Get

[POST] .../v1/chequepaymentoperation/get

Returns retail payments. Use this method after DocCheque/Get to retrieve payment lines of a retail sale cheque, including payment type, amount, change and storno references. The response returns DocRetailPayment records for the selected cheque or payment UUIDs, supports filters and is ordered by payment operation order and UUID; there is no sort_orders request field for this endpoint. The request body is required and must provide doc_sale_uuid or uuids; uuids is limited to 250 items, payments are filtered by the current request user's allowed stocks and accounts and the method does not change data. The current request user must have retail payment select permission; business errors such as missing body, missing selector fields, oversized uuids, denied access, invalid filters, database failures or persistent lookup errors are returned as HTTP 200 ErrorResult.

Request Parameters

Name Type Required Description
filters Array of Filter Optional Optional filters by fields available for this API method.

Filterable Fields

Field Type Description
doc_sale_uuid string Retail sale document UUID.
uuids string Payment operation UUIDs.

Request Example

{
  "filters": [
    {
      "Field": "doc_sale_uuid",
      "Operator": "Equal",
      "Value": "4a6ed673-ea97-4d3f-807e-e8a4ab2f454d"
    }
  ]
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Array of DocRetailPayment Result array.

Response Example

{
  "ok": true,
  "result": [
    {
      "uuid": "b7e79552-83d6-4ed1-9b80-1105c9eb20b1",
      "has_storno": false,
      "storno_uuid": null,
      "document": "4a6ed673-ea97-4d3f-807e-e8a4ab2f454d",
      "order": 1,
      "type": {
        "id": 2,
        "name": "Bank card"
      },
      "payment_type": {
        "id": 2,
        "name": "Bank card"
      },
      "value": 185000,
      "has_change": false,
      "change_uuid": null
    }
  ]
}