(Quick Reference)
Service: List prepayments
Description: This web service returns a json list of prepayments.
URL:
https://BASE_URL/api/VERSION/orderPrepayments
: GET
Parameters:
Pagination parameters:
| Name | Description | Type | Required | Possible values |
|---|
| max | Limits the number of resources requested to return. | Integer | no | |
| offset | Tells where to start returning records from the entire set of results. | Integer | no | |
| order | Orders ascending or descending. | Integer | no | asc,desc |
| sort | Orders the results by the specified field. | String | no | |
The max parameter is set to 100 by default.
Filters parameters:
| Name | Description | Type | Required | Example values |
|---|
| dateCreated_gt | Filters by the resource's creation date time and operator greater than | Date | no | 2016-08-15T14:52:48Z |
| dateCreated_gte | Filters by the resource's creation date time and operator greater than or equal | Date | no | |
| dateCreated_lt | Filters by the resource's creation date time and operator less than | Date | no | |
| dateCreated_lte | Filters by the resource's creation date time and operator less than or equal | Date | no | |
| lastUpdated_gt | Filters by the resource's last-modified date time and operator greater than | Date | no | |
| lastUpdated_gte | Filters by the resource's last-modified date time and operator greater than or equal | Date | no | |
| lastUpdated_lt | Filters by the resource's last-modified date time and operator less than | Date | no | |
| lastUpdated_lte | Filters by the resource's last-modified date time and operator less than or equal | Date | no | |
| paymentDate_gt | Filters by the resource's payment date time and operator greater than | Date | no | 2016-08-15T14:52:48Z |
| paymentDate_gte | Filters by the resource's payment date time and operator greater than or equal | Date | no | |
| paymentDate_lt | Filters by the resource's payment date time and operator less than | Date | no | |
| paymentDate_lte | Filters by the resource's payment date time and operator less than or equal | Date | no | |
| reference | Wildcard search by the resource's reference | String | no | |
| customerReference | Wildcard search by the resource's customer reference | String | no | customerReference=Ref-6* , customerReference=*ef-6 , customerReference=*ef-6* |
Dates should be formatted as the ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ)
Success Output
Success case: response.status=200
{
"paging": {
"total": 702,
"max": 5,
"offset": 5,
"previous": "/api/v1.0/orderPrepayments?sort=dateCreated&max=5&order=ascoffset=0",
"next": "/api/v1.0/orderPrepayments?sort=dateCreated&max=5&order=asc&offset=10"
},
"data": [
{
"id": 27,
"reference": "L-aa-1505226514088",
"description": "",
"total": 45,
"paymentDate": "2017-09-12T08:25:00Z",
"dateCreated": "2017-09-12T14:28:49Z",
"lastUpdated": "2017-09-12T14:28:49Z",
"status": "UNAPPLIED",
"currency": "AUD",
"paymentType": {
"id": 4,
"reference": "CASH",
"name": "Cash",
"href": "/valomniav2/api/v2.1/paymentTypes/4"
},
"bank": null,
"chequeNumber": null,
"desiredPaymentDate": null,
"organization": "entity1",
"createdBy": {
"userId": 2,
"reference": "emp-002",
"href": "/valomniav2/api/v2.1/users/2"
},
"customer": {
"id": 1,
"reference": "JohnDoe",
"reference2": "",
"name": "John Doe",
"href": "/valomniav2/api/v2.1/customers/1"
}
},…
]
} Failure Output
Failure case:response.status = 400
{
"error": "invalid_param",
"error_description": "The parameters [dateCreated_gta] you provided are not valid for this request."
}{
"error": "invalid_datetime_format",
"error_description": "Invalid datetime filter (not ISO-8601 formatted): [2016-08-1Z]"
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}
