Получить описание полей банковских реквизитов crm.requisite.bankdetail.fields
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
crmКто может выполнять метод: любой пользователь
Метод возвращает формальное описание полей банковских реквизитов.
Без параметров.
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.bankdetail.fields
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.requisite.bankdetail.fields
// 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
type FieldAttributes = {
type: string
isRequired: boolean
isReadOnly: boolean
isImmutable: boolean
isMultiple: boolean
isDynamic: boolean
title: string
}
// Shape of the payload returned in result (match the "response handling" section of the page)
type BankDetailFieldsResult = Record<string, FieldAttributes>
try {
const response = await $b24.actions.v2.call.make<BankDetailFieldsResult>({
method: 'crm.requisite.bankdetail.fields',
params: {},
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('Bank detail fields:', Object.keys(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 getBankDetailFields() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.requisite.bankdetail.fields',
params: {},
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('Bank detail fields:', Object.keys(result))
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getBankDetailFields)
</script>
try {
$response = $b24Service
->core
->call(
'crm.requisite.bankdetail.fields',
[]
);
$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 fetching bank detail fields: ' . $e->getMessage();
}
BX24.callMethod(
"crm.requisite.bankdetail.fields",
{},
function(result)
{
if(result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'crm.requisite.bankdetail.fields',
[]
);
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.bankdetail.fields().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}")
Обработка ответа
HTTP-статус: 200
{
"result": {
"ID": {
"type": "integer",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "ID"
},
"ENTITY_ID": {
"type": "integer",
"isRequired": true,
"isReadOnly": false,
"isImmutable": true,
"isMultiple": false,
"isDynamic": false,
"title": "ID объекта"
},
"COUNTRY_ID": {
"type": "integer",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "ID страны"
},
"DATE_CREATE": {
"type": "datetime",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Дата создания"
},
"DATE_MODIFY": {
"type": "datetime",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Дата изменения"
},
"CREATED_BY_ID": {
"type": "user",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Создал"
},
"MODIFY_BY_ID": {
"type": "user",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Изменил"
},
"NAME": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Название"
},
"CODE": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Код"
},
"XML_ID": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Внешний код"
},
"ACTIVE": {
"type": "char",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Активен"
},
"SORT": {
"type": "integer",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Сортироква"
},
"RQ_BANK_NAME": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Наименование банка"
},
"RQ_BANK_ADDR": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Адрес банка"
},
"RQ_BANK_CODE": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "RQ_BANK_CODE"
},
"RQ_AGENCY_NAME": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "RQ_AGENCY_NAME"
},
"RQ_BANK_ROUTE_NUM": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "RQ_BANK_ROUTE_NUM"
},
"RQ_BIK": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "БИК"
},
"RQ_MFO": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "RQ_MFO"
},
"RQ_ACC_NAME": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "RQ_ACC_NAME"
},
"RQ_ACC_NUM": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Расчетный счёт"
},
"RQ_ACC_TYPE": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "RQ_ACC_TYPE"
},
"RQ_IIK": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "RQ_IIK"
},
"RQ_ACC_CURRENCY": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Валюта счёта"
},
"RQ_COR_ACC_NUM": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Кор. счёт"
},
"RQ_IBAN": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "RQ_IBAN"
},
"RQ_SWIFT": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "SWIFT"
},
"RQ_BIC": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "RQ_BIC"
},
"RQ_CODEB": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "RQ_CODEB"
},
"RQ_CODEG": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "RQ_CODEG"
},
"RQ_RIB": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "RQ_RIB"
},
"COMMENTS": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Комментарий"
},
"ORIGINATOR_ID": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Внешний источник"
}
},
"time": {
"start": 1717409814.796487,
"finish": 1717409815.225673,
"duration": 0.4291858673095703,
"processing": 0.013273000717163086,
"date_start": "2024-06-03T12:16:54+02:00",
"date_finish": "2024-06-03T12:16:55+02:00",
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Объект в формате |
|
time |
Информация о времени выполнения запроса |
Описание полей банковских реквизитов
|
Название |
Описание |
|
ID |
Идентификатор банковского реквизита. Создается автоматически и уникален в рамках портала |
|
ENTITY_ID |
Идентификатор родительского объекта. Сейчас может быть только идентификатор реквизита. Идентификаторы реквизитов можно получить с помощью метода |
|
COUNTRY_ID |
Идентификатор страны, которой соответствует набор полей банковского реквизита (смотрите метод crm.requisite.preset.countries для получения доступных значений). Код страны банковского реквизита совпадает с кодом страны в привязанном шаблоне реквизитов, идентификатор которого указан в поле |
|
DATE_CREATE |
Дата создания |
|
DATE_MODIFY |
Дата изменения |
|
CREATED_BY_ID |
Идентификатор пользователя, создавшего реквизит |
|
MODIFY_BY_ID |
Идентификатор пользователя, изменившего реквизит |
|
NAME |
Название банковского реквизита |
|
CODE |
Символьный код реквизита |
|
XML_ID |
Внешний ключ. Используется для операций обмена. Идентификатор объекта внешней информационной базы. Назначение поля может меняться конечным разработчиком. Каждое приложение обеспечивает уникальность значений в этом поле. Рекомендуется использовать уникальный префикс для избежания коллизий с другими приложениями |
|
ACTIVE |
Признак активности. Используются значения Сейчас поле фактически ни на что не влияет |
|
SORT |
Сортировка |
|
RQ_BANK_NAME |
Наименование банка |
|
RQ_BANK_ADDR |
Адрес банка |
|
RQ_BANK_CODE |
Código do banco (для страны BR) |
|
RQ_BANK_ROUTE_NUM |
Bank Routing Number |
|
RQ_BIK |
БИК |
|
RQ_CODEB |
Code Banque (для страны FR) |
|
RQ_CODEG |
Code Guichet (для страны FR) |
|
RQ_RIB |
Clé RIB (для страны FR) |
|
RQ_MFO |
МФО |
|
RQ_ACC_NAME |
Bank Account Holder Name |
|
RQ_ACC_NUM |
Bank Account Number |
|
RQ_ACC_TYPE |
Tipo da conta (для страны BR) |
|
RQ_AGENCY_NAME |
Agência (для страны BR) |
|
RQ_IIK |
ИИК |
|
RQ_ACC_CURRENCY |
Валюта счета |
|
RQ_COR_ACC_NUM |
Корреспондентский счет |
|
RQ_IBAN |
IBAN |
|
RQ_SWIFT |
SWIFT |
|
RQ_BIC |
BIC |
|
COMMENTS |
Комментарий |
|
ORIGINATOR_ID |
Идентификатор внешней информационной базы. Назначение поля может меняться конечным разработчиком |
Описание атрибутов
|
Название |
Описание |
|
type |
Тип поля |
|
isRequired |
Атрибут «обязательное». Возможные значения:
|
|
isReadOnly |
Атрибут «только для чтения». Возможные значения:
|
|
isImmutable |
Атрибут «неизменяемое». Возможные значения:
|
|
isMultiple |
Атрибут «мультиполе». Возможные значения:
|
|
isDynamic |
Атрибут «пользовательское». Возможные значения:
|
|
title |
Идентификатор поля |
Обработка ошибок
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Создать новый банковский реквизит crm.requisite.bankdetail.add
- Изменить банковский реквизит crm.requisite.bankdetail.update
- Получить банковский реквизит по id crm.requisite.bankdetail.get
- Получить список банковских реквизитов по фильтру crm.requisite.bankdetail.list
- Удалить банковский реквизит crm.requisite.bankdetail.delete