Документация для разработчиков

Структура таблиц


Важно! Настоятельно рекомендуется при обновлении адреса передавать полный набор полей адреса в метод обновления. Частичное обновление поддерживается, но нежелательно из-за возможных конкурирующих запросов на обновление адреса другими приложениями.

Пример

Допустим, у компании был адрес "г. Калининград, ул. Фридриха Маркса, д. 50, кв. 5".

Чужое приложение: чтение адреса "г. Калининград, ул. Фридриха Маркса, д. 50, кв. 5".
Ваше приложение: чтение адреса "г. Калининград, ул. Фридриха Маркса, д. 50, кв. 5".

Чужое приложение: сохранение адреса "г. Светлогорск, ул. Ленина, д. 100, кв. 10" (исправление ошибки - полная замена адреса на адрес другого филиала).
Ваше приложение: сохранение части адреса "ул. Карла Маркса" (исправление ошибки - корректировка названия улицы, а на самом деле создание новой ошибки).

В результате двух конкурирующих запросов на обновление адрес компании стал "г. Светлогорск, ул. Карла Маркса, д. 100, кв. 10".
Таким образом, мы можем получить неконсистентный адрес.


Сделки

ПолеОписаниеЧтение Запись
ID Идентификатор сделки. Создается автоматически и уникален в рамках БД.ДаНет
TITLEНазвание сделки. Обязательное поле.Да Да
TYPE_IDИдентификатор типа сделки.ДаДа
STAGE_IDИдентификатор этапа сделкиДаДа
PROBABILITY Вероятность заключения сделки (в %) Да Да
CURRENCY_ID Валюта сделки Да Да
OPPORTUNITY Сумма в валюте сделки Да Да
COMPANY_ID Идентификатор компании-контрагента сделки Да Да
CONTACT_ID Идентификатор контактного лица Да Да
BEGINDATE Дата открытия сделки Да Да
CLOSEDATE Дата закрытия сделки Да Да
OPENED Флаг "Сделка доступна для всех" Да Да
CLOSED Флаг "Сделка закрыта" Да Да
COMMENTS Комментарии Да Да
ASSIGNED_BY_ID Идентификатор ответственного за сделку Да Да
CREATED_BY_ID Идентификатор создавшего сделку Да Нет
MODIFY_BY_ID Идентификатор изменившего сделку Да Нет
DATE_CREATE Дата создания Да Нет
DATE_MODIFY Дата изменения Да Нет
LEAD_ID Идентификатор лида Да Нет
ADDITIONAL_INFO Дополнительная информация Да Да
ORIGINATOR_ID Идентификатор внешней информационной базы. Назначение поля может меняться конечным разработчиком. Да Да
ORIGIN_IDВнешний ключ, используется для операций обмена. Идентификатор объекта внешней информационной базы. Назначение поля может меняться конечным разработчиком. ДаДа
CATEGORY_IDИдентификатор направления сделки. ДаДа

Лиды

Поле Описание Чтение Запись
ID Идентификатор лида. Да Нет
TITLE Название лида. Обязательное поле. Да Да
NAME Имя контакта Да Да
SECOND_NAME Отчество контакта Да Да
LAST_NAME Фамилия Да Да
COMPANY_TITLE Название компании Да Да
SOURCE_ID Идентификатор источника Да Да
SOURCE_DESCRIPTION Дополнительно об источнике Да Да
STATUS_ID Идентификатор статуса лида Да Да
STATUS_DESCRIPTION Дополнительная информация о статусе Да Да
POST Должность Да Да
ADDRESS Улица, дом, корпус, строение Да Да
ADDRESS_2 Квартира, офисДаДа
ADDRESS_CITY ГородДаДа
ADDRESS_POSTAL_CODE Почтовый индексДаДа
ADDRESS_REGION РайонДаДа
ADDRESS_PROVINCE ОбластьДаДа
ADDRESS_COUNTRY СтранаДаДа
ADDRESS_COUNTRY_CODE Код страныДаДа
CURRENCY_ID Идентификатор валюты Да Да
OPPORTUNITY Предполагаемая сумма Да Да
OPENED Флаг "Доступен для всех" Да Да
COMMENTS Комментарии Да Да
ASSIGNED_BY_ID Ответственный Да Да
CREATED_BY_ID Создан Да Нет
MODIFY_BY_ID Изменен Да Нет
DATE_CREATE Дата создания Да Нет
DATE_MODIFY Дата изменения Да Нет
COMPANY_ID Идентификатор компании Да Нет
CONTACT_ID Идентификатор контакта Да Нет
DATE_CLOSED Дата закрытия Да Нет
PHONE PHONE Да Да
EMAIL e-mail Да Да
WEB веб-сайт Да Да
IM Контакт в службе обмена мгновенными сообщениями Да Да
ORIGINATOR_ID Идентификатор внешней информационной базы. Назначение поля может меняться конечным разработчиком. Да Да
ORIGIN_ID Внешний ключ, используется для операций обмена. Идентификатор объекта внешней информационной базы. Назначение поля может меняться конечным разработчиком. Да Да

Компании

Поле Описание Чтение Запись
ID Идентификатор компании. Создается автоматически и уникален в рамках БД. Да Нет
TITLE Название компании. Обязательное поле.. Да Да
COMPANY_TYPE Тип компании. Выбирается из списка Да Да
LOGO Логотип компании Да Да
ADDRESSУлица, дом, корпус, строение (фактический адрес)ДаДа
ADDRESS_2Квартира / офис (фактический адрес)ДаДа
ADDRESS_CITYГород (фактический адрес)ДаДа
ADDRESS_POSTAL_CODE Почтовый индекс (фактический адрес)ДаДа
ADDRESS_REGION Район (фактический адрес)ДаДа
ADDRESS_PROVINCE Область (фактический адрес)ДаДа
ADDRESS_COUNTRY Страна (фактический адрес)ДаДа
ADDRESS_COUNTRY_CODE Код Страны (фактический адрес)ДаДа
REG_ADDRESSУлица, дом, корпус, строение (юридический адрес)ДаДа
REG_ADDRESS_2Квартира / офис (юридический адрес)ДаДа
REG_ADDRESS_CITYГород (юридический адрес)ДаДа
REG_ADDRESS_POSTAL_CODE Почтовый индекс (юридический адрес)ДаДа
REG_ADDRESS_REGION Район (юридический адрес)ДаДа
REG_ADDRESS_PROVINCE Область (юридический адрес)ДаДа
REG_ADDRESS_COUNTRY Страна (юридический адрес)ДаДа
REG_ADDRESS_COUNTRY_CODE Код Страны (юридический адрес)ДаДа
ADDRESS_LEGAL Юридический адрес Да Да
BANKING_DETAILS Банковские реквизиты Да Да
INDUSTRY Сфера деятельности. Выбирается из списка. Да Да
EMPLOYEES Количество сотрудников. Выбирается из списка Да Да
CURRENCY_ID Валюта расчетов Да Да
REVENUE Годовой оборот Да Да
OPENED Флаг "Доступна для всех" Да Да
COMMENTS Комментарии Да Да
ASSIGNED_BY_ID Идентификатор ответственного Да Да
CREATED_BY_ID Создал Да Нет
MODIFY_BY_ID Изменил Да Нет
DATE_CREATE Дата создания Да Нет
DATE_MODIFY Дата изменения Да Нет
LEAD_ID Идентификатор лида Да Нет
ORIGINATOR_ID Идентификатор внешней информационной базы. Назначение поля может меняться конечным разработчиком. Да Да
ORIGIN_ID Внешний ключ, используется для операций обмена. Идентификатор объекта внешней информационной базы. Назначение поля может меняться конечным разработчиком. Да Да
PHONE PHONE Да Да
EMAIL e-mail Да Да
WEB веб-сайт Да Да
IM Контакт в службе обмена мгновенными сообщениями Да Да

Контакты

Поле Описание Чтение Запись
ID Идентификатор контакта. Создается автоматически и уникален в пределах БД Да Да
NAME Имя контакта. Обязательное поле Да Да
SECOND_NAME Отчество контакта. Обязательное поле Да Да
LAST_NAME Фамилия Контакта. Обязательное поле Да Да
PHOTO Фотография контакта Да Да
BIRTHDATE Дата рождения контакта Да Да
TYPE_ID Тип контакта Да Да
SOURCE_ID Источник Да Да
SOURCE_DESCRIPTION Подробнее об источнике Да Да
POST Должность Да Да
ADDRESS Улица, дом, корпус, строение Да Да
ADDRESS_2 Квартира, офисДаДа
ADDRESS_CITY ГородДаДа
ADDRESS_POSTAL_CODE Почтовый индексДаДа
ADDRESS_REGION РайонДаДа
ADDRESS_PROVINCE ОбластьДаДа
ADDRESS_COUNTRY СтранаДаДа
ADDRESS_COUNTRY_CODE Код страныДаДа
OPENED Флаг "Доступен для всех" Да Да
COMMENTS Комментарии Да Да
EXPORT Флаг разрешения экспорта Да Да
ASSIGNED_BY_ID Идентификатор ответственного Да Да
CREATED_BY_ID Создан Да Нет
MODIFY_BY_ID Изменен Да Нет
DATE_CREATE Дата создания Да Нет
DATE_MODIFY Дата изменения Да Нет
COMPANY_ID Идентификатор компании Да Да
LEAD_ID Идентификатор лида Да Нет
PHONE PHONE Да Да
EMAIL e-mail Да Да
WEB веб-сайт Да Да
IM Контакт в службе обмена мгновенными сообщениями Да Да
ORIGINATOR_ID Идентификатор внешней информационной базы. Назначение поля может меняться конечным разработчиком. Да Да
ORIGIN_ID Внешний ключ, используется для операций обмена. Идентификатор объекта внешней информационной базы. Назначение поля может меняться конечным разработчиком. Да Да


Пользовательские комментарии

Пользовательские комментарии не являются официальной документацией. Ответственность за их использование несет сам пользователь.

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

Добавлять комментарии могут только зарегистрированные пользователи. Сообщения для просмотра появляются после модерации.
© «Битрикс», 2001-2017, «1C-Битрикс», 2017