Создать новый банковский реквизит crm.requisite.bankdetail.add

Scope: crm

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

Метод создает новый банковский реквизит.

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

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

Название
тип

Описание

fields*
object

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

Параметр fields

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

Название
тип

Описание

ENTITY_ID*
integer

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

COUNTRY_ID
integer

Идентификатор страны, которой соответствует набор полей банковского реквизита (смотрите метод crm.requisite.preset.countries для получения доступных значений).

Код страны банковского реквизита совпадает с кодом страны в привязанном шаблоне реквизитов, идентификатор которого указан в поле ENTITY_ID

NAME*
string

Название банковского реквизита

CODE
string

Символьный код реквизита

XML_ID
string

Внешний ключ. Используется для операций обмена. Идентификатор объекта внешней информационной базы.

Назначение поля может меняться конечным разработчиком. Каждое приложение обеспечивает уникальность значений в этом поле.

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

ACTIVE
char

Признак активности. Используются значения Y или N.

Сейчас поле фактически ни на что не влияет

SORT
integer

Сортировка

RQ_BANK_NAME
string

Наименование банка

RQ_BANK_ADDR
string

Адрес банка

RQ_BANK_CODE
string

Código do banco (для страны BR)

RQ_BANK_ROUTE_NUM
string

Bank Routing Number

RQ_BIK
string

БИК

RQ_CODEB
string

Code Banque (для страны FR)

RQ_CODEG
string

Code Guichet (для страны FR)

RQ_RIB
string

Clé RIB (для страны FR)

RQ_MFO
string

МФО

RQ_ACC_NAME
string

Bank Account Holder Name

RQ_ACC_NUM
string

Bank Account Number

RQ_ACC_TYPE
string

Tipo da conta (для страны BR)

RQ_AGENCY_NAME
string

Agência (для страны BR)

RQ_IIK
string

ИИК

RQ_ACC_CURRENCY
string

Валюта счета

RQ_COR_ACC_NUM
string

Корреспондентский счет

RQ_IBAN
string

IBAN

RQ_SWIFT
string

SWIFT

RQ_BIC
string

BIC

COMMENTS
string

Комментарий

ORIGINATOR_ID
string

Идентификатор внешней информационной базы. Назначение поля может меняться конечным разработчиком

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"ENTITY_ID":27,"COUNTRY_ID":1,"NAME":"Супербанк","RQ_BANK_NAME":"ПАО Супербанк","RQ_BANK_ADDR":"117312, г. Москва, улица Вавилова, дом 19","RQ_BIK":"044525225","RQ_ACC_NUM":"40702810938000060473","RQ_ACC_CURRENCY":"RUR","RQ_COR_ACC_NUM":"30101810400000000225","XML_ID":"1e4641fd-2dd9-31e6-b2f2-105056c00008","ACTIVE":"Y","SORT":600}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.bankdetail.add
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"ENTITY_ID":27,"COUNTRY_ID":1,"NAME":"Супербанк","RQ_BANK_NAME":"ПАО Супербанк","RQ_BANK_ADDR":"117312, г. Москва, улица Вавилова, дом 19","RQ_BIK":"044525225","RQ_ACC_NUM":"40702810938000060473","RQ_ACC_CURRENCY":"RUR","RQ_COR_ACC_NUM":"30101810400000000225","XML_ID":"1e4641fd-2dd9-31e6-b2f2-105056c00008","ACTIVE":"Y","SORT":600},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.requisite.bankdetail.add
        
