Fields of Main CRM Objects

Choose a tool for developing with an AI agent:

use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

This page explains the purpose and type of standard fields for the main CRM objects. Refer to it when building select, filter, and fields for CRM methods.

The available fields and their settings may differ between Bitrix24 accounts. Before creating an integration, retrieve the current field description using the corresponding crm.object_name.fields method, for example, crm.deal.fields for a deal. The tables below provide a quick reference and do not replace the method response.

The methods return the current availability attributes for each field:

isReadOnly: true—the field is read-only
isImmutable: true—the field value can be set when creating an object but cannot be changed after it is retained
isRequired: true—the field is required
isMultiple: true—the field accepts multiple values
isDynamic: true—the field was created in a specific Bitrix24 account and is not part of the standard set

To prepare a request:

Select an object and call its .fields method
Find the field by its identifier and check its type and availability attributes
Retrieve allowed values for dynamic directories, such as stages and custom fields
Pass the field to a create, update, retrieve, or list method according to the returned attributes

Field length limits are described in the article CRM Field Length Limits.

Deals

The field description is returned by the method crm.deal.fields

Name `type`	Description
ID `integer`	Deal identifier
TITLE `string`	Name
TYPE_ID `crm_status`	Deal type. Used only for linking to an external source.
CATEGORY_ID `crm_category`	Pipeline identifier. Immutable. If this field is not passed when creating a deal, the deal is created in the default pipeline
STAGE_ID `crm_status`	Deal stage identifier. The set of stages depends on the pipeline. Retrieve stages using crm.status.list with an `ENTITY_ID` filter: `DEAL_STAGE` for the default pipeline or `DEAL_STAGE_{CATEGORY_ID}` for another pipeline
STAGE_SEMANTIC_ID `string`	Deal stage group. Possible values: `P` — stage in progress `S` — successful stage `F` — unsuccessful stage
IS_NEW `char`	New deal flag (deals in the first stage)
IS_RECURRING `char`	Recurring deal template flag. If `Y` is set, then it is a template, not a deal
IS_RETURN_CUSTOMER `char`	Repeat deal indicator. Allowed values are `Y` and `N`
IS_REPEATED_APPROACH `char`	Indicates manual amount calculation. Allowed values are `Y` and `N`
PROBABILITY `integer`	Probability
CURRENCY_ID `crm_currency`	Deal currency identifier
OPPORTUNITY `double`	Amount
IS_MANUAL_OPPORTUNITY `char`	Repeat Salutation
TAX_VALUE `double`	Tax rate
COMPANY_ID `crm_company`	Linked company identifier
CONTACT_ID `crm_contact`	Linked contact identifier. Deprecated. Retained for compatibility
CONTACT_IDS `crm_contact`	Linked contact identifier. Multiple. When using crm.deal.update and crm.deal.add, you can pass an array of contacts. In the crm.deal.list and crm.deal.get methods, this field does not exist, and you must use crm.deal.contact.items.get to retrieve the list of contacts. To clear the field, use crm.deal.contact.items.delete; to replace the value, use crm.deal.contact.items.set
QUOTE_ID `crm_quote`	Quote identifier. Read-only. Deprecated. Use the crm.quote.list method with a filter by deal
BEGINDATE `date`	Start date
CLOSEDATE `date`	End date
OPENED `char`	Available to all
CLOSED `char`	Is the deal completed
COMMENTS `string`	Comments
ASSIGNED_BY_ID `user`	Linked to user by ID
CREATED_BY_ID `user`	Created by user
MODIFY_BY_ID `user`	Last change author identifier
MOVED_BY_ID `user`	Author identifier who moved the item to the current stage
DATE_CREATE `datetime`	Create date
DATE_MODIFY `datetime`	Change date
MOVED_TIME `datetime`	Date the item was moved to the current stage
SOURCE_ID `string`	Source identifier. Determines the source of the deal (callback, advertisement, Email, etc.). A list of possible identifiers can be obtained using the crm.status.list method with the `filter[ENTITY_ID]=SOURCE` filter.
SOURCE_DESCRIPTION `string`	Additional information about the source. Text field.
ADDITIONAL_INFO `string`	Additional information.
LEAD_ID `crm_lead`	Linked lead identifier.
LOCATION_ID `location`	Customer location. Service field, not recommended for use.
ORIGINATOR_ID `string`	Data source identifier. Used only for linking to an external source.
ORIGIN_ID `string`	Item identifier in the data source. Used only for linking to an external source.
UTM_SOURCE `string`	Ad system (Search Ads, Display Ads, and others).
UTM_MEDIUM `string`	Traffic type: CPC (ads), CPM (banners).
UTM_CAMPAIGN `string`	Advertising campaign designation.
UTM_CONTENT `string`	Campaign contents. For example, for contextual ads.
UTM_TERM `string`	Campaign search condition. For example, contextual advertising keywords.
PARENT_ID_xxx `crm_entity`	Relation fields. If there are SPAs on the portal linked to contacts, then for each such SPA, there is a field that stores the connection between this SPA and the contact. The field itself stores the item identifier of that SPA. For example, the `PARENT_ID_153` field — a connection with SPA `entityTypeId=153`, stores the item identifier of this SPA linked to the current contact.
LAST_ACTIVITY_BY `string`	Identifier of the user assigned to the last activity in this lead (for example, the one who created a new activity in the lead).
LAST_ACTIVITY_TIME `datetime`	Last activity time.
UF_CRM_xxx	Custom fields

Leads

The field description is returned by the method crm.lead.fields

Name `type`	Description
ID `integer`	Integer lead identifier.
TITLE `string`	Lead name.
HONORIFIC `crm_status`	Salutation. Status from the directory. A list of possible identifiers can be obtained using the crm.status.list method with the `filter[ENTITY_ID]=HONORIFIC` filter.
NAME `string`	Contact first name.
SECOND_NAME `string`	Contact middle name.
LAST_NAME `string`	Contact last name.
BIRTHDATE `date`	Date of birth.
COMPANY_TITLE `string`	Name of the company linked to the lead.
SOURCE_ID `crm_status`	Source identifier. Status from the directory. A list of possible identifiers can be obtained using the crm.status.list method with the `filter[ENTITY_ID]=SOURCE` filter.
SOURCE_DESCRIPTION `string`	Source description.
STATUS_ID `crm_status`	Lead stage identifier. Status from the directory. A list of possible identifiers can be obtained using the crm.status.list method with the `filter[ENTITY_ID]=STATUS` filter.
STATUS_DESCRIPTION `string`	Additional information about the stage.
STATUS_SEMANTIC_ID `string`	Status. Possible values: `F` (failed) — processed unsuccessfully `S` (success) — processed successfully `P` (processing) — lead is being processed
POST `string`	Job title
ADDRESS `string`	Contact address.
ADDRESS_2 `string`	Address line 2. In some countries, addresses are commonly split into two parts
ADDRESS_CITY `string`	City
ADDRESS_POSTAL_CODE `string`	Postal code
ADDRESS_REGION `string`	District
ADDRESS_PROVINCE `string`	Region
ADDRESS_COUNTRY `string`	Country
ADDRESS_COUNTRY_CODE `string`	Country code
ADDRESS_LOC_ADDR_ID `integer`	Address identifier from the locations module
CURRENCY_ID `crm_currency`	Currency identifier
OPPORTUNITY `double`	Estimated amount
IS_MANUAL_OPPORTUNITY `char`	Manual amount calculation flag. Allowed values `Y` or `N`
OPENED `char`	Available to all. Allowed values `Y` or `N`
COMMENTS `string`	Comments
HAS_PHONE `char`	`phone` field completion flag. Allowed values `Y` or `N`
HAS_EMAIL `char`	Email field completion flag. Allowed values `Y` or `N`
HAS_IMOL `char`	Linked Open Channel presence flag. Allowed values `Y` or `N`
ASSIGNED_BY_ID `user`	Identifier of the user assigned to the lead
CREATED_BY_ID `user`	Identifier of the user who created the lead
MODIFY_BY_ID `user`	Last change author identifier
MOVED_BY_ID `user`	Identifier of the author who moved the item to the current stage
DATE_CREATE `datetime`	Create date
DATE_MODIFY `datetime`	Change date
MOVED_TIME `datetime`	Date the item was moved to the current stage
COMPANY_ID `crm_company`	Linking the lead to a company (Client->Company field)
CONTACT_ID `crm_contact`	Linking the lead to a contact. Obsolete field, currently not used. Kept for backward compatibility
CONTACT_IDS `crm_contact`	Linked contact identifier. Multiple. When using crm.lead.update and crm.lead.add, you can pass an array of contacts
IS_RETURN_CUSTOMER `char`	Repeat lead indicator. Allowed values `Y` or `N`
DATE_CLOSED `datetime`	Closing date
ORIGINATOR_ID `string`	Data source identifier. Used only for linking to an external source.
ORIGIN_ID `string`	Item identifier in the data source. Used only for linking to an external source.
UTM_SOURCE `string`	Ad system (Search Ads, Display Ads, and others).
UTM_MEDIUM `string`	Traffic type: CPC (ads), CPM (banners).
UTM_CAMPAIGN `string`	Advertising campaign designation.
UTM_CONTENT `string`	Campaign contents. For example, for contextual ads.
UTM_TERM `string`	Campaign search condition. For example, contextual advertising keywords.
LAST_ACTIVITY_TIME `datetime`	Last activity time.
LAST_ACTIVITY_BY `string`	Identifier of the user assigned to the last activity in this lead (for example, the one who created a new activity in the lead).
PHONE `crm_multifield`	Contact phone. Multiple
EMAIL `crm_multifield`	Email address. Multiple
WEB `crm_multifield`	Lead URL resources. Multiple
IM `crm_multifield`	Messengers. Multiple
LINK `crm_multifield`	Links. Multiple. Service
UF_CRM_xxx	Custom fields

Companies

The field description is returned by the method crm.company.fields

Name `type`	Description
ID `integer`	Company identifier
TITLE `string`	Name. Required
COMPANY_TYPE `crm_status`	Company type
LOGO `file`	Logo
ADDRESS `string`	Company address
ADDRESS_2 `string`	Address line 2. In some countries, it is common to split the address into 2 parts.
ADDRESS_CITY `string`	City
ADDRESS_POSTAL_CODE `string`	Postal code
ADDRESS_REGION `string`	District
ADDRESS_PROVINCE `string`	Region
ADDRESS_COUNTRY `string`	Country
ADDRESS_COUNTRY_CODE `string`	Country code
ADDRESS_LOC_ADDR_ID `integer`	Location address identifier
ADDRESS_LEGAL `string`	Legal address
REG_ADDRESS `string`	Company legal address. Obsolete, used for compatibility
REG_ADDRESS_2 `string`	Legal address line 2. In some countries, it is common to split the address into 2 parts. Obsolete, used for compatibility
REG_ADDRESS_CITY `string`	Legal address city. Obsolete, used for compatibility
REG_ADDRESS_POSTAL_CODE `string`	Legal address postal code. Obsolete, used for compatibility
REG_ADDRESS_REGION `string`	Legal address district. Obsolete, used for compatibility
REG_ADDRESS_PROVINCE `string`	Legal address region. Obsolete, used for compatibility
REG_ADDRESS_COUNTRY `string`	Legal address country. Obsolete, used for compatibility
REG_ADDRESS_COUNTRY_CODE `string`	Legal address country code. Obsolete, used for compatibility
REG_ADDRESS_LOC_ADDR_ID `integer`	Legal address location identifier. Obsolete, used for compatibility
BANKING_DETAILS `string`	Bank Company details
INDUSTRY `crm_status`	Industry
EMPLOYEES `crm_status`	Number of employees
CURRENCY_ID `crm_currency`	Currency
REVENUE `double`	Annual turnover
OPENED `char`	Available to all
COMMENTS `string`	Comments
HAS_PHONE `char`	Has phone
HAS_EMAIL `char`	Has email
HAS_IMOL `char`	Has Open Channel
IS_MY_COMPANY `char`	My company
ASSIGNED_BY_ID `user`	Linked to user by ID
CREATED_BY_ID `user`	Created by
MODIFY_BY_ID `user`	Last change author identifier
DATE_CREATE `datetime`	Create date
DATE_MODIFY `datetime`	Change date
CONTACT_ID `string`	Contact. Used only for linking to an external source.
LEAD_ID `crm_lead`	Identifier of the lead linked to the company
ORIGINATOR_ID `string`	Data source identifier. Used only for linking to an external source.
ORIGIN_ID `string`	Item identifier in the data source. Used only for linking to an external source.
ORIGIN_VERSION `string`	Original version. Used to protect data from accidental overwriting by an external system. If the data was imported and has not changed in the external system, then such data can be edited in the CRM without fear that the next upload will lead to overwriting the data
UTM_SOURCE `string`	Ad system (Search Ads, Display Ads, and others).
UTM_MEDIUM `string`	Traffic type: CPC (ads), CPM (banners).
UTM_CAMPAIGN `string`	Advertising campaign designation.
UTM_CONTENT `string`	Campaign contents. For example, for contextual ads.
UTM_TERM `string`	Campaign search condition. For example, contextual advertising keywords.
PARENT_ID_xxx `crm_entity`	Relation fields. If the Bitrix24 account has SPAs linked to contacts, each such SPA has a linking field. The field stores the identifier of the SPA item linked to the current contact. For example, the field `PARENT_ID_153` — link to SPA `entityTypeId=153`, stores the item identifier of this SPA linked to the current contact
LAST_ACTIVITY_TIME `datetime`	Last activity time.
LAST_ACTIVITY_BY `user`	Author of the latest timeline activity
PHONE `crm_multifield`	Company phone. Multiple
EMAIL `crm_multifield`	Email address. Multiple
WEB `crm_multifield`	Company resource URLs. Multiple
IM `crm_multifield`	Messengers. Multiple
LINK `crm_multifield`	Links. Multiple. Service

