get

[POST] …/v1/DocInOut/get

Возвращает информацию о документе занесения или списания

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

Название Тип данных Обязательность Описание параметра
inout_type enum Необязательный Тип документа ( income = 1, outcome = 2)
start_date Int64 Необязательный Дата начала периода в формате unixtime в секундах
end_date Int64 Необязательный Дата окончания периода в формате unixtime в секундах
ids array of int64 Необязательный Массив id документов занесения или списания
firm_ids array of int64 Необязательный Массив id предприятий
stock_ids array of int64 Необязательный Массив id складов
attached_user_ids array of int64 Необязательный Массив id ответственных пользователей
sort_orders Sort_orders Необязательный Сортировка выходных данных - Объект класса Sort_orders
blocked bool Необязательный Метка о блокировке документа
performed bool Необязательный Метка о проведении документа
deleted_mark bool Необязательный Метка об удалении
limit Int32 Необязательный Лимит возвращаемых данных при запросе. Значение по умолчанию 10000. Максимальное значение 10000
offset Int32 Необязательный Смещение от начала выборки


Sort_orders

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

Название Тип данных Описание параметра
column enum Значение для сортировки: Id ( Id документа), Type (Тип документа), Date (Дата), Code (Код документа), StockName (Склад), AttacheUserName (Ответственный пользователь), Blocked (Блокировка), Performed (Проведен), DeletedMark (Метка на удаление), LastUpdate (Дата изменения)
direction enum Порядок сортировки: ASC (По возрастанию), DESC (По убыванию)

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

{
    "inout_type":"income",
    "start_date":1534153454,
    "end_date":1534157896,
    "ids":[1,2,3],
    "firm_ids":[1,2,3],
    "stock_ids":[1,2,3],
    "attached_user_ids":[1,2],
    "status_ids":[1,2],
    "sort_orders":
    [
        {
        "column":'date',
        "direction":'desc'
        }
    ],
    "limit":20,
    "offset":3
}

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

Название Тип данных Обязательность Описание параметра
Result Array of DocInOut Обязательный Массив объектов DocInOut

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

{
    "ok": true,
    "result": [
        {
            "id": 5,
            "inout_type": 2,
            "date": 1538498781,
            "code": "2018-0000005",
            "stock": {
                "id": 1,
                "name": "Склад №1",
                "firm": {
                    "id": 1,
                    "group": {
                        "id": 1,
                        "parent_id": 0,
                        "name": "Предприятия",
                        "last_update": 1539013844
                    },
                    "deleted_mark": false,
                    "last_update": 1539013863,
                    "name": "OOO Retail",
                    "fullname": "",
                    "address": "",
                    "phones": "",
                    "description": null,
                    "inn": "",
                    "bank_name": "",
                    "mfo": "",
                    "rs": "",
                    "oked": ""
                },
                "deleted_mark": false,
                "last_update": 1539013883
            },
            "description": null,
            "blocked": false,
            "performed": false,
            "deleted_mark": false,
            "last_update": 1549398176
        }
    ],
    "next_offset": 1,
    "total": 15
}