Документация для разработчиков
Темная тема

sale.cashbox.handler.add

Scope: sale, cashbox Права на выполнение: для всех

Описание и пример

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

Пример

BX24.callMethod(
	"sale.cashbox.handler.add",
	{
		"CODE": "restcashbox01",
		"NAME": "REST-касса 01",
		"SORT": 100,
		"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());
	}
);

Параметры

Параметр Описание С версии
CODE Обязательный. Код REST-обработчика. Должен быть уникальным среди всех обработчиков.
NAME Обязательный. Название REST-обработчика.
SORT Сортировка (по умолчанию 100).
SUPPORTS_FFD105 Поддерживает ли касса формат фискальных данных версии 1.05 (по умолчанию N).
SETTINGS Обязательный. Настройки обработчика (все параметры обязательные):
  • PRINT_URL - адрес, на который отправляются данные для печати чека;
  • CHECK_URL - адрес, по которому происходит проверка статуса чека;
  • HTTP_VERSION - версия протокола HTTP, используемая для запросов. Возможные значения: 1.0, 1.1. Если параметр не заполнен, то для запросов используется HTTP 1.0. Параметр доступен с версии sale 22.0.100;
  • CONFIG - структура настроек, которые пользователь сможет устанавливать и изменять на странице редактирования кассы. Каждый ключ в этом параметре задаёт один раздел на странице настроек:
    • LABEL - заголовок раздела;
    • ITEMS - список настроек раздела:
      • TYPE - тип настройки;
      • LABEL - название настройки;
      • REQUIRED - является ли настройка обязательной.



© «Битрикс», 2001-2024, «1С-Битрикс», 2024