About Custom Fields for Requisites

Scope: crm

Who 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 `type`	Description	Read	Write	Required	Immutable	Multiple
ID `int`	Identifier of the custom field	Yes	No	No	No	No
ENTITY_ID `string`	Identifier of the entity to which the custom field belongs. For requisites, this is always `CRM_REQUISITE`	Yes	Yes	Yes	Yes	No
FIELD_NAME `string`	Symbolic code. For requisites, it always starts with the prefix `UF_CRM_`	Yes	Yes	Yes	Yes	No
USER_TYPE_ID `string`	Data type (`string`, `boolean`, `double` or `datetime`)	Yes	Yes	Yes	Yes	No
XML_ID `string`	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 `int`	Sorting	Yes	Yes	No	No	No
MULTIPLE `char`	Indicator of multiplicity. Possible values: `Y` — yes `N` — no
MANDATORY `char`	Indicator of necessity. 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`	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`	Are the field values included in the search. Possible values: `Y` — yes `N` — no
EDIT_FORM_LABEL `string`	Label in the edit form	Yes	Yes	No	No	No
LIST_COLUMN_LABEL `string`	Header in the list	Yes	Yes	No	No	No
LIST_FILTER_LABEL `string`	Filter label in the list	Yes	Yes	No	No	No
ERROR_MESSAGE `string`	Error message	Yes	Yes	No	No	No
HELP_MESSAGE `string`	Help	Yes	Yes	No	No	No
LIST `uf_enum_element`	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 `object`	Additional settings (dependent on type). For detailed information, see the section Get the settings field descriptions for the custom field type crm.userfield.settings.fields	Yes	Yes	No	No	No

Overview of Methods

Method	Description
crm.requisite.userfield.add.md	Creates a new custom field for a requisite
crm.requisite.userfield.update.md	Modifies an existing custom field for a requisite
crm.requisite.userfield.get.md	Returns a custom field for a requisite by identifier
crm.requisite.userfield.list.md	Returns a list of custom fields for requisites by filter
crm.requisite.userfield.delete.md	Deletes a custom field for a requisite

Get Description of Bank Detail Fields

Create a New Custom Requisite Field

About Custom Fields for Requisites

Fields Describing a Custom Field for RequisitesFields Describing a Custom Field for Requisites

Overview of MethodsOverview of Methods

Fields Describing a Custom Field for Requisites

Overview of Methods