Read FAQ
NEW
Bitrix24 Support
Registration and Authentication
How to start
My Profile
Feed
Messenger
Calendar
Bitrix24.Docs
Bitrix24.Drive
Bitrix24.Mail
Workgroups
CoPilot - AI in Bitrix24
Tasks and Projects
CRM
Contact Center
Sales Center
CRM Analytics (beta)
BI Builder
Sales Intelligence
Inventory Management
Marketing
Sites
Online Store (beta)
CRM + Online Store
CRM Store (beta)
e-Signature
e-Signature for HR
Company
Knowledge base (beta)
Automation
Workflows
Telephony
Market
Subscription
Settings
Enterprise
Desktop App
General questions
Bitrix24 On-Premise

Bitrix24Care

Description of datasets and fields for BI Builder

The dataset contains information on leads, deals, custom fields, companies, and other Bitrix24 entities. Use this data in BI Builder, Power BI, and Looker Studio to build new reports or add necessary information to the existing ones.

Find all available datasets and descriptions of their fields below.


Deals

Deals — crm_deal

Field Description Field type
ID Unique key Number
DATE_CREATE Deal creation date and time Date
CREATED_BY_ID ID of the user who created the deal Number
CREATED_BY ID and name of the user who created the deal String
CREATED_BY_NAME Name of the user who created the deal String
DATE_MODIFY Deal change date and time Date
MODIFY_BY_ID ID of the user who last updated the deal Number
MODIFIED_BY ID and name of the user who last updated the deal String
MODIFIED_BY_NAME Name of the user who last modified the deal String
ASSIGNED_BY_ID ID of the user who was assigned as responsible for the deal Number
ASSIGNED_BY ID and name of the user who was assigned as responsible for the deal String
ASSIGNED_BY_DEPARTMENT Responsible person's department String
MOVED_BY_ID ID of the user who changed the stage Number
MOVED_BY ID and name of the user who changed the stage String
MOVED_BY_NAME Name of the user who changed the stage String
MOVED_TIME Stage change date and time Date
LEAD_ID ID of the lead converted into the deal Number
COMPANY_NAME Company name String
COMPANY_ID Company ID Number
COMPANY Company name and ID String
CONTACT_ID Contact ID Number
CONTACT_NAME Contact name String
CONTACT Contact name and ID String
OPENED Shows whether the deal is available to all employees ("Y") or not ("N") String
TITLE Deal name String
CRM_PRODUCT CRM product name and ID (one or multiple) String
CATEGORY Deal pipeline name and ID String
STAGE_ID Stage ID String
STAGE Stage name and ID String
STAGE_SEMANTIC_ID Status type ID: "F": "(failed) - processed unsuccessfully", "S": "(success) - processed successfully", "P": "(processing) - deal in progress" String
STAGE_SEMANTIC Status type, semantic type description (e.g., "Success", "Failure", "In progress") String
IS_NEW Shows whether the deal is in the first stage ("Y") or not ("N") String
IS_RECURRING Shows whether the deal is recurring ("Y") or not ("N") String
IS_RETURN_CUSTOMER Shows whether the deal is repeat inquiry ("Y") or not ("N") String
CLOSED Shows whether the deal is in a final stage ("Y") or not ("N") String
TYPE_ID Deal type String
OPPORTUNITY_ACCOUNT Amount in reporting currency Number
OPPORTUNITY Expected amount Number
IS_MANUAL_OPPORTUNITY Shows whether the deal amount was entered manually ("Y") or not ("N") String
TAX_VALUE Tax Number
TAX_VALUE_ACCOUNT Tax in reporting currency Number
CURRENCY_ID Currency String
ACCOUNT_CURRENCY_ID Reporting currency String
PROBABILITY Deal success probability (scoring) Number
COMMENTS Comments in the deal String
BEGINDATE Auto completes with the deal creation date Date
CLOSEDATE Proposed closing date of the deal; by default, it's set 7 days after the deal creation date Date
LOCATION_ID Customer location Number
SOURCE_ID Source ID String
SOURCE Source name and ID String
SOURCE_DESCRIPTION Source description String
ORIGINATOR_ID External system where the deal was created String
ORIGIN_ID Deal ID in the external system where the deal was created String
ADDITIONAL_INFO Additional information in the deal String
UTM_SOURCE Ad source, UTM_SOURCE in the deal form String
UTM_MEDIUM Ad medium, UTM_MEDIUM in the deal form String
UTM_CAMPAIGN Ad campaign, UTM_CAMPAIGN in the deal form String
UTM_CONTENT Ad content, UTM_CONTENT in the deal form String
UTM_TERM Ad term, UTM_TERM in the deal form String
BANK_DETAIL_ID Bank details ID Number
CRM_PRODUCT_ID Identifiers of products in the deal form Number
CRM_PRODUCT_COUNT Product quantity as seen in the deal form String
WEBFORM_ID CRM form ID Number
WEBFORM_NAME CRM form name String
WEBFORM CRM form name and ID String

Custom fields of deals — crm_deal_uf

All custom fields are automatically added to the dataset. Their number depends on the number of fields in Bitrix24. The field name is assigned during creation in the format UF_CRM_123456789.

Field Description Field type
DEAL_ID Deal ID Number
DATE_CREATE Deal creation date and time Date
CLOSEDATE Proposed closing date of the deal Date
UF_CRM_123456789 Custom field name String
UF_CRM_* Other custom fields from Bitrix24 String

Deal history — crm_deal_stage_history

