Эффективная интеграция и кастомизация функционала в Битрикс24 часто требует работы на уровне API. Сегодня мы подробно рассмотрим «Поля объектов CRM». Вы узнаете экспертные методики работы с поля объектов и научитесь избегать типичных ошибок начинающих разработчиков.
Поля объектов CRM
В блоке общие поля приведен перечень стандартных полей, которые используются во всех типах объектов CRM.
В блоках по типам объектов приведены перечни стандартных полей, характерных для этого типа объекта:
- лид,
- сделка,
- контакт,
- компания,
- предложение,
- счет,
- смарт-процесс.
Используйте метод crm.item.fields с указанием типа объекта в entityTypeId, чтобы получить полный перечень полей для объекта, в том числе пользовательских.
Общие поля {#common}
Названиетип | Описание |
|---|---|
| assignedById [ user][1] | Идентификатор пользователя ответственного за элемент |
| createdBy [ user][1] | Идентификатор пользователя, который создал элемент |
| createdTime [ datetime][1] | Время создания элемента |
| entityTypeId [ integer][1] | Идентификатор типа сущности |
| id [ integer][1] | Идентификатор элемента |
| lastActivityBy [ user][1] | Идентификатор пользователя, который последним проявлял активность в таймлайне |
| lastActivityTime [ datetime][1] | Время, последнего проявления активности в таймлайне |
| opened [ boolean][1] | Является ли элемент открытым |
| parentId… [ crm_entity][1] | Поле-родитель. Элемент другого типа объекта CRM, который привязан к данному элементу. Каждое такое поле имеет код parentId + {parentEntityTypeId} |
| ufCrm… [ crm_userfield][1] | Пользовательское поле. Смотрите раздел [](./user-defined-fields/index). — Значения множественных полей отдаются в виде массива — Значение поля типа file отдаются в виде объекта:— id — идентификатор— url — ссылка на файл на портале— urlMachine — ссылка на файл для приложения |
| updatedBy [ user][1] | Идентификатор пользователя, который изменил элемент |
| updatedTime [ datetime][1] | Время последнего изменения элемента |
| utmCampaign [ string][1] | Обозначение рекламной кампании |
| utmContent [ string][1] | Содержание кампании. Например, для контекстных объявлений |
| utmMedium [ string][1] | Тип трафика. Возможные значения: — CPC — объявления — CPM — баннеры |
| utmSource [ string][1] | Рекламная система. Yandex-Direct, Google-Adwords и другие |
| utmTerm [ string][1] | Условие поиска кампании. Например, ключевые слова контекстной рекламы |
| webformId [ integer][1] | Идентификатор crm формы |
Поля по объектам
Лид {#lead}
Названиетип | Описание |
|---|---|
| dateCreateShort [ datetime][1] | Время создания элемента (краткий формат). Поле выключено |
| dateModifyShort [ datetime][1] | Время последнего изменения элемента (краткий формат). Поле выключено |
| companyId [ crm_company][1] | Идентификатор компании, привязанной к элементу |
| contactId [ crm_contact][1] | Идентификатор контакта, привязанного к элементу |
| stageId [ crm_status][1] | Строковый идентификатор стадии элемента |
| isConvert [ boolean][1] | Сконвертирован ли лид. Поле выключено |
| statusDescription [ text][1] | Дополнительно о стадии |
| stageSemanticId [ string][1] | Группа стадии. Возможные значения: — P — в работе— S — успешная— F — неуспешная |
| productId [ string][1] | Идентификатор товара. Устарело. Поле выключено |
| opportunity [ double][1] | Сумма |
| currencyId [ crm_currency][1] | Идентификатор валюты элемента |
| sourceId [ crm_status][1] | Строковый идентификатор типа источника |
| sourceDescription [ text][1] | Дополнительно об источнике |
| title [ string][1] | Название элемента |
| name [ string][1] | Имя |
| lastName [ string][1] | Фамилия |
| secondName [ string][1] | Отчество |
| shortName [ string][1] | Фамилия Имя. Краткий формат: например ‘Иванов Иван’ -> ‘Иванов И.’. Поле выключено |
| companyTitle [ string][1] | Название компании |
| post [ string][1] | Должность |
| address [ text][1] | Адрес. Устарело. Поле выключено |
| comments [ text][1] | Комментарий |
| originatorId [ string][1] | Внешний источник |
| originId [ string][1] | Идентификатор элемента во внешнем источнике |
| dateClosed [ datetime][1] | Время закрытия элемента |
| birthdate [ date][1] | Дата рождения |
| honorific [ crm_status][1] | Строковый идентификатор типа обращения |
| hasPhone [ boolean][1] | Имеется ли у элемента телефон |
| hasEmail [ boolean][1] | Имеется ли у элемента почта |
| hasImol [ boolean][1] | Имеется ли у элемента открытые линии |
| login [ string][1] | Логин. Устарело. Поле выключено |
| isReturnCustomer [ boolean][1] | Является ли элемент повторным |
| searchContent [ text][1] | Информация для полнотекстового поиска. Служебное поле |
| isManualOpportunity [ boolean][1] | Установлен ли ручной режим расчеты суммы |
| movedBy [ user][1] | Идентификатор пользователя, который последним сменил стадию |
| movedTime [ datetime][1] | Время последней смены стадии |
| phoneMobile [ string][1] | Мобильный телефон |
| phoneWork [ string][1] | Рабочий телефон |
| phoneMailing [ string][1] | Телефон для рассылок |
| emailHome [ string][1] | Личный E-mail |
| emailWork [ string][1] | Рабочий E-mail |
| emailMailing [ string][1] | Почта для рассылок |
| skype [ string][1] | Skype |
| icq [ string][1] | ICQ |
| imol [ string][1] | IMOL |
| email [ string][1] | |
| phone [ string][1] | Телефон |
| observers [ user[]][1] | Список идентификаторов пользователей, которые являются Наблюдателями |
| contactIds [ crm_contact[]][1] | Список идентификаторов контактов, привязанных к элементу |
| fm [ multifield][1] | Массив мультиполей. Подробнее о мультиполях можно почитать в разделе [](../data-types.md#crm_multifield) Структура мультиполя: — id — Уникальный идентификатор— typeId — Тип мультиполя— valueType — Тип значения— value — Значение |
Сделка {#deal}
Названиетип | Описание |
|---|---|
| dateCreateShort [ datetime][1] | Время создания элемента (краткий формат). Поле выключено |
| dateModifyShort [ datetime][1] | Время последнего изменения элемента (краткий формат). Поле выключено |
| leadId [ crm_lead][1] | Идентификатор лида, на основании, которого создан элемент |
| companyId [ crm_company][1] | Идентификатор компании, привязанной к элементу |
| contactId [ crm_contact][1] | Идентификатор контакта, привязанного к элементу |
| quoteId [ crm_quote][1] | Идентификатор предложения, привязанного к элементу |
| title [ string][1] | Название элемента |
| productId [ string][1] | Идентификатор товара. Устарело. Поле выключено |
| categoryId [ crm_category][1] | Идентификатор воронки (направления) элемента |
| stageId [ crm_status][1] | Строковый идентификатор стадии элемента |
| stageSemanticId [ string][1] | Группа стадии — P — в работе— S — успешная— F — неуспешная |
| isNew [ boolean][1] | Является ли сделка новой |
| isRecurring [ boolean][1] | Является ли сделка повторной |
| isReturnCustomer [ boolean][1] | Является ли элемент повторным |
| isRepeatedApproach [ boolean][1] | Является ли сделка повторным обращением |
| closed [ boolean][1] | Является ли сделка закрытой |
| typeId [ crm_status][1] | Строковый идентификатор типа сделки |
| opportunity [ double][1] | Сумма |
| isManualOpportunity [ boolean][1] | Установлен ли ручной режим расчеты суммы |
| taxValue [ double][1] | Сумма налога |
| currencyId [ crm_currency][1] | Идентификатор валюты элемента |
| probability [ integer][1] | Вероятность, % |
| comments [ text][1] | Комментарий |
| begindate [ date][1] | Дата начала элемента |
| begindateShort [ datetime][1] | Время начала элемента (краткий формат). Поле выключено |
| closedate [ date][1] | Дата завершения элемента |
| closedateShort [ datetime][1] | Время окончания элемента (краткий формат). Поле выключено |
| eventDate [ datetime][1] | Дата события |
| eventDateShort [ datetime][1] | Дата события (краткий формат). Поле выключено |
| eventId [ crm_status][1] | Строковый идентификатор типа события |
| eventDescription [ text][1] | Описание события |
| locationId [ location][1] | Идентификатор местоположения. Служебное поле |
| sourceId [ crm_status][1] | Строковый идентификатор типа источника |
| sourceDescription [ text][1] | Дополнительно об источнике |
| originatorId [ string][1] | Внешний источник |
| originId [ string][1] | Идентификатор элемента во внешнем источнике |
| additionalInfo [ string][1] | Дополнительная информация |
| searchContent [ text][1] | Информация для полнотекстового поиска. Служебное поле |
| orderStage [ string][1] | Статус оплаты сделки |
| movedBy [ user][1] | Идентификатор пользователя, который последним сменил стадию |
| movedTime [ datetime][1] | Время последней смены стадии |
| isWork [ boolean][1] | Является ли сделка в работе. Поле выключено |
| isWon [ boolean][1] | Является ли сделка выигранной. Поле выключено |
| isLose [ boolean][1] | Является ли сделка проваленной. Поле выключено |
| receivedAmount [ string][1] | Полученная сумма. Поле выключено |
| lostAmount [ string][1] | Утраченная сумма. Поле выключено |
| hasProducts [ boolean][1] | Содержит ли элемент товары. Поле выключено |
| observers [ user[]][1] | Список идентификаторов пользователей, который являются Наблюдателями |
| contactIds [ crm_contact[]][1] | Список идентификаторов контактов, привязанных к элементу |
Контакт {#contact}
Названиетип | Описание |
|---|---|
| companyId [ crm_company][1] | Идентификатор компании, привязанной к элементу |
| sourceId [ crm_status][1] | Строковый идентификатор типа источника |
| sourceDescription [ text][1] | Дополнительно об источнике |
| name [ string][1] | Имя |
| lastName [ string][1] | Фамилия |
| secondName [ string][1] | Отчество |
| shortName [ string][1] | Фамилия Имя. Краткий формат: например ‘Иванов Иван’ -> ‘Иванов И.’. Поле выключено |
| photo [ file][1] | Фотография |
| post [ string][1] | Должность |
| address [ text][1] | Адрес. Устарело. Поле выключено |
| comments [ text][1] | Комментарий |
| leadId [ crm_lead][1] | Идентификатор лида, на основании, которого создан элемент |
| export [ boolean][1] | Разрешено ли экспортировать контакт |
| typeId [ crm_status][1] | Строковый идентификатор типа сделки |
| originatorId [ string][1] | Внешний источник |
| originId [ string][1] | Идентификатор элемента во внешнем источнике |
| originVersion [ string][1] | Версия оригинала |
| birthdate [ date][1] | Дата рождения |
| honorific [ crm_status][1] | Строковый идентификатор типа обращения |
| hasPhone [ boolean][1] | Имеется ли у элемента телефон |
| hasEmail [ boolean][1] | Имеется ли у элемента почта |
| hasImol [ boolean][1] | Имеется ли у элемента открытые линии |
| searchContent [ text][1] | Информация для полнотекстового поиска. Служебное поле |
| categoryId [ crm_category][1] | Идентификатор воронки (направления) элемента |
| login [ string][1] | Логин. Устарело. Поле выключено |
| emailHome [ string][1] | Личный E-mail |
| emailWork [ string][1] | Рабочий E-mail |
| emailMailing [ string][1] | Почта для рассылок |
| phoneMobile [ string][1] | Мобильный телефон |
| phoneWork [ string][1] | Рабочий телефон |
| phoneMailing [ string][1] | Телефон для рассылок |
| imol [ string][1] | IMOL |
| email [ string][1] | |
| phone [ string][1] | Телефон |
| observers [ user[]][1] | Список идентификаторов пользователей, который являются Наблюдателями |
| companyIds [ crm_company[]][1] | Список идентификаторов компаний, привязанных к элементу |
| fm [ multifield][1] | Массив мультиполей. Подробнее о мультиполях можно почитать в разделе [](../data-types.md#crm_multifield) Структура мультиполя: — id — Уникальный идентификатор— typeId — Тип мультиполя— valueType — Тип значения— value — Значение |
Компания {#company}
Названиетип | Описание |
|---|---|
| title [ string][1] | Название элемента |
| logo [ file][1] | Логотип |
| address [ text][1] | Адрес. Устарело. Поле выключено |
| addressLegal [ text][1] | Юридический адрес. Устарело |
| bankingDetails [ string][1] | Банковские реквизиты |
| comments [ text][1] | Комментарий |
| typeId [ crm_status][1] | Строковый идентификатор типа сделки |
| industry [ crm_status][1] | Строковый идентификатор типа индустрии |
| revenue [ double][1] | Годовой оборот |
| currencyId [ crm_currency][1] | Идентификатор валюты элемента |
| employees [ crm_status][1] | Строковый идентификатор типа кол-ва сотрудников |
| leadId [ crm_lead][1] | Идентификатор лида, на основании, которого создан элемент |
| originatorId [ string][1] | Внешний источник |
| originId [ string][1] | Идентификатор элемента во внешнем источнике |
| originVersion [ string][1] | Версия оригинала |
| hasPhone [ boolean][1] | Имеется ли у элемента телефон |
| hasEmail [ boolean][1] | Имеется ли у элемента почта |
| hasImol [ boolean][1] | Имеется ли у элемента открытые линии |
| isMyCompany [ boolean][1] | Является ли компания моей компанией |
| searchContent [ text][1] | Информация для полнотекстового поиска. Служебное поле |
| categoryId [ crm_category][1] | Идентификатор воронки (направления) элемента |
| emailHome [ string][1] | Личный E-mail |
| emailWork [ string][1] | Рабочий E-mail |
| emailMailing [ string][1] | Почта для рассылок |
| phoneMobile [ string][1] | Мобильный телефон |
| phoneWork [ string][1] | Рабочий телефон |
| phoneMailing [ string][1] | Телефон для рассылок |
| imol [ string][1] | IMOL |
| email [ string][1] | |
| phone [ string][1] | Телефон |
| ufLogo [ file][1] | Логотип (генератор документов) |
| ufStamp [ file][1] | Печать организации (генератор документов) |
| ufDirectorSign [ file][1] | Подпись директора (генератор документов) |
| ufAccountantSign [ file][1] | Подпись гл. бухгалтера (генератор документов) |
| observers [ user[]][1] | Список идентификаторов пользователей, который являются Наблюдателями |
| contactIds [ crm_contact[]][1] | Список идентификаторов контактов, привязанных к элементу |
| fm [ multifield][1] | Массив мультиполей. Подробнее о мультиполях можно почитать в разделе [](../data-types.md#crm_multifield) Структура мультиполя: — id — Уникальный идентификатор— typeId — Тип мультиполя— valueType — Тип значения— value — Значение |
Предложение {#quote}
Названиетип | Описание |
|---|---|
| dateCreateShort [ datetime][1] | Время создания элемента (краткий формат). Поле выключено |
| dateModifyShort [ datetime][1] | Время последнего изменения элемента (краткий формат). Поле выключено |
| leadId [ crm_lead][1] | Идентификатор лида, на основании, которого создан элемент |
| dealId [ crm_deal][1] | Идентификатор сделки, привязанной к элементу |
| companyId [ crm_company][1] | Идентификатор компании, привязанной к элементу |
| contactId [ crm_contact][1] | Идентификатор контакта, привязанного к элементу |
| personTypeId [ integer][1] | Идентификатор типа плательщика |
| mycompanyId [ crm_company][1] | Идентификатор «моей» компании |
| title [ string][1] | Название элемента |
| stageId [ crm_status][1] | Строковый идентификатор стадии элемента |
| closed [ boolean][1] | Является ли сделка закрытой |
| opportunity [ double][1] | Сумма |
| isManualOpportunity [ boolean][1] | Установлен ли ручной режим расчеты суммы |
| taxValue [ double][1] | Сумма налога |
| currencyId [ crm_currency][1] | Идентификатор валюты элемента |
| comments [ text][1] | Комментарий |
| commentsType [ integer][1] | Идентификатор типа комментария. Возможные значения: — 0 — неизвестно— 1 — текст— 2 — bb-код— 3 — HTML |
| begindate [ date][1] | Дата начала элемента |
| begindateShort [ datetime][1] | Время начала элемента (краткий формат). Поле выключено |
| closedate [ date][1] | Дата завершения элемента |
| closedateShort [ datetime][1] | Время окончания элемента (краткий формат). Поле выключено |
| quoteNumber [ string][1] | Номер предложения |
| content [ text][1] | Содержание |
| contentType [ integer][1] | Идентификатор типа содержания. Возможные значения: — 0 — неизвестно— 1 — текст— 2 — bb-код— 3 — HTML |
| terms [ text][1] | Условия |
| termsType [ integer][1] | Идентификатор типа условия. Возможные значения: — 0 — неизвестно— 1 — текст— 2 — bb-код— 3 — HTML |
| storageTypeId [ integer][1] | Идентификатор типа хранения |
| storageElementIds [ integer[]][1] | Массив файлов |
| locationId [ location][1] | Идентификатор местоположения. Служебное поле |
| clientTitle [ string][1] | Название клиента |
| clientAddr [ string][1] | Адрес клиента |
| clientContact [ string][1] | Контакты клиента |
| clientEmail [ string][1] | E-mail клиента |
| clientPhone [ string][1] | Телефон клиента |
| clientTpId [ string][1] | ИНН Клиента |
| clientTpaId [ string][1] | ТПП Клиента |
| searchContent [ text][1] | Информация для полнотекстового поиска. Служебное поле |
| hasProducts [ boolean][1] | Содержит ли элемент товары. Поле выключено |
| actualDate [ date][1] | Актуально до |
| contactIds [ crm_contact[]][1] | Список идентификаторов контактов, привязанных к элементу |
Счет {#invoice}
Названиетип | Описание |
|---|---|
| xmlId [ string][1] | Внешний код |
| title [ string][1] | Название элемента |
| movedBy [ user][1] | Идентификатор пользователя, который последним сменил стадию |
| movedTime [ datetime][1] | Время последней смены стадии |
| categoryId [ crm_category][1] | Идентификатор воронки (направления) элемента |
| stageId [ crm_status][1] | Строковый идентификатор стадии элемента |
| previousStageId [ crm_status][1] | Идентификатор типа предыдущей стадии |
| begindate [ date][1] | Дата начала элемента |
| closedate [ date][1] | Дата завершения элемента |
| companyId [ crm_company][1] | Идентификатор компании, привязанной к элементу |
| contactId [ crm_contact][1] | Идентификатор контакта, привязанного к элементу |
| opportunity [ double][1] | Сумма |
| isManualOpportunity [ boolean][1] | Установлен ли ручной режим расчеты суммы |
| taxValue [ double][1] | Сумма налога |
| currencyId [ crm_currency][1] | Идентификатор валюты элемента |
| mycompanyId [ crm_company][1] | Идентификатор «моей» компании |
| sourceId [ crm_status][1] | Строковый идентификатор типа источника |
| sourceDescription [ text][1] | Дополнительно об источнике |
| comments [ text][1] | Комментарий |
| accountNumber [ string][1] | Номер счета |
| locationId [ location][1] | Идентификатор местоположения. Служебное поле |
| observers [ user[]][1] | Список идентификаторов пользователей, которые являются Наблюдателями |
| contactIds [ crm_contact[]][1] | Список идентификаторов контактов, привязанных к элементу |
Смарт-процесс {#spa}
Названиетип | Описание |
|---|---|
| xmlId [ string][1] | Внешний код |
| title [ string][1] | Название элемента |
| movedBy [ user][1] | Идентификатор пользователя, который последним сменил стадию. Доступно лишь при включенной настройке isStagesEnabled у соответствующего смарт-процесса |
| movedTime [ datetime][1] | Время последней смены стадии. Доступно лишь при включенной настройке isStagesEnabled у соответствующего смарт-процесса |
| categoryId [ crm_category][1] | Идентификатор воронки (направления) элемента |
| stageId [ crm_status][1] | Строковый идентификатор стадии элемента. Доступно лишь при включенной настройке isStagesEnabled у соответствующего смарт-процесса |
| previousStageId [ crm_status][1] | Идентификатор типа предыдущей стадии. Доступно лишь при включенной настройке isStagesEnabled у соответствующего смарт-процесса |
| begindate [ date][1] | Дата начала элемента. Доступно лишь при включенной настройке isBeginCloseDatesEnabled у соответствующего смарт-процесса |
| closedate [ date][1] | Дата завершения элемента. Доступно лишь при включенной настройке isBeginCloseDatesEnabled у соответствующего смарт-процесса |
| companyId [ crm_company][1] | Идентификатор компании, привязанной к элементу. Доступно лишь при включенной настройке isClientEnabled у соответствующего смарт-процесса |
| contactId [ crm_contact][1] | Идентификатор контакта, привязанного к элементу. Доступно лишь при включенной настройке isClientEnabled у соответствующего смарт-процесса |
| opportunity [ double][1] | Сумма. Доступно лишь при включенной настройке isLinkWithProductsEnabled у соответствующего смарт-процесса |
| isManualOpportunity [ boolean][1] | Установлен ли ручной режим расчеты суммы. Доступно лишь при включенной настройке isLinkWithProductsEnabled у соответствующего смарт-процесса |
| taxValue [ double][1] | Сумма налога. Доступно лишь при включенной настройке isLinkWithProductsEnabled у соответствующего смарт-процесса |
| currencyId [ crm_currency][1] | Идентификатор валюты элемента. Доступно лишь при включенной настройке isLinkWithProductsEnabled у соответствующего смарт-процесса |
| opportunityAccount [ double][1] | Сумма в валюте учета. Устарело. Поле выключено. Доступно лишь при включенной настройке isLinkWithProductsEnabled у соответствующего смарт-процесса |
| taxValueAccount [ double][1] | Сумма налога в валюте учета. Устарело. Поле выключено. Доступно лишь при включенной настройке isLinkWithProductsEnabled у соответствующего смарт-процесса |
| accountCurrencyId [ crm_currency][1] | Валюта учета. Поле выключено. Доступно лишь при включенной настройке isLinkWithProductsEnabled у соответствующего смарт-процесса |
| mycompanyId [ crm_company][1] | Идентификатор «моей» компании. Доступно лишь при включенной настройке isMycompanyEnabled у соответствующего смарт-процесса |
| sourceId [ crm_status][1] | Строковый идентификатор типа источника. Доступно лишь при включенной настройке isSourceEnabled у соответствующего смарт-процесса |
| sourceDescription [ text][1] | Дополнительно об источнике. Доступно лишь при включенной настройке isSourceEnabled у соответствующего смарт-процесса |
| observers [ user[]][1] | Список идентификаторов пользователей, который являются Наблюдателями. Доступно лишь при включенной настройке isObserversEnabled у соответствующего смарт-процесса |
| contactIds [ crm_contact[]][1] | Список идентификаторов контактов, привязанных к элементу. Доступно лишь при включенной настройке isClientEnabled у соответствующего смарт-процесса |
[1]: ../data-types.md
💡 Экспертное мнение и рекомендации
Ключевые выводы по теме «Поля объектов CRM»:
Использование современных стандартов D7 при работе с поля объектов позволяет писать чистый, масштабируемый и безопасный код. Не забывайте обрабатывать исключения (try/catch) и проверять права доступа текущего пользователя перед выполнением критических операций.
Похожая задача в бизнесе?
Помогу автоматизировать процессы и внедрить ИИ
Меня зовут Андрей Горошко. Я Full-stack разработчик и эксперт по 1С-Битрикс. Настраиваю CRM Битрикс24, разрабатываю защищенные API и создаю умных ИИ-агентов для автоматизации рутины.
Написать во ВКонтакте
или на почту: gorandvas@yandex.ru
