Custom Fields for Inventory Accounting Documents: Overview of Methods

This section contains methods for reading and updating the values of custom fields for inventory accounting documents. The creation and configuration of the custom fields themselves are performed in a separate section userfieldconfig.*.

Quick navigation: all methods

Relationships with Other ObjectsRelationships with Other Objects

Custom Fields. Fields are created and configured using the methods in the userfieldconfig.* section. 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.

Working with Custom Fields of DocumentsWorking with Custom Fields of Documents

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

Overview of MethodsOverview of Methods

Scope: catalog

Who can execute the method: depending on the method

Method	Description
catalog.userfield.document.update	Updates the values of custom fields for inventory accounting documents
catalog.userfield.document.list	Returns a list of values for custom fields of inventory accounting documents