Get

[POST] .../v1/doccheque/get

Returns cheques. Use this method to retrieve retail sale cheques for a period, a cash shift or a known set of cheque UUIDs before loading cheque item operations and payment operations. The response returns paged DocCheque records with next_offset and total, includes doc_order_delivery_id for cheques linked to delivery orders and supports filters by uuid, cashier_id, seller_id, card_id, customer_id, session_uuid, status, is_return, is_fiscal and date, plus sort_orders, limit and offset. The request must provide either uuids, session_uuid or a valid start_date/end_date period; period selection validates end_date >= start_date and limits the range to one month, while uuids is limited to 250 items. The current request user must exist and have retail cheque select permission; business errors such as missing body, missing or invalid period fields, oversized uuids, denied access, invalid filters or sort_orders, 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.
limit Int32 Optional Number of result items returned by the request.
offset Int32 Optional Offset from the beginning of the result set.
sort_orders Array of DocChequeColumn Optional Output parameter sorting.

Filterable Fields

Field Type Description
card_id int Customer card IDs.
cashier_id int Cashier IDs.
customer_id int Customer IDs.
date int
end_date int Period end date as Unix time in seconds.
is_fiscal bool Indicates whether the cheque has a fiscal sign: true - has a fiscal sign, false - does not have a fiscal sign, null - return all cheques with and without a fiscal sign. A fiscal sign means that the cheque contains a QR code with a URL.
is_return bool Indicates whether the cheque is a return cheque: true - return cheque, false - sale cheque, null - return all sale and return cheques.
seller_id int Seller IDs.
session_uuid string UUID of the shift linked to the cheque.
start_date int Period start date as Unix time in seconds.
status string Cheque status: Opened - opened, Paying - payment in progress, Closed - closed, Delayed - delayed, DelayedPayment - delayed during payment, Canceled - canceled.
uuid string Cheque UUIDs.

Sortable Fields

Field
agregate_status
amount
card.barcode_value
cashier.name
code
date
is_return
last_update
return_reason.id
seller.name
session
status
uuid

Request Example

{
  "filters": [
    {
      "Field": "date",
      "Operator": "GreaterOrEqual",
      "Value": "1767225600"
    },
    {
      "Field": "date",
      "Operator": "LessOrEqual",
      "Value": "1767311999"
    },
    {
      "Field": "status",
      "Operator": "Equal",
      "Value": "Closed"
    }
  ],
  "sort_orders": [
    {
      "column": "date",
      "direction": "DESC"
    }
  ],
  "limit": 50,
  "offset": 0
}

Response Parameters

Name Type Description
next_offset Int32 Offset for the next data page.
ok Boolean Indicates whether the request completed successfully.
result Array of DocCheque Result array.
total Int64 Total number of result items.

Response Example

{
  "ok": true,
  "result": [
    {
      "uuid": "4a6ed673-ea97-4d3f-807e-e8a4ab2f454d",
      "date": 1767227400,
      "code": "CH-000120",
      "status": "Closed",
      "session": "b2f790c8-4c0b-4d93-9a2d-3999dc5a0c11",
      "cashier": {
        "id": 12,
        "first_name": "Ali",
        "last_name": "Karimov"
      },
      "is_return": false,
      "seller": {
        "id": 18,
        "first_name": "Nodira",
        "last_name": "Saidova"
      },
      "return_reason": null,
      "card": null,
      "amount": 185000,
      "doc_order_delivery_id": 2451,
      "agregate_status": "New",
      "last_update": 1767227460
    }
  ],
  "next_offset": 0,
  "total": 1
}