Fields of Main CRM Objects

Name
type

Description

Read

Write

ID
integer

Deal identifier

Yes

No

TITLE
string

Name

Yes

Yes

TYPE_ID
crm_status

Deal type. Used only for linking to an external source.

Yes

Yes

CATEGORY_ID
crm_category

Direction identifier. Immutable. If this field is not passed when creating a deal, the deal will be created in the general direction.

Yes

Yes

STAGE_ID
crm_status

Stage identifier. Possible values:

• NEW — new deal
• PREPARATION — document preparation
• PREPAYMENT_INVOICE — invoice sending
• EXECUTING — in progress
• FINAL_INVOICE — final invoice
• WON — won
• >LOSE — lost, no reason analysis required
• APOLOGY — lost, reason analysis required

Yes

Yes

STAGE_SEMANTIC_ID
string

Name. Read-only. In a sense, generalizes the values of the deal identifier STAGE_ID:

• P — for stages with identifiers NEW, PREPARATION, PREPAYMENT_INVOICE, EXECUTING, and FINAL_INVOICE
• S — for the stage with identifier WON
• F — for stages with identifiers >LOSE and APOLOGY

Yes

No

IS_NEW
char

New deal flag (deals in the first stage)

Yes

No

IS_RECURRING
char

Recurring deal template flag. If Y is set, then it is a template, not a deal

Yes

Yes

IS_RETURN_CUSTOMER
char

Repeat lead indicator

Yes

Yes

IS_REPEATED_APPROACH
char

Repeat Salutation

Yes

Yes

PROBABILITY
integer

Probability

Yes

Yes

CURRENCY_ID
crm_currency

Deal currency identifier

Yes

Yes

OPPORTUNITY
double

Amount

Yes

Yes

IS_MANUAL_OPPORTUNITY
char

Repeat Salutation

Yes

Yes

TAX_VALUE
double

Tax rate

Yes

Yes

COMPANY_ID
crm_company

Linked company identifier

Yes

Yes

CONTACT_ID
crm_contact

Linked contact identifier. Deprecated. Retained for compatibility

Yes

Yes

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

Yes

Yes

QUOTE_ID
crm_quote

Quote identifier. Read-only. Deprecated. Use the crm.quote.list method with a filter by deal

Yes

No

BEGINDATE
date

Start date

Yes

Yes

CLOSEDATE
date

End date

Yes

Yes

OPENED
char

Available to all

Yes

Yes

CLOSED
char

Is the deal completed

Yes

Yes

COMMENTS
string

Comments

Yes

Yes

ASSIGNED_BY_ID
user

Linked to user by ID

Yes

Yes

CREATED_BY_ID
user

Created by user

Yes

No

MODIFY_BY_ID
user

Last change author identifier

Yes

No

MOVED_BY_ID
user

Author identifier who moved the item to the current stage

Yes

No

DATE_CREATE
datetime

Create date

Yes

No

DATE_MODIFY
datetime

Change date

Yes

No

MOVED_TIME
datetime

Date the item was moved to the current stage

Yes

No

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.

Yes

Yes

SOURCE_DESCRIPTION
string

Additional information about the source. Text field.

Yes

Yes

ADDITIONAL_INFO
string

Additional information.

Yes

Yes

LEAD_ID
crm_lead

Linked lead identifier.

Yes

No

LOCATION_ID
location

Customer location. Service field, not recommended for use.

Yes

Yes

ORIGINATOR_ID
string

Data source identifier. Used only for linking to an external source.

Yes

Yes

ORIGIN_ID
string

Item identifier in the data source. Used only for linking to an external source.

Yes

Yes

UTM_SOURCE
string

Ad system (Search Ads, Display Ads, and others).

Yes

Yes

UTM_MEDIUM
string

Traffic type: CPC (ads), CPM (banners).

Yes

Yes

UTM_CAMPAIGN
string

Advertising campaign designation.

Yes

Yes

UTM_CONTENT
string

Campaign contents. For example, for contextual ads.

Yes

Yes

UTM_TERM
string

Campaign search condition. For example, contextual advertising keywords.

Yes

Yes

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.

Yes

Yes

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).

Yes

Yes

LAST_ACTIVITY_TIME
datetime

Last activity time.

Yes

Yes

UF_CRM_xxx

Custom fields

Yes

Yes

Name
type

Description

Read

Write

ID
integer

Integer lead identifier.

Yes

No

TITLE
string

Lead name.

Yes

Yes

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.

Yes

Yes

NAME
string

Contact first name.

Yes

Yes

SECOND_NAME
string

Contact middle name.

Yes

Yes

LAST_NAME
string

Contact last name.

Yes

Yes

BIRTHDATE
date

Date of birth.

Yes

Yes

COMPANY_TITLE
string

Name of the company linked to the lead.

Yes

Yes

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.

Yes

Yes

SOURCE_DESCRIPTION
string

Source description.

Yes

Yes

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.

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 is being processed.

Yes

No

POST
string

Job title.

Yes

Yes

ADDRESS
string

Contact address.

Yes

Yes

ADDRESS_2
string

Address line 2. In some countries, it is common 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

District

Yes

Yes

ADDRESS_PROVINCE
string

Region

Yes

Yes

ADDRESS_COUNTRY
string

Country

Yes

Yes

ADDRESS_COUNTRY_CODE
string

Country code

Yes

Yes

ADDRESS_LOC_ADDR_ID
integer

Address identifier from the locations module

Yes

Yes

CURRENCY_ID
crm_currency

Currency identifier

Yes

Yes

OPPORTUNITY
double

Estimated amount

Yes

Yes

IS_MANUAL_OPPORTUNITY
char

Manual amount calculation flag. Allowed values Y or N

Yes

Yes

OPENED
char

Available to all. Allowed values Y or N

Yes

Yes

COMMENTS
string

Comments

Yes

Yes

HAS_PHONE
char

phone field completion flag. Allowed values Y or N

Yes

No

HAS_EMAIL
char

Email field completion flag. Allowed values Y or N

Yes

No

HAS_IMOL
char

Linked Open Channel presence flag. Allowed values Y or N

Yes

No

ASSIGNED_BY_ID
user

Identifier of the user assigned to the lead

Yes

Yes

CREATED_BY_ID
user

Identifier of the user who created the lead

Yes

No

MODIFY_BY_ID
user

Last change author identifier

Yes

No

MOVED_BY_ID
user

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

Yes

No

DATE_CREATE
datetime

Create date

Yes

No

DATE_MODIFY
datetime

Change date

Yes

No

MOVED_TIME
datetime

Date the item was moved to the current stage

Yes

No

COMPANY_ID
crm_company

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

Yes

Yes

CONTACT_ID
crm_contact

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

Yes

Yes

CONTACT_IDS
crm_contact

Linked contact identifier. Multiple.

When using crm.lead.update and crm.lead.add, you can pass an array of contacts

Yes

Yes

IS_RETURN_CUSTOMER
char

Repeat lead indicator. Allowed values Y or N

Yes

No

DATE_CLOSED
datetime

Closing date

Yes

No

ORIGINATOR_ID
string

Data source identifier. Used only for linking to an external source.

Yes

Yes

ORIGIN_ID
string

Item identifier in the data source. Used only for linking to an external source.

Yes

Yes

UTM_SOURCE
string

Ad system (Search Ads, Display Ads, and others).

Yes

Yes

UTM_MEDIUM
string

Traffic type: CPC (ads), CPM (banners).

Yes

Yes

UTM_CAMPAIGN
string

Advertising campaign designation.

Yes

Yes

UTM_CONTENT
string

Campaign contents. For example, for contextual ads.

Yes

Yes

UTM_TERM
string

