Table Structure

Important! When updating address, it is strongly recommended to pass a full set of address fields in the update method. Partial update is supported, but is undesirable due to possible competing requests for address update by other apps.

Example

A company has an address "Blueville st., New York, 4251".

Third-party app: reading the address as "Blueville st., New York, 4251".
Your app: reading address as "Blueville st., New York, 4251".

Third-party app: saving address as "Radmond st., Los Angeles, 352" (fixing the error - fully replacing address to another address).
Your app: saving portion of address as "Blueville st." (fixing the error - correcting street name, but in effect, creating new error).

As a result of two competing update requests, the company has the following address "Los Angeles, Blueville st., 352".
Finally, we can get an inconsistent address.

Attention! More detailed list of fields is provided in the method pages, returning description of entity fields. Such methods have the name crm.entity.name.fields.

Deals

Field	Description	Read	Write
ID	Deal ID. It is created automatically and is unique for the database.	Yes	No
TITLE	Deal name. A required field.	Yes	Yes
TYPE_ID	Deal type ID.	Yes	Yes
STAGE_ID	Deal stage ID	Yes	Yes
PROBABILITY	Deal conclusion probability (in %)	Yes	Yes
CURRENCY_ID	Deal currency	Yes	Yes
OPPORTUNITY	Amount in deal currency	Yes	Yes
COMPANY_ID	ID of a company that is a counterpart to the deal	Yes	Yes
CONTACT_ID	Contact person ID	Yes	Yes
BEGINDATE	Deal opening date	Yes	Yes
CLOSEDATE	Deal closing date	Yes	Yes
OPENED	Checkmark "Available to everyone"	Yes	Yes
CLOSED	Checkmark "The deal is closed"	Yes	Yes
COMMENTS	Comments	Yes	Yes
ASSIGNED_BY_ID	Deal responsible’s ID	Yes	Yes
CREATED_BY_ID	Deal creator’s ID	Yes	No
MODIFY_BY_ID	ID of a person who modified the deal	Yes	No
DATE_CREATE	Creation date	Yes	No
DATE_MODIFY	Modification date	Yes	No
LEAD_ID	Lead ID	Yes	No
ADDITIONAL_INFO	Additional information	Yes	Yes
ORIGINATOR_ID	ID of the external information database. The field assignment can be modified by the end developer.	Yes	Yes
ORIGIN_ID	External key used for exchange operations. ID of an object of the external information database. The field assignment can be modified by the end developer.	Yes	Yes
CATEGORY_ID	Deal progress ID.	Yes	Yes

Leads

Field	Description	Read	Write
ID	Lead ID	Yes	No
TITLE	Lead name. A required field.	Yes	Yes
NAME	Contact person’s name	Yes	Yes
SECOND_NAME	Contact person’s patronymic	Yes	Yes
LAST_NAME	Last name	Yes	Yes
COMPANY_TITLE	Company name	Yes	Yes
SOURCE_ID	Source ID	Yes	Yes
SOURCE_DESCRIPTION	Additional information about the source	Yes	Yes
STATUS_ID	Lead status ID	Yes	Yes
STATUS_DESCRIPTION	Additional information about the status	Yes	Yes
POST	Position	Yes	Yes
ADDRESS	Address	Yes	Yes
ADDRESS_2	Apartment, office	Yes	Yes
ADDRESS_CITY	City	Yes	Yes
ADDRESS_POSTAL_CODE	Postal code	Yes	Yes
ADDRESS_REGION	Region	Yes	Yes
ADDRESS_PROVINCE	Province	Yes	Yes
ADDRESS_COUNTRY	Country	Yes	Yes
ADDRESS_COUNTRY_CODE	Country code	Yes	Yes
CURRENCY_ID	Currency ID	Yes	Yes
OPPORTUNITY	Supposed amount	Yes	Yes
OPENED	Checkmark "Available for all"	Yes	Yes
COMMENTS	Comments	Yes	Yes
ASSIGNED_BY_ID	Responsible person	Yes	Yes
CREATED_BY_ID	Created by	Yes	No
MODIFY_BY_ID	Modified by	Yes	No
DATE_CREATE	Creation date	Yes	No
DATE_MODIFY	Modification date	Yes	No
COMPANY_ID	Company ID	Yes	No
CONTACT_ID	Contact person’s ID	Yes	No
DATE_CLOSED	Closing date	Yes	No
PHONE	Phone	Yes	Yes
EMAIL	E-mail	Yes	Yes
WEB	Website	Yes	Yes
IM	Contact person in the instant messaging service	Yes	Yes
ORIGINATOR_ID	External information base ID. Field assignment can be changed by the end developer.	Yes	Yes
ORIGIN_ID	External key that is used for exchange operations. ID of an object of the external information database. The field assignment can be modified by the end developer.	Yes	Yes

