Get the Link of the Requisite with the Object crm.requisite.link.get

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Scope: crm

Who can execute the method: any user

The method returns the link of the requisites with the object.

Method Parameters

Required parameters are marked with *

Name
type

Description

entityTypeId*
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

entityId*
integer

Identifier of the object to which the link belongs.

Identifiers of objects can be obtained using the following methods: crm.deal.list, crm.quote.list, crm.item.list.

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"entityTypeId":31,"entityId":315}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.link.get
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"entityTypeId":31,"entityId":315,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.requisite.link.get
        
// 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
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type RequisiteLinkGetResult = {
          ENTITY_TYPE_ID: number
          ENTITY_ID: number
          REQUISITE_ID: string
          BANK_DETAIL_ID: string
          MC_REQUISITE_ID: string
          MC_BANK_DETAIL_ID: string
        }
        
        try {
          const response = await $b24.actions.v2.call.make<RequisiteLinkGetResult>({
            method: 'crm.requisite.link.get',
            params: {
              entityTypeId: 31,
              entityId: 315,
            },
            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(result.ENTITY_TYPE_ID, result.ENTITY_ID, result.REQUISITE_ID)
          }
        } 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 getRequisiteLink() {
            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.get',
                params: {
                  entityTypeId: 31,
                  entityId: 315,
                },
                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(result.ENTITY_TYPE_ID, result.ENTITY_ID, result.REQUISITE_ID)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getRequisiteLink)
        </script>
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.requisite.link.get',
                    [
                        'entityTypeId' => 31,
                        'entityId'     => 315,
                    ]
                );
        
            $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 getting requisite link: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "crm.requisite.link.get", {
                entityTypeId: 31,        // Type Identifier (Account)
                entityId: 315,             // Account 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.get',
            [
                'entityTypeId' => 31,
                'entityId' => 315
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        
from b24pysdk.client import BaseClient
        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        client: BaseClient
        
        try:
            bitrix_response = client.crm.requisite.link.get(
                entity_type_id=31,
                entity_id=315,
            ).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}")
        

Response Handling

HTTP status: 200

{
            "result": {
                "ENTITY_TYPE_ID": 31,
                "ENTITY_ID": 315,
                "REQUISITE_ID": "60",
                "BANK_DETAIL_ID": "24",
                "MC_REQUISITE_ID": "2",
                "MC_BANK_DETAIL_ID": "2"
            },
            "time": {
                "start": 1718378061.651857,
                "finish": 1718378062.098295,
                "duration": 0.4464380741119385,
                "processing": 0.07567882537841797,
                "date_start": "2024-06-14T17:14:21+02:00",
                "date_finish": "2024-06-14T17:14:22+02:00",
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
Object

An object containing the values of the requisite link fields

time
time

Information about the request execution time

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

Error Handling

HTTP status: 40x, 50x

{
            "error": "",
            "error_description": "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

entityTypeId is not defined or invalid

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

entityId is not defined or invalid

The object identifier is not set or has an invalid value

Not found

The requisite link was not found

Access denied

Insufficient access permissions to retrieve the requisite link

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 permitted for calls 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 HTTPS protocol is required for method calls

503

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it

403

ACCESS_DENIED
REST API is available only on commercial plans

The REST API is only available on commercial plans

403

INVALID_CREDENTIALS
Invalid request credentials

The user associated with the access token or webhook used to call the method lacks the necessary 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 portal administrator has restricted access to this application to specific users only

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 "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