Add Currency crm.currency.add

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 the "Edit CRM preferences" permission in CRM

The crm.currency.add method adds a currency and returns its code.

Pass the localization parameters — the currency name and the amount format for each Bitrix24 language — in the LANG field. Languages missing from it get the default parameters. You can also set the parameters for a single language separately with the crm.currency.localizations.set method.

Method Parameters

Required parameters are marked with *

Name
type

Description

fields*
object

Field values (detailed description provided below) for adding a new currency in the form of a structure:

fields: {
            CURRENCY: 'value',
            BASE: 'value',
            AMOUNT_CNT: 'value',
            AMOUNT: 'value',
            SORT: 'value',
            LANG: 'value'
        }

Parameter fields

Required parameters are marked with *

Name
type

Description

CURRENCY*
string

Currency identifier.

Corresponds to the ISO 4217 standard

BASE
string

Base currency flag. The method ignores this parameter and does not return an error: you cannot make a currency the base currency with this method. The base currency is changed by the crm.currency.base.set method

AMOUNT_CNT*
integer

Denomination — the number of currency units for which the AMOUNT rate is set. Usually 1, 10, 100, and so on

AMOUNT*
double

The value of the AMOUNT_CNT denomination in the base currency, for example 0.1220

SORT
integer

Position in the currency list.

Default value is 100.

LANG
object

Currency localization parameters.

An object in the format {"lang_1": "value_1", ... "lang_N": "value_N"}, where lang_N is the language identifier, and value is an object of type crm_currency_localization.

If not all languages are specified, default localization parameters will be used for the remaining ones.

Parameter LANG

Name
type

Description

DECIMALS
integer

Number of decimal places

DEC_POINT
string

Decimal separator

FORMAT_STRING*
string

Amount display template, for example # CNY

FULL_NAME
string

Name of the currency in the language for which localization is added.

HIDE_ZERO
string

Whether to hide insignificant zeros: Y — hide, N — show. The method saves any other value as N

THOUSANDS_SEP
string

Thousands separator

THOUSANDS_VARIANT
string

Code for the thousands separator.

Allowed values are described in the reference.

