метод REST scope: cashbox

sale.cashbox.update

Обновить существующую кассу

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

Описание

Метод sale.cashbox.update обновляет существующую кассу.

Параметры

ID sale_cashbox.ID обязательный

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

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

Значения обновляемых полей (подробное описание приведено ниже)

Параметр FIELDS

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

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

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 — нет

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

Сортировка

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

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

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

Настройки кассы в соответствии со структурой настроек, переданной в ключе 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 '{"ID":1,"FIELDS":{"NAME":"Новое имя"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.cashbox.update

Ответ

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

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

time time

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

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

HTTP-статус: 400

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

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

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