Документация для разработчиков
Документация для разработчиков Документация по D7 Документация по REST Пользовательская документация
Темная тема
Доступна новая документация по REST: понятнее описания, больше примеров, удобнее поиск
Перейти

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

Описание и пример

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

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

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

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

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

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



Сделки

ПолеОписаниеЧтение Запись
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 Внешний ключ, используется для операций обмена. Идентификатор объекта внешней информационной базы. Назначение поля может меняться конечным разработчиком. Да Да

Реквизиты

Название Описание Чтение Запись
Общие реквизиты
ID Идентификатор реквизита. Создается автоматически и уникален в рамках БД. ДаНет
ENTITY_TYPE_ID Идентификаторы типов сущностей возвращает метод crm.enum.ownertype Тип родительской сущности. Возможные типы: "Компания", "Контакт". Обязательное поле. ДаДа
ENTITY_ID Идентификатор родительской сущности. Обязательное поле. ДаДа
PRESET_ID Идентификатор шаблона реквизитов. Обязательное поле. ДаДа
DATE_CREATE Дата создания. ДаНет
DATE_MODIFY Дата изменения. ДаНет
CREATED_BY_ID Идентификатор создавшего реквизит. ДаНет
MODIFY_BY_ID Идентификатор изменившего реквизит. ДаНет
NAME Название реквизита. ДаДа
CODE Символьный код реквизита. ДаДа
XML_ID Внешний ключ, используется для операций обмена. Идентификатор объекта внешней информационной базы. Назначение поля может меняться конечным разработчиком. ДаДа
ACTIVE Признак активности. ДаДа
SORT Сортировка. ДаДа
RQ_NAME Ф.И.О. ДаДа
RQ_FIRST_NAME Имя. ДаДа
RQ_LAST_NAME Фамилия. ДаДа
RQ_COMPANY_NAME Сокращенное наименование организации. ДаДа
RQ_COMPANY_FULL_NAME Полное наименование организации. ДаДа
RQ_COMPANY_REG_DATE Дата государственной регистрации. ДаДа
RQ_DIRECTOR Ген. директор. ДаДа
RQ_ACCOUNTANT Гл. бухгалтер. ДаДа
RQ_CEO_NAME ФИО первого руководителя. ДаДа
RQ_CEO_WORK_POS Должность первого руководителя. ДаДа
RQ_CONTACT Контактное лицо. ДаДа
RQ_EMAIL E-Mail. ДаДа
RQ_PHONE Телефон. ДаДа
RQ_FAX Факс. ДаДа
RQ_IDENT_DOC Вид документа. ДаДа
RQ_IDENT_DOC_SER Серия. ДаДа
RQ_IDENT_DOC_NUM Номер. ДаДа
RQ_IDENT_DOC_DATE Дата выдачи. ДаДа
RQ_IDENT_DOC_ISSUED_BY Кем выдан. ДаДа
RQ_IDENT_DOC_DEP_CODE Код подразделения. ДаДа
RQ_INN ИНН. ДаДа
RQ_KPP КПП. ДаДа
RQ_USRLE Handelsregisternummer (для страны DE). ДаДа
RQ_IFNS ИФНС. ДаДа
RQ_OGRN ОГРН. ДаДа
RQ_OGRNIP ОГРНИП. ДаДа
RQ_OKPO ОКПО. ДаДа
RQ_OKTMO ОКТМО. ДаДа
RQ_OKVED ОКВЭД. ДаДа
RQ_EDRPOU ЄДРПОУ. ДаДа
RQ_DRFO ДРФО. ДаДа
RQ_KBE КБЕ. ДаДа
RQ_IIN ИИН. ДаДа
RQ_BIN БИН. ДаДа
RQ_VAT_PAYER Платник ПДВ (для страны UA). ДаДа
RQ_VAT_ID VAT ID (идентификационный номер (плательщика) НДС). ДаДа
RQ_VAT_CERT_SER Серия свидетельства по НДС. ДаДа
RQ_VAT_CERT_NUM Номер свидетельства по НДС. ДаДа
RQ_VAT_CERT_DATE Дата свидетельства по НДС. ДаДа
RQ_RESIDENCE_COUNTRY Страна резидента. ДаДа
ORIGINATOR_ID Идентификатор внешней информационной базы. Назначение поля может меняться конечным разработчиком. ДаДа
Банковские реквизиты
ID Идентификатор реквизита. Создается автоматически и уникален в рамках БД. ДаНет
ENTITY_TYPE_ID Идентификаторы типов сущностей возвращает метод crm.enum.ownertype Тип родительской сущности. По умолчанию тип: "Реквизит". Обязательное поле. ДаДа
ENTITY_ID Идентификатор родительской сущности. Обязательное поле. ДаДа
COUNTRY_ID Идентификатор страны. ДаДа
DATE_CREATE Дата создания. ДаНет
DATE_MODIFY Дата изменения. ДаНет
CREATED_BY_ID Идентификатор создавшего реквизит. ДаНет
MODIFY_BY_ID Идентификатор изменившего реквизит. ДаНет
NAME Название реквизита. ДаДа
CODE Символьный код реквизита. ДаДа
XML_ID Внешний ключ, используется для операций обмена. Идентификатор объекта внешней информационной базы. Назначение поля может меняться конечным разработчиком. ДаДа
ACTIVE Признак активности. ДаДа
SORT Сортировка. ДаДа
RQ_BANK_NAME Наименование банка. ДаДа
RQ_BANK_ADDR Адрес банка. ДаДа
RQ_BANK_ROUTE_NUM Bank Routing Number. ДаДа
RQ_BIK БИК. ДаДа
RQ_MFO МФО. ДаДа
RQ_ACC_NAME Bank Account Holder Name. ДаДа
RQ_ACC_NUM Bank Account Number. ДаДа
RQ_IIK ИИК. ДаДа
RQ_ACC_CURRENCY Валюта счёта. ДаДа
RQ_COR_ACC_NUM Кор. счёт. ДаДа
RQ_IBAN IBAN. ДаДа
RQ_SWIFT SWIFT. ДаДа
RQ_BIC BIC. ДаДа
COMMENTS Комментарий. ДаДа
ORIGINATOR_ID Идентификатор внешней информационной базы. Назначение поля может меняться конечным разработчиком. ДаДа
Шаблоны реквизитов
ID Идентификатор реквизита. Создается автоматически и уникален в рамках БД. ДаНет
ENTITY_TYPE_ID Идентификаторы типов сущностей возвращает метод crm.enum.ownertype Тип родительской сущности. Обязательное поле. ДаДа
COUNTRY_ID Страна, которой соответствует набор полей шаблона реквизита. ДаДа
DATE_CREATE Дата создания. ДаНет
DATE_MODIFY Дата изменения. ДаНет
CREATED_BY_ID Идентификатор создавшего реквизит. ДаНет
MODIFY_BY_ID Идентификатор изменившего реквизит. ДаНет
NAME Название реквизита. ДаДа
XML_ID Внешний ключ, используется для операций обмена. Идентификатор объекта внешней информационной базы. Назначение поля может меняться конечным разработчиком. ДаДа
ACTIVE Признак активности. ДаДа
SORT Сортировка. ДаДа
Поля шаблонов реквизитов
ID Идентификатор реквизита. Создается автоматически и уникален в рамках реквизита. ДаНет
FIELD_NAME Название поля. ДаДа
FIELD_TITLE Альтернативное название поля для реквизита. ДаДа
SORT Сортировка. ДаДа
IN_SHORT_LIST Показывать в кратком списке. ДаДа
Адреса реквизитов
TYPE_ID Идентификатор типа адреса. Обязательное поле. Элемент перечисления "Тип адреса". ДаДа
ENTITY_TYPE_ID Идентификаторы типов сущностей возвращает метод crm.enum.ownertype Тип родительской сущности. Возможные типы: "Реквизит", "Компания", "Контакт", "Лид". Обязательное поле. ДаДа
ENTITY_ID Идентификатор родительской сущности. Обязательное поле. ДаДа
ADDRESS_1 Улица, дом, корпус, строение. ДаДа
ADDRESS_2 Квартира / офис. ДаДа
CITY Город. ДаДа
POSTAL_CODE Почтовый индекс. ДаДа
REGION Район. ДаДа
PROVINCE Область. ДаДа
COUNTRY Страна. ДаДа
COUNTRY_CODE Код страны. ДаДа

