Обновить данные обработчика кассы sale.cashbox.handler.update

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

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

Scope: sale, cashbox

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

Метод обновляет данные REST-обработчика кассы.

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

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

Название
тип

Описание

ID*
sale_cashbox_handler.ID

Идентификатор обновляемого обработчика

FIELDS*
object

Значения обновляемых полей.

Поля, доступные к обновлению: NAME, SORT, SETTINGS (смотрите поля sale_cashbox_handler)

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"ID":1,"FIELDS":{"NAME":"Моя REST-касса с новым именем","SORT":200,"SETTINGS":{"PRINT_URL":"http://setagaya.bx/receipt_print.php","CHECK_URL":"http://setagaya.bx/receipt_check.php","CONFIG":{"AUTH":{"LABEL":"Авторизация","ITEMS":{"LOGIN":{"TYPE":"STRING","REQUIRED":"Y","LABEL":"Логин"},"PASSWORD":{"TYPE":"STRING","REQUIRED":"Y","LABEL":"Пароль"}}},"COMPANY":{"LABEL":"Данные об организации","ITEMS":{"INN":{"TYPE":"STRING","REQUIRED":"Y","LABEL":"ИНН организации"}}},"INTERACTION":{"LABEL":"Настройки взаимодействия с кассой","ITEMS":{"MODE":{"TYPE":"ENUM","LABEL":"Режим работы с кассой","OPTIONS":{"ACTIVE":"боевой","TEST":"тестовый"}}}}},"SUPPORTS_FFD105":"N"}}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.cashbox.handler.update

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"ID":1,"FIELDS":{"NAME":"Моя REST-касса с новым именем","SORT":200,"SETTINGS":{"PRINT_URL":"http://setagaya.bx/receipt_print.php","CHECK_URL":"http://setagaya.bx/receipt_check.php","CONFIG":{"AUTH":{"LABEL":"Авторизация","ITEMS":{"LOGIN":{"TYPE":"STRING","REQUIRED":"Y","LABEL":"Логин"},"PASSWORD":{"TYPE":"STRING","REQUIRED":"Y","LABEL":"Пароль"}}},"COMPANY":{"LABEL":"Данные об организации","ITEMS":{"INN":{"TYPE":"STRING","REQUIRED":"Y","LABEL":"ИНН организации"}}},"INTERACTION":{"LABEL":"Настройки взаимодействия с кассой","ITEMS":{"MODE":{"TYPE":"ENUM","LABEL":"Режим работы с кассой","OPTIONS":{"ACTIVE":"боевой","TEST":"тестовый"}}}}},"SUPPORTS_FFD105":"N"}},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sale.cashbox.handler.update