Companies

Field	Description	Read	Write
ID	Company ID. It is created automatically and is unique for the database.	Yes	No
TITLE	Company name. A required field.	Yes	Yes
COMPANY_TYPE	Company type. To be selected from the list.	Yes	Yes
LOGO	Company logo	Yes	Yes
ADDRESS	Physical address	Yes	Yes
ADDRESS	Street, House, Building (current address)	Yes	Yes
ADDRESS_2	Apartment / office (current address)	Yes	Yes
ADDRESS_CITY	City (current address)	Yes	Yes
ADDRESS_POSTAL_CODE	Postal Code (current address)	Yes	Yes
ADDRESS_REGION	Region (current address)	Yes	Yes
ADDRESS_PROVINCE	Province (current address)	Yes	Yes
ADDRESS_COUNTRY	Country (current address)	Yes	Yes
ADDRESS_COUNTRY_CODE	Country Code (current address)	Yes	Yes
REG_ADDRESS	Street, House, Building (legal address)	Yes	Yes
REG_ADDRESS_2	Apartment / office (legal address)	Yes	Yes
REG_ADDRESS_CITY	City (legal address)	Yes	Yes
REG_ADDRESS_POSTAL_CODE	Postal code (legal address)	Yes	Yes
REG_ADDRESS_REGION	Region (legal address)	Yes	Yes
REG_ADDRESS_PROVINCE	Province (legal address)	Yes	Yes
REG_ADDRESS_COUNTRY	Country (legal address)	Yes	Yes
REG_ADDRESS_COUNTRY_CODE	Country Code (legal address)	Yes	Yes
ADDRESS_LEGAL	Legal address	Yes	Yes
BANKING_DETAILS	Bank details	Yes	Yes
INDUSTRY	Area of activity. To be selected from the list.	Yes	Yes
EMPLOYEES	Number of employees. To be selected from the list.	Yes	Yes
CURRENCY_ID	Settlement currency	Yes	Yes
REVENUE	Annual turnover	Yes	Yes
OPENED	Check mark "Available for all"	Yes	Yes
COMMENTS	Comments	Yes	Yes
ASSIGNED_BY_ID	Responsible person’s ID	Yes	Yes
CREATED_BY_ID	Created by	Yes	No
MODIFY_BY_ID	Modified by	Yes	No
DATE_CREATE	Creation date	Yes	No
DATE_MODIFY	Modification date	Yes	No
LEAD_ID	Lead ID	Yes	No
ORIGINATOR_ID	ID of the external information database. The field assignment can be modified by the end developer.	Yes	Yes
ORIGIN_ID	External key that is used for exchange operations. ID of an object of the external information database. The field assignment can be modified by the end developer.	Yes	Yes
PHONE	Phone	Yes	Yes
EMAIL	E-mail	Yes	Yes
WEB	Website	Yes	Yes
IM	Contact person in the instant messaging service.	Yes	Yes

Contacts

