метод REST scope: cashbox

sale.cashbox.handler.add

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

Кто может выполнять: администратор 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

PRINT_URL string обязательный

Адрес, на который отправляются данные для печати чека

CHECK_URL string обязательный

Адрес, по которому происходит проверка статуса чека

HTTP_VERSION string необязательный

Версия протокола HTTP, используемая для запросов. Возможные значения: 1.0, 1.1.

Если параметр не заполнен, то для запросов используется HTTP 1.0

CONFIG object обязательный

Структура настроек (подробное описание приведено ниже), которые пользователь сможет устанавливать и изменять на странице редактирования кассы, а также при добавлении или обновлении кассы через REST.

Каждый ключ в этом параметре задает один раздел на странице настроек, ключ является кодом раздела. Значения объекта описывают раздел и содержащиеся в нем настройки

Параметр SETTINGS\[CONFIG]

LABEL string обязательный

Заголовок раздела

ITEMS object обязательный

Список настроек раздела (подробное описание приведено ниже).

Ключ является кодом настройки, значение — описанием настройки

Параметр 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

Примеры запроса

-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

Ответ

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_handler.ID

Идентификатор созданного обработчика

time time

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

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

HTTP-статус: 400

{
    "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

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.