Contacts

The field description is returned by the method crm.contact.fields

Name `type`	Description
ID `integer`	Contact identifier
HONORIFIC `crm_status`	Salutation. You can obtain the dictionary values using the crm.status.list method with a filter by `ENTITY_ID=HONORIFIC`
NAME `string`	First name
SECOND_NAME `string`	Middle name
LAST_NAME `string`	Last name
PHOTO `file`	Photo
BIRTHDATE `date`	Date of birth.
TYPE_ID `crm_status`	Contact type. You can obtain the dictionary values using the crm.status.list method with a filter by `ENTITY_ID=CONTACT_TYPE`
SOURCE_ID `crm_status`	Source. You can obtain the dictionary values using the crm.status.list method with a filter by `ENTITY_ID=SOURCE`
SOURCE_DESCRIPTION `string`	Additional info about the source
POST `string`	Job title.
Deprecated fields Address fields in the contact are deprecated and used only for backward compatibility. To work with addresses, use Company details.
ADDRESS `string`	Address (deprecated)
ADDRESS_2 `string`	Address line 2 (deprecated)
ADDRESS_CITY `string`	City (deprecated)
ADDRESS_POSTAL_CODE `string`	Postal code (deprecated)
ADDRESS_REGION `string`	District (deprecated)
ADDRESS_PROVINCE `string`	Region (deprecated)
ADDRESS_COUNTRY `string`	Country (deprecated)
ADDRESS_COUNTRY_CODE `string`	Country code (deprecated)
ADDRESS_LOC_ADDR_ID `location`	Location address identifier (deprecated)
COMMENTS `string`	Comment. Supports bb-codes
OPENED `char`	Available to all. Can take values `Y` or `N`. Taken into account in access rights for roles with "All open" access level
EXPORT `char`	Include in contact export. Can take values `Y` or `N`
HAS_PHONE `char`	Phone is set. Can take values `Y` or `N`
HAS_EMAIL `char`	E-mail is set. Can take values `Y` or `N`
HAS_IMOL `char`	Open Channel is set. Can take values `Y` or `N`
ASSIGNED_BY_ID `user`	assigned user
CREATED_BY_ID `user`	Created by
MODIFY_BY_ID `user`	Changed by
DATE_CREATE `datetime`	Create date
DATE_MODIFY `datetime`	Change date
COMPANY_ID `crm_company`	Primary company of the contact
COMPANY_IDS `crm_company`	Linking a contact to companies. Multiple. In methods crm.contact.update and crm.contact.add, it is used to provide an array of companies. In methods crm.contact.list and crm.contact.get, this field does not exist, and you must use crm.contact.company.items.get to retrieve the list of companies
LEAD_ID `crm_lead`	Identifier of the lead associated with the contact
Connection fields with external data sources If the contact was created by an external system, then: the `ORIGINATOR_ID` field stores the string identifier of that system the `ORIGIN_ID` field stores the string identifier of the contact in that external system the `ORIGIN_VERSION` field stores the version of the contact data in that external system
ORIGINATOR_ID `string`	Identifier of the external system that is the source of data about this contact
ORIGIN_ID `string`	Identifier of the contact in the external system
ORIGIN_VERSION `string`	Version of the contact data in the external system. Used to protect data from accidental overwriting by an external system. If the data was imported and has not changed in the external system, such data can be edited in the CRM without fear that the next export will lead to overwriting the data.
FACE_ID `integer`	Link to persons from the `faceid` module
UTM_SOURCE `string`	Ad system (Search Ads, Display Ads, and others).
UTM_MEDIUM `string`	Traffic type: CPC (ads), CPM (banners).
UTM_CAMPAIGN `string`	Advertising campaign designation.
UTM_CONTENT `string`	Campaign contents. For example, for contextual ads.
UTM_TERM `string`	Campaign search condition. For example, contextual advertising keywords.
PARENT_ID_...	Relation fields. If there are SPAs on the portal linked to contacts, for each such SPA there is a field storing the link between this SPA and the contact. The field itself stores the item identifier of such an SPA. For example, the field `PARENT_ID_153` — link to SPA `entityTypeId=153`, stores the item identifier of this SPA linked to the current contact
LAST_ACTIVITY_TIME `datetime`	Date of the last activity in the timeline
LAST_ACTIVITY_BY `user`	Author of the last activity in the timeline
PHONE `crm_multifield`	Phones. Multiple
EMAIL `crm_multifield`	E-mail. Multiple
WEB `crm_multifield`	Websites. Multiple
IM `crm_multifield`	Messengers. Multiple
LINK `crm_multifield`	Links. Multiple. Service
UF_CRM_xxx	custom fields. For example, `UF_CRM_25534736`. Depending on the portal settings, contacts may have a set of custom fields of certain types. You can add a custom field to a contact using the crm.contact.userfield.add method

