Сохранить результат печати чека sale.cashbox.check.apply

Scope: sale, cashbox

Кто может выполнять метод: администратор CRM (право «Разрешить изменять настройки»)

Метод сохраняет результат печати чека, напечатанного на REST-кассе. UUID чека сохраняется при его печати из ответа PRINT_URL, указанного при добавлении обработчика (см. пример реализации простой кассы на REST API).

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

UUID*
string

UUID чека

PRINT_END_TIME
string

Время окончания печати чека

REG_NUMBER_KKT
string

Регистрационный номер ККТ

FISCAL_DOC_ATTR
string

Фискальный признак документа

FISCAL_DOC_NUMBER
string

Номер фискального документа

FISCAL_RECEIPT_NUMBER
string

Фискальный номер чека

FN_NUMBER
string

Номер фискального накопителя

SHIFT_NUMBER
string

Номер смены

Примеры кода

Как использовать примеры в документации

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);
                // Нужная вам логика обработки данных
                processData($result->data());
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error applying cashbox 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>';
        

Обработка ответа

HTTP-статус: 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
            }
        }
        

Возвращаемые данные

Название
тип

Описание

result
boolean

Результат сохранения печати чека

time
time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400, 403

{ 
            "error": "ERROR_CHECK_NOT_FOUND", 
            "error_description": "Check not found" 
        }
        

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код

Описание

Статус

ACCESS_DENIED

Недостаточно прав для сохранения результата печати чека

403

ERROR_CHECK_FAILURE

Не указано значение поля UUID

400

ERROR_CHECK_NOT_FOUND

Не найден чек с указанным UUID

400

ERROR_CHECK_APPLY

Прочие ошибки. Более подробную информацию об ошибке можно найти в error_description

400

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Предыдущая
Следующая