[POST] …/v1/DocMovement/Get
Возвращает документы перемещения.
Входные параметры
Название | Тип данных | Обязательность | Описание |
---|---|---|---|
start_date | Int64 | Необязательный | Дата начала периода в формате unix time в секундах |
end_date | Int64 | Необязательный | Дата окончания периода в формате unix time в секундах |
ids | Array of int64 | Необязательный | Массив ID документов перемещения |
stock_sender_ids | Array of int64 | Необязательный | Массив ID складов отправителей |
stock_receiver_ids | Array of int64 | Необязательный | Массив ID складов получателей |
firm_sender_ids | Array of int64 | Необязательный | Массив ID фирм отправителей |
firm_receiver_ids | Array of int64 | Необязательный | Массив ID фирм получателей |
attached_user_ids | Array of int64 | Необязательный | Массив ID ответственных пользователей |
performed | Boolean | Необязательный | Метка о проведении документа |
blocked | Boolean | Необязательный | Метка о блокировке документа |
deleted_mark | Boolean | Необязательный | Метка об удалении |
search | String | Необязательный | Поиск про значениям параметров: code - Код документа, Stock/name - Наименование склада, Partner/name - Наименование контрагента, Partner/inn - ИНН контрагента, User/name - ФИО ответственного лица, DocContract/code - Код договора, Firm/name - Наименование предприятия, Firm/inn - ИНН предприятия |
sort_orders | Array of SortOrders | Необязательный | Сортировака выходных параметров |
limit | Int32 | Необязательный | Лимит возвращаемых данных при запросе. Значение по умолчанию 10000. Максимальное значение 10000 |
offset | Int32 | Необязательный | Смещение от начала выборки |
Модель сортировки выходных параметров.
Название | Тип данных | Обязательность | Описание |
---|---|---|---|
column | Enum | Необязательный | Значение для сортировки: <Id | 1 > - ID документа, <Date | 2 > - Дата документа, <Code | 3 > - Код документа, <StockSenderName | 4 > - Наименование склада отправителя, <StockReceiverName | 5 > - Наименование склада получателя, <AttacheUserName | 6 > - ФИО ответственного пользователя, <Performed | 7 > - Проведён, <Blocked | 8 > - Заблокирован, <DeletedMark | 9 > - Помечен на удаление, <LastUpdate | 10 > - Последенее изменение в unix time |
direction | Enum | Необязательный | Порядок сортировки: <ASC | 1 > - По возростанию, <DESC | 2 > - По убыванию |
Пример запроса
{
"start_date":1534153454,
"end_date":1534157896,
"ids":[1],
"stock_sender_ids":[1],
"stock_receiver_ids":[1],
"firm_sender_ids":[1],
"firm_receiver_ids":[1],
"attached_user_ids":[1],
"performed": false,
"blocked": false,
"deleted_mark": false,
"search": "example",
"sort_orders": [
{
"column": "Code",
"direction": "ASC"
}
],
"limit":1,
"offset":1
}
Выходные параметры
Название | Тип данных | Описание |
---|---|---|
result | Array of DocMovement | Массив документов перемещения |
next_offset | Int32 | Смещение для следующей выборки данных |
total | Int32 | Количество элементов выборки |
Пример ответа
{
"ok": true,
"result": [
{
"id": 3,
"date": 1540536481,
"code": "MVT-0000001",
"stock_sender": {
"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
},
"stock_receiver": {
"id": 2,
"name": "Новомосковская2",
"address": "example2",
"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А2",
"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": "example",
"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"
},
"performed": false,
"blocked": false,
"current_user_blocked": false,
"deleted_mark": false,
"last_update": 1541420059
}
],
"next_offset": 1,
"total": 1
}