Company Details

General Requisites

The field description is returned by the method crm.requisite.fields

Name `type`	Description
ID `integer`	Identifier of the requisite. Can be obtained using the crm.requisite.list method. Created automatically and is unique within the portal
ENTITY_TYPE_ID `integer`	Identifier of the parent entity type. Currently, this can only be: `3` — contact `4` — company The crm.enum.ownertype method returns identifiers for all CRM object types
ENTITY_ID `integer`	Identifier of the parent entity (contact or company). The identifier can be obtained using the crm.company.list method for a company and the crm.contact.list method for a contact.
PRESET_ID `integer`	Requisite template identifier. Template identifiers can be obtained using the crm.requisite.preset.list method.
DATE_CREATE `datetime`	Create date
DATE_MODIFY `datetime`	Change date
CREATED_BY_ID `user`	Identifier of the user who created the requisite.
MODIFY_BY_ID `user`	Identifier of the user who changed the requisite.
NAME `string`	Requisite name.
CODE `string`	Character code of the requisite.
XML_ID `string`	Foreign key, used for exchange operations. Identifier of the external information base object. The purpose of the field may be changed by the end developer.
ORIGINATOR_ID `string`	External information base identifier. The purpose of the field may be changed by the end developer.
ACTIVE `char`	Activity flag. Uses values `Y` or `N`. Currently, the field does not actually affect anything.
ADDRESS_ONLY `char`	Status flag, when the requisite is used only for storing an address. Uses values `Y` or `N`. When the value is `Y`, Company details are not shown in the entity card, but the address is displayed.
SORT `integer`	Sorting. The order in the entity's requisite list when there are multiple requisites.
RQ_NAME `string`	Full Name
RQ_FIRST_NAME `string`	First name
RQ_LAST_NAME `string`	Last name
RQ_SECOND_NAME `string`	Middle name
RQ_COMPANY_ID `string`	Organization identifier
RQ_COMPANY_NAME `string`	Abbreviated organization name
RQ_COMPANY_FULL_NAME `string`	Full organization name
RQ_COMPANY_REG_DATE `string`	State registration date
RQ_DIRECTOR `string`	General Director
RQ_ACCOUNTANT `string`	Chief Accountant
RQ_CEO_NAME `string`	Full Name of the first manager
RQ_CEO_WORK_POS `string`	Position of the first manager
RQ_CONTACT `string`	Contact person
RQ_EMAIL `string`	E-Mail
RQ_PHONE `string`	Phone
RQ_FAX `string`	Fax
RQ_IDENT_TYPE `crm_status`	Identification method
RQ_IDENT_DOC `string`	Document type
RQ_IDENT_DOC_SER `string`	Series
RQ_IDENT_DOC_NUM `string`	Number
RQ_IDENT_DOC_PERS_NUM `string`	Personal number
RQ_IDENT_DOC_DATE `string`	Date of issue
RQ_IDENT_DOC_ISSUED_BY `string`	Issued by
RQ_IDENT_DOC_DEP_CODE `string`	Department code
RQ_INN `string`	TIN
RQ_KPP `string`	KPP
RQ_USRLE `string`	Handelsregisternummer (for country DE)
RQ_IFNS `string`	IFNS
RQ_OGRN `string`	OGRN
RQ_OGRNIP `string`	OGRNIP
RQ_OKPO `string`	OKPO
RQ_OKTMO `string`	OKTMO
RQ_OKVED `string`	OKVED
RQ_EDRPOU `string`	EDRPOU
RQ_DRFO `string`	DRFO
RQ_KBE `string`	KBE
RQ_IIN `string`	IIN
RQ_BIN `string`	BIN
RQ_ST_CERT_SER `string`	State registration certificate series
RQ_ST_CERT_NUM `string`	State registration certificate number
RQ_ST_CERT_DATE `string`	State registration certificate date
RQ_VAT_PAYER `char`	VAT Payer (for country UA). Uses values `Y` or `N`
RQ_VAT_ID `string`	VAT ID (Value Added Tax identification number)
RQ_VAT_CERT_SER `string`	VAT certificate series
RQ_VAT_CERT_NUM `string`	VAT certificate number
RQ_VAT_CERT_DATE `string`	VAT certificate date
RQ_RESIDENCE_COUNTRY `string`	Country of residence
RQ_BASE_DOC `string`	Basis of action
RQ_REGON `string`	REGON (for country PL)
RQ_KRS `string`	KRS (for country PL)
RQ_PESEL `string`	PESEL (for country PL)
RQ_LEGAL_FORM `string`	Legal form (for country FR)
RQ_SIRET `string`	Siret Number (for country FR)
RQ_SIREN `string`	Siren Number (for country FR)
RQ_CAPITAL `string`	Share capital (for country FR)
RQ_RCS `string`	RCS (for country FR)
RQ_CNPJ `string`	CNPJ (for country BR)
RQ_STATE_REG `string`	State Registration (IE) (for country BR)
RQ_MNPL_REG `string`	Municipal Registration (IM) (for country BR)
RQ_CPF `string`	CPF (for country BR)
UF_CRM_...	Custom fields. For example, `UF_CRM_1694526604`. Requisites can have a set of custom fields with types: `string`, `boolean`, `double`, `datetime`. You can add a custom field to requisites using the crm.requisite.userfield.add method

