[POST] …/v1/DocOrderToMovement/get
Возвращает информацию о документе заказа на перемещение
Входные параметры
Название | Тип данных | Обязательность | Описание параметра |
---|---|---|---|
start_date | Int64 | Необязательный | Дата начала периода в формате unixtime в секундах |
end_date | Int64 | Необязательный | Дата окончания периода в формате unixtime в секундах |
ids | array of int64 | Необязательный | Массив id документов заказа на перемещение |
stock_receiver_ids | array of int64 | Необязательный | Массив id складов получателей |
firm_receiver_ids | array of int64 | Необязательный | Массив id фирм получателей |
attached_user_ids | array of int64 | Необязательный | Массив id ответственных пользователей |
status_ids | array of int64 | Необязательный | Массив id статусов |
sort_orders | Sort_orders | Необязательный | Сортировка выходных данных - Объект класса Sort_orders |
blocked | bool | Необязательный | Метка о блокировке документа |
deleted_mark | bool | Необязательный | Метка об удалении |
limit | Int32 | Необязательный | Лимит возвращаемых данных при запросе. Значение по умолчанию 10000. Максимальное значение 10000 |
offset | Int32 | Необязательный | Смещение от начала выборки |
Модель сортировки выходных параметров
Название | Тип данных | Описание параметра |
---|---|---|
column | enum | Значение для сортировки: Id ( Id документа), Date (Дата), Code (Код документа), StockReceiverName (Склад), StatusId (Статус), AttacheUserName (Ответственный пользователь), Blocked (Блокировка), DeletedMark (Метка на удаление), LastUpdate (Дата изменения) |
direction | enum | Порядок сортировки: ASC (По возрастанию), DESC (По убыванию) |
Пример запроса
{
"start_date":1534153454,
"end_date":1534157896,
"ids":[1,2,3],
"status_ids":[1,2],
"stock_receiver_ids":[1,2,3],
"firm_receiver_ids":[1,2,3],
"attached_user_ids":[1,2],
sort_orders:
[
{
column:'date',
direction:'desc'
}
],
"limit":20,
"offset":3
}
Выходные параметры
Название | Тип данных | Обязательность | Описание параметра |
---|---|---|---|
Result | Array of DocOrderToMovement | Обязательный | Массив объектов DocOrderToMovement |
Пример ответа
{
"ok": true,
"result": [
{
"id": 1,
"date": 1540384987,
"code": "OTM-0000001",
"stock_receiver": {
"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
},
"status": {
"id": 11,
"document_type_id": 14,
"name": "Новый",
"order": 1,
"last_update": 1540311075
},
"blocked": false,
"deleted_mark": false,
"last_update": 1541419926
}
],
"next_offset": 1,
"total": 5
}