Fields of Main CRM Objects

Name
type

Description

Read

Write

ID
integer

Integer identifier of the lead

Yes

No

TITLE
string

Title of the lead

Yes

Yes

HONORIFIC
crm_status

Form of address. Status from the directory.

A list of possible identifiers can be obtained using the method crm.status.list with the filter filter[ENTITY_ID]=HONORIFIC

Yes

Yes

NAME
string

Contact's first name

Yes

Yes

SECOND_NAME
string

Contact's middle name

Yes

Yes

LAST_NAME
string

Contact's last name

Yes

Yes

BIRTHDATE
date

Date of birth

Yes

Yes

COMPANY_TITLE
string

Title of the company linked to the lead

Yes

Yes

SOURCE_ID
crm_status

Identifier of the source. Status from the directory.

A list of possible identifiers can be obtained using the method crm.status.list with the filter filter[ENTITY_ID]=SOURCE

Yes

Yes

SOURCE_DESCRIPTION
string

Description of the source

Yes

Yes

STATUS_ID
crm_status

Identifier of the lead stage. Status from the directory.

A list of possible identifiers can be obtained using the method crm.status.list with the filter filter[ENTITY_ID]=STATUS

Yes

Yes

STATUS_DESCRIPTION
string

Additional information about the stage

Yes

Yes

STATUS_SEMANTIC_ID
string

Status. Possible values:

• F (failed) — processed unsuccessfully
• S (success) — processed successfully
• P (processing) — lead in processing

Yes

No

POST
string

Position

Yes

Yes

ADDRESS
string

Contact's address

Yes

Yes

ADDRESS_2
string

Second line of the address. In some countries, it is customary to split the address into 2 parts

Yes

Yes

ADDRESS_CITY
string

City

Yes

Yes

ADDRESS_POSTAL_CODE
string

Postal code

Yes

Yes

ADDRESS_REGION
string

Region

Yes

Yes

ADDRESS_PROVINCE
string

Province

Yes

Yes

ADDRESS_COUNTRY
string

Country

Yes

Yes

ADDRESS_COUNTRY_CODE
string

Country code

Yes

Yes

ADDRESS_LOC_ADDR_ID
integer

Identifier of the address from the location module

Yes

Yes

CURRENCY_ID
crm_currency

Identifier of the currency

Yes

Yes

OPPORTUNITY
double

Estimated amount

Yes

Yes

IS_MANUAL_OPPORTUNITY
char

Indicator of manual calculation of the amount. Allowed values Y or N

Yes

Yes

OPENED
char

Available to everyone. Allowed values Y or N

Yes

Yes

COMMENTS
string

Comments

Yes

Yes

HAS_PHONE
char

Indicator of the phone field being filled. Allowed values Y or N

Yes

No

HAS_EMAIL
char

Indicator of the e-mail field being filled. Allowed values Y or N

Yes

No

HAS_IMOL
char

Indicator of the presence of a linked open line. Allowed values Y or N

Yes

No

ASSIGNED_BY_ID
user

Identifier of the user responsible for the lead

Yes

Yes

CREATED_BY_ID
user

Identifier of the user who created the lead

Yes

No

MODIFY_BY_ID
user

Identifier of the author of the last change

Yes

No

MOVED_BY_ID
user

Identifier of the author who moved the item to the current stage

Yes

No

DATE_CREATE
datetime

Creation date

Yes

No

DATE_MODIFY
datetime

Modification date

Yes

No

MOVED_TIME
datetime

Date of moving the item to the current stage

Yes

No

COMPANY_ID
crm_company

Linking the lead to a company (Field Client->Company)

Yes

Yes

CONTACT_ID
crm_contact

Linking the lead to a contact. Deprecated field, currently not used. Kept for backward compatibility

Yes

Yes

CONTACT_IDS
crm_contact

Identifier of the linked contact. Multiple.

When using crm.lead.update and crm.lead.add, an array of contacts can be submitted

Yes

Yes

IS_RETURN_CUSTOMER
char

Indicator of a repeat lead. Allowed values Y or N

Yes

No

DATE_CLOSED
datetime

Closing date

Yes

No

ORIGINATOR_ID
string

Identifier of the data source. Used only for linking to external sources

Yes

Yes

ORIGIN_ID
string

Identifier of the item in the data source. Used only for linking to external sources

Yes

Yes

UTM_SOURCE
string

Advertising system (Google-Adwords, etc.)

Yes

Yes

UTM_MEDIUM
string

Type of traffic: CPC (ads), CPM (banners)

Yes

Yes

UTM_CAMPAIGN
string

Designation of the advertising campaign

Yes

Yes

UTM_CONTENT
string

Content of the campaign. For example, for contextual ads

Yes

Yes

UTM_TERM
string

Search condition of the campaign. For example, keywords for contextual advertising

Yes

Yes

LAST_ACTIVITY_TIME
datetime

Time of the last activity

Yes

No

LAST_ACTIVITY_BY
string

Identifier of the user responsible for the last activity in this lead (for example, who created a new deal in the lead)

Yes

No

PHONE
crm_multifield

Contact's phone. Multiple

Yes

Yes

EMAIL
crm_multifield

E-mail address. Multiple

Yes

Yes

WEB
crm_multifield

URLs of the lead. Multiple

Yes

Yes

IM
crm_multifield

Messengers. Multiple

Yes

Yes

LINK
crm_multifield

Links. Multiple. Service

Yes

Yes

UF_CRM_xxx

User-defined fields

Yes

Yes

Name
type

Description

Read

Write

ID
integer

Identifier of the company

Yes

No

TITLE
string

Name. Required

Yes

Yes

COMPANY_TYPE
crm_status

Type of company

Yes

Yes

LOGO
file

Logo

Yes

Yes

ADDRESS
string

Address of the company

Yes

Yes

ADDRESS_2
string

Second line of the address. In some countries, it is customary to split the address into 2 parts

Yes

Yes

ADDRESS_CITY
string

City

Yes

Yes

ADDRESS_POSTAL_CODE
string

Postal code

Yes

Yes

ADDRESS_REGION
string

Region

Yes

Yes

ADDRESS_PROVINCE
string

Province

Yes

Yes

ADDRESS_COUNTRY
string

Country

Yes

Yes

ADDRESS_COUNTRY_CODE
string

Country code

Yes

Yes

ADDRESS_LOC_ADDR_ID
integer

Identifier of the location address

Yes

Yes

ADDRESS_LEGAL
string

Legal address

Yes

Yes

REG_ADDRESS
string

Legal address of the company. Deprecated, used for compatibility

Yes

Yes

REG_ADDRESS_2
string

Second line of the legal address. In some countries, it is customary to split the address into 2 parts.
Deprecated, used for compatibility

Yes

Yes

REG_ADDRESS_CITY
string

City of the legal address. Deprecated, used for compatibility

Yes

Yes

REG_ADDRESS_POSTAL_CODE
string

Postal code of the legal address. Deprecated, used for compatibility

Yes

Yes

REG_ADDRESS_REGION
string

Region of the legal address. Deprecated, used for compatibility

Yes

Yes

REG_ADDRESS_PROVINCE
string

Province of the legal address. Deprecated, used for compatibility

Yes

Yes

REG_ADDRESS_COUNTRY
string

Country of the legal address. Deprecated, used for compatibility

Yes

Yes

REG_ADDRESS_COUNTRY_CODE
string

Country code of the legal address. Deprecated, used for compatibility

Yes

Yes

REG_ADDRESS_LOC_ADDR_ID
integer

Legal address identifier of the location address. Deprecated, used for compatibility

Yes

Yes

BANKING_DETAILS
string

Banking details

Yes

Yes

INDUSTRY
crm_status

Industry

Yes

Yes

EMPLOYEES
crm_status

Number of employees

Yes

Yes

CURRENCY_ID
crm_currency

Currency

Yes

Yes

REVENUE
double

Annual revenue

Yes

Yes

OPENED
char

Available to everyone

Yes

Yes

COMMENTS
string

Comments

Yes

Yes

HAS_PHONE
char

Check for the phone field being filled

Yes

No

HAS_EMAIL
char

Check for the e-mail field being filled

Yes

No

HAS_IMOL
char

Is there an open line

Yes

No

IS_MY_COMPANY
char

My company

Yes

Yes

ASSIGNED_BY_ID
user

Linked to user by ID

Yes

Yes

CREATED_BY_ID
user

Who created the company

Yes

No

MODIFY_BY_ID
user

Identifier of the author of the last change

Yes

No

DATE_CREATE
datetime

Creation date

Yes

No

DATE_MODIFY
datetime

Modification date

Yes

No

CONTACT_ID
string

Contact. Used only for linking to external sources.

Yes

Yes

LEAD_ID
crm_lead

Identifier of the lead associated with the company

Yes

No

ORIGINATOR_ID
string

Identifier of the data source. Used only for linking to external sources

Yes

Yes

ORIGIN_ID
string

Identifier of the item in the data source. Used only for linking to external sources

Yes

Yes

ORIGIN_VERSION
string

Original version. Used to protect data from accidental overwriting by an external system.

If the data was imported and not changed in the external system, such data can be edited in CRM without fear that the next export will overwrite the data

Yes

Yes

UTM_SOURCE
string

Advertising system (Google-Adwords, etc.)

Yes

Yes

UTM_MEDIUM
string

Type of traffic: CPC (ads), CPM (banners)

Yes

Yes

UTM_CAMPAIGN
string

Designation of the advertising campaign

Yes

Yes

UTM_CONTENT
string

Content of the campaign. For example, for contextual ads

Yes

Yes

UTM_TERM
string

Search condition of the campaign. For example, keywords for contextual advertising

Yes

Yes

PARENT_ID_xxx
crm_entity

Relationship fields.

If there are SPAs related to contacts on the account, for each such SPA there is a field that stores the relationship between this SPA and the contact. The field itself stores the identifier of the item of that SPA.

For example, the field PARENT_ID_153 — relationship with the SPA entityTypeId=153, stores the identifier of the item of this SPA related to the current contact

Yes

Yes

LAST_ACTIVITY_TIME
datetime

Time of the last activity.

Yes

No

LAST_ACTIVITY_BY
string

Identifier of the user responsible for the last activity in this lead (for example, who created a new deal in the lead)

Yes

No

PHONE
crm_multifield

Phone of the company. Multiple

Yes

Yes

EMAIL
crm_multifield

E-mail address. Multiple

Yes

Yes

WEB
crm_multifield

URLs of the company. Multiple

Yes

Yes

IM
crm_multifield

Messengers. Multiple

Yes

Yes

LINK
crm_multifield

Links. Multiple. Service

Yes

Yes

UF_CRM_xxx

User-defined fields

Yes

Yes

Name
type

Description

Read

Write

ID
integer

Identifier of the contact

Yes

No

HONORIFIC
crm_status

Addressing.

Values from the directory can be obtained using the method crm.status.list with the filter by ENTITY_ID=HONORIFIC

Yes

Yes

NAME
string

First name

Yes

Yes

SECOND_NAME
string

Middle name

Yes

Yes

LAST_NAME
string

Last name

Yes

Yes

PHOTO
file

Photo

Yes

Yes

BIRTHDATE
date

Date of birth

Yes

Yes

TYPE_ID
crm_status

Type of contact.

Values from the directory can be obtained using the method crm.status.list with the filter by ENTITY_ID=CONTACT_TYPE

Yes

Yes

SOURCE_ID
crm_status

Source.

Values from the directory can be obtained using the method crm.status.list with the filter by ENTITY_ID=SOURCE

Yes

Yes

SOURCE_DESCRIPTION
string

Additional information about the source

Yes

Yes

POST
string

Position

Yes

Yes

ADDRESS
string

Address (deprecated)

Yes

Yes

ADDRESS_2
string

Second line of the address (deprecated)

Yes

Yes

ADDRESS_CITY
string

City (deprecated)

Yes

Yes

ADDRESS_POSTAL_CODE
string

Postal code (deprecated)

Yes

Yes

ADDRESS_REGION
string

Region (deprecated)

Yes

Yes

ADDRESS_PROVINCE
string

Province (deprecated)

Yes

Yes

ADDRESS_COUNTRY
string

Country (deprecated)

Yes

Yes

ADDRESS_COUNTRY_CODE
string

Country code (deprecated)

Yes

Yes

ADDRESS_LOC_ADDR_ID
location

Identifier of the location address (deprecated)

Yes

Yes

COMMENTS
string

Comment. Supports bb-codes

Yes

Yes

OPENED
char

Available to everyone. Can take values Y or N. Considered in the work of access permissions for roles with the access level "All open"

Yes

Yes

EXPORT
char

Participates in the export of contacts. Can take values Y or N

Yes

Yes

HAS_PHONE
char

Phone is set. Can take values Y or N

Yes

No

HAS_EMAIL
char

E-mail is set. Can take values Y or N

Yes

No

HAS_IMOL
char

Open line is set. Can take values Y or N

Yes

No

ASSIGNED_BY_ID
user

Responsible

Yes

Yes

CREATED_BY_ID
user

Who created

Yes

No

MODIFY_BY_ID
user

Who modified

Yes

No

DATE_CREATE
datetime

Creation date

Yes

No

DATE_MODIFY
datetime

Modification date

Yes

No

COMPANY_ID
crm_company

Main company of the contact

Yes

Yes

COMPANY_IDS
crm_company

Linking the contact to companies. Multiple.

In the methods crm.contact.update and crm.contact.add, it is used to submit an array of companies.

In the methods crm.contact.list and crm.contact.get, this field does not exist, and crm.contact.company.items.get should be used to get the list of companies

Yes

Yes

LEAD_ID
crm_lead

Identifier of the lead associated with the contact

Yes

No

ORIGINATOR_ID
string

Identifier of the external system that is the source of data about this contact

Yes

Yes

ORIGIN_ID
string

Identifier of the contact in the external system

Yes

Yes

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 not changed in the external system, such data can be edited in CRM without fear that the next export will overwrite the data.

Yes

Yes

FACE_ID
integer

Link to faces from the faceid module

Yes

No

UTM_SOURCE
string

Advertising system (Google-Adwords, etc.)

Yes

Yes

UTM_MEDIUM
string

Type of traffic: CPC (ads), CPM (banners)

Yes

Yes

UTM_CAMPAIGN
string

Designation of the advertising campaign

Yes

Yes

UTM_CONTENT
string

Content of the campaign. For example, for contextual ads

Yes

Yes

UTM_TERM
string

Search condition of the campaign. For example, keywords for contextual advertising

Yes

Yes

PARENT_ID_...

Relationship fields.

If there are SPAs related to contacts on the account, for each such SPA there is a field that stores the relationship between this SPA and the contact. The field itself stores the identifier of the item of that SPA.

For example, the field PARENT_ID_153 — relationship with the SPA entityTypeId=153, stores the identifier of the item of this SPA related to the current contact

Yes

Yes

LAST_ACTIVITY_TIME
datetime

Date of the last activity in the timeline

Yes

No

LAST_ACTIVITY_BY
user

Author of the last activity in the timeline

Yes

No

PHONE
crm_multifield

Phones. Multiple

Yes

Yes

EMAIL
crm_multifield

E-mail. Multiple

Yes

Yes

WEB
crm_multifield

Websites. Multiple

Yes

Yes

IM
crm_multifield

Messengers. Multiple

Yes

Yes

LINK
crm_multifield

Links. Multiple. Service

Yes

Yes

UF_CRM_xxx

User-defined fields. For example, UF_CRM_25534736.

Depending on the portal settings, contacts may have a set of user-defined fields of specific types. A user-defined field can be added to a contact using the method crm.contact.userfield.add

Name
type

Description

Read

Write

ID
integer

Identifier of the requisite.

Can be obtained using the method crm.requisite.list.

Created automatically and unique within the portal

Yes

No

ENTITY_TYPE_ID
integer

Identifier of the parent entity type. Currently, this can only be:

• 3 — contact
• 4 — company

Identifiers of all CRM entity types are returned by the method crm.enum.ownertype

Yes

Yes

ENTITY_ID
integer

Identifier of the parent entity (contact or company).

The identifier can be obtained using the method crm.company.list for a company and the method crm.contact.list for a contact

Yes

Yes

PRESET_ID
integer

Identifier of the requisites template.

