Поля основных объектов CRM

Если вы разрабатываете интеграции для Битрикс24 с помощью AI-инструментов (Codex, Claude Code, Cursor), подключите MCP-сервер, чтобы ассистент использовал официальную REST-документацию.

Внимание! Более полный перечень полей приводится на страницах методов, возвращающих описание полей объектов. Такие методы имеют название crm.название_объекта.fields.

Описание полей возвращает метод crm.deal.fields

Название
тип

Описание

Чтение

Запись

ID
integer

Идентификатор сделки

Да

Нет

TITLE
string

Название

Да

Да

TYPE_ID
crm_status

Тип сделки. Используется только для привязки к внешнему источнику.

Да

Да

CATEGORY_ID
crm_category

Идентификатор направления. Неизменяемое. Если не передавать это поле при создании сделки, то сделка создастся в общем направлении.

Да

Да

STAGE_ID
crm_status

Идентификатор стадии. Возможные значения:

  • NEW — новая сделка
  • PREPARATION — подготовка бумаг
  • PREPAYMENT_INVOICE — отправка счета
  • EXECUTING — в процессе выполнения
  • FINAL_INVOICE — финальный счет
  • WON — выиграна
  • >LOSE — проиграна, анализ причин не требуется
  • APOLOGY — проиграна, требуется анализ причин

Да

Да

STAGE_SEMANTIC_ID
string

Имя. Только для чтения. В некотором смысле обобщает значения идентификатора сделки STAGE_ID:

  • P — у стадий с идентификаторами NEW, PREPARATION, PREPAYMENT_INVOICE, EXECUTING и FINAL_INVOICE
  • S — у стадии с идентификатором WON
  • F — у стадий с идентификаторами >LOSE и APOLOGY

Да

Нет

IS_NEW
char

Флаг новой сделки (сделки в первой стадии)

Да

Нет

IS_RECURRING
char

Флаг шаблона регулярной сделки. Если стоит Y, то это шаблон, а не сделка

Да

Да

IS_RETURN_CUSTOMER
char

Признак повторного лида

Да

Да

IS_REPEATED_APPROACH
char

Повторное обращение

Да

Да

PROBABILITY
integer

Вероятность

Да

Да

CURRENCY_ID
crm_currency

Идентификатор валюты сделки

Да

Да

OPPORTUNITY
double

Сумма

Да

Да

IS_MANUAL_OPPORTUNITY
char

Повторное обращение

Да

Да

TAX_VALUE
double

Ставка налога

Да

Да

COMPANY_ID
crm_company

Идентификатор привязанной компании

Да

Да

CONTACT_ID
crm_contact

Идентификатор привязанного контакта. Устаревший. Сохраняется для совместимости

Да

Да

CONTACT_IDS
crm_contact

Идентификатор привязанного контакта. Множественный.

При использовании crm.deal.update и crm.deal.add можно подать массив контактов.

В методах crm.deal.list и crm.deal.get поля нет и необходимо использовать crm.deal.contact.items.get для получения списка контактов.

Для очистки поля используйте crm.deal.contact.items.delete, для замены значения используйте crm.deal.contact.items.set

Да

Да

QUOTE_ID
crm_quote

Идентификатор квоты. Только для чтения. Устаревший. Используйте метод crm.quote.list с фильтром по сделке

Да

Нет

BEGINDATE
date

Дата начала

Да

Да

CLOSEDATE
date

Дата завершения

Да

Да

OPENED
char

Доступен для всех

Да

Да

CLOSED
char

Завершена ли сделка

Да

Да

COMMENTS
string

Коментарии

Да

Да

ASSIGNED_BY_ID
user

Связано с пользователем по ID

Да

Да

CREATED_BY_ID
user

Создано пользователем

Да

Нет

MODIFY_BY_ID
user

Идентификатор автора последнего изменения

Да

Нет

MOVED_BY_ID
user

Идентификатор автора, который переместил элемент на текущую стадию

Да

Нет

DATE_CREATE
datetime

Дата создания

Да

Нет

DATE_MODIFY
datetime

Дата изменения

Да

Нет

MOVED_TIME
datetime

Дата перемещения элемента на текущую стадию

Да

Нет

SOURCE_ID
string

Идентификатор источника. Определяет источник сделки (обратный звонок, реклама, электронная почта и прочее).

Список возможных идентификаторов можно получить методом crm.status.list с фильтром filter[ENTITY_ID]=SOURCE

Да

Да

SOURCE_DESCRIPTION
string

Дополнительно об источнике. Текстовое поле

Да

Да

ADDITIONAL_INFO
string

Дополнительная информация

Да

Да

LEAD_ID
crm_lead

Идентификатор привязанного лида

Да

Нет

LOCATION_ID
location

Местоположение клиента. Служебное поле, не рекомендуется к использованию

Да

Да

ORIGINATOR_ID
string

Идентификатор источника данных. Используется только для привязки к внешнему источнику

Да

Да

ORIGIN_ID
string

Идентификатор элемента в источнике данных. Используется только для привязки к внешнему источнику

Да

Да

UTM_SOURCE
string

Рекламная система (Yandex-Direct, Google-Adwords и другие)

Да

Да

UTM_MEDIUM
string

Тип трафика: CPC (объявления), CPM (баннеры)

Да

Да

UTM_CAMPAIGN
string

Обозначение рекламной кампании

Да

Да

UTM_CONTENT
string

Содержание кампании. Например, для контекстных объявлений

