# sale.cashbox.handler.add URL: https://chugunov.pro/api-bitrix24/sale/cashbox/sale-cashbox-handler-add/ Проверено на Битрикс24 REST API, обновлено 11.09.2026 (ревизия источника fb39d6c). Источник: официальная документация Битрикс24 (bitrix-tools/b24-rest-docs, лицензия MIT, © Bitrix). Справочник независимый, официальной документацией не является. Добавить обработчик кассы Scope: `cashbox` Кто может выполнять метод: администратор CRM (право «Разрешить изменять настройки») ## Описание Метод `sale.cashbox.handler.add` добавляет REST-обработчик кассы. ## Параметры - `CODE` `string` — обязательный. Код REST-обработчика. Должен быть уникальным среди всех обработчиков - `NAME` `string` — обязательный. Название REST-обработчика - `SORT` `integer` — необязательный. Сортировка. Значение по умолчанию: `100` - `SUPPORTS_FFD105` `string` — необязательный. Поддерживает ли касса формат фискальных данных версии 1.05. Возможные значения: - `Y` — да - `N` — нет Значение по умолчанию: `N` - `SETTINGS` `object` — обязательный. Настройки обработчика (подробное описание приведено [ниже](#settings)) ### Параметр SETTINGS - `PRINT_URL` `string` — обязательный. Адрес, на который отправляются данные для печати чека - `CHECK_URL` `string` — обязательный. Адрес, по которому происходит проверка статуса чека - `HTTP_VERSION` `string` — необязательный. Версия протокола HTTP, используемая для запросов. Возможные значения: `1.0`, `1.1`. Если параметр не заполнен, то для запросов используется HTTP `1.0` - `CONFIG` `object` — обязательный. Структура настроек (подробное описание приведено [ниже](#settingsconfig)), которые пользователь сможет устанавливать и изменять на странице редактирования кассы, а также при добавлении или обновлении кассы через REST. Каждый ключ в этом параметре задает один раздел на странице настроек, ключ является кодом раздела. Значения объекта описывают раздел и содержащиеся в нем настройки ### Параметр SETTINGS\[CONFIG] - `LABEL` `string` — обязательный. Заголовок раздела - `ITEMS` `object` — обязательный. Список настроек раздела (подробное описание приведено [ниже](#settingsconfigitems)). Ключ является кодом настройки, значение — описанием настройки ### Параметр SETTINGS\[CONFIG]\[код раздела]\[ITEMS] - `TYPE` `string` — обязательный. Тип настройки. Возможные значения: - `STRING` — строка - `NUMBER` — число с плавающей точкой - `Y/N` — строка, принимающая значения `Y` или `N` - `ENUM` — список строковых значений - `DATE` — дата - `LABEL` `string` — обязательный. Название настройки - `REQUIRED` `string` — обязательный. Является ли настройка обязательной. Возможные значения: - `Y` — да - `N` — нет - `DISABLED` `string` — необязательный. Отключена ли возможность редактирования настройки. Возможные значения: - `Y` — да - `N` — нет Значение по умолчанию: `N` - `MULTIPLE` `string` — необязательный. Является ли настройка множественной. Возможные значения: - `Y` — да - `N` — нет Значение по умолчанию: `N` - `MULTILINE` `string` — необязательный. Является ли поле многострочным. Используется для типа `STRING`. Возможные значения: - `Y` — да - `N` — нет Значение по умолчанию: `N` - `OPTIONS` `object` — обязательный. Список возможных значений свойства. Используется для типа `ENUM`. Ключ объекта — значение свойства, значение ключа — название значения, отображаемое в интерфейсе - `TIME` `string` — необязательный. Есть ли возможность выбрать время. Используется для типа `DATE`. Возможные значения: - `Y` — да - `N` — нет Значение по умолчанию: `N` ## Ответ HTTP-статус: 200 ```json { "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_handler.ID`. Идентификатор созданного обработчика - `time` `time`. Информация о времени выполнения запроса ## Ошибки HTTP-статус: 400 ```json { "error": "ERROR_HANDLER_ALREADY_EXIST", "error_description": "Handler already exists!" } ``` - `ACCESS_DENIED` — Недостаточно прав для добавления обработчика. 403 - `ERROR_CHECK_FAILURE` — Не указано значение обязательного поля либо значение одного из полей указано неверно. 400 - `ERROR_HANDLER_ALREADY_EXIST` — Обработчик с кодом, указанным в параметре `CODE`, уже существует в системе. 400 - `ERROR_HANDLER_ADD` — Прочие ошибки. Более подробную информацию об ошибке можно найти в `error_description`. 400 ## Примеры запроса ### cURL (Webhook) ```bash -X POST \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -d '{"CODE":"restcashbox01","NAME":"REST-касса 01","SORT":100,"SUPPORTS_FFD105":"Y","SETTINGS":{"PRINT_URL":"http://example.com/rest_print.php","CHECK_URL":"http://example.com/rest_check.php","HTTP_VERSION":"1.1","CONFIG":{"AUTH":{"LABEL":"Авторизация","ITEMS":{"KEYWORD":{"TYPE":"STRING","LABEL":"Кодовое слово"},"PREFERENCE":{"TYPE":"ENUM","LABEL":"Множественный выбор","REQUIRED":"Y","OPTIONS":{"FIRST":"Первый","SECOND":"Второй","THIRD":"Третий"}}}},"INTERACTION":{"LABEL":"Настройки взаимодействия с кассой","ITEMS":{"MODE":{"TYPE":"ENUM","LABEL":"Режим работы с кассой","OPTIONS":{"ACTIVE":"боевой","TEST":"тестовый"}}}}}}}' \ https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.cashbox.handler.add ``` ### cURL (OAuth) ```bash -X POST \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -d '{"CODE":"restcashbox01","NAME":"REST-касса 01","SORT":100,"SUPPORTS_FFD105":"Y","SETTINGS":{"PRINT_URL":"http://example.com/rest_print.php","CHECK_URL":"http://example.com/rest_check.php","HTTP_VERSION":"1.1","CONFIG":{"AUTH":{"LABEL":"Авторизация","ITEMS":{"KEYWORD":{"TYPE":"STRING","LABEL":"Кодовое слово"},"PREFERENCE":{"TYPE":"ENUM","LABEL":"Множественный выбор","REQUIRED":"Y","OPTIONS":{"FIRST":"Первый","SECOND":"Второй","THIRD":"Третий"}}}},"INTERACTION":{"LABEL":"Настройки взаимодействия с кассой","ITEMS":{"MODE":{"TYPE":"ENUM","LABEL":"Режим работы с кассой","OPTIONS":{"ACTIVE":"боевой","TEST":"тестовый"}}}}}},"auth":"**put_access_token_here**"}' \ https://**put_your_bitrix24_address**/rest/sale.cashbox.handler.add ``` ### JS (TS) ```ts // 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({ method: 'sale.cashbox.handler.add', params: { CODE: 'restcashbox01', NAME: 'REST cashbox 01', SORT: 100, SUPPORTS_FFD105: 'Y', SETTINGS: { PRINT_URL: 'http://example.com/rest_print.php', CHECK_URL: 'http://example.com/rest_check.php', HTTP_VERSION: '1.1', CONFIG: { AUTH: { LABEL: 'Authorization', ITEMS: { KEYWORD: { TYPE: 'STRING', LABEL: 'Keyword', }, PREFERENCE: { TYPE: 'ENUM', LABEL: 'Multiple choice', REQUIRED: 'Y', OPTIONS: { FIRST: 'First', SECOND: 'Second', THIRD: 'Third', }, }, }, }, INTERACTION: { LABEL: 'Cash register interaction settings', ITEMS: { MODE: { TYPE: 'ENUM', LABEL: 'Cash register operating mode', OPTIONS: { ACTIVE: 'active', TEST: 'test', }, }, }, }, }, }, }, 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('New cashbox handler ID:', result) } } catch (error) { // Thrown on transport or SDK failures (AjaxError, SdkError, etc.) console.error(error) } ``` ### JS (UMD) ```html ``` ### Python ```python from b24pysdk.errors import BitrixAPIError, BitrixSDKException settings = { "PRINT_URL": "http://example.com/rest_print.php", "CHECK_URL": "http://example.com/rest_check.php", "HTTP_VERSION": "1.1", "CONFIG": { "AUTH": { "LABEL": "Авторизация", "ITEMS": { "KEYWORD": { "TYPE": "STRING", "LABEL": "Кодовое слово", }, "PREFERENCE": { "TYPE": "ENUM", "LABEL": "Множественный выбор", "REQUIRED": "Y", "OPTIONS": { "FIRST": "Первый", "SECOND": "Второй", "THIRD": "Третий", }, }, }, }, "INTERACTION": { "LABEL": "Настройки взаимодействия с кассой", "ITEMS": { "MODE": { "TYPE": "ENUM", "LABEL": "Режим работы с кассой", "OPTIONS": { "ACTIVE": "боевой", "TEST": "тестовый", }, }, }, }, }, } try: bitrix_response = client.sale.cashbox.handler.add( code="restcashbox01", name="REST-касса 01", sort=100, supports_ffd105=True, settings=settings, ).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}") ``` ### PHP ```php try { $response = $b24Service ->core ->call( 'sale.cashbox.handler.add', [ 'CODE' => 'restcashbox01', 'NAME' => 'REST-касса 01', 'SORT' => 100, 'SUPPORTS_FFD105' => 'Y', 'SETTINGS' => [ 'PRINT_URL' => 'http://example.com/rest_print.php', 'CHECK_URL' => 'http://example.com/rest_check.php', 'HTTP_VERSION' => '1.1', 'CONFIG' => [ 'AUTH' => [ 'LABEL' => 'Авторизация', 'ITEMS' => [ 'KEYWORD' => [ 'TYPE' => 'STRING', 'LABEL' => 'Кодовое слово', ], 'PREFERENCE' => [ 'TYPE' => 'ENUM', 'LABEL' => 'Множественный выбор', 'REQUIRED' => 'Y', 'OPTIONS' => [ 'FIRST' => 'Первый', 'SECOND' => 'Второй', 'THIRD' => 'Третий', ], ], ], ], 'INTERACTION' => [ 'LABEL' => 'Настройки взаимодействия с кассой', 'ITEMS' => [ 'MODE' => [ 'TYPE' => 'ENUM', 'LABEL' => 'Режим работы с кассой', 'OPTIONS' => [ 'ACTIVE' => 'боевой', 'TEST' => 'тестовый', ], ], ], ], ], ], ] ); $result = $response ->getResponseData() ->getResult(); echo 'Success: ' . print_r($result, true); console.dir($result); } catch (Throwable $e) { error_log($e->getMessage()); echo 'Error adding cashbox handler: ' . $e->getMessage(); } ``` ### BX24.js ```js BX24.callMethod( "sale.cashbox.handler.add", { "CODE": "restcashbox01", "NAME": "REST-касса 01", "SORT": 100, "SUPPORTS_FFD105": "Y", "SETTINGS": { "PRINT_URL": "http://example.com/rest_print.php", "CHECK_URL": "http://example.com/rest_check.php", "HTTP_VERSION": "1.1", "CONFIG": { "AUTH": { "LABEL": "Авторизация", "ITEMS": { "KEYWORD": { "TYPE": "STRING", "LABEL": "Кодовое слово" }, "PREFERENCE": { "TYPE": "ENUM", "LABEL": "Множественный выбор", "REQUIRED": "Y", "OPTIONS": { "FIRST": "Первый", "SECOND": "Второй", "THIRD": "Третий", } } } }, "INTERACTION": { "LABEL": "Настройки взаимодействия с кассой", "ITEMS": { "MODE": { "TYPE": "ENUM", "LABEL": "Режим работы с кассой", "OPTIONS": { "ACTIVE": "боевой", "TEST": "тестовый" } } } } } } }, function(result) { if(result.error()) console.error(result.error()); else console.dir(result.data()); } ); ``` ### PHP CRest ```php require_once('crest.php'); $result = CRest::call( 'sale.cashbox.handler.add', [ 'CODE' => 'restcashbox01', 'NAME' => 'REST-касса 01', 'SORT' => 100, 'SUPPORTS_FFD105' => 'Y', 'SETTINGS' => [ 'PRINT_URL' => 'http://example.com/rest_print.php', 'CHECK_URL' => 'http://example.com/rest_check.php', 'HTTP_VERSION' => '1.1', 'CONFIG' => [ 'AUTH' => [ 'LABEL' => 'Авторизация', 'ITEMS' => [ 'KEYWORD' => [ 'TYPE' => 'STRING', 'LABEL' => 'Кодовое слово' ], 'PREFERENCE' => [ 'TYPE' => 'ENUM', 'LABEL' => 'Множественный выбор', 'REQUIRED' => 'Y', 'OPTIONS' => [ 'FIRST' => 'Первый', 'SECOND' => 'Второй', 'THIRD' => 'Третий', ] ] ] ], 'INTERACTION' => [ 'LABEL' => 'Настройки взаимодействия с кассой', 'ITEMS' => [ 'MODE' => [ 'TYPE' => 'ENUM', 'LABEL' => 'Режим работы с кассой', 'OPTIONS' => [ 'ACTIVE' => 'боевой', 'TEST' => 'тестовый' ] ] ] ] ] ] ] ); echo '
';
print_r($result);
echo '
'; ``` ### Go ```go // client и ctx уже созданы — см. раздел «SDK для Go» res, err := client.Core().Call(ctx, "sale.cashbox.handler.add", b24.Params{ "CODE": "restcashbox01", "NAME": "REST-касса 01", "SORT": 100, "SUPPORTS_FFD105": "Y", "SETTINGS": b24.Params{ "PRINT_URL": "http://example.com/rest_print.php", "CHECK_URL": "http://example.com/rest_check.php", "HTTP_VERSION": "1.1", "CONFIG": b24.Params{ "AUTH": b24.Params{ "LABEL": "Авторизация", "ITEMS": b24.Params{ "KEYWORD": b24.Params{ "TYPE": "STRING", "LABEL": "Кодовое слово", }, "PREFERENCE": b24.Params{ "TYPE": "ENUM", "LABEL": "Множественный выбор", "REQUIRED": "Y", "OPTIONS": b24.Params{ "FIRST": "Первый", "SECOND": "Второй", "THIRD": "Третий", }, }, }, }, "INTERACTION": b24.Params{ "LABEL": "Настройки взаимодействия с кассой", "ITEMS": b24.Params{ "MODE": b24.Params{ "TYPE": "ENUM", "LABEL": "Режим работы с кассой", "OPTIONS": b24.Params{ "ACTIVE": "боевой", "TEST": "тестовый", }, }, }, }, }, }, }) if err != nil { return fmt.Errorf("sale.cashbox.handler.add: %w", err) } var newID b24.ID if err := json.Unmarshal(res.Result, &newID); err != nil { return fmt.Errorf("разбор ответа: %w", err) } fmt.Println("идентификатор:", newID) ``` Оригинал в официальной документации: https://apidocs.bitrix24.ru/api-reference/sale/cashbox/sale-cashbox-handler-add.html