Bank Details

The field description is returned by the method crm.requisite.bankdetail.fields

Name `type`	Description
ID `integer`	Bank requisite identifier. Created automatically and is unique within the portal
ENTITY_TYPE_ID `integer`	Parent object type identifier. Can only be `Attribute` (value `8`). The method crm.enum.ownertype returns object type identifiers
ENTITY_ID `integer`	Parent object identifier
COUNTRY_ID `integer`	Country identifier that corresponds to the set of bank requisite fields (see method crm.requisite.preset.countries to get available values). The bank requisite country code matches the country code in the linked requisite template, whose identifier is specified in the `ENTITY_ID` field
DATE_CREATE `datetime`	Create date
DATE_MODIFY `datetime`	Change date
CREATED_BY_ID `user`	Identifier of the user who created the requisite
MODIFY_BY_ID `user`	Identifier of the user who changed the requisite
NAME^* `string`	Bank requisite name
CODE `string`	Character code of the requisite.
XML_ID `string`	External key. Used for exchange operations. Identifier of the external information base object. The purpose of the field may be changed by the end developer. Each application ensures the uniqueness of values in this field. It is recommended to use a unique prefix to avoid collisions with other applications
ACTIVE `char`	Activity flag. Uses values `Y` or `N`. Currently, the field does not actually affect anything
SORT `integer`	Sorting
RQ_BANK_NAME `string`	Bank name
RQ_BANK_ADDR `string`	Bank address
RQ_BANK_CODE `string`	Bank Code (for country BR)
RQ_BANK_ROUTE_NUM `string`	Bank Routing Number
RQ_BIK `string`	BIC
RQ_CODEB `string`	Bank Code (for country FR)
RQ_CODEG `string`	Branch Code (for country FR)
RQ_RIB `string`	RIB Key (for country FR)
RQ_MFO `string`	MFO
RQ_ACC_NAME `string`	Bank Account Holder Name
RQ_ACC_NUM `string`	Bank Account Number
RQ_ACC_TYPE `string`	Account Type (for country BR)
RQ_AGENCY_NAME `string`	Agency (for country BR)
RQ_IIK `string`	IIK
RQ_ACC_CURRENCY `string`	Account currency
RQ_COR_ACC_NUM `string`	Correspondent account
RQ_IBAN `string`	IBAN
RQ_SWIFT `string`	SWIFT
RQ_BIC `string`	BIC
COMMENTS `string`	Comment
ORIGINATOR_ID `string`	External information base identifier. The purpose of the field may be changed by the end developer

