crm.lead.fields

Scope: catalog Permissions: all

crm.lead.fields()

Returns the lead fields description, including user fields.

Parameters

No parameters.

Example

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

Fields

Field	Description	Type	Note
ADDRESS	Contact address	string
ADDRESS_2	Second page of the address	string	In some countries it is customary to split an address into 2 parts
ADDRESS_CITY	City	string
ADDRESS_COUNTRY	Country	string
ADDRESS_COUNTRY_CODE	Country code	string
ADDRESS_POSTAL_CODE	Postal code	string
ADDRESS_PROVINCE	Province	string
ADDRESS_REGION	Region	string
ASSIGNED_BY_ID	Associated with user by ID	user
BIRTHDAY	Date of birth	date
COMMENTS	Comments	string
COMPANY_ID	Linking a contact to a company	crm_company	Read only
COMPANY_TITLE	Name of company, associated with a lead	crm_company
CONTACT_ID	Linking a lead to a contact	crm_contact	Read only
CONTACT_IDS	Linked contact ID	crm_contact	Multiple. You can pass array with contacts when using crm.deal.update and crm.deal.add. This field is unavailable in methods crm.deal.list and crm.deal.get and you need to use crm.deal.contact.items.get for getting list of contacts. To clear the field, use crm.deal.contact.items.delete, to replace the value, use crm.deal.contact.items.set.
CREATED_BY_ID	Who created	user	Read only
CURRENCY_ID	Currency ID	crm_currency
DATE_CLOSED	Date closed	datetime	Read only
DATA_CREATE	Creation date	datetime	Read only
DATA_MODIFY	Date modified	datetime	Read only
EMAIL	E-mail address	crm_multifield	Multiple
HAS_MAIL	E-mail field fill-up check	char	Read only
HAS_PHONE	Telephone field fill-up check	char	Read only
HONORIFIC	Request type	crm_status
ID	Contact ID	integer	Read only
IM	Messengers	crm_multifield	Multiple
IS_RETURN_CASTOMER	Repeat lead attribute	char	Read only
LAST_NAME	Last name	string	Can be set as required.
MODIFY_BY_ID	Last modification author ID	user	Read only
MOVED_BY_ID	Identifier for moving item to the current stage	user	Read only
MOVED_TIME	Date when item was moved to current stage	user	Read only
NAME	Name	string	Required
OPENED	Accessible for all	char
OPPORTUNITY	Estimated amount	double
ORIGINATOR_ID	Data source ID	string	Used only to link to to an external source.
ORIGIN_ID	Element ID in the data source	string	Used only to link to to an external source.
ORIGIN_VERSION	Original version	string	Used only for protection from random deletion by an external system. If the data is imported and was not modified in the external system, then such data can be safely edited in CRM and that the next download will not overwrite the data.
PHONE	Contact telephone	crm_multifield	Multiple
POST	Position	string
SECOND_NAME	Second name	string	Required
SOURCE_DESCRIPTION	Source description?	string
SOURCE_ID	Source ID	crm_status	Status from directory. List of possible IDs can be fetched via the method crm.status.list with filter фильтром `filter[ENTITY_ID]=SOURCE`
STATUS_DESCRIPTION		string
STATUS_ID		string	NEW -Not processed, IN_PROCESS – In progress PROCESSED – Processed JUNK – Junk lead CONVERTED – Good lead
STATUS_SEMANTIC_ID		string	F (failed) – processed unsuccessfully, S (success) – processed successfully, P (processing) – processing in progress.
TITLE	Lead name	string	Required
UTM_CAMPAIGN	Advertisement campaign designation	string
UTM_CONTENT	Campaign content	string	For example, for context announcements.
UTM_MEDIUM	Type of traffic	string	CPC (announcements), CPM (banners)
UTM_SOURCE	Advertisement system	string	Google-Adwords and others.
UTM_TERM	Campaign search condition	string	For example, contextual advertising keywords.
WEB	URL for contact resources	crm_multifield	Multiple