Добавить кассу sale.cashbox.add

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

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

Scope: sale, cashbox

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

Метод добавляет кассу.

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

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

Название
тип

Описание

NAME*
string

Название кассы

REST_CODE*
sale_cashbox_handler.CODE

Код REST-обработчика кассы. Указывается при добавлении обработчика в методе sale.cashbox.handler.add в параметре CODE

EMAIL*
string

Адрес электронной почты, на который будут отправляться уведомления в случае возникновения ошибок при печати чеков

OFD
string

Код обработчика ОФД. Доступные обработчики ОФД:

  • bx_firstofd — Первый ОФД
  • bx_platformaofd — Платформа ОФД
  • bx_yarusofd — ОФД ЯРУС
  • bx_taxcomofd — Такском ОФД
  • bx_ofdruofd — OFD.RU
  • bx_tenzorofd — Тензор ОФД
  • bx_conturofd — Контур ОФД

По умолчанию без ОФД

OFD_SETTINGS
object

Настройки ОФД (подробное описание приведено ниже).

По умолчанию пустой массив

NUMBER_KKM
string

Внешний идентификатор кассы.

По умолчанию пуст

ACTIVE
string

Активность кассы. Возможные значения:

  • Y — да
  • N — нет

Значение по умолчанию: N

SORT
integer

Сортировка. По умолчанию 100

USE_OFFLINE
string

Используется ли касса офлайн. Возможные значения:

  • Y — да
  • N — нет

Значение по умолчанию: N

SETTINGS
array

Настройки кассы в соответствии со структурой настроек, переданной в ключе CONFIG поля SETTINGS метода sale.cashbox.handler.add.

По умолчанию пусты

Параметр OFD_SETTINGS

Название
тип

Описание

Настройки для всех ОФД

OFD_MODE
object

Настройки, относящиеся к режиму работы ОФД. Передается параметр IS_TEST (string со значениями Y/N) — режим работы ОФД:

  • Y — тестовый режим
  • N — рабочий режим

Дополнительные настройки для OFD.RU

SELLER_INFO
object

Настройки раздела «Информация о продавце». Передается обязательный параметр INN (string) — ИНН продавца

Дополнительные настройки для ОФД ЯРУС

AUTH
object

Настройки авторизации. Передается параметр INN (string) — ключ безопасности

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"NAME":"Rest-касса","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-касса","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>
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'sale.cashbox.add',
                    [
                        'NAME'       => 'Rest-касса',
                        '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);
            // Нужная вам логика обработки данных
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding cashbox: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "sale.cashbox.add",
            {
                "NAME": 'Rest-касса',
                "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-касса',
                '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>';
        

Частые кейсы и сценарии

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

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

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

Название
тип

Описание

result
sale_cashbox.ID

Идентификатор добавленной кассы

time
time

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

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

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

{
            "error": "ERROR_CHECK_FAILURE",
            "error_description": "Parameter NAME is not defined"
        }
        

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

Статус

ACCESS_DENIED

Недостаточно прав для добавления кассы

403

ERROR_CHECK_FAILURE

Не указано значение обязательного поля либо значение одного из полей указано неверно

400

ERROR_CASHBOX_ADD

Прочие ошибки. Более подробную информацию об ошибке можно найти в 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

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

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

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

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

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

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