Template identifiers can be obtained using the method crm.requisite.preset.list

Yes

Yes

DATE_CREATE
datetime

Creation date

Yes

No

DATE_MODIFY
datetime

Modification date

Yes

No

CREATED_BY_ID
user

Identifier of the user who created the requisite

Yes

No

MODIFY_BY_ID
user

Identifier of the user who modified the requisite

Yes

No

NAME
string

Name of the requisite

Yes

Yes

CODE
string

Symbolic code of the requisite

Yes

Yes

XML_ID
string

External key, used for exchange operations.

Identifier of the object in the external information database.

The purpose of the field may change by the end developer

Yes

Yes

ORIGINATOR_ID
string

Identifier of the external information database.

The purpose of the field may change by the end developer

Yes

Yes

ACTIVE
char

Activity indicator.

Values Y or N are used.

Currently, the field does not actually affect anything

Yes

Yes

ADDRESS_ONLY
char

Indicator of the state when the requisite is used only for storing the address.

Values Y or N are used. When set to Y, the requisites are not displayed in the entity card, but the address is displayed

Yes

Yes

SORT
integer

Sorting. Order in the list of entity requisites when there are multiple

Yes

Yes

RQ_NAME
string

Full name

Yes

Yes

RQ_FIRST_NAME
string

First name

Yes

Yes

RQ_LAST_NAME
string

Last name

Yes

Yes

RQ_SECOND_NAME
string

Middle name

Yes

Yes

RQ_COMPANY_ID
string

Identifier of the organization

Yes

Yes

RQ_COMPANY_NAME
string

Short name of the organization

Yes

Yes

RQ_COMPANY_FULL_NAME
string

Full name of the organization

Yes

Yes

RQ_COMPANY_REG_DATE
string

Date of state registration

Yes

Yes

RQ_DIRECTOR
string

General director

Yes

Yes

RQ_ACCOUNTANT
string

Chief accountant

Yes

Yes

RQ_CEO_NAME
string

Full name of the first leader

Yes

Yes

RQ_CEO_WORK_POS
string

Position of the first leader

Yes

Yes

RQ_CONTACT
string

Contact person

Yes

Yes

RQ_EMAIL
string

E-Mail

Yes

Yes

RQ_PHONE
string

Phone

Yes

Yes

RQ_FAX
string

Fax

Yes

Yes

RQ_IDENT_TYPE
crm_status

Method of identification

Yes

Yes

RQ_IDENT_DOC
string

Type of document

Yes

Yes

RQ_IDENT_DOC_SER
string

Series

Yes

Yes

RQ_IDENT_DOC_NUM
string

Number

Yes

Yes

RQ_IDENT_DOC_PERS_NUM
string

Personal number

Yes

Yes

RQ_IDENT_DOC_DATE
string

Date of issue

Yes

Yes

RQ_IDENT_DOC_ISSUED_BY
string

Issued by

Yes

Yes

RQ_IDENT_DOC_DEP_CODE
string

Department code

Yes

Yes

RQ_INN
string

Taxpayer identification number

Yes

Yes

RQ_KPP
string

Tax registration reason code

Yes

Yes

RQ_USRLE
string

Commercial register number (for country DE)

Yes

Yes

RQ_IFNS
string

Tax authority

Yes

Yes

RQ_OGRN
string

Primary state registration number

Yes

Yes

RQ_OGRNIP
string

Primary state registration number for individual entrepreneurs

Yes

Yes

RQ_OKPO
string

National classification of enterprises and organizations

Yes

Yes

RQ_OKTMO
string

Municipal classification of territories

Yes

Yes

RQ_OKVED
string

All-Russian classifier of economic activities

Yes

Yes

RQ_EDRPOU
string

Unified State Register of Enterprises and Organizations

Yes

Yes

RQ_DRFO
string

Taxpayer registration number

Yes

Yes

RQ_KBE
string

Classification of economic activities

Yes

Yes

RQ_IIN
string

Individual identification number

Yes

Yes

RQ_BIN
string

Business identification number

Yes

Yes

RQ_ST_CERT_SER
string

Series of the state registration certificate

Yes

Yes

RQ_ST_CERT_NUM
string

