Documentation

crm.deal.fields

crm.deal.fields()

Returns the description of the deal fields, including user fields.

Parameters

This method has no parameters.

Example

<script type="text/javascript">
	BX24.callMethod(
			"crm.deal.fields", 
			{}, 
			function(result) 
			{
				if(result.error())
					console.error(result.error());
				else
					console.dir(result.data());
			}
		);	
</script>

Fields

direction ID
Field DescriptionTypeNote
ADDITIONAL_INFO Additional informationstring
ASSIGNED_BY_ID Attached to user by IDuser
BEGINDATE Start datedate
CATEGORY_ID crm_categoryUnmodifiable
CLOSED Closedchar
CLOSEDATE Closure Datedate
COMMENTS Commentsstring
COMPANY_ID Attached company IDcrm_company
CONTACT_ID Attached contact ID crm_contact Outdated. Saved for compatibility
CONTACT_IDS Attached contact ID crm_contactMultiple.
CREATED_BY_ID Created by useruserRead only
CURRENCY_ID Deal currency IDcrm_currency
DATA_CREATE Creation datedatetimeRead only
DATA_MODIFY Modification datedatetimeRead only
ID Deal IDintegerRead only
IS_NEW New deal flag (i. e. deal is in the first stage)char
LEAD_ID Attached lead IDcrm_leadRead only
LOCATION Client locationlocation
MODIFY_BY_ID Last modification author IDuserRead only
OPENED Accessible for allchar
OPPORTUNITY Sumdouble
ORIGINATOR_ID Data source IDstringUsed only for attachment to external source.
ORIGIN_ID Data source Element IDstringUsed only for attachment to external source.
PROBABILITY Probabilityinteger
QUOTE_ID Quote IDcrm_quoteRead only
STAGE_ID Stage IDcrm_status
STAGE_SEMANTIC_ID Namestring
TAX_VALUE Tax ratedouble
TITLE NamestringRequired.
TYPE_ID Deal typecrm_statusUsed only for attachment to external source.
UTM_CAMPAIGN Ad campaign designationstring
UTM_CONTENT Campaign contentstringFor example, for context announcements.
UTM_MEDIUM Traffic typestringCPC (announcements), CPM (banners)
UTM_SOURSE Advertisement systemstringYandex-Direct, Google-Adwords and others.
UTM_TERM Company search conditionstringFor example, contextual advertising keywords.


User Comments

User comments are not part of official documentation. Use information provided by other users in the comments at your own risk.

The User Comments section is not to be used as a feature discussion board. Only registered users can post comments. Your comment will be visible once it has been approved by the moderator.
© «Bitrix Inc.», 2001-2017, «Bitrix Inc.», 2017