[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 | SortOrders | Необязательный | Сортировка выходных данных - Объект класса |
| limit | Int32 | Необязательный | Лимит возвращаемых данных при запросе. Значение по умолчанию 10000. Максимальное значение 10000 |
| offset | Int32 | Необязательный | Смещение от начала выборки |
Модель сортировки выходных параметров
| Название | Тип данных | Описание |
|---|---|---|
| column | enum | Значение для сортировки: Id ( Id документа), Code Код документа, OpenDate (Дата открытия инвентаризации), CloseDate (Дата закрытия инвентаризации), CompareType (Тип сопоставления), StockName (Склад), AttacheUserName (Ответственный пользователь), Blocked (Блокировка), Performed (Проведен), DeletedMark (Метка на удаление), LastUpdate (Дата изменения) |
| direction | enum | Порядок сортировки: ASC (По возрастанию), DESC (По убыванию) |
Пример запроса
{
"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": "date",
"direction": "desc"
},
"limit": 1,
"offset": 1
}Выходные параметры
| Название | Тип данных | Описание |
|---|---|---|
| Result | Array of DocInventory | Массив документов инвентаризации |
Пример ответа
{
"ok": true,
"result": [
{
"id": 1,
"code": "INV-0000001",
"open_date": 1694511937,
"close_date": 1694512232,
"compare_type": 1,
"stock": {
"id": 1,
"name": "Новомосковская",
"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"
},
"deleted_mark": false,
"last_update": 1705583155
},
"description": null,
"attached_user": {
"id": 5,
"full_name": null,
"main_phone": "998333670115",
"user_group": {
"id": 1,
"parent_id": 0,
"name": "Admins",
"child_count": 0,
"last_update": 1552326674
},
"enable_hints": true,
"system": true,
"first_name": "REGOS Support #1",
"last_name": "Regos",
"middle_name": "",
"sex": "none",
"date_of_birth": "1900-01-01",
"address": null,
"phones": "",
"email": "",
"description": "",
"login": "support1",
"can_authorize": true,
"active": true,
"language_code": "RUS",
"last_update": 1693457772
},
"price_type": {
"id": 1,
"name": "Розничная цена",
"round_to": 1000,
"markup": 20,
"max_discount": 100,
"currency": {
"id": 1,
"code_num": 860,
"code_chr": "UZS",
"name": "Узбекский сум",
"exchange_rate": 1,
"is_base": true,
"deleted": false,
"last_update": 1664715017
},
"currency_additional": {
"id": 2,
"code_num": 840,
"code_chr": "USD",
"name": "USD",
"exchange_rate": 13000,
"is_base": false,
"deleted": false,
"last_update": 1714030051
},
"last_update": 1723116235
},
"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": 51
}