Number of the state registration certificate

Yes

Yes

RQ_ST_CERT_DATE
string

Date of the state registration certificate

Yes

Yes

RQ_VAT_PAYER
char

VAT payer (for country UA).

Values Y or N are used

Yes

Yes

RQ_VAT_ID
string

VAT ID (identification number of the VAT payer)

Yes

Yes

RQ_VAT_CERT_SER
string

Series of the VAT certificate

Yes

Yes

RQ_VAT_CERT_NUM
string

Number of the VAT certificate

Yes

Yes

RQ_VAT_CERT_DATE
string

Date of the VAT certificate

Yes

Yes

RQ_RESIDENCE_COUNTRY
string

Country of residence

Yes

Yes

RQ_BASE_DOC
string

Basis for action

Yes

Yes

RQ_REGON
string

REGON (for country PL)

Yes

Yes

RQ_KRS
string

KRS (for country PL)

Yes

Yes

RQ_PESEL
string

PESEL (for country PL)

Yes

Yes

RQ_LEGAL_FORM
string

Legal form (for country FR)

Yes

Yes

RQ_SIRET
string

SIRET number (for country FR)

Yes

Yes

RQ_SIREN
string

SIREN number (for country FR)

Yes

Yes

RQ_CAPITAL
string

Share capital (for country FR)

Yes

Yes

RQ_RCS
string

RCS (for country FR)

Yes

Yes

RQ_CNPJ
string

CNPJ (for country BR)

Yes

Yes

RQ_STATE_REG
string

State registration (IE) (for country BR)

Yes

Yes

RQ_MNPL_REG
string

Municipal registration (IM) (for country BR)

Yes

Yes

RQ_CPF
string

CPF (for country BR)

Yes

Yes

UF_CRM_...

User-defined fields. For example, UF_CRM_1694526604.

Requisites may have a set of user-defined fields with types: string, boolean, double, datetime.

A user-defined field can be added to requisites using the method crm.requisite.userfield.add

Yes

Yes

Name
type

Description

Read

Write

ID
integer

Identifier of the bank detail. Created automatically and unique within the portal

Yes

No

ENTITY_TYPE_ID
integer

Identifier of the parent object type. Can only be Requisite (value 8).

Identifiers of object types are returned by the method crm.enum.ownertype

Yes

No

ENTITY_ID
integer

Identifier of the parent object

Yes

Yes

COUNTRY_ID
integer

Identifier of the country corresponding to the set of bank detail fields (see method crm.requisite.preset.countries for available values).

The country code of the bank detail matches the country code in the linked requisites template, the identifier of which is specified in the field ENTITY_ID

Yes

Yes

DATE_CREATE
datetime

Creation date

Yes

No

DATE_MODIFY
datetime

Modification date

Yes

No

CREATED_BY_ID
user

Identifier of the user who created the requisite

Yes

No

MODIFY_BY_ID
user

Identifier of the user who modified the requisite

Yes

No

NAME^*
string

Name of the bank detail

Yes

Yes

CODE
string

Symbolic code of the requisite

Yes

Yes

XML_ID
string

External key. Used for exchange operations. Identifier of the object in the external information database.

The purpose of the field may change 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

Yes

Yes

ACTIVE
char

Activity indicator. Values Y or N are used.

Currently, the field does not actually affect anything

Yes

Yes

SORT
integer

Sorting

Yes

Yes

RQ_BANK_NAME
string

Name of the bank

Yes

Yes

RQ_BANK_ADDR
string

Address of the bank

Yes

Yes

RQ_BANK_CODE
string

Bank code (for country BR)

Yes

Yes

RQ_BANK_ROUTE_NUM
string

Bank Routing Number

Yes

Yes

RQ_BIK
string

BIK

Yes

Yes

RQ_CODEB
string

Bank Code (for country FR)

Yes

Yes

RQ_CODEG
string

Branch Code (for country FR)

Yes

Yes

RQ_RIB
string

RIB Key (for country FR)

Yes

Yes

RQ_MFO
string

MFO

Yes

Yes

RQ_ACC_NAME
string

Bank Account Holder Name

Yes

Yes

RQ_ACC_NUM
string

Bank Account Number

