Добавить валюту crm.currency.add
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
crmКто может выполнять метод: пользователь с правом «Разрешить изменять настройки» в CRM
Метод crm.currency.add добавляет валюту и возвращает ее код.
Параметры локализации — название валюты и формат суммы на каждом языке Битрикс24 — передайте в поле LANG. Для языков, которых в нем нет, будут использованы параметры по умолчанию. Параметры для одного языка можно задать и отдельно методом crm.currency.localizations.set.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
fields* |
Значения полей (подробное описание приведено ниже) для добавления новой валюты в виде структуры:
|
Параметр fields
Обязательные параметры отмечены *
|
Название |
Описание |
|
CURRENCY* |
Идентификатор валюты. Соответствует стандарту ISO 4217 |
|
BASE |
Признак базовой валюты. Метод не учитывает этот параметр и не возвращает ошибку: сделать валюту базовой этим методом нельзя. Базовую валюту меняет метод crm.currency.base.set |
|
AMOUNT_CNT* |
Номинал — количество единиц валюты, для которого задан курс |
|
AMOUNT* |
Сколько стоит номинал |
|
SORT |
Положение в списке валют. Значение по умолчанию — |
|
LANG |
Параметры локализации валюты. Объект в формате Если указать не все языки, для оставшихся будут использоваться параметры локализации по умолчанию |
Параметр LANG
|
Название |
Описание |
|
DECIMALS |
Количество знаков после запятой |
|
DEC_POINT |
Десятичный разделитель |
|
FORMAT_STRING* |
Шаблон вывода суммы, например |
|
FULL_NAME |
Название валюты на языке, для которого добавляется локализация |
|
HIDE_ZERO |
Скрывать ли незначащие нули: |
|
THOUSANDS_SEP |
Разделитель разрядов |
|
THOUSANDS_VARIANT |
Код разделителя разрядов. Допустимые значения описаны в справочнике |
Примеры кода
-
Создание юаня с параметрами локализации (русский и английский языки)
Базовая валюта — рубль. Один юань стоит 12,2251 рубля.
Как использовать примеры в документации
cURL (Webhook)cURL (OAuth)JS (TS)JS (UMD)PythonPHPBX24.jsPHP CRestGocurl -X POST \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -d '{"fields":{"CURRENCY":"CNY","BASE":"N","AMOUNT":12.2251,"AMOUNT_CNT":1,"SORT":9000,"LANG":{"ru":{"DECIMALS":2,"DEC_POINT":".","FORMAT_STRING":"# CNY","FULL_NAME":"юань","HIDE_ZERO":"Y","THOUSANDS_VARIANT":"S"},"en":{"DECIMALS":2,"DEC_POINT":",","FORMAT_STRING":"# CNY","FULL_NAME":"yuan","HIDE_ZERO":"Y","THOUSANDS_VARIANT":"D"}}}}' \ https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.currency.addcurl -X POST \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -d '{"fields":{"CURRENCY":"CNY","BASE":"N","AMOUNT":12.2251,"AMOUNT_CNT":1,"SORT":9000,"LANG":{"ru":{"DECIMALS":2,"DEC_POINT":".","FORMAT_STRING":"# CNY","FULL_NAME":"юань","HIDE_ZERO":"Y","THOUSANDS_VARIANT":"S"},"en":{"DECIMALS":2,"DEC_POINT":",","FORMAT_STRING":"# CNY","FULL_NAME":"yuan","HIDE_ZERO":"Y","THOUSANDS_VARIANT":"D"}}},"auth":"**put_access_token_here**"}' \ https://**put_your_bitrix24_address**/rest/crm.currency.add// 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<string>({ method: 'crm.currency.add', params: { fields: { CURRENCY: 'CNY', BASE: 'N', AMOUNT: 12.2251, AMOUNT_CNT: 1, SORT: 9000, LANG: { ru: { DECIMALS: 2, DEC_POINT: '.', FORMAT_STRING: '# CNY', FULL_NAME: 'юань', HIDE_ZERO: 'Y', THOUSANDS_VARIANT: 'S', }, en: { DECIMALS: 2, DEC_POINT: ',', FORMAT_STRING: '# CNY', FULL_NAME: 'yuan', HIDE_ZERO: 'Y', THOUSANDS_VARIANT: 'D', }, }, }, }, 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('Created currency id:', 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 addCurrency() { try { // Initialize the SDK inside a Bitrix24 frame const $b24 = await B24Js.initializeB24Frame() const response = await $b24.actions.v2.call.make({ method: 'crm.currency.add', params: { fields: { CURRENCY: 'CNY', BASE: 'N', AMOUNT: 12.2251, AMOUNT_CNT: 1, SORT: 9000, LANG: { ru: { DECIMALS: 2, DEC_POINT: '.', FORMAT_STRING: '# CNY', FULL_NAME: 'юань', HIDE_ZERO: 'Y', THOUSANDS_VARIANT: 'S', }, en: { DECIMALS: 2, DEC_POINT: ',', FORMAT_STRING: '# CNY', FULL_NAME: 'yuan', HIDE_ZERO: 'Y', THOUSANDS_VARIANT: 'D', }, }, }, }, 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('Created currency id:', result) } catch (error) { // Thrown on transport or SDK failures (AjaxError, SdkError, etc.) console.error(error) } } document.addEventListener('DOMContentLoaded', addCurrency) </script>from b24pysdk.errors import BitrixAPIError, BitrixSDKException try: bitrix_response = client.crm.currency.add( fields={ "CURRENCY": "CNY", "BASE": "N", "AMOUNT": 12.2251, "AMOUNT_CNT": 1, "SORT": 9000, "LANG": { "ru": { "DECIMALS": 2, "DEC_POINT": ".", "FORMAT_STRING": "# CNY", "FULL_NAME": "юань", "HIDE_ZERO": "Y", "THOUSANDS_VARIANT": "S", }, "en": { "DECIMALS": 2, "DEC_POINT": ",", "FORMAT_STRING": "# CNY", "FULL_NAME": "yuan", "HIDE_ZERO": "Y", "THOUSANDS_VARIANT": "D", }, }, }, ).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.currency.add', [ 'fields' => [ 'CURRENCY' => 'CNY', 'BASE' => 'N', 'AMOUNT' => 12.2251, 'AMOUNT_CNT' => 1, 'SORT' => 9000, 'LANG' => [ 'ru' => [ 'DECIMALS' => 2, 'DEC_POINT' => '.', 'FORMAT_STRING' => '# CNY', 'FULL_NAME' => 'юань', 'HIDE_ZERO' => 'Y', 'THOUSANDS_VARIANT' => 'S', ], 'en' => [ 'DECIMALS' => 2, 'DEC_POINT' => ',', 'FORMAT_STRING' => '# CNY', 'FULL_NAME' => 'yuan', 'HIDE_ZERO' => 'Y', 'THOUSANDS_VARIANT' => 'D', ], ], ], ] ); $result = $response ->getResponseData() ->getResult(); print_r($result); } catch (Throwable $e) { echo $e->getMessage(); }BX24.callMethod( "crm.currency.add", { fields: { CURRENCY: 'CNY', BASE: 'N', AMOUNT: 12.2251, AMOUNT_CNT: 1, SORT: 9000, LANG: { ru: { DECIMALS: 2, DEC_POINT: '.', FORMAT_STRING: '# CNY', FULL_NAME: 'юань', HIDE_ZERO: 'Y', THOUSANDS_VARIANT: 'S' }, en: { DECIMALS: 2, DEC_POINT: ',', FORMAT_STRING: '# CNY', FULL_NAME: 'yuan', HIDE_ZERO: 'Y', THOUSANDS_VARIANT: 'D' } } } }, function(result) { if (result.error()) { console.error(result.error()); } else { console.log(result.data()); } } );require_once('crest.php'); $result = CRest::call( 'crm.currency.add', [ 'fields' => [ 'CURRENCY' => 'CNY', 'BASE' => 'N', 'AMOUNT' => 12.2251, 'AMOUNT_CNT' => 1, 'SORT' => 9000, 'LANG' => [ 'ru' => [ 'DECIMALS' => 2, 'DEC_POINT' => '.', 'FORMAT_STRING' => '# CNY', 'FULL_NAME' => 'юань', 'HIDE_ZERO' => 'Y', 'THOUSANDS_VARIANT' => 'S', ], 'en' => [ 'DECIMALS' => 2, 'DEC_POINT' => ',', 'FORMAT_STRING' => '# CNY', 'FULL_NAME' => 'yuan', 'HIDE_ZERO' => 'Y', 'THOUSANDS_VARIANT' => 'D', ], ], ] ] ); echo '<PRE>'; print_r($result); echo '</PRE>';// client и ctx уже созданы — см. раздел «SDK для Go» res, err := client.Core().Call(ctx, "crm.currency.add", b24.Params{ "fields": b24.Params{ "CURRENCY": "CNY", "BASE": "N", "AMOUNT": 12.2251, "AMOUNT_CNT": 1, "SORT": 9000, "LANG": b24.Params{ "ru": b24.Params{ "DECIMALS": 2, "DEC_POINT": ".", "FORMAT_STRING": "# CNY", "FULL_NAME": "юань", "HIDE_ZERO": "Y", "THOUSANDS_VARIANT": "S", }, "en": b24.Params{ "DECIMALS": 2, "DEC_POINT": ",", "FORMAT_STRING": "# CNY", "FULL_NAME": "yuan", "HIDE_ZERO": "Y", "THOUSANDS_VARIANT": "D", }, }, }, }) if err != nil { return fmt.Errorf("crm.currency.add: %w", err) } var value string if err := json.Unmarshal(res.Result, &value); err != nil { return fmt.Errorf("разбор ответа: %w", err) } fmt.Println("результат:", value) -
Создание индонезийской рупии
Базовая валюта — рубль. Одна рупия стоит 0,00548 рубля. Чтобы задать такой низкий курс точно, увеличиваем номинал:
AMOUNT=54.8738рубля заAMOUNT_CNT=10000рупий.Как использовать примеры в документации
cURL (Webhook)cURL (OAuth)JS (TS)JS (UMD)PythonPHPBX24.jsPHP CRestGocurl -X POST \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -d '{"fields":{"CURRENCY":"IDR","AMOUNT":54.8738,"AMOUNT_CNT":10000,"SORT":8000,"LANG":{"ru":{"DECIMALS":2,"DEC_POINT":".","FORMAT_STRING":"Rp#","FULL_NAME":"рупия","HIDE_ZERO":"Y","THOUSANDS_VARIANT":"C"},"en":{"DECIMALS":2,"DEC_POINT":".","FORMAT_STRING":"Rp#","FULL_NAME":"rupee","HIDE_ZERO":"Y","THOUSANDS_VARIANT":"C"}}}}' \ https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.currency.addcurl -X POST \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -d '{"fields":{"CURRENCY":"IDR","AMOUNT":54.8738,"AMOUNT_CNT":10000,"SORT":8000,"LANG":{"ru":{"DECIMALS":2,"DEC_POINT":".","FORMAT_STRING":"Rp#","FULL_NAME":"рупия","HIDE_ZERO":"Y","THOUSANDS_VARIANT":"C"},"en":{"DECIMALS":2,"DEC_POINT":".","FORMAT_STRING":"Rp#","FULL_NAME":"rupee","HIDE_ZERO":"Y","THOUSANDS_VARIANT":"C"}}},"auth":"**put_access_token_here**"}' \ https://**put_your_bitrix24_address**/rest/crm.currency.add// 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<string>({ method: 'crm.currency.add', params: { fields: { CURRENCY: 'IDR', AMOUNT: 54.8738, AMOUNT_CNT: 10000, SORT: 8000, LANG: { ru: { DECIMALS: 2, DEC_POINT: '.', FORMAT_STRING: 'Rp#', FULL_NAME: 'рупия', HIDE_ZERO: 'Y', THOUSANDS_VARIANT: 'C', }, en: { DECIMALS: 2, DEC_POINT: '.', FORMAT_STRING: 'Rp#', FULL_NAME: 'rupee', HIDE_ZERO: 'Y', THOUSANDS_VARIANT: 'C', }, }, }, }, 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('Created currency id:', 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 addCurrency() { try { // Initialize the SDK inside a Bitrix24 frame const $b24 = await B24Js.initializeB24Frame() const response = await $b24.actions.v2.call.make({ method: 'crm.currency.add', params: { fields: { CURRENCY: 'IDR', AMOUNT: 54.8738, AMOUNT_CNT: 10000, SORT: 8000, LANG: { ru: { DECIMALS: 2, DEC_POINT: '.', FORMAT_STRING: 'Rp#', FULL_NAME: 'рупия', HIDE_ZERO: 'Y', THOUSANDS_VARIANT: 'C', }, en: { DECIMALS: 2, DEC_POINT: '.', FORMAT_STRING: 'Rp#', FULL_NAME: 'rupee', HIDE_ZERO: 'Y', THOUSANDS_VARIANT: 'C', }, }, }, }, 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('Created currency id:', result) } catch (error) { // Thrown on transport or SDK failures (AjaxError, SdkError, etc.) console.error(error) } } document.addEventListener('DOMContentLoaded', addCurrency) </script>from b24pysdk.errors import BitrixAPIError, BitrixSDKException try: bitrix_response = client.crm.currency.add( fields={ "CURRENCY": "IDR", "AMOUNT": 54.8738, "AMOUNT_CNT": 10000, "SORT": 8000, "LANG": { "ru": { "DECIMALS": 2, "DEC_POINT": ".", "FORMAT_STRING": "Rp#", "FULL_NAME": "рупия", "HIDE_ZERO": "Y", "THOUSANDS_VARIANT": "C", }, "en": { "DECIMALS": 2, "DEC_POINT": ".", "FORMAT_STRING": "Rp#", "FULL_NAME": "rupee", "HIDE_ZERO": "Y", "THOUSANDS_VARIANT": "C", }, }, }, ).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.currency.add', [ 'fields' => [ 'CURRENCY' => 'IDR', 'AMOUNT' => 54.8738, 'AMOUNT_CNT' => 10000, 'SORT' => 8000, 'LANG' => [ 'ru' => [ 'DECIMALS' => 2, 'DEC_POINT' => '.', 'FORMAT_STRING' => 'Rp#', 'FULL_NAME' => 'рупия', 'HIDE_ZERO' => 'Y', 'THOUSANDS_VARIANT' => 'C', ], 'en' => [ 'DECIMALS' => 2, 'DEC_POINT' => '.', 'FORMAT_STRING' => 'Rp#', 'FULL_NAME' => 'rupee', 'HIDE_ZERO' => 'Y', 'THOUSANDS_VARIANT' => 'C', ], ], ], ] ); $result = $response ->getResponseData() ->getResult(); print_r($result); } catch (Throwable $e) { echo $e->getMessage(); }BX24.callMethod( "crm.currency.add", { fields: { CURRENCY: 'IDR', AMOUNT: 54.8738, AMOUNT_CNT: 10000, SORT: 8000, LANG: { ru: { DECIMALS: 2, DEC_POINT: '.', FORMAT_STRING: 'Rp#', FULL_NAME: 'рупия', HIDE_ZERO: 'Y', THOUSANDS_VARIANT: 'C' }, en: { DECIMALS: 2, DEC_POINT: '.', FORMAT_STRING: 'Rp#', FULL_NAME: 'rupee', HIDE_ZERO: 'Y', THOUSANDS_VARIANT: 'C' } } } }, function(result) { if (result.error()) { console.error(result.error()); } else { console.log(result.data()); } } );require_once('crest.php'); $result = CRest::call( 'crm.currency.add', [ 'fields' => [ 'CURRENCY' => 'IDR', 'AMOUNT' => 54.8738, 'AMOUNT_CNT' => 10000, 'SORT' => 8000, 'LANG' => [ 'ru' => [ 'DECIMALS' => 2, 'DEC_POINT' => '.', 'FORMAT_STRING' => 'Rp#', 'FULL_NAME' => 'рупия', 'HIDE_ZERO' => 'Y', 'THOUSANDS_VARIANT' => 'C', ], 'en' => [ 'DECIMALS' => 2, 'DEC_POINT' => '.', 'FORMAT_STRING' => 'Rp#', 'FULL_NAME' => 'rupee', 'HIDE_ZERO' => 'Y', 'THOUSANDS_VARIANT' => 'C', ] ] ] ] ); echo '<PRE>'; print_r($result); echo '</PRE>';// client и ctx уже созданы — см. раздел «SDK для Go» res, err := client.Core().Call(ctx, "crm.currency.add", b24.Params{ "fields": b24.Params{ "CURRENCY": "IDR", "AMOUNT": 54.8738, "AMOUNT_CNT": 10000, "SORT": 8000, "LANG": b24.Params{ "ru": b24.Params{ "DECIMALS": 2, "DEC_POINT": ".", "FORMAT_STRING": "Rp#", "FULL_NAME": "рупия", "HIDE_ZERO": "Y", "THOUSANDS_VARIANT": "C", }, "en": b24.Params{ "DECIMALS": 2, "DEC_POINT": ".", "FORMAT_STRING": "Rp#", "FULL_NAME": "rupee", "HIDE_ZERO": "Y", "THOUSANDS_VARIANT": "C", }, }, }, }) if err != nil { return fmt.Errorf("crm.currency.add: %w", err) } var value string if err := json.Unmarshal(res.Result, &value); err != nil { return fmt.Errorf("разбор ответа: %w", err) } fmt.Println("результат:", value)
Обработка ответа
HTTP-статус: 200
{
"result": "CNY",
"time": {
"start": 1717684463.467685,
"finish": 1717684465.282238,
"duration": 1.8145530223846436,
"processing": 0.12580394744873047,
"date_start": "2024-06-06T16:34:23+02:00",
"date_finish": "2024-06-06T16:34:25+02:00",
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Идентификатор созданной валюты |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "",
"error_description": "Access denied."
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
Пустое значение |
|
У пользователя нет права «Разрешить изменять настройки» в CRM |
|
|
|
|
|
|
|
|
|
Валюта с таким кодом уже есть |
|
|
|
|
Не передан |
|
|
|
|
В локализации из |
|
|
|
|
В локализации из |
|
|
|
|
|
|
|
|
|
|
|
|
Пустое значение |
|
Не установлен модуль «Валюты» |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |