GetShort - УСТАРЕВШЕЕ

DocChequeShort - УСТАРЕВШЕЕ

МЕТОД УСТАРЕВШИЙ - будет отключен в ноябре 2025 года

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

Название Тип данных Описание
uuid String UUID чека
operating_cash_id Int64 ID кассы
date Int64 Дата чека в unix time
code String Код чека
sale_status Enum Статус чека: <Opened | 1> - Открыт, <Paying | 2> - В процессе оплаты, <Closed | 3> - Закрыт, <Delayed | 4> - Отложен, <DelayedPayment | 5> - Отложен в процессе оплаты, <Canceled | 6> - Аннулирован
session_uuid String UUID коссовой смены
session_code String Код коссовой смены
is_return Boolean Вид чека: true - чек возврата, false - чек продажи
amount Decimal Сумма чека
stock_id Int64 ID склада
stock_name String Наименование склада
firm_id Int64 ID фирмы
firm_name String Наименование предприятия
customer_id Int64 D покупателя
customer_name String Наименование покупателя
card_id Int64 ID карты лояльности
card_barcode String Штрих-код карты лояльности

[POST] …/v1/DocCheque/GetShort

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

Чеки доступны только за период не более 1 месяца. При передаче uuids или session_uuids ограничение по датам не применяется.

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

Название Тип данных Обязательность Описание
uuids Array of String Необязательный Массив UUID чеков
start_date Int64 Необязательный Дата начала периода в формате unix time в секундах
end_date Int64 Необязательный Дата окончания периода в формате unix time в секундах
search String Необязательный Строка поиска по полям: code - Код чека, Stock/name - Наименование склада, Firm/name - Наименование предприятия
session_uuids Array of 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 Array of SortOrders Необязательный Сортировака выходных параметров
is_return Boolean Необязательный Вид чека: true - чек возврата, false - чек продажи
sale_status Enum Необязательный Статус чека: <Opened | 1> - Открыт, <Paying | 2> - В процессе оплаты, <Closed | 3> - Закрыт, <Delayed | 4> - Отложен, <DelayedPayment | 5> - Отложен в процессе оплаты, <Canceled | 6> - Аннулирован
limit Int32 Необязательный Количество возвращаемых элементов при запросе
offset Int32 Необязательный Смещение от начала выборки
SortOrders

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

Название Тип данных Обязательность Описание
column Enum Необязательный Значение для сортировки: <SessionCode | 1> - Код смены, <Code | 2> - Код чека, <Amount | 3> - Сумма чека, <Date | 4> - Дата, <IsReturn | 5> - Чек продажи или возврата, <SaleStatus | 6> - Статус чека, <StockName | 7> - Наименование склада, <FirmName | 8> - Наименование предприятия
direction Enum Необязательный Порядок сортировки: <ASC | 1> - по возростанию, <DESC | 2> - по убыванию

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

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

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

Название Тип данных Описание
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": "Closed",
            "session_uuid": "e2c42d62-dcef-4624-ae37-dba39074561c",
            "session_code": "WEB-0000048",
            "is_return": false,
            "amount": 30000.1,
            "stock_id": 1,
            "stock_name": "Офис 1",
            "firm_id": 1,
            "firm_name": "REGOS",
            "customer_id": 1,
            "customer_name": "Paul",
            "card_id": 1,
            "card_barcode": "1234567890123"
        }
    ],
    "next_offset": 1,
    "total": 1
}