try
        {
        	const response = await $b24.callMethod(
        		"crm.requisite.bankdetail.add",
        		{
        			fields:
        			{
        				"ENTITY_ID": 27,                 // Идентификатор реквизита
        				"COUNTRY_ID": 1,                 // Код страны (Россия)
        				"NAME": "Супербанк",              // Название банковского реквизита
        				"RQ_BANK_NAME": "ПАО Супербанк",  // Наименование банка
        				"RQ_BANK_ADDR": "117312, г. Москва, улица Вавилова, дом 19",
        				"RQ_BIK": "044525225",
        				"RQ_ACC_NUM": "40702810938000060473",
        				"RQ_ACC_CURRENCY": "RUR",
        				"RQ_COR_ACC_NUM": "30101810400000000225",
        				"XML_ID":"1e4641fd-2dd9-31e6-b2f2-105056c00008",
        				"ACTIVE":"Y",
        				"SORT":600
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info("Создан банковский реквизит с ID " + result);
        }
        catch(error)
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.requisite.bankdetail.add',
                    [
                        'fields' => [
                            'ENTITY_ID'       => 27,
                            'COUNTRY_ID'      => 1,
                            'NAME'            => 'Супербанк',
                            'RQ_BANK_NAME'    => 'ПАО Супербанк',
                            'RQ_BANK_ADDR'    => '117312, г. Москва, улица Вавилова, дом 19',
                            'RQ_BIK'          => '044525225',
                            'RQ_ACC_NUM'      => '40702810938000060473',
                            'RQ_ACC_CURRENCY' => 'RUR',
                            'RQ_COR_ACC_NUM'  => '30101810400000000225',
                            'XML_ID'          => '1e4641fd-2dd9-31e6-b2f2-105056c00008',
                            'ACTIVE'          => 'Y',
                            'SORT'            => 600,
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Создан банковский реквизит с ID ' . $result;
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error creating bank detail: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "crm.requisite.bankdetail.add",
            {
                fields:
                {
                    "ENTITY_ID": 27,                 // Идентификатор реквизита
                    "COUNTRY_ID": 1,                 // Код страны (Россия)
                    "NAME": "Супербанк",              // Название банковского реквизита
                    "RQ_BANK_NAME": "ПАО Супербанк",  // Наименование банка
                    "RQ_BANK_ADDR": "117312, г. Москва, улица Вавилова, дом 19",
                    "RQ_BIK": "044525225",
                    "RQ_ACC_NUM": "40702810938000060473",
                    "RQ_ACC_CURRENCY": "RUR",
                    "RQ_COR_ACC_NUM": "30101810400000000225",
                    "XML_ID":"1e4641fd-2dd9-31e6-b2f2-105056c00008",
                    "ACTIVE":"Y",
                    "SORT":600
                }
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                    console.info("Создан банковский реквизит с ID " + result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.requisite.bankdetail.add',
            [
                'fields' => [
                    'ENTITY_ID' => 27,
                    'COUNTRY_ID' => 1,
                    'NAME' => 'Супербанк',
                    'RQ_BANK_NAME' => 'ПАО Супербанк',
                    'RQ_BANK_ADDR' => '117312, г. Москва, улица Вавилова, дом 19',
                    'RQ_BIK' => '044525225',
                    'RQ_ACC_NUM' => '40702810938000060473',
                    'RQ_ACC_CURRENCY' => 'RUR',
                    'RQ_COR_ACC_NUM' => '30101810400000000225',
                    'XML_ID' => '1e4641fd-2dd9-31e6-b2f2-105056c00008',
                    'ACTIVE' => 'Y',
                    'SORT' => 600
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

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

HTTP-статус: 200

{
            "result": 357,
            "time": {
                "start": 1717429942.060649,
                "finish": 1717429942.626925,
                "duration": 0.5662760734558105,
                "processing": 0.09111285209655762,
                "date_start": "2024-06-03T17:52:22+02:00",
                "date_finish": "2024-06-03T17:52:22+02:00",
                "operating": 0
            }
        }
        

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

Название
тип

Описание

result
integer

Идентификатор созданного банковского реквизита

time
time

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

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

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

{
            "error": "",
            "error_description": "ENTITY_ID is not defined or invalid."
        }
        

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Текст ошибки

Описание

ENTITY_ID is not defined or invalid

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

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

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

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

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

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