Billiecart API

<back to all web services

GetContributionRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
GET/contributions/{Id}
GetContributionRequest Parameters:
NameParameterData TypeRequiredDescription
IdpathstringNo
GetOperationTenanted<TResponse> Parameters:
NameParameterData TypeRequiredDescription
OrganisationIdformstringNo
GetOperationUnTenanted<TResponse> Parameters:
NameParameterData TypeRequiredDescription
EmbedformstringNo
GetContributionResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ContributionformContributionNo
Contribution Parameters:
NameParameterData TypeRequiredDescription
EmployerIdformstringNo
EmployerNameformstringNo
AmountformdecimalNo
PaymentDateformDateTimeNo
DistributedformboolNo
IdformstringNo
GetContributionResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ContributionformContributionNo

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.

GET /contributions/{Id} HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: text/csv
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"}},"contribution":{"employerId":"String","employerName":"String","amount":0,"distributed":false,"id":"String"}}