Установить локализации для валюты crm.currency.localizations.set

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

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

Scope: crm

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

Метод обновляет локализации для валюты или добавляет, если локализация для указанного языка не существует.

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

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

Название /
тип

Описание

id*
string

Идентификатор валюты.

Соответствует стандарту ISO 4217.

Идентификатор можно получить методом crm.currency.list

localizations*
object

Параметры локализации валюты.
Объект в формате {"lang_1": "value_1", ... "lang_N": "value_N"}, где lang_N — идентификатор языка, для которого надо добавить/изменить локализацию, а value — объект типа crm_currency_localization.

Существующие локализации, которые не переданы в метод, не будут изменены.

Примеры кода

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":"CLF","localizations":{"en":{"FULL_NAME":"Unidad de Fomento","FORMAT_STRING":"CLF#VALUE#","DEC_POINT":".","THOUSANDS_VARIANT":"C","DECIMALS":4},"ru":{"FULL_NAME":"Единица развития","FORMAT_STRING":"#VALUE# CLF","DEC_POINT":".","THOUSANDS_VARIANT":"B","DECIMALS":4}}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.currency.localizations.set
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":"CLF","localizations":{"en":{"FULL_NAME":"Unidad de Fomento","FORMAT_STRING":"CLF#VALUE#","DEC_POINT":".","THOUSANDS_VARIANT":"C","DECIMALS":4},"ru":{"FULL_NAME":"Единица развития","FORMAT_STRING":"#VALUE# CLF","DEC_POINT":".","THOUSANDS_VARIANT":"B","DECIMALS":4}},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.currency.localizations.set
// 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.currency.localizations.set',
    params: {
      id: 'CLF',
      localizations: {
        en: {
          FULL_NAME: 'Unidad de Fomento',
          FORMAT_STRING: 'CLF#VALUE#',
          DEC_POINT: '.',
          THOUSANDS_VARIANT: 'C',
          DECIMALS: 4,
        },
        ru: {
          FULL_NAME: 'Unit of Account',
          FORMAT_STRING: '#VALUE# CLF',
          DEC_POINT: '.',
          THOUSANDS_VARIANT: 'B',
          DECIMALS: 4,
        },
      },
    },
    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('Localizations set:', 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 setCurrencyLocalizations() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'crm.currency.localizations.set',
        params: {
          id: 'CLF',
          localizations: {
            en: {
              FULL_NAME: 'Unidad de Fomento',
              FORMAT_STRING: 'CLF#VALUE#',
              DEC_POINT: '.',
              THOUSANDS_VARIANT: 'C',
              DECIMALS: 4,
            },
            ru: {
              FULL_NAME: 'Unit of Account',
              FORMAT_STRING: '#VALUE# CLF',
              DEC_POINT: '.',
              THOUSANDS_VARIANT: 'B',
              DECIMALS: 4,
            },
          },
        },
        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('Localizations set:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', setCurrencyLocalizations)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.crm.currency.localizations.set(
        bitrix_id="CLF",
        localizations={
            "en": {
                "FULL_NAME": "Unidad de Fomento",
                "FORMAT_STRING": "CLF#VALUE#",
                "DEC_POINT": ".",
                "THOUSANDS_VARIANT": "C",
                "DECIMALS": 4,
            },
            "ru": {
                "FULL_NAME": "Единица развития",
                "FORMAT_STRING": "#VALUE# CLF",
                "DEC_POINT": ".",
                "THOUSANDS_VARIANT": "B",
                "DECIMALS": 4,
            },
        },
    ).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.localizations.set',
            [
                'id' => 'CLF',
                'localizations' => [
                    'en' => [
                        'FULL_NAME'        => 'Unidad de Fomento',
                        'FORMAT_STRING'    => 'CLF#VALUE#',
                        'DEC_POINT'        => '.',
                        'THOUSANDS_VARIANT' => 'C',
                        'DECIMALS'         => 4,
                    ],
                    'ru' => [
                        'FULL_NAME'        => 'Единица развития',
                        'FORMAT_STRING'    => '#VALUE# CLF',
                        'DEC_POINT'        => '.',
                        'THOUSANDS_VARIANT' => 'B',
                        'DECIMALS'         => 4,
                    ],
                ],
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error setting currency localizations: ' . $e->getMessage();
}
BX24.callMethod(
    "crm.currency.localizations.set",
    {
        id: 'CLF',
        localizations: {
            en: {
                FULL_NAME: 'Unidad de Fomento',
                FORMAT_STRING: 'CLF#VALUE#',
                DEC_POINT: '.',
                THOUSANDS_VARIANT: 'C',
                DECIMALS: 4,
            },
            ru: {
                FULL_NAME: 'Единица развития',
                FORMAT_STRING: '#VALUE# CLF',
                DEC_POINT: '.',
                THOUSANDS_VARIANT: 'B',
                DECIMALS: 4,
            }
        }
    },
)
.then(
    function(result)
    {
        if (result.error())
        {
            console.error(result.error());
        }
        else
        {
            console.log(result);
        }
    },
    function(error)
    {
        console.info(error);
    }
);
require_once('crest.php');

$result = CRest::call(
    'crm.currency.localizations.set',
    [
        'id' => 'CLF',
        'localizations' => [
            'en' => [
                'FULL_NAME' => 'Unidad de Fomento',
                'FORMAT_STRING' => 'CLF#VALUE#',
                'DEC_POINT' => '.',
                'THOUSANDS_VARIANT' => 'C',
                'DECIMALS' => 4,
            ],
            'ru' => [
                'FULL_NAME' => 'Единица развития',
                'FORMAT_STRING' => '#VALUE# CLF',
                'DEC_POINT' => '.',
                'THOUSANDS_VARIANT' => 'B',
                'DECIMALS' => 4,
            ]
        ]
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.currency.localizations.set", b24.Params{
	"id": "CLF",
	"localizations": b24.Params{
		"en": b24.Params{
			"FULL_NAME":         "Unidad de Fomento",
			"FORMAT_STRING":     "CLF#VALUE#",
			"DEC_POINT":         ".",
			"THOUSANDS_VARIANT": "C",
			"DECIMALS":          4,
		},
		"ru": b24.Params{
			"FULL_NAME":         "Единица развития",
			"FORMAT_STRING":     "#VALUE# CLF",
			"DEC_POINT":         ".",
			"THOUSANDS_VARIANT": "B",
			"DECIMALS":          4,
		},
	},
})
if err != nil {
	return fmt.Errorf("crm.currency.localizations.set: %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": 1718122481.837301,
        "finish": 1718122483.141736,
        "duration": 1.3044350147247314,
        "processing": 0.08866286277770996,
        "date_start": "2024-06-11T18:14:41+02:00",
        "date_finish": "2024-06-11T18:14:43+02:00",
        "operating": 0
    }
}

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

Название
тип

Описание

result
boolean

Возвращает:

  • true — в случае успеха
  • false – в случае, когда операцию выполнить не удалось, но ошибки нет, либо ситуация не считается ошибочной. Возможные варианты:
    • отсутствует модуль валют
    • передан пустой объект с локализациями
    • не была добавлена/изменена ни одна локализация

time
time

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

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

HTTP-статус: 400

{
    "error": "",
    "error_description": "The parameter id is invalid or not defined."
}

Название
тип

Описание

error
string

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

error_description
string

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

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

Код

Описание

Значение

Пустая строка

Access denied.

Недостаточно прав доступа

Пустая строка

The parameter id is invalid or not defined.

Пустой идентификатор валюты

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

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

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

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