Billiecart API

<back to all web services

DistributeContributionRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
POST/contributions/{Id}/distribute
DistributeContributionRequest Parameters:
NameParameterData TypeRequiredDescription
IdpathstringNo
SalaryPackagesbodyList<ContributionSalaryPackage>No
PostOperationTenanted<TResponse> Parameters:
NameParameterData TypeRequiredDescription
OrganisationIdformstringNo
DistributeContributionResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ContributionSalaryPackage Parameters:
NameParameterData TypeRequiredDescription
PreTaxDeductionformdecimal?No
PostTaxDeductionformdecimal?No
SalarySacrificeBreakdownformSalarySacrificeBreakdownNo
IdformstringNo
SalarySacrificeBreakdown Parameters:
NameParameterData TypeRequiredDescription
LeaseAmountformdecimal?No
AdministrationFeeformdecimal?No
Fuelformdecimal?No
Servicingformdecimal?No
Tyresformdecimal?No
Insuranceformdecimal?No
CarWashformdecimal?No
Registrationformdecimal?No
RoadSideAssistanceformdecimal?No
AnythingExtraformdecimal?No
DistributeContributionResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo

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

HTTP + JSV

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

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