Field Description Field type
ID Unique key Number
TYPE_ID Record type: 1 for entity creation, 2 for transfer to the intermediate stage, and 3 for transfer to the final stage Number
DEAL_ID Deal ID, identifier of the entity in which the stage has changed; in this case, the deal ID Number
DATE_CREATE Record creation date and time. Date and time of the deal getting on the stage Date
START_DATE Stage start date; the values of the crm_deal_stage_history.START_DATE and crm_deal.BEGINDATE fields are equal Date
END_DATE Stage end date; the values of the crm_deal_stage_history.END_DATE and crm_deal.CLOSEDATE fields are equal Date
ASSIGNED_BY_NAME Name of the user who was assigned as responsible for the deal String
ASSIGNED_BY_ID ID of the user who was assigned as responsible for the deal Number
ASSIGNED_BY ID and name of the user who was assigned as responsible for the deal String
ASSIGNED_BY_DEPARTMENT Responsible person's department String
STAGE_SEMANTIC_ID Stage type identifier: "F": "(failed) - processed unsuccessfully", "S": "(success) - processed successfully", "P": "(processing) - deal in processing" String
STAGE_SEMANTIC Stage type: "Failure", "Success", or "In Progress" String
STAGE_ID Stage ID String
STAGE Stage ID and name String
CATEGORY_ID Deal pipeline ID String
CATEGORY_NAME Deal pipeline name String
CATEGORY Deal pipeline String

Products in deal — crm_deal_product_row

In Bitrix24 On-premise version, the iblock module is required for working with the PARENT, SUPERPARENT, and SUPERSUPERPARENT fields. Depending on the version of the information block, it uses different tables and fields.

For the information block version 1.0:

  • Table: b_iblock_element_property. Fields: IBLOCK_ELEMENT_ID, IBLOCK_PROPERTY_ID.

For the information block version 2.0:

  • Table: b_iblock_element_prop_s{information block ID}. Fields: PROPERTY_{ID of the "Catalog element" property}, BLOCK_THE_ID ELEMENT.

  • Table: b_iblock_section_element. Field: IBLOCK_ELEMENT_ID.

  • Table: b_iblock_section. Fields: ID, NAME.

The catalog and sale modules are required to use the INSTOCK field. They use the following tables and fields:

  • Table: b_catalog_dogs_element. Fields: DOC_ID, ELEMENT_ID.

  • Table: b_catalog_store_docs. Fields: ID, DOC_TYPE, STATUS, DATE_STATUS.

  • Table: b_sale_basket. Fields: QUANTITY, ID, PRODUCT_ID.

  • Table: b_sale_order_dlv_basket. Fields: ORDER_DELIVERY_ID, BASKET_ID.

  • Table: b_sale_order_delivery. Fields: ID, DEDUCTED, DATE_DEDUCTED.
Field Description Field type
ID Unique key Number
DEAL_ID Deal ID Number
DEAL_DATE_CREATE Deal creation time Date
DEAL_CLOSEDATE Deal completion time Date
PRODUCT Product name and ID String
PRODUCT_ID Product ID Number
PRODUCT_NAME Product name String
PRICE Product price Number
PRICE_EXCLUSIVE Discounted price without tax Number
PRICE_NETTO Price without discount or tax Number
PRICE_BRUTTO Discounted price with tax Number
QUANTITY Product quantity Number
DISCOUNT_TYPE Discount name and ID String
DISCOUNT_TYPE_ID Discount ID Number
DISCOUNT_TYPE_NAME Discount name String
DISCOUNT_RATE Discount percentage value Number
DISCOUNT_SUM Discount amount Number
TAX_RATE Tax percentage rate Number
TAX_INCLUDED Shows whether tax is included in price ("Y") or not ("N") String
CUSTOMIZED Shows whether the product was modified manually after being added to the deal ("Y") or not ("N") String
MEASURE Unit of measurement name and ID String
MEASURE_CODE Unit of measurement ID Number
MEASURE_NAME Unit of measurement name String
SORT Sorting order Number
CATEGORY Deal pipeline name and ID String
CATEGORY_NAME Deal pipeline name String
PARENT Product section (e.g., "Yoghurts") String
SUPERPARENT Parent product section (e.g., "Dairy products") String
SUPERSUPERPARENT Parent of parent product section (e.g., "Perishable products") String

Leads

Leads — crm_lead

Field Description Field type
ID Unique key Number
DATE_CREATE Lead creation date and time Date
CREATED_BY_ID ID of the user who created the lead Number
CREATED_BY ID and name of the user who created the lead String
DATE_MODIFY Lead change date and time Date
MODIFY_BY_ID ID of the user who last updated the lead Number
MODIFIED_BY ID and name of the user who last updated the lead String
MODIFIED_BY_NAME Name of the user who last modified the lead String
ASSIGNED_BY_ID ID of the user who was assigned as responsible for the lead Number
ASSIGNED_BY_NAME Name of the user who was assigned as responsible for the lead String
ASSIGNED_BY ID and name of the user who was assigned as responsible for the lead String
ASSIGNED_BY_DEPARTMENT Responsible person's department String
COMPANY_ID Company ID Number
COMPANY Company name and ID String
COMPANY_NAME Company name String
COMPANY_TITLE Company name from the lead field String
CONTACT_ID Contact ID Number
CONTACT_NAME Contact name String
CONTACT Contact name and ID String
OPENED Shows whether the deal is available to all employees ("Y") or not ("N") String
TITLE Lead title String
NAME First name in the lead form String
LAST_NAME Last name in the lead form String
SECOND_NAME Second name in the lead form String
FULL_NAME Full name in the lead form String
POST Position String
STATUS_ID Status ID String
STATUS_NAME Status name String
STATUS Status name and ID String
STATUS_DESCRIPTION Status description (reasons for moving to the status) String
STATUS_SEMANTIC_ID Status type identifier: "F": "(failed) - processed unsuccessfully", "S": "(success) - processed successfully", "P": "(processing) - lead in processing" String
STATUS_SEMANTIC Status type ("Success" or "Failure") String
IS_RETURN_CUSTOMER Shows whether the lead is repeat ("Y") or not ("N") String
OPPORTUNITY Expected amount Number
CURRENCY_ID Currency String
COMMENTS Comments in the lead form String
SOURCE_ID Source ID String
SOURCE_NAME Source name String
SOURCE Source name and ID String
SOURCE_DESCRIPTION Source description String
ORIGINATOR_ID External system where the lead was created String
ORIGIN_ID Lead ID in the external system where the deal was created String
UTM_SOURCE Ad source, UTM_SOURCE in the lead form String
UTM_MEDIUM Ad medium, UTM_MEDIUM in the lead form String
UTM_CAMPAIGN Ad campaign, UTM_CAMPAIGN in the lead form String
UTM_CONTENT Ad content, UTM_CONTENT in the lead form String
UTM_TERM Ad term, UTM_TERM in the lead form String
CRM_PRODUCT_ID Identifiers of products in the lead form String
CRM_PRODUCT CRM product name and ID (one or multiple) String
CRM_PRODUCT_COUNT Product quantity as seen in the lead form String
CRM_PRODUCT_NAME Product name in the lead form String
ADDRESS_1 Address in the lead form String
ADDRESS_2 Address in the lead form String
ADDRESS_CITY City String
ADDRESS_POSTAL_CODE Zip/Postal code String
ADDRESS_REGION Region String
ADDRESS_PROVINCE Area String
ADDRESS_COUNTRY Country String
ADDRESS_COUNTRY_CODE Country code String
DATE_CLOSED Lead closing date and time Date
BIRTHDATE Date of birth Date
HONORIFIC Salutation String
PHONE Type identifier and phone number String
WEB Type identifier and URL String
EMAIL Type identifier and email String
IM Type identifier and messengers String

Custom fields of leads — crm_lead_uf

All custom fields are automatically added to the dataset. Their number depends on the number of fields in Bitrix24. The field name is assigned during creation in the format UF_CRM_123456789.

Field Description Field type
LEAD_ID Lead ID Number
DATE_MODIFY Lead change date Date
DATE_CREATE Lead creation date Date
DATE_CLOSED Lead closing date Date
UF_CRM_123456789 Custom field name String
UF_CRM_* Other custom fields from Bitrix24 String

Lead history — crm_lead_status_history

Field Description Field type
ID Unique key of the record Number
TYPE_ID Record type: 1 for entity creation, 2 for transfer to the intermediate stage, and 3 for transfer to the final stage Number
LEAD_ID Lead ID, identifier of the entity in which the stage has changed; in this case, the lead ID Number
DATE_CREATE Record creation date and time. Date and time of the lead getting on the stage Date
ASSIGNED_BY_ID ID of the user who was assigned as responsible for the lead Number
ASSIGNED_BY ID and name of the user who was assigned as responsible for the lead String
ASSIGNED_BY_NAME Name of the user who was assigned as responsible for the lead String
ASSIGNED_BY_DEPARTMENT Responsible person's department String
STATUS_SEMANTIC_ID Status type identifier: "F": "(failed) - processed unsuccessfully", "S": "(success) - processed successfully", "P": "(processing) - lead in processing" String
STATUS_SEMANTIC Status type ("Success" or "Failure") String
STATUS_ID Status ID String
STATUS Status name and ID String
STATUS_NAME Status name String

Products in lead — crm_lead_product_row

Field Description Field type
ID Unique key of the record Number
LEAD_ID Lead ID Number
LEAD_DATE_MODIFY Lead change date Date
LEAD_DATE_CREATE Lead creation date Date
LEAD_DATE_CLOSED Lead closing date Date
PRODUCT Product name and ID String
PRODUCT_ID Product ID Number
PRODUCT_NAME Product name String
PRICE Product price Number
PRICE_EXCLUSIVE Discounted price without tax Number
PRICE_NETTO Price without discount or tax Number
PRICE_BRUTTO Discounted price with tax Number
QUANTITY Product quantity Number
DISCOUNT_TYPE Discount name and ID String
DISCOUNT_TYPE_ID Discount ID Number
DISCOUNT_TYPE_NAME Discount name String
DISCOUNT_RATE Discount percentage value Number
DISCOUNT_SUM Discount amount Number
TAX_RATE Tax percentage rate Number
TAX_INCLUDED Shows whether tax is included in price ("Y") or not ("N") String
CUSTOMIZED Shows whether the product was modified manually after being added to the lead ("Y") or not ("N") String
MEASURE Unit of measurement name and ID String
MEASURE_CODE Unit of measurement ID Number
MEASURE_NAME Unit of measurement name String
SORT Sorting order Number

SPAs and activities

SPA items — crm_dynamic_items_123

Each SPA (Smart Process Automation) is a separate dataset. It contains its own fields and columns. You need to find the SPA type ID to use its data in reports.
Where to find the SPA ID

All custom SPA fields are automatically added to the dataset. Their number depends on the number of fields in Bitrix24. The field name is assigned during creation in the format UF_CRM_123456789.

