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

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

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

Страница помогает определить назначение и тип стандартных полей основных объектов CRM. Используйте справочник при формировании select, filter и fields в методах CRM.

Состав полей и их настройки могут отличаться в разных Битрикс24. Перед созданием интеграции получите актуальное описание полей методом crm.название_объекта.fields, например crm.deal.fields для сделки. Таблицы ниже нужны для быстрого поиска и не заменяют ответ метода.

Методы возвращают актуальные признаки доступности каждого поля:

  • isReadOnly: true — поле доступно только для чтения
  • isImmutable: true — значение поля можно задать при создании объекта, но нельзя изменить после сохранения
  • isRequired: true — поле обязательно
  • isMultiple: true — поле принимает несколько значений
  • isDynamic: true — поле создано в конкретном Битрикс24 и не входит в стандартный набор

Чтобы подготовить запрос:

  1. Выберите объект и вызовите его метод .fields
  2. Найдите поле по идентификатору и проверьте его тип и признаки доступности
  3. Получите допустимые значения динамических справочников, например стадий и пользовательских полей
  4. Передайте поле в методе создания, изменения, получения или списка с учетом возвращенных признаков

Ограничения длины полей описаны в статье Ограничения длины полей CRM.

Сделки

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

Название
тип

Описание

ID
integer

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

TITLE
string

Название

TYPE_ID
crm_status

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

CATEGORY_ID
crm_category

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

STAGE_ID
crm_status

Идентификатор стадии сделки. Набор стадий зависит от воронки. Получить стадии можно методом crm.status.list с фильтром по ENTITY_ID: DEAL_STAGE для общей воронки или DEAL_STAGE_{CATEGORY_ID} для другой воронки

STAGE_SEMANTIC_ID
string

Группа стадии сделки. Возможные значения:

  • P — стадия в работе
  • S — успешная стадия
  • F — неуспешная стадия

IS_NEW
char

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

IS_RECURRING
char

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

IS_RETURN_CUSTOMER
char

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

IS_REPEATED_APPROACH
char

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

PROBABILITY
integer

Вероятность

CURRENCY_ID
crm_currency

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

OPPORTUNITY
double

Сумма

IS_MANUAL_OPPORTUNITY
char

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

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

Поля связей.

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

Например, поле 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

Поля связей.

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

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

LAST_ACTIVITY_TIME
datetime

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

LAST_ACTIVITY_BY
user

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

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_...

Поля связей.

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

Например, поле 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.

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

Реквизиты

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

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

Название
тип

Описание

ID
integer

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

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

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

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

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

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

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

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.

Адреса можно привязать к реквизитам или лидам. Реквизиты, в свою очередь, связаны с компаниями или контактами. Для обратной совместимости в некоторых старых Битрикс24 может быть доступна прямая связь адреса с контактом или компанией.

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

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

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