Get

[POST] …/v1/DocInventory/Get

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

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

Название Тип данных Обязательность Описание
compare_type Enum Необязательный Тип сопоставления: <open_date | 1> - На дату открытия, <close_date | 2> - На дату закрытия, <operation_date | 3> - На дату операции
ids Array of int64 Необязательный Массив id документов перемещения
stock_ids Array of int64 Необязательный Массив id складов
attached_user_ids Array of int64 Необязательный Массив id ответственных пользователей
start_date Int64 Необязательный Дата начала периода в формате unix time в секундах
end_date Int64 Необязательный Дата окончания периода в формате unix time в секундах
closed Boolean Необязательный Закрыт ли документ: true - закрыт, false - не закрыт
blocked Boolean Необязательный Заблокирован ли документ: true - заблокирован, false - не заблокирован
deleted_mark Boolean Необязательный Метка об удалении
search String Необязательный Поиск по значениям полей: code, firm->name, firm->inn, stock_name, attached_user_name
sort_orders Array of SortOrders Необязательный Сортировака выходных параметров
limit Int32 Необязательный Лимит возвращаемых данных при запросе. Значение по умолчанию 10000. Максимальное значение 10000
offset Int32 Необязательный Смещение от начала выборки
SortOrders

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

Название Тип данных Обязательность Описание
column enum Необязательный Значение для сортировки: <Id | 1> - ID документа, <Code | 2> - Код документа, <OpenDate | 3> - Дата открытия, <CloseDate | 4> - Дата закрытия, <CompareType | 5> - Тип сопоставления, <StockName | 6> - Наименование склада, <AttacheUserName | 7> - ФИО ответственного пользователя, <Blocked | 8> - Заблокирован, <Closed | 9> - Закрыта, <DeletedMark | 10> - Помечен на удаление, <LastUpdate | 11> - Последнее изменение в unix time
direction Enum Необязательный Порядок сортировки: <ASC | 1> - По возростанию, <DESC | 2> - По убыванию

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

{
    "compare_type": "open_date",
    "ids": [
        1
    ],
    "stock_ids": [
        1
    ],
    "attached_user_ids": [
        1
    ],
    "start_date": 1534153454,
    "end_date": 1534157896,
    "closed": false,
    "blocked": false,
    "deleted_mark": false,
    "search": "Bob",
    "sort_orders": {
        "column": "Code",
        "direction": "ASC"
    },
    "limit": 1,
    "offset": 1
}

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

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

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

{
    "ok": true,
    "result": [
        {
            "id": 1,
            "code": "INV-0000001",
            "open_date": 1694511937,
            "close_date": 1694512232,
            "compare_type": "open_date",
            "stock": {
                "id": 1,
                "name": "Новомосковская",
                "address": "example",
                "firm": {
                    "id": 1,
                    "group": {
                        "id": 1,
                        "parent_id": 0,
                        "name": "Предприятия",
                        "child_count": 0,
                        "last_update": 1715233269
                    },
                    "deleted_mark": false,
                    "last_update": 1715863600,
                    "name": "REGOS",
                    "fullname": "ООО \"REGOS Software\"",
                    "boss_name": "Андрей",
                    "address": "Мукими, 8А",
                    "phones": "+998987654321",
                    "description": "EasyTrade successor",
                    "inn": "305930137",
                    "bank_name": "Ипак Йули",
                    "mfo": "01101",
                    "rs": "22125489632541254782",
                    "oked": "62090",
                    "vat_index": "1325489654785"
                },
                "description": "example",
                "deleted_mark": false,
                "last_update": 1705583155
            },
            "description": null,
            "attached_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"
            },
            "price_type": {
                "id": 1,
                "name": "example",
                "round_to": 0.00,
                "markup": 0.25,
                "max_discount": 0.2,
                "currency": {
                    "id": 1,
                    "code_num": 123,
                    "code_chr": "UZS",
                    "name": "Узбекский сум",
                    "exchange_rate": 1,
                    "is_base": true,
                    "deleted": false,
                    "last_update": 1533619909
                },
                "currency_additional": {
                    "id": 1,
                    "code_num": 123,
                    "code_chr": "USD",
                    "name": "Dolar",
                    "exchange_rate": 1.1,
                    "is_base": false,
                    "deleted": false,
                    "last_update": 1533619909
                },
                "last_update": 1700000000
            },
            "blocked": true,
            "closed": true,
            "full": false,
            "create_docinout": false,
            "external_id": null,
            "current_user_blocked": false,
            "deleted_mark": false,
            "last_update": 1720673909
        }
    ],
    "next_offset": 1,
    "total": 1
}