Add Cash Register sale.cashbox.add

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Scope: sale, cashbox

Who can execute the method: CRM administrator (permission "Allow to change settings")

This method adds a cash register.

Method Parameters

Required parameters are marked with *

Name `type`	Description
NAME* `string`	Name of the cash register
REST_CODE* `sale_cashbox_handler.CODE`	REST handler code for the cash register. Specified when adding the handler in the method sale.cashbox.handler.add in the `CODE` parameter
EMAIL* `string`	Email address to which notifications will be sent in case of errors during receipt printing
OFD `string`	OFD handler code. Available OFD handlers: `bx_firstofd` — First OFD `bx_platformaofd` — OFD Platform `bx_yarusofd` — YARUS OFD `bx_taxcomofd` — Taxcom OFD `bx_ofdruofd` — OFD.RU `bx_tenzorofd` — Tensor OFD `bx_conturofd` — Kontur OFD By default, without OFD
OFD_SETTINGS `object`	OFD settings (detailed description provided below). By default, an empty array
NUMBER_KKM `string`	External identifier of the cash register. By default, empty
ACTIVE `string`	Activity status of the cash register. Possible values: `Y` — yes `N` — no Default value: `N`
SORT `integer`	Sorting. Default `100`
USE_OFFLINE `string`	Whether the cash register is used offline. Possible values: `Y` — yes `N` — no Default value: `N`
SETTINGS `array`	Cash register settings according to the settings structure passed in the `CONFIG` key of the `SETTINGS` field of the method sale.cashbox.handler.add. By default, empty

OFD_SETTINGS Parameter

Name `type`	Description
Settings for all OFDs
OFD_MODE `object`	Settings related to the OFD operation mode. The `IS_TEST` parameter is passed (`string` with values `Y/N`) — OFD operation mode: `Y` — test mode `N` — working mode
Additional settings for OFD.RU
SELLER_INFO `object`	Settings for the "Seller Information" section. The required parameter `INN` (`string`) — seller's INN is passed
Additional settings for YARUS OFD
AUTH `object`	Authorization settings. The `INN` parameter is passed (`string`) — security key

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 '{"NAME":"Rest-Cash Register","REST_CODE":"restcashbox01","EMAIL":"user@example.com","NUMBER_KKM":"123","ACTIVE":"Y","SORT":100,"OFD":"bx_ofdruofd","OFD_SETTINGS":{"OFD_MODE":{"IS_TEST":"N"}},"SETTINGS":{"AUTH":{"KEYWORD":"top_secret!","PREFERENCE":"SECOND"},"INTERACTION":{"MODE":"ACTIVE"}}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.cashbox.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"NAME":"Rest-Cash Register","REST_CODE":"restcashbox01","EMAIL":"user@example.com","NUMBER_KKM":"123","ACTIVE":"Y","SORT":100,"OFD":"bx_ofdruofd","OFD_SETTINGS":{"OFD_MODE":{"IS_TEST":"N"}},"SETTINGS":{"AUTH":{"KEYWORD":"top_secret!","PREFERENCE":"SECOND"},"INTERACTION":{"MODE":"ACTIVE"}},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sale.cashbox.add

