метод REST scope: cashbox

sale.cashbox.add

Добавить кассу

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

Описание

Метод sale.cashbox.add добавляет кассу.

Параметры

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

Название кассы

REST_CODE sale_cashbox_handler.CODE обязательный

Код REST-обработчика кассы. Указывается при добавлении обработчика в методе sale.cashbox.handler.add в параметре CODE

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

Адрес электронной почты, на который будут отправляться уведомления в случае возникновения ошибок при печати чеков

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

Код обработчика ОФД. Доступные обработчики ОФД:
- bx_firstofd — Первый ОФД
- bx_platformaofd — Платформа ОФД
- bx_yarusofd — ОФД ЯРУС
- bx_taxcomofd — Такском ОФД
- bx_ofdruofd — OFD.RU
- bx_tenzorofd — Тензор ОФД
- bx_conturofd — Контур ОФД

По умолчанию без ОФД

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

Настройки ОФД (подробное описание приведено ниже).

По умолчанию пустой массив

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

Внешний идентификатор кассы.

По умолчанию пуст

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

Активность кассы. Возможные значения:
- Y — да
- N — нет

Значение по умолчанию: N

SORT integer необязательный

Сортировка. По умолчанию 100

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

Используется ли касса офлайн. Возможные значения:
- Y — да
- N — нет

Значение по умолчанию: N

SETTINGS array необязательный

Настройки кассы в соответствии со структурой настроек, переданной в ключе CONFIG поля SETTINGS метода sale.cashbox.handler.add.

По умолчанию пусты

Параметр OFD_SETTINGS

Настройки для всех ОФД необязательный
OFD_MODE object необязательный

Настройки, относящиеся к режиму работы ОФД. Передается параметр IS_TEST (string со значениями Y/N) — режим работы ОФД:
- Y — тестовый режим
- N — рабочий режим

Дополнительные настройки для OFD.RU необязательный
SELLER_INFO object необязательный

Настройки раздела «Информация о продавце». Передается обязательный параметр INN (string) — ИНН продавца

Дополнительные настройки для ОФД ЯРУС необязательный
AUTH object необязательный

Настройки авторизации. Передается параметр INN (string) — ключ безопасности

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"NAME":"Rest-касса","REST_CODE":"restcashbox01","EMAIL":"user@example.com","NUMBER_KKM":"123","ACTIVE":"Y","SORT":100,"OFD":"bx_ofdruofd","OFD_SETTINGS":{"OFD_MODE":{"IS_TEST":"N"}},"SETTINGS":{"AUTH":{"KEYWORD":"top_secret!","PREFERENCE":"SECOND"},"INTERACTION":{"MODE":"ACTIVE"}}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.cashbox.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.ID

Идентификатор добавленной кассы

time time

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

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

HTTP-статус: 400

{
    "error": "ERROR_CHECK_FAILURE",
    "error_description": "Parameter NAME is not defined"
}
Код Описание Значение
ACCESS_DENIED Недостаточно прав для добавления кассы 403
ERROR_CHECK_FAILURE Не указано значение обязательного поля либо значение одного из полей указано неверно 400
ERROR_CASHBOX_ADD Прочие ошибки. Более подробную информацию об ошибке можно найти в error_description 400

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

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