Register Requisite Link with Object crm.requisite.link.register

Scope: crm

Who can execute the method: any user

This method registers a link between requisites and an object.

For successful registration, the requisite IDs must belong to the client and seller selected in the linked object. If a requisite is not available, its ID is passed as 0. You can even specify all requisite IDs as zero. In this case, it is considered that the requisites are not linked to the object.

Method Parameters

Required parameters are marked with *

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

Parameter fields

Required parameters are marked with *

Name `type`	Description
ENTITY_TYPE_ID* `integer`	Identifier of the object type to which the link belongs. The following types can be used: deal (value `2`) old invoice (value `5`) estimate (value `7`) new invoice (value `31`) other dynamic objects (for possible values, see the method crm.type.list). You can obtain CRM object type identifiers using the method crm.enum.ownertype
ENTITY_ID* `integer`	Identifier of the object to which the link belongs. Object identifiers can be obtained using the following methods: crm.deal.list, crm.quote.list, crm.item.list
REQUISITE_ID* `integer`	Identifier of the client's requisite selected for the object. Requisite identifiers can be obtained using the method crm.requisite.list
BANK_DETAIL_ID* `integer`	Identifier of the client's bank requisite selected for the object. Bank requisite identifiers can be obtained using the method crm.requisite.bankdetail.list
MC_REQUISITE_ID* `integer`	Identifier of my company's requisite selected for the object. Requisite identifiers can be obtained using the method crm.requisite.list
MC_BANK_DETAIL_ID* `integer`	Identifier of my company's bank requisite selected for the object. Bank requisite identifiers can be obtained using the method crm.requisite.bankdetail.list

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":31,"ENTITY_ID":315,"REQUISITE_ID":60,"BANK_DETAIL_ID":24,"MC_REQUISITE_ID":2,"MC_BANK_DETAIL_ID":2}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.link.register

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"ENTITY_TYPE_ID":31,"ENTITY_ID":315,"REQUISITE_ID":60,"BANK_DETAIL_ID":24,"MC_REQUISITE_ID":2,"MC_BANK_DETAIL_ID":2},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.requisite.link.register

try
        {
        	const response = await $b24.callMethod(
        		"crm.requisite.link.register", {
        			fields: {
        				ENTITY_TYPE_ID: 31,
        				ENTITY_ID: 315,
        				REQUISITE_ID: 60,
        				BANK_DETAIL_ID: 24,
        				MC_REQUISITE_ID: 2,
        				MC_BANK_DETAIL_ID: 2
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.dir(result);
        }
        catch( error )
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.requisite.link.register',
                    [
                        'fields' => [
                            'ENTITY_TYPE_ID'  => 31,
                            'ENTITY_ID'       => 315,
                            'REQUISITE_ID'    => 60,
                            'BANK_DETAIL_ID'  => 24,
                            'MC_REQUISITE_ID' => 2,
                            'MC_BANK_DETAIL_ID' => 2,
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error registering requisite link: ' . $e->getMessage();
        }

BX24.callMethod(
            "crm.requisite.link.register", {
                fields: {
                    ENTITY_TYPE_ID: 31,
                    ENTITY_ID: 315,
                    REQUISITE_ID: 60,       // Identifier of the requisite belonging to the buyer
                    BANK_DETAIL_ID: 24,     // Identifier of the bank requisite belonging to the buyer
                    MC_REQUISITE_ID: 2,     // Identifier of the requisite belonging to the selling company
                    MC_BANK_DETAIL_ID: 2    // Identifier of the bank requisite belonging to the selling company
                }
            },
            function (result)
            {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.requisite.link.register',
            [
                'fields' =>
                [
                    'ENTITY_TYPE_ID' => 31,
                    'ENTITY_ID' => 315,
                    'REQUISITE_ID' => 60,
                    'BANK_DETAIL_ID' => 24,
                    'MC_REQUISITE_ID' => 2,
                    'MC_BANK_DETAIL_ID' => 2
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result": true,
            "time": {
                "start": 1718729280.575321,
                "finish": 1718729281.296214,
                "duration": 0.720893144607544,
                "processing": 0.1967611312866211,
                "date_start": "2024-06-18T18:48:00+02:00",
                "date_finish": "2024-06-18T18:48:01+02:00",
                "operating": 0.1967298984527588
            }
        }

Returned Data

Name
type

Description

result
boolean

Result of the link registration:

true — link registered
false — link not registered

time
time

Information about the request execution time

Error Handling

HTTP status: 40x, 50x

{
            "error": "",
            "error_description": "Entity is 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
`ENTITY_TYPE_ID is not defined or invalid`	Object type identifier is not set or has an invalid value
`ENTITY_ID is not defined or invalid`	Object identifier is not set or has an invalid value
`REQUISITE_ID is not defined or invalid`	Client requisite identifier is not set or has an invalid value
`BANK_DETAIL_ID is not defined or invalid`	Client bank requisite identifier is not set or has an invalid value
`MC_REQUISITE_ID is not defined or invalid`	My company requisite identifier is not set or has an invalid value
`MC_BANK_DETAIL_ID is not defined or invalid`	My company bank requisite identifier is not set or has an invalid value
`The Requisite with ID '60' is not found`	Client requisite with the specified identifier not found
`The Requisite with ID '60' is not assigned to Company with ID '5'`	Client requisite with the specified identifier does not belong to the company specified in the object
`The BankDetail with ID '24' is not found`	Client bank requisite with the specified identifier not found
`The BankDetail with ID '24' is not assigned to Requisite with ID '60'`	Client bank requisite with the specified identifier does not belong to the specified requisite
`The Requisite of your company with ID '2' is not found`	My company requisite with the specified identifier not found
`The Requisite with ID '2' is not assigned to your company with ID '3010'`	My company requisite with the specified identifier does not belong to my company specified in the object
`The BankDetail of your company with ID '2' is not found`	My company bank requisite with the specified identifier not found
`The BankDetail of your company with ID '2' is not assigned to Requisite of your company with ID '2'`	My company bank requisite with the specified identifier does not belong to the specified 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

Get the Connection of a Requisite with an Object

Register Requisite Link with Object crm.requisite.link.register

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning