GetShort

DocChequeShort

Модель, описыпающая чеки

Название	Тип данных	Описание параметра
uuid	string	uuid чека
operating_cash_id	int64	id кассы
date	int64	дата чека в unixtime
code	string	код чека
sale_status	DocChequeStatus	статус чека
session_uuid	string	uuid коссовой смены
session_code	string	код коссовой смены
is_return	bool	чек взврата(true) или продажи(false)
amount	float128	сумма чека
stock_id	int64	id склада (места хранения)
stock_name	string	наименование склада
firm_id	int64	id фирмы
firm_name	string	наименование предприятия
customer_id	Int64	id покупателя
customer_name	string	наименование покупателя
card_id	Int64	id карты лояльности
card_barcode	string	штрихкод карты лояльности

[POST] …/v1/DocCheque/GetShort

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

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

Название	Тип данных	Обязательность	Описание параметра
uuids	Array of string	Необязательный	Массив Uuid чеков
start_date	Int64	Необязательный	Дата начала периода в формате unixtime в секундах
end_date	Int64	Необязательный	Дата окончания периода в формате unixtime в секундах
search	string	Необязательный	Строка поиска по полям: код чека, название склада и названию предприятия
session_uuid	string	Необязательный	Uuid смены, к которой привязан чек
operating_cash_ids	Array of Int64	Необязательный	массив id касс
stock_ids	Array of Int64	Необязательный	массив id мест хранения (складов)
firm_ids	Array of Int64	Необязательный	массив id предприятий
customer_ids	Array of Int64	Необязательный	массив id покупателей
sort_orders	SortOrder	Необязательный	сортировать по полям: SessionCode, Code, Amount, Date, IsReturn, SaleStatus, StockName, FirmName
is_return	bool	Необязательный	метка чеков возрата (null - все чеки)
sale_status	DocChequeStatus	Необязательный	Статус чека: Opened (Открыт), Paying (В процессе оплаты), Closed (Закрыт), Delayed (Отложен), DelayedPayment (Отложен в процессе оплаты), Canceled (Аннулирован)
limit	int32	Необязательный	Количество возвращаемых элементов при запросе
offset	int32	Необязательный	Смещение от начала выборки

Sort_orders

Модель сортировки выходных параметров

Название	Тип данных	Описание параметра
column	enum	Значение для сортировки: SessionCode(), Code(Код кассовой смены), Amount(Сумма документа), Date(), IsReturn(), SaleStatus(Статус чека), StockName(Наименование склада), FirmName(Наименование предприятия)
direction	enum	Порядок сортировки: ASC (По возрастанию), DESC (По убыванию)

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

{
    "uuid": "f44289c4-6edc-48d0-a40f-63d718f35993",
    "start_date": null,
    "end_date": null,
    "search": "Офис 1",
    "session_uuid": "4264195d-7c35-47cb-bbb9-baa2d2cea624",
    "operating_cash_ids": [1],
    "stock_ids": [1],
    "firm_ids": [1],
    "customer_ids": [0,1,2,3],
    "sort_orders": [
      {
         "column":"StartDate",
         "direction":"DESC"
      }
    ],
    "is_return": false,
    "sale_status": "Closed",
    "limit": 1,
    "offset": 0
}

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

Название	Тип данных	Описание параметра
Result	Array of DocChequeShort	Массив чеков
next_offset	Int32	Смещение для следующей выборки данных
total	Int32	Общее количество элементов

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

{
  "ok": true,
  "result": [
    {
      "uuid": "00597cdb-97f5-4a93-a470-76481828ebd2",
      "operating_cash_id": 1,
      "date": 1683550191,
      "code": "WEB-0000135",
      "sale_status": 3,
      "session_uuid": "e2c42d62-dcef-4624-ae37-dba39074561c",
      "session_code": "WEB-0000048",
      "is_return": false,
      "amount": 30000,
      "stock_id": 1,
      "stock_name": "Офис 1",
      "firm_id": 1,
      "firm_name": "REGOS",
      "customer_id": 0,
      "customer_name": "",
      "card_id": 0,
      "card_barcode": ""
    }
  ],
  "next_offset": 1,
  "total": 1218
}