Yes

Yes

RQ_ACC_TYPE
string

Account Type (for country BR)

Yes

Yes

RQ_AGENCY_NAME
string

Agency (for country BR)

Yes

Yes

RQ_IIK
string

IIK

Yes

Yes

RQ_ACC_CURRENCY
string

Currency of the account

Yes

Yes

RQ_COR_ACC_NUM
string

Correspondent account

Yes

Yes

RQ_IBAN
string

IBAN

Yes

Yes

RQ_SWIFT
string

SWIFT

Yes

Yes

RQ_BIC
string

BIC

Yes

Yes

COMMENTS
string

Comment

Yes

Yes

ORIGINATOR_ID
string

Identifier of the external information database. The purpose of the field may change by the end developer

Yes

Yes

Name

Description

Read

Write

ID
integer

Identifier of the requisite. Created automatically and unique within the portal

Yes

No

ENTITY_TYPE_ID
integer

Identifier of the parent object type.

Identifiers of CRM object types are returned by the method crm.enum.ownertype

Yes

Yes

COUNTRY_ID
integer

Identifier of the country corresponding to the set of fields of the requisites template (for available values see method crm.requisite.preset.countries)

Yes

Yes

DATE_CREATE
datetime

Creation date

Yes

No

DATE_MODIFY
datetime

Modification date. Contains an empty string if the template has not been changed since creation

Yes

No

CREATED_BY_ID
user

Identifier of the user who created the requisite

Yes

No

MODIFY_BY_ID
user

Identifier of the user who modified the requisite

Yes

No

NAME
string

Name of the requisite

Yes

Yes

XML_ID
string

External key. Used for exchange operations. Identifier of the object in the external information database.

The purpose of the field may change 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.

Values of the form #CRM_REQUISITE_PRESET_DEF_... are reserved in CRM for identifying templates that are used by default. These identifiers should not be used for your purposes, as this may lead to a violation of logic

Yes

Yes

ACTIVE
char

Activity indicator. Values Y or N are used. Determines the availability of the template in the selection list when adding requisites

Yes

Yes

SORT
integer

Sorting

Yes

Yes

Name
type

Description

Read

Write

ID
integer

Identifier of the field. Created automatically and unique within the template

Yes

No

FIELD_NAME
string

Name of the field

Yes

Yes

FIELD_TITLE
string

Alternative name of the field for the requisite.

The alternative name is displayed in various forms for filling requisites. Depending on the specific form, the alternative name may or may not be used

Yes

Yes

SORT
integer

Sorting. Order in the list of template fields

Yes

Yes

IN_SHORT_LIST
char

Show in the short list. Deprecated field, currently not used. Kept for backward compatibility. Can take values Y or N

Yes

Yes

Name

Description

Read

Write

TYPE_ID
integer

Identifier of the address type. Element of the enumeration "Address Type".

Elements of the enumeration "Address Type" can be obtained using the method crm.enum.addresstype

Yes

Yes

ENTITY_TYPE_ID
integer

Identifier of the parent object type.

Identifiers of object types can be obtained using the method crm.enum.ownertype.

Yes

Yes

ENTITY_ID
string

Identifier of the parent object

Yes

Yes

ADDRESS_1
string

Street, house, building

Yes

Yes

ADDRESS_2
string

Apartment / office

Yes

Yes

CITY
string

City

Yes

Yes

POSTAL_CODE
string

Postal code

Yes

Yes

REGION
string

Region

Yes

Yes

PROVINCE
string

Province

Yes

Yes

COUNTRY
string

Country

Yes

Yes

COUNTRY_CODE
string

Country code

Yes

Yes

LOC_ADDR_ID
integer

Identifier of the location address.

This field contains the identifier of the address object in the Location module, linked to the CRM address object. Each CRM address corresponds to an address object in the location module. This can be used to copy an existing address in CRM with location information that is not in the CRM address fields.

If the identifier of the location module address is specified when creating an address, a copy of the location address is created 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.

If at least one string field was specified, then 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 will occur when updating the address

Yes

Yes

ANCHOR_TYPE_ID
integer

Identifier of the type of the main parent object.

This field is for service use. The value is automatically filled when adding an address.

