Обновить валюту crm.currency.update

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

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

Scope: crm

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

Метод обновляет существующую валюту.

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

Название
тип

Описание

ID
string

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

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

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

fields
object

Значения полей (подробное описание приведено ниже) для обновления валюты в виде структуры:

fields: {
    SORT: 'значение'
    AMOUNT_CNT: 'значение',
    AMOUNT: 'значение'
    BASE: 'значение',
    LANG: {
        lang_1: {
            DECIMALS: 'значение',
            DEC_POINT: 'значение',
            ...
        },
        ...
        lang_N: {
            ...
        }
    }
}

Параметр fields

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

Название
тип

Описание

SORT
integer

Положение в списке валют.

Значение по умолчанию — 100

AMOUNT_CNT*
integer

Номинал. В качестве номинала чаще всего используется 1 или число кратное 10

AMOUNT*
double

Курс обмена по отношению к базовой валюте

BASE
string

Признак, является ли валюта базовой.

Возможные значения:

  • Y — да
  • N — нет

Значение по умолчанию — N.

Важно

Не рекомендуется менять базовую валюту через REST. Иначе необходимо будет изменить курсы всех валют

LANG
object

Параметры локализации валюты.

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

Если указать не все языки, для оставшихся будут использоваться параметры локализации по умолчанию

Параметр LANG

Название
тип

Описание

DECIMALS*
integer

Число десятичных знаков дробной части

DEC_POINT
string

Десятичная точка при выводе

FORMAT_STRING
string

Шаблон формата

FULL_NAME
string

Название валюты на языке, для которого добавляется локализация

HIDE_ZERO
string

Признак, скрывать незначащие нули или нет

THOUSANDS_SEP
string

Разделитель триад

THOUSANDS_VARIANT
string

Код разделителя триад.

Допустимые значения смотрите в справочнике crm_currency_localization

Примеры кода

  1. Изменение курса юаня по отношению к базовой валюте

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

    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"ID":"CNY","fields":{"AMOUNT":15.3449}}' \
    https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.currency.update
    
    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"ID":"CNY","fields":{"AMOUNT":15.3449},"auth":"**put_access_token_here**"}' \
    https://**put_your_bitrix24_address**/rest/crm.currency.update
    
    // 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.update',
        params: {
          ID: 'CNY',
          fields: {
            AMOUNT: 15.3449,
          },
        },
        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('Currency updated:', 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 updateCurrency() {
        try {
          // Initialize the SDK inside a Bitrix24 frame
          const $b24 = await B24Js.initializeB24Frame()
    
          const response = await $b24.actions.v2.call.make({
            method: 'crm.currency.update',
            params: {
              ID: 'CNY',
              fields: {
                AMOUNT: 15.3449,
              },
            },
            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('Currency updated:', result)
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
      }
    
      document.addEventListener('DOMContentLoaded', updateCurrency)
    </script>
    
    from b24pysdk.errors import BitrixAPIError, BitrixSDKException
    
    try:
        bitrix_response = client.crm.currency.update(
            bitrix_id="CNY",
            fields={
                "AMOUNT": 15.3449,
            },
        ).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}")
    
    require_once('crest.php');
    
    $result = CRest::call(
        'crm.currency.update',
        [
            'ID' => 'CNY',
            'fields' => [
                'AMOUNT' => 15.3449,
            ]
        ]
    );
    
    echo '<PRE>';
    print_r($result);
    echo '</PRE>';
    
    // client и ctx уже созданы — см. раздел «SDK для Go»
    res, err := client.Core().Call(ctx, "crm.currency.update", b24.Params{
    	"ID": "CNY",
    	"fields": b24.Params{
    		"AMOUNT": 15.3449,
    	},
    })
    if err != nil {
    	return fmt.Errorf("crm.currency.update: %w", err)
    }
    
    var ok bool
    if err := json.Unmarshal(res.Result, &ok); err != nil {
    	return fmt.Errorf("разбор ответа: %w", err)
    }
    fmt.Println("выполнено:", ok)
    
  2. Изменение локализаций валюты (на примере доллара США)

    После выполнения этого примера для валюты USD будут изменены (либо добавлены) локализации только для английского и немецкого языков. Локализации для остальных языков, если они были, не изменятся.

    Данный пример аналогичен работе метода crm.currency.localizations.set

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

    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"ID":"USD","fields":{"LANG":{"en":{"DECIMALS":2,"DEC_POINT":".","FORMAT_STRING":"$#","FULL_NAME":"доллар США","HIDE_ZERO":"Y","THOUSANDS_VARIANT":"S"},"de":{"DECIMALS":2,"DEC_POINT":".","FORMAT_STRING":"# $","FULL_NAME":"US-Dollar","HIDE_ZERO":"Y","THOUSANDS_VARIANT":"C"}}}}' \
    https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.currency.update
    
    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"ID":"USD","fields":{"LANG":{"en":{"DECIMALS":2,"DEC_POINT":".","FORMAT_STRING":"$#","FULL_NAME":"доллар США","HIDE_ZERO":"Y","THOUSANDS_VARIANT":"S"},"de":{"DECIMALS":2,"DEC_POINT":".","FORMAT_STRING":"# $","FULL_NAME":"US-Dollar","HIDE_ZERO":"Y","THOUSANDS_VARIANT":"C"}}},"auth":"**put_access_token_here**"}' \
    https://**put_your_bitrix24_address**/rest/crm.currency.update
    
    // 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.update',
        params: {
          ID: 'USD',
          fields: {
            LANG: {
              en: {
                DECIMALS: 2,
                DEC_POINT: '.',
                FORMAT_STRING: '$#',
                FULL_NAME: 'US Dollar',
                HIDE_ZERO: 'Y',
                THOUSANDS_VARIANT: 'S',
              },
              de: {
                DECIMALS: 2,
                DEC_POINT: '.',
                FORMAT_STRING: '# $',
                FULL_NAME: 'US-Dollar',
                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('Currency updated:', 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 updateCurrency() {
        try {
          // Initialize the SDK inside a Bitrix24 frame
          const $b24 = await B24Js.initializeB24Frame()
    
          const response = await $b24.actions.v2.call.make({
            method: 'crm.currency.update',
            params: {
              ID: 'USD',
              fields: {
                LANG: {
                  en: {
                    DECIMALS: 2,
                    DEC_POINT: '.',
                    FORMAT_STRING: '$#',
                    FULL_NAME: 'US Dollar',
                    HIDE_ZERO: 'Y',
                    THOUSANDS_VARIANT: 'S',
                  },
                  de: {
                    DECIMALS: 2,
                    DEC_POINT: '.',
                    FORMAT_STRING: '# $',
                    FULL_NAME: 'US-Dollar',
                    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('Currency updated:', result)
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
      }
    
      document.addEventListener('DOMContentLoaded', updateCurrency)
    </script>
    
    from b24pysdk.errors import BitrixAPIError, BitrixSDKException
    
    try:
        bitrix_response = client.crm.currency.update(
            bitrix_id="USD",
            fields={
                "LANG": {
                    "en": {
                        "DECIMALS": 2,
                        "DEC_POINT": ".",
                        "FORMAT_STRING": "$#",
                        "FULL_NAME": "доллар США",
                        "HIDE_ZERO": "Y",
                        "THOUSANDS_VARIANT": "S",
                    },
                    "de": {
                        "DECIMALS": 2,
                        "DEC_POINT": ".",
                        "FORMAT_STRING": "# $",
                        "FULL_NAME": "US-Dollar",
                        "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}")
    
    require_once('crest.php');
    
    $result = CRest::call(
        'crm.currency.update',
        [
            'ID' => 'USD',
            'fields' => [
                'LANG' => [
                    'en' => [
                        'DECIMALS' => 2,
                        'DEC_POINT' => '.',
                        'FORMAT_STRING' => '$#',
                        'FULL_NAME' => 'доллар США',
                        'HIDE_ZERO' => 'Y',
                        'THOUSANDS_VARIANT' => 'S',
                    ],
                    'de' => [
                        'DECIMALS' => 2,
                        'DEC_POINT' => '.',
                        'FORMAT_STRING' => '# $',
                        'FULL_NAME' => 'US-Dollar',
                        '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.update", b24.Params{
    	"ID": "USD",
    	"fields": b24.Params{
    		"LANG": b24.Params{
    			"en": b24.Params{
    				"DECIMALS":          2,
    				"DEC_POINT":         ".",
    				"FORMAT_STRING":     "$#",
    				"FULL_NAME":         "доллар США",
    				"HIDE_ZERO":         "Y",
    				"THOUSANDS_VARIANT": "S",
    			},
    			"de": b24.Params{
    				"DECIMALS":          2,
    				"DEC_POINT":         ".",
    				"FORMAT_STRING":     "# $",
    				"FULL_NAME":         "US-Dollar",
    				"HIDE_ZERO":         "Y",
    				"THOUSANDS_VARIANT": "C",
    			},
    		},
    	},
    })
    if err != nil {
    	return fmt.Errorf("crm.currency.update: %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": 1717764521.938284,
        "finish": 1717764522.516576,
        "duration": 0.5782921314239502,
        "processing": 0.07656002044677734,
        "date_start": "2024-06-07T14:48:41+02:00",
        "date_finish": "2024-06-07T14:48:42+02:00",
        "operating": 0
    }
}

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

Название
тип

Описание

result
boolean

Результат обновления валюты

time
time

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

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

HTTP-статус: 400

{
	"error": "",
	"error_description": "Access denied."
}

Название
тип

Описание

error
string

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

error_description
string

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

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

Код

Описание

Значение

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

Access denied.

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

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

Модуль "Валюты" не найден! Пожалуйста, установите модуль "Валюты".

ERROR_CODE

Другие ошибки в данных для изменения валюты

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

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

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

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