Да

Да

UTM_TERM
string

Условие поиска кампании. Например, ключевые слова контекстной рекламы

Да

Да

PARENT_ID_xxx
crm_entity

Поля связей.

Если на портале есть смарт-процессы, связанные с контактами, то для каждого такого смарт-процесса существует поле, хранящее связь между этим смарт-процессом и контактом. Само поле хранит идентификатор элемента такого смарт-процесса.

Например, поле PARENT_ID_153 — связь со смарт-процессом entityTypeId=153, хранит идентификатор элемента этого смарт-процесса, связанного с текущим контактом

Да

Да

LAST_ACTIVITY_BY
string

Идентификатор пользователя, ответственного за последнюю активность в этом лиде (например, создавшего новое дело в лиде)

Да

Да

LAST_ACTIVITY_TIME
datetime

Время последней активности

Да

Да

UF_CRM_ххх

Пользовательские поля

Да

Да

Описание полей возвращает метод crm.lead.fields

Название
тип

Описание

Чтение

Запись

ID
integer

Целочисленный идентификатор лида

Да

Нет

TITLE
string

Название лида

Да

Да

HONORIFIC
crm_status

Вид обращения. Статус из справочника.

Список возможных идентификаторов можно получить методом crm.status.list с фильтром filter[ENTITY_ID]=HONORIFIC

Да

Да

NAME
string

Имя контакта

Да

Да

SECOND_NAME
string

Отчество контакта

Да

Да

LAST_NAME
string

Фамилия контакта

Да

Да

BIRTHDATE
date

Дата рождения

Да

Да

COMPANY_TITLE
string

Название компании, привязанной к лиду

Да

Да

SOURCE_ID
crm_status

Идентификатор источника. Статус из справочника.

Список возможных идентификаторов можно получить методом crm.status.list с фильтром filter[ENTITY_ID]=SOURCE

Да

Да

SOURCE_DESCRIPTION
string

Описание источника

Да

Да

STATUS_ID
crm_status

Идентификатор стадии лида. Статус из справочника.

Список возможных идентификаторов можно получить методом crm.status.list с фильтром filter[ENTITY_ID]=STATUS

Да

Да

STATUS_DESCRIPTION
string

Дополнительно о стадии

Да

Да

STATUS_SEMANTIC_ID
string

Статус. Возможные значения:

  • F (failed) — обработан неуспешно
  • S (success) — обработан успешно
  • P (processing) — лид в обработке

Да

Нет

POST
string

Должность

Да

Да

ADDRESS
string

Адрес контакта

Да

Да

ADDRESS_2
string

Вторая страница адреса. В некоторых странах принято разбивать адрес на 2 части

Да

Да

ADDRESS_CITY
string

Город

Да

Да

ADDRESS_POSTAL_CODE
string

Почтовый индекс

Да

Да

ADDRESS_REGION
string

Район

Да

Да

ADDRESS_PROVINCE
string

Область

Да

Да

ADDRESS_COUNTRY
string

Страна

Да

Да

ADDRESS_COUNTRY_CODE
string

Код страны

Да

Да

ADDRESS_LOC_ADDR_ID
integer

Идентификатор адреса из модуля местоположений

Да

Да

CURRENCY_ID
crm_currency

Идентификатор валюты

Да

Да

OPPORTUNITY
double

Предполагаемая сумма

Да

Да

IS_MANUAL_OPPORTUNITY
char

Признак ручного расчета суммы. Допустимые значения Y или N

Да

Да

OPENED
char

Доступен для всех. Допустимые значения Y или N

Да

Да

COMMENTS
string

Комментарии

Да

Да

HAS_PHONE
char

Признак заполненности поля телефон. Допустимые значения Y или N

Да

Нет

HAS_EMAIL
char

Признак заполненности поля электронной почты. Допустимые значения Y или N

Да

Нет

HAS_IMOL
char

Признак наличия привязанной открытой линии. Допустимые значения Y или N

Да

Нет

ASSIGNED_BY_ID
user

Идентификатор пользователя, ответственного за лид

Да

Да

CREATED_BY_ID
user

Идентификатор пользователя, создавшего лид

Да

Нет

MODIFY_BY_ID
user

Идентификатор автора последнего изменения

Да

Нет

MOVED_BY_ID
user

Идентификатор автора перемещения элемента на текущую стадию

Да

Нет

DATE_CREATE
datetime

Дата создания

Да

Нет

DATE_MODIFY
datetime

Дата изменения

Да

Нет

MOVED_TIME
datetime

Дата перемещения элемента на текущую стадию

Да

Нет

COMPANY_ID
crm_company

Привязка лида к компании (Поле Клиент->Компания)

Да

Да

CONTACT_ID
crm_contact

Привязка лида к контакту. Устаревшее поле, сейчас не используется. Оставлено для обратной совместимости

Да

Да

CONTACT_IDS
crm_contact

Идентификатор привязанного контакта. Множественный.

При использовании crm.lead.update и crm.lead.add можно передать массив контактов

Да

Да

IS_RETURN_CUSTOMER
char

Признак повторного лида. Допустимые значения Y или N

Да

Нет

DATE_CLOSED
datetime

Дата закрытия

Да

Нет

ORIGINATOR_ID
string

Идентификатор источника данных. Используется только для привязки к внешнему источнику

Да

Да

ORIGIN_ID
string

Идентификатор элемента в источнике данных. Используется только для привязки к внешнему источнику

Да

Да

UTM_SOURCE
string

Рекламная система (Yandex-Direct, Google-Adwords и другие)

Да

Да

UTM_MEDIUM
string

Тип трафика: CPC (объявления), CPM (баннеры)

Да

Да

UTM_CAMPAIGN
string

Обозначение рекламной кампании

Да

Да

UTM_CONTENT
string

Содержание кампании. Например, для контекстных объявлений

Да

Да

UTM_TERM
string

Условие поиска кампании. Например, ключевые слова контекстной рекламы

Да

Да

LAST_ACTIVITY_TIME
datetime

Время последней активности

Да

Нет

LAST_ACTIVITY_BY
string

Идентификатор пользователя, ответственного за последнюю активность в этом лиде (например, создавшего новое дело в лиде)

Да

Нет

PHONE
crm_multifield

Телефон контакта. Множественный

Да

Да

EMAIL
crm_multifield

Адрес электронной почты. Множественный

Да

Да

WEB
crm_multifield

URL ресурсы лида. Множественный

Да

Да

IM
crm_multifield

Мессенджеры. Множественный

Да

Да

LINK
crm_multifield

Ссылки. Множественное. Служебное

Да

Да

UF_CRM_ххх

Пользовательские поля

Да

Да

Описание полей возвращает метод crm.company.fields

Название
тип

Описание

Чтение

Запись

ID
integer

Идентификатор компании

Да

Нет

TITLE
string

Название. Обязательное

Да

Да

COMPANY_TYPE
crm_status

Тип компании

Да

Да

LOGO
file

Логотип

Да

Да

ADDRESS
string

Адрес компании

Да

Да

ADDRESS_2
string

Вторая страница адреса. В некоторых странах принято разбивать адрес на 2 части

Да

Да

ADDRESS_CITY
string

Город

Да

Да

ADDRESS_POSTAL_CODE
string

Почтовый индекс

Да

Да

ADDRESS_REGION
string

Район

Да

Да

ADDRESS_PROVINCE
string

Область

Да

Да

ADDRESS_COUNTRY
string

Страна

Да

Да

ADDRESS_COUNTRY_CODE
string

Код страны

Да

Да

ADDRESS_LOC_ADDR_ID
integer

Идентификатор адреса местоположения

Да

Да

ADDRESS_LEGAL
string

Юридический адрес

Да

Да

REG_ADDRESS
string

Юридический адрес компании. Устарел, используется для совместимости

Да

Да

REG_ADDRESS_2
string

Вторая страница юридического адреса. В некоторых странах принято разбивать адрес на 2 части.

Устарел, используется для совместимости

Да

Да

REG_ADDRESS_CITY
string

Город юридического адреса. Устарел, используется для совместимости

Да

Да

REG_ADDRESS_POSTAL_CODE
string

Почтовый индекс юридического адреса. Устарел, используется для совместимости

Да

Да

REG_ADDRESS_REGION
string

Район юридического адреса. Устарел, используется для совместимости

Да

Да

REG_ADDRESS_PROVINCE
string

Область юридического адреса. Устарел, используется для совместимости

Да

Да

REG_ADDRESS_COUNTRY
string

Страна юридического адреса. Устарел, используется для совместимости

Да

Да

REG_ADDRESS_COUNTRY_CODE
string

Код страны юридического адресa. Устарел, используется для совместимости

Да

Да

REG_ADDRESS_LOC_ADDR_ID
integer

Юридический адрес идентификатор адреса местоположения. Устарел, используется для совместимости

Да

Да

BANKING_DETAILS
string

Банковские реквизиты

Да

Да

INDUSTRY
crm_status

Сфера деятельности

Да

Да

EMPLOYEES
crm_status

Количество сотрудников

Да

Да

CURRENCY_ID
crm_currency

Валюта

Да

Да

REVENUE
double

Годовой оборот

Да

Да

OPENED
char

Доступен для всех

Да

Да

COMMENTS
string

Комментарии

Да

Да

HAS_PHONE
char

Проверка заполненности поля телефона

Да

Нет

HAS_EMAIL
char

Проверка заполненности поля электронной почты

Да

Нет

HAS_IMOL
char

Задана ли открытая линия

Да

Нет

IS_MY_COMPANY
char

Моя компания

Да

Да

ASSIGNED_BY_ID
user

Связана ли с пользователем по ID

Да

Да

CREATED_BY_ID
user

Кем создана компания

Да

Нет

MODIFY_BY_ID
user

Идентификатор автора последнего изменения

Да

Нет

DATE_CREATE
datetime

Дата создания

Да

Нет

DATE_MODIFY
datetime

Дата изменения

Да

Нет

CONTACT_ID
string

Контакт. Используется только для привязки к внешнему источнику.

Да

Да

LEAD_ID
crm_lead

Идентификатор лида, связанного с компанией

Да

Нет

ORIGINATOR_ID
string

Идентификатор источника данных. Используется только для привязки к внешнему источнику

Да

Да

ORIGIN_ID
string

Идентификатор элемента в источнике данных. Используется только для привязки к внешнему источнику

Да

Да

ORIGIN_VERSION
string

Оригинальная версия. Используется для защиты данных от случайного перетирания внешней системой.

Если данные были импортированы и не изменялись во внешней системе, то такие данные могут быть редактированы в CRM без опасения, что следующая выгрузка приведет к перетиранию данных

Да

Да

UTM_SOURCE
string

Рекламная система (Yandex-Direct, Google-Adwords и другие)

