Requires the role: | manager |
GET | /contributions |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
OrganisationId | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Distinct | form | string | No | |
Limit | form | int? | No | |
Offset | form | int? | No | |
Sort | form | string | No | |
Filter | form | string | No | |
Search | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Embed | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
Contributions | form | List<Contribution> | No | |
Metadata | form | SearchMetadata | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
EmployerId | form | string | No | |
EmployerName | form | string | No | |
Amount | form | decimal | No | |
PaymentDate | form | DateTime | No | |
Distributed | form | bool | No | |
Id | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Total | form | int | No | |
Limit | form | int | No | |
Offset | form | int | No | |
Sort | form | Sorting | No | |
Filter | form | Filtering | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
By | form | string | No | |
Direction | form | SortDirection | No |
Ascending | |
Descending |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Fields | form | List<string> | No | |
Search | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
Contributions | form | List<Contribution> | No | |
Metadata | form | SearchMetadata | No |
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
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"}}}