Save the result of printing the receipt sale.cashbox.check.apply
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, cashboxWho can execute the method: CRM administrator (permission "Allow to change settings")
The method saves the result of printing a receipt that was printed on a REST cash register. The UUID of the receipt is saved when it is printed from the PRINT_URL response specified when adding the handler (see example of implementing a simple cash register on REST API).
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
UUID* |
UUID of the receipt |
|
PRINT_END_TIME |
Time when the receipt printing ended |
|
REG_NUMBER_KKT |
Registration number of the cash register |
|
FISCAL_DOC_ATTR |
Fiscal attribute of the document |
|
FISCAL_DOC_NUMBER |
Fiscal document number |
|
FISCAL_RECEIPT_NUMBER |
Fiscal receipt number |
|
FN_NUMBER |
Fiscal storage number |
|
SHIFT_NUMBER |
Shift number |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"UUID":"check|example.com|1","PRINT_END_TIME":"1609459200","REG_NUMBER_KKT":"1234567891011121","FISCAL_DOC_ATTR":"1234567890","FISCAL_DOC_NUMBER":"12345","FISCAL_RECEIPT_NUMBER":"123","FN_NUMBER":"1234567891011121","SHIFT_NUMBER":"1"}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.cashbox.check.apply
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"UUID":"check|example.com|1","PRINT_END_TIME":"1609459200","REG_NUMBER_KKT":"1234567891011121","FISCAL_DOC_ATTR":"1234567890","FISCAL_DOC_NUMBER":"12345","FISCAL_RECEIPT_NUMBER":"123","FN_NUMBER":"1234567891011121","SHIFT_NUMBER":"1","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.cashbox.check.apply
try
{
const response = await $b24.callMethod(
"sale.cashbox.check.apply",
{
'UUID':'check|example.com|1',
'PRINT_END_TIME':'1609459200',
'REG_NUMBER_KKT':'1234567891011121',
'FISCAL_DOC_ATTR':'1234567890',
'FISCAL_DOC_NUMBER':'12345',
'FISCAL_RECEIPT_NUMBER':'123',
'FN_NUMBER':'1234567891011121',
'SHIFT_NUMBER':'1'
}
);
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.check.apply',
[
'UUID' => 'check|example.com|1',
'PRINT_END_TIME' => '1609459200',
'REG_NUMBER_KKT' => '1234567891011121',
'FISCAL_DOC_ATTR' => '1234567890',
'FISCAL_DOC_NUMBER' => '12345',
'FISCAL_RECEIPT_NUMBER' => '123',
'FN_NUMBER' => '1234567891011121',
'SHIFT_NUMBER' => '1',
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
} else {
echo 'Success: ' . print_r($result->data(), true);
// Your required data processing logic
processData($result->data());
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error applying cash register check: ' . $e->getMessage();
}
BX24.callMethod(
"sale.cashbox.check.apply",
{
'UUID':'check|example.com|1',
'PRINT_END_TIME':'1609459200',
'REG_NUMBER_KKT':'1234567891011121',
'FISCAL_DOC_ATTR':'1234567890',
'FISCAL_DOC_NUMBER':'12345',
'FISCAL_RECEIPT_NUMBER':'123',
'FN_NUMBER':'1234567891011121',
'SHIFT_NUMBER':'1'
},
function(result)
{
if(result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'sale.cashbox.check.apply',
[
'UUID' => 'check|example.com|1',
'PRINT_END_TIME' => '1609459200',
'REG_NUMBER_KKT' => '1234567891011121',
'FISCAL_DOC_ATTR' => '1234567890',
'FISCAL_DOC_NUMBER' => '12345',
'FISCAL_RECEIPT_NUMBER' => '123',
'FN_NUMBER' => '1234567891011121',
'SHIFT_NUMBER' => '1'
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
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 saving the receipt printing |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400, 403
{
"error": "ERROR_CHECK_NOT_FOUND",
"error_description": "Check not found"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
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 |
|
|
Insufficient permissions to save the receipt printing result |
403 |
|
|
The |
400 |
|
|
Receipt with the specified |
400 |
|
|
Other errors. More detailed information about the error can be found in |
400 |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
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 |
|
|
|
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
- 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
- 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
- How to Connect a Cash Register to Bitrix24