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

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: crm

Who can execute the method: a user with "edit" access permission for the CRM object the link is registered for

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 (to get possible values, see the method crm.type.list).

Object type identifiers can be obtained 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 -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
        
// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        try {
          const response = await $b24.actions.v2.call.make<boolean>({
            method: 'crm.requisite.link.register',
            params: {
              fields: {
                ENTITY_TYPE_ID: 31,
                ENTITY_ID: 315,
                REQUISITE_ID: 60,
                BANK_DETAIL_ID: 24,
                MC_REQUISITE_ID: 2,
                MC_BANK_DETAIL_ID: 2,
              },
            },
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Link registered:', result)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function registerRequisiteLink() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'crm.requisite.link.register',
                params: {
                  fields: {
                    ENTITY_TYPE_ID: 31,
                    ENTITY_ID: 315,
                    REQUISITE_ID: 60,
                    BANK_DETAIL_ID: 24,
                    MC_REQUISITE_ID: 2,
                    MC_BANK_DETAIL_ID: 2,
                  },
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Link registered:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', registerRequisiteLink)
        </script>
        

        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.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,
                },
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected 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,       // Buyer's payment detail identifier
                    BANK_DETAIL_ID: 24,     // Buyer's bank detail identifier
                    MC_REQUISITE_ID: 2,     // Seller company's payment detail identifier
                    MC_BANK_DETAIL_ID: 2    // Seller company's bank detail identifier
                }
            },
            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>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "crm.requisite.link.register", b24.Params{
        	"fields": b24.Params{
        		"ENTITY_TYPE_ID":    31,
        		"ENTITY_ID":         315,
        		"REQUISITE_ID":      60,
        		"BANK_DETAIL_ID":    24,
        		"MC_REQUISITE_ID":   2,
        		"MC_BANK_DETAIL_ID": 2,
        	},
        })
        if err != nil {
        	return fmt.Errorf("crm.requisite.link.register: %w", err)
        }
        
        var ok bool
        if err := json.Unmarshal(res.Result, &ok); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println("done:", ok)
        

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 consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Code

Description

ENTITY_TYPE_ID is not defined or invalid

The object type identifier is not set or has an invalid value

ENTITY_ID is not defined or invalid

The 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: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not found!

No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning