Get Fields Available for Addition to the Requisite Template crm.requisite.preset.field.availabletoadd

Scope: crm

Who can execute the method: any user

The method returns fields available for addition to the specified requisite template.

Method Parameters

Required parameters are marked with *

Name
type

Description

preset*
object

An object containing the identifier of the template for which to retrieve the list of available customizable fields.

Template identifiers can be obtained using the crm.requisite.preset.list method.

Fields with the prefix UF_ in the response are custom fields (see methods for working with custom requisite fields)

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"preset":{"ID":27}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.preset.field.availabletoadd

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"preset":{"ID":27},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.requisite.preset.field.availabletoadd

try
        {
        	const response = await $b24.callMethod(
        		"crm.requisite.preset.field.availabletoadd",
        		{
        			preset:
        			{
        				"ID": 27
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	if(result.error())
        	{
        		console.error(result.error());
        	}
        	else
        	{
        		console.dir(result);
        	}
        }
        catch(error)
        {
        	console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.requisite.preset.field.availabletoadd',
                    [
                        'preset' => [
                            'ID' => 27
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error checking available fields: ' . $e->getMessage();
        }

BX24.callMethod(
            "crm.requisite.preset.field.availabletoadd",
            {
                preset:
                {
                    "ID": 27
                }
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.requisite.preset.field.availabletoadd',
            [
                'preset' => ['ID' => 27]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "result": [
                "RQ_FIRST_NAME",
                "RQ_LAST_NAME",
                "RQ_SECOND_NAME",
                "RQ_COMPANY_NAME",
                "RQ_COMPANY_FULL_NAME",
                "RQ_COMPANY_REG_DATE",
                "RQ_DIRECTOR",
                "RQ_ACCOUNTANT",
                "RQ_ADDR",
                "RQ_CONTACT",
                "RQ_EMAIL",
                "RQ_PHONE",
                "RQ_FAX",
                "RQ_IDENT_DOC",
                "RQ_IDENT_DOC_SER",
                "RQ_IDENT_DOC_NUM",
                "RQ_IDENT_DOC_DATE",
                "RQ_IDENT_DOC_ISSUED_BY",
                "RQ_IDENT_DOC_DEP_CODE",
                "RQ_INN",
                "RQ_KPP",
                "RQ_IFNS",
                "RQ_OGRN",
                "RQ_OGRNIP",
                "RQ_OKPO",
                "RQ_OKTMO",
                "RQ_OKVED",
                "RQ_ST_CERT_SER",
                "RQ_ST_CERT_NUM",
                "RQ_ST_CERT_DATE",
                "RQ_SIGNATURE",
                "RQ_STAMP",
                "UF_CRM_1707997209",
                "UF_CRM_1707997236",
                "UF_CRM_1707997253",
                "UF_CRM_1708012333"
            ]
        }

Returned Data

Name `type`	Description
result `array`	An array with the names of fields that can be added to the specified requisite template
time `time`	Information about the execution time of the request

Field Descriptions

Name `type`	Description
RQ_FIRST_NAME `string`	First name
RQ_LAST_NAME `string`	Last name
RQ_SECOND_NAME `string`	Middle name
RQ_COMPANY_NAME `string`	Short name of the organization
RQ_COMPANY_FULL_NAME `string`	Full name of the organization
RQ_COMPANY_REG_DATE `string`	Date of state registration
RQ_DIRECTOR `string`	General director
RQ_ACCOUNTANT `string`	Chief accountant
RQ_CONTACT `string`	Contact person
RQ_EMAIL `string`	E-Mail
RQ_PHONE `string`	Phone
RQ_FAX `string`	Fax
RQ_IDENT_DOC `string`	Type of document
RQ_IDENT_DOC_SER `string`	Series
RQ_IDENT_DOC_NUM `string`	Number
RQ_IDENT_DOC_DATE `string`	Date of issue
RQ_IDENT_DOC_ISSUED_BY `string`	Issued by
RQ_IDENT_DOC_DEP_CODE `string`	Department code
RQ_INN `string`	Tax Identification Number
RQ_KPP `string`	Tax Registration Reason Code
RQ_IFNS `string`	Tax Authority Code
RQ_OGRN `string`	Primary State Registration Number
RQ_OGRNIP `string`	Individual Entrepreneur Registration Number
RQ_OKPO `string`	All-Russian Classifier of Enterprises and Organizations Code
RQ_OKTMO `string`	All-Russian Classifier of Territories Code
RQ_OKVED `string`	All-Russian Classifier of Economic Activities Code
RQ_ST_CERT_SER `string`	Series of State Registration Certificate
RQ_ST_CERT_NUM `string`	Number of State Registration Certificate
RQ_ST_CERT_DATE `string`	Date of State Registration Certificate
UF_CRM_1707997209 `double`	Custom Field of Type "Number"
UF_CRM_1707997236 `boolean`	Custom Field of Type "Yes/No"
UF_CRM_1707997253 `datetime`	Custom Field of Type "Date"
UF_CRM_1708012333 `string`	Custom Field of Type "String"

Error Handling

HTTP Status: 40x, 50x

{
            "error": "",
            "error_description": "Template not found."
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code	Description
`Template not found`	The template for which to retrieve the list of available fields was not found

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Update Custom Field of a Given Requisite Template

Get Custom Field of Requisite Template by ID

Get Fields Available for Addition to the Requisite Template crm.requisite.preset.field.availabletoadd

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Field DescriptionsField Descriptions

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning