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

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

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

Scope: cashbox

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

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

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

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

Название
тип

Описание

ID*
sale_cashbox_handler.ID

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

FIELDS*
object

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

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

Примеры кода

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

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>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

fields = {
    "NAME": "Моя REST-касса с новым именем",
    "SORT": 200,
    "ACTIVE": "боевой",
}

try:
    bitrix_response = client.sale.cashbox.handler.update(
        bitrix_id=1,
        fields=fields,
    ).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.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>';

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sale.cashbox.handler.update", b24.Params{
	"ID": 1,
	"FIELDS": b24.Params{
		"NAME": "Моя REST-касса с новым именем",
		"SORT": 200,
		"SETTINGS": b24.Params{
			"PRINT_URL": "http://setagaya.bx/receipt_print.php",
			"CHECK_URL": "http://setagaya.bx/receipt_check.php",
			"CONFIG": b24.Params{
				"AUTH": b24.Params{
					"LABEL": "Авторизация",
					"ITEMS": b24.Params{
						"LOGIN": b24.Params{
							"TYPE":     "STRING",
							"REQUIRED": "Y",
							"LABEL":    "Логин",
						},
						"PASSWORD": b24.Params{
							"TYPE":     "STRING",
							"REQUIRED": "Y",
							"LABEL":    "Пароль",
						},
					},
				},
				"COMPANY": b24.Params{
					"LABEL": "Данные об организации",
					"ITEMS": b24.Params{
						"INN": b24.Params{
							"TYPE":     "STRING",
							"REQUIRED": "Y",
							"LABEL":    "ИНН организации",
						},
					},
				},
				"INTERACTION": b24.Params{
					"LABEL": "Настройки взаимодействия с кассой",
					"ITEMS": b24.Params{
						"MODE": b24.Params{
							"TYPE":  "ENUM",
							"LABEL": "Режим работы с кассой",
							"OPTIONS": b24.Params{
								"ACTIVE": "боевой",
								"TEST":   "тестовый",
							},
						},
					},
				},
			},
			"SUPPORTS_FFD105": "N",
		},
	},
})
if err != nil {
	return fmt.Errorf("sale.cashbox.handler.update: %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

Результат обновления полей REST-обработчика кассы

time
time

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

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

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

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

Название
тип

Описание

error
string

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

error_description
string

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

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

Код

Описание

Статус

ACCESS_DENIED

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

403

ERROR_CHECK_FAILURE

Не указано значение полей ID или FIELDS

400

ERROR_HANDLER_NOT_FOUND

Обработчик с указанным ID не найден

400

ERROR_HANDLER_UPDATE

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

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

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

Предыдущая
Добавить обработчик кассы
Следующая
Получить список доступных обработчиков касс