// 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.handler.update',
            params: {
              ID: 1,
              FIELDS: {
                NAME: 'My REST cashbox with a new name',
                SORT: 200,
                SETTINGS: {
                  PRINT_URL: 'http://setagaya.bx/receipt_print.php',
                  CHECK_URL: 'http://setagaya.bx/receipt_check.php',
                  CONFIG: {
                    AUTH: {
                      LABEL: 'Authorization',
                      ITEMS: {
                        LOGIN: {
                          TYPE: 'STRING',
                          REQUIRED: 'Y',
                          LABEL: 'Login',
                        },
                        PASSWORD: {
                          TYPE: 'STRING',
                          REQUIRED: 'Y',
                          LABEL: 'Password',
                        },
                      },
                    },
                    COMPANY: {
                      LABEL: 'Organization data',
                      ITEMS: {
                        INN: {
                          TYPE: 'STRING',
                          REQUIRED: 'Y',
                          LABEL: 'Organization INN',
                        },
                      },
                    },
                    INTERACTION: {
                      LABEL: 'Cashbox interaction settings',
                      ITEMS: {
                        MODE: {
                          TYPE: 'ENUM',
                          LABEL: 'Cashbox operating mode',
                          OPTIONS: {
                            ACTIVE: 'production',
                            TEST: 'test',
                          },
                        },
                      },
                    },
                  },
                  SUPPORTS_FFD105: 'N',
                },
              },
            },
            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('Handler updated:', 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 updateCashboxHandler() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'sale.cashbox.handler.update',
                params: {
                  ID: 1,
                  FIELDS: {
                    NAME: 'My REST cashbox with a new name',
                    SORT: 200,
                    SETTINGS: {
                      PRINT_URL: 'http://setagaya.bx/receipt_print.php',
                      CHECK_URL: 'http://setagaya.bx/receipt_check.php',
                      CONFIG: {
                        AUTH: {
                          LABEL: 'Authorization',
                          ITEMS: {
                            LOGIN: {
                              TYPE: 'STRING',
                              REQUIRED: 'Y',
                              LABEL: 'Login',
                            },
                            PASSWORD: {
                              TYPE: 'STRING',
                              REQUIRED: 'Y',
                              LABEL: 'Password',
                            },
                          },
                        },
                        COMPANY: {
                          LABEL: 'Organization data',
                          ITEMS: {
                            INN: {
                              TYPE: 'STRING',
                              REQUIRED: 'Y',
                              LABEL: 'Organization INN',
                            },
                          },
                        },
                        INTERACTION: {
                          LABEL: 'Cashbox interaction settings',
                          ITEMS: {
                            MODE: {
                              TYPE: 'ENUM',
                              LABEL: 'Cashbox operating mode',
                              OPTIONS: {
                                ACTIVE: 'production',
                                TEST: 'test',
                              },
                            },
                          },
                        },
                      },
                      SUPPORTS_FFD105: 'N',
                    },
                  },
                },
                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('Handler updated:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', updateCashboxHandler)
        </script>

try {
            $response = $b24Service
                ->core
                ->call(
                    'sale.cashbox.handler.update',
                    [
                        'ID'     => 1,
                        'FIELDS' => [
                            'NAME'     => 'Моя REST-касса с новым именем',
                            'SORT'     => 200,
                            'SETTINGS' => [
                                'PRINT_URL'      => 'http://setagaya.bx/receipt_print.php',
                                'CHECK_URL'      => 'http://setagaya.bx/receipt_check.php',
                                'CONFIG'         => [
                                    'AUTH'        => [
                                        'LABEL' => 'Авторизация',
                                        'ITEMS' => [
                                            'LOGIN'    => [
                                                'TYPE'     => 'STRING',
                                                'REQUIRED' => 'Y',
                                                'LABEL'    => 'Логин',
                                            ],
                                            'PASSWORD' => [
                                                'TYPE'     => 'STRING',
                                                'REQUIRED' => 'Y',
                                                'LABEL'    => 'Пароль',
                                            ],
                                        ],
                                    ],
                                    'COMPANY'      => [
                                        'LABEL' => 'Данные об организации',
                                        'ITEMS' => [
                                            'INN' => [
                                                'TYPE'     => 'STRING',
                                                'REQUIRED' => 'Y',
                                                'LABEL'    => 'ИНН организации',
                                            ],
                                        ],
                                    ],
                                    'INTERACTION'  => [
                                        'LABEL' => 'Настройки взаимодействия с кассой',
                                        'ITEMS' => [
                                            'MODE' => [
                                                'TYPE'    => 'ENUM',
                                                'LABEL'   => 'Режим работы с кассой',
                                                'OPTIONS' => [
                                                    'ACTIVE' => 'боевой',
                                                    'TEST'   => 'тестовый',
                                                ],
                                            ],
                                        ],
                                    ],
                                ],
                                'SUPPORTS_FFD105' => 'N',
                            ],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Нужная вам логика обработки данных
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating cashbox handler: ' . $e->getMessage();
        }

BX24.callMethod( 
        "sale.cashbox.handler.update", 
        { 
            "ID": 1, 
            "FIELDS": 
            { 
                "NAME": "Моя REST-касса с новым именем",
                "SORT": 200,
                "SETTINGS": {
                    "PRINT_URL": "http://setagaya.bx/receipt_print.php",
                    "CHECK_URL": "http://setagaya.bx/receipt_check.php",
                    "CONFIG": {
                        "AUTH": {
                            "LABEL": "Авторизация",
                            "ITEMS": {
                                "LOGIN": {
                                    "TYPE": "STRING",
                                    "REQUIRED": "Y",
                                    "LABEL": "Логин"
                                },
                                "PASSWORD": {
                                    "TYPE": "STRING",
                                    "REQUIRED": "Y",
                                    "LABEL": "Пароль"
                                }
                            }
                        },
                        "COMPANY": {
                            "LABEL": "Данные об организации",
                            "ITEMS": {
                                "INN": {
                                    "TYPE": "STRING",
                                    "REQUIRED": "Y",
                                    "LABEL": "ИНН организации"
                                }
                            }
                        },
                        "INTERACTION": {
                            "LABEL": "Настройки взаимодействия с кассой",
                            "ITEMS": {
                                "MODE": {
                                    "TYPE": "ENUM",
                                    "LABEL": "Режим работы с кассой",
                                    "OPTIONS": {
                                        "ACTIVE": "боевой",
                                        "TEST": "тестовый"
                                    }
                                }
                            }
                        }
                    },
                    "SUPPORTS_FFD105": "N"
                }
            } 
        }, 
            function(result) 
        { 
            if(result.error()) 
                console.error(result.error()); 
            else 
                console.dir(result.data()); 
        } 
        );

require_once('crest.php');
        
        $result = CRest::call(
            'sale.cashbox.handler.update',
            [
                'ID' => 1,
                'FIELDS' =>
                [
                    'NAME' => 'Моя REST-касса с новым именем',
                    'SORT' => 200,
                    'SETTINGS' =>
                    [
                        'PRINT_URL' => 'http://setagaya.bx/receipt_print.php',
                        'CHECK_URL' => 'http://setagaya.bx/receipt_check.php',
                        'CONFIG' =>
                        [
                            'AUTH' =>
                            [
                                'LABEL' => 'Авторизация',
                                'ITEMS' =>
                                [
                                    'LOGIN' =>
                                    [
                                        'TYPE' => 'STRING',
                                        'REQUIRED' => 'Y',
                                        'LABEL' => 'Логин'
                                    ],
                                    'PASSWORD' =>
                                    [
                                        'TYPE' => 'STRING',
                                        'REQUIRED' => 'Y',
                                        'LABEL' => 'Пароль'
                                    ]
                                ]
                            ],
                            'COMPANY' =>
                            [
                                'LABEL' => 'Данные об организации',
                                'ITEMS' =>
                                [
                                    'INN' =>
                                    [
                                        'TYPE' => 'STRING',
                                        'REQUIRED' => 'Y',
                                        'LABEL' => 'ИНН организации'
                                    ]
                                ]
                            ],
                            'INTERACTION' =>
                            [
                                'LABEL' => 'Настройки взаимодействия с кассой',
                                'ITEMS' =>
                                [
                                    'MODE' =>
                                    [
                                        'TYPE' => 'ENUM',
                                        'LABEL' => 'Режим работы с кассой',
                                        'OPTIONS' =>
                                        [
                                            'ACTIVE' => 'боевой',
                                            'TEST' => 'тестовый'
                                        ]
                                    ]
                                ]
                            ]
                        ],
                        'SUPPORTS_FFD105' => 'N'
                    ]
                ]
            ]
        );
        
        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`	Результат обновления полей REST-обработчика кассы
time `time`	Информация о времени выполнения запроса

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

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

{
            "error": "ERROR_HANDLER_NOT_FOUND",
            "error_description": "Handler not found"
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код	Описание	Статус
`ACCESS_DENIED`	Недостаточно прав для обновления обработчика либо приложение пытается изменить обработчик, добавленный другим приложением	403
`ERROR_CHECK_FAILURE`	Не указано значение полей `ID` или `FIELDS`	400
`ERROR_HANDLER_NOT_FOUND`	Обработчик с указанным `ID` не найден	400
`ERROR_HANDLER_UPDATE`	Прочие ошибки. Более подробную информацию об ошибке можно найти в `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	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Добавить обработчик кассы

Получить список доступных обработчиков касс

Обновить данные обработчика кассы sale.cashbox.handler.update

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

Примеры кодаПримеры кода

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

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

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

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

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

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