Да

Да

UTM_MEDIUM
string

Тип трафика: CPC (объявления), CPM (баннеры)

Да

Да

UTM_CAMPAIGN
string

Обозначение рекламной кампании

Да

Да

UTM_CONTENT
string

Содержание кампании. Например, для контекстных объявлений

Да

Да

UTM_TERM
string

Условие поиска кампании. Например, ключевые слова контекстной рекламы

Да

Да

PARENT_ID_xxx
crm_entity

Поля связей.

Если на портале есть смарт-процессы, связанные с контактами, для каждого такого смарт-процесса существует поле, хранящее связь между этим смарт-процессом и контактом. Само поле хранит идентификатор элемента такого смарт-процесса.

Например, поле PARENT_ID_153 — связь со смарт-процессом entityTypeId=153, хранит идентификатор элемента этого смарт-процесса, связанного с текущим контактом

Да

Да

LAST_ACTIVITY_TIME
datetime

Время последней активности.

Да

Нет

LAST_ACTIVITY_BY
string

Идентификатор пользователя, ответственного за последнюю активность в этом лиде (например, создавшего новое дело в лиде)

Да

Нет

PHONE
crm_multifield

Телефон компании. Множественное

Да

Да

EMAIL
crm_multifield

Адрес электронной почты. Множественное

Да

Да

WEB
crm_multifield

URL ресурсов компании. Множественное

Да

Да

IM
crm_multifield

Мессенджеры. Множественное

Да

Да

LINK
crm_multifield

Ссылки. Множественное. Служебное

Да

Да

Описание полей возвращает метод crm.contact.fields

Название
тип

Описание

Чтение

Запись

ID
integer

Идентификатор контакта

Да

Нет

HONORIFIC
crm_status

Обращение.

Получить значения справочника можно с помощью метода crm.status.list с фильтром по ENTITY_ID=HONORIFIC

Да

Да

NAME
string

Имя

Да

Да

SECOND_NAME
string

Отчество

Да

Да

LAST_NAME
string

Фамилия

Да

Да

PHOTO
file

Фотография

Да

Да

BIRTHDATE
date

Дата рождения

Да

Да

TYPE_ID
crm_status

Тип контакта.

Получить значения справочника можно с помощью метода crm.status.list с фильтром по ENTITY_ID=CONTACT_TYPE

Да

Да

SOURCE_ID
crm_status

Источник.

Получить значения справочника можно с помощью метода crm.status.list с фильтром по ENTITY_ID=SOURCE

Да

Да

SOURCE_DESCRIPTION
string

Дополнительно об источнике

Да

Да

POST
string

Должность

Да

Да

Устревшие поля

Поля адреса в контакте являются устаревшими и используются только в режиме совместимости. Для работы с адресом используйте реквизиты.

ADDRESS
string

Адрес (устаревшее)

Да

Да

ADDRESS_2
string

Вторая строка адреса (устаревшее)

Да

Да

ADDRESS_CITY
string

Город (устаревшее)

Да

Да

ADDRESS_POSTAL_CODE
string

Почтовый индекс (устаревшее)

Да

Да

ADDRESS_REGION
string

Район (устаревшее)

Да

Да

ADDRESS_PROVINCE
string

Область (устаревшее)

Да

Да

ADDRESS_COUNTRY
string

Страна (устаревшее)

Да

Да

ADDRESS_COUNTRY_CODE
string

Код страны (устаревшее)

Да

Да

ADDRESS_LOC_ADDR_ID
location

Идентификатор адреса местоположения (устаревшее)

Да

Да

COMMENTS
string

Комментарий. Поддерживает bb-коды

Да

Да

OPENED
char

Доступен для всех. Может принимать значения Y или N. Учитывается в работе прав доступа для ролей с уровнем доступа «Все открытые»

Да

Да

EXPORT
char

Участвует в экспорте контактов. Может принимать значения Y или N

Да

Да

HAS_PHONE
char

Задан телефон. Может принимать значения Y или N

Да

Нет

HAS_EMAIL
char

Задан e-mail. Может принимать значения Y или N

Да

Нет

HAS_IMOL
char

Задана открытая линия. Может принимать значения Y или N

Да

Нет

ASSIGNED_BY_ID
user

Ответственный

Да

Да

CREATED_BY_ID
user

Кем создан

Да

Нет

MODIFY_BY_ID
user

Кем изменен

Да

Нет

DATE_CREATE
datetime

Дата создания

Да

Нет

DATE_MODIFY
datetime

Дата изменения

Да

Нет

COMPANY_ID
crm_company

Основная компания контакта

Да

Да

COMPANY_IDS
crm_company

Привязка контакта к компаниям. Множественное.

В методах crm.contact.update и crm.contact.add используется для подачи массива компаний.

В методах crm.contact.list и crm.contact.get поля нет и необходимо использовать crm.contact.company.items.get для получения списка компаний

Да

Да

LEAD_ID
crm_lead

Идентификатор лида, связанного с контактом

Да

Нет

Поля связи с внешними источниками данных

Если контакт создан внешней системой, то:

  • поле ORIGINATOR_ID хранит строковый идентификатор этой системы
  • поле ORIGIN_ID хранит строковый идентификатор контакта в этой внешней системе
  • поле ORIGIN_VERSION хранит версию данных контакта в этой внешней системе

ORIGINATOR_ID
string

Идентификатор внешней системы, являющейся источником данных об этом контакте

Да

Да

ORIGIN_ID
string

Идентификатор контакта во внешней системе

Да

Да

ORIGIN_VERSION
string

Версия данных о контакте во внешней системе. Используется для защиты данных от случайного перетирания внешней системой.

Если данные были импортированы и не изменялись во внешней системе, то такие данные могут быть редактированы в CRM без опасения, что следующая выгрузка приведет к перетиранию данных.

Да

Да

FACE_ID
integer

Привязка к лицам из модуля faceid

Да

Нет

UTM_SOURCE
string

Рекламная система (Yandex-Direct, Google-Adwords и другие)

Да

Да

UTM_MEDIUM
string

Тип трафика: CPC (объявления), CPM (баннеры)

Да

Да

UTM_CAMPAIGN
string

Обозначение рекламной кампании

Да

Да

UTM_CONTENT
string

Содержание кампании. Например, для контекстных объявлений

Да

Да

UTM_TERM
string

Условие поиска кампании. Например, ключевые слова контекстной рекламы

Да

Да

PARENT_ID_...

Поля связей.

Если на портале есть смарт-процессы, связанные с контактами, для каждого такого смарт-процесса существует поле, хранящее связь между этим смарт-процессом и контактом. Само поле хранит идентификатор элемента такого смарт-процесса.

Например, поле PARENT_ID_153 — связь со смарт-процессом entityTypeId=153, хранит идентификатор элемента этого смарт-процесса, связанного с текущим контактом

LAST_ACTIVITY_TIME
datetime

Дата последней активности в таймлайне

Да

Нет

LAST_ACTIVITY_BY
user

Автор последней активности в таймлайне

Да

Нет

PHONE
crm_multifield

Телефоны. Множественное

Да

Да

EMAIL
crm_multifield

E-mail. Множественное

Да

Да

WEB
crm_multifield

Сайты. Множественное

Да

Да

IM
crm_multifield

Мессенджеры. Множественное

Да

Да

LINK
crm_multifield

Ссылки. Множественное. Служебное

Да

Да

UF_CRM_xxx

Пользовательские поля. Например, UF_CRM_25534736.

В зависимости от настроек портала у контактов может быть набор пользовательских полей определенных типов. Добавить пользовательское поле в контакт можно с помощью метода crm.contact.userfield.add

Общие реквизиты

Описание полей возвращает метод crm.requisite.fields

Название
тип

Описание

Чтение

Запись

ID
integer

Идентификатор реквизита.

Можно получить с помощью метода crm.requisite.list.

Создается автоматически и уникален в рамках портала

Да

Нет

ENTITY_TYPE_ID
integer

Идентификатор типа родительской сущности. Сейчас это может быть только:

  • 3 — контакт
  • 4 — компания

Идентификаторы всех типов сущностей CRM отдает метод crm.enum.ownertype

Да

Да

ENTITY_ID
integer

Идентификатор родительской сущности (контакта либо компании).

Идентификатор можно получить методом crm.company.list для компании и методом crm.contact.list для контакта

Да

Да

PRESET_ID
integer

Идентификатор шаблона реквизитов.

Идентификаторы шаблонов можно получить методом crm.requisite.preset.list

Да

Да

DATE_CREATE
datetime

Дата создания

Да

Нет

DATE_MODIFY
datetime

Дата изменения

Да

Нет

CREATED_BY_ID
user

Идентификатор создавшего реквизит

Да

Нет

MODIFY_BY_ID
user

Идентификатор изменившего реквизит

Да

Нет

NAME
string

Название реквизита

Да

Да

CODE
string

Символьный код реквизита

Да

Да

XML_ID
string

Внешний ключ, используется для операций обмена.

Идентификатор объекта внешней информационной базы.

Назначение поля может меняться конечным разработчиком

Да

Да

ORIGINATOR_ID
string

Идентификатор внешней информационной базы.

Назначение поля может меняться конечным разработчиком

Да

Да

ACTIVE
char

Признак активности.

Используются значения Y или N.

Сейчас поле фактически ни на что не влияет

Да

Да

ADDRESS_ONLY
char

Признак состояния, когда реквизит используется только для хранения адреса.

Используются значения Y или N. При значении Y реквизиты не показываются в карточке сущности, но отображается адрес

Да

Да

SORT
integer

Сортировка. Порядок в списке реквизитов сущности, когда их несколько

Да

Да

RQ_NAME
string

ФИО

Да

Да

RQ_FIRST_NAME
string

Имя

Да

Да

RQ_LAST_NAME
string

Фамилия

Да

Да

RQ_SECOND_NAME
string

Отчество

Да

Да

RQ_COMPANY_ID
string

Идентификатор организации

Да

Да

RQ_COMPANY_NAME
string

Сокращенное наименование организации

Да

Да

RQ_COMPANY_FULL_NAME
string

Полное наименование организации

Да

Да

RQ_COMPANY_REG_DATE
string

Дата государственной регистрации

Да

Да

RQ_DIRECTOR
string

Генеральный директор

Да

Да

RQ_ACCOUNTANT
string

Главный бухгалтер

Да

Да

RQ_CEO_NAME
string

ФИО первого руководителя

Да

Да

RQ_CEO_WORK_POS
string

Должность первого руководителя

Да

Да

RQ_CONTACT
string

Контактное лицо

Да

Да

RQ_EMAIL
string

E-Mail

Да

Да

RQ_PHONE
string

Телефон

Да

Да

RQ_FAX
string

Факс

