Field

Модель представляет дополнительное (кастомное) поле, привязанное к сущности в системе — содержит метаданные поля: ключ, название, тип данных, к какой сущности привязано, обязательность и т.п.

Название	Тип данных	Описание
id	Int64	Идентификатор поля
key	String	Уникальный ключ поля (machine-name)
name	String	Читабельное наименование поля
entity_type	Enum	Сущность, к которому привязано дополнительное поле
data_type	Enum	Тип данных значения поля. Допустимые значения: `string`, `int`, `decimal`, `bool`
metadata	String	Метаданные поля. Необязательное поле, максимум 500 символов с учётом экранирования
is_custom	Boolean	Признак: поле пользовательское (`true`) или системное (`false`)
required	Boolean	Обязательное поле (`true`) или нет (`false`)

Допустимые значения entity_type

Название	Описание
RetailCustomer	Розничный покупатель
Partner	Контрагент
DocPurchase	Док. поступления от контрагента
DocPayment	Док. платежа
DocAccountMovement	Док. перевода между счетами
Item	Номенклатура
Task	Задача проекта
Lead	CRM-обращение
Deal	CRM-сделка
Client	CRM-клиент
Ticket	CRM-тикет

Модели доп. полей, используемые в объектах сущности

Ниже — описание трёх моделей, которые используются в объектах сущности. Каждая модель обычно передаётся/принимается как массив элементов (FieldValue[], FieldValueAdd[], FieldValueEdit[]).

FieldValue — модель значения доп. поля (используется в модели объекта сущности)

Название	Тип данных	Описание
key	string	Ключ поля
name	string	Читабельное наименование поля
data_type	string	Тип данных поля. Допустимые значения: `string`, `int`, `decimal`, `bool`
metadata	string	Метаданные поля. Может быть `null`
is_custom	Boolean	Признак: поле пользовательское (`true`) или системное (`false`)
required	Boolean	Обязательное поле (`true`) или нет (`false`)
value	string	Значение поля в текстовом представлении. При обработке на сервере/клиенте значение конвертируется в тип, указанный в `data_type`

В объекте сущности хранится массив FieldValue[]. Сервер ожидает, что value приведён к строковому представлению; типовая валидация/конвертация выполняется на стороне API по data_type.

FieldValueAdd — модель для добавления значения доп. поля при создании сущности

Название	Тип данных	Описание
key	string	Ключ поля
value	string	Значение поля в строковом представлении. Будет конвертировано к `data_type` при сохранении

При создании сущности передаётся массив FieldValueAdd[]. Обязательность передачи конкретных полей определяется моделью и бизнес-правилами (например, если поле required = true — требуется передать значение).

Если для поля с data_type = int, data_type = bool или data_type = decimal передано пустое значение (""), такое значение игнорируется: новая запись значения по этому полю не создаётся.

FieldValueEdit — модель для редактирования значения доп. поля в сущности

Название	Тип данных	Описание
key	string	Ключ поля
value	string	Новое значение поля в строковом представлении
deleted	bool	Метка удаления значения по этому полю в сущности. `true` — удалить значение; `false` — оставить/обновить. По умолчанию `false`.

При редактировании сущности используется массив FieldValueEdit[]. Если deleted = true, значение поля будет удалено (сервер игнорирует value в этом случае).

Если для поля с data_type = int, data_type = bool или data_type = decimal передано пустое значение (""), такое значение игнорируется: текущее значение по этому полю не изменяется.