Campaign search condition. For example, contextual advertising keywords.

Yes

Yes

LAST_ACTIVITY_TIME
datetime

Last activity time.

Yes

No

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).

Yes

No

PHONE
crm_multifield

Contact phone. Multiple

Yes

Yes

EMAIL
crm_multifield

Email address. Multiple

Yes

Yes

WEB
crm_multifield

Lead URL resources. Multiple

Yes

Yes

IM
crm_multifield

Messengers. Multiple

Yes

Yes

LINK
crm_multifield

Links. Multiple. Service

Yes

Yes

UF_CRM_xxx

Custom fields

Yes

Yes

Name
type

Description

Read

Write

ID
integer

Company identifier

Yes

No

TITLE
string

Name. Required

Yes

Yes

COMPANY_TYPE
crm_status

Company type

Yes

Yes

LOGO
file

Logo

Yes

Yes

ADDRESS
string

Company address

Yes

Yes

ADDRESS_2
string

Address line 2. In some countries, it is common 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

District

Yes

Yes

ADDRESS_PROVINCE
string

Region

Yes

Yes

ADDRESS_COUNTRY
string

Country

Yes

Yes

ADDRESS_COUNTRY_CODE
string

Country code

Yes

Yes

ADDRESS_LOC_ADDR_ID
integer

Location address identifier

Yes

Yes

ADDRESS_LEGAL
string

Legal address

Yes

Yes

REG_ADDRESS
string

Company legal address. Obsolete, used for compatibility

Yes

Yes

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

Yes

Yes

REG_ADDRESS_CITY
string

Legal address city. Obsolete, used for compatibility

Yes

Yes

REG_ADDRESS_POSTAL_CODE
string

Legal address postal code. Obsolete, used for compatibility

Yes

Yes

REG_ADDRESS_REGION
string

Legal address district. Obsolete, used for compatibility

Yes

Yes

REG_ADDRESS_PROVINCE
string

Legal address region. Obsolete, used for compatibility

Yes

Yes

REG_ADDRESS_COUNTRY
string

Legal address country. Obsolete, used for compatibility

Yes

Yes

REG_ADDRESS_COUNTRY_CODE
string

Legal address country code. Obsolete, used for compatibility

Yes

Yes

REG_ADDRESS_LOC_ADDR_ID
integer

Legal address location identifier. Obsolete, used for compatibility

Yes

Yes

BANKING_DETAILS
string

Bank Company 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 turnover

Yes

Yes

OPENED
char

Available to all

Yes

Yes

COMMENTS
string

Comments

Yes

Yes

HAS_PHONE
char

Phone field completion check

Yes

No

HAS_EMAIL
char

Email field completion check

Yes

No

HAS_IMOL
char

Is Open Channel set

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

Created by

Yes

No

MODIFY_BY_ID
user

Last change author identifier

Yes

No

DATE_CREATE
datetime

Create date

Yes

No

DATE_MODIFY
datetime

Change date

Yes

No

CONTACT_ID
string

Contact. Used only for linking to an external source.

Yes

Yes

LEAD_ID
crm_lead

Identifier of the lead linked to the company

Yes

No

ORIGINATOR_ID
string

Data source identifier. Used only for linking to an external source.

Yes

Yes

ORIGIN_ID
string

Item identifier in the data source. Used only for linking to an external source.

Yes

Yes

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

Yes

Yes

UTM_SOURCE
string

Ad system (Search Ads, Display Ads, and others).

Yes

Yes

UTM_MEDIUM
string

Traffic type: CPC (ads), CPM (banners).

Yes

Yes

UTM_CAMPAIGN
string

Advertising campaign designation.

Yes

Yes

UTM_CONTENT
string

Campaign contents. For example, for contextual ads.

Yes

Yes

UTM_TERM
string

Campaign search condition. For example, contextual advertising keywords.

Yes

Yes

PARENT_ID_xxx
crm_entity

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

