Зарегистрировать связь реквизитов с объектом crm.requisite.link.register

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

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

Scope: crm

Кто может выполнять метод: пользователь с правом на изменение объекта CRM, для которого регистрируется связь

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

Для успешной регистрации идентификаторы реквизитов должны принадлежать клиенту и продавцу, которые выбраны в связываемом объекте. Если какого-то реквизита нет, то его идентификатор передается как 0. Можно даже указать все идентификаторы реквизитов нулевыми. Тогда считается, что к объекту реквизиты не привязаны.

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

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

Название
тип

Описание

fields*
object

Набор полей связи реквизита — объект вида {"поле": "значение"[, ...]}

Параметр fields

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

Название
тип

Описание

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

Примеры кода

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

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",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {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,       // Идентификатор реквизита, принадлежащего покупателю
            BANK_DETAIL_ID: 24,     // Идентификатор банковского реквизита, принадлежащего покупателю
            MC_REQUISITE_ID: 2,     // Идентификатор реквизита, принадлежащего компании-продавцу
            MC_BANK_DETAIL_ID: 2    // Идентификатор банковского реквизита, принадлежащего компании-продавцу
        }
    },
    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 и ctx уже созданы — см. раздел «SDK для Go»
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("разбор ответа: %w", err)
}
fmt.Println("выполнено:", ok)

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

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

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

Название
тип

Описание

result
boolean

Результат регистрации связи:

  • true — связь зарегистрирована
  • false — связь не зарегистрирована

time
time

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

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

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

{
    "error": "",
    "error_description": "Entity is not found"
}

Название
тип

Описание

error
string

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

error_description
string

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

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

Код

Описание

ENTITY_TYPE_ID is not defined or invalid

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

ENTITY_ID is not defined or invalid

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

REQUISITE_ID is not defined or invalid

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

BANK_DETAIL_ID is not defined or invalid

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

MC_REQUISITE_ID is not defined or invalid

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

MC_BANK_DETAIL_ID is not defined or invalid

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

The Requisite with ID '60' is not found

Реквизит клиента с заданным идентификатором не найден

The Requisite with ID '60' is not assigned to Company with ID '5'

Реквизит клиента с заданным идентификатором не принадлежит компании, указанной в объекте

The BankDetail with ID '24' is not found

Банковский реквизит клиента с заданным идентификатором не найден

The BankDetail with ID '24' is not assigned to Requisite with ID '60'

Банковский реквизит клиента с заданным идентификатором не принадлежит указанному реквизиту

The Requisite of your company with ID '2' is not found

Реквизит моей компании с заданным идентификатором не найден

The Requisite with ID '2' is not assigned to your company with ID '3010'

Реквизит моей компании с заданным идентификатором не принадлежит моей компании, указанной в объекте

The BankDetail of your company with ID '2' is not found

Банковский реквизит моей компании с заданным идентификатором не найден

The BankDetail of your company with ID '2' is not assigned to Requisite of your company with ID '2'

Банковский реквизит моей компании с заданным идентификатором не принадлежит указанному реквизиту

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

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

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

Описание

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

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

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

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

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

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

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

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

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