Code Examples

  1. Creating the yuan with localization parameters (Russian and English languages)

    The base currency is the euro. One yuan costs 0.1220 euros.

    How to Use Examples in Documentation

    curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"CURRENCY":"CNY","BASE":"N","AMOUNT":0.1220,"AMOUNT_CNT":1,"SORT":9000,"LANG":{"ru":{"DECIMALS":2,"DEC_POINT":".","FORMAT_STRING":"# CNY","FULL_NAME":"yuan","HIDE_ZERO":"Y","THOUSANDS_VARIANT":"S"},"en":{"DECIMALS":2,"DEC_POINT":",","FORMAT_STRING":"# CNY","FULL_NAME":"yuan","HIDE_ZERO":"Y","THOUSANDS_VARIANT":"D"}}}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.currency.add
        
    curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"CURRENCY":"CNY","BASE":"N","AMOUNT":0.1220,"AMOUNT_CNT":1,"SORT":9000,"LANG":{"ru":{"DECIMALS":2,"DEC_POINT":".","FORMAT_STRING":"# CNY","FULL_NAME":"yuan","HIDE_ZERO":"Y","THOUSANDS_VARIANT":"S"},"en":{"DECIMALS":2,"DEC_POINT":",","FORMAT_STRING":"# CNY","FULL_NAME":"yuan","HIDE_ZERO":"Y","THOUSANDS_VARIANT":"D"}}},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.currency.add
        
    // 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 } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        try {
          const response = await $b24.actions.v2.call.make<string>({
            method: 'crm.currency.add',
            params: {
              fields: {
                CURRENCY: 'CNY',
                BASE: 'N',
                AMOUNT: 0.1220,
                AMOUNT_CNT: 1,
                SORT: 9000,
                LANG: {
                  ru: {
                    DECIMALS: 2,
                    DEC_POINT: '.',
                    FORMAT_STRING: '# CNY',
                    FULL_NAME: 'yuan',
                    HIDE_ZERO: 'Y',
                    THOUSANDS_VARIANT: 'S',
                  },
                  en: {
                    DECIMALS: 2,
                    DEC_POINT: ',',
                    FORMAT_STRING: '# CNY',
                    FULL_NAME: 'yuan',
                    HIDE_ZERO: 'Y',
                    THOUSANDS_VARIANT: 'D',
                  },
                },
              },
            },
            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('Created currency id:', 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 addCurrency() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'crm.currency.add',
                params: {
                  fields: {
                    CURRENCY: 'CNY',
                    BASE: 'N',
                    AMOUNT: 0.1220,
                    AMOUNT_CNT: 1,
                    SORT: 9000,
                    LANG: {
                      ru: {
                        DECIMALS: 2,
                        DEC_POINT: '.',
                        FORMAT_STRING: '# CNY',
                        FULL_NAME: 'yuan',
                        HIDE_ZERO: 'Y',
                        THOUSANDS_VARIANT: 'S',
                      },
                      en: {
                        DECIMALS: 2,
                        DEC_POINT: ',',
                        FORMAT_STRING: '# CNY',
                        FULL_NAME: 'yuan',
                        HIDE_ZERO: 'Y',
                        THOUSANDS_VARIANT: 'D',
                      },
                    },
                  },
                },
                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('Created currency id:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', addCurrency)
        </script>
        
    
        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.currency.add(
                fields={
                    "CURRENCY": "CNY",
                    "BASE": "N",
                    "AMOUNT": 0.1220,
                    "AMOUNT_CNT": 1,
                    "SORT": 9000,
                    "LANG": {
                        "de": {
                            "DECIMALS": 2,
                            "DEC_POINT": ".",
                            "FORMAT_STRING": "# CNY",
                            "FULL_NAME": "yuan",
                            "HIDE_ZERO": "Y",
                            "THOUSANDS_VARIANT": "S",
                        },
                        "en": {
                            "DECIMALS": 2,
                            "DEC_POINT": ",",
                            "FORMAT_STRING": "# CNY",
                            "FULL_NAME": "yuan",
                            "HIDE_ZERO": "Y",
                            "THOUSANDS_VARIANT": "D",
                        },
                    },
                },
            ).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.add',
                    [
                        'fields' => [
                            'CURRENCY' => 'CNY',
                            'BASE' => 'N',
                            'AMOUNT' => 0.1220,
                            'AMOUNT_CNT' => 1,
                            'SORT' => 9000,
                            'LANG' => [
                                'ru' => [
                                    'DECIMALS' => 2,
                                    'DEC_POINT' => '.',
                                    'FORMAT_STRING' => '# CNY',
                                    'FULL_NAME' => 'yuan',
                                    'HIDE_ZERO' => 'Y',
                                    'THOUSANDS_VARIANT' => 'S',
                                ],
                                'en' => [
                                    'DECIMALS' => 2,
                                    'DEC_POINT' => ',',
                                    'FORMAT_STRING' => '# CNY',
                                    'FULL_NAME' => 'yuan',
                                    'HIDE_ZERO' => 'Y',
                                    'THOUSANDS_VARIANT' => 'D',
                                ],
                            ],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }
        
    BX24.callMethod(
            "crm.currency.add",
            {
                fields: {
                    CURRENCY: 'CNY',
                    BASE: 'N',
                    AMOUNT: 0.1220,
                    AMOUNT_CNT: 1,
                    SORT: 9000,
                    LANG: {
                        ru: {
                            DECIMALS: 2,
                            DEC_POINT: '.',
                            FORMAT_STRING: '# CNY',
                            FULL_NAME: 'yuan',
                            HIDE_ZERO: 'Y',
                            THOUSANDS_VARIANT: 'S'
                        },
                        en: {
                            DECIMALS: 2,
                            DEC_POINT: ',',
                            FORMAT_STRING: '# CNY',
                            FULL_NAME: 'yuan',
                            HIDE_ZERO: 'Y',
                            THOUSANDS_VARIANT: 'D'
                        }
                    }
                }
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );
        
    require_once('crest.php');
        
        $result = CRest::call(
            'crm.currency.add',
            [
                'fields' => [
                    'CURRENCY' => 'CNY',
                    'BASE' => 'N',
                    'AMOUNT' => 0.1220,
                    'AMOUNT_CNT' => 1,
                    'SORT' => 9000,
                    'LANG' => [
                        'de' => [
                            'DECIMALS' => 2,
                            'DEC_POINT' => '.',
                            'FORMAT_STRING' => '# CNY',
                            'FULL_NAME' => 'yuan',
                            'HIDE_ZERO' => 'Y',
                            'THOUSANDS_VARIANT' => 'S',
                        ],
                        'en' => [
                            'DECIMALS' => 2,
                            'DEC_POINT' => ',',
                            'FORMAT_STRING' => '# CNY',
                            'FULL_NAME' => 'yuan',
                            'HIDE_ZERO' => 'Y',
                            'THOUSANDS_VARIANT' => 'D',
                        ],
                    ],
                ]
            ]
        );
        
        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.add", b24.Params{
        	"fields": b24.Params{
        		"CURRENCY":   "CNY",
        		"BASE":       "N",
        		"AMOUNT":     0.1220,
        		"AMOUNT_CNT": 1,
        		"SORT":       9000,
        		"LANG": b24.Params{
        			"ru": b24.Params{
        				"DECIMALS":          2,
        				"DEC_POINT":         ".",
        				"FORMAT_STRING":     "# CNY",
        				"FULL_NAME":         "yuan",
        				"HIDE_ZERO":         "Y",
        				"THOUSANDS_VARIANT": "S",
        			},
        			"en": b24.Params{
        				"DECIMALS":      2,
        				"DEC_POINT":     ",",
        				"FORMAT_STRING": "# CNY",
        				"FULL_NAME":     "yuan",
        				"HIDE_ZERO":     "Y",
        				"THOUSANDS_VARIANT": "D",
        			},
        		},
        	},
        })
        if err != nil {
        	return fmt.Errorf("crm.currency.add: %w", err)
        }
        
        var value string
        if err := json.Unmarshal(res.Result, &value); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println("result:", value)

  2. Creating the Indonesian rupiah

    The base currency is the euro. One rupiah costs 0.00005405 euros. To set such a low rate precisely, we increase the denomination: AMOUNT = 0.5405 euros per AMOUNT_CNT = 10000 rupiah.

    How to Use Examples in Documentation

    curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"CURRENCY":"IDR","AMOUNT":0.5405,"AMOUNT_CNT":10000,"SORT":8000,"LANG":{"ru":{"DECIMALS":2,"DEC_POINT":".","FORMAT_STRING":"Rp#","FULL_NAME":"rupiah","HIDE_ZERO":"Y","THOUSANDS_VARIANT":"C"},"en":{"DECIMALS":2,"DEC_POINT":".","FORMAT_STRING":"Rp#","FULL_NAME":"rupee","HIDE_ZERO":"Y","THOUSANDS_VARIANT":"C"}}}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.currency.add
        
    curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"CURRENCY":"IDR","AMOUNT":0.5405,"AMOUNT_CNT":10000,"SORT":8000,"LANG":{"ru":{"DECIMALS":2,"DEC_POINT":".","FORMAT_STRING":"Rp#","FULL_NAME":"rupiah","HIDE_ZERO":"Y","THOUSANDS_VARIANT":"C"},"en":{"DECIMALS":2,"DEC_POINT":".","FORMAT_STRING":"Rp#","FULL_NAME":"rupee","HIDE_ZERO":"Y","THOUSANDS_VARIANT":"C"}}},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.currency.add
        
    // 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 } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        try {
          const response = await $b24.actions.v2.call.make<string>({
            method: 'crm.currency.add',
            params: {
              fields: {
                CURRENCY: 'IDR',
                AMOUNT: 0.5405,
                AMOUNT_CNT: 10000,
                SORT: 8000,
                LANG: {
                  ru: {
                    DECIMALS: 2,
                    DEC_POINT: '.',
                    FORMAT_STRING: 'Rp#',
                    FULL_NAME: 'rupiah',
                    HIDE_ZERO: 'Y',
                    THOUSANDS_VARIANT: 'C',
                  },
                  en: {
                    DECIMALS: 2,
                    DEC_POINT: '.',
                    FORMAT_STRING: 'Rp#',
                    FULL_NAME: 'rupee',
                    HIDE_ZERO: 'Y',
                    THOUSANDS_VARIANT: 'C',
                  },
                },
              },
            },
            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('Created currency id:', 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 addCurrency() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'crm.currency.add',
                params: {
                  fields: {
                    CURRENCY: 'IDR',
                    AMOUNT: 0.5405,
                    AMOUNT_CNT: 10000,
                    SORT: 8000,
                    LANG: {
                      ru: {
                        DECIMALS: 2,
                        DEC_POINT: '.',
                        FORMAT_STRING: 'Rp#',
                        FULL_NAME: 'rupiah',
                        HIDE_ZERO: 'Y',
                        THOUSANDS_VARIANT: 'C',
                      },
                      en: {
                        DECIMALS: 2,
                        DEC_POINT: '.',
                        FORMAT_STRING: 'Rp#',
                        FULL_NAME: 'rupee',
                        HIDE_ZERO: 'Y',
                        THOUSANDS_VARIANT: 'C',
                      },
                    },
                  },
                },
                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('Created currency id:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', addCurrency)
        </script>
        
    
        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.currency.add(
                fields={
                    "CURRENCY": "IDR",
                    "AMOUNT": 0.5405,
                    "AMOUNT_CNT": 10000,
                    "SORT": 8000,
                    "LANG": {
                        "de": {
                            "DECIMALS": 2,
                            "DEC_POINT": ".",
                            "FORMAT_STRING": "Rp#",
                            "FULL_NAME": "rupee",
                            "HIDE_ZERO": "Y",
                            "THOUSANDS_VARIANT": "C",
                        },
                        "en": {
                            "DECIMALS": 2,
                            "DEC_POINT": ".",
                            "FORMAT_STRING": "Rp#",
                            "FULL_NAME": "rupee",
                            "HIDE_ZERO": "Y",
                            "THOUSANDS_VARIANT": "C",
                        },
                    },
                },
            ).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.add',
                    [
                        'fields' => [
                            'CURRENCY' => 'IDR',
                            'AMOUNT' => 0.5405,
                            'AMOUNT_CNT' => 10000,
                            'SORT' => 8000,
                            'LANG' => [
                                'ru' => [
                                    'DECIMALS' => 2,
                                    'DEC_POINT' => '.',
                                    'FORMAT_STRING' => 'Rp#',
                                    'FULL_NAME' => 'rupiah',
                                    'HIDE_ZERO' => 'Y',
                                    'THOUSANDS_VARIANT' => 'C',
                                ],
                                'en' => [
                                    'DECIMALS' => 2,
                                    'DEC_POINT' => '.',
                                    'FORMAT_STRING' => 'Rp#',
                                    'FULL_NAME' => 'rupee',
                                    'HIDE_ZERO' => 'Y',
                                    'THOUSANDS_VARIANT' => 'C',
                                ],
                            ],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }
        
    BX24.callMethod(
            "crm.currency.add",
            {
                fields: {
                    CURRENCY: 'IDR',
                    AMOUNT: 0.5405,
                    AMOUNT_CNT: 10000,
                    SORT: 8000,
                    LANG: {
                        ru: {
                            DECIMALS: 2,
                            DEC_POINT: '.',
                            FORMAT_STRING: 'Rp#',
                            FULL_NAME: 'rupiah',
                            HIDE_ZERO: 'Y',
                            THOUSANDS_VARIANT: 'C'
                        },
                        en: {
                            DECIMALS: 2,
                            DEC_POINT: '.',
                            FORMAT_STRING: 'Rp#',
                            FULL_NAME: 'rupee',
                            HIDE_ZERO: 'Y',
                            THOUSANDS_VARIANT: 'C'
                        }
                    }
                }
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );
        
    require_once('crest.php');
        
        $result = CRest::call(
            'crm.currency.add',
            [
                'fields' => [
                    'CURRENCY' => 'IDR',
                    'AMOUNT' => 0.5405,
                    'AMOUNT_CNT' => 10000,
                    'SORT' => 8000,
                    'LANG' => [
                        'de' => [
                            'DECIMALS' => 2,
                            'DEC_POINT' => '.',
                            'FORMAT_STRING' => 'Rp#',
                            'FULL_NAME' => 'rupee',
                            'HIDE_ZERO' => 'Y',
                            'THOUSANDS_VARIANT' => 'C',
                        ],
                        'en' => [
                            'DECIMALS' => 2,
                            'DEC_POINT' => '.',
                            'FORMAT_STRING' => 'Rp#',
                            'FULL_NAME' => 'rupee',
                            'HIDE_ZERO' => 'Y',
                            'THOUSANDS_VARIANT' => 'C',
                        ]
                    ]
                ]
            ]
        );
        
        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.add", b24.Params{
        	"fields": b24.Params{
        		"CURRENCY":   "IDR",
        		"AMOUNT":     0.5405,
        		"AMOUNT_CNT": 10000,
        		"SORT":       8000,
        		"LANG": b24.Params{
        			"ru": b24.Params{
        				"DECIMALS":          2,
        				"DEC_POINT":         ".",
        				"FORMAT_STRING":     "Rp#",
        				"FULL_NAME":         "rupiah",
        				"HIDE_ZERO":         "Y",
        				"THOUSANDS_VARIANT": "C",
        			},
        			"en": b24.Params{
        				"DECIMALS":          2,
        				"DEC_POINT":         ".",
        				"FORMAT_STRING":     "Rp#",
        				"FULL_NAME":         "rupee",
        				"HIDE_ZERO":         "Y",
        				"THOUSANDS_VARIANT": "C",
        			},
        		},
        	},
        })
        if err != nil {
        	return fmt.Errorf("crm.currency.add: %w", err)
        }
        
        var value string
        if err := json.Unmarshal(res.Result, &value); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println("result:", value)

Response Handling

HTTP status: 200

{
            "result": "CNY",
            "time": {
                "start": 1717684463.467685,
                "finish": 1717684465.282238,
                "duration": 1.8145530223846436,
                "processing": 0.12580394744873047,
                "date_start": "2024-06-06T16:34:23+02:00",
                "date_finish": "2024-06-06T16:34:25+02:00",
                "operating": 0
            }
        }

Returned Data

Name
type

Description

result
crm_currency.CURRENCY

Identifier of the created currency.

time
time

Information about the request execution time

Error Handling

HTTP status: 400

{
        	"error": "",
        	"error_description": "Access denied."
        }

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 does not have the "Edit CRM preferences" permission in CRM

400

ERROR_CORE

The currency ID must be represented by three Latin characters.

CURRENCY is not three Latin letters

400

ERROR_CORE

Currency with this ID already exists.

A currency with this code already exists

400

ERROR_CORE

The default exchange rate is not specified.

AMOUNT is not passed

400

ERROR_CORE

The field "Format" for language ru is empty.

FORMAT_STRING is not passed in a localization from LANG

400

ERROR_CORE

The decimal point is the same as the thousands separator specified for en

In a localization from LANG, the thousands separator is the same as DEC_POINT

400

ERROR_CORE

The default exchange rate is incorrect.

AMOUNT is not greater than zero

400

ERROR_CORE

The currency face value is incorrect.

AMOUNT_CNT is not greater than zero

400

Empty value

The Currency module is not installed.

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

Previous
Overview of Methods
Next
Update Currency