Requires the role: | manager |
POST | /contributions |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Amount | body | decimal? | No | |
PaymentDate | body | DateTime | No | |
EmployerId | body | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
OrganisationId | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
Contribution | form | Contribution | 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 |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
Contribution | form | Contribution | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
amount: 0,
employerId: 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 } }, contribution: { employerId: String, employerName: String, amount: 0, distributed: False, id: String } }