لوكلاء AI: ملف markdown لهذه الصفحة — /docs-content-en/entities/currencies/localizations/fields.md فهرس التوثيق — /llms.txt

مقالات التوثيق متاحة حاليًا باللغة الإنجليزية فقط.

Currency localization fields

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

Describes the currency name and amount format settings for each language. Use this reference before writing localizations.

Scope: crm. A key in READONLY mode is accepted.

Parameters

Parameter Type Required Default Description
Parameterid (path) Typestring Requiredyes Default— DescriptionCurrency code from the currency list. The metadata is shared by all currencies; the code's existence is not checked

Examples

curl — personal key

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

curl — OAuth application

Terminal 
curl "https://vibecode.bitrix24.com/v1/currencies/QVC/localizations/fields" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

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

JavaScript — OAuth application

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

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typeobject DescriptionMap of localization field metadata
Fielddata.fullName Typeobject DescriptionFull currency name. Setting metadata
Fielddata.fullName.bitrixName Typestring DescriptionSource field name: FULL_NAME
Fielddata.fullName.type Typestring DescriptionValue type: string
Fielddata.fullName.readonly Typeboolean Descriptionfalse — the setting can be passed on write
Fielddata.formatString Typeobject DescriptionAmount display template, # is the placeholder for the number. Setting metadata
Fielddata.formatString.bitrixName Typestring DescriptionSource field name: FORMAT_STRING
Fielddata.formatString.type Typestring DescriptionValue type: string
Fielddata.formatString.readonly Typeboolean Descriptionfalse — the setting can be passed on write
Fielddata.decPoint Typeobject DescriptionDecimal separator. Setting metadata
Fielddata.decPoint.bitrixName Typestring DescriptionSource field name: DEC_POINT
Fielddata.decPoint.type Typestring DescriptionValue type: string
Fielddata.decPoint.readonly Typeboolean Descriptionfalse — the setting can be passed on write
Fielddata.thousandsVariant Typeobject DescriptionThousands separator variant. Setting metadata
Fielddata.thousandsVariant.bitrixName Typestring DescriptionSource field name: THOUSANDS_VARIANT
Fielddata.thousandsVariant.type Typestring DescriptionValue type: string
Fielddata.thousandsVariant.readonly Typeboolean Descriptionfalse — the setting can be passed on write
Fielddata.thousandsSep Typeobject DescriptionThousands separator character. Setting metadata
Fielddata.thousandsSep.bitrixName Typestring DescriptionSource field name: THOUSANDS_SEP
Fielddata.thousandsSep.type Typestring DescriptionValue type: string
Fielddata.thousandsSep.readonly Typeboolean Descriptionfalse — the setting can be passed on write
Fielddata.decimals Typeobject DescriptionNumber of digits after the decimal separator. Setting metadata
Fielddata.decimals.bitrixName Typestring DescriptionSource field name: DECIMALS
Fielddata.decimals.type Typestring DescriptionValue type: number
Fielddata.decimals.readonly Typeboolean Descriptionfalse — the setting can be passed on write
Fielddata.hideZero Typeobject DescriptionHide trailing zeros in the fractional part. Setting metadata
Fielddata.hideZero.bitrixName Typestring DescriptionSource field name: HIDE_ZERO
Fielddata.hideZero.type Typestring DescriptionValue type: boolean
Fielddata.hideZero.readonly Typeboolean Descriptionfalse — the setting can be passed on write

Response example

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
    }
  }
}

Error response example

403 — the key has no crm scope:

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": "The app's API key lacks the “CRM” permission. You can add it in the key settings in the developer cabinet."
  }
}

Errors

HTTP Code Description
HTTP422 CodeBITRIX_ERROR DescriptionBitrix24 rejected the reference request
HTTP403 CodeBITRIX_ACCESS_DENIED DescriptionThe user has no permission for the operation in Bitrix24
HTTP403 CodeSCOPE_DENIED DescriptionThe API key has no crm scope
HTTP401 CodeMISSING_API_KEY DescriptionThe X-Api-Key header is missing
HTTP401 CodeTOKEN_MISSING DescriptionThe API key has no configured Bitrix24 tokens
HTTP502 CodeBITRIX_RESPONSE_INVALID DescriptionA response with an unexpected structure was received
HTTP502 CodeBITRIX_UNAVAILABLE DescriptionBitrix24 is unavailable

Full list of common API errors — Errors.

See also