Да

Да

RQ_IDENT_TYPE
crm_status

Способ идентификации

Да

Да

RQ_IDENT_DOC
string

Вид документа

Да

Да

RQ_IDENT_DOC_SER
string

Серия

Да

Да

RQ_IDENT_DOC_NUM
string

Номер

Да

Да

RQ_IDENT_DOC_PERS_NUM
string

Личный номер

Да

Да

RQ_IDENT_DOC_DATE
string

Дата выдачи

Да

Да

RQ_IDENT_DOC_ISSUED_BY
string

Кем выдан

Да

Да

RQ_IDENT_DOC_DEP_CODE
string

Код подразделения

Да

Да

RQ_INN
string

ИНН

Да

Да

RQ_KPP
string

КПП

Да

Да

RQ_USRLE
string

Handelsregisternummer (для страны DE)

Да

Да

RQ_IFNS
string

ИФНС

Да

Да

RQ_OGRN
string

ОГРН

Да

Да

RQ_OGRNIP
string

ОГРНИП

Да

Да

RQ_OKPO
string

ОКПО

Да

Да

RQ_OKTMO
string

ОКТМО

Да

Да

RQ_OKVED
string

ОКВЭД

Да

Да

RQ_EDRPOU
string

ЄДРПОУ

Да

Да

RQ_DRFO
string

ДРФО

Да

Да

RQ_KBE
string

КБЕ

Да

Да

RQ_IIN
string

ИИН

Да

Да

RQ_BIN
string

БИН

Да

Да

RQ_ST_CERT_SER
string

Серия свидетельства о государственной регистрации

Да

Да

RQ_ST_CERT_NUM
string

Номер свидетельства о государственной регистрации

Да

Да

RQ_ST_CERT_DATE
string

Дата свидетельства о государственной регистрации

Да

Да

RQ_VAT_PAYER
char

Платник ПДВ (для страны UA).

Используются значения Y или N

Да

Да

RQ_VAT_ID
string

VAT ID (идентификационный номер плательщика НДС)

Да

Да

RQ_VAT_CERT_SER
string

Серия свидетельства по НДС

Да

Да

RQ_VAT_CERT_NUM
string

Номер свидетельства по НДС

Да

Да

RQ_VAT_CERT_DATE
string

Дата свидетельства по НДС

Да

Да

RQ_RESIDENCE_COUNTRY
string

Страна резидента

Да

Да

RQ_BASE_DOC
string

Основание действия

Да

Да

RQ_REGON
string

REGON (для страны PL)

Да

Да

RQ_KRS
string

KRS (для страны PL)

Да

Да

RQ_PESEL
string

PESEL (для страны PL)

Да

Да

RQ_LEGAL_FORM
string

Forme juridique (для страны FR)

Да

Да

RQ_SIRET
string

Numéro Siret (для страны FR)

Да

Да

RQ_SIREN
string

Numéro Siren (для страны FR)

Да

Да

RQ_CAPITAL
string

Capital social (для страны FR)

Да

Да

RQ_RCS
string

RCS (для страны FR)

Да

Да

RQ_CNPJ
string

CNPJ (для страны BR)

Да

Да

RQ_STATE_REG
string

Inscrição Estadual (IE) (для страны BR)

Да

Да

RQ_MNPL_REG
string

Inscrição Municipal (IM) (для страны BR)

Да

Да

RQ_CPF
string

CPF (для страны BR)

Да

Да

UF_CRM_...

Пользовательские поля. Например, UF_CRM_1694526604.

У реквизитов может быть набор пользовательских полей с типами: string, boolean, double, datetime.

Добавить пользовательское поле реквизитов можно методом crm.requisite.userfield.add

Да

Да

Банковские реквизиты

Описание полей возвращает метод crm.requisite.bankdetail.fields

Название
тип

Описание

Чтение

Запись

ID
integer

Идентификатор банковского реквизита. Создается автоматически и уникален в рамках портала

Да

Нет

ENTITY_TYPE_ID
integer

Идентификатор типа родительского объекта. Может быть только Реквизит (значение 8).

Идентификаторы типов объектов возвращает метод crm.enum.ownertype

Да

Нет

ENTITY_ID
integer

Идентификатор родительского объекта

Да

Да

COUNTRY_ID
integer

Идентификатор страны, которой соответствует набор полей банковского реквизита (смотрите метод crm.requisite.preset.countries для получения доступных значений).

Код страны банковского реквизита совпадает с кодом страны в привязанном шаблоне реквизитов, идентификатор которого указан в поле ENTITY_ID

Да

Да

DATE_CREATE
datetime

Дата создания

Да

Нет

DATE_MODIFY
datetime

Дата изменения

Да

Нет

CREATED_BY_ID
user

Идентификатор пользователя, создавшего реквизит

Да

Нет

MODIFY_BY_ID
user

Идентификатор пользователя, изменившего реквизит

Да

Нет

NAME*
string

Название банковского реквизита

Да

Да

CODE
string

Символьный код реквизита

Да

Да

XML_ID
string

Внешний ключ. Используется для операций обмена. Идентификатор объекта внешней информационной базы.

Назначение поля может меняться конечным разработчиком. Каждое приложение обеспечивает уникальность значений в этом поле.

Рекомендуется использовать уникальный префикс для избежания коллизий с другими приложениями

Да

Да

ACTIVE
char

Признак активности. Используются значения Y или N.

Сейчас поле фактически ни на что не влияет

Да

