Описание сущности

Лид - это любая минимальная информация о намерении получить услугу/товар. Заполнение формы обратной связи, входящий звонок, письпо полученное на почтовый ящик - это намерение купить товар/приобрести услугу.

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

Поля лидов

В таблице указаны основные поля непосредственной сущности Лид.

Поле Тип Описание Примечание
ID int Уникальный целочисленный идентификатор лида AI, RO
TITLE string Название лида REQ
HONORIFIC crm_status Обращение Код справочника: HONORIFIC
NAME string Имя
SECOND_NAME string Отчество
LAST_NAME string Фамилия
BIRTHDATE date Дата рождения
BIRTHDAY_SORT integer Универсальное число, получаемое из даты рождения для сортировки и поиска
COMPANY_TITLE string Название компании
SOURCE_ID crm_status Источник Код справочника: SOURCE
SOURCE_DESCRIPTION string Дополнительно об источнике
STATUS_ID crm_status Статус Код справочника: STATUS
STATUS_DESCRIPTION string Дополнительно о статусе
STATUS_SEMANTIC_ID string Состояние статуса (N (новый), P (в работе), F (закрыт)) RO
POST string Должность
CURRENCY_ID crm_currency Валюта
OPPORTUNITY double Сумма
OPENED char Доступен для всех Y/N
COMMENTS string Комментарий
HAS_PHONE char Задан телефон, автоматически вычисляется при создании/обновлении Y/N, RO
HAS_EMAIL char Задан e-mail, автоматически вычисляется при создании/обновлении Y/N, RO
HAS_IMOL char Задана открытая линия, автоматически вычисляется при создании/обновлении Y/N, RO
ASSIGNED_BY_ID user Ответственный
CREATED_BY_ID user Кем создан RO
MODIFY_BY_ID user Кем изменен RO
DATE_CREATE datetime Дата создания RO
DATE_MODIFY datetime Дата изменения RO
COMPANY_ID crm_company Компания
CONTACT_ID crm_contact Контакт DEP
IS_RETURN_CUSTOMER char Повторный лид Y/N, RO
DATE_CLOSED datetime Дата завершения RO
ORIGINATOR_ID string Внешний источник
ORIGIN_ID string Идентификатор элемента во внешнем источнике
UTM_SOURCE string Рекламная система
UTM_MEDIUM string Тип трафика
UTM_CAMPAIGN string Обозначение рекламной кампании
UTM_CONTENT string Содержание кампании
UTM_TERM string Условие поиска кампании
PHONE crm_multifield Телефон RO
EMAIL crm_multifield E-mail RO
WEB crm_multifield Сайт RO
IM crm_multifield Мессенджер RO

Примечание к перечисленным полям:

  1. Для расшифровки типов можно обратиться к Типам данных.

  2. Для обозначения специальных полей используются дополнительные флаги:

  • RO - read only (поле только для чтения)
  • AI - auto increment (автоматически заполняемый счетчик, наследует поведение RO)
  • REQ - required (обязательное)
  • DEP - deprecated (устаревшее). Не следует ориентироваться на данные поля, так как они могут быть удалены или их поведение было изменено
  1. Не следует использовать поля ORIGINATOR_ID и ORIGIN_ID для хранения внешних ключей при синхронизации. Эти поля заполняются исключительно при создании из внешних систем.

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