Get

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

Returns cheque information. Use this method to retrieve POS cheque documents for receipt lookup, cashier support, reconciliation and retail sale diagnostics. The request body supports filters by uuid, code, session_uuid, cashier_id, seller_id, card_id, doc_order_delivery_id, statuses, date period, return flag and return reason, then returns result with a Cheque array. The method checks the current request user and accepted cashier context before reading data; missing body, missing cash register acceptance, lookup failures and storage errors are returned as HTTP 200 ErrorResult business errors.

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
card_id int Customer card ID.
cashier_id int Cashier ID.
code string Cheque code.
doc_order_delivery_id int Percentage discount applied to the cheque.
end_date int Period end date as Unix time in seconds.
is_return bool Indicates whether the cheque is a return cheque.
return_reason int Return reason ID.
seller_id int Seller ID.
session_uuid string UUID of the shift linked to the cheque.
start_date int Period start date as Unix time in seconds.
statuses string Cheque status: Opened - opened, Paying - pending payment, Closed - closed, Delayed - delayed, DelayedPayment - delayed for payment, Canceled - canceled.
uuid string Cheque UUID.

Request Example

{
  "filters": [
    {
      "Field": "card_id",
      "Operator": "Equal",
      "Value": "string"
    }
  ]
}

Response Parameters

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

Response Example

{
  "ok": true,
  "result": [
    {
      "amount": 1.0,
      "amount2": 1.0,
      "card": {
        "barcode_type": {
          "id": 1,
          "last_update": 1,
          "name": "string"
        },
        "barcode_value": "string",
        "bonus_amount": 1.0,
        "customer": {
          "address": "string",
          "date_of_birth": "string",
          "debt": 1.0,
          "deleted_mark": true,
          "description": "string",
          "email": "string",
          "fields": [
            {
              "data_type": "string",
              "is_custom": true,
              "key": "string",
              "metadata": "string",
              "name": "string",
              "required": true,
              "value": "string"
            }
          ],
          "first_name": "string",
          "full_name": "string",
          "group": {
            "child_count": 1,
            "id": 1,
            "last_update": 1,
            "name": "string",
            "parent_id": 1
          },
          "id": 1,
          "last_name": "string",
          "last_purchase": 1,
          "last_update": 1,
          "main_phone": "string",
          "middle_name": "string",
          "phones": "string",
          "refer_id": 1,
          "region": {
            "id": 1,
            "last_update": 1,
            "name": "string",
            "parent_id": 1
          },
          "sex": "none"
        },
        "date": 1,
        "enabled": true,
        "expiry_date": "string",
        "group": {
          "child_count": 1,
          "id": 1,
          "last_update": 1,
          "name": "string",
          "parent_id": 1
        },
        "id": 1,
        "last_purchase": 1,
        "last_update": 1,
        "promo": {
          "active": true,
          "days": [
            1
          ],
          "description": "string",
          "end_date": "string",
          "end_time": "string",
          "id": 1,
          "last_update": 1,
          "name": "string",
          "priority": 1,
          "start_date": "string",
          "start_time": "string",
          "sub_type": 1,
          "type": {
            "id": 1,
            "last_update": 1,
            "name": "string"
          }
        },
        "unlimited": true
      },
      "card_discount_percent": 1.0,
      "card_id": 1,
      "cashier": {
        "active": true,
        "address": "string",
        "can_authorize": true,
        "date_of_birth": "string",
        "description": "string",
        "email": "string",
        "enable_hints": true,
        "fields": [
          {
            "data_type": "string",
            "is_custom": true,
            "key": "string",
            "metadata": "string",
            "name": "string",
            "required": true,
            "value": "string"
          }
        ],
        "first_name": "string",
        "full_name": "string",
        "id": 1,
        "internal_phone": "string",
        "language_code": "string",
        "last_name": "string",
        "last_update": 1,
        "login": "string",
        "main_phone": "string",
        "middle_name": "string",
        "phones": "string",
        "photo_url": "string",
        "seller_barcode": "string",
        "sex": "none",
        "sub": "string",
        "system": true,
        "user_group": {
          "child_count": 1,
          "id": 1,
          "last_update": 1,
          "name": "string",
          "parent_id": 1
        }
      },
      "cashier_id": 1,
      "code": "string",
      "date": 1,
      "debt_payment": true,
      "debt_uuid": "00000000-0000-0000-0000-000000000000",
      "doc_order_delivery_id": 1,
      "is_return": true,
      "payments_amount": 1.0,
      "refund_info": {
        "datetime": "2026-01-01T00:00:00Z",
        "fiscal_sign": "string",
        "qrcode_url": "string",
        "receipt_no": "string",
        "terminal_id": "string"
      },
      "return_reason": {
        "description": "string",
        "enabled": true,
        "id": 1,
        "last_update": 1,
        "name": "string"
      },
      "seller": {
        "active": true,
        "address": "string",
        "can_authorize": true,
        "date_of_birth": "string",
        "description": "string",
        "email": "string",
        "enable_hints": true,
        "fields": [
          {
            "data_type": "string",
            "is_custom": true,
            "key": "string",
            "metadata": "string",
            "name": "string",
            "required": true,
            "value": "string"
          }
        ],
        "first_name": "string",
        "full_name": "string",
        "id": 1,
        "internal_phone": "string",
        "language_code": "string",
        "last_name": "string",
        "last_update": 1,
        "login": "string",
        "main_phone": "string",
        "middle_name": "string",
        "phones": "string",
        "photo_url": "string",
        "seller_barcode": "string",
        "sex": "none",
        "sub": "string",
        "system": true,
        "user_group": {
          "child_count": 1,
          "id": 1,
          "last_update": 1,
          "name": "string",
          "parent_id": 1
        }
      },
      "seller_id": 1,
      "session_code": "string",
      "session_uuid": "00000000-0000-0000-0000-000000000000",
      "status": "Opened",
      "uuid": "00000000-0000-0000-0000-000000000000"
    }
  ]
}