Requires the role: | manager |
POST | /contributions/{Id}/distribute |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | path | string | No | |
SalaryPackages | body | List<ContributionSalaryPackage> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
OrganisationId | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PreTaxDeduction | form | decimal? | No | |
PostTaxDeduction | form | decimal? | No | |
SalarySacrificeBreakdown | form | SalarySacrificeBreakdown | No | |
Id | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
LeaseAmount | form | decimal? | No | |
AdministrationFee | form | decimal? | No | |
Fuel | form | decimal? | No | |
Servicing | form | decimal? | No | |
Tyres | form | decimal? | No | |
Insurance | form | decimal? | No | |
CarWash | form | decimal? | No | |
Registration | form | decimal? | No | |
RoadSideAssistance | form | decimal? | No | |
AnythingExtra | form | decimal? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=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"}}}