Update Cash Register Handler sale.cashbox.handler.update
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.handler.update updates the data of the REST cash register handler.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
ID* |
Identifier of the handler being updated |
|
FIELDS* |
Values of the fields to be updated. Fields available for update: |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ID":1,"FIELDS":{"NAME":"My REST cash register with a new name","SORT":200,"SETTINGS":{"PRINT_URL":"http://setagaya.bx/receipt_print.php","CHECK_URL":"http://setagaya.bx/receipt_check.php","CONFIG":{"AUTH":{"LABEL":"Authorization","ITEMS":{"LOGIN":{"TYPE":"STRING","REQUIRED":"Y","LABEL":"Login"},"PASSWORD":{"TYPE":"STRING","REQUIRED":"Y","LABEL":"Password"}}},"COMPANY":{"LABEL":"Company Information","ITEMS":{"INN":{"TYPE":"STRING","REQUIRED":"Y","LABEL":"Company INN"}}},"INTERACTION":{"LABEL":"Cash Register Interaction Settings","ITEMS":{"MODE":{"TYPE":"ENUM","LABEL":"Cash Register Operation Mode","OPTIONS":{"ACTIVE":"live","TEST":"test"}}}}},"SUPPORTS_FFD105":"N"}}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.cashbox.handler.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ID":1,"FIELDS":{"NAME":"My REST cash register with a new name","SORT":200,"SETTINGS":{"PRINT_URL":"http://setagaya.bx/receipt_print.php","CHECK_URL":"http://setagaya.bx/receipt_check.php","CONFIG":{"AUTH":{"LABEL":"Authorization","ITEMS":{"LOGIN":{"TYPE":"STRING","REQUIRED":"Y","LABEL":"Login"},"PASSWORD":{"TYPE":"STRING","REQUIRED":"Y","LABEL":"Password"}}},"COMPANY":{"LABEL":"Company Information","ITEMS":{"INN":{"TYPE":"STRING","REQUIRED":"Y","LABEL":"Company INN"}}},"INTERACTION":{"LABEL":"Cash Register Interaction Settings","ITEMS":{"MODE":{"TYPE":"ENUM","LABEL":"Cash Register Operation Mode","OPTIONS":{"ACTIVE":"live","TEST":"test"}}}}},"SUPPORTS_FFD105":"N"}},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.cashbox.handler.update
// 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<boolean>({
method: 'sale.cashbox.handler.update',
params: {
ID: 1,
FIELDS: {
NAME: 'My REST cashbox with a new name',
SORT: 200,
SETTINGS: {
PRINT_URL: 'http://setagaya.bx/receipt_print.php',
CHECK_URL: 'http://setagaya.bx/receipt_check.php',
CONFIG: {
AUTH: {
LABEL: 'Authorization',
ITEMS: {
LOGIN: {
TYPE: 'STRING',
REQUIRED: 'Y',
LABEL: 'Login',
},
PASSWORD: {
TYPE: 'STRING',
REQUIRED: 'Y',
LABEL: 'Password',
},
},
},
COMPANY: {
LABEL: 'Organization data',
ITEMS: {
INN: {
TYPE: 'STRING',
REQUIRED: 'Y',
LABEL: 'Organization INN',
},
},
},
INTERACTION: {
LABEL: 'Cashbox interaction settings',
ITEMS: {
MODE: {
TYPE: 'ENUM',
LABEL: 'Cashbox operating mode',
OPTIONS: {
ACTIVE: 'production',
TEST: 'test',
},
},
},
},
},
SUPPORTS_FFD105: 'N',
},
},
},
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('Handler updated:', 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 updateCashboxHandler() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'sale.cashbox.handler.update',
params: {
ID: 1,
FIELDS: {
NAME: 'My REST cashbox with a new name',
SORT: 200,
SETTINGS: {
PRINT_URL: 'http://setagaya.bx/receipt_print.php',
CHECK_URL: 'http://setagaya.bx/receipt_check.php',
CONFIG: {
AUTH: {
LABEL: 'Authorization',
ITEMS: {
LOGIN: {
TYPE: 'STRING',
REQUIRED: 'Y',
LABEL: 'Login',
},
PASSWORD: {
TYPE: 'STRING',
REQUIRED: 'Y',
LABEL: 'Password',
},
},
},
COMPANY: {
LABEL: 'Organization data',
ITEMS: {
INN: {
TYPE: 'STRING',
REQUIRED: 'Y',
LABEL: 'Organization INN',
},
},
},
INTERACTION: {
LABEL: 'Cashbox interaction settings',
ITEMS: {
MODE: {
TYPE: 'ENUM',
LABEL: 'Cashbox operating mode',
OPTIONS: {
ACTIVE: 'production',
TEST: 'test',
},
},
},
},
},
SUPPORTS_FFD105: 'N',
},
},
},
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('Handler updated:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', updateCashboxHandler)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
fields = {
"NAME": "My REST cash register with a new name",
"SORT": 200,
"ACTIVE": "production",
}
try:
bitrix_response = client.sale.cashbox.handler.update(
bitrix_id=1,
fields=fields,
).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.handler.update',
[
'ID' => 1,
'FIELDS' => [
'NAME' => 'My REST cash register with a new name',
'SORT' => 200,
'SETTINGS' => [
'PRINT_URL' => 'http://setagaya.bx/receipt_print.php',
'CHECK_URL' => 'http://setagaya.bx/receipt_check.php',
'CONFIG' => [
'AUTH' => [
'LABEL' => 'Authorization',
'ITEMS' => [
'LOGIN' => [
'TYPE' => 'STRING',
'REQUIRED' => 'Y',
'LABEL' => 'Login',
],
'PASSWORD' => [
'TYPE' => 'STRING',
'REQUIRED' => 'Y',
'LABEL' => 'Password',
],
],
],
'COMPANY' => [
'LABEL' => 'Company Information',
'ITEMS' => [
'INN' => [
'TYPE' => 'STRING',
'REQUIRED' => 'Y',
'LABEL' => 'Company INN',
],
],
],
'INTERACTION' => [
'LABEL' => 'Cash Register Interaction Settings',
'ITEMS' => [
'MODE' => [
'TYPE' => 'ENUM',
'LABEL' => 'Cash Register Operation Mode',
'OPTIONS' => [
'ACTIVE' => 'live',
'TEST' => 'test',
],
],
],
],
],
'SUPPORTS_FFD105' => 'N',
],
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Your logic for processing data
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error updating cash register handler: ' . $e->getMessage();
}
BX24.callMethod(
"sale.cashbox.handler.update",
{
"ID": 1,
"FIELDS":
{
"NAME": "My REST cash register with a new name",
"SORT": 200,
"SETTINGS": {
"PRINT_URL": "http://setagaya.bx/receipt_print.php",
"CHECK_URL": "http://setagaya.bx/receipt_check.php",
"CONFIG": {
"AUTH": {
"LABEL": "Authorization",
"ITEMS": {
"LOGIN": {
"TYPE": "STRING",
"REQUIRED": "Y",
"LABEL": "Login"
},
"PASSWORD": {
"TYPE": "STRING",
"REQUIRED": "Y",
"LABEL": "Password"
}
}
},
"COMPANY": {
"LABEL": "Company Information",
"ITEMS": {
"INN": {
"TYPE": "STRING",
"REQUIRED": "Y",
"LABEL": "Company INN"
}
}
},
"INTERACTION": {
"LABEL": "Cash Register Interaction Settings",
"ITEMS": {
"MODE": {
"TYPE": "ENUM",
"LABEL": "Cash Register Operation Mode",
"OPTIONS": {
"ACTIVE": "live",
"TEST": "test"
}
}
}
}
},
"SUPPORTS_FFD105": "N"
}
}
},
function(result)
{
if(result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'sale.cashbox.handler.update',
[
'ID' => 1,
'FIELDS' =>
[
'NAME' => 'My REST cash register with a new name',
'SORT' => 200,
'SETTINGS' =>
[
'PRINT_URL' => 'http://setagaya.bx/receipt_print.php',
'CHECK_URL' => 'http://setagaya.bx/receipt_check.php',
'CONFIG' =>
[
'AUTH' =>
[
'LABEL' => 'Authorization',
'ITEMS' =>
[
'LOGIN' =>
[
'TYPE' => 'STRING',
'REQUIRED' => 'Y',
'LABEL' => 'Login'
],
'PASSWORD' =>
[
'TYPE' => 'STRING',
'REQUIRED' => 'Y',
'LABEL' => 'Password'
]
]
},
'COMPANY' =>
[
'LABEL' => 'Company Information',
'ITEMS' =>
[
'INN' =>
[
'TYPE' => 'STRING',
'REQUIRED' => 'Y',
'LABEL' => 'Company INN'
]
]
},
'INTERACTION' =>
[
'LABEL' => 'Cash Register Interaction Settings',
'ITEMS' =>
[
'MODE' =>
[
'TYPE' => 'ENUM',
'LABEL' => 'Cash Register Operation Mode',
'OPTIONS' =>
[
'ACTIVE' => 'live',
'TEST' => 'test'
]
]
]
]
},
'SUPPORTS_FFD105' => 'N'
]
]
]
);
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.handler.update", b24.Params{
"ID": 1,
"FIELDS": b24.Params{
"NAME": "My REST cash register with a new name",
"SORT": 200,
"SETTINGS": b24.Params{
"PRINT_URL": "http://setagaya.bx/receipt_print.php",
"CHECK_URL": "http://setagaya.bx/receipt_check.php",
"CONFIG": b24.Params{
"AUTH": b24.Params{
"LABEL": "Authorization",
"ITEMS": b24.Params{
"LOGIN": b24.Params{
"TYPE": "STRING",
"REQUIRED": "Y",
"LABEL": "Login",
},
"PASSWORD": b24.Params{
"TYPE": "STRING",
"REQUIRED": "Y",
"LABEL": "Password",
},
},
},
"COMPANY": b24.Params{
"LABEL": "Company Information",
"ITEMS": b24.Params{
"INN": b24.Params{
"TYPE": "STRING",
"REQUIRED": "Y",
"LABEL": "Company INN",
},
},
},
"INTERACTION": b24.Params{
"LABEL": "Cash Register Interaction Settings",
"ITEMS": b24.Params{
"MODE": b24.Params{
"TYPE": "ENUM",
"LABEL": "Cash Register Operation Mode",
"OPTIONS": b24.Params{
"ACTIVE": "live",
"TEST": "test",
},
},
},
},
},
"SUPPORTS_FFD105": "N",
},
},
})
if err != nil {
return fmt.Errorf("sale.cashbox.handler.update: %w", err)
}
var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println("done:", ok)
Response Handling
HTTP Status: 200
{
"result": true,
"time": {
"start": 1712135335.026931,
"finish": 1712135335.407762,
"duration": 0.3808310031890869,
"processing": 0.0336611270904541,
"date_start": "2024-04-03T11:08:55+02:00",
"date_finish": "2024-04-03T11:08:55+02:00",
"operating_reset_at": 1705765533,
"operating": 3.3076241016387939
}
}
Returned Data
|
Name |
Description |
|
result |
Result of updating the REST cash register handler |
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 400, 403
{
"error": "ERROR_HANDLER_NOT_FOUND",
"error_description": "Handler not found"
}
|
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 permissions to update the handler or the application is trying to modify a handler added by another application |
403 |
|
|
The values for fields |
400 |
|
|
Handler with the specified |
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
- Get a list of available cash register handlers sale.cashbox.handler.list
- Delete Cashbox Handler sale.cashbox.handler.delete
- Add Cash Register sale.cashbox.add
- 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