Получить связь реквизита с объектом crm.requisite.link.get

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: crm

Кто может выполнять метод: любой пользователь

Метод возвращает связь реквизитов с объектом.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

entityTypeId*
integer

Идентификатор типа объекта, к которому относится связь.

Могут использоваться следующие типы:

  • сделка (значение 2)
  • старый счет (значение 5)
  • предложение (значение 7)
  • новый счет (значение 31)
  • другие динамические объекты (для получения возможных значений смотрите метод crm.type.list).

Идентификаторы типов объектов CRM можно получить с помощью метода crm.enum.ownertype

entityId*
integer

Идентификатор объекта, к которому относится связь.

Идентификаторы объектов можно получить с помощью следующих методов: crm.deal.list, crm.quote.list, crm.item.list.

Примеры кода

Как использовать примеры в документации

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,        // Идентификатор типа (Счёт)
        			entityId: 315,             // Идентификатор счёта
        		}
        	);
        	
        	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,        // Идентификатор типа (Счёт)
                entityId: 315,             // Идентификатор счёта
            },
            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>';

Обработка ответа

HTTP-статус: 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
            }
        }

Возвращаемые данные

Название
тип

Описание

result
Object

Объект, содержащий значения полей связи реквизита

time
time

Информация о времени выполнения запроса

Описание полей связи реквизита с объектом CRM

Название
тип

Описание

ENTITY_TYPE_ID
integer

Идентификатор типа объекта, к которому относится связь.

Могут использоваться следующие типы:

  • сделка (значение 2)
  • старый счет (значение 5)
  • предложение (значение 7)
  • новый счет (значение 31)
  • другие динамические объекты (для получения возможных значений смотрите метод crm.type.list).

Идентификаторы типов объектов CRM можно получить с помощью метода crm.enum.ownertype

ENTITY_ID
integer

Идентификатор объекта, к которому относится связь.

Идентификаторы объектов можно получить с помощью следующих методов: crm.deal.list, crm.quote.list, crm.item.list

REQUISITE_ID
integer

Идентификатор реквизита клиента, выбранного для объекта.

Идентификаторы реквизитов можно получить с помощью метода crm.requisite.list

BANK_DETAIL_ID
integer

Идентификатор банковского реквизита клиента, выбранного для объекта.

Идентификаторы банковских реквизитов можно получить с помощью метода crm.requisite.bankdetail.list

MC_REQUISITE_ID
integer

Идентификатор реквизита моей компании, выбранного для объекта.

Идентификаторы реквизитов можно получить с помощью метода crm.requisite.list

MC_BANK_DETAIL_ID
integer

Идентификатор банковского реквизита моей компании, выбранного для объекта.

Идентификаторы банковских реквизитов можно получить с помощью метода crm.requisite.bankdetail.list

Обработка ошибок

HTTP-статус: 40x, 50x

{
            "error": "",
            "error_description": "Not found"
        }

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код

Описание

entityTypeId is not defined or invalid

Идентификатор типа объекта не задан или имеет недопустимое значение

entityId is not defined or invalid

Идентификатор объекта не задан или имеет недопустимое значение

Not found

Связь реквизита не найдена

Access denied

Недостаточно прав доступа для получения связи реквизита

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

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

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Предыдущая
Зарегистрировать связь реквизитов с объектом
Следующая
Получить список связей реквизитов