CRM Company Details Custom Fields: Methods Overview

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.

Company details custom fields supplement the standard set of company details fields with integration-specific or business-specific data.

Custom fields for company details can only be created for the following types: string, boolean, double, datetime.

General rules for working with custom fields are described on the Custom Fields in CRM page.

Quick navigation: All Methods

User documentation: Custom Fields in CRM

Getting Started

  1. Specify the custom field object ENTITY_ID with the value CRM_REQUISITE
  2. Select a data type USER_TYPE_ID: string, boolean, double, or datetime
  3. Set a symbolic code FIELD_NAME with the prefix UF_CRM_
  4. Create the field using the crm.requisite.userfield.add method
  5. Retrieve a list of custom fields using the crm.requisite.userfield.list method
  6. Update or delete a field using the crm.requisite.userfield.update and crm.requisite.userfield.delete methods

Custom Field Identifiers

  • ID — the custom field identifier. It is returned by the crm.requisite.userfield.add, crm.requisite.userfield.get, and crm.requisite.userfield.list methods
  • ENTITY_ID — the identifier of the object to which the custom field belongs. For company details, always pass CRM_REQUISITE
  • FIELD_NAME — the symbolic code of the custom field. For company details, the code always begins with the prefix UF_CRM_
  • USER_TYPE_ID — the data type of the custom field. Available values: string, boolean, double, datetime

Fields Describing a Company Details Custom Field

Required fields are marked with *.

Name
type

Description

ID
int

Identifier of the custom field

ENTITY_ID*
string

Identifier of the object to which the custom field belongs. For requisites, this is always CRM_REQUISITE

FIELD_NAME*
string

Symbolic code. For requisites, it always starts with the prefix UF_CRM_

USER_TYPE_ID*
string

Data type (string, boolean, double, or datetime)

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

SORT
int

Sorting

MULTIPLE
char

Indicator of multiplicity. Possible values:

  • Y — yes
  • N — no

MANDATORY
char

Indicator of mandatory status. Possible values:

  • Y — yes
  • N — no

SHOW_FILTER
char

Show in the list filter. Possible values:

  • N — do not show
  • I — exact match
  • E — mask
  • S — substring

SHOW_IN_LIST
char

Whether to show in the list. Possible values:

  • Y — yes
  • N — no

EDIT_IN_LIST
char

Allow user editing? Possible values:

  • Y — yes
  • N — no

IS_SEARCHABLE
char

Whether the field values participate in search. Possible values:

  • Y — yes
  • N — no

EDIT_FORM_LABEL
string

Label in the edit form

LIST_COLUMN_LABEL
string

Header in the list

LIST_FILTER_LABEL
string

Filter label in the list

ERROR_MESSAGE
string

Error message

HELP_MESSAGE
string

Help

LIST
uf_enum_element

List items. A detailed description of the item fields is available on the Get Field Descriptions for Custom Field Type "Enumeration" (List) crm.userfield.enumeration.fields page

SETTINGS
object

Additional settings that depend on the field type. A detailed description of the settings is available on the Get Field Settings Description for Custom Field Type crm.userfield.settings.fields page

Overview of Methods

Scope: crm

Who can execute the methods: depending on the method — a user with "read" access permission for requisites can read the fields, while only a CRM administrator can change the set of fields

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 identifier

crm.requisite.userfield.list

Returns a list of custom fields for requisites by filter

crm.requisite.userfield.delete

Deletes a custom field for a requisite
Previous
Get Description of Bank Detail Fields
Next
Create a New Custom Requisite Field