crm.contact.fields

Scope: catalog Permissions to execute: for all

crm.contact.fields()

Returns the description of contact, as well as user fields available to contact.

Parameters

No parameters.

Example

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

Fields

The methods crm.contact.update and crm.contact.add are used to pass an array of companies. The methods crm.contact.list and crm.contact.get do not have this field and the method crm.contact.company.items.get must be used to get list of companies.All fields from crm_status must contain values from selection list. Values can fetched by calling crm.status.list. ce

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
BIRTHDATE	Date of birth	date
COMMENTS	Comments	string
COMPANY_ID	Associating a contact to a company	crm_company	Outdated. Saved for compatibility.
COMPANY_IDS	Associating a contact to several companies	crm_company	Multiple
CREATED_DY_ID	Who created	user	Read only
DATA_CREATE	Creation date	datetime	Read only
DATA_MODIFY	Date modified	datetime	Read only
EMAIL	E-mail address	crm_multifield	Multiple
EXPORT	Specifies if the contact is included into export. If N, then it is not possible to upload it.	char	Protection from employees, who want to steal client database.
FACE_ID	Linking to persons from faceid module	integer
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	All fields for crm_status must contain values from selection lists. These values can be fetched by calling crm.status.list.
ID	Contact ID	integer	Read only
IM	Messengers	crm_multifield	Multiple
LAST_NAME	Last name	string	Required
LEAD_ID	Lead ID, associated with the contact	crm_lead	Read only
MODIFY_BY_ID	Last modification author ID	user	Read only
NAME	Name	string	Required
OPENED	Accessible for all	char
ORIGINATOR_ID	Data source ID	string	Used only to link to external source.
ORIGIN_ID	Element ID in the data source	string	Used only to link to 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
PHOTO	Contact photo	file
POST	Position	string
SECOND_NAME	Middle name	string	Required
SOURCE_DISCRIPTION	Source description	string
SOURCE_ID	Source identifier	crm_status	Status from directory. List of possible identifiers can be fetched via the method crm.status.list with filter filter[ENTITY_ID]=SOURCE	TYPE_ID	ID type	crm_status	Status from directory
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_SOURSE	Advertisement system	string	Yandex-Direct, Google-Adwords and others.
UTM_TERM	Campaign search condition	string	For example, contextual advertising keywords.
WEB	URL for contact resources	crm_multifield	Multiple