Чеки передплати та післяплати

Get Prepayment Relation

Отримання інформації про чеки передоплати та післяплати.

get/api/v1/prepayment-receipts/{relation_id}

Request

  • Base URL: https://api.checkbox.ua (the document declares no server; this is the origin it was published from)
  • URL: https://api.checkbox.ua/api/v1/prepayment-receipts/{relation_id}
  • Auth: HTTP bearer

Path parameters

relation_idstring required

Headers

X-Client-Namestring

Назва клієнту або сервісу що інтегрується з API, наприклад 'My Custom SDK'

X-Client-Versionstring

Номер версії клієнту що інтегрується з API, наприклад 'v1.2.5'

Response

Successful Response

idstring uuid required
relation_idstring required
paid_sumnumber required
total_sumnumber required
left_to_paynumber
paid_by_cash_sumnumber
last_returned_receipt_atstring date-time
receipt_chain_countinteger
is_debt_receiptboolean
pre_payment_status'PARTIAL_PAID' | 'FULL_PAID' | 'CANCELLED' | 'PARTIAL_CANCELLED' required

An enumeration.

created_atstring date-time required
updated_atstring date-time

Example response

{
  "receipts_chain": {
    "pre_payment_receipts": [
      {
        "payments": [
          {
            "type": "CASH",
            "value": 4242
          }
        ]
      }
    ],
    "after_payment_receipt": {
      "payments": [
        {
          "type": "CASH",
          "value": 4242
        }
      ]
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.