Get the List of Currencies crm.currency.list
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:
crmWho can execute the method: a user with read access to at least one CRM object
The crm.currency.list method returns all Bitrix24 currencies in a single response. For each currency, it returns the code, the exchange rate to the base currency, the sort index, and display parameters. The method has no paging, and the start parameter is ignored.
Note
The method returns the currency name, amount format, and separators for the current Bitrix24 language.
Method Parameters
|
Name |
Description |
|
order |
An optional object for sorting records in the format The method uses only the first field in Possible values for
|
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"order":{"sort":"asc","currency":"asc"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.currency.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"order":{"sort":"asc","currency":"asc"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.currency.list
// 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 each currency object returned in result[]
type CrmCurrencyListItem = {
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
}
try {
// crm.currency.list returns all currencies in one response (no paging)
const response = await $b24.actions.v2.call.make<CrmCurrencyListItem[]>({
method: 'crm.currency.list',
params: {
order: {
sort: 'asc',
currency: 'asc',
},
},
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('Currencies on this page:', result.length, result)
}
} 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 listCurrencies() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// crm.currency.list returns all currencies in one response (no paging)
const response = await $b24.actions.v2.call.make({
method: 'crm.currency.list',
params: {
order: {
sort: 'asc',
currency: 'asc',
},
},
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('Currencies on this page:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listCurrencies)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.currency.list(
order={
"sort": "asc",
"currency": "asc",
},
).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}")
as_list Example
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.currency.list(
order={
"sort": "asc",
"currency": "asc",
},
).as_list().response
result = bitrix_response.result
for item in result:
print(item)
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.list',
[
'order' => [
'sort' => 'asc',
'currency' => 'asc',
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// The data processing logic you need
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error: ' . $e->getMessage();
}
BX24.callMethod(
"crm.currency.list",
{
order: {
sort: 'asc',
currency: 'asc',
},
},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'crm.currency.list',
[
'order' => [
'sort' => 'asc',
'currency' => 'asc',
]
]
);
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.list", b24.Params{
"order": b24.Params{
"sort": "asc",
"currency": "asc",
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.currency.list: %w", err)
}
// The response arrives as json.RawMessage — unmarshal it
// into a struct matching the response shape shown below on this page.
fmt.Printf("%s\n", res.Result)
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": " ",
"DECIMALS": "2",
"DATE_UPDATE": "2024-01-29T12:28:40+02:00"
},
{
"CURRENCY": "USD",
"AMOUNT_CNT": "1",
"AMOUNT": "68.7900",
"SORT": "200",
"BASE": "N",
"FULL_NAME": "United States Dollar",
"LID": "de",
"FORMAT_STRING": "$#",
"DEC_POINT": ".",
"THOUSANDS_SEP": null,
"DECIMALS": "2",
"DATE_UPDATE": "2023-03-21T15:19:50+02:00"
},
{
"CURRENCY": "EUR",
"AMOUNT_CNT": "1",
"AMOUNT": "78.3200",
"SORT": "300",
"BASE": "N",
"FULL_NAME": "Euro",
"LID": "de",
"FORMAT_STRING": "# €",
"DEC_POINT": ".",
"THOUSANDS_SEP": " ",
"DECIMALS": "2",
"DATE_UPDATE": "2023-03-21T15:19:50+02:00"
},
{
"CURRENCY": "CAD",
"AMOUNT_CNT": "1",
"AMOUNT": "32.2000",
"SORT": "500",
"BASE": "N",
"FULL_NAME": "Canadian Dollar",
"LID": "de",
"FORMAT_STRING": "# CAD",
"DEC_POINT": ".",
"THOUSANDS_SEP": " ",
"DECIMALS": "2",
"DATE_UPDATE": "2023-03-21T15:19:50+02:00"
}
],
"total": 0,
"time": {
"start": 1716986687.629166,
"finish": 1716986688.481436,
"duration": 0.8522701263427734,
"processing": 0.014969825744628906,
"date_start": "2024-05-29T14:44:47+02:00",
"date_finish": "2024-05-29T14:44:48+02:00",
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
An array of all Bitrix24 currencies (detailed description) |
|
total |
Always |
|
time |
Information about the request execution time |
result Array Element
Numeric values are returned as strings. If there is no localization for the current Bitrix24 language, the fields FULL_NAME, LID, FORMAT_STRING, DEC_POINT, THOUSANDS_SEP, and DECIMALS are null. The crm.currency.get method returns localizations for all languages in the LANG field.
|
Name |
Description |
|
CURRENCY |
Currency code, for example, |
|
AMOUNT_CNT |
Nominal value — the number of currency units for which the rate is specified |
|
AMOUNT |
The value of the nominal amount in the base currency |
|
SORT |
Sort index |
|
BASE |
Whether the currency is the base currency: |
|
FULL_NAME |
Currency name in the current language |
|
LID |
Language for which the display fields are returned |
|
FORMAT_STRING |
Amount display template, for example, |
|
DEC_POINT |
Decimal separator |
|
THOUSANDS_SEP |
Thousands separator |
|
DECIMALS |
Number of decimal places |
|
DATE_UPDATE |
Date and time of the last change in ISO 8601 format |
Error Handling
HTTP status: 400
{
"error": "",
"error_description": "Access denied."
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Status |
Code |
Description |
Value |
|
|
Empty value |
|
|
|
|
Empty value |
|
|
|
|
Empty value |
|
The user has no read access to any CRM object |
|
|
Empty value |
|
The Currency module is not installed |
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 |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
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 |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
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 — |
|
|
|
No active webhook with the specified user identifier and secret code was 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 |
|
|
|
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 |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
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 |