Overview of Helper Methods
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.
The helper method groups include multiple fields, enumerations, and VAT rates.
Quick navigation: all methods and events
Multiple Fields
The method crm.multifield.fields returns information about the structure of multiple fields, such as phone numbers or e-mails. To populate a field with a value of type, pass the data in the structure returned by the method.
Example of passing data to fill in a mobile phone number:
PHONE: [
{
VALUE: "555888",
VALUE_TYPE: "MOBILE",
},
] ,
Typical use-cases and scenarios
Enumerations
The group of enumeration methods crm.enum.* returns information about the names and identifiers of CRM objects. For example, the method crm.enum.ownertype returns identifiers for smart processes, while the method crm.enum.addresstype returns identifiers for address types: legal, physical, delivery address.
Typical use-cases and scenarios
VAT Rates
The group of methods catalog.vat.* manages VAT rates. These methods allow you to create, delete, update, and retrieve VAT rate values.
To set the VAT for a product in a deal or another CRM object, use the taxRate parameter from the group of methods crm.item.productrow.*.
To set the VAT for a product or service in the product catalog, use the vatId parameter from the group of methods catalog.product.*.
Overview of Methods
Scope:
crmWho can perform methods: depending on the method
Multiple Fields
|
Method |
Description |
|
Returns the description of multiple fields |
Enumerations
|
Method |
Description |
|
Returns the description of enumeration fields |
|
|
Returns the types of objects in CRM |
|
|
Returns the identifiers of object types to which order binding is available |
|
|
Returns the types of addresses |
|
|
Returns the description of CRM operation modes |
|
|
Returns the enumeration items "Activity Types" |
|
|
Returns the enumeration items "Activity Priorities" |
|
|
Returns the enumeration items "Activity Direction" for e-mails and calls |
|
|
Returns the enumeration items "Activity Start Notification Type" for meetings and calls |
|
|
Returns the enumeration items "Status" |
|
|
Returns the enumeration items "Description Type" |