Identifiers of object types can be obtained using the method crm.enum.ownertype.

This field contains the identifier of the type of the parent requisite object (company or contact) if the address is linked to the requisite. If the address is linked to a lead, then this value will be the identifier of the lead

Yes

No

ANCHOR_ID
integer

This field is for service use. The value is automatically filled when adding an address.

This field contains the identifier of the parent requisite object (company or contact) if the address is linked to the requisite. If the address is linked to a lead, then this value will be the identifier of the lead

Yes

No

Name

Description

Read

Write

ID
integer

Identifier of the activity

Yes

No

OWNER_ID
integer

Identifier of the owner, immutable

Yes

Yes

OWNER_TYPE_ID
crm.enum.ownertype

Type of owner, immutable

Yes

Yes

TYPE_ID
crm_enum_activitytype

Type, immutable

Yes

Yes

PROVIDER_ID
string

Identifier of the provider

Yes

Yes

PROVIDER_TYPE_ID
string

Identifier of the provider type

Yes

Yes

PROVIDER_GROUP_ID
string

Type of connector

Yes

Yes

ASSOCIATED_ENTITY_ID
integer

Identifier of the entity associated with the activity

Yes

No

SUBJECT
string

Subject, title of the activity

Yes

Yes

START_TIME
datetime

Start time of execution

Yes

Yes

END_TIME
datetime

End time

Yes

Yes

DEADLINE
datetime

Deadline. The field is not set directly; the value is taken from START_TIME for calls and meetings and from END_TIME for tasks

Yes

Yes

COMPLETED
char

Completed

Yes

Yes

STATUS
crm_enum_activitystatus

Status

Yes

Yes

RESPONSIBLE_ID
user

Responsible

Yes

Yes

PRIORITY
crm.enum.activitypriority

Importance

Yes

Yes

NOTIFY_TYPE
crm.enum.activitynotifytype

Type of notifications

Yes

Yes

NOTIFY_VALUE
integer

Notification parameter

Yes

Yes

DESCRIPTION
string

Description

Yes

Yes

DESCRIPTION_TYPE
crm.enum.contenttype

Type of description

Yes

Yes

DIRECTION
crm.enum.activitydirection

Direction of the activity: incoming/outgoing. Relevant for calls and emails, not used for meetings

Yes

Yes

LOCATION
string

Location

Yes

Yes

CREATED
datetime

Creation date

Yes

No

AUTHOR_ID
user

Creator of the activity

Yes

Yes

LAST_UPDATED
datetime

Date of the last update

Yes

No

EDITOR_ID
user

Who modified

Yes

No

SETTINGS
object

Settings

Yes

Yes

ORIGIN_ID
string

Identifier of the item in the data source. Used only for linking to external sources

Yes

Yes

ORIGINATOR_ID
string

Identifier of the data source. Used only for linking to external sources

Yes

Yes

RESULT_STATUS
integer

Unused field, remains for compatibility

Yes

Yes

RESULT_STREAM
integer

Report statistics

Yes

Yes

RESULT_SOURCE_ID
string

Unused field, remains for compatibility

Yes

Yes

PROVIDER_PARAMS
object

Provider parameters

Yes

Yes

PROVIDER_DATA
string

Provider data

Yes

Yes

RESULT_MARK
integer

Unused field, remains for compatibility

Yes

Yes

RESULT_VALUE
double

Unused field, remains for compatibility

Yes

Yes

RESULT_SUM
double

Unused field, remains for compatibility

Yes

Yes

RESULT_CURRENCY_ID
string

Unused field, remains for compatibility

Yes

Yes

AUTOCOMPLETE_RULE
integer

Autocomplete

Yes

Yes

BINDINGS
crm_activity_binding

Bindings

Yes

No

COMMUNICATIONS
crm_activity_communication

Communication channel. Multiple, required

Yes

Yes

FILES
diskfile

Added files. Multiple

Yes

Yes

WEBDAV_ELEMENTS
diskfile

Added files. Multiple. Deprecated, kept for compatibility

Yes

Yes

IS_INCOMING_CHANNEL
char

Is the activity incoming, that is, created as a result of an incoming client request in the communication channel

Yes

No