Custom Fields for Inventory Accounting Documents: Overview of 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 catalog.userfield.document.* methods read and update the values of custom fields for inventory accounting documents. Custom fields themselves are created and configured using userfieldconfig.* methods.

Quick navigation: all methods

Relationships with Other Objects

Custom Fields. Fields are created and configured using userfieldconfig.* methods. For inventory accounting documents, use moduleId = catalog and entityId in the format CAT_STORE_DOCUMENT_<documentType>, for example, CAT_STORE_DOCUMENT_A.

Type of Inventory Accounting Document. The methods in this section use documentType. Acceptable values can be obtained using the catalog.enum.getStoreDocumentTypes method.

Inventory Accounting Document. To update values, a documentId is required. The document identifier can be obtained using the catalog.document.list method.

How to Start

  1. Create a custom field using userfieldconfig.add
  2. Retrieve the documentType using catalog.enum.getStoreDocumentTypes
  3. Get the current field values using catalog.userfield.document.list
  4. Update the values using catalog.userfield.document.update

Overview of Methods

Scope: catalog

Who can execute the method: depending on the method

Method

Description

catalog.userfield.document.list

Returns a list of values for custom fields of inventory accounting documents

catalog.userfield.document.update

Updates the values of custom fields for inventory accounting documents