(Quick Reference)
Service: Create a prepayment
Description: Returns the created prepayment in json format when successful. Returns a json response, describing the failure condition when unsuccessful.
URL:
https://BASE_URL/api/VERSION/orderPrepayments
: POST
Request content type: application/json
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| reference | | String | yes | |
| customerId | The numerical ID of customer | Long/String | yes | |
| userId | The numerical ID of user. By default, it is set to the current connected user | Long/String | no | |
| total | | Double | yes | |
| currency | ISO code of configured currency. By default, it is set as the organization currency if the customer does not have currency. | String | no | EUR |
| latitude | | Double | No | 12.914 |
| longitude | | Double | No | 14.99 |
| checkInDate | | String | No | 2016-04-12T19:30:48Z |
| paymentDate | | Date | Yes | 2016-08-15T14:52:48Z |
| paymentTypeId | The ID of payment type | Integer/String | No | |
| desiredPaymentDate | Used when payment is by CHEQUE | Date | no | 2016-08-15 |
| bank | The bank name. It's used when payment is by CHEQUE | String | no | |
| useExternalId | By default, it is set to false. set it to true if you want to use external ids. | Boolean | no | true , false |
latitude and longitude must have a valid value otherwise, they will be considered as null
Success Output
Success case: response.status=201
{
"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": "save_failed",
"error_description": "Failed to save instance."
}{
"error": "not_unique",
"error_description": "reference already used"
}{
"error": "invalid_param_type",
"error_description": "An invalid value was specified for parameter: total (must be positive)"
}{
"error": "date_validation_error",
"error_description": "Failed to add the Prepayment with the reference PR_001 : paymentDate incorrect Date Format"
}{
"error": "not_found",
"error_description": "The Customer with the id 10 doesn't exist."
}{
"error": "not_found",
"error_description": "The payment type with the id 8000 doesn't exist."
}{
"error": "not_found",
"error_description": "The User with the id 1 doesn't exist."
}{
"error": "not_found",
"error_description": "The currency with name IN doesn't exist."
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}
