[POST] …/v1/DocCommercialOffer/get
Возвращает информацию о документе коммерческого предложения
Входные параметры
Название | Тип данных | Обязательность | Описание параметра |
---|---|---|---|
start_date | Int64 | Необязательный | Дата начала периода в формате unixtime в секундах |
end_date | Int64 | Необязательный | Дата окончания периода в формате unixtime в секундах |
ids | array of int64 | Необязательный | Массив id документов коммерческого предложения |
partner_ids | array of int64 | Необязательный | Массив id контрагентов |
currency_ids | array of int64 | Необязательный | Массив id валют |
attached_user_ids | array of int64 | Необязательный | Массив id ответственных пользователей |
vat_calculation_type | enum | Необязательный | Расчет НДС: no (не начислять), exclude (НДС включен в стоимость), include (НДС не включен в стоимость) |
sort_orders | Sort_orders | Необязательный | Сортировка выходных данных - Объект класса Sort_orders |
blocked | bool | Необязательный | Метка о блокировке документа |
deleted_mark | bool | Необязательный | Метка об удалении |
limit | Int32 | Необязательный | Лимит возвращаемых данных при запросе. Значение по умолчанию 10000. Максимальное значение 10000 |
offset | Int32 | Необязательный | Смещение от начала выборки |
Модель сортировки выходных параметров
Название | Тип данных | Описание параметра |
---|---|---|
column | enum | Значение для сортировки: Code (Код документа), Date (Дата), PartnerName (Наименование контрагента), Amount (Количество), CurrencyName (Валюта) |
direction | enum | Порядок сортировки: ASC (По возрастанию), DESC (По убыванию) |
Пример запроса
{
"start_date":1534153454,
"end_date":1534157896,
"ids":[1,2,3],
"partner_ids":[1,2,3],
"sort_orders":
[
{
"column":'date',
"direction":'desc'
}
],
"limit":20,
"offset":3
}
Выходные параметры
Название | Тип данных | Обязательность | Описание параметра |
---|---|---|---|
Result | Array of DocCommercialOffer | Обязательный | Массив объектов DocCommercialOffer |
Пример ответа
{
"ok": true,
"result": [
{
"id": 7,
"date": 1584601184,
"code": "OFF-0000007",
"partner": {
"id": 1,
"group": {
"id": 1,
"parent_id": 0,
"name": "Поставщики",
"last_update": 1574146554
},
"deleted_mark": false,
"last_update": 1574146563,
"legal_status": "Legal",
"name": "AliExpress",
"fullname": null,
"boss_name": null,
"address": null,
"phones": null,
"description": null,
"inn": null,
"bank_name": null,
"mfo": null,
"rs": null,
"oked": null,
"vat_index": null
},
"currency": {
"id": 1,
"code_num": 860,
"code_chr": "UZS",
"name": "Узбекский сум",
"exchange_rate": 1.0,
"is_base": true,
"last_update": 1574075456
},
"description": null,
"amount": 0.0,
"vat_calculation_type": "No",
"exchange_rate": 10.0,
"attached_user": {
"id": 1,
"user_group": {
"id": 1,
"parent_id": 0,
"name": "Admins",
"last_update": 1552326674
},
"first_name": "Administrator",
"last_name": "",
"middle_name": "",
"sex": "none",
"date_of_birth": "1990-01-01",
"address": "Tashkent, Mirabad-5",
"main_phone": "",
"phones": "+998713456789",
"email": "",
"description": "",
"login": "admin",
"can_authorize": true,
"active": true,
"language_code": "RUS",
"last_update": 1583131927
},
"blocked": false,
"deleted_mark": false,
"last_update": 1584601367
}
],
"next_offset": 1,
"total": 5
}