Billiecart API

DistributeContributionRequest

**Requires Authentication**
Requires the role:	manager

The following routes are available for this service:
POST	/contributions/{Id}/distribute

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


TResponse = TypeVar('TResponse')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PostOperationUnTenanted(Generic[TResponse], IReturn[TResponse], IPost):
    @staticmethod
    def response_type(): return TResponse


TResponse = TypeVar('TResponse')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PostOperationTenanted(Generic[TResponse], PostOperationUnTenanted[TResponse], ITenantedRequest):
    organisation_id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DistributeContributionResponse:
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SalarySacrificeBreakdown:
    lease_amount: Optional[Decimal] = None
    administration_fee: Optional[Decimal] = None
    fuel: Optional[Decimal] = None
    servicing: Optional[Decimal] = None
    tyres: Optional[Decimal] = None
    insurance: Optional[Decimal] = None
    car_wash: Optional[Decimal] = None
    registration: Optional[Decimal] = None
    road_side_assistance: Optional[Decimal] = None
    anything_extra: Optional[Decimal] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContributionSalaryPackage(IIdentifiableResource):
    pre_tax_deduction: Optional[Decimal] = None
    post_tax_deduction: Optional[Decimal] = None
    salary_sacrifice_breakdown: Optional[SalarySacrificeBreakdown] = None
    id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DistributeContributionRequest(PostOperationTenanted[DistributeContributionResponse]):
    id: Optional[str] = None
    salary_packages: Optional[List[ContributionSalaryPackage]] = None

Python DistributeContributionRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /contributions/{Id}/distribute HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DistributeContributionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Contributions">
  <OrganisationId xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations">String</OrganisationId>
  <Id>String</Id>
  <SalaryPackages xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources">
    <d2p1:ContributionSalaryPackage>
      <d2p1:Id>String</d2p1:Id>
      <d2p1:PostTaxDeduction>0</d2p1:PostTaxDeduction>
      <d2p1:PreTaxDeduction>0</d2p1:PreTaxDeduction>
      <d2p1:SalarySacrificeBreakdown>
        <d2p1:AdministrationFee>0</d2p1:AdministrationFee>
        <d2p1:AnythingExtra>0</d2p1:AnythingExtra>
        <d2p1:CarWash>0</d2p1:CarWash>
        <d2p1:Fuel>0</d2p1:Fuel>
        <d2p1:Insurance>0</d2p1:Insurance>
        <d2p1:LeaseAmount>0</d2p1:LeaseAmount>
        <d2p1:Registration>0</d2p1:Registration>
        <d2p1:RoadSideAssistance>0</d2p1:RoadSideAssistance>
        <d2p1:Servicing>0</d2p1:Servicing>
        <d2p1:Tyres>0</d2p1:Tyres>
      </d2p1:SalarySacrificeBreakdown>
    </d2p1:ContributionSalaryPackage>
  </SalaryPackages>
</DistributeContributionRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DistributeContributionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Contributions">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</DistributeContributionResponse>