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:
cashboxWho can execute the method: CRM administrator (permission "Allow to change settings")
The method sale.cashbox.add adds a cash register.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
NAME* |
Name of the cash register |
|
REST_CODE* |
REST handler code for the cash register. Specified when adding the handler in the method sale.cashbox.handler.add in the |
|
EMAIL* |
Email address to which notifications will be sent in case of errors during receipt printing |
|
OFD |
OFD handler code. Available OFD handlers:
By default, without OFD |
|
OFD_SETTINGS |
OFD settings (detailed description provided below). By default, an empty array |
|
NUMBER_KKM |
External identifier of the cash register. By default, empty |
|
ACTIVE |
Activity status of the cash register. Possible values:
Default value: |
|
SORT |
Sorting. Default |
|
USE_OFFLINE |
Whether the cash register is used offline. Possible values:
Default value: |
|
SETTINGS |
Cash register settings according to the settings structure passed in the By default, empty |
OFD_SETTINGS Parameter
|
Name |
Description |
|
Settings for all OFDs |
|
|
OFD_MODE |
Settings related to the OFD operation mode. The
|
|
Additional settings for OFD.RU |
|
|
SELLER_INFO |
Settings for the "Seller Information" section. The required parameter |
|
Additional settings for YARUS OFD |
|
|
AUTH |
Authorization settings. The |
Code Examples
How to Use Examples in Documentation
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
// 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<number>({
method: 'sale.cashbox.add',
params: {
NAME: 'Rest-cashbox',
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',
},
},
},
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('Added cashbox 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 addCashbox() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'sale.cashbox.add',
params: {
NAME: 'Rest-cashbox',
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',
},
},
},
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('Added cashbox ID:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addCashbox)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
settings = {
"AUTH": {
"KEYWORD": "top_secret!",
"PREFERENCE": "SECOND",
},
"INTERACTION": {
"MODE": "ACTIVE",
},
}
try:
bitrix_response = client.sale.cashbox.add(
name="Rest cash register",
rest_code="restcashbox01",
email="user@example.com",
number_kkm="123",
active=True,
sort=100,
ofd="bx_ofdruofd",
ofd_settings={
"OFD_MODE": {
"IS_TEST": "N",
},
},
settings=settings,
).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(
'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>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "sale.cashbox.add", b24.Params{
"NAME": "Rest-Cash Register",
"REST_CODE": "restcashbox01",
"EMAIL": "user@example.com",
"NUMBER_KKM": "123",
"ACTIVE": "Y",
"SORT": 100,
"OFD": "bx_ofdruofd",
"OFD_SETTINGS": b24.Params{
"OFD_MODE": b24.Params{
"IS_TEST": "N",
},
},
"SETTINGS": b24.Params{
"AUTH": b24.Params{
"KEYWORD": "top_secret!",
"PREFERENCE": "SECOND",
},
"INTERACTION": b24.Params{
"MODE": "ACTIVE",
},
},
})
if err != nil {
return fmt.Errorf("sale.cashbox.add: %w", err)
}
var newID b24.ID
if err := json.Unmarshal(res.Result, &newID); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println("id:", newID)
Typical use-cases and scenarios
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 |
Description |
|
result |
Identifier of the added cash register |
|
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 |
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
|
Code |
Description |
Status |
|
|
Insufficient rights to add a cash register |
403 |
|
|
A required field value is not specified or the value of one of the fields is incorrect |
400 |
|
|
Other errors. More detailed information about the error can be found in |
400 |
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 |
|
|
|
The REST API is available only on commercial plans. 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 |
Continue Learning
- Add Cashbox Handler sale.cashbox.handler.add
- Update Cash Register Handler sale.cashbox.handler.update
- Get a list of available cash register handlers sale.cashbox.handler.list
- Delete Cashbox Handler sale.cashbox.handler.delete
- Update Existing Cash Register sale.cashbox.update
- Get a list of configured cash registers sale.cashbox.list
- Delete cash register sale.cashbox.delete
- Save the result of printing the receipt sale.cashbox.check.apply
- How to Connect a Cash Register to Bitrix24