Поля объектов CRM

Выберите инструмент для разработки с AI-агентом:

используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Поля объектов CRM — это набор стандартных полей элемента, который универсальные методы crm.item.* принимают в параметре fields и возвращают в ответе. Так работают методы crm.item.add, crm.item.update, crm.item.get и crm.item.list.

Имена полей даны в нотации camelCase. Методы отдельных типов объектов — crm.lead.*, crm.deal.*, crm.contact.*, crm.company.* — работают с теми же данными в нотации UPPER_CASE. Например, stageId у них называется STATUS_ID или STAGE_ID. Перечни их полей возвращают методы crm.lead.fields, crm.deal.fields, crm.contact.fields и crm.company.fields. Имена полей из этой статьи для методов отдельных типов объектов не подходят.

Scope: crm

Права доступа к элементам объекта CRM действуют и на поля: без права на чтение элемента и без права на его изменение метод вернет ошибку доступа вместо ответа

Пользовательские поля, ограничения длины и форматы типов данных описаны отдельно:

пользовательские поля — Пользовательские поля в CRM: обзор методов
ограничения длины — Ограничения длины полей CRM
типы данных — Типы данных и форматы параметров в REST API и Типы данных и структура объектов в REST API CRM

Как устроен набор полей элемента

Набор полей элемента зависит от типа объекта CRM entityTypeId. Поля делятся на пять групп:

Общие поля. Есть у всех типов объектов. Описаны в разделе Общие поля
Поля по типам объектов. Есть только у лида, сделки, контакта, компании, предложения, счета или смарт-процесса. Описаны в разделе Поля по типам объектов
Пользовательские поля ufCrm.... Создаются в Битрикс24. Описаны строкой в таблице раздела Общие поля, подробнее — Пользовательские поля в CRM: обзор методов
Родительские поля parentId.... Связывают элемент с элементом другого типа объекта. Описаны строкой в таблице раздела Общие поля
Мультиполя fm. Хранят контактные данные. Описаны в разделе Структура мультиполя

У смарт-процессов набор полей дополнительно зависит от настроек типа объекта — подробнее в разделе Смарт-процесс. У счета состав полей фиксирован — подробнее в разделе Счет.

Выбирайте источник сведений о полях по задаче:

Задача	Что использовать
Узнать состав и назначение стандартных полей	Таблицы в разделах Общие поля и Поля по типам объектов
Получить актуальный перечень полей конкретного типа объекта, включая пользовательские, с флагами `isRequired`, `isReadOnly`, `isImmutable`, `isMultiple`	crm.item.fields
Узнать, какие поля приходят в ответе конкретного метода	Раздел Поля в select, filter и order
Узнать правила преобразования имен между `UPPER_CASE` и `camelCase`	Особенности имен полей

Важно

Метод crm.item.fields возвращает служебное поле contacts — у контакта вместо него companies. Через REST они не работают: в ответах crm.item.get и crm.item.list они не приходят, а при записи метод возвращает ошибку 100. Привязывайте контакты и компании полями contactIds и companyIds.

Как читать таблицы полей

Колонка «Доступ»

В колонке «Доступ» указано, что можно делать с полем через методы crm.item.*:

Значение	Что означает
Чтение и запись	Поле есть в ответе `crm.item.fields`. Значение приходит в ответах и принимается в `crm.item.add` и `crm.item.update`
Только чтение	Поле есть в ответе `crm.item.fields` с флагом `isReadOnly`. Значение приходит в ответах, а при записи игнорируется без ошибки
Только при создании	Поле есть в ответе `crm.item.fields` с флагом `isImmutable`. Значение принимается в `crm.item.add`, а в `crm.item.update` игнорируется
Только в ответе	Поля нет в ответе `crm.item.fields`. Значение приходит в `crm.item.get` и `crm.item.list`, а при записи игнорируется без ошибки
Не возвращается	Поле скрыто: не приходит ни в одном ответе и не принимается при записи. В `filter` и `order` оно работает, подробнее — в разделе Поля в select, filter и order

Если доступ к полю различается по типам объектов, в колонке указаны оба значения.

Среди полей из таблиц ниже запрос при передаче в fields прерывает только id в crm.item.update — это отмечено в его описании. О полях в select, filter и order — в разделе Поля в select, filter и order.

Поля в select, filter и order

Поля из таблиц можно указывать в параметрах select, filter и order метода crm.item.list. Метод crm.item.get этих параметров не принимает и всегда возвращает элемент целиком.

Исключения:

служебные entityTypeId, contacts и companies метод отбрасывает из select, а в filter и order прерывает запрос ошибкой. Через REST эти поля не работают: при записи метод возвращает ошибку 100, а привязывать контакты и компании нужно полями contactIds и companyIds
поля со значением «Не возвращается» метод отбрасывает из select, но в filter и order они работают
мультиполе fm приходит, только если select не указан или равен ["*"]; в filter и order метод возвращает ошибку 100

Маркеры устаревания

В описаниях полей используются два маркера:

Устарело, используйте X — у поля есть актуальная замена: другое поле или отдельный раздел методов, он назван в описании. Метод crm.item.fields возвращает такое поле с флагом isDeprecated
Устаревшее поле — поле осталось от прежних версий CRM, замены нет, в ответе crm.item.fields его тоже нет. Значение может быть пустым. В новых интеграциях такие поля не используйте

Значения полей

Обязательные поля

Обязательных стандартных полей нет: элемент создается с пустым параметром fields. Если не передать название, оно подставится автоматически — например, Сделка #8455 в поле title у сделки или Контакт #2759 в поле lastName у контакта. Методы crm.item.* не проверяют обязательность пользовательских полей.

Форматы значений

boolean — строки Y и N. При записи значением «истина» считаются true, "true", "y" и "Y". Любое другое значение записывается как N
datetime и date — строка ISO-8601 со смещением часового пояса Битрикс24, например 2026-08-25T16:16:04+03:00. Методы crm.item.* возвращают со временем и поля типа date, а не в кратком формате YYYY-MM-DD из словаря типов
поля с суффиксом Short — устаревшие копии дат. Несмотря на название, методы crm.item.* возвращают их в том же полном формате ISO-8601, краткого формата в ответе нет
user — целочисленный идентификатор пользователя, user[] — массив идентификаторов
file у стандартных полей photo и logo — целочисленный идентификатор файла. При записи тоже передается идентификатор уже загруженного файла. Если вместо него передать имя файла и содержимое в base64, метод вернет ошибку FILE_NOT_FOUND

Структура мультиполя

Поле fm лида, контакта и компании хранит массив мультиполей — телефоны, почты, мессенджеры и сайты. Каждый элемент массива состоит из четырех ключей:

id — уникальный идентификатор
typeId — тип мультиполя: PHONE, EMAIL, WEB, IM или LINK
valueType — тип значения, например WORK, HOME или MAILING
value — значение

Метод crm.item.update только добавляет значения: переданный массив не заменяет существующие мультиполя, а дополняет их. Идентификатор id при записи игнорируется, поэтому изменить или удалить значение через crm.item.* нельзя — используйте методы отдельных типов объектов, например crm.contact.update с полем PHONE.

Полные перечни значений typeId и valueType — в описании типа crm_multifield.

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

Запрос создает сделку и заполняет три поля из таблицы Сделка. В ответе метод вернет объект item с полями созданной сделки — состав ответа описан на странице Создать новый элемент CRM crm.item.add.

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityTypeId":2,"fields":{"title":"Поставка оборудования","opportunity":150000,"currencyId":"RUB"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.item.add

Общие поля

Название `тип`	Доступ	Описание
assignedById `user`	Чтение и запись	Идентификатор пользователя, ответственного за элемент
createdBy `user`	Только чтение	Идентификатор пользователя, который создал элемент
createdTime `datetime`	Только чтение	Дата и время создания элемента
entityTypeId `integer`	Только в ответе	Идентификатор типа объекта CRM. Это не собственное поле элемента: методы добавляют его в ответ, только если `select` не указан или равен `["*"]`
id `integer`	Только чтение	Идентификатор элемента, уникальный в пределах типа объекта. В `crm.item.add` значение игнорируется, а в `crm.item.update` прерывает запрос ошибкой `Setting value for Primary ID is not allowed, it is read-only field` — не передавайте `id` внутри `fields`
lastActivityBy `user`	Чтение и запись	Идентификатор пользователя, который последним проявлял активность в таймлайне
lastActivityTime `datetime`	Чтение и запись	Дата и время последней активности в таймлайне
lastCommunicationCallTime `datetime`	Только чтение	Дата и время последнего звонка
lastCommunicationEmailTime `datetime`	Только чтение	Дата и время последнего письма
lastCommunicationImolTime `datetime`	Только чтение	Дата и время последнего сообщения в открытых линиях
lastCommunicationTime `string`	Только чтение	Дата и время последней коммуникации по любому каналу. Метод `crm.item.fields` объявляет поле типом `string`, а значение приходит в том же формате ISO-8601, что и у полей типа `datetime`
lastCommunicationWebformTime `datetime`	Только чтение	Дата и время последнего заполнения CRM-формы
opened `boolean`	Чтение и запись	Доступен ли элемент всем сотрудникам. `Y` — всем, `N` — только ответственному, его руководителям и наблюдателям
parentId... `crm_entity`	Чтение и запись	Поле-родитель: идентификатор элемента другого типа объекта CRM, привязанного к этому элементу. Имя поля состоит из префикса `parentId` и идентификатора типа объекта-родителя: связь с элементом типа `entityTypeId = 177` дает поле `parentId177`. Поля появляются только для тех связей между типами, которые настроены в Битрикс24
ufCrm... `crm_userfield`	Чтение и запись	Пользовательское поле. Подробнее — Пользовательские поля в CRM: обзор методов. Значения множественных полей приходят в виде массива. Значение поля типа `file` приходит в виде объекта: `id` — идентификатор файла `url` — ссылка на файл в Битрикс24 `urlMachine` — ссылка на файл для приложения
updatedBy `user`	Только чтение	Идентификатор пользователя, который последним изменил элемент
updatedTime `datetime`	Только чтение	Дата и время последнего изменения элемента
utmCampaign `string`	Чтение и запись, у счета и смарт-процессов — только в ответе	Обозначение рекламной кампании
utmContent `string`	Чтение и запись, у счета и смарт-процессов — только в ответе	Содержание кампании, например для контекстных объявлений
utmMedium `string`	Чтение и запись, у счета и смарт-процессов — только в ответе	Тип трафика. Возможные значения: `CPC` — объявления `CPM` — баннеры
utmSource `string`	Чтение и запись, у счета и смарт-процессов — только в ответе	Рекламная система: `Yandex-Direct`, `Google-Adwords` и другие
utmTerm `string`	Чтение и запись, у счета и смарт-процессов — только в ответе	Условие поиска кампании, например ключевые слова контекстной рекламы
webformId `integer`	Чтение и запись, у сделки, контакта и компании — только при создании	Идентификатор CRM-формы, которая создала элемент. Метод `crm.item.fields` возвращает тип поля как `crm_webform`