try
        {
        	const response = await $b24.callMethod(
        		"sale.cashbox.add",
        		{
        			"NAME": 'Rest-Cash Register',
        			"REST_CODE": 'restcashbox01',
        			"EMAIL": "user@example.com",
        			"NUMBER_KKM": "123",
        			"ACTIVE": "Y",
        			"SORT": 100,
        			"OFD": "bx_ofdruofd",
        			"OFD_SETTINGS":
        			{
        				"OFD_MODE":
        				{
        					"IS_TEST": "N"
        				}
        			},
        			"SETTINGS":
        			{
        				"AUTH":
        				{
        					"KEYWORD": "top_secret!",
        					"PREFERENCE": "SECOND"
        				},
        				"INTERACTION":
        				{
        					"MODE": "ACTIVE"
        				}
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	if(result.error())
        		console.error(result.error());
        	else
        		console.dir(result);
        }
        catch(error)
        {
        	console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'sale.cashbox.add',
                    [
                        'NAME'       => 'Rest-Cash Register',
                        'REST_CODE'  => 'restcashbox01',
                        'EMAIL'      => 'user@example.com',
                        'NUMBER_KKM' => '123',
                        'ACTIVE'     => 'Y',
                        'SORT'       => 100,
                        'OFD'        => 'bx_ofdruofd',
                        'OFD_SETTINGS' => [
                            'OFD_MODE' => [
                                'IS_TEST' => 'N'
                            ]
                        ],
                        'SETTINGS' => [
                            'AUTH' => [
                                'KEYWORD'    => 'top_secret!',
                                'PREFERENCE' => 'SECOND'
                            ],
                            'INTERACTION' => [
                                'MODE' => 'ACTIVE'
                            ]
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Your required data processing logic
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding cash register: ' . $e->getMessage();
        }

BX24.callMethod(
            "sale.cashbox.add",
            {
                "NAME": 'Rest-Cash Register',
                "REST_CODE": 'restcashbox01',
                "EMAIL": "user@example.com",
                "NUMBER_KKM": "123",
                "ACTIVE": "Y",
                "SORT": 100,
                "OFD": "bx_ofdruofd",
                "OFD_SETTINGS":
                {
                    "OFD_MODE":
                    {
                        "IS_TEST": "N"
                    }
                },
                "SETTINGS":
                {
                    "AUTH":
                    {
                        "KEYWORD": "top_secret!",
                        "PREFERENCE": "SECOND"
                    },
                    "INTERACTION":
                    {
                        "MODE": "ACTIVE"
                    }
                }
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'sale.cashbox.add',
            [
                'NAME' => 'Rest-Cash Register',
                'REST_CODE' => 'restcashbox01',
                'EMAIL' => 'user@example.com',
                'NUMBER_KKM' => '123',
                'ACTIVE' => 'Y',
                'SORT' => 100,
                'OFD' => 'bx_ofdruofd',
                'OFD_SETTINGS' =>
                [
                    'OFD_MODE' =>
                    [
                        'IS_TEST' => 'N'
                    ]
                ],
                'SETTINGS' =>
                [
                    'AUTH' =>
                    [
                        'KEYWORD' => 'top_secret!',
                        'PREFERENCE' => 'SECOND'
                    ],
                    'INTERACTION' =>
                    [
                        'MODE' => 'ACTIVE'
                    ]
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Typical use-cases and scenarios

How to Connect a Cash Register to Bitrix24

Response Handling

HTTP status: 200

{
            "result": 5,
            "time": {
                "start": 1712132792.910734,
                "finish": 1712132793.530359,
                "duration": 0.6196250915527344,
                "processing": 0.032338857650756836,
                "date_start": "2024-04-03T10:26:32+02:00",
                "date_finish": "2024-04-03T10:26:33+02:00",
                "operating_reset_at": 1705765533,
                "operating": 3.3076241016387939
            }
        }

Returned Data

Name `type`	Description
result `sale_cashbox.ID`	Identifier of the added cash register
time `time`	Information about the request execution time

Error Handling

HTTP status: 400, 403

{
            "error": "ERROR_CHECK_FAILURE",
            "error_description": "Parameter NAME is 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	Status
`ACCESS_DENIED`	Insufficient rights to add a cash register	403
`ERROR_CHECK_FAILURE`	A required field value is not specified or the value of one of the fields is incorrect	400
`ERROR_CASHBOX_ADD`	Other errors. More detailed information about the error can be found in `error_description`	400

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 permitted for calls 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 HTTPS protocol is required for method calls
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is only available on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user associated with the access token or webhook used to call the method lacks the necessary 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 portal administrator has restricted access to this application to specific users only
`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 "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

Delete Cash Register Handler

Update Existing Cash Register

Add Cash Register sale.cashbox.add

Method ParametersMethod Parameters

OFD_SETTINGS ParameterOFD_SETTINGS Parameter

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