Yes

Yes

LAST_ACTIVITY_TIME
datetime

Last activity time.

Yes

No

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).

Yes

No

PHONE
crm_multifield

Company phone. Multiple

Yes

Yes

EMAIL
crm_multifield

Email address. Multiple

Yes

Yes

WEB
crm_multifield

Company resource URLs. Multiple

Yes

Yes

IM
crm_multifield

Messengers. Multiple

Yes

Yes

LINK
crm_multifield

Links. Multiple. Service

Yes

Yes

Name
type

Description

Read

Write

ID
integer

Contact identifier

Yes

No

HONORIFIC
crm_status

Salutation.

You can obtain the dictionary values using the crm.status.list method with a 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

Contact type.

You can obtain the dictionary values using the crm.status.list method with a filter by ENTITY_ID=CONTACT_TYPE

Yes

Yes

SOURCE_ID
crm_status

Source.

You can obtain the dictionary values using the crm.status.list method with a filter by ENTITY_ID=SOURCE

Yes

Yes

SOURCE_DESCRIPTION
string

Additional info about the source

Yes

Yes

POST
string

Job title.

Yes

Yes

ADDRESS
string

Address (deprecated)

Yes

Yes

ADDRESS_2
string

Address line 2 (deprecated)

Yes

Yes

ADDRESS_CITY
string

City (deprecated)

Yes

Yes

ADDRESS_POSTAL_CODE
string

Postal code (deprecated)

Yes

Yes

ADDRESS_REGION
string

District (deprecated)

Yes

Yes

ADDRESS_PROVINCE
string

Region (deprecated)

Yes

Yes

ADDRESS_COUNTRY
string

Country (deprecated)

Yes

Yes

ADDRESS_COUNTRY_CODE
string

Country code (deprecated)

Yes

Yes

ADDRESS_LOC_ADDR_ID
location

Location address identifier (deprecated)

Yes

Yes

COMMENTS
string

Comment. Supports bb-codes

Yes

Yes

OPENED
char

Available to all. Can take values Y or N. Taken into account in access rights for roles with "All open" access level

Yes

Yes

EXPORT
char

Include in contact export. 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 Channel is set. Can take values Y or N

Yes

No

ASSIGNED_BY_ID
user

assigned user

Yes

Yes

CREATED_BY_ID
user

Created by

Yes

No

MODIFY_BY_ID
user

Changed by

Yes

No

DATE_CREATE
datetime

Create date

Yes

No

DATE_MODIFY
datetime

Change date

Yes

No

COMPANY_ID
crm_company

Primary company of the contact

Yes

Yes

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

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 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.

Yes

Yes

FACE_ID
integer

Link to persons from the faceid module

Yes

No

UTM_SOURCE
string

Ad system (Search Ads, Display Ads, and others).

Yes

Yes

UTM_MEDIUM
string

Traffic type: CPC (ads), CPM (banners).

Yes

Yes

UTM_CAMPAIGN
string

Advertising campaign designation.

Yes

Yes

UTM_CONTENT
string

Campaign contents. For example, for contextual ads.

Yes

Yes

UTM_TERM
string

Campaign search condition. For example, contextual advertising keywords.

Yes

Yes

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

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

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

Name
type

Description

Read

Write

ID
integer

Identifier of the requisite.

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

Created automatically and is 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

The crm.enum.ownertype method returns identifiers for all CRM entity types

Yes

Yes

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.

Yes

Yes

PRESET_ID
integer

Requisite template identifier.

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

Yes

Yes

DATE_CREATE
datetime

Create date

Yes

No

DATE_MODIFY
datetime

Change 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 changed the requisite.

Yes

No

NAME
string

Requisite name.

Yes

Yes

CODE
string

Character code of the requisite.

Yes

Yes

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.

Yes

Yes

ORIGINATOR_ID
string

External information base identifier.

The purpose of the field may be changed by the end developer.

