Get

[POST] …/DocCashSession/Get

Возвращает кассовые смены.

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

Название Тип данных Обязательность Описание
uuids Array of String Необязательный Массив UUID смен
operating_cash_ids Array of Int64 Необязательный Массив ID касс, к которым привязаны смены
start_date Int64 Необязательный Дата начала периода в формате unix time в секундах
end_date Int64 Необязательный Дата окончания периода в формате unix time в секундах
is_agregated Boolean Необязательный Статус агрегации кассовых операций: true - Агрегированы, false - Не агрегированы
is_close Boolean Необязательный Статус смены: true - Закрыта, false - Не закрыта
open_user_id Int64 Необязательный ID пользователя, открывшего смену
close_user_id Int64 Необязательный ID пользователя, закрывшего смену
sort_orders Array of SortOrders Необязательный Сортировака выходных параметров
limit Int32 Необязательный Лимит возвращаемых данных при запросе. Значение по умолчанию 10000. Максимальное значение 10000
offset Int32 Необязательный Смещение от начала выборки
SortOrders

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

Название Тип данных Обязательность Описание
column Enum Необязательный Значение для сортировки: <Uuid | 1> - UUID Смены, <Code | 2> - Код смены, <OperatingCashId | 3> - ID кассы, <StartDate | 4> - Дата открытия смены, <StartUserName | 5> - ФИО открывшего смену кассира, <StartAmount | 6> - Сумма в кассе на момент открытия смены, <CloseDate | 7> - Дата закрытия смены, <CloseUserName | 8> - ФИО закрывшего смену кассира, <Closed | 9> - Смена закрыта, <CloseAmount | 10> - Сумма в кассе на момент закрытия смены, <LastUpdate | 11> - Последнее изменение в unix time
direction Enum Необязательный Порядок сортировки: <ASC | 1> - По возростанию, <DESC | 2> - По убыванию

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

{
   "uuids":null,
   "operating_cash_ids":null,
   "start_date":1602442800,
   "end_date":1607713199,
   "is_agregated": true,
   "is_close": true,
   "open_user_id": 1,
   "close_user_id": 1,
   "sort_orders": [
        {
          "column": "Code",
          "direction": "ASC"
        }
    ],
   "limit":1,
   "offset":1
}

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

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

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

{
    "ok": true,
    "result": [
        {
            "uuid": "6ab5087b-64fa-4cd2-8bc9-d5099e0fd45c",
            "code": "WEB-0000004",
            "operating_cash_id": 1,
            "start_date": 1592573622,
            "start_user": {
                "id": 1,
                "full_name": "John Fitzgerald Kennedy",
                "main_phone": "998123456789",
                "user_group": {
                    "id": 1,
                    "parent_id": 1,
                    "name": "Administrators",
                    "child_count": 1,
                    "last_update": 1529755889
                },
                "enable_hints": true,
                "system": true,
                "seller_barcode": "1010000001000000",
                "last_update": 1532276019,
                "first_name": "John",
                "last_name": "Kennedy",
                "middle_name": "Fitzgerald",
                "sex": "Male",
                "date_of_birth": "1993-12-21",
                "address": "456 Elm Street, Suite 3, Los Angeles, CA 90001, USA",
                "phones": "998123456789",
                "email": "example@example.com",
                "description": "example",
                "login": "Admin",
                "can_authorize": true,
                "active": true,
                "language_code": "RUS"
            },
            "start_amount": 10000.0,
            "close_date": 1592573622,
            "close_user": {
                "id": 1,
                "full_name": "John Fitzgerald Kennedy",
                "main_phone": "998123456789",
                "user_group": {
                    "id": 1,
                    "parent_id": 1,
                    "name": "Administrators",
                    "child_count": 1,
                    "last_update": 1529755889
                },
                "enable_hints": true,
                "system": true,
                "seller_barcode": "1010000001000000",
                "last_update": 1532276019,
                "first_name": "John",
                "last_name": "Kennedy",
                "middle_name": "Fitzgerald",
                "sex": "Male",
                "date_of_birth": "1993-12-21",
                "address": "456 Elm Street, Suite 3, Los Angeles, CA 90001, USA",
                "phones": "998123456789",
                "email": "example@example.com",
                "description": "example",
                "login": "Admin",
                "can_authorize": true,
                "active": true,
                "language_code": "RUS"
            },
            "closed": true,
            "close_amount": 10000.0,
            "last_update": 1592573622
        }
    ],
    "next_offset": 2,
    "total": 1
}