Field	Description	Read	Write
ID	Contact ID. It is created automatically and is unique for the database.	Yes	No
NAME	Contact name. A require field.	Yes	Yes
SECOND_NAME	Contact person’s patronymic. A required field.	Yes	Yes
LAST_NAME	Contact person’s last name. A required field.	Yes	Yes
PHOTO	Contact person’s photo.	Yes	Yes
BIRTHDATE	Contact person’s date of birth	Yes	Yes
TYPE_ID	Type of contact	Yes	Yes
SOURCE_ID	Source	Yes	Yes
SOURCE_DESCRIPTION	Additional information about the source	Yes	Yes
POST	Position	Yes	Yes
ADDRESS	Address	Yes	Yes
ADDRESS_2	Apartment, office	Yes	Yes
ADDRESS_CITY	City	Yes	Yes
ADDRESS_POSTAL_CODE	Postal code	Yes	Yes
ADDRESS_REGION	Region	Yes	Yes
ADDRESS_PROVINCE	Province	Yes	Yes
ADDRESS_COUNTRY	Country	Yes	Yes
ADDRESS_COUNTRY_CODE	Country code	Yes	Yes
OPENED	Check mark "Available for all"	Yes	Yes
COMMENTS	Comments	Yes	Yes
EXPORT	Export permission checkmark	Yes	Yes
ASSIGNED_BY_ID	Responsible person’s ID	Yes	Yes
CREATED_BY_ID	Created by	Yes	No
MODIFY_BY_ID	Modified by	Yes	No
DATE_CREATE	Creation date	Yes	No
DATE_MODIFY	Modification date	Yes	No
COMPANY_ID	Company ID	Yes	Yes
LEAD_ID	Lead ID	Yes	No
PHONE	Phone	Yes	Yes
EMAIL	E-mail	Yes	Yes
WEB	Website	Yes	Yes
IM	Contact person in the instant messaging service	Yes	Yes
ORIGINATOR_ID	External information base ID. Field assignment can be changed by the end developer.	Yes	Yes
ORIGIN_ID	External key that is used for exchange operations. ID of an object of the external information database. The field assignment can be modified by the end developer.	Yes	Yes

Requisites

Name	Description	Read	Write
General requisites
ID	Requisite ID. Automatically created and unique within the database.	Yes	No
ENTITY_TYPE_ID	Parent entity type. Possible types: "Company", "Contact". Required field.	Yes	Yes
ENTITY_ID	Parent entity type. Required field.	Yes	Yes
PRESET_ID	Requisite template ID. Required field.	Yes	Yes
DATE_CREATE	Creation date.	Yes	No
DATE_MODIFY	Modification date.	Yes	No
CREATED_BY_ID	Requisite creator ID.	Yes	No
MODIFY_BY_ID	Requisite modifier ID.	Yes	No
NAME	Requisite name.	Yes	Yes
CODE	Requisite ID.	Yes	Yes
XML_ID	External key, used for exchange action. External database object ID. Field designation can be changed by the end developer.	Yes	Yes
ACTIVE	Active state attribute.	Yes	Yes
SORT	Sorting.	Yes	Yes
RQ_NAME	Full name	Yes	Yes
RQ_FIRST_NAME	Name.	Yes	Yes
RQ_LAST_NAME	Last name.	Yes	Yes
RQ_COMPANY_NAME	Abbreviated company name.	Yes	Yes
RQ_COMPANY_FULL_NAME	Full company name.	Yes	Yes
RQ_COMPANY_REG_DATE	Date of state registration.	Yes	Yes
RQ_DIRECTOR	General director.	Yes	Yes
RQ_ACCOUNTANT	Chief accountant.	Yes	Yes
RQ_CEO_NAME	CEO full name.	Yes	Yes
RQ_CEO_WORK_POS	CEO work position.	Yes	Yes
RQ_CONTACT	Contact person.	Yes	Yes
RQ_EMAIL	E-Mail.	Yes	Yes
RQ_PHONE	Telephone.	Yes	Yes
RQ_FAX	Fax.	Yes	Yes
RQ_IDENT_DOC	Document type.	Yes	Yes
RQ_IDENT_DOC_SER	Series.	Yes	Yes
RQ_IDENT_DOC_NUM	Number.	Yes	Yes
RQ_IDENT_DOC_DATE	Date of issue.	Yes	Yes
RQ_IDENT_DOC_ISSUED_BY	Issued by.	Yes	Yes
RQ_IDENT_DOC_DEP_CODE	Dept. code.	Yes	Yes
RQ_INN	INN.	Yes	Yes
RQ_KPP	KPP.	Yes	Yes
RQ_USRLE	Handelsregisternummer (for DE).	Yes	Yes
RQ_IFNS	IFNS.	Yes	Yes
RQ_OGRN	OGRN.	Yes	Yes
RQ_OGRNIP	OGRNIP.	Yes	Yes
RQ_OKPO	OKPO.	Yes	Yes
RQ_OKTMO	OKTMO.	Yes	Yes
RQ_OKVED	OKVED.	Yes	Yes
RQ_EDRPOU	EDRPOU.	Yes	Yes
RQ_DRFO	DRFO.	Yes	Yes
RQ_KBE	KBE.	Yes	Yes
RQ_IIN	IIN.	Yes	Yes
RQ_BIN	BIN.	Yes	Yes
RQ_VAT_PAYER	VAT payer (for UA).	Yes	Yes
RQ_VAT_ID	VAT ID (VAT payer identification number).	Yes	Yes
RQ_VAT_CERT_SER	VAT certificate series.	Yes	Yes
RQ_VAT_CERT_NUM	VAT certificate number.	Yes	Yes
RQ_VAT_CERT_DATE	VAT certificate date.	Yes	Yes
RQ_RESIDENCE_COUNTRY	Residence country.	Yes	Yes
ORIGINATOR_ID	External database ID. Field designation can be changed by the end developer.	Yes	Yes
Bank requisites
ID	Requisite ID. Automatically created and unique within the database.	Yes	No
ENTITY_TYPE_ID	Parent entity type. Default type: "Requisite". Required field.	Yes	Yes
ENTITY_ID	Parent entity ID. Required field.	Yes	Yes
COUNTRY_ID	Country ID.	Yes	Yes
DATE_CREATE	Creation date.	Yes	No
DATE_MODIFY	Modification date.	Yes	No
CREATED_BY_ID	Requisite creator ID.	Yes	No
MODIFY_BY_ID	Requisite modifier ID.	Yes	No
NAME	Requisite name.	Yes	Yes
CODE	Requisite ID.	Yes	Yes
XML_ID	External key used for exchange operations. ID of an object of the external information database. The field assignment can be modified by the end developer.	Yes	Yes
ACTIVE	Active state attribute.	Yes	Yes
SORT	Sorting.	Yes	Yes
RQ_BANK_NAME	Bank name.	Yes	Yes
RQ_BANK_ADDR	Bank address.	Yes	Yes
RQ_BANK_ROUTE_NUM	Bank Routing Number.	Yes	Yes
RQ_BIK	BIC.	Yes	Yes
RQ_MFO	MFO.	Yes	Yes
RQ_ACC_NAME	Bank Account Holder Name.	Yes	Yes
RQ_ACC_NUM	Bank Account Number.	Yes	Yes
RQ_IIK	ИИК.	Yes	Yes
RQ_ACC_CURRENCY	Account currency.	Yes	Yes
RQ_COR_ACC_NUM	Corr. account.	Yes	Yes
RQ_IBAN	IBAN.	Yes	Yes
RQ_SWIFT	SWIFT.	Yes	Yes
RQ_BIC	BIC.	Yes	Yes
COMMENTS	Comment.	Yes	Yes
ORIGINATOR_ID	External database ID. Field designation can change by the end developer.	Yes	Yes
Requisite templates
ID	Requisite ID. Automatically created and unique within the database.	Yes	No
ENTITY_TYPE_ID	Parent entity type. Required field.	Yes	Yes
COUNTRY_ID	Country, to which requisite template fields match.	Yes	Yes
DATE_CREATE	Creation date.	Yes	No
DATE_MODIFY	Modification date.	Yes	No
CREATED_BY_ID	Requisite creator ID.	Yes	No
MODIFY_BY_ID	Requisite modificatory ID.	Yes	No
NAME	Requisite name.	Yes	Yes
XML_ID	External key used for exchange operations. ID of an object of the external information database. The field assignment can be modified by the end developer.	Yes	Yes
ACTIVE	Active state attribute.	Yes	Yes
SORT	Sorting.	Yes	Yes
Requisite template fields
ID	Requisite ID. Automatically created and unique within the requisite.	Yes	No
FIELD_NAME	Field name.	Yes	Yes
FIELD_TITLE	Alternative field name for requisite.	Yes	Yes
SORT	Sorting.	Yes	Yes
IN_SHORT_LIST	Show in short list.	Yes	Yes
Requisite addresses
TYPE_ID	Address type ID. Required field. "Address type" enumeration element.	Yes	Yes
ENTITY_TYPE_ID	Parent entity type. Possible types: "Requisite", "Company", "Contact", "Lead". Required field.	Yes	Yes
ENTITY_ID	Parent entity ID. Required field.	Yes	Yes
ADDRESS_1	Street, house, building.	Yes	Yes
ADDRESS_2	Apartment / office.	Yes	Yes
CITY	Город.	Yes	Yes
POSTAL_CODE	Postal code.	Yes	Yes
REGION	Region.	Yes	Yes
PROVINCE	Province.	Yes	Yes
COUNTRY	Country.	Yes	Yes
COUNTRY_CODE	Country code.	Yes	Yes