Да

SORT
integer

Сортировка

Да

Да

RQ_BANK_NAME
string

Наименование банка

Да

Да

RQ_BANK_ADDR
string

Адрес банка

Да

Да

RQ_BANK_CODE
string

Código do banco (для страны BR)

Да

Да

RQ_BANK_ROUTE_NUM
string

Bank Routing Number

Да

Да

RQ_BIK
string

БИК

Да

Да

RQ_CODEB
string

Code Banque (для страны FR)

Да

Да

RQ_CODEG
string

Code Guichet (для страны FR)

Да

Да

RQ_RIB
string

Clé RIB (для страны FR)

Да

Да

RQ_MFO
string

МФО

Да

Да

RQ_ACC_NAME
string

Bank Account Holder Name

Да

Да

RQ_ACC_NUM
string

Bank Account Number

Да

Да

RQ_ACC_TYPE
string

Tipo da conta (для страны BR)

Да

Да

RQ_AGENCY_NAME
string

Agência (для страны BR)

Да

Да

RQ_IIK
string

ИИК

Да

Да

RQ_ACC_CURRENCY
string

Валюта счета

Да

Да

RQ_COR_ACC_NUM
string

Корреспондентский счет

Да

Да

RQ_IBAN
string

IBAN

Да

Да

RQ_SWIFT
string

SWIFT

Да

Да

RQ_BIC
string

BIC

Да

Да

COMMENTS
string

Комментарий

Да

Да

ORIGINATOR_ID
string

Идентификатор внешней информационной базы. Назначение поля может меняться конечным разработчиком

Да

Да

Шаблоны реквизитов

Описание полей возвращает метод crm.requisite.preset.fields

Название

Описание

Чтение

Запись

ID
integer

Идентификатор реквизита. Создается автоматически и уникален в рамках портала

Да

Нет

ENTITY_TYPE_ID
integer

Идентификатор типа родительского объекта.

Идентификаторы типов объектов CRM отдает метод crm.enum.ownertype

Да

Да

COUNTRY_ID
integer

Идентификатор страны, которой соответствует набор полей шаблона реквизита (для получения доступных значений смотрите метод crm.requisite.preset.countries)

Да

Да

DATE_CREATE
datetime

Дата создания

Да

Нет

DATE_MODIFY
datetime

Дата изменения. Содержит пустую строку, если шаблон не менялся после создания

Да

Нет

CREATED_BY_ID
user

Идентификатор пользователя, создавшего реквизит

Да

Нет

MODIFY_BY_ID
user

Идентификатор пользователя, изменившего реквизит

Да

Нет

NAME
string

Название реквизита

Да

Да

XML_ID
string

Внешний ключ. Используется для операций обмена. Идентификатор объекта внешней информационной базы.

Назначение поля может меняться конечным разработчиком.

Каждое приложение обеспечивает уникальность значений в этом поле. Рекомендуется использовать уникальный префикс для избежания коллизий с другими приложениями.

В CRM зарезервированы значения вида #CRM_REQUISITE_PRESET_DEF_... для идентификации шаблонов, которые используются по умолчанию. Не следует использовать эти идентификаторы для своих целей, так как это может привести к нарушению логики

Да

Да

ACTIVE
char

Признак активности. Используются значения Y или N. Определяет доступность шаблона в списке выбора при добавлении реквизитов

Да

Да

SORT
integer

Сортировка

Да

Да

Поля шаблонов реквизитов

Описание полей возвращает метод crm.requisite.preset.field.fields

Название
тип

Описание

Чтение

Запись

ID
integer

Идентификатор поля. Создается автоматически и уникален в рамках шаблона

Да

Нет

FIELD_NAME
string

Название поля

Да

Да

FIELD_TITLE
string

Альтернативное название поля для реквизита.

Альтернативное название отображается в различных формах для заполнения реквизитов. В зависимости от конкретной формы альтернативное название может использоваться или нет

Да

Да

SORT
integer

Сортировка. Порядок в списке полей шаблона

Да

Да

IN_SHORT_LIST
char

Показывать в кратком списке. Устаревшее поле, сейчас не используется. Оставлено для обратной совместимости. Может принимать значения Y или N

Да

Да

Адреса реквизитов

Описание полей возвращает метод crm.address.fields

Название

Описание

Чтение

Запись

TYPE_ID
integer

Идентификатор типа адреса. Элемент перечисления «Тип адреса».

Элементы перечисления «Тип адреса» можно получить с помощью метода crm.enum.addresstype

Да

Да

ENTITY_TYPE_ID
integer

Идентификатор типа родительского объекта.

Идентификаторы типов объектов можно получить с помощью метода crm.enum.ownertype.

Адреса могут быть привязаны только к Реквизитам (а реквизиты уже к компаниям либо контактам) или Лидам. Для обратной совместимости оставлена возможность связывать Адреса с Контактами или Компаниями. Но эта связь возможна только на некоторых старых порталах, где специально техподдержкой был включен старый режим работы с адресами.

Да

Да

ENTITY_ID
string

Идентификатор родительского объекта

Да

Да

ADDRESS_1
string

Улица, дом, корпус, строение

Да

Да

ADDRESS_2
string

Квартира / офис

Да

Да

CITY
string

Город

Да

Да

POSTAL_CODE
string

Почтовый индекс

Да

Да

REGION
string

Район

Да

Да

PROVINCE
string

Область

Да

Да

COUNTRY
string

Страна

Да

Да

