Documentation

crm.deal.fields

Description and example

crm.deal.fields()

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

Parameters

No parameters.

Example

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

Fields

direction ID
NEW   // new deal
PREPARATION   // document preparation
PREPAYMENT_INVOICE  // sending invoice
EXECUTING   // in progress
FINAL_INVOICE  // final invoice	
(P - value for STAGE_SEMANTIC_ID)
WON   // won
(S - value for STAGE_SEMANTIC_ID)
>LOSE  // lost, failure analysis is not required
APOLOGY  // lost, failure analysis is required	
(F - value for STAGE_SEMANTIC_ID)
Field DescriptionTypeNote
ADDITIONAL_INFO Additional informationstring
ASSIGNED_BY_ID Associated with a user by IDuser
BANK_DETAIL_ID Bank detail IDintegerAccepted, but not returned.
The parameter is passed to the function crm.requisite.link.register automatically on successful adding/updating of a deal with this deal ID.
BEGINDATE Start datedate
CATEGORY_ID crm_categoryUnmodifiable. When this field is not passed when creating a deal, the deal is created in the general pipeline.
CLOSED Closedchar
CLOSEDATE Closure Datedate
COMMENTS Commentsstring
COMPANY_ID Assigned company IDcrm_company
CONTACT_ID Assigned contact IDcrm_contact Outdated. Saved for compatibility
CONTACT_IDS Associated contact IDcrm_contactMultiple.
When using crm.deal.update and crm.deal.add an array of companies can be passed. The methods crm.deal.list and crm.deal.get do not have the this field and crm.deal.contact.items.get must be used to get list of contacts.
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
IS_RECURRINGFlag of recurring deal template (if set to Y, its not a deal, but a template)char
IS_RETURN_CUSTOMERRepeat lead attributechar
LEAD_ID Associated lead IDcrm_leadRead only
LOCATION_ID Client locationlocationService parameter. Not recommended for use.
MODIFY_BY_ID Last modification author IDuserRead only
MOVED_TIME Date when item was moved to current stageuserRead only
OPENED Accessible for allchar
OPPORTUNITY Sumdouble
ORIGINATOR_ID Data source IDstringUsed only to link to an external source.
ORIGIN_ID Data source Element IDstringUsed only to link to an external source.
PROBABILITY Probabilityinteger
QUOTE_ID Quote IDcrm_quoteRead only. Deprecated, use the method crm.quote.list with filter for deal.
REQUISITE_ID Requisite IDAccepted, but not returned.
The parameter is passed to the function crm.requisite.link.register automatically on successful adding/updating of a deal with this deal ID.
STAGE_ID Stage IDcrm_status
STAGE_SEMANTIC_ID NamestringRead only. Summarizes ID values for deal STAGE_ID. (See the values above.)
SOURCE_ID Source identifier. Defines the deal source (callback, ads, email and etc.). stringList of possible IDs can be retrieved by the REST method crm.status.list with filter filter[ENTITY_ID]=SOURCE
STAGE_SEMANTIC_ID Namestring
TAX_VALUE Tax ratedouble
TITLE NamestringRequired.
TYPE_ID Deal typecrm_statusUsed only to link to an external source.
UTM_CAMPAIGN Advertisement 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.

© «Bitrix24», 2001-2022
Up