Get

[POST] …/v1/Firm/get

Возвращает информацию о предприятии.

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

Название Тип данных Обязательность Описание параметра
ids array of int64 Необязательный Массив id предприятий
parent_ids array of int64 Необязательный Массив id групп предприятий
sort_orders Sort_orders Необязательный Сортировка выходных данных
search string Необязательный Строка поиска по полям: name, fullname, address, inn, rs
deleted_mark bool Необязательный Помеченные на удаление: null - показывает всё, true - только помеченнае на удаление, false - не помечанные на удаление
limit Int32 Необязательный Лимит возвращаемых данных при запросе. Значение по умолчанию 10000. Максимальное значение 10000
offset Int32 Необязательный Смещение от начала выборки


Sort_orders

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

Название Тип данных Описание параметра
column enum Значение для сортировки: Id ( Id предприятия), Name (Наименование предприятия), Fullname (Полное наименование), Bossname (ФИО руководителя), Address (Адрес), Phones (Телефоны), Inn (ИНН), BankName (Наименование банка), Mfo (МФО), Rs (Расчетный счет), Oked (ОКЭД), VatIndex (НДС),LastUpdate (Дата изменения)
direction enum Порядок сортировки: ASC (По возрастанию), DESC (По убыванию)

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

{
    "ids": [1],
    "parent_ids": [0],
    "sort_orders": [
        {
            "column": "Name",
            "direction": "desc"
        }
    ],
    "search": "ООО \"REGOS Software\"",
    "deleted_mark": false,
    "limit": 1,
    "offset": 0
}

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

Название Тип данных Описание параметра
Result array of Firm Массив объектов Firm

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

{
  "ok": true,
  "result": [
    {
      "id": 1,
      "group": {
        "id": 1,
        "parent_id": 0,
        "name": "Предприятия",
        "child_count": 0,
        "last_update": 1715233269
      },
      "deleted_mark": false,
      "last_update": 1715863600,
      "name": "REGOS",
      "fullname": "ООО \"REGOS Software\"",
      "boss_name": "Андрей",
      "address": "Мукими, 8А",
      "phones": "+998987654321",
      "description": "EasyTrade successor",
      "inn": "305930137",
      "bank_name": "Ипак Йули",
      "mfo": "01101",
      "rs": "22125489632541254782",
      "oked": "62090",
      "vat_index": "1325489654785"
    }
  ],
  "next_offset": 0,
  "total": 1
}