COUNTRY_CODE
string

Код страны

Да

Да

LOC_ADDR_ID
integer

Идентификатор адреса местоположения.

Это поле содержит идентификатор объекта адреса в модуле Location, связанного с объектов адреса CRM. Каждому адресу CRM соответствует объект адреса в модуле location. Это можно использовать для копирования существующего адреса в CRM с информацией о местоположении, которой нет в полях адреса CRM.

Если при создании адреса указан идентификатор адреса модуля location, то создается копия адреса location и привязывается к созданному адресу CRM. Если в таком случае не указаны значения для строковых полей адреса, то они будут заполнены из location-адреса.

Если же было указано хоть одно строковое поле, то в адресе CRM будут сохранены только указанные поля, и их значения перезапишут соответствующие значения в объекте location-адреса. Такое же поведение будет и при обновлении адреса

Да

Да

ANCHOR_TYPE_ID
integer

Идентификатор типа основного родительского объекта.

Это поле для служебного использования. Значение заполняется автоматически при добавлении адреса.

Идентификаторы типов объектов можно получить с помощью метода crm.enum.ownertype.

В этом поле содержится идентификатор типа родительского объекта реквизита (компания или контакт), если адрес привязан к реквизиту. Если адрес привязан к лиду, то этим значением будет идентификатор типа лид

Да

Нет

ANCHOR_ID
integer

Это поле для служебного использования. Значение заполняется автоматически при добавлении адреса.

В этом поле содержится идентификатор родительского объекта реквизита (компании или контакта), если адрес привязан к реквизиту. Если адрес привязан к лиду, то этим значением будет идентификатор лида

Да

Нет

Описание полей возвращает метод crm.activity.fields

Название

Описание

Чтение

Запись

ID
integer

Идентификатор дела

Да

Нет

OWNER_ID
integer

Идентификатор владельца, неизменяемое

Да

Да

OWNER_TYPE_ID
crm.enum.ownertype

Тип владельца, неизменяемое

Да

Да

TYPE_ID
crm_enum_activitytype

Тип, неизменяемый

Да

Да

PROVIDER_ID
string

Идентификатор провайдера

Да

Да

PROVIDER_TYPE_ID
string

Идентификатор типа провайдера

Да

Да

PROVIDER_GROUP_ID
string

Тип коннектора

Да

Да

ASSOCIATED_ENTITY_ID
integer

Идентификатор связанной с делом сущности

Да

Нет

SUBJECT
string

Тема, заголовок дела

Да

Да

START_TIME
datetime

Время начала выполнения

Да

Да

END_TIME
datetime

Время завершения

Да

Да

DEADLINE
datetime

Срок исполнения. Поле напрямую не устанавливается, значение берется из START_TIME для звонка и встречи и из END_TIME для задачи

Да

Да

COMPLETED
char

Выполнено

Да

Да

STATUS
crm_enum_activitystatus

Статус

Да

Да

RESPONSIBLE_ID
user

Ответственный

Да

Да

PRIORITY
crm.enum.activitypriority

Важность

Да

Да

NOTIFY_TYPE
crm.enum.activitynotifytype

Тип уведомлений

Да

Да

NOTIFY_VALUE
integer

Параметр уведомления

Да

Да

DESCRIPTION
string

Описание

Да

Да

DESCRIPTION_TYPE
crm.enum.contenttype

Тип описания

Да

Да

DIRECTION
crm.enum.activitydirection

Направление дела: входящее/исходящее. Актуально для звонков и писем, для встреч не используется

Да

Да

LOCATION
string

Местоположение

Да

Да

CREATED
datetime

Дата создания

Да

Нет

AUTHOR_ID
user

Создатель дела

Да

Да

LAST_UPDATED
datetime

Дата последнего обновления

Да

Нет

EDITOR_ID
user

Кто изменил

Да

Нет

SETTINGS
object

Настройки

Да

Да

ORIGIN_ID
string

Идентификатор элемента в источнике данных. Используется только для привязки к внешнему источнику

Да

Да

ORIGINATOR_ID
string

Идентификатор источника данных. Используется только для привязки к внешнему источнику

Да

Да

RESULT_STATUS
integer

Неиспользуемое поле, остается для совместимости

Да

Да

RESULT_STREAM
integer

Статистика отчетов

Да

Да

RESULT_SOURCE_ID
string

Неиспользуемое поле, остается для совместимости

Да

Да

PROVIDER_PARAMS
object

Параметры провайдера

Да

Да

PROVIDER_DATA
string

Данные провайдера

Да

Да

RESULT_MARK
integer

Неиспользуемое поле, остается для совместимости

Да

Да

RESULT_VALUE
double

Неиспользуемое поле, остается для совместимости

Да

Да

RESULT_SUM
double

Неиспользуемое поле, остается для совместимости

Да

Да

RESULT_CURRENCY_ID
string

Неиспользуемое поле, остается для совместимости

Да

Да

AUTOCOMPLETE_RULE
integer

Автозаполнение

Да

Да

BINDINGS
crm_activity_binding

Привязки

Да

Нет

COMMUNICATIONS
crm_activity_communication

Канал коммуникации. Множественное, обязательное

Да

Да

FILES
diskfile

Добавленные файлы. Множественное

Да

Да

WEBDAV_ELEMENTS
diskfile

Добавленные файлы. Множественное. Устарел, сохраняется для совместимости

Да

Да

IS_INCOMING_CHANNEL
char

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

Да

Нет