Billiecart API

<back to all web services

SearchAllContributionsRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
GET/contributions
SearchOperationTenanted<TResponse> Parameters:
NameParameterData TypeRequiredDescription
OrganisationIdformstringNo
SearchOperationUnTenanted<TResponse> Parameters:
NameParameterData TypeRequiredDescription
DistinctformstringNo
Limitformint?No
Offsetformint?No
SortformstringNo
FilterformstringNo
SearchformstringNo
GetOperationUnTenanted<TResponse> Parameters:
NameParameterData TypeRequiredDescription
EmbedformstringNo
SearchAllContributionsResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ContributionsformList<Contribution>No
MetadataformSearchMetadataNo
Contribution Parameters:
NameParameterData TypeRequiredDescription
EmployerIdformstringNo
EmployerNameformstringNo
AmountformdecimalNo
PaymentDateformDateTimeNo
DistributedformboolNo
IdformstringNo
SearchMetadata Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
LimitformintNo
OffsetformintNo
SortformSortingNo
FilterformFilteringNo
Sorting Parameters:
NameParameterData TypeRequiredDescription
ByformstringNo
DirectionformSortDirectionNo
SortDirection Enum:
Ascending
Descending
Filtering Parameters:
NameParameterData TypeRequiredDescription
FieldsformList<string>No
SearchformstringNo
SearchAllContributionsResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ContributionsformList<Contribution>No
MetadataformSearchMetadataNo

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.

GET /contributions HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: application/json
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"}},"contributions":[{"employerId":"String","employerName":"String","amount":0,"distributed":false,"id":"String"}],"metadata":{"total":0,"limit":0,"offset":0,"sort":{"by":"String","direction":"Ascending"},"filter":{"fields":["String"],"search":"String"}}}