(Quick Reference)
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"
}
