[POST] …/v1/DocWholeSaleReturn/get
Возвращает информацию о документе оптового возврата
Входные параметры
| Название | Тип данных | Обязательность | Описание параметра |
|---|---|---|---|
| start_date | Int64 | Необязательный | Дата начала периода в формате unixtime в секундах |
| end_date | Int64 | Необязательный | Дата окончания периода в формате unixtime в секундах |
| ids | array of int64 | Необязательный | Массив id документов оптового возврата |
| firm_ids | array of int64 | Необязательный | Массив id предприятий |
| stock_ids | array of int64 | Необязательный | Массив id складов |
| partner_ids | array of int64 | Необязательный | Массив id контрагентов |
| contract_ids | array of int64 | Необязательный | Массив id договоров |
| attached_user_ids | array of int64 | Необязательный | Массив id ответственных пользователей |
| sort_orders | Sort_orders | Необязательный | Сортировка выходных данных - Объект класса Sort_orders |
| blocked | bool | Необязательный | Метка о блокировке документа |
| performed | bool | Необязательный | Метка о проведении документа |
| deleted_mark | bool | Необязательный | Метка об удалении |
| limit | Int32 | Необязательный | Лимит возвращаемых данных при запросе |
| offset | Int32 | Необязательный | Смещение от начала выборки |
Модель сортировки выходных параметров
| Название | Тип данных | Описание параметра |
|---|---|---|
| column | enum | Значение для сортировки: Id ( Id документа), Date (Дата), Code (Код документа), PartnerName (Контрагент), StockName (Склад), CurrencyName (Валюта), ContractName (Договор), Amount (Количество), VatCalculationType (Тип НДС), AttacheUserName (Ответственный пользователь), Blocked (Блокировка), Performed (Проведен), DeletedMark (Метка на удаление), LastUpdate (Дата изменения) |
| direction | enum | Порядок сортировки: ASC (По возрастанию), DESC (По убыванию) |
Пример запроса
{
"start_date":1534153454,
"end_date":1534157896,
"ids":[1,2,3],
"firm_ids":[1,2,3],
"stock_ids":[1,2,3],
"partner_ids":[1,2,3],
"contract_ids":[1,2,3],
"attached_user_ids":[1,2],
sort_orders:
[
{
column:'date',
direction:'desc'
}
],
"limit":20,
"offset":3
}Выходные параметры
| Название | Тип данных | Обязательность | Описание параметра |
|---|---|---|---|
| Result | Array of DocWholeSaleReturn | Обязательный | Массив объектов DocWholeSaleReturn |
Пример ответа
{
"ok": true,
"result": [
{
"id": 1,
"date": 1539938097,
"code": "WRT-0000001",
"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": ""
},
"stock": {
"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
},
"currency": {
"id": 1,
"code_num": 860,
"code_chr": "UZS",
"name": "Узбекский сум",
"exchange_rate": 1,
"is_base": true,
"last_update": 1537706844
},
"contract": {
"id": 1,
"code": "1",
"name": "№1 от 08.10.2018",
"date": 1539014177,
"start_date": 1539014177,
"end_date": 1539014177,
"partner_id": 1,
"firm_id": 1,
"direction": "Income",
"currency_id": 1,
"amount": 250000,
"details": "ПОставка товаров",
"description": null,
"deleted_mark": false,
"last_update": 1541489991
},
"description": null,
"vat_calculation_type": "No",
"amount": 53900,
"exchange_rate": 1,
"blocked": false,
"performed": false,
"deleted_mark": false,
"last_update": 1541489991
}
],
"next_offset": 1,
"total": 2
}