[POST] …/v1/DocPayment/get
Возвращает информацию о документе оплаты
Входные параметры
| Название | Тип данных | Обязательность | Описание параметра |
|---|---|---|---|
| payment_direction | enum | Необязательный | Тип направления оплаты документа ( Income = 1, Outcome = 2) |
| start_date | Int64 | Необязательный | Дата начала периода в формате unixtime в секундах |
| end_date | Int64 | Необязательный | Дата окончания периода в формате unixtime в секундах |
| ids | array of int64 | Необязательный | Массив id документов оплаты |
| partner_ids | array of int64 | Необязательный | Массив id контрагентов |
| firm_ids | array of int64 | Необязательный | Массив id предприятий |
| contract_ids | array of int64 | Необязательный | Массив id договоров |
| document_type_ids | array of int64 | Необязательный | Массив id типов документов |
| document_ids | array of int64 | Необязательный | Массив id документов |
| attached_user_ids | array of int64 | Необязательный | Массив id ответственных пользователей |
| sort_orders | Sort_orders | Необязательный | Сортировка выходных данных - Объект класса Sort_orders |
| limit | Int32 | Необязательный | Лимит возвращаемых данных при запросе |
| offset | Int32 | Необязательный | Смещение от начала выборки |
Модель сортировки выходных параметров
| Название | Тип данных | Описание параметра |
|---|---|---|
| column | enum | Значение для сортировки: Id ( Id документа), Date (Дата), Code (Код документа), TypeName (Тип документа), ContractName (Договор), FirmName (Предприятие), PartnerName (Контрагент), CategoryName (Категория операции), Amount (Сумма), AttacheUserName (Ответственный пользователь), Performed (Проведен), DeletedMark (Метка на удаление), LastUpdate (Дата изменения) |
| direction | enum | Порядок сортировки: ASC (По возрастанию), DESC (По убыванию) |
Пример запроса
{
"payment_direction":"income",
"start_date":1534153454,
"end_date":1534157896,
"ids":[1,2,3],
"partner_ids":[1,2,3],
"firm_ids":[1,2,3],
"contract_ids":[1,2,3],
"document_type_ids":[1,2,3],
"document_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 DocPayment | Массив объектов DocPayment |
Пример ответа
{
"ok": true,
"result": [
{
"id": 1,
"date": 1539335663,
"code": "2018-0000022",
"type": {
"id": 1,
"name": "Перечисление",
"account": {
"id": 1,
"code": "1",
"name": "Основной счет",
"currency": {
"id": 1,
"code_num": 860,
"code_chr": "UZS",
"name": "Узбекский сум",
"exchange_rate": 1,
"is_base": true,
"last_update": 1537706844
},
"last_update": 1549300287
},
"is_cash": false,
"kkm_code": -1,
"last_update": 1545899004,
"image_url": "https://cdn.regos.uz/5fbc650b-6166-4e1b-8864-f93c0617bbf8/i_1678063359_905ee850-3e41-4ec9-b70a-b78b5d7d52f0.png",
"enabled": "True"
},
"document_id": 0,
"document_type_id": 0,
"contract": {
"id": 4,
"code": "1",
"name": "№1 от 12.10.2018",
"date": 1539335664,
"start_date": 1539335664,
"end_date": 1539335664,
"partner_id": 1,
"firm_id": 1,
"direction": "Outcome",
"currency_id": 1,
"amount": 25000,
"details": "c",
"description": null,
"deleted_mark": false,
"last_update": 1539335733
},
"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": ""
},
"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": ""
},
"category": {
"id": 2,
"parent_id": 0,
"name": "Поступление ден. средств за выполнение работ",
"positive": true,
"last_update": 1539325474
},
"amount": 5000,
"exchange_rate": 1,
"performed": true,
"description": "4454",
"deleted_mark": false,
"last_update": 1539337488
}
],
"next_offset": 1,
"total": 4
}