метод REST scope: crm

crm.currency.add

Добавить валюту

Кто может выполнять: любой пользователь с доступом к изменению настроек 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 необязательный

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

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

Примеры запроса

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

Ответ

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

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.