Field Description Field type
ID Unique key Number
XML_ID External ID String
TITLE SPA name String
CREATED_BY ID and name of the user who created the SPA item String
CREATED_BY_ID ID of the user who created the SPA item Number
CREATED_BY_NAME Name of the user who created the SPA item String
UPDATED_BY ID and name of the user who last updated the SPA item String
UPDATED_BY_ID ID of the user who last updated the SPA item Number
UPDATED_BY_NAME Name of the user who last updated the SPA item String
MOVED_BY ID and name of the user who changed the stage String
MOVED_BY_ID ID of the user who changed the stage Number
MOVED_BY_NAME Name of the user who changed the stage String
CREATED_TIME SPA item creation date Date
UPDATED_TIME SPA item change date Date
MOVED_TIME SPA item's stage change date Date
CATEGORY Pipeline name and ID String
CATEGORY_ID Pipeline ID Number
CATEGORY_NAME Pipeline name String
OPENED Shows whether the deal is available to all employees ("Y") or not ("N") String
STAGE Stage name and ID String
STAGE_ID Stage ID String
STAGE_NAME Stage name String
PREVIOUS_STAGE_ID Previous stage ID String
BEGINDATE Start date Date
CLOSEDATE End date Date
COMPANY Company name and ID String
COMPANY_ID Company ID Number
COMPANY_NAME Company name String
CONTACT Contact name and ID String
CONTACT_ID Contact ID Number
CONTACT_NAME Contact name String
OPPORTUNITY Expected amount Number
IS_MANUAL_OPPORTUNITY Shows whether the expected amount was entered manually ("Y") or not ("N") String
TAX_VALUE Tax Number
CURRENCY_ID Currency String
OPPORTUNITY_ACCOUNT Amount in reporting currency Number
TAX_VALUE_ACCOUNT Tax in reporting currency Number
ACCOUNT_CURRENCY_ID Reporting currency String
MYCOMPANY ID and name of my company String
MYCOMPANY_ID My company ID Number
MYCOMPANY_NAME My company name String
SOURCE Source name and ID (e.g., "[STORE] Online store") String
SOURCE_ID Source ID String
SOURCE_NAME Source name String
SOURCE_DESCRIPTION Source description String
ASSIGNED_BY ID and name of the user assigned as a responsible person String
ASSIGNED_BY_ID ID of the user assigned as a responsible person Number
ASSIGNED_BY_NAME Name of the user assigned as a responsible person String
WEBFORM_ID ID of the source CRM form Number
UF_CRM_123456789 Custon field name String
UF_CRM_* Other custom fields from Bitrix24 String

SPAs — crm_smart_proc

Field Description Field type
ENTITY_TYPE_ID SPA type ID Number
TITLE SPA name String
DATASET_NAME SPA dataset name String
AUTOMATED_SOLUTION_DATASET_NAME Automated solution dataset name; if the SPA is not linked to any automated solution, the CRM dataset name will be displayed String
CUSTOM_SECTION_ID Automated solution ID Number
CUSTOM_SECTION_TITLE Automated solution name String

CRM entity stages — crm_stages

Field Description Field type
ID Unique key of the record Number
ENTITY_TYPE_ID Entity type ID Number
STATUS_ID Stage ID String
NAME Stage name String
CATEGORY_ID Pipeline ID Number
CATEGORY_NAME Pipeline name String
SORT Sort order Number
SEMANTICS Stage type: "null" for intermediate stages, "S" for success, and "F" for failure. String

Dependencies of CRM entities — crm_entity_relation

Field Description Field type
SRC_ENTITY_TYPE_ID Source entity type ID (e.g., Lead 1, Deal 2, Contact 3, Company 4, Invoice 31, Estimate 7, Details 8) Number
SRC_ENTITY_ID Source entity ID Number
SRC_ENTITY_DATASET_NAME Source entity dataset name String
DST_ENTITY_TYPE_ID Linked entity type ID (e.g., Lead 1, Deal 2, Contact 3, Company 4, Invoice 31, Estimate 7, Details 8) Number
DST_ENTITY_ID Linked entity ID Number
DST_ENTITY_DATASET_NAME Linked entity dataset name String

SPAs in Automated solutions — crm_automated_solution_XXX

Field Description Field type
XXX Automated solution type ID Number
ENTITY_TYPE_ID SPA type ID Number
TITLE SPA name String
DATASET_NAME SPA dataset name String
AUTOMATED_SOLUTION_DATASET_NAME Automated solution dataset name is displayed if the SPA is linked to the automated solution; otherwise, the CRM dataset name is displayed String
CUSTOM_SECTION_ID Automated solution ID Number
CUSTOM_SECTION_TITLE Automated solution name String

Activities — crm_activity

Field Description Field type
ID Unique key Number
SUBJECT Activity name (e.g., Contact customer) String
ASSOCIATED_ENTITY_ID ID of the Bitrix24 entity associated with the activity. Number
TYPE_ID Activity type ID: 1 - meeting, 2 - call, 3 - task, 4 - email, 6 - custom actions, including new tasks, chats, deliveries, SMS messages, etc. Number
TYPE_NAME Activity type name, like "Meeting" or "Call" String
OWNER_ID ID of the CRM entity to which the activity is linked Number
OWNER_TYPE_ID CRM entity type code: 1 - lead, 2 - deal, 3 - contact Number
OWNER_TYPE_NAME CRM entity type name String
PRIORITY_ID Priority code: 1 - low, 2 - normal, 3 - high Number
PRIORITY_NAME Priority level String
DIRECTION_ID Pipeline ID Number
DIRECTION_NAME Pipeline name String
STATUS_ID Status code: 1 - pending, 2 - completed, 3 - completed automatically Number
STATUS_NAME Status name String
COMPLETED Shows whether the activity is completed ("Y") or not ("N") String
DATE_CREATE Activity creation date and time Date
START_TIME Activity start time Date
END_TIME Activity completion time Date
DEADLINE Activity deadline Date
DATE_MODIFY Last change date and time Date
AUTHOR ID and name of the user who created the activity String
AUTHOR_ID ID of the user who created the activity Number
AUTHOR_NAME Name of the user who created the activity String
EDITOR ID and name of the user who last modified the activity String
EDITOR_ID ID of the user who last modified the activity Number
EDITOR_NAME Name of the user who last modified the activity String
RESPONSIBLE Activity responsible person name and ID String
RESPONSIBLE_ID Activity responsible person ID Number
RESPONSIBLE_NAME Activity responsible person name String
DESCRIPTION Activity description String
DESCRIPTION_TYPE_ID Description type code Number
DESCRIPTION_TYPE_NAME Description type String
ORIGINATOR_ID External system where the activity was created String
ORIGIN_ID Activity external ID String

Companies

Companies — crm_company

Field Description Field type
ID Unique key Number
DATE_CREATE Company creation date and time Date
DATE_MODIFY Company change date and time Date
CREATED_BY_ID ID of the user who created the company Number
CREATED_BY ID and name of the user who created the company String
CREATED_BY_NAME Name of the user who created the company String
MODIFY_BY_ID ID of the user who last modified the company Number
MODIFIED_BY_NAME Name of the user who last modified the company String
MODIFIED_BY ID and name of the user who last modified the company String
ASSIGNED_BY_ID ID of the user who was assigned as responsible for this company Number
ASSIGNED_BY ID and name of the user who was assigned as responsible for the company String
ASSIGNED_BY_NAME Name of the user who was assigned as responsible for the company String
OPENED Shows whether the company is available to all employees ("Y") or not ("N") String
TITLE Company name String
ADDRESS_1 Address 1 String
ADDRESS_2 Address 2 String
ADDRESS_CITY City String
ADDRESS_POSTAL_CODE Zip/Postal code Number
ADDRESS_REGION State/Territory/Region String
ADDRESS_PROVINCE Area/District/Municipality String
ADDRESS_COUNTRY Country String
ADDRESS_COUNTRY_CODE Country code String
BANKING_DETAILS Banking details String
COMMENTS Comments String
COMPANY_TYPE_ID Company type ID String
COMPANY_TYPE_NAME Company type name String
COMPANY_TYPE ID and name of the company type String
INDUSTRY_ID Industry ID String
INDUSTRY_NAME Industry name String
INDUSTRY ID and name of industry String
REVENUE Annual revenue Number
CURRENCY_ID Currency String
EMPLOYESS Number of employees String
LEAD_ID ID of the lead linked to the company Number
ORIGINATOR_ID External system String
ORIGIN_ID External identifier String
ORIGIN_VERSION Original version String
IS_MY_COMPANY My company property String
UTM_SOURCE Ad source String
UTM_MEDIUM Ad medium String
UTM_CAMPAIGN Ad campaign String
UTM_CONTENT Ad content String
UTM_TERM Ad term String
PHONE Phone number String
WEB URL String
EMAIL Email String
IM Messengers String

Custom fields of companies — crm_company_uf

All custom fields are automatically added to the dataset. Their number depends on the number of fields in Bitrix24. The field name is assigned during creation in the format UF_CRM_123456789.

Field Description Field type
COMPANY_ID Company ID Number
DATE_CREATE Company creation date and time Date
UF_LOGO Company logo String
UF_CRM_123456789 Custom field name String
UF_CRM_* Other custom fields from Bitrix24 String
UF_STAMP Company stamp String
UF_DIRECTOR_SIGN CEO's signature String
UF_ACCOUNTANT_SIGN Chief Accountant's signature String

Contacts

Contacts — crm_contact

Field Description Field type
ID Unique key Number
DATE_CREATE Contact creation date and time Date
DATE_MODIFY Contact change date and time Date
CREATED_BY_ID ID of the user who created the contact Number
CREATED_BY ID and name of the user who created the contact String
CREATED_BY_NAME Name of the user who created the contact String
MODIFY_BY_ID ID of the user who last modified the contact Number
MODIFIED_BY_NAME Name of the user who last modified the contact String
MODIFIED_BY ID and name of the user who last modified the contact String
ASSIGNED_BY_ID ID of the user who was assigned as responsible for the contact Number
ASSIGNED_BY ID and name of the user who was assigned as responsible for the contact String
ASSIGNED_BY_NAME Name of the user who was assigned as responsible for this contact String
OPENED Shows whether the contact is available to all employees ("Y") or not ("N") String
COMPANY_ID Company ID Number
SOURCE_ID Source ID String
SOURCE_DESCRIPTION Source description String
NAME First name String
LAST_NAME Last name String
SECOND_NAME Second name String
POST Position String
ADDRESS_1 Address 1 String
ADDRESS_2 Address 2 String
ADDRESS_CITY City String
ADDRESS_POSTAL_CODE Zip/Postal code Number
ADDRESS_REGION State/Territory/Region String
ADDRESS_PROVINCE Area/District/Municipality String
ADDRESS_COUNTRY Country String
ADDRESS_COUNTRY_CODE Country code String
COMMENTS Comments String
LEAD_ID ID of the lead linked with the contact Number
EXPORT Shows whether the contact can be exported ("Y") or not ("N") String
TYPE_ID Type ID (e.g., "CLIENT") String
ORIGINATOR_ID External system String
ORIGIN_ID External identifier String
ORIGIN_VERSION Original version String
BIRTHDATE Date of birth Date
HONORIFIC Salutation code (e.g., "HNR_EN_1") String
FACE_ID faceid ID Number
PHONE Phone number String
WEB URL String
EMAIL Email String
IM Messengers String
UTM_SOURCE Ad source String
UTM_MEDIUM Ad medium (e.g., "CPC" for ads or "CPM" for banners) String
UTM_CAMPAIGN Ad campaign String
UTM_CONTENT Ad content String
UTM_TERM Ad term (e.g., contextual advertising keywords) String

