Billiecart API

DistributeContributionRequest

**Requires Authentication**
Requires the role:	manager

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


export class PostOperationUnTenanted<TResponse> implements IPost
{

    public constructor(init?: Partial<PostOperationUnTenanted<TResponse>>) { (Object as any).assign(this, init); }
}

export class PostOperationTenanted<TResponse> extends PostOperationUnTenanted<TResponse> implements ITenantedRequest
{
    public organisationId?: string;

    public constructor(init?: Partial<PostOperationTenanted<TResponse>>) { super(init); (Object as any).assign(this, init); }
}

export class DistributeContributionResponse
{
    public responseStatus?: ResponseStatus;

    public constructor(init?: Partial<DistributeContributionResponse>) { (Object as any).assign(this, init); }
}

export class SalarySacrificeBreakdown
{
    public leaseAmount?: number;
    public administrationFee?: number;
    public fuel?: number;
    public servicing?: number;
    public tyres?: number;
    public insurance?: number;
    public carWash?: number;
    public registration?: number;
    public roadSideAssistance?: number;
    public anythingExtra?: number;

    public constructor(init?: Partial<SalarySacrificeBreakdown>) { (Object as any).assign(this, init); }
}

export class ContributionSalaryPackage implements IIdentifiableResource
{
    public preTaxDeduction?: number;
    public postTaxDeduction?: number;
    public salarySacrificeBreakdown?: SalarySacrificeBreakdown;
    public id?: string;

    public constructor(init?: Partial<ContributionSalaryPackage>) { (Object as any).assign(this, init); }
}

export class DistributeContributionRequest extends PostOperationTenanted<DistributeContributionResponse>
{
    public id?: string;
    public salaryPackages?: ContributionSalaryPackage[];

    public constructor(init?: Partial<DistributeContributionRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript 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>