Дела

Поле ОписаниеТипПримечание
ASSOCIATED_ENTITY_ID Идентификатор связанной с делом сущностиintegerТолько для чтения
AUTOR_ID Создатель делаuser
AUTOCOMPLETE_RULE Автозаполнениеinteger
BINDINGS Привязкиcrm_activity_bindingМножественное, только для чтения.
COMMUNICATIONS crm_activity_communicationМножественное, обязательное.
COMPLETED Завершеноchar
CREATED Созданоdatetime
DEADLINE Срок исполненияdatetimeПоле напрямую не устанавливается, значение берётся из START_TIME для звонка и встречи и из END_TIME для задачи.
DESCRIPTION Описаниеstring
DESCRIPTION_TYPE Тип описанияcrm.enum.contenttype
DIRECTION Направление дела: входящее/исходящее. crm.enum.activitydirectionАктуально для звонков и писем, для встреч не используется.
EDITOR_ID Кто изменилuserТолько для чтения
END_TIME Время завершенияdatetime
FILES Добавленные файлыdiskfileМножественное
ID Идентификатор делаintegerТолько для чтения
LAST_UPDATE Дата последнего обновления datetimeТолько для чтения
LOCATION Местоположение.string
NOTIFY_TYPE Тип уведомленийcrm.enum.activitynotifytype
NOTIFY_VALUE integerТолько для чтения
ORIGINATOR_ID Идентификатор источника данныхstringИспользуется только для привязки к внешнему источнику.
ORIGIN_ID Идентификатор элемента в источнике данныхstringИспользуется только для привязки к внешнему источнику.
ORIGIN_VERSION Оригинальная версияstringИспользуется для защиты данных от случайного перетирания внешней системой. Если данные были импортированы и не изменялись во внешней системе, то такие данные могут быть редактированы в CRM без опасения, что следующая выгрузка приведет к перетиранию данных
OWNER_ID СобственникintegerНеизменяемое.
OWNER_TYPE_ID Тип собственникаcrm.enum.ownertypeНеизменяемое.
PRIORITY Приоритетcrm.enum.activitypriority
PROVIDER_DATA string
PROVIDER_GROUP_ID string
PROVIDER_ID Идентификатор провайдераstring
PROVIDER_TYPE_ID Идентификатор типа провайдераstringСтатус из справочника
PROVIDER_PARAMS object
RESPONSIBLE_ID ОтветстветнныйuserОбязательное.
RESULT_CURRENCY_ID string
RESULT_MARK integer
RESULT_SOURSE_ID string
RESULT_STATUS integer
RESULT_STREAM Статистика отчётовinteger
RESULT_SUM double
RESULT_VALUE double
SETTINGS Настройкиobject
START_TIME Время начала выполненияdatetime
STATUS Статусcrm_enum_activitystatus
SUBJECT СубьектstringОбязательное
TYPE_ID Типcrm_enum_activitytypeОбязательный, неизменяемый
WEBDAV_ELEMENTS Добавленные файлыdiskfileМножественное. Устарел, сохраняется для совместимости.


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

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

Для этого нужно всего лишь авторизоваться на сайте

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

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2024, «1С-Битрикс», 2024