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 .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"id":"String","salaryPackages":[{"preTaxDeduction":0,"postTaxDeduction":0,"salarySacrificeBreakdown":{"leaseAmount":0,"administrationFee":0,"fuel":0,"servicing":0,"tyres":0,"insurance":0,"carWash":0,"registration":0,"roadSideAssistance":0,"anythingExtra":0},"id":"String"}],"organisationId":"String"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}