[POST] …/v1/DocInventory/get
Возвращает информацию о документе инвентаризации
Входные параметры
Название | Тип данных | Обязательность | Описание параметра |
---|---|---|---|
start_date | Int64 | Необязательный | Дата начала периода в формате unixtime в секундах |
end_date | Int64 | Необязательный | Дата окончания периода в формате unixtime в секундах |
ids | array of int64 | Необязательный | Массив id документов перемещения |
compare_type | enum | Необязательный | Тип сопоставления: open_date (На дату открытия), close_date (На дату закрытия) |
stock_ids | array of int64 | Необязательный | Массив id складов |
attached_user_ids | array of int64 | Необязательный | Массив id ответственных пользователей |
sort_orders | Sort_orders | Необязательный | Сортировка выходных данных - Объект класса Sort_orders |
blocked | bool | Необязательный | Метка о блокировке документа |
closed | bool | Необязательный | Метка о закрытии документа |
deleted_mark | bool | Необязательный | Метка об удалении |
limit | Int32 | Необязательный | Лимит возвращаемых данных при запросе. Значение по умолчанию 10000. Максимальное значение 10000 |
offset | Int32 | Необязательный | Смещение от начала выборки |
Модель сортировки выходных параметров
Название | Тип данных | Описание параметра |
---|---|---|
column | enum | Значение для сортировки: Id ( Id документа), Code (Код документа, OpenDate (Дата открытия инвентаризации), CloseDate (Дата закрытия инвентаризации), CompareType (Тип сопоставления), StockName (Склад), AttacheUserName (Ответственный пользователь), Blocked (Блокировка), Performed (Проведен), DeletedMark (Метка на удаление), LastUpdate (Дата изменения) |
direction | enum | Порядок сортировки: ASC (По возрастанию), DESC (По убыванию) |
Пример запроса
{
"start_date":1534153454,
"end_date":1534157896,
"ids":[1,2,3],
"stock_ids":[1,2,3],
"compare_type":"close_date",
"sort_orders":
{
"column":'date',
"direction":'desc'
},
"limit":20,
"offset":3
}
Выходные параметры
Название | Тип данных | Обязательность | Описание параметра |
---|---|---|---|
Result | Array of DocInventory | Обязательный | Массив объектов DocInventory |
Пример ответа
{
"ok": true,
"result": [
{
"id": 3,
"date": 1540536481,
"code": "MVT-0000001",
"stock": {
"id": 2,
"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": 1539015217
},
"description": null,
"closed": false,
"blocked": false,
"deleted_mark": false,
"last_update": 1541420059
}
],
"next_offset": 1,
"total": 5
}