Templates of Requisites

The field description is returned by the method crm.requisite.preset.fields

Name	Description
ID `integer`	Requisite identifier. Created automatically and is unique within the portal
ENTITY_TYPE_ID `integer`	Parent object type identifier. The method crm.enum.ownertype returns CRM object type identifiers
COUNTRY_ID `integer`	Country identifier that corresponds to the set of fields in the requisite template (to get available values, see method crm.requisite.preset.countries)
DATE_CREATE `datetime`	Create date
DATE_MODIFY `datetime`	Modification date. Contains an empty string if the template has not changed since creation.
CREATED_BY_ID `user`	Identifier of the user who created the requisite
MODIFY_BY_ID `user`	Identifier of the user who changed the requisite
NAME `string`	Requisite name.
XML_ID `string`	Foreign key. Used for exchange operations. Identifier of an object in an external information base. The purpose of the field may change depending on the end developer. Each application ensures the uniqueness of values in this field. It is recommended to use a unique prefix to avoid collisions with other applications. In CRM, values like `#CRM_REQUISITE_PRESET_DEF_...` are reserved for identifying default templates. These identifiers should not be used for your own purposes, as this may lead to logic violations.
ACTIVE `char`	Activity flag. Uses values `Y` or `N`. Determines the availability of the template in the selection list when adding requisites.
SORT `integer`	Sorting

Fields of Requisites Templates

The field description is returned by the method crm.requisite.preset.field.fields

Name `type`	Description
ID `integer`	Field identifier. Created automatically and is unique within the template.
FIELD_NAME `string`	Field name
FIELD_TITLE `string`	Alternative field name for a requisite. The alternative name is displayed in various forms for filling out requisites. Depending on the specific form, the alternative name may or may not be used.
SORT `integer`	Sorting. The order in the template field list.
IN_SHORT_LIST `char`	Show in short list. Deprecated field, currently not used. Kept for backward compatibility. Can take values `Y` or `N`.

Addresses of Requisites

The field description is returned by the method crm.address.fields

Name	Description
TYPE_ID `integer`	Address type identifier. "Address type" enumeration item. "Address type" enumeration items can be obtained using the crm.enum.addresstype method
ENTITY_TYPE_ID `integer`	Parent object type identifier. Object type identifiers can be obtained using the crm.enum.ownertype method. Addresses can only be linked to Requisites (whereas Company details are already linked to companies or contacts) or Leads. For backward compatibility, the ability to link Addresses to Contacts or Companies has been kept. However, this connection is only possible on some old portals where the old address mode was specifically enabled by technical support.
ENTITY_ID `string`	Parent object identifier
ADDRESS_1 `string`	Street, house, building, structure
ADDRESS_2 `string`	Apartment / office
CITY `string`	City
POSTAL_CODE `string`	Postal code
REGION `string`	District
PROVINCE `string`	Region
COUNTRY `string`	Country
COUNTRY_CODE `string`	Country code
LOC_ADDR_ID `integer`	Location identifier. This field contains the identifier of the address object in the `Location` module, associated with the CRM address object. Each CRM address corresponds to an address object in the module `location`. This can be used to copy an existing CRM address with location information that is not present in the CRM address fields. If a `location` module address identifier is specified when creating an address, a copy of the address is created `location` and linked to the created CRM address. If, in this case, no values are specified for the string address fields, they will be filled from the location address. However, if at least one string field was specified, only the specified fields will be saved in the CRM address, and their values will overwrite the corresponding values in the location address object. The same behavior applies when updating an address.
ANCHOR_TYPE_ID `integer`	Main parent object type identifier. This field is for internal use. The value is filled automatically when an address is added. Object type identifiers can be obtained using the crm.enum.ownertype method. This field contains the identifier of the attribute's parent object type (company or contact) if the address is linked to an attribute. If the address is linked to a lead, this value will be the lead type identifier.
ANCHOR_ID `integer`	This field is for internal use. The value is filled automatically when an address is added. This field contains the identifier of the attribute's parent object (company or contact) if the address is linked to an attribute. If the address is linked to a lead, this value will be the lead identifier.

