crm.deal.fields

Scope: crm Permissions: for all

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

Field	Description	Type	Note
ADDITIONAL_INFO	Additional information	string
ASSIGNED_BY_ID	Associated with a user by ID	user
BANK_DETAIL_ID	Bank detail ID	integer	Accepted, 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 date	date
CATEGORY_ID	Direction ID	crm_category	Unmodifiable. When this field is not passed when creating a deal, the deal is created in the general pipeline.
CLOSED	Closed	char
CLOSEDATE	Closure Date	date
COMMENTS	Comments	string
COMPANY_ID	Assigned company ID	crm_company
CONTACT_ID	Assigned contact ID	crm_contact	Outdated. Saved for compatibility
CONTACT_IDS	Associated contact ID	crm_contact	Multiple. 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.. To clear the field, use crm.deal.contact.items.delete. For replacement, use crm.deal.contact.items.set.
CREATED_BY_ID	Created by user	user	Read only
CURRENCY_ID	Deal currency ID	crm_currency
DATA_CREATE	Creation date	datetime	Read only
DATA_MODIFY	Modification date	datetime	Read only
ID	Deal ID	integer	Read only
IS_NEW	New deal flag (i. e. deal is in the first stage)	char
IS_RECURRING	Flag of recurring deal template (if set to Y, its not a deal, but a template)	char
IS_RETURN_CUSTOMER	Repeat lead attribute	char
LEAD_ID	Associated lead ID	crm_lead	Read only
LOCATION_ID	Client location	location	Service parameter. Not recommended for use.
MODIFY_BY_ID	Author ID for the recent modification	user	Read only
MOVED_BY_ID	Author ID for moved item to the current stage	user	Read only
MOVED_TIME	Date when item was moved to current stage	datetime	Read only
OPENED	Accessible for all	char
OPPORTUNITY	Sum	double
ORIGINATOR_ID	Data source ID	string	Used only to link to an external source.
ORIGIN_ID	Data source Element ID	string	Used only to link to an external source.
PROBABILITY	Probability	integer
QUOTE_ID	Estimate ID	crm_quote	Read only. Deprecated, use the method crm.quote.list with filter for deal.
REQUISITE_ID	Requisite ID		Accepted, 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 ID	crm_status	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)
STAGE_SEMANTIC_ID	Name	string	Read 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.).	string	List of possible IDs can be retrieved by the REST method crm.status.list with filter `filter[ENTITY_ID]=SOURCE`
SOURCE_DESCRIPTION	Additional information for a deal.	string	Text field
STAGE_SEMANTIC_ID	Name	string
TAX_VALUE	Tax rate	double
TITLE	Name	string	Required.
TYPE_ID	Deal type	crm_status	Used only to link to an external source.
UTM_CAMPAIGN	Advertisement campaign designation	string
UTM_CONTENT	Campaign content	string	For example, for context announcements.
UTM_MEDIUM	Traffic type	string	CPC (announcements), CPM (banners)
UTM_SOURSE	Advertisement system	string	Yandex-Direct, Google-Adwords and others.
UTM_TERM	Company search condition	string	For example, contextual advertising keywords.