Yes

Yes

ACTIVE
char

Activity flag.

Uses values Y or N.

Currently, the field does not actually affect anything.

Yes

Yes

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.

Yes

Yes

SORT
integer

Sorting. The order in the entity's requisite list when there are multiple requisites.

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

Organization identifier

Yes

Yes

RQ_COMPANY_NAME
string

Abbreviated organization name

Yes

Yes

RQ_COMPANY_FULL_NAME
string

Full organization name

Yes

Yes

RQ_COMPANY_REG_DATE
string

State registration date

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 manager

Yes

Yes

RQ_CEO_WORK_POS
string

Position of the first manager

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

Identification method

Yes

Yes

RQ_IDENT_DOC
string

Document type

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

TIN

Yes

Yes

RQ_KPP
string

KPP

Yes

Yes

RQ_USRLE
string

Handelsregisternummer (for country DE)

Yes

Yes

RQ_IFNS
string

IFNS

Yes

Yes

RQ_OGRN
string

OGRN

Yes

Yes

RQ_OGRNIP
string

OGRNIP

Yes

Yes

RQ_OKPO
string

OKPO

Yes

Yes

RQ_OKTMO
string

OKTMO

Yes

Yes

RQ_OKVED
string

OKVED

Yes

Yes

RQ_EDRPOU
string

EDRPOU

Yes

Yes

RQ_DRFO
string

DRFO

Yes

Yes

RQ_KBE
string

KBE

Yes

Yes

RQ_IIN
string

IIN

Yes

Yes

RQ_BIN
string

BIN

Yes

Yes

RQ_ST_CERT_SER
string

State registration certificate series

Yes

Yes

RQ_ST_CERT_NUM
string

State registration certificate number

Yes

Yes

RQ_ST_CERT_DATE
string

State registration certificate date

Yes

Yes

RQ_VAT_PAYER
char

VAT Payer (for country UA).

Uses values Y or N

Yes

Yes

RQ_VAT_ID
string

VAT ID (Value Added Tax identification number)

Yes

Yes

RQ_VAT_CERT_SER
string

VAT certificate series

Yes

Yes

RQ_VAT_CERT_NUM
string

VAT certificate number

Yes

Yes

RQ_VAT_CERT_DATE
string

VAT certificate date

Yes

Yes

RQ_RESIDENCE_COUNTRY
string

Country of residence

Yes

Yes

RQ_BASE_DOC
string

Basis of 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_...

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

Yes

Yes

Name
type

Description

Read

Write

ID
integer

Bank requisite identifier. Created automatically and is unique within the portal

Yes

No

ENTITY_TYPE_ID
integer

Parent object type identifier. Can only be Attribute (value 8).

The method crm.enum.ownertype returns object type identifiers

Yes

No

ENTITY_ID
integer

Parent object identifier

Yes

Yes

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

Yes

Yes

DATE_CREATE
datetime

Create date

Yes

No

DATE_MODIFY
datetime

Change 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 changed the requisite

Yes

No

NAME^*
string

Bank requisite name

Yes

Yes

CODE
string

Character code of the requisite.

Yes

Yes

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

Yes

Yes

ACTIVE
char

Activity flag. Uses values Y or N.

Currently, the field does not actually affect anything

Yes

Yes

SORT
integer

Sorting

Yes

Yes

RQ_BANK_NAME
string

Bank name

Yes

Yes

RQ_BANK_ADDR
string

Bank address

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

BIC

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

Account currency

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

External information base identifier. The purpose of the field may be changed by the end developer

Yes

Yes

Name

Description

Read

Write

ID
integer

Requisite identifier. Created automatically and is unique within the portal

Yes

No

ENTITY_TYPE_ID
integer

Parent object type identifier.

The method crm.enum.ownertype returns CRM object type identifiers

Yes

Yes

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)

Yes

Yes

DATE_CREATE
datetime

Create date

