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

Поля локализаций валюты

GET /v1/currencies/:id/localizations/fields

Описывает настройки названия валюты и формата сумм для каждого языка. Используйте справочник перед записью локализаций.

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

Параметры

Параметр Тип Обяз. По умолч. Описание
id (path) string да — Код валюты из Списка валют. Метаданные общие для всех валют, существование кода не проверяется

Примеры

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

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

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/currencies/QVC/localizations/fields" \
  -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/QVC/localizations/fields', {
  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/QVC/localizations/fields', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { success, data } = await res.json()

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data object Карта метаданных полей локализации
data.fullName object Полное название валюты. Метаданные настройки
data.fullName.bitrixName string Исходное имя поля: FULL_NAME
data.fullName.type string Тип значения: string
data.fullName.readonly boolean false — настройку можно передать при записи
data.formatString object Шаблон отображения суммы, # — место для числа. Метаданные настройки
data.formatString.bitrixName string Исходное имя поля: FORMAT_STRING
data.formatString.type string Тип значения: string
data.formatString.readonly boolean false — настройку можно передать при записи
data.decPoint object Разделитель дробной части. Метаданные настройки
data.decPoint.bitrixName string Исходное имя поля: DEC_POINT
data.decPoint.type string Тип значения: string
data.decPoint.readonly boolean false — настройку можно передать при записи
data.thousandsVariant object Вариант разделителя тысяч. Метаданные настройки
data.thousandsVariant.bitrixName string Исходное имя поля: THOUSANDS_VARIANT
data.thousandsVariant.type string Тип значения: string
data.thousandsVariant.readonly boolean false — настройку можно передать при записи
data.thousandsSep object Символ разделителя тысяч. Метаданные настройки
data.thousandsSep.bitrixName string Исходное имя поля: THOUSANDS_SEP
data.thousandsSep.type string Тип значения: string
data.thousandsSep.readonly boolean false — настройку можно передать при записи
data.decimals object Количество знаков после разделителя дробной части. Метаданные настройки
data.decimals.bitrixName string Исходное имя поля: DECIMALS
data.decimals.type string Тип значения: number
data.decimals.readonly boolean false — настройку можно передать при записи
data.hideZero object Скрывать незначащие нули дробной части. Метаданные настройки
data.hideZero.bitrixName string Исходное имя поля: HIDE_ZERO
data.hideZero.type string Тип значения: boolean
data.hideZero.readonly boolean false — настройку можно передать при записи

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

JSON 
{
  "success": true,
  "data": {
    "fullName": {
      "bitrixName": "FULL_NAME",
      "type": "string",
      "readonly": false
    },
    "formatString": {
      "bitrixName": "FORMAT_STRING",
      "type": "string",
      "readonly": false
    },
    "decPoint": {
      "bitrixName": "DEC_POINT",
      "type": "string",
      "readonly": false
    },
    "thousandsVariant": {
      "bitrixName": "THOUSANDS_VARIANT",
      "type": "string",
      "readonly": false
    },
    "thousandsSep": {
      "bitrixName": "THOUSANDS_SEP",
      "type": "string",
      "readonly": false
    },
    "decimals": {
      "bitrixName": "DECIMALS",
      "type": "number",
      "readonly": false
    },
    "hideZero": {
      "bitrixName": "HIDE_ZERO",
      "type": "boolean",
      "readonly": false
    }
  }
}

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

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 — Ошибки.

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