Set Localizations for Currency crm.currency.localizations.set

Scope: crm

Who can execute the method: any user with access to modify CRM settings

This method updates localizations for a currency or adds them if the localization for the specified language does not exist.

Method Parameters

Required parameters are marked with *

Name /
type

Description

id*
string

Currency identifier.

Corresponds to the ISO 4217 standard.

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

localizations*
object

Currency localization parameters.
An object in the format {"lang_1": "value_1", ... "lang_N": "value_N"}, where lang_N is the language identifier for which to add/change the localization, and value is an object of type crm_currency_localization.

Existing localizations that are not passed to the method will not be changed.

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":"CLF","localizations":{"en":{"FULL_NAME":"Unidad de Fomento","FORMAT_STRING":"CLF#VALUE#","DEC_POINT":".","THOUSANDS_VARIANT":"C","DECIMALS":4},"de":{"FULL_NAME":"Einheit der Entwicklung","FORMAT_STRING":"#VALUE# CLF","DEC_POINT":".","THOUSANDS_VARIANT":"B","DECIMALS":4}}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.currency.localizations.set

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":"CLF","localizations":{"en":{"FULL_NAME":"Unidad de Fomento","FORMAT_STRING":"CLF#VALUE#","DEC_POINT":".","THOUSANDS_VARIANT":"C","DECIMALS":4},"de":{"FULL_NAME":"Einheit der Entwicklung","FORMAT_STRING":"#VALUE# CLF","DEC_POINT":".","THOUSANDS_VARIANT":"B","DECIMALS":4}},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.currency.localizations.set

try
        {
        	const response = await $b24.callMethod(
        		"crm.currency.localizations.set",
        		{
        			id: 'CLF',
        			localizations: {
        				en: {
        					FULL_NAME: 'Unidad de Fomento',
        					FORMAT_STRING: 'CLF#VALUE#',
        					DEC_POINT: '.',
        					THOUSANDS_VARIANT: 'C',
        					DECIMALS: 4,
        				},
        				de: {
        					FULL_NAME: 'Einheit der Entwicklung',
        					FORMAT_STRING: '#VALUE# CLF',
        					DEC_POINT: '.',
        					THOUSANDS_VARIANT: 'B',
        					DECIMALS: 4,
        				}
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.log(result);
        }
        catch( error )
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.currency.localizations.set',
                    [
                        'id' => 'CLF',
                        'localizations' => [
                            'en' => [
                                'FULL_NAME'        => 'Unidad de Fomento',
                                'FORMAT_STRING'    => 'CLF#VALUE#',
                                'DEC_POINT'        => '.',
                                'THOUSANDS_VARIANT' => 'C',
                                'DECIMALS'         => 4,
                            ],
                            'de' => [
                                'FULL_NAME'        => 'Einheit der Entwicklung',
                                'FORMAT_STRING'    => '#VALUE# CLF',
                                'DEC_POINT'        => '.',
                                'THOUSANDS_VARIANT' => 'B',
                                'DECIMALS'         => 4,
                            ],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error setting currency localizations: ' . $e->getMessage();
        }

BX24.callMethod(
            "crm.currency.localizations.set",
            {
                id: 'CLF',
                localizations: {
                    en: {
                        FULL_NAME: 'Unidad de Fomento',
                        FORMAT_STRING: 'CLF#VALUE#',
                        DEC_POINT: '.',
                        THOUSANDS_VARIANT: 'C',
                        DECIMALS: 4,
                    },
                    de: {
                        FULL_NAME: 'Einheit der Entwicklung',
                        FORMAT_STRING: '#VALUE# CLF',
                        DEC_POINT: '.',
                        THOUSANDS_VARIANT: 'B',
                        DECIMALS: 4,
                    }
                }
            },
        )
        .then(
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result);
                }
            },
            function(error)
            {
                console.info(error);
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.currency.localizations.set',
            [
                'id' => 'CLF',
                'localizations' => [
                    'en' => [
                        'FULL_NAME' => 'Unidad de Fomento',
                        'FORMAT_STRING' => 'CLF#VALUE#',
                        'DEC_POINT' => '.',
                        'THOUSANDS_VARIANT' => 'C',
                        'DECIMALS' => 4,
                    ],
                    'de' => [
                        'FULL_NAME' => 'Einheit der Entwicklung',
                        'FORMAT_STRING' => '#VALUE# CLF',
                        'DEC_POINT' => '.',
                        'THOUSANDS_VARIANT' => 'B',
                        'DECIMALS' => 4,
                    ]
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "result": true,
            "time": {
                "start": 1718122481.837301,
                "finish": 1718122483.141736,
                "duration": 1.3044350147247314,
                "processing": 0.08866286277770996,
                "date_start": "2024-06-11T18:14:41+02:00",
                "date_finish": "2024-06-11T18:14:43+02:00",
                "operating": 0
            }
        }

Returned Data

Name
type

Description

result
boolean

Returns:

true — on success
false – if the operation could not be completed, but there is no error, or the situation is not considered erroneous. Possible scenarios:
- currency module is missing
- an empty object with localizations was passed
- no localization was added/changed

time
time

Information about the request execution time

Error Handling

HTTP Status: 400

{
            "error": "",
            "error_description": "The parameter id is invalid or not defined."
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code	Description	Value
Empty string	Access denied.	Insufficient access permissions
Empty string	The parameter id is invalid or not defined.	Empty currency identifier

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Get Currency Localizations

Delete Currency Localizations

Set Localizations for Currency crm.currency.localizations.set

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning