About Custom Fields for Requisites
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.
Scope:
crmWho can execute methods: any user
This section presents methods for working with custom fields for requisites. Custom fields can only be created for requisites of the following types: string, boolean, double, datetime.
For a description of general methods for working with custom fields, see the section Custom Fields in CRM.
Fields Describing a Custom Field for Requisites
|
Name |
Description |
Read |
Write |
Required |
Immutable |
Multiple |
|
ID |
Identifier of the custom field |
Yes |
No |
No |
No |
No |
|
ENTITY_ID |
Identifier of the entity to which the custom field belongs. For requisites, this is always |
Yes |
Yes |
Yes |
Yes |
No |
|
FIELD_NAME |
Symbolic code. For requisites, it always starts with the prefix |
Yes |
Yes |
Yes |
Yes |
No |
|
USER_TYPE_ID |
Yes |
Yes |
Yes |
Yes |
No |
|
|
XML_ID |
External key. Used for exchange operations. Identifier of the object in the external information base. The purpose of the field may change by the final developer |
Yes |
Yes |
No |
No |
No |
|
SORT |
Sorting |
Yes |
Yes |
No |
No |
No |
|
MULTIPLE |
Indicator of multiplicity. Possible values:
|
|||||
|
MANDATORY |
Indicator of necessity. Possible values:
|
|||||
|
SHOW_FILTER |
Show in the list filter. Possible values:
|
|||||
|
SHOW_IN_LIST |
Show in the list. Possible values:
|
|||||
|
EDIT_IN_LIST |
Allow user editing. Possible values:
|
|||||
|
IS_SEARCHABLE |
Are the field values included in the search. Possible values:
|
|||||
|
EDIT_FORM_LABEL |
Label in the edit form |
Yes |
Yes |
No |
No |
No |
|
LIST_COLUMN_LABEL |
Header in the list |
Yes |
Yes |
No |
No |
No |
|
LIST_FILTER_LABEL |
Filter label in the list |
Yes |
Yes |
No |
No |
No |
|
ERROR_MESSAGE |
Error message |
Yes |
Yes |
No |
No |
No |
|
HELP_MESSAGE |
Help |
Yes |
Yes |
No |
No |
No |
|
LIST |
List elements. For detailed information, see the section Get Field Descriptions for Custom Field Type "Enumeration" (List) crm.userfield.enumeration.fields |
Yes |
Yes |
No |
No |
Yes |
|
SETTINGS |
Additional settings (dependent on type). For detailed information, see the section Get Field Settings Description for Custom Field Type crm.userfield.settings.fields |
Yes |
Yes |
No |
No |
No |
Overview of Methods
|
Method |
Description |
|
Creates a new custom field for a requisite |
|
|
Modifies an existing custom field for a requisite |
|
|
Returns a custom field for a requisite by identifier |
|
|
Returns a list of custom fields for requisites by filter |
|
|
Deletes a custom field for a requisite |