Custom Fields for Estimates: Overview of Methods and Events

Custom fields add data to the estimate detail form for which there are no system fields: a string, a number, a link, an address, a reference to another CRM object. The methods for working with the estimates themselves are collected in the section Estimates.

Quick navigation: all methods and events

User documentation: Custom fields in CRM

Getting StartedGetting Started

1. Choose the field type — it determines the format of the stored data and the set of available settings. The full list of types is returned by the method crm.userfield.types
2. Find out which settings the chosen type supports using the method crm.userfield.settings.fields, and the list of general field characteristics using the method crm.userfield.fields
3. Create the field using the method crm.quote.userfield.add. The response contains the field identifier, and the full name is returned by the method crm.quote.userfield.get
4. Write and read the field value by its full name in the methods crm.quote.add, crm.quote.update, and crm.quote.get

Custom Field NameCustom Field Name

The field code is passed in the required parameter FIELD_NAME of the method crm.quote.userfield.add, and the system builds the full name itself: the prefix UF_CRM_ is added to the code. For FIELD_NAME = MANAGER_NOTE, the full field name will be UF_CRM_MANAGER_NOTE. For fields created in the Bitrix24 interface, the code is substituted automatically, and their names look like UF_CRM_QUOTE_1768404002.

It is the full name that is used further on:

• in the fields parameter of the methods crm.quote.add and crm.quote.update — to write the value
• in the select parameter of the method crm.quote.list — to return the value in the selection. The UF_* mask selects all custom fields at once
• in the FIELD_NAME field of custom field events — to determine which field has changed

Types of Custom FieldsTypes of Custom Fields

The type is set in the USER_TYPE_ID field when the field is created and cannot be changed afterwards.

Type	What It Stores
string	A string
integer	An integer
double	A floating-point number
boolean	A yes or no value
date	A date
datetime	A date and time
money	An amount with a currency
url	A link
address	An address on a map
file	A file
enumeration	A value from a list that is defined in the LIST field
employee	A reference to a Bitrix24 user
crm	A reference to a CRM entity: a lead, deal, contact, or company
crm_status	A reference to a CRM reference guide item
iblock_element	A reference to an information block element
iblock_section	A reference to an information block section

The current list of types is returned by the method crm.userfield.types, and the set of settings for a specific type — by the method crm.userfield.settings.fields.

Errors When Working with Custom FieldsErrors When Working with Custom Fields

When creating or deleting custom fields, the request may be interrupted with an error INTERNAL_SERVER_ERROR. This is an internal server error, and its cause is visible only in the server logs at the time of the request:

• in cloud Bitrix24, submit a request to technical support to get details about the error
• in on-premise Bitrix24, request the server error log from the server or hosting administrator, and then contact technical support and attach the log for analysis

Common Causes of Server ErrorsCommon Causes of Server Errors

1. You can create 1016 custom fields for estimates — this is a limitation of the database architecture. If there are already 1016 fields for estimates in Bitrix24, attempting to create a new field will result in the method crm.quote.userfield.add returning an error INTERNAL_SERVER_ERROR

   You can check the number of custom fields for estimates using the method crm.quote.userfield.list

2. There is a limitation on servers for the execution time of a single request — max_execution_time, with a standard value of 60 seconds. If the request takes longer, it is interrupted with an error INTERNAL_SERVER_ERROR

   The time for creating or deleting a custom field depends on the number of estimates: when a field is created, it is added to all estimate detail forms, and when it is deleted, it is removed from all detail forms. The fewer estimates you have in Bitrix24, the faster fields are created and deleted

   To find out the number of estimates, use the method crm.quote.list

Overview of Methods and EventsOverview of Methods and Events

Scope: crm

Who can execute the method: depending on the method — only a CRM administrator can create, update, and delete fields, while a user with permission to read estimates can read them