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

crm.deal.fields

Scope: crm Права на выполнение: для всех

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

crm.deal.fields()

Возвращает описание полей сделки, в том числе пользовательских.

Параметры

Без параметров.

Пример

BX24.callMethod(
	"crm.deal.fields",
	{},
	function(result)
	{
		if(result.error())
			console.error(result.error());
		else
			console.dir(result.data());
	}
);

Поля

Поле ОписаниеТипПримечание
ADDITIONAL_INFO Дополнительная информацияstring
ASSIGNED_BY_ID Связано с пользователем по IDuser
BANK_DETAIL_ID ID банковского реквизитаintegerПринимается, но не возвращается.
Параметр подаётся на функцию crm.requisite.link.register автоматически при успешном добавлении/обновлении сделки с идентификатором этой сделки
BEGINDATE Дата началаdate
CATEGORY_ID Идентификатор направленияcrm_categoryНеизменяемое. Если не передавать это поле при создании сделки, то сделка создастся в общем направлении.
CLOSED Завершенаchar
CLOSEDATE Дата завершенияdate
COMMENTS Коментарииstring
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.
CREATED_BY_ID Создано пользователемuserТолько для чтения
CURRENCY_ID Идентификатор валюты сделкиcrm_currency
DATE_CREATE Дата созданияdatetimeТолько для чтения
DATE_MODIFY Дата измененияdatetimeТолько для чтения
ID Идентификатор сделкиintegerТолько для чтения
IS_NEW Флаг новой сделки (т. е. сделка в первой стадии)char
IS_RECURRINGФлаг шаблона регулярной сделки (если стоит Y, то это не сделка, а шаблон)char
IS_RETURN_CUSTOMERПризнак повторного лидаchar
LEAD_ID Идентификатор привязанного лидаcrm_leadТолько для чтения
LOCATION_ID Местоположение клиентаlocationСлужебный, не рекомендуется к использованию.
MODIFY_BY_ID Идентификатор автора последнего измененияuserТолько для чтения
MOVED_BY_ID Идентификатор автора перемещения элемента на текущую стадиюuserТолько для чтения
MOVED_TIME Дата перемещения элемента на текущую стадиюdatetimeТолько для чтения
OPENED Доступен для всехchar
OPPORTUNITY Суммаdouble
ORIGINATOR_ID Идентификатор источника данныхstringИспользуется только для привязки к внешнему источнику.
ORIGIN_ID Идентификатор элемента в источнике данныхstringИспользуется только для привязки к внешнему источнику.
PROBABILITY Вероятностьinteger
QUOTE_ID Идентификатор квотыcrm_quoteТолько для чтения. Устаревший, использовать метод crm.quote.list с фильром по сделке
REQUISITE_ID Идентификатор реквизитаПринимается, но не возвращается.
Параметр подаётся на функцию crm.requisite.link.register автоматически при успешном добавлении/обновлении сделки с идентификатором этой сделки.
STAGE_ID Идентификатор стадииcrm_status
NEW   // новая сделка
PREPARATION   // подготовка бумаг
PREPAYMENT_INVOICE  // отправка счёта
EXECUTING   // в процессе выполнения
FINAL_INVOICE  // финальный счёт	
(P - значение у STAGE_SEMANTIC_ID)
WON   // выиграна
(S - значение у STAGE_SEMANTIC_ID)
>LOSE  // проиграна, анализ причин не требуется
APOLOGY  // проиграна, требуется анализ причин	
(F - значение у STAGE_SEMANTIC_ID)
STAGE_SEMANTIC_ID ИмяstringТолько для чтения, которое в некотором смысле обобщает значения идентификатора сделки STAGE_ID. (Значения смотри выше.)
SOURCE_ID Идентификатор источника. Определяет источник сделки (обратный звонок, реклама, электронная почта итд). stringСписок возможных идентификаторов можно вытащить рест методом crm.status.list с фильтром filter[ENTITY_ID]=SOURCE
SOURCE_DESCRIPTION Дополнительно об источнике.stringТекстовое поле
TAX_VALUE Ставка налогаdouble
TITLE НазваниеstringОбязательное.
TYPE_ID Тип сделкиcrm_statusИспользуется только для привязки к внешнему источнику.
UTM_CAMPAIGN Обозначение рекламной кампанииstring
UTM_CONTENT Содержание кампанииstringНапример, для контекстных объявлений.
UTM_MEDIUM Тип трафикаstringCPC (объявления), CPM (баннеры)
UTM_SOURCE Рекламная системаstringYandex-Direct, Google-Adwords и другие.
UTM_TERM Условие поиска кампанииstringНапример, ключевые слова контекстной рекламы.


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

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

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

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

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
0
Евгений Кулик
Сообщение не промодерировано, возможны ошибки и неточности.
Все поля сделок:
Код
ID: ID (integer)DATE_CREATE: Когда создана (datetime)
DATE_CREATE_SHORT: Дата создания (expression)
DATE_MODIFY: Когда обновлена (datetime)
DATE_MODIFY_SHORT: CRM_DEAL_ENTITY_DATE_MODIFY_SHORT_FIELD (expression)
CREATED_BY_ID: Кем создана (integer)
CREATED_BY: Создал (reference)
MODIFY_BY_ID: Кем обновлена (integer)
MODIFY_BY: Изменил (reference)
ASSIGNED_BY_ID: Ответственный (integer)
ASSIGNED_BY: Ответственный (reference)
OPENED: Доступно для всех (boolean)
LEAD_ID: Лид (integer)
LEAD_BY: Лид (reference)
COMPANY_ID: Компания (integer)
COMPANY_BY: Компания (reference)
COMPANY: Компания (reference)
CONTACT_ID: Контакт (integer)
CONTACT_BY: Контакт (reference)
CONTACT: Контакт (reference)
BINDING_CONTACT: BINDING_CONTACT (reference)
CONTACT_BINDINGS: CONTACT_BINDINGS (OneToMany)
QUOTE_ID: Предложение (integer)
TITLE: Название (string)
PRODUCT_ID: PRODUCT_ID (string)
CATEGORY_ID: Воронка (integer)
STAGE_ID: Стадия (string)
STAGE_BY: Стадия сделки (reference)
STAGE_SEMANTIC_ID: Группа стадии (string)
IS_NEW: Новая сделка (boolean)
IS_RECURRING: Регулярная сделка (boolean)
CRM_DEAL_RECURRING: CRM_DEAL_RECURRING (reference)
IS_RETURN_CUSTOMER: Повторная сделка (boolean)
IS_REPEATED_APPROACH: Повторное обращение (boolean)
CLOSED: Сделка закрыта (boolean)
TYPE_ID: Тип сделки (string)
TYPE_BY: Тип сделки (reference)
OPPORTUNITY: Сумма (float)
IS_MANUAL_OPPORTUNITY: Режим расчёта суммы (boolean)
TAX_VALUE: Сумма налога (float)
CURRENCY_ID: Валюта (string)
OPPORTUNITY_ACCOUNT: Сумма в валюте учёта (float)
TAX_VALUE_ACCOUNT: Сумма налога в валюте учёта (float)
ACCOUNT_CURRENCY_ID: Валюта учёта (string)
PROBABILITY: Вероятность,% (integer)
COMMENTS: Комментарий (text)
BEGINDATE: Дата начала (date)
BEGINDATE_SHORT: Дата начала (expression)
CLOSEDATE: Дата завершения (date)
CLOSEDATE_SHORT: Предполагаемая дата закрытия (expression)
EVENT_DATE: Дата события (datetime)
EVENT_DATE_SHORT: Дата события (expression)
EVENT_ID: Тип события (string)
EVENT_BY: Тип события (reference)
EVENT_RELATION: События (reference)
EVENT_DESCRIPTION: Описание события (text)
EXCH_RATE: EXCH_RATE (float)
LOCATION_ID: Местоположение (string)
WEBFORM_ID: Создано CRM-формой (integer)
SOURCE_ID: Источник (string)
SOURCE_BY: Источник (reference)
SOURCE_DESCRIPTION: Дополнительно об источнике (text)
ORIGINATOR_ID: Внешний источник (string)
ORIGINATOR_BY: Привязка (reference)
ORIGIN_ID: Идентификатор элемента во внешнем источнике (string)
ADDITIONAL_INFO: Дополнительная информация (text)
SEARCH_CONTENT: SEARCH_CONTENT (text)
ORDER_STAGE: Статус оплаты сделки (string)
MOVED_BY_ID: Кем передвинута (integer)
MOVED_TIME: Когда передвинут (datetime)
LAST_ACTIVITY_BY: Кем осуществлена последняя активность в таймлайне (integer)
LAST_ACTIVITY_TIME: Последняя активность (datetime)
IS_WORK: В работе (expression)
IS_WON: Удачно (expression)
IS_LOSE: Не удачно (expression)
RECEIVED_AMOUNT: Полученная сумма (expression)
LOST_AMOUNT: Утраченная сумма (expression)
HAS_PRODUCTS: Содержит товары (expression)
PRODUCT_ROW: PRODUCT_ROW (reference)
HISTORY: HISTORY (reference)
FULL_HISTORY: FULL_HISTORY (reference)
ORDER_BINDING: ORDER_BINDING (reference)
PRODUCT_ROWS: Товары (OneToMany)
OBSERVER_IDS: Наблюдатели (OneToMany)
UTM_SOURCE: UTM Source (reference)
UTM_MEDIUM: UTM Medium (reference)
UTM_CAMPAIGN: UTM Campaign (reference)
UTM_CONTENT: UTM Content (reference)
UTM_TERM: UTM Term (reference)
0
Богдан Остапчук
Сообщение не промодерировано, возможны ошибки и неточности.
Цитата
пишет:
А поле "Наблюдатели" оно есть, но его нет в документации, я верно понимаю?
Хороший вопрос, но проигнорирован)) тоже не нашел наблюдателя
0
Александр Шелков
Сообщение не промодерировано, возможны ошибки и неточности.
А поле "Наблюдатели" оно есть, но его нет в документации, я верно понимаю?
© «Битрикс», 2001-2024, «1С-Битрикс», 2024
Наверх