Get Currency by Code crm.currency.get

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: crm

Who can execute the method: a user with read access to at least one CRM object

The crm.currency.get method returns a currency by its code, for example, USD. The response contains the exchange rate to the base currency, the sort index, and display parameters for different languages.

Note

The method returns the currency name, amount format, and separators for the current Bitrix24 language. Localizations for all languages are returned in the LANG field.

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
crm_currency.CURRENCY

Symbolic identifier of the currency.

Corresponds to the ISO 4217 standard.

The value is case-insensitive: the method accepts usd as USD.

The code can be obtained using the crm.currency.list method

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":"USD"}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.currency.get
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":"USD","auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.currency.get
        
// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type CrmCurrencyResult = {
          CURRENCY: string
          AMOUNT_CNT: string
          AMOUNT: string
          SORT: string
          BASE: string
          FULL_NAME: string
          LID: string
          FORMAT_STRING: string
          DEC_POINT: string
          THOUSANDS_SEP: string | null
          DECIMALS: string
          DATE_UPDATE: ISODate | null
          LANG: Record<string, CrmCurrencyLang>
        }
        
        type CrmCurrencyLang = {
          FORMAT_STRING: string
          FULL_NAME: string
          DEC_POINT: string
          THOUSANDS_SEP: string | null
          DECIMALS: string
          THOUSANDS_VARIANT: string
          HIDE_ZERO: string
        }
        
        try {
          const response = await $b24.actions.v2.call.make<CrmCurrencyResult>({
            method: 'crm.currency.get',
            params: {
              id: 'USD',
            },
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Currency:', result.CURRENCY, result.FULL_NAME)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function getCurrency() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'crm.currency.get',
                params: {
                  id: 'USD',
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Currency:', result.CURRENCY, result.FULL_NAME)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getCurrency)
        </script>
        

        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.currency.get(bitrix_id="USD").response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API Error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK Error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.currency.get',
                    [
                        'id' => 'USD',
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }
        
BX24.callMethod(
            "crm.currency.get",
            {
                id: "USD"
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.currency.get',
            [
                'id' => 'USD'
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "crm.currency.get", b24.Params{
        	"id": "EUR",
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("crm.currency.get: %w", err)
        }
        
        var item struct {
        	Currency  string `json:"CURRENCY"`
        	AmountCnt string `json:"AMOUNT_CNT"`
        	Amount    string `json:"AMOUNT"`
        	Sort      string `json:"SORT"`
        	Base      string `json:"BASE"`
        	FullName  string `json:"FULL_NAME"`
        }
        if err := json.Unmarshal(res.Result, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.Currency, item.AmountCnt)
        

Response Handling

HTTP status: 200

{
            "result": {
                "CURRENCY": "USD",
                "AMOUNT_CNT": "1",
                "AMOUNT": "1.0000",
                "SORT": "100",
                "BASE": "Y",
                "FULL_NAME": "United States Dollar",
                "LID": "de",
                "FORMAT_STRING": "# $",
                "DEC_POINT": ".",
                "THOUSANDS_SEP": "&nbsp;",
                "DECIMALS": "2",
                "DATE_UPDATE": "2024-01-29T12:28:40+02:00",
                "LANG": {
                    "en": {
                        "FORMAT_STRING": "$#",
                        "FULL_NAME": "United States Dollar",
                        "DEC_POINT": ".",
                        "THOUSANDS_SEP": null,
                        "DECIMALS": "2",
                        "THOUSANDS_VARIANT": "C",
                        "HIDE_ZERO": "Y"
                    },
                    "de": {
                        "FORMAT_STRING": "# $",
                        "FULL_NAME": "United States Dollar",
                        "DEC_POINT": ".",
                        "THOUSANDS_SEP": "&nbsp;",
                        "DECIMALS": "2",
                        "THOUSANDS_VARIANT": "B",
                        "HIDE_ZERO": "Y"
                    }
                }
            },
            "time": {
                "start": 1718357792.091095,
                "finish": 1718357792.889212,
                "duration": 0.79811692237854,
                "processing": 0.10800814628601074,
                "date_start": "2024-06-14T11:36:32+02:00",
                "date_finish": "2024-06-14T11:36:32+02:00",
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
crm_currency

Currency data (detailed description)

time
time

Information about the request execution time

result Object

Numeric values are returned as strings. The fields FULL_NAME, LID, FORMAT_STRING, DEC_POINT, THOUSANDS_SEP, and DECIMALS refer to the current Bitrix24 language. If there is no localization for this language, FULL_NAME equals the currency code, and the other fields are null.

Name
type

Description

CURRENCY
string

Currency code according to ISO 4217, for example, USD

AMOUNT_CNT
string

Nominal value — the number of currency units for which the rate is specified, for example, 1

AMOUNT
string

Exchange rate of the nominal value to the base currency, for example, 0.9250

SORT
string

Sort index

BASE
string

Whether the currency is the base currency: Y or N

FULL_NAME
string

Currency name in the current language

LID
string

Language for which the display fields are returned

FORMAT_STRING
string

Amount display template, for example, # $

DEC_POINT
string

Decimal separator

THOUSANDS_SEP
string

Thousands separator

DECIMALS
string

Number of decimal places

DATE_UPDATE
string

Date and time of the last change in ISO 8601 format

LANG
object

Currency localizations by language in the format {"en": {...}, "de": {...}}. The localization fields are described in the crm_currency_localization type. If there are no localizations, an empty array []

Error Handling

HTTP status: 400

{
        	"error": "",
        	"error_description": "Not found"
        }
        

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Status

Code

Description

Value

400

Empty value

Access denied.

The user has no read access to any CRM object

400

Empty value

ID is not defined or invalid.

The id parameter is not passed

400

Empty value

The parameter id is not string.

id is not passed as a string

400

Empty value

Not found

No currency with this code exists

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not found!

No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning