[POST] …/v1/Partner/get
Возвращает информацию о контрагенте
Входные параметры
Название | Тип данных | Обязательность | Описание параметра |
---|---|---|---|
ids | array of int64 | Необязательный | Массив id контрагентов |
group_ids | array of int64 | Необязательный | Массив id групп контрагентов |
deleted_mark | bool | Необязательный | Метка об удалении |
sort_orders | Sort_orders | Необязательный | Сортировка выходных данных - Объект класса Sort_orders |
search | string | Необязательный | Строка поиска по полям name, fullname, address, inn, rs |
limit | Int32 | Необязательный | Лимит возвращаемых данных при запросе. Значение по умолчанию 10000. Максимальное значение 10000 |
offset | Int32 | Необязательный | Смещение от начала выборки |
Модель сортировки выходных параметров
Название | Тип данных | Описание параметра |
---|---|---|
column | enum | Значение для сортировки: Id ( Id контрагента), Name (Наименование контрагента), LegalStatus (Юридический статус), Fullname (Полное наименование), Bossname (ФИО руководителя), Address (Адрес), Phones (Телефоны), Inn (ИНН), BankName (Наименование банка), Mfo (МФО), Rs (Расчетный счет), Oked (ОКЭД), VatIndex (НДС),LastUpdate (Дата изменения) |
direction | enum | Порядок сортировки: ASC (По возрастанию), DESC (По убыванию) |
Пример запроса
{
"ids":[1,2],
"group_ids":[1,2],
"sort_orders":
[
{
"column":'Name',
"direction":'desc'
}
],
"limit":20,
"offset":3
}
Выходные параметры
Название | Тип данных | Обязательность | Описание параметра |
---|---|---|---|
Result | array of Partner | Обязательный | Массив объектов Partner |
Пример ответа
{
"ok": true,
"result": [
{
"id": 5,
"group": {
"id": 82,
"parent_id": 0,
"name": "Поставщики",
"last_update": 1533619909
},
"deleted_mark": false,
"last_update": 1533714741,
"name": "Megamarket",
"fullname": "ООО Megamarket",
"address": "Ташкент",
"phones": "90 123-67-23",
"description": null,
"inn": null,
"bank_name": null,
"mfo": null,
"rs": null,
"oked": null
}
],
"next_offset": 0,
"total": 2
}