Custom fields of contacts — crm_contact_uf

All custom fields are automatically added to the dataset. Their number depends on the number of fields in Bitrix24. The field name is assigned during creation in the format UF_CRM_123456789.

Field Description Field type
CONTACT_ID Contact ID Number
DATE_CREATE Contact creation date and time Date
UF_CRM_123456789 Custom field name String
UF_CRM_* Other custom fields from Bitrix24 String

Users, projects, and calls

Users — user

Field Description Field type
ID Unique key Number
ACTIVE Shows whether the user is on staff ("Y") or dismissed ("N") String
NAME User name String
DEPARTMENT User's department in the company structure. The department position in the company hierarchy is shown as "[ID] Company name / Company department." If a user is linked to multiple departments, the department with the smallest ID is used. String

Projects — socialnetwork_group

Field Description Field type
ID Unique key Number
SITE_ID Site code String
NAME Project or workgroup name String
DESCRIPTION Project or workgroup description String
PROJECT Shows whether it is a project ("Y") or not ("N") String
DATE_CREATE Creation date and time Date
DATE_MODIFY Date and time of the last change of project or workgroup parameters Date
OPENED Shows whether a workgroup or project is public ("Y") or not ("N") String
CLOSED Shows whether a workgroup or project is archived ("Y") or not ("N") String
SUBJECT Project or workgroup subject String
OWNER Project or workgroup owner String
OWNER_ID Project or workgroup owner ID Number
OWNER_NAME Project or workgroup owner name String
KEYWORDS Project keywords or tags String
NUMBER_OF_MEMBERS Number of members Number
DATE_ACTIVITY Last activity date and time Date

Calls — telephony_call

Field Description Field type
CALL_ID Unique key String
CALL_TYPE Call type: 1 - outgoing, 2 - incoming, 3 - forwarded incoming, 4 - callback Number
CALL_VOTE Call rating Number
COMMENT Call comment String
PORTAL_USER_ID Agent ID Number
PORTAL_USER Agent ID and name (e.g., "[12] Sam Smith") String
PORTAL_USER_DEPARTMENT Agent department (e.g., "[1] Company24 / [7] IT department") String
PORTAL_NUMBER Agent number linked with the call String
PHONE_NUMBER Customer's phone number String
CALL_DURATION Call duration in seconds Number
CALL_START_TIME Call start time Date
COST Call cost Number
COST_CURRENCY Call currency (e.g., "USD" or "EUR") String
CALL_STATUS_CODE Call code String
CALL_STATUS_CODE_ID Call result code String
CALL_STATUS_CODE_NAME Call result description String
CALL_STATUS_REASON Call code description (e.g., "Skipped call" or "Success call") String
CRM_ACTIVITY_ID ID of the CRM activity created based on the call Number
CRM_ENTITY_ID ID of the CRM entity to which the activity is bound Number
CRM_ENTITY_TYPE Type of CRM entity to which the activity is bound (e.g., "CONTACT") String
REST_APP_ID External telephony integration application ID Number
REST_APP_NAME External telephony integration application name String
REDIAL_ATTEMPT Number of dial attempts Number
TRANSCRIPT_ID Call transcript ID Number
TRANSCRIPT_PENDING Shows whether the transcript is ready ("N") or still in progress ("Y") String
RECORD_FILE_ID Call recording file ID Number

Workflows

Workflow assignments — bizproc_task

Field Description Field type
ID Unique key Number
CODE_ID Assignment type ID String
CODE_NAME Assignment type name String
CODE type String
WORKFLOW_ID Workflow ID and parent workflow ID String
NAME Assignment name String
CREATED_DATE Date and time assignment was created Date
MODIFIED Date and time assignment was modified Date
DURATION Workflow execution time in seconds Number
APPROVE_TYPE Assignment approval type ID String
APPROVE_TYPE_NAME Assignment approval type name String
STATUS_ID Status ID Number
STATUS_NAME Assignment status name String
STATUS Assignment status ID and name String
USER_ID Assignment participant ID Number
USER_NAME Assignment participant name String
USER Assignment participant ID and name String

Running workflows — bizproc_workflow_state

Field Description Field type
ID Unique key String
STARTED_BY_ID ID of the user who started the workflow Number
STARTED_BY_NAME Name of the user who started the workflow String
STARTED_BY ID and name of the user who started the workflow String
STARTED Start date and time Date
COMPLETED Completion status, "Y" - completed, "N" - running String
DOCUMENT_ID Workflow element ID String
DURATION Workflow execution time in seconds Number
START_DURATION Time spent on getting the workflow to start Number
WORKFLOW_TEMPLATE_ID Template ID Number
WORKFLOW_TEMPLATE_NAME Template name String
MODULE_ID Module ID String
MODULE_ID_NAME Module name String
ENTITY_ID Entity type ID String
ENTITY_ID_NAME Entity type name String
MODIFIED_BY_ID ID of the user who last updated the template Number
MODIFIED_BY_NAME Name of the user who last updated the template String
MODIFIED_BY ID and name of the user who last updated the template String

Invoices, e-Signature, and e-Signature for HR

Invoices — crm_dynamic_items_31

