index.md

Details in CRM: Overview of Methods

{% note tip "" %}

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

{% endnote %}

Details are separate CRM entities that store data used in closing deals: Tax Identification Number (TIN), Tax Registration Reason Code (TRRC), Primary State Registration Number (PSRN), banking details, and addresses. Everything necessary for document templates.

The Details field is available:

• in contacts and companies — where buyer data is stored
• in your companies — where your company's data, acting as the seller, is stored. This type of company is located in a separate section in the CRM settings

Quick navigation: all methods and events

User documentation: add company details, use of company details

How to Choose a Section

Requisite methods are split into subsections by the objects they work with.

#| || If You Need To | Open the Section || || Create a requisite for a contact or company, retrieve or update its data | Universal Company Details || || Add a legal, actual, or other address to a requisite | Addresses || || Store a bank account, BIC, and other payment data | Banking Details || || Specify which requisites to insert into an invoice, quote, or deal | Linking Company Details to CRM Objects || || Manage the set of requisite fields for a country or counterparty type | Requisite Templates and Customizable Template Fields || || Add a custom field to a requisite | CRM Company Details Custom Fields || || Receive notifications about requisite changes | Events || |#

Getting Started

1. Choose a requisite template — it defines the set of fields. The list of templates is returned by the crm.requisite.preset.list method
2. Create a requisite using the crm.requisite.add method. Pass the template identifier to it, along with the type and identifier of the owner — a contact or a company
3. Supplement the requisite with addresses and banking details if they are needed in documents
4. Link the requisite to a deal, invoice, or quote using the methods of the Linking Company Details to CRM Objects section so that it is inserted into printed forms

Connection of Details with Other CRM Entities

Contact. The default details template is Person.

Company. The default details template is Company.

My Company. The details of the company selected as the main seller are automatically filled in all documents.

Address. A separate entity accessible through the standard Address field. Addresses can only be linked to requisites or leads. To work with addresses, use the group of methods crm.address.*, where the requisite identifier is passed in the ENTITY_ID parameter.

Documents. Any printed forms: invoices, acts, contracts, and others generated through the document generator. Which requisites end up in a document is determined by the link registered with the crm.requisite.link.* methods.

{% note tip "User Documentation" %}

• Updates in working with addresses and contact or company details in CRM
• Documents in CRM: how to create and send in a couple of minutes

{% endnote %}

Details Templates

Any detail for a contact or company is created within templates. A template consists of a set of fields characteristic of a specific type of legal and natural persons:

• the Company template consists of fields for legal entities such as LLC: VAT ID, Company Name
• the Person template consists of other fields: First Name, Last Name

You can add, modify, and delete details templates through the group of methods crm.requisite.preset.*.

Manage the list of fields for a specific template — crm.requisite.preset.field.*.

Create and modify custom fields that can be used in the template — crm.requisite.userfield.*.

{% note tip "User Documentation" %}

• Contact or company details templates

{% endnote %}

Overview of Methods and Events {#all-methods}

Scope: crm

Who can execute methods: depending on the method — access permissions are checked against the object that owns the requisite

Basic

{% list tabs %}

• Methods

  #| || Method | Description || || crm.requisite.add | Creates a new requisite || || crm.requisite.update | Updates an existing requisite || || crm.requisite.get | Returns a requisite by ID || || crm.requisite.list | Returns a list of requisites by filter || || crm.requisite.delete | Deletes a requisite and all associated objects || || crm.requisite.fields | Returns the description of requisite fields || |#

• Events

  #| || Event | Triggered || || onCrmRequisiteAdd | When a requisite is added || || onCrmRequisiteUpdate | When a requisite is modified || || onCrmRequisiteDelete | When a requisite is deleted || |#

{% endlist %}

Addresses

{% list tabs %}

• Methods

  #| || Method | Description || || crm.address.add | Adds a new address for a requisite or lead || || crm.address.update | Modifies an address for a requisite or lead || || crm.address.list | Returns a list of addresses by filter || || crm.address.delete | Deletes an address || || crm.address.fields | Returns the formal description of address fields || |#

• Events

  #| || Event | Triggered || || onCrmAddressRegister | When an address is registered || || onCrmAddressUnregister | When an address is deleted || |#

{% endlist %}

Banking Details

{% list tabs %}

• Methods

  #| || Method | Description || || crm.requisite.bankdetail.add | Creates a new banking requisite || || crm.requisite.bankdetail.update | Modifies an existing banking requisite || || crm.requisite.bankdetail.get | Returns a banking requisite by ID || || crm.requisite.bankdetail.list | Returns a list of banking requisites by filter || || crm.requisite.bankdetail.delete | Deletes a banking requisite || || crm.requisite.bankdetail.fields | Returns the formal description of banking requisite fields || |#

• Events

  #| || Event | Triggered || || onCrmBankDetailAdd | When a banking requisite is added || || onCrmBankDetailUpdate | When a banking requisite is modified || || onCrmBankDetailDelete | When a banking requisite is deleted || |#

{% endlist %}

Custom Requisite Fields

{% list tabs %}

• Methods

  #| || Method | Description || || crm.requisite.userfield.add | Creates a new custom field for a requisite || || crm.requisite.userfield.update | Modifies an existing custom field for a requisite || || crm.requisite.userfield.get | Returns a custom field for a requisite by ID || || crm.requisite.userfield.list | Returns a list of custom fields for a requisite by filter || || crm.requisite.userfield.delete | Deletes a custom field for a requisite || |#

• Events

  #| || Event | Triggered || || onCrmRequisiteUserFieldAdd | When a custom field is added || || onCrmRequisiteUserFieldUpdate | When a custom field is modified || || onCrmRequisiteUserFieldDelete | When a custom field is deleted || || onCrmRequisiteUserFieldSetEnumValues | When the set of values for a custom field of list type is modified || |#

{% endlist %}

Connections of Requisites with CRM Entities

#| || Method | Description || || crm.requisite.link.register | Registers the connection of requisites with an entity || || crm.requisite.link.get | Returns the connection of requisites with an entity || || crm.requisite.link.list | Returns a list of requisites connections by filter || || crm.requisite.link.unregister | Deletes the connection of requisites with an entity || || crm.requisite.link.fields | Returns the formal description of fields for requisites connections || |#

Requisites Templates

#| || Method | Description || || crm.requisite.preset.add | Creates a new requisites template || || crm.requisite.preset.update | Modifies a requisites template || || crm.requisite.preset.get | Returns a requisites template by ID || || crm.requisite.preset.list | Returns a list of requisites templates by filter || || crm.requisite.preset.delete | Deletes a requisites template || || crm.requisite.preset.countries | Returns the list of countries available for requisites templates || || crm.requisite.preset.fields | Returns the formal description of fields for requisites templates || |#

Customizable Requisite Template Fields

#| || Method | Description || || crm.requisite.preset.field.add | Adds a customizable field to the requisites template || || crm.requisite.preset.field.update | Modifies a customizable field in the requisites template || || crm.requisite.preset.field.get | Returns the description of a customizable field in the requisites template by ID || || crm.requisite.preset.field.list | Returns a list of all customizable fields for a specific requisites template || || crm.requisite.preset.field.delete | Deletes a customizable field from the requisites template || || crm.requisite.preset.field.availabletoadd | Returns fields available for addition to the specified requisites template || || crm.requisite.preset.field.fields | Returns a formal description of a customizable field in the requisites template || |#