[POST] …/v1/DocOrderFromPartner/get
Возвращает информацию о документе заказа от контрагента
Входные параметры
| Название | Тип данных | Обязательность | Описание параметра |
|---|---|---|---|
| start_date | Int64 | Необязательный | Дата начала периода в формате unixtime в секундах |
| end_date | Int64 | Необязательный | Дата окончания периода в формате unixtime в секундах |
| ids | array of int64 | Необязательный | Массив id документов заказа от контрагента |
| partner_ids | array of int64 | Необязательный | Массив id контрагентов |
| stock_ids | array of int64 | Необязательный | Массив id складов |
| contract_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 | Значение для сортировки: Code (Код документа), Date (Дата), ContractName (Наименование договора), PartnerName (Наименование контрагента), StockName (Склад), FirmName(Предприятие), OrderStatusName (Статус заказа), Amount (Количество), CurrencyName (Валюта) |
| direction | enum | Порядок сортировки: ASC (По возрастанию), DESC (По убыванию) |
Пример запроса
{
"start_date":1534153454,
"end_date":1534157896,
"ids":[1,2,3],
"partner_ids":[1,2,3],
"stock_ids":[1,2,3],
"contract_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 DocOrderFromPartner | Обязательный | Массив объектов DocOrderFromPartner |
Пример ответа
{
"ok": true,
"result": [
{
"id": 1,
"date": 1539866961,
"code": "OFP-0000002",
"contract": {
"id": 3,
"code": "122",
"name": "№122 от 12.10.2018",
"date": 1539326016,
"start_date": 1539326016,
"end_date": 1539326016,
"partner_id": 1,
"firm_id": 1,
"direction": "Income",
"currency_id": 3,
"amount": 500,
"details": "123",
"description": null,
"deleted_mark": false,
"last_update": 1541409480
},
"partner": {
"id": 1,
"group": {
"id": 1,
"parent_id": 0,
"name": "Поставщики",
"last_update": 1539013744
},
"deleted_mark": false,
"last_update": 1548936070,
"legal_status": "Legal",
"name": "OOO NEW HORIZON",
"fullname": "OOO NEW HORIZON Trade Inc.",
"address": "",
"phones": "",
"description": null,
"inn": "",
"bank_name": "",
"mfo": "",
"rs": "",
"oked": ""
},
"currency": {
"id": 3,
"code_num": 643,
"code_chr": "RUB",
"name": "Российский рубль",
"exchange_rate": 150,
"is_base": false,
"last_update": 1535544269
},
"exchange_rate": 150,
"vat_calculation_type": "No",
"amount": 0,
"status": {
"id": 2,
"document_type_id": 12,
"name": "Утвержден",
"order": 5,
"last_update": 1537691463
},
"booked": true,
"blocked": false,
"deleted_mark": false,
"last_update": 1541409480
}
],
"next_offset": 1,
"total": 4
}