Yes

No

DATE_MODIFY
datetime

Modification date. Contains an empty string if the template has not 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 changed the requisite

Yes

No

NAME
string

Requisite name.

Yes

Yes

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.

Yes

Yes

ACTIVE
char

Activity flag. Uses values Y or N. 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

Field identifier. Created automatically and is unique within the template.

Yes

No

FIELD_NAME
string

Field name

Yes

Yes

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.

Yes

Yes

SORT
integer

Sorting. The order in the template field list.

Yes

Yes

IN_SHORT_LIST
char

Show in 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

Address type identifier. "Address type" enumeration item.

"Address type" enumeration items can be obtained using the crm.enum.addresstype method.

Yes

Yes

ENTITY_TYPE_ID
integer

Parent object type identifier.

Object type identifiers can be obtained using the crm.enum.ownertype method.

Yes

Yes

ENTITY_ID
string

Parent object identifier

Yes

Yes

ADDRESS_1
string

Street, house, building, structure

Yes

Yes

ADDRESS_2
string

Apartment / office

Yes

Yes

CITY
string

City

Yes

Yes

POSTAL_CODE
string

Postal code

Yes

Yes

REGION
string

District

Yes

Yes

PROVINCE
string

Region

Yes

Yes

COUNTRY
string

Country

Yes

Yes

COUNTRY_CODE
string

Country code

Yes

Yes

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.

Yes

Yes

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.

Yes

No

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.

Yes

No

Name

Description

Read

Write

ID
integer

Activity identifier

Yes

No

OWNER_ID
integer

Owner identifier, immutable

Yes

Yes

OWNER_TYPE_ID
crm.enum.ownertype

Owner type, immutable

Yes

Yes

TYPE_ID
crm_enum_activitytype

Type, immutable

Yes

Yes

PROVIDER_ID
string

Provider identifier

Yes

Yes

PROVIDER_TYPE_ID
string

Provider type identifier

Yes

Yes

PROVIDER_GROUP_ID
string

Connector type

Yes

Yes

ASSOCIATED_ENTITY_ID
integer

Entity identifier related to the activity

Yes

No

SUBJECT
string

Subject, activity title

Yes

Yes

START_TIME
datetime

Start time

Yes

Yes

END_TIME
datetime

Completion time

Yes

Yes

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.

Yes

Yes

COMPLETED
char

Completed

Yes

Yes

STATUS
crm_enum_activitystatus

Status

Yes

Yes

RESPONSIBLE_ID
user

assigned user

Yes

Yes

PRIORITY
crm.enum.activitypriority

Importance

Yes

Yes

NOTIFY_TYPE
crm.enum.activitynotifytype

Notification type

Yes

Yes

NOTIFY_VALUE
integer

Notification parameter

Yes

Yes

DESCRIPTION
string

Description

Yes

Yes

DESCRIPTION_TYPE
crm.enum.contenttype

Description type

Yes

Yes

DIRECTION
crm.enum.activitydirection

Activity direction: inbound/outbound. Relevant for calls and emails, not used for meetings.

Yes

Yes

LOCATION
string

Location

Yes

Yes

CREATED
datetime

Create date

Yes

No

AUTHOR_ID
user

Activity creator

Yes

Yes

LAST_UPDATED
datetime

Last update date

Yes

No

EDITOR_ID
user

Changed by

Yes

No

SETTINGS
object

Settings

Yes

Yes

ORIGIN_ID
string

Item identifier in the data source. Used only for linking to an external source.

Yes

Yes

ORIGINATOR_ID
string

Data source identifier. Used only for linking to an external source.

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

Autofill

Yes

Yes

BINDINGS
crm_activity_binding

Links

Yes

No

COMMUNICATIONS
crm_activity_communication

Communication channel. Multiple, mandatory

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

Whether the activity is inbound, i.e., created as a result of an incoming client Salutation to a communication channel

Yes

No