Activities

Field	Description	Type	Note
ASSOCIATED_ENTITY_ID	ID of the entity associated with the activity	integer	Read only
AUTOR_ID	Activity creator	user
AUTOCOMPLETE_RULE	Autocomplete	integer
BINDINGS	Bindings	crm_activity_binding	Multiple, read only.
COMMUNICATIONS		crm_activity_communication	Multiple, required.
COMPLETED	Completed	char
CREATED	Created	datetime
DEADLINE	Deadline	datetime	Field is not set directly, value is taken from START_TIME for a call or meeting and from END_TIME for task.
DESCRIPTION	Description	string
DESCRIPTION_TYPE	Description type	crm.enum.contenttype
DIRECTION	Activity direction: incoming/outgoing.	crm.enum.activitydirection	Relevant to calls and emails; not used for meetings.
EDITOR_ID	Editor	user	Read only
END_TIME	Completion time	datetime
FILES	Added files	diskfile	Multiple
ID	Activity ID	integer	Read only
LAST_UPDATE	Date of last update	datetime	Read only
LOCATION	Location.	string
NOTIFY_TYPE	Notifications type	crm.enum.activitynotifytype
NOTIFY_VALUE		integer	Read only
ORIGINATOR_ID	Data source ID	string	Used only to bind to external source.
ORIGIN_ID	Element ID in the data source	string	Used only to bind to external source.
ORIGIN_VERSION	Original version	string	Used for data protection from rewrite by external system. If data was imported and not modified in the external system, such data can be edited in CRM without danger that the next upload will result in rewritten data.
OWNER_ID	Owner	integer	Unmodifiable
OWNER_TYPE_ID	Owner type	crm.enum.ownertype	Unmodifiable
PRIORITY	Priority	crm.enum.activitypriority
PROVIDER_DATA		string
PROVIDER_GROUP_ID		string
PROVIDER_ID	Provider ID	string
PROVIDER_TYPE_ID	Provider type ID	string	Status from directory
PROVIDER_PARAMS		object
RESPONSIBLE_ID	Responsible	user	Required
RESULT_CURRENCY_ID		string
RESULT_MARK		integer
RESULT_SOURSE_ID		string
RESULT_STATUS		integer
RESULT_STREAM	Report statistics	integer
RESULT_SUM		double
RESULT_VALUE		double
SETTINGS	Settings	object
START_TIME	Start time	datetime
STATUS	Status	crm_enum_activitystatus
SUBJECT	Subject	string	Required
TYPE_ID	Type	crm_enum_activitytype	Required, unmodifiable
WEBDAV_ELEMENTS	Added files	diskfile	Multiple. Deprecated, kept for compatibility