Для AI-агентов: markdown этой страницы — /docs-content/entities/currencies/base.md индекс документации — /llms.txt

Базовая валюта

GET /v1/currencies/base

Позволяет узнать базовую валюту портала, относительно которой заданы курсы остальных валют в CRM.

Скоуп: crm. Ключ в режиме READONLY разрешён.

Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/currencies/base" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/currencies/base" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/currencies/base', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})
const { success, data } = await res.json()

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/currencies/base', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { success, data } = await res.json()

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data object Объект с кодом базовой валюты
data.currency string Код базовой валюты. Подробности о валюте — Получить валюту

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

JSON 
{
  "success": true,
  "data": {
    "currency": "RUB"
  }
}

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

403 — у ключа нет скоупа crm:

JSON 
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'crm' scope",
    "hint": "This request needs the 'crm' scope, which the calling key does not carry. Add 'crm' to this key in the developer cabinet (or through the management API), then repeat the call.",
    "cause": "key_scope_missing",
    "requiredScope": "crm",
    "keyScopes": [
      "task",
      "im"
    ],
    "fix": {
      "action": "edit_key_scopes",
      "via": "cabinet"
    },
    "userMessage": "Ключу приложения не хватает права «CRM». Добавить его можно в настройках ключа в кабинете разработчика."
  }
}

Ошибки

HTTP Код Описание
422 BITRIX_ERROR Битрикс24 отклонил чтение базовой валюты
403 BITRIX_ACCESS_DENIED У пользователя нет прав на операцию в Битрикс24
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 MISSING_API_KEY Не передан заголовок X-Api-Key
401 TOKEN_MISSING API-ключ не имеет настроенных токенов Битрикс24
502 BITRIX_RESPONSE_INVALID Получен ответ неожиданной структуры
502 BITRIX_UNAVAILABLE Битрикс24 недоступен

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

Известные особенности

Метод только читает настройки. Переключение базовой валюты через него недоступно.

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