Activities

The field description is returned by the method crm.activity.fields

Name	Description
ID `integer`	Activity identifier
OWNER_ID `integer`	Owner identifier, immutable
OWNER_TYPE_ID `crm_enum_ownertype`	Owner type, immutable
TYPE_ID `crm_enum_activitytype`	Type, immutable
PROVIDER_ID `string`	Provider identifier
PROVIDER_TYPE_ID `string`	Provider type identifier
PROVIDER_GROUP_ID `string`	Connector type
ASSOCIATED_ENTITY_ID `integer`	Entity identifier related to the activity
SUBJECT `string`	Subject, activity title
START_TIME `datetime`	Start time
END_TIME `datetime`	Completion time
DEADLINE `datetime`	Due date. This field is not set directly; the value is taken from `START_TIME` for calls and meetings and from `END_TIME` for tasks.
COMPLETED `char`	Completed
STATUS `crm_enum_activitystatus`	Status
RESPONSIBLE_ID `user`	assigned user
PRIORITY `crm_enum_activitypriority`	Importance
NOTIFY_TYPE `crm_enum_activitynotifytype`	Notification type
NOTIFY_VALUE `integer`	Notification parameter
DESCRIPTION `string`	Description
DESCRIPTION_TYPE `crm_enum_contenttype`	Description type
DIRECTION `crm_enum_activitydirection`	Activity direction: inbound/outbound. Relevant for calls and emails, not used for meetings.
LOCATION `string`	Location
CREATED `datetime`	Create date
AUTHOR_ID `user`	Activity creator
LAST_UPDATED `datetime`	Last update date
EDITOR_ID `user`	Changed by
SETTINGS `object`	Settings
ORIGIN_ID `string`	Item identifier in the data source. Used only for linking to an external source.
ORIGINATOR_ID `string`	Data source identifier. Used only for linking to an external source.
RESULT_STATUS `integer`	Unused field, remains for compatibility
RESULT_STREAM `integer`	Report statistics
RESULT_SOURCE_ID `string`	Unused field, remains for compatibility
PROVIDER_PARAMS `object`	Provider parameters
PROVIDER_DATA `string`	Provider data
RESULT_MARK `integer`	Unused field, remains for compatibility
RESULT_VALUE `double`	Unused field, remains for compatibility
RESULT_SUM `double`	Unused field, remains for compatibility
RESULT_CURRENCY_ID `string`	Unused field, remains for compatibility
AUTOCOMPLETE_RULE `integer`	Autofill
BINDINGS `crm_activity_binding`	Links
COMMUNICATIONS `crm_activity_communication`	Communication channel. Multiple, mandatory
FILES `diskfile`	Added files. Multiple
WEBDAV_ELEMENTS `diskfile`	Added files. Multiple. Deprecated, kept for compatibility
IS_INCOMING_CHANNEL `char`	Whether the activity is inbound, i.e., created as a result of an incoming client Salutation to a communication channel

Continue Exploring

CRM Data Types — special field types and links between objects
Deal Custom Fields — create and configure additional deal fields
CRM Statuses and Directories — retrieve stage values and other directory fields

Was the article helpful?

Data Types and Object Structure in the CRM REST API

CRM Field Length Limits

Fields of Main CRM Objects

DealsDeals

LeadsLeads

CompaniesCompanies

ContactsContacts

Company DetailsCompany Details

General RequisitesGeneral Requisites

Bank DetailsBank Details

Templates of RequisitesTemplates of Requisites

Fields of Requisites TemplatesFields of Requisites Templates

Addresses of RequisitesAddresses of Requisites

ActivitiesActivities

Continue ExploringContinue Exploring