Поля по типам объектов

Числовой идентификатор типа объекта нужен в каждом вызове crm.item.*. Полная таблица типов — в справочнике типов объектов CRM. Значения колонки «Доступ» в таблицах ниже расшифрованы в разделе Колонка «Доступ».

Тип объекта	`entityTypeId`	Поля
Лид	1	Лид
Сделка	2	Сделка
Контакт	3	Контакт
Компания	4	Компания
Предложение	7	Предложение
Счет	31	Счет
Смарт-процесс	от 128	Смарт-процесс

Лид

entityTypeId = 1

Название `тип`	Доступ	Описание
address `text`	Только в ответе	Адрес. Устаревшее поле
birthdate `date`	Чтение и запись	Дата рождения
comments `text`	Чтение и запись	Комментарий
companyId `crm_company`	Чтение и запись	Идентификатор компании, привязанной к элементу
companyTitle `string`	Чтение и запись	Название компании
contactId `crm_contact`	Чтение и запись	Идентификатор контакта, привязанного к элементу. Устарело, используйте `contactIds`
contactIds `crm_contact[]`	Чтение и запись	Список идентификаторов контактов, привязанных к элементу
currencyId `crm_currency`	Чтение и запись	Идентификатор валюты элемента
dateClosed `datetime`	Только чтение	Дата и время закрытия элемента
dateCreateShort `datetime`	Только в ответе	Устаревшая копия даты создания элемента. Приходит в полном формате ISO-8601
dateModifyShort `datetime`	Только в ответе	Устаревшая копия даты изменения элемента. Приходит в полном формате ISO-8601
email `string`	Только в ответе	Первый адрес почты из мультиполя `fm`. Чтобы изменить, передайте `fm`
emailHome `string`	Только в ответе	Адрес почты с типом `HOME` из мультиполя `fm`
emailMailing `string`	Только в ответе	Адрес почты с типом `MAILING` из мультиполя `fm`
emailWork `string`	Только в ответе	Адрес почты с типом `WORK` из мультиполя `fm`
fm `crm_multifield`	Чтение и запись	Массив мультиполей. Состав ключей — в разделе Структура мультиполя
hasEmail `boolean`	Только чтение	Есть ли у элемента почта
hasImol `boolean`	Только чтение	Есть ли у элемента открытые линии
hasPhone `boolean`	Только чтение	Есть ли у элемента телефон
honorific `crm_status`	Чтение и запись	Строковый идентификатор типа обращения
icq `string`	Только в ответе	ICQ. Устаревшее поле
imol `string`	Только в ответе	Идентификатор открытой линии из мультиполя `fm`
isConvert `boolean`	Только в ответе	Сконвертирован ли лид. Устаревшее поле
isManualOpportunity `boolean`	Чтение и запись	Включен ли ручной режим расчета суммы
isReturnCustomer `boolean`	Только чтение	Является ли лид повторным
lastName `string`	Чтение и запись	Фамилия
login `string`	Только в ответе	Логин. Устаревшее поле
movedBy `user`	Только чтение	Идентификатор пользователя, который последним сменил стадию
movedTime `datetime`	Только чтение	Дата и время последней смены стадии
name `string`	Чтение и запись	Имя
observers `user[]`	Чтение и запись	Список идентификаторов пользователей, которые являются наблюдателями
opportunity `double`	Чтение и запись	Сумма
originId `string`	Чтение и запись	Идентификатор элемента во внешнем источнике
originatorId `string`	Чтение и запись	Внешний источник
phone `string`	Только в ответе	Первый телефон из мультиполя `fm`. Чтобы изменить, передайте `fm`
phoneMailing `string`	Только в ответе	Телефон с типом `MAILING` из мультиполя `fm`
phoneMobile `string`	Только в ответе	Телефон с типом `MOBILE` из мультиполя `fm`
phoneWork `string`	Только в ответе	Телефон с типом `WORK` из мультиполя `fm`
post `string`	Чтение и запись	Должность
productId `string`	Только в ответе	Идентификатор товара. Устаревшее поле
searchContent `text`	Только в ответе	Служебное поле: информация для полнотекстового поиска
secondName `string`	Чтение и запись	Отчество
shortName `string`	Только в ответе	Фамилия с инициалами: `Иванов И.` Устаревшее поле
skype `string`	Только в ответе	Skype. Устаревшее поле
sourceDescription `text`	Чтение и запись	Дополнительно об источнике
sourceId `crm_status`	Чтение и запись	Строковый идентификатор типа источника
stageId `crm_status`	Чтение и запись	Строковый идентификатор стадии элемента
stageSemanticId `string`	Только чтение	Группа стадии. Возможные значения: `P` — в работе `S` — успешная `F` — неуспешная
statusDescription `text`	Чтение и запись	Дополнительно о стадии
title `string`	Чтение и запись	Название элемента

Сделка

entityTypeId = 2

Название `тип`	Доступ	Описание
additionalInfo `string`	Чтение и запись	Дополнительная информация
begindate `date`	Чтение и запись	Дата начала элемента
begindateShort `datetime`	Только в ответе	Устаревшая копия даты начала элемента. Приходит в полном формате ISO-8601
categoryId `crm_category`	Чтение и запись	Идентификатор воронки элемента
closed `boolean`	Только чтение	Является ли сделка закрытой
closedate `date`	Чтение и запись	Дата завершения элемента
closedateShort `datetime`	Только в ответе	Устаревшая копия даты завершения элемента. Приходит в полном формате ISO-8601
comments `text`	Чтение и запись	Комментарий
companyId `crm_company`	Чтение и запись	Идентификатор компании, привязанной к элементу
contactId `crm_contact`	Чтение и запись	Идентификатор контакта, привязанного к элементу. Устарело, используйте `contactIds`
contactIds `crm_contact[]`	Чтение и запись	Список идентификаторов контактов, привязанных к элементу
currencyId `crm_currency`	Чтение и запись	Идентификатор валюты элемента
dateCreateShort `datetime`	Только в ответе	Устаревшая копия даты создания элемента. Приходит в полном формате ISO-8601
dateModifyShort `datetime`	Только в ответе	Устаревшая копия даты изменения элемента. Приходит в полном формате ISO-8601
eventDate `datetime`	Только в ответе	Дата события. Устаревшее поле
eventDateShort `datetime`	Только в ответе	Устаревшая копия даты события. Приходит в полном формате ISO-8601
eventDescription `text`	Только в ответе	Описание события. Устаревшее поле
eventId `crm_status`	Только в ответе	Строковый идентификатор типа события. Устаревшее поле
hasProducts `boolean`	Только в ответе	Содержит ли элемент товары
isLose `boolean`	Только в ответе	Является ли сделка проваленной
isManualOpportunity `boolean`	Чтение и запись	Включен ли ручной режим расчета суммы
isNew `boolean`	Только чтение	Является ли сделка новой
isRecurring `boolean`	Чтение и запись	Является ли сделка регулярной
isRepeatedApproach `boolean`	Только чтение	Является ли сделка повторным обращением
isReturnCustomer `boolean`	Только чтение	Является ли сделка повторной
isWon `boolean`	Только в ответе	Является ли сделка выигранной
isWork `boolean`	Только в ответе	Находится ли сделка в работе
leadId `crm_lead`	Чтение и запись	Идентификатор лида, на основании которого создан элемент
locationId `location`	Чтение и запись	Служебное поле: идентификатор местоположения
lostAmount `integer`	Только в ответе	Утраченная сумма
movedBy `user`	Только чтение	Идентификатор пользователя, который последним сменил стадию
movedTime `datetime`	Только чтение	Дата и время последней смены стадии
mycompanyId `crm_company`	Чтение и запись	Идентификатор «моей» компании
observers `user[]`	Чтение и запись	Список идентификаторов пользователей, которые являются наблюдателями
opportunity `double`	Чтение и запись	Сумма
orderStage `string`	Только в ответе	Статус оплаты сделки
originId `string`	Чтение и запись	Идентификатор элемента во внешнем источнике
originatorId `string`	Чтение и запись	Внешний источник
previousStageId `crm_status`	Только чтение	Строковый идентификатор предыдущей стадии
probability `integer`	Чтение и запись	Вероятность в процентах
productId `string`	Только в ответе	Идентификатор товара. Устаревшее поле
quoteId `crm_quote`	Чтение и запись	Идентификатор предложения, привязанного к элементу
receivedAmount `integer`	Только в ответе	Полученная сумма
searchContent `text`	Только в ответе	Служебное поле: информация для полнотекстового поиска
sourceDescription `text`	Чтение и запись	Дополнительно об источнике
sourceId `crm_status`	Чтение и запись	Строковый идентификатор типа источника
stageId `crm_status`	Чтение и запись	Строковый идентификатор стадии элемента
stageSemanticId `string`	Только чтение	Группа стадии. Возможные значения: `P` — в работе `S` — успешная `F` — неуспешная
taxValue `double`	Чтение и запись	Сумма налога
title `string`	Чтение и запись	Название элемента
typeId `crm_status`	Чтение и запись	Строковый идентификатор типа сделки. Возможные значения возвращает метод crm.status.list для справочника `DEAL_TYPE`

Контакт

entityTypeId = 3

Название `тип`	Доступ	Описание
address `text`	Только в ответе	Адрес. Устаревшее поле
birthdate `date`	Чтение и запись	Дата рождения
categoryId `crm_category`	Чтение и запись	Идентификатор воронки элемента
comments `text`	Чтение и запись	Комментарий
companyId `crm_company`	Чтение и запись	Идентификатор компании, привязанной к элементу. Устарело, используйте `companyIds`
companyIds `crm_company[]`	Чтение и запись	Список идентификаторов компаний, привязанных к элементу
email `string`	Только в ответе	Первый адрес почты из мультиполя `fm`. Чтобы изменить, передайте `fm`
emailHome `string`	Только в ответе	Адрес почты с типом `HOME` из мультиполя `fm`
emailMailing `string`	Только в ответе	Адрес почты с типом `MAILING` из мультиполя `fm`
emailWork `string`	Только в ответе	Адрес почты с типом `WORK` из мультиполя `fm`
export `boolean`	Чтение и запись	Разрешено ли экспортировать контакт
fm `crm_multifield`	Чтение и запись	Массив мультиполей. Состав ключей — в разделе Структура мультиполя
hasEmail `boolean`	Только чтение	Есть ли у элемента почта
hasImol `boolean`	Только чтение	Есть ли у элемента открытые линии
hasPhone `boolean`	Только чтение	Есть ли у элемента телефон
honorific `crm_status`	Чтение и запись	Строковый идентификатор типа обращения
imol `string`	Только в ответе	Идентификатор открытой линии из мультиполя `fm`
lastName `string`	Чтение и запись	Фамилия
leadId `crm_lead`	Чтение и запись	Идентификатор лида, на основании которого создан элемент
login `string`	Только в ответе	Логин. Устаревшее поле
name `string`	Чтение и запись	Имя
observers `user[]`	Чтение и запись	Список идентификаторов пользователей, которые являются наблюдателями
originId `string`	Чтение и запись	Идентификатор элемента во внешнем источнике
originVersion `string`	Чтение и запись	Версия оригинала
originatorId `string`	Чтение и запись	Внешний источник
phone `string`	Только в ответе	Первый телефон из мультиполя `fm`. Чтобы изменить, передайте `fm`
phoneMailing `string`	Только в ответе	Телефон с типом `MAILING` из мультиполя `fm`
phoneMobile `string`	Только в ответе	Телефон с типом `MOBILE` из мультиполя `fm`
phoneWork `string`	Только в ответе	Телефон с типом `WORK` из мультиполя `fm`
photo `file`	Чтение и запись	Фотография. Приходит и записывается идентификатором файла
post `string`	Чтение и запись	Должность
searchContent `text`	Только в ответе	Служебное поле: информация для полнотекстового поиска
secondName `string`	Чтение и запись	Отчество
shortName `string`	Только в ответе	Фамилия с инициалами: `Иванов И.` Устаревшее поле
sourceDescription `text`	Чтение и запись	Дополнительно об источнике
sourceId `crm_status`	Чтение и запись	Строковый идентификатор типа источника
typeId `crm_status`	Чтение и запись	Строковый идентификатор типа контакта: клиент, поставщик, партнер и другие. Возможные значения возвращает метод crm.status.list для справочника `CONTACT_TYPE`

Компания

entityTypeId = 4

Поля ufAccountantSign, ufDirectorSign, ufLogo и ufStamp — предустановленные пользовательские поля генератора документов. Шаблон ufCrm... на них не распространяется, в ответе crm.item.fields их нет.

Название `тип`	Доступ	Описание
address `text`	Только в ответе	Адрес. Устаревшее поле
addressLegal `text`	Только в ответе	Юридический адрес. Устаревшее поле
bankingDetails `text`	Чтение и запись	Банковские реквизиты. Устарело, используйте реквизиты
categoryId `crm_category`	Чтение и запись	Идентификатор воронки элемента
comments `text`	Чтение и запись	Комментарий
contactIds `crm_contact[]`	Чтение и запись	Список идентификаторов контактов, привязанных к элементу
currencyId `crm_currency`	Чтение и запись	Идентификатор валюты элемента
email `string`	Только в ответе	Первый адрес почты из мультиполя `fm`. Чтобы изменить, передайте `fm`
emailHome `string`	Только в ответе	Адрес почты с типом `HOME` из мультиполя `fm`
emailMailing `string`	Только в ответе	Адрес почты с типом `MAILING` из мультиполя `fm`
emailWork `string`	Только в ответе	Адрес почты с типом `WORK` из мультиполя `fm`
employees `crm_status`	Чтение и запись	Строковый идентификатор количества сотрудников
fm `crm_multifield`	Чтение и запись	Массив мультиполей. Состав ключей — в разделе Структура мультиполя
hasEmail `boolean`	Только чтение	Есть ли у элемента почта
hasImol `boolean`	Только чтение	Есть ли у элемента открытые линии
hasPhone `boolean`	Только чтение	Есть ли у элемента телефон
imol `string`	Только в ответе	Идентификатор открытой линии из мультиполя `fm`
industry `crm_status`	Чтение и запись	Строковый идентификатор сферы деятельности
isMyCompany `boolean`	Только при создании	Является ли компания «моей» компанией
leadId `crm_lead`	Чтение и запись	Идентификатор лида, на основании которого создан элемент
logo `file`	Чтение и запись	Логотип. Приходит и записывается идентификатором файла
observers `user[]`	Чтение и запись	Список идентификаторов пользователей, которые являются наблюдателями
originId `string`	Чтение и запись	Идентификатор элемента во внешнем источнике
originVersion `string`	Чтение и запись	Версия оригинала
originatorId `string`	Чтение и запись	Внешний источник
phone `string`	Только в ответе	Первый телефон из мультиполя `fm`. Чтобы изменить, передайте `fm`
phoneMailing `string`	Только в ответе	Телефон с типом `MAILING` из мультиполя `fm`
phoneMobile `string`	Только в ответе	Телефон с типом `MOBILE` из мультиполя `fm`
phoneWork `string`	Только в ответе	Телефон с типом `WORK` из мультиполя `fm`
revenue `double`	Чтение и запись	Годовой оборот
searchContent `text`	Только в ответе	Служебное поле: информация для полнотекстового поиска
title `string`	Чтение и запись	Название элемента
typeId `crm_status`	Чтение и запись	Строковый идентификатор типа компании: клиент, поставщик, партнер и другие. Возможные значения возвращает метод crm.status.list для справочника `COMPANY_TYPE`
ufAccountantSign `file`	Только в ответе	Подпись главного бухгалтера для генератора документов
ufDirectorSign `file`	Только в ответе	Подпись директора для генератора документов
ufLogo `file`	Только в ответе	Логотип для генератора документов
ufStamp `file`	Только в ответе	Печать организации для генератора документов

Предложение

entityTypeId = 7

Поля commentsType, contentType и termsType используют общий словарь форматов текста:

0 — неизвестно
1 — текст
2 — BB-код
3 — HTML

Название `тип`	Доступ	Описание
actualDate `date`	Чтение и запись	Дата, до которой предложение актуально
begindate `date`	Чтение и запись	Дата начала элемента
begindateShort `datetime`	Только в ответе	Устаревшая копия даты начала элемента. Приходит в полном формате ISO-8601
clientAddr `string`	Только в ответе	Адрес клиента
clientContact `string`	Только в ответе	Контакты клиента
clientEmail `string`	Только в ответе	Почта клиента
clientPhone `string`	Только в ответе	Телефон клиента
clientTitle `string`	Только в ответе	Название клиента
clientTpId `string`	Только в ответе	ИНН клиента
clientTpaId `string`	Только в ответе	Код клиента в торгово-промышленной палате
closed `boolean`	Только чтение	Является ли предложение закрытым
closedate `date`	Чтение и запись	Дата завершения элемента
closedateShort `datetime`	Только в ответе	Устаревшая копия даты завершения элемента. Приходит в полном формате ISO-8601
comments `text`	Чтение и запись	Комментарий
commentsType `integer`	Только в ответе	Идентификатор формата комментария из общего словаря форматов текста
companyId `crm_company`	Чтение и запись	Идентификатор компании, привязанной к элементу
contactId `crm_contact`	Чтение и запись	Идентификатор контакта, привязанного к элементу. Устарело, используйте `contactIds`
contactIds `crm_contact[]`	Чтение и запись	Список идентификаторов контактов, привязанных к элементу
content `text`	Чтение и запись	Содержание
contentType `integer`	Только в ответе	Идентификатор формата содержания из общего словаря форматов текста
currencyId `crm_currency`	Чтение и запись	Идентификатор валюты элемента
dateCreateShort `datetime`	Только в ответе	Устаревшая копия даты создания элемента. Приходит в полном формате ISO-8601
dateModifyShort `datetime`	Только в ответе	Устаревшая копия даты изменения элемента. Приходит в полном формате ISO-8601
dealId `crm_deal`	Чтение и запись	Идентификатор сделки, привязанной к элементу
hasProducts `boolean`	Только в ответе	Содержит ли элемент товары
isManualOpportunity `boolean`	Чтение и запись	Включен ли ручной режим расчета суммы
leadId `crm_lead`	Чтение и запись	Идентификатор лида, на основании которого создан элемент
locationId `location`	Чтение и запись	Служебное поле: идентификатор местоположения
mycompanyId `crm_company`	Чтение и запись	Идентификатор «моей» компании
opportunity `double`	Чтение и запись	Сумма
personTypeId `integer`	Только чтение	Идентификатор типа плательщика
quoteNumber `string`	Чтение и запись	Номер предложения
searchContent `text`	Только в ответе	Служебное поле: информация для полнотекстового поиска
stageId `crm_status`	Чтение и запись	Строковый идентификатор стадии элемента
storageElementIds `integer[]`	Чтение и запись	Массив идентификаторов файлов
storageTypeId `integer`	Чтение и запись	Идентификатор типа хранения файлов
taxValue `double`	Чтение и запись	Сумма налога
terms `text`	Чтение и запись	Условия
termsType `integer`	Только в ответе	Идентификатор формата условий из общего словаря форматов текста
title `string`	Чтение и запись	Название элемента

Счет

entityTypeId = 31

Методы crm.item.* работают только со счетами нового типа. Для счетов старого типа entityTypeId = 5 они вернут ошибку ENTITY_TYPE_NOT_SUPPORTED. Подробнее — Счета: обзор методов и событий.

Тип счета предопределен, его настройки через REST недоступны: crm.type.get с entityTypeId = 31 возвращает ошибку 100. Состав полей счета фиксирован.

Название `тип`	Доступ	Описание
accountNumber `string`	Чтение и запись	Номер счета
begindate `date`	Чтение и запись	Дата начала элемента
categoryId `crm_category`	Чтение и запись	Идентификатор воронки элемента
closedate `date`	Чтение и запись	Дата завершения элемента
comments `text`	Чтение и запись	Комментарий
companyId `crm_company`	Чтение и запись	Идентификатор компании, привязанной к элементу
contactId `crm_contact`	Чтение и запись	Идентификатор контакта, привязанного к элементу. Устарело, используйте `contactIds`
contactIds `crm_contact[]`	Чтение и запись	Список идентификаторов контактов, привязанных к элементу
currencyId `crm_currency`	Чтение и запись	Идентификатор валюты элемента
isManualOpportunity `boolean`	Чтение и запись	Включен ли ручной режим расчета суммы
isRecurring `boolean`	Чтение и запись	Является ли счет регулярным
locationId `location`	Чтение и запись	Служебное поле: идентификатор местоположения
movedBy `user`	Только чтение	Идентификатор пользователя, который последним сменил стадию
movedTime `datetime`	Только чтение	Дата и время последней смены стадии
mycompanyId `crm_company`	Чтение и запись	Идентификатор «моей» компании
observers `user[]`	Чтение и запись	Список идентификаторов пользователей, которые являются наблюдателями
opportunity `double`	Чтение и запись	Сумма
previousStageId `crm_status`	Только чтение	Строковый идентификатор предыдущей стадии
sourceDescription `text`	Чтение и запись	Дополнительно об источнике
sourceId `crm_status`	Чтение и запись	Строковый идентификатор типа источника
stageId `crm_status`	Чтение и запись	Строковый идентификатор стадии элемента
taxValue `double`	Чтение и запись	Сумма налога
title `string`	Чтение и запись	Название элемента
xmlId `string`	Чтение и запись	Внешний код

