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

crm.deal.fields

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 для получения списка контактов.
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Только для чтения
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
STAGE_SEMANTIC_ID Имя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Например, ключевые слова контекстной рекламы.


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

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

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

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

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