Billiecart API

<back to all web services

CreateContributionRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
POST/contributions
CreateContributionRequest Parameters:
NameParameterData TypeRequiredDescription
Amountbodydecimal?No
PaymentDatebodyDateTimeNo
EmployerIdbodystringNo
PostOperationTenanted<TResponse> Parameters:
NameParameterData TypeRequiredDescription
OrganisationIdformstringNo
CreateContributionResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ContributionformContributionNo
Contribution Parameters:
NameParameterData TypeRequiredDescription
EmployerIdformstringNo
EmployerNameformstringNo
AmountformdecimalNo
PaymentDateformDateTimeNo
DistributedformboolNo
IdformstringNo
CreateContributionResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ContributionformContributionNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /contributions HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"amount":0,"employerId":"String","organisationId":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"contribution":{"employerId":"String","employerName":"String","amount":0,"distributed":false,"id":"String"}}