Смарт-процесс

entityTypeId — от 128. Идентификаторы смарт-процессов Битрикс24 возвращает метод crm.type.list.

Часть полей зависит от настроек типа смарт-процесса — в таблице настройка названа в описании поля. Настройки возвращает метод crm.type.get, он требует административного доступа к смарт-процессу или права на его чтение.

Если настройка выключена, поле не исчезает, а меняет доступ: оно пропадает из ответа crm.item.fields и работает как «Только в ответе» — приходит в crm.item.get и crm.item.list, но при записи игнорируется.

Название `тип`	Доступ	Описание
accountCurrencyId `crm_currency`	Не возвращается	Служебное поле: валюта учета
begindate `date`	Чтение и запись	Дата начала элемента. Зависит от настройки `isBeginCloseDatesEnabled`
categoryId `crm_category`	Чтение и запись	Идентификатор воронки элемента
closedate `date`	Чтение и запись	Дата завершения элемента. Зависит от настройки `isBeginCloseDatesEnabled`
companyId `crm_company`	Чтение и запись	Идентификатор компании, привязанной к элементу. Зависит от настройки `isClientEnabled`
contactId `crm_contact`	Чтение и запись	Идентификатор контакта, привязанного к элементу. Устарело, используйте `contactIds`. Зависит от настройки `isClientEnabled`
contactIds `crm_contact[]`	Чтение и запись	Список идентификаторов контактов, привязанных к элементу. Зависит от настройки `isClientEnabled`
currencyId `crm_currency`	Чтение и запись	Идентификатор валюты элемента. Зависит от настройки `isLinkWithProductsEnabled`
isManualOpportunity `boolean`	Чтение и запись	Включен ли ручной режим расчета суммы. Зависит от настройки `isLinkWithProductsEnabled`
isRecurring `boolean`	Чтение и запись	Является ли элемент регулярным
movedBy `user`	Только чтение	Идентификатор пользователя, который последним сменил стадию. Зависит от настройки `isStagesEnabled`
movedTime `datetime`	Только чтение	Дата и время последней смены стадии. Зависит от настройки `isStagesEnabled`
mycompanyId `crm_company`	Чтение и запись	Идентификатор «моей» компании. Зависит от настройки `isMycompanyEnabled`
observers `user[]`	Чтение и запись	Список идентификаторов пользователей, которые являются наблюдателями. Зависит от настройки `isObserversEnabled`
opportunity `double`	Чтение и запись	Сумма. Зависит от настройки `isLinkWithProductsEnabled`
opportunityAccount `double`	Не возвращается	Служебное поле: сумма в валюте учета
previousStageId `crm_status`	Только чтение	Строковый идентификатор предыдущей стадии. Зависит от настройки `isStagesEnabled`
sourceDescription `text`	Чтение и запись	Дополнительно об источнике. Зависит от настройки `isSourceEnabled`
sourceId `crm_status`	Чтение и запись	Строковый идентификатор типа источника. Зависит от настройки `isSourceEnabled`
stageId `crm_status`	Чтение и запись	Строковый идентификатор стадии элемента. Зависит от настройки `isStagesEnabled`
taxValue `double`	Чтение и запись	Сумма налога. Зависит от настройки `isLinkWithProductsEnabled`
taxValueAccount `double`	Не возвращается	Служебное поле: сумма налога в валюте учета
title `string`	Чтение и запись	Название элемента
xmlId `string`	Чтение и запись	Внешний код

Продолжите изучение

создать элемент — Создать новый элемент CRM crm.item.add
изменить элемент — Обновить элемент crm.item.update
получить элемент или список элементов — Получить элемент по Id crm.item.get, Получить список элементов crm.item.list
получить перечень полей конкретного типа объекта — Получить поля элемента crm.item.fields
работать с пользовательскими полями — Пользовательские поля в CRM: обзор методов
узнать ограничения длины полей — Ограничения длины полей CRM

Была ли статья полезна?

Получить поля элемента

Обзор событий

Поля объектов CRM

Как устроен набор полей элементаКак устроен набор полей элемента

Как читать таблицы полейКак читать таблицы полей

Колонка «Доступ»Колонка «Доступ»

Поля в select, filter и orderПоля в select, filter и order

Маркеры устареванияМаркеры устаревания

Значения полейЗначения полей

Обязательные поляОбязательные поля

Форматы значенийФорматы значений

Структура мультиполяСтруктура мультиполя

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

Общие поляОбщие поля

Поля по типам объектовПоля по типам объектов

ЛидЛид

СделкаСделка

КонтактКонтакт

КомпанияКомпания

ПредложениеПредложение

СчетСчет

Смарт-процессСмарт-процесс

Продолжите изучениеПродолжите изучение