get

[POST] …/v1/DocCheque/get

Возвращает информацию о чеке

Входные параметры

Название	Тип данных	Обязательность	Описание параметра
start_date	Int64	Необязательный	Дата начала периода в формате unixtime в секундах
end_date	Int64	Необязательный	Дата окончания периода в формате unixtime в секундах
uuids	Array of string	Необязательный	Массив Uuid чеков
code	string	Необязательный	Код чека
session_uuid	string	Необязательный	Uuid смены, к которой привязан чек
cashier_ids	Array of Int64	Необязательный	Массив Id кассиров
seller_ids	Array of Int64	Необязательный	Массив Id продавцов
card_ids	Array of Int64	Необязательный	Массив Id карт покупателей
doc_order_delivery_id	Int64	Необязательный	Id документа заказа
statuses	Array of enum	Необязательный	Статус чека: Opened (Открыт), Paying (В процессе оплаты), Closed (Закрыт), Delayed (Отложен), DelayedPayment (Отложен в процессе оплаты), Canceled (Аннулирован)
is_return	bool	Необязательный	Метка о том, что чек является чеком возврата
return_reason	Int64	Необязательный	Id причины возврата
is_fiscal	bool	Необязательный	Имеет ли чек фискальный признак. null - все чеки, true - только чеки с фискальным признаком, false - чеки без фискального признака. Под фискальным признаком понимается наличие qr-code с url в чеке

Пример запроса

{
    "uuid": "a0ac4d96-f193-4c15-8c9d-5e9e5fe78307",
    "code": "1-0000210",
    "session_uuid": "d80432cf-221f-4f0c-a3b7-00d9c9293591",
    "cashier_ids": [
        1
    ],
    "seller_ids": [
        2
    ],
    "card_ids": [
        3
    ],
    "doc_order_delivery_id": 0,
    "statuses": "Closed",
    "start_date": 1635860191,
    "end_date": 1635860991,
    "is_return": true,
    "return_reason": 1,
    "is_fiscal": true
}

Выходные параметры

Название	Тип данных	Описание параметра
Result	Array of DocCheque	Массив чеков

Пример ответа

{
  "ok": true,
  "result": [
    {
      "uuid": "a0ac4d96-f193-4c15-8c9d-5e9e5fe78307",
      "date": 1635860191,
      "code": "1-0000210",
      "status": 3,
      "session": "d80432cf-221f-4f0c-a3b7-00d9c9293591",
      "cashier": {
        "id": 1,
        "full_name": "Administrator",
        "user_group": {
          "id": 1,
          "parent_id": 0,
          "name": "Admins",
          "child_count": 0,
          "last_update": 1552326674
        },
        "first_name": "Administrator",
        "last_name": null,
        "middle_name": null,
        "sex": "none",
        "date_of_birth": "1900-01-01",
        "address": null,
        "main_phone": null,
        "phones": null,
        "email": null,
        "description": null,
        "login": "admin",
        "can_authorize": true,
        "active": true,
        "language_code": "RUS",
        "last_update": 1623234133
      },
      "is_return": true,
      "seller": null,
      "return_reason": 1,
      "card": null,
      "amount": 0,
      "agregate_status": 1,
      "last_update": 1641537703
    }
  ],
  "next_offset": 0,
  "total": 1
}