Get

[POST] …/v1/Partner/Get

Возвращает информацию о контрагенте.

Входные параметры

Название Тип данных Обязательность Описание
ids Array of int64 Необязательный Массив id контрагентов
group_ids Array of int64 Необязательный Массив id групп контрагентов
legal_status Enum Необязательный Юридический статус: <Legal | 1> - юр. лицо, <Natural | 2> - физ. лицо
sort_orders Array of SortOrders Необязательный Сортировка выходных параметров
filters Array of Filter Необязательный Фильтры по основным и дополнительным полям
search String Необязательный Строка поиска по полям: name, fullname, address, inn, rs
deleted_mark Boolean Необязательный Пометка на удаление: true - помеченные на удаление, false - не помеченные на удаление
limit Int32 Необязательный Лимит возвращаемых данных при запросе.
offset Int32 Необязательный Смещение от начала выборки

Поля, доступные для сортировки (sort_orders):

id, name, legal_status, fullname, boss_name, address, phones, inn, bank_name, mfo, rs, oked, vat_index, last_update

Поля, доступные для фильтрации (filters):

name, phones, inn, rs, mfo, vat_index, oked

Пример запроса

{
    "ids":[1],
    "group_ids":[1],
    "legal_status": "Natural",
    "sort_orders":
    [
      {
        "column":"Name",
        "direction":"desc"
      }
    ],
    "search": "Tashkent",
    "deleted_mark": "false",
    "limit":1,
    "offset":1
}

Выходные параметры

Название Тип данных Описание
result Array of Partner Массив контрагентов
next_offset Int32 Смещение для следующей выборки данных
total Int32 Количество элементов выборки

Пример ответа

{
    "ok": true,
    "result": [
        {
            "id": 1,
            "group": {
                "id": 1,
                "parent_id": 1,
                "name": "Поставщики",
                "child_count": 1,
                "last_update": 1693395102
            },
            "legal_status": "Legal",
            "name": "Coca-cola company",
            "fullname": "Eric George Blair",
            "boss_name": "Arthur",
            "address": "100017, A.Qodiriy ko’chasi 981 uy",
            "phones": "+998987654321",
            "description": "Book Shop",
            "inn": "123456789",
            "bank_name": "Ipak Yo'li Banki",
            "mfo": "00450",
            "rs": "29802000600000444085",
            "oked": "62.03.0",
            "vat_index": "12",
            "deleted_mark": false,
            "last_update": 1728627216
        }
    ],
    "next_offset": 1,
    "total": 1
}