#Создать валюту

POST /v1/currencies

Создаёт новую валюту в CRM. Код валюты задаётся в поле id (трёхбуквенный код ISO 4217).

#Параметры тела запроса

Параметр Тип Обязат. Описание
id string да Код валюты (RUB, USD, EUR)
amount number да Курс обмена относительно базовой валюты
amountCnt number да Номинал (обычно 1; для JPY обычно 100)
sort number Порядок сортировки
LANG object Локализация: название и формат отображения валюты (см. ниже)

Локализуемые поля пишутся только через LANG. Поля fullName, formatString, decimals, decPoint, thousandsSep в Битрикс24 хранятся в структуре локализации и при плоской записи молча игнорируются (запрос вернёт успех, значения не сохранятся). Передавайте их через объект LANG:

JSON 
{ "LANG": { "ru": { "FULL_NAME": "Китайский юань", "FORMAT_STRING": "# ¥", "DECIMALS": 2, "DEC_POINT": ".", "THOUSANDS_SEP": " " } } }

На чтении API уплощает локализацию текущего языка обратно в fullName / formatString / decimals / decPoint / thousandsSep.

#Примеры

#curl — личный ключ

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/currencies" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"id": "CNY", "amount": 12.7, "amountCnt": 1, "sort": 300, "LANG": {"ru": {"FULL_NAME": "Китайский юань"}}}'

#curl — OAuth-приложение

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/currencies" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"id": "CNY", "amount": 12.7, "amountCnt": 1, "sort": 300, "LANG": {"ru": {"FULL_NAME": "Китайский юань"}}}'

#JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/currencies', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/json' },
  body: JSON.stringify({ id: 'CNY', amount: 12.7, amountCnt: 1, sort: 300, LANG: { ru: { FULL_NAME: 'Китайский юань' } } }),
})
const { success, data } = await res.json()

#JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/currencies', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ id: 'CNY', amount: 12.7, amountCnt: 1, sort: 300, LANG: { ru: { FULL_NAME: 'Китайский юань' } } }),
})
const { success, data } = await res.json()

#Поля ответа

Поле Тип Описание
id string Код валюты (RUB, USD, EUR)
amountCnt number Количество единиц для курса
amount number Курс обмена
sort number Сортировка
base boolean Базовая валюта
fullName string Название (руб., $)
LID string Язык
formatString string Формат отображения
decPoint string Разделитель дробной части
thousandsSep string Разделитель тысяч
decimals number Знаков после запятой

#Пример ответа

JSON 
{
  "success": true,
  "data": { "id": "CNY" }
}

#Пример ответа при ошибке

JSON 
{
  "success": false,
  "error": { "code": "BITRIX_ERROR", "message": "Currency already exists" }
}

#Ошибки

HTTP Код Описание
400 BITRIX_ERROR Ошибка Bitrix24 (дубликат кода и др.)
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING Не передан API-ключ

Полный список ошибок — Ошибки.

#Смотрите также