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 Необязательный Сортировки выходных данных
search string Необязательный Строка поиска по полям: name, fullname, address, inn, rs
deleted_mark bool Необязательный null - показывает всё, true - только помеченнае на удаление, false - не помечанные на удаление
limit Int32 Необязательный Лимит возвращаемых данных при запросе. Значение по умолчанию 10000. Максимальное значение 10000
offset Int32 Необязательный Смещение от начала выборки


SortOrders

Модель сортировки выходных параметров

Название Тип данных Описание
column enum Значение для сортировки: <Id | 1> (Id контрагента), <Name | 2> (Наименование контрагента), <LegalStatus | 3> (Юридический статус), <Fullname | 4> (Полное наименование), <Bossname | 5> (ФИО руководителя), <Address | 6> (Адрес), <Phones | 7> (Телефоны), <Inn | 8> (ИНН), <BankName | 9> (Наименование банка), <Mfo | 10> (МФО), <Rs | 11> (Расчетный счет), <Oked | 12> (ОКЭД), <VatIndex | 13> (НДС), <LastUpdate | 14> (Дата изменения)
direction enum Порядок сортировки: <ASC | 1> (по возростанию), <DESC | 2> (по убыванию)

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

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

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

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

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

{
  "ok": true,
  "result": [
    {
      "id": 1,
      "group": {
        "id": 1,
        "parent_id": 0,
        "name": "Поставщики",
        "child_count": 0,
        "last_update": 1693395102
      },
      "deleted_mark": false,
      "last_update": 1728627216,
      "legal_status": "Legal",
      "name": "Coca-cola company",
      "fullname": "",
      "boss_name": "",
      "address": "ауывававуа",
      "phones": "",
      "description": "",
      "inn": "111111111",
      "bank_name": "",
      "mfo": "",
      "rs": "",
      "oked": "",
      "vat_index": ""
    }
  ],
  "next_offset": 1,
  "total": 6
}