Field Description Field type
ID Unique key Number
XML_ID External ID for communication with external systems String
TITLE Invoice name String
CREATED_BY_ID ID of the user who created the item Number
CREATED_BY_NAME Name of the user who created the item String
CREATED_BY ID and name of the user who created the item String
UPDATED_BY_ID ID of the user who last modified the item Number
UPDATED_BY_NAME Name of the user who last modified the item String
UPDATED_BY ID and name of the user who last modified the item String
MOVED_BY_ID ID of the user who changed the stage Number
MOVED_BY_NAME Name of the user who changed the stage String
MOVED_BY ID and name of the user who changed the stage String
CREATED_TIME Creation date and time Date
UPDATED_TIME Change date and time Date
MOVED_TIME Stage change date and time Date
CATEGORY_ID Pipeline ID Number
CATEGORY_NAME Pipeline name String
CATEGORY Pipeline name and ID String
OPENED Shows whether the item is available to all employees ("Y") or not ("N") String
STAGE_ID Stage ID String
STAGE_NAME Stage name String
STAGE Stage name and ID String
PREVIOUS_STAGE_ID Previous stage ID String
BEGINDATE Start date and time Date
CLOSEDATE End date and time Date
COMPANY_ID Company ID Number
COMPANY_NAME Company name String
COMPANY ID and name of the company String
CONTACT_ID Contact ID Number
CONTACT_NAME Contact name String
CONTACT Contact name and ID String
OPPORTUNITY Expected amount Number
IS_MANUAL_OPPORTUNITY Shows whether the expected amount was entered manually ("Y") or not ("N") String
TAX_VALUE Tax Number
CURRENCY_ID Currency (e.g., "USD") String
OPPORTUNITY_ACCOUNT Amount in reporting currency Number
TAX_VALUE_ACCOUNT Tax in reporting currency Number
ACCOUNT_CURRENCY_ID Reporting currency String
MYCOMPANY ID and name of my company String
MYCOMPANY_ID My company ID Number
MYCOMPANY_NAME My company name String
SOURCE_ID Source ID String
SOURCE_NAME Source name String
SOURCE Source name and ID String
SOURCE_DESCRIPTION Source description String
ASSIGNED_BY ID and name of the user assigned as a responsible person String
ASSIGNED_BY_ID ID of the user assigned as a responsible person Number
ASSIGNED_BY_NAME Name of the user assigned as a responsible person String
WEBFORM_ID ID of the source CRM form Number

Customer documents (e-Signature) — crm_dynamic_items_36

Field Description Field type
ID Unique key Number
XML_ID External ID for communication with external systems String
TITLE Document name String
CREATED_BY_ID ID of the user who created the item Number
CREATED_BY_NAME Name of the user who created the item String
CREATED_BY ID and name of the user who created the item String
UPDATED_BY_ID ID of the user who last modified the item Number
UPDATED_BY_NAME Name of the user who last modified the item String
UPDATED_BY ID and name of the user who last modified the item String
MOVED_BY_ID ID of the user who changed the stage Number
MOVED_BY_NAME Name of the user who changed the stage String
MOVED_BY ID and name of the user who changed the stage String
CREATED_TIME Creation date and time Date
UPDATED_TIME Change date and time Date
MOVED_TIME Stage change date and time Date
CATEGORY_ID Pipeline ID Number
CATEGORY_NAME Pipeline name String
CATEGORY Pipeline name and ID String
OPENED Shows whether the item is available to all employees ("Y") or not ("N") String
STAGE_ID Stage ID String
STAGE_NAME Stage name String
STAGE Stage name and ID String
PREVIOUS_STAGE_ID Previous stage ID String
BEGINDATE Start date and time Date
CLOSEDATE End date and time Date
COMPANY_ID Company ID Number
COMPANY_NAME Company name String
COMPANY ID and name of the company String
CONTACT_ID Contact ID Number
CONTACT_NAME Contact name String
CONTACT Contact name and ID String
OPPORTUNITY Expected amount Number
IS_MANUAL_OPPORTUNITY Shows whether the expected amount was entered manually ("Y") or not ("N") String
TAX_VALUE Tax Number
CURRENCY_ID Currency (e.g., "USD") String
OPPORTUNITY_ACCOUNT Amount in reporting currency Number
TAX_VALUE_ACCOUNT Tax in reporting currency Number
ACCOUNT_CURRENCY_ID Reporting currency String
MYCOMPANY ID and name of my company String
MYCOMPANY_ID My company ID Number
MYCOMPANY_NAME My company name String
SOURCE_ID Source ID String
SOURCE_NAME Source name String
SOURCE Source name and ID String
SOURCE_DESCRIPTION Source description String
ASSIGNED_BY ID and name of the user assigned as a responsible person String
ASSIGNED_BY_ID ID of the user assigned as a responsible person Number
ASSIGNED_BY_NAME Name of the user assigned as a responsible person String
WEBFORM_ID ID of the source CRM form Number

HR documents (e-Signature for HR) — crm_dynamic_items_39

Field Description Field type
ID Unique key Number
XML_ID External ID for communication with external systems String
TITLE Document name String
CREATED_BY_ID ID of the user who created the item Number
CREATED_BY_NAME Name of the user who created the item String
CREATED_BY ID and name of the user who created the item String
UPDATED_BY_ID ID of the user who last modified the item Number
UPDATED_BY_NAME Name of the user who last modified the item String
UPDATED_BY ID and name of the user who last modified the item String
MOVED_BY_ID ID of the user who changed the stage Number
MOVED_BY_NAME Name of the user who changed the stage String
MOVED_BY ID and name of the user who changed the stage String
CREATED_TIME Creation date and time Date
UPDATED_TIME Change date and time Date
MOVED_TIME Stage change date and time Date
CATEGORY_ID Pipeline ID Number
CATEGORY_NAME Pipeline name String
CATEGORY Pipeline name and ID String
OPENED Shows whether the item is available to all employees ("Y") or not ("N") String
STAGE_ID Stage ID String
STAGE_NAME Stage name String
STAGE Stage name and ID String
PREVIOUS_STAGE_ID Previous stage ID String
BEGINDATE Start date and time Date
CLOSEDATE End date and time Date
COMPANY_ID Company ID Number
COMPANY_NAME Company name String
COMPANY ID and name of the company String
CONTACT_ID Contact ID Number
CONTACT_NAME Contact name String
CONTACT Contact name and ID String
OPPORTUNITY Expected amount Number
IS_MANUAL_OPPORTUNITY Shows whether the expected amount was entered manually ("Y") or not ("N") String
TAX_VALUE Tax Number
CURRENCY_ID Currency (e.g., "USD") String
OPPORTUNITY_ACCOUNT Amount in reporting currency Number
TAX_VALUE_ACCOUNT Tax in reporting currency Number
ACCOUNT_CURRENCY_ID Reporting currency String
MYCOMPANY ID and name of my company String
MYCOMPANY_ID My company ID Number
MYCOMPANY_NAME My company name String
SOURCE_ID Source ID String
SOURCE_NAME Source name String
SOURCE Source name and ID String
SOURCE_DESCRIPTION Source description String
ASSIGNED_BY ID and name of the user assigned as a responsible person String
ASSIGNED_BY_ID ID of the user assigned as a responsible person Number
ASSIGNED_BY_NAME Name of the user assigned as a responsible person String
WEBFORM_ID ID of the source CRM form Number

Tasks

Tasks — task

Field Description Field type
ID Unique key Number
TITLE Task name String
DESCRIPTION Task description String
MARK Task rating: positive, negative, or not rated String
PRIORITY Task priority: low, normal, or high String
STATUS Task statuses: Pending, In progress, Pending review, Completed, Deferred String
GROUP_ID ID of the project to which the task is linked Number
GROUP_NAME Name of the project to which the task is linked String
GROUP_INFO ID and name of the project to which the task is linked String
MULTITASK Shows whether the task has multiple assignees ("Y") or not ("N") String
STAGE_ID ID of the task stage Number
STAGE_NAME Name of the task stage String
STAGE ID and name of the task stage String
CREATED_BY_ID Task creator ID Number
CREATED_BY_NAME Task creator name String
CREATED_BY Task creator ID and name String
CREATED_DATE Task creation date Date
RESPONSIBLE_ID Assignee ID Number
RESPONSIBLE_NAME Assignee name String
RESPONSIBLE Assignee ID and name String
ACCOMPLICES_IDS Participant IDs String
ACCOMPLICES_NAMES Participant names String
ACCOMPLICES Participant names and IDs String
AUDITORS_IDS Observer IDs String
AUDITORS_NAMES Observer names String
AUDITORS Observer names and IDs String
PARENT_ID Parent task ID Number
CHANGED_BY_ID ID of the user who last updated the task Number
CHANGED_BY_NAME Name of the user who last updated the task String
CHANGED_BY ID and name of the user who last updated the task String
CHANGED_DATE Task change date and time Date
STATUS_CHANGED_BY_ID ID of the user who last updated the task status Number
STATUS_CHANGED_BY_NAME Name of the user who last updated the task status String
STATUS_CHANGED_BY ID and name of the user who last updated the task status String
STATUS_CHANGED_DATE Date and time when the task status was last modified Date
CLOSED_BY_ID ID of the user who closed the task Number
CLOSED_BY_NAME Name of the user who closed the task String
CLOSED_BY ID and name of the user who closed the task String
CLOSED_DATE Task closing date and time Date
ACTIVITY_DATE Last event date Date
DATE_START Task start date Date
DEADLINE Task deadline Date
START_DATE_PLAN Planned start date Date
END_DATE_PLAN Planned closing date Date
ALLOW_CHANGE_DEADLINE Shows whether the assignee can change task deadline ("Y") or not ("N") String
ALLOW_TIME_TRACKING Shows whether task time tracking is enabled ("Y") or not ("N") String
TASK_CONTROL Shows whether task result must be approved with a status summary ("Y") or not ("N") String
ADD_IN_REPORT Shows whether the task is added to work day report ("Y") or not ("N") String
TIME_ESTIMATE Task time estimate in seconds Number
MATCH_WORK_TIME Shows whether to extend task time if it falls on weekends or holidays ("Y") or not ("N") String
DURATION_PLAN Planned task duration in seconds Number
DURATION_FACT Real task duration time Number
DURATION_TYPE Unit of task duration: second, minute, hour, day, week, month, year String
CRM_TASK ID and type of CRM item as specified in the task: L (lead), D (deal), C (contact), CO (company) String
TAGS Tags in the task String
DEPENDS_ON Dependent task IDs Number
TIME_SPENT_IN_LOGS The time the task took to complete, including the value from the log events Number
COMMENTS_COUNT Comment count Number

Task stages — task_stages

Field Description Field type
ID Stage ID Number
TITLE Stage name String
SORT Stage sort order Number
COLOR Stage color String
GROUP_ID ID of the project to which the task is linked Number
GROUP_NAME Name of the project to which the task is linked String
GROUP_INFO ID and name of the project to which the task is linked String

Custom fields of tasks — task_uf

Field Description Field type
TASK_ID Task ID Number
UF_CRM_TASK CRM entity names as specified in the task String
UF_MAIL_MESSAGE ID of the email message the task was based on String

Was this information helpful?
Integration specialist assistance
That's not what I'm looking for
Complicated and incomprehensible text
The information is outdated
It's too short. I need more information
I don't like the way this tool works
Go to Bitrix24
Don't have an account? Create for free