Add Requisite crm.requisite.add

Scope: crm

Who can execute the method: any user

This method adds a new requisite.

Method Parameters

Required parameters are marked with *

Name `type`	Description
fields* `object`	Set of fields — an object of the form `{"field": "value"[, ...]}` for adding the requisite

Parameter fields

Required parameters are marked with *

Name `type`	Description
ENTITY_TYPE_ID* `integer`	Identifier of the parent entity type. Currently, this can only be: `3` — contact `4` — company Identifiers for all CRM entity types can be retrieved using the method crm.enum.ownertype
ENTITY_ID* `integer`	Identifier of the parent entity (contact or company). The identifier can be obtained using the method crm.company.list for a company and the method crm.contact.list for a contact
PRESET_ID* `integer`	Identifier of the requisite template. Template identifiers can be obtained using the method crm.requisite.preset.list
NAME* `string`	Name of the requisite
CODE `string`	Symbolic code of the requisite
XML_ID `string`	External key, used for exchange operations. Identifier of the external information database. The purpose of the field may change by the final developer
ORIGINATOR_ID `string`	Identifier of the external information database. The purpose of the field may change by the final developer
ACTIVE `char`	Activity status. Values `Y` or `N` are used. Currently, the field does not affect anything
ADDRESS_ONLY `char`	Status indicator when the requisite is used only for storing the address. Values `Y` or `N` are used. When set to `Y`, the requisites are not displayed in the entity card, but the address is shown
SORT `integer`	Sorting. Order in the list of requisites of the entity when there are multiple
RQ_NAME `string`	Full name
RQ_FIRST_NAME `string`	First name
RQ_LAST_NAME `string`	Last name
RQ_SECOND_NAME `string`	Middle name
RQ_COMPANY_ID `string`	Identifier of the organization
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_CEO_NAME `string`	Full name of the first leader
RQ_CEO_WORK_POS `string`	Position of the first leader
RQ_CONTACT `string`	Contact person
RQ_EMAIL `string`	E-Mail
RQ_PHONE `string`	Phone
RQ_FAX `string`	Fax
RQ_IDENT_TYPE `crm_status`	Method of identification
RQ_IDENT_DOC `string`	Type of document
RQ_IDENT_DOC_SER `string`	Series
RQ_IDENT_DOC_NUM `string`	Number
RQ_IDENT_DOC_PERS_NUM `string`	Personal 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`	Taxpayer Identification Number
RQ_KPP `string`	Tax Registration Reason Code
RQ_USRLE `string`	Handelsregisternummer (for country DE)
RQ_IFNS `string`	Tax Authority
RQ_OGRN `string`	Primary State Registration Number
RQ_OGRNIP `string`	OGRNIP
RQ_OKPO `string`	OKPO
RQ_OKTMO `string`	OKTMO
RQ_OKVED `string`	OKVED
RQ_EDRPOU `string`	EDRPOU
RQ_DRFO `string`	DRFO
RQ_KBE `string`	KBE
RQ_IIN `string`	IIN
RQ_BIN `string`	BIN
RQ_ST_CERT_SER `string`	Series of the state registration certificate
RQ_ST_CERT_NUM `string`	Number of the state registration certificate
RQ_ST_CERT_DATE `string`	Date of the state registration certificate
RQ_VAT_PAYER `char`	VAT payer (for country UA). Values `Y` or `N` are used
RQ_VAT_ID `string`	VAT ID (identification number of VAT payer)
RQ_VAT_CERT_SER `string`	Series of the VAT certificate
RQ_VAT_CERT_NUM `string`	Number of the VAT certificate
RQ_VAT_CERT_DATE `string`	Date of the VAT certificate
RQ_RESIDENCE_COUNTRY `string`	Country of residence
RQ_BASE_DOC `string`	Basis for action
RQ_REGON `string`	REGON (for country PL)
RQ_KRS `string`	KRS (for country PL)
RQ_PESEL `string`	PESEL (for country PL)
RQ_LEGAL_FORM `string`	Legal form (for country FR)
RQ_SIRET `string`	Siret number (for country FR)
RQ_SIREN `string`	Siren number (for country FR)
RQ_CAPITAL `string`	Share capital (for country FR)
RQ_RCS `string`	RCS (for country FR)
RQ_CNPJ `string`	CNPJ (for country BR)
RQ_STATE_REG `string`	State Registration (IE) (for country BR)
RQ_MNPL_REG `string`	Municipal Registration (IM) (for country BR)
RQ_CPF `string`	CPF (for country BR)
UF_CRM_...	Custom fields. For example, `UF_CRM_1694526604`. Requisites can have a set of custom fields with types: `string`, `boolean`, `double`, `datetime`. You can add a custom field to requisites using the method crm.requisite.userfield.add

Which fields with the prefix RQ_ can be specified?

When creating a requisite, only those fields with the prefix RQ_ that are present in the requisite template linked to the created requisite (see the field PRESET_ID) should be specified. The values of other fields will be saved but will not be visible to the user.

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 '{"fields":{"ENTITY_TYPE_ID":4,"ENTITY_ID":1,"PRESET_ID":1,"NAME":"Organization","ACTIVE":"Y","ADDRESS_ONLY":"N","SORT":500,"RQ_COMPANY_NAME":"Ltd. \"QuickBooks and other similar platforms\"","RQ_COMPANY_FULL_NAME":"LIMITED LIABILITY COMPANY \"QuickBooks and other similar platforms\"","RQ_COMPANY_REG_DATE":"06.04.2007","RQ_DIRECTOR":"SMITH JOHN","RQ_INN":"7717586110","RQ_KPP":"770501001","RQ_OGRN":"5077746476209","UF_CRM_1707997209":"56","UF_CRM_1708012333":"Category 1","XML_ID":"5e4641fd-1dd9-11e6-b2f2-005056c00008"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"ENTITY_TYPE_ID":4,"ENTITY_ID":1,"PRESET_ID":1,"NAME":"Organization","ACTIVE":"Y","ADDRESS_ONLY":"N","SORT":500,"RQ_COMPANY_NAME":"Ltd. \"QuickBooks and other similar platforms\"","RQ_COMPANY_FULL_NAME":"LIMITED LIABILITY COMPANY \"QuickBooks and other similar platforms\"","RQ_COMPANY_REG_DATE":"06.04.2007","RQ_DIRECTOR":"SMITH JOHN","RQ_INN":"7717586110","RQ_KPP":"770501001","RQ_OGRN":"5077746476209","UF_CRM_1707997209":"56","UF_CRM_1708012333":"Category 1","XML_ID":"5e4641fd-1dd9-11e6-b2f2-005056c00008","auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.requisite.add

try
        {
        	const response = await $b24.callMethod(
        		"crm.requisite.add",
        		{
        			fields:
        			{
        				"ENTITY_TYPE_ID": 4,
        				"ENTITY_ID": 1,
        				"PRESET_ID": 1,
        				"NAME": "Organization",
        				"ACTIVE": "Y",
        				"ADDRESS_ONLY": "N",
        				"SORT": 500,
                        "RQ_COMPANY_NAME": "Ltd. \"QuickBooks and other similar platforms\"",
                        "RQ_COMPANY_FULL_NAME": "LIMITED LIABILITY COMPANY \"QuickBooks and other similar platforms\"",
                        "RQ_COMPANY_REG_DATE": "06.04.2007",
                        "RQ_DIRECTOR": "SMITH JOHN",
        				"RQ_INN": "7717586110",
        				"RQ_KPP": "770501001",
        				"RQ_OGRN": "5077746476209",
        				"UF_CRM_1707997209": "56",
        				"UF_CRM_1708012333": "Category 1",
        				"XML_ID": "5e4641fd-1dd9-11e6-b2f2-005056c00008"
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info("Requisite created with ID " + result);
        }
        catch(error)
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.requisite.add',
                    [
                        'fields' => [
                            'ENTITY_TYPE_ID'        => 4,
                            'ENTITY_ID'             => 1,
                            'PRESET_ID'             => 1,
                            'NAME'                  => 'Organization',
                            'ACTIVE'                => 'Y',
                            'ADDRESS_ONLY'          => 'N',
                            'SORT'                  => 500,
                            "RQ_COMPANY_NAME" => "Ltd. \"QuickBooks and other similar platforms\"",
                            "RQ_COMPANY_FULL_NAME" => "LIMITED LIABILITY COMPANY \"QuickBooks and other similar platforms\"",
                            "RQ_COMPANY_REG_DATE" => "06.04.2007",
                            "RQ_DIRECTOR" => "SMITH JOHN",
                            'RQ_INN'                => '7717586110',
                            'RQ_KPP'                => '770501001',
                            'RQ_OGRN'               => '5077746476209',
                            'UF_CRM_1707997209'     => '56',
                            'UF_CRM_1708012333'     => 'Category 1',
                            'XML_ID'                => '5e4641fd-1dd9-11e6-b2f2-005056c00008',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Requisite created with ID ' . $result;
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error creating requisite: ' . $e->getMessage();
        }

BX24.callMethod(
            "crm.requisite.add",
            {
                fields:
                {
                    "ENTITY_TYPE_ID": 4,
                    "ENTITY_ID": 1,
                    "PRESET_ID": 1,
                    "NAME": "Organization",
                    "ACTIVE": "Y",
                    "ADDRESS_ONLY": "N",
                    "SORT": 500,
                    "RQ_COMPANY_NAME": "Ltd. \"QuickBooks and other similar platforms\"",
                    "RQ_COMPANY_FULL_NAME": "LIMITED LIABILITY COMPANY \"QuickBooks and other similar platforms\"",
                    "RQ_COMPANY_REG_DATE": "06.04.2007",
                    "RQ_DIRECTOR": "SMITH JOHN",
                    "RQ_INN": "7717586110",
                    "RQ_KPP": "770501001",
                    "RQ_OGRN": "5077746476209",
                    "UF_CRM_1707997209": "56",
                    "UF_CRM_1708012333": "Category 1",
                    "XML_ID": "5e4641fd-1dd9-11e6-b2f2-005056c00008"
                }
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                    console.info("Requisite created with ID " + result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.requisite.add',
            [
                'fields' => [
                    "ENTITY_TYPE_ID" => 4,
                    "ENTITY_ID" => 1,
                    "PRESET_ID" => 1,
                    "NAME" => "Organization",
                    "ACTIVE" => "Y",
                    "ADDRESS_ONLY" => "N",
                    "SORT" => 500,
                    "RQ_COMPANY_NAME" => "Ltd. \"QuickBooks and other similar platforms\"",
                    "RQ_COMPANY_FULL_NAME" => "LIMITED LIABILITY COMPANY \"QuickBooks and other similar platforms\"",
                    "RQ_COMPANY_REG_DATE" => "06.04.2007",
                    "RQ_DIRECTOR" => "SMITH JOHN",
                    "RQ_INN" => "7717586110",
                    "RQ_KPP" => "770501001",
                    "RQ_OGRN" => "5077746476209",
                    "UF_CRM_1707997209" => "56",
                    "UF_CRM_1708012333" => "Category 1",
                    "XML_ID" => "5e4641fd-1dd9-11e6-b2f2-005056c00008"
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response on Success

HTTP status: 200

{
            "result": 27,
            "time": {
                "start": 1716998748.040801,
                "finish": 1716998749.444508,
                "duration": 1.4037070274353027,
                "processing": 0.32904696464538574,
                "date_start": "2024-05-29T18:05:48+02:00",
                "date_finish": "2024-05-29T18:05:49+02:00",
                "operating": 0.32897305488586426
            }
        }

Returned Data

Name `type`	Description
result `integer`	Identifier of the created requisite
time `time`	Information about the execution time of the request

Response on Error

HTTP status: 400

{
            "error": "",
            "error_description": "ENTITY_TYPE_ID is not defined or invalid."
        }

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 Errors

Code	Error Text	Description
Empty string	ENTITY_TYPE_ID is not defined or invalid.	Identifier of the parent entity type is not defined or has an invalid value
Empty string	ENTITY_ID is not defined or invalid.	Identifier of the parent entity is not defined or has an invalid value
Empty string	PRESET_ID is not defined or invalid.	Identifier of the requisite template is not defined or has an invalid value
Empty string	Entity not found.	The entity for which the requisite is being created was not found
Empty string	Access denied.	Insufficient access permissions to add the requisite

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

Overview of methods

Update detail

Add Requisite crm.requisite.add

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Code ExamplesCode Examples

Response on SuccessResponse on Success

Returned DataReturned Data

Response on ErrorResponse on Error

Possible ErrorsPossible Errors

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning