#Поля валюты

GET /v1/currencies/fields

Возвращает описание всех полей сущности с типами и атрибутами.

#Примеры

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

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

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

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

#Поля ответа

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

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

JSON 
{
  "success": true,
  "data": {
    "CURRENCY": { "type": "string", "isRequired": true, "isReadOnly": true },
    "AMOUNT": { "type": "double", "isRequired": true, "isReadOnly": false },
    "AMOUNT_CNT": { "type": "integer", "isRequired": true, "isReadOnly": false },
    "BASE": { "type": "char", "isRequired": false, "isReadOnly": false },
    "SORT": { "type": "integer", "isRequired": false, "isReadOnly": false },
    "FORMAT_STRING": { "type": "string", "isRequired": false, "isReadOnly": false },
    "FULL_NAME": { "type": "string", "isRequired": false, "isReadOnly": false },
    "DECIMALS": { "type": "integer", "isRequired": false, "isReadOnly": false },
    "DEC_POINT": { "type": "string", "isRequired": false, "isReadOnly": false },
    "THOUSANDS_SEP": { "type": "string", "isRequired": false, "isReadOnly": false }
  }
}

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

404 — не найден:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Элемент не найден"
  }
}

#Ошибки

HTTP Код Описание
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING Не передан API-ключ

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

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