Get the link of the requisite with the object crm.requisite.link.get

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).

Identifiers of CRM object types 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 (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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

try
        {
        	const response = await $b24.callMethod(
        		"crm.requisite.link.get", {
        			entityTypeId: 31,        // Identifier of the type (Invoice)
        			entityId: 315,             // Identifier of the invoice
        		}
        	);
        	
        	const result = response.getData().result;
        	console.dir(result);
        }
        catch(error)
        {
        	console.error(error);
        }

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,        // Identifier of the type (Invoice)
                entityId: 315,             // Identifier of the invoice
            },
            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>';

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 execution time of the request

Description of the requisite link fields with the CRM object

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). Identifiers of CRM object types can be obtained using the method crm.enum.ownertype
ENTITY_ID `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
REQUISITE_ID `integer`	Identifier of the client's requisite selected for the object. Identifiers of requisites can be obtained using the method crm.requisite.list
BANK_DETAIL_ID `integer`	Identifier of the client's bank requisite selected for the object. Identifiers of bank requisites can be obtained using the method crm.requisite.bankdetail.list
MC_REQUISITE_ID `integer`	Identifier of my company's requisite selected for the object. Identifiers of requisites 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. Identifiers of bank requisites 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 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

Get a List of Requisite Connections

Get the link of the requisite with the object crm.requisite.link.get

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Description of the requisite link fields with the CRM objectDescription of the requisite link fields with the CRM object

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning