Добавить валюту crm.currency.add

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

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

Scope: crm

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

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

Для языков, используемых на портале, необходимо указать параметры локализации. Если этого не сделать, будут использованы параметры по умолчанию. Для конкретного языка можно задать параметры локализации методом crm.currency.localizations.set.

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

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

Название `тип`	Описание
fields* `object`	Значения полей (подробное описание приведено ниже) для добавления новой валюты в виде структуры: `fields: { CURRENCY: 'значение', BASE: 'значение', AMOUNT_CNT: 'значение', AMOUNT: 'значение' SORT: 'значение' LANG: 'значение' }`

Параметр fields

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

Название `тип`	Описание
CURRENCY* `string`	Идентификатор валюты. Соответствует стандарту ISO 4217
BASE `string`	Признак, является ли валюта базовой. Возможные значения: `Y` — да `N` — нет Значение по умолчанию — `N`. Важно Не рекомендуется менять базовую валюту через REST. Иначе потребуется изменить курсы всех валют
AMOUNT_CNT* `integer`	Номинал. В качестве номинала чаще всего используется `1` или число кратное `10`
AMOUNT* `double`	Курс обмена по отношению к базовой валюте
SORT `integer`	Положение в списке валют. Значение по умолчанию — `100`
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`	Код разделителя триад. Допустимые значения описаны в справочнике

Примеры кода

Создание юаня с параметрами локализации (русский и английский языки)

Базовая валюта — рубль. Курс юаня — 12.2251 руб за 1 юань.

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

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

curl -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_SEP":"."}}}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.currency.add

curl -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_SEP":"."}}},"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: 'Yuan',
            HIDE_ZERO: 'Y',
            THOUSANDS_VARIANT: 'S',
          },
          en: {
            DECIMALS: 2,
            DEC_POINT: ',',
            FORMAT_STRING: '# CNY',
            FULL_NAME: 'Yuan',
            HIDE_ZERO: 'Y',
            THOUSANDS_SEP: '.',
          },
        },
      },
    },
    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: 'Yuan',
                HIDE_ZERO: 'Y',
                THOUSANDS_VARIANT: 'S',
              },
              en: {
                DECIMALS: 2,
                DEC_POINT: ',',
                FORMAT_STRING: '# CNY',
                FULL_NAME: 'Yuan',
                HIDE_ZERO: 'Y',
                THOUSANDS_SEP: '.',
              },
            },
          },
        },
        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_SEP": ".",
                },
            },
        },
    ).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.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_SEP' => '.',
                ],
            ],
        ]
    ]
);

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_SEP": ".",
			},
		},
	},
})
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)

Создание индонезийской рупии

Предполагаем, что базовая валюта — рубль. Валюта имеет очень низкий курс — 1 рупия эквивалентна 0,00548 рубля. В этом случае номинал (AMOUNT_CNT) увеличиваем, чтобы задавать курс с требуемой точностью.

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

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

curl -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.add

curl -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: 'Rupee',
            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: 'Rupee',
                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": "# CNY",
                    "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}")

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 `crm_currency.CURRENCY`	Идентификатор созданной валюты
time `time`	Информация о времени выполнения запроса

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

HTTP-статус: 400

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

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

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

Код	Описание	Значение
Пустая строка	Access denied.	Недостаточно прав доступа
Пустая строка	Модуль "Валюты" не найден! Пожалуйста, установите модуль "Валюты".
`ERROR_CORE`	Undefined array key "#FIELD#"	Не указано обязательное поле #FIELD# (вместо #FIELD# будет подставлен код отсутствующего поля)
`ERROR_CORE`	Другие ошибки в данных для создания валюты

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

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

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

Была ли статья полезна?

Обзор методов

Обновить валюту

Добавить валюту crm.currency.add

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

Параметр fieldsПараметр fields

Параметр LANGПараметр LANG

Примеры кодаПримеры кода

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

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

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

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

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

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