Описание и пример
Важно! Настоятельно рекомендуется при обновлении адреса передавать полный набор полей адреса в метод обновления. Частичное обновление поддерживается, но нежелательно из-за возможных конкурирующих запросов на обновление адреса другими приложениями.
Допустим, у компании был адрес "г. Калининград, ул. Фридриха Маркса, д. 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 | Множественное. Устарел, сохраняется для совместимости. |