20.04.2026 12:35

GetFields

[POST] .../v1/filter/getfields

Возвращает список полей, доступных для фильтрации по выбранной сущности.

Как формируется список полей

  1. Метод обходит все сущности, поддерживающие Filter, и получает от каждой её стандартные фильтруемые поля.
  2. Из общего реестра берётся список стандартных полей для entity_type, переданного в запросе.
  3. Затем для этой же сущности добавляются пользовательские дополнительные поля (field_*).
  4. Итоговый список дедуплицируется по field без учёта регистра.

Для entity_type = Item стандартные поля возвращаются как объединение полей, используемых в Item/Get и Item/GetExt:
icps, articul, comission_tin, package_code, price, last_purchase_cost, quantity.booked, quantity.common, quantity.allowed, min_quantity.

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

Название Тип данных Обязательность Описание
entity_type Enum (FieldEntityTypeEnum) Обязательный Сущность, для которой нужно вернуть список полей фильтрации.

Поддерживаемые значения: RetailCustomer, Partner, Item, DocPurchase, DocPayment, DocAccountMovement, Task, Lead, Deal, Client, Ticket.

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

{
  "entity_type": "Item"
}

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

Название Тип данных Описание
result Array of Object Массив полей для фильтрации в формате { field, datatype }.
result[].field String Имя поля, доступного для фильтрации.
result[].datatype String Тип данных поля: string, int, decimal, bool.

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

{
  "ok": true,
  "result": [
    { "field": "icps", "datatype": "string" },
    { "field": "articul", "datatype": "string" },
    { "field": "price", "datatype": "decimal" },
    { "field": "quantity.common", "datatype": "decimal" },
    { "field": "field_telegram_id", "datatype": "string" }
  ]
}