(Quick Reference)
61 Prepayment Allocations - Reference Documentation
Version: 2.1
61 Prepayment Allocations
61.1 List
Service: List prepayment allocations
Description: This web service returns a json list of prepayment allocations.
URL:
https://BASE_URL/api/VERSION/orderPrepaymentAllocations
: 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 | |
| prepaymentReference | Wildcard search by the resource's prepayment reference | String | no | prepaymentReference=Ref-6* , prepaymentReference=*ef-6 , prepaymentReference=*ef-6* |
| orderReference | Wildcard search by the resource's order reference | String | no | orderReference=Ref-6* , orderReference=*ef-6 , orderReference=*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/orderPrepaymentAllocations?sort=dateCreated&max=5&order=ascoffset=0",
"next": "/api/v1.0/orderPrepaymentAllocations?sort=dateCreated&max=5&order=asc&offset=10"
},
"data": [
{
"id": 252,
"prepaymentId": {
"prepaymentId": 61,
"reference": "L-aa-1505382365189",
"href": "/valomniav2/api/v2.1/orderPrepayments/61"
},
"orderId": {
"orderId": 100,
"reference": "OafB9NNYx8beEes",
"href": "/valomniav2/api/v2.1/orders/100"
},
"organization": "entity1",
"dateCreated": "2017-09-14T11:16:51Z",
"lastUpdated": "2017-09-14T11:16:53Z",
"paymentDate": "2017-09-15T09:46:00Z",
"amountToCredit": 120.50
},…
]
} 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..."
}61.2 Create
Service: Create a prepayment allocation
Description: Returns the created prepayment allocation in json format when successful. Returns a json response, describing the failure condition when unsuccessful.
URL:
https://BASE_URL/api/VERSION/orderPrepaymentAllocations
: POST
Request content type: application/json
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| orderId | The numerical ID of order | Long/String | yes | |
| prepaymentId | The numerical ID of prepayment | Long/String | yes | |
| amountToCredit | | Double | yes | |
| useExternalId | By default, it is set to false. set it to true if you want to use external ids. | Boolean | no | true , false |
Success Output
Success case: response.status=201
{
"id": 252,
"prepaymentId": {
"prepaymentId": 61,
"reference": "L-aa-1505382365189",
"href": "/valomniav2/api/v2.1/orderPrepayments/61"
},
"orderId": {
"orderId": 100,
"reference": "OafB9NNYx8beEes",
"href": "/valomniav2/api/v2.1/orders/100"
},
"organization": "entity1",
"dateCreated": "2017-09-14T11:16:51Z",
"lastUpdated": "2017-09-14T11:16:53Z",
"paymentDate": "2017-09-15T09:46:00Z",
"amountToCredit": 120.50
} Failure Output
Failure case:response.status = 400
{
"error": "save_failed",
"error_description": "Failed to save instance."
}{
"error": "invalid_param_type",
"error_description": "An invalid value was specified for parameter: amountToCredit (must be positive)"
}{
"error": "not_found",
"error_description": "The Order with the id 10 doesn't exist."
}{
"error": "not_found",
"error_description": "The Prepayment type with the id 8000 doesn't exist."
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}{
"error": "Invalid_amountToCredit",
"error_description": "The amountToCredit is surpassed the remaining amount in the prepayment"
}{
"error":"Invalid_order",
"error_description": "The order you specified is already paid"
}{
"error":"Invalid_customer",
"error_description": "The customer of prepayment and order are not the same"
}61.3 Delete
Service: Delete a prepayment allocation
Description: Returns a JSON response.
URL:
https://BASE_URL/api/VERSION/orderPrepaymentAllocations/{id}: DELETE
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| id | The ID of the desired prepayment allocation | Long | yes | 123 |
Success Output
Success case: response.status=200
{
"success": "true",
"success_description": "Instance deleted successfully"
} Failure Output
Failure case:response.status = 400
{
"error": "delete_failed",
"error_description": "Failed to delete instance."
}{
"error":"invalid_param_type",
"error_description": "The type of parameter id you provided is not valid for this request."
} Failure case:response.status = 404
{
"error": "not_found",
"error_description": "The prepayment allocation with the id 706 doesn't exist."
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}
