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	Связано с пользователем по ID	user
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	Тип трафика	string	CPC (объявления), CPM (баннеры)
UTM_SOURCE	Рекламная система	string	Yandex-Direct, Google-Adwords и другие.
UTM_TERM	Условие поиска кампании	string	Например, ключевые слова контекстной рекламы.

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

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

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

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

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

0 Александр Шелков 24.01.2024 15:08:45 Сообщение не промодерировано, возможны ошибки и неточности.
А поле "Наблюдатели" оно есть, но его нет в документации, я верно понимаю?

Наверх