Add

[POST] …/v1/field/add

Создаёт новое дополнительное поле. Все поля, создаваемые через этот метод, сохраняются с флагом is_custom = true.

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

Название	Тип данных	Обязательность	Описание
key	string	Обязательный	Ключ поля (уникален в рамках `entity_type`), не более 30 символов. При сохранении к значению добавляется префикс `field_`
name	string	Обязательный	Наименование поля
entity_type	string	Обязательный	Сущность, к которой привязано поле
data_type	string	Обязательный	Тип данных значения поля. Допустимые значения: `string`, `int`, `decimal`, `bool`
metadata	string	Необязательный	Метаданные поля. Максимальная длина — 500 символов с учётом экранирования. При `null`/пустом значении сохраняется `null`
required	bool	Необязательный	Обязательное поле (`true`) или нет (`false`). По умолчанию `false`.

key — проверка уникальности в рамках указанной entity_type; максимальная длина 30 символов; при сохранении поле будет иметь key = field_<key>.

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

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

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

{
  "key": "customer_vat",
  "name": "ИНН клиента",
  "entity_type": "Partner",
  "data_type": "string",
  "metadata": "{\"mask\":\"#########\"}",
  "required": false
}

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

Название	Тип данных	Описание
new_id	Int64	ID созданного поля (InsertResult)

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

{
  "ok": true,
  "result": {
    "new_id": 201
  }
}