Skip to content

Structure "Payment"

This structure describes various aspects of payment. It is a part of the "Freight" structure and "Vehicles" structure under the name payment.

Field description

Name Description Data type Required
price Delivery price. String +
currency Currency from the directory. "Basic directory element" structure
unit Payment unit from the directory. "Basic directory element" structure
moment Moment of payment from the directory. "Basic directory element" structure
type Payment type from the directory. "Basic directory element" structure
prepay Percentage of prepayment of the total cost. Number +
delay Deferred payment, days. Number +
vat VAT. Logical +

Notes: The delay parameter has a value and is indicated if the moment parameter contains the "Deferred payment" value.

Sample

JSON
{
    "price": 1000,
    "currency": {
        "id": 4,
        "name": "USD"
    },
    "unit": {
        "id": 2,
        "name": "km"
    },
    "moment": {
        "id": 2,
        "name": "during loading"
    },
    "type": {
        "id": 2,
        "name": "cash"
    },
    "prepay": 10,
    "delay": 0,
    "vat": false
}