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

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: cashbox

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

Метод sale.cashbox.check.apply сохраняет результат печати чека, напечатанного на REST-кассе. UUID чека сохраняется при его печати из ответа PRINT_URL, указанного при добавлении обработчика. Пример сценария — в туториале Как подключить кассу к Битрикс24.

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

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

Название
тип

Описание

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
// 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.check.apply',
    params: {
      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',
    },
    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('Check apply result:', 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 applyCheck() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'sale.cashbox.check.apply',
        params: {
          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',
        },
        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('Check apply result:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', applyCheck)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.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",
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sale.cashbox.check.apply", b24.Params{
	"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",
})
if err != nil {
	return fmt.Errorf("sale.cashbox.check.apply: %w", err)
}

var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("выполнено:", ok)

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

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
string

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

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

Код

Описание

Статус

ACCESS_DENIED

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

403

ERROR_CHECK_FAILURE

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

400

ERROR_CHECK_NOT_FOUND

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

400

ERROR_CHECK_APPLY

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

400

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

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

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

Описание

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

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

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

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

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

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

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

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

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

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