UndoBill

Назначение	Отмена пречека
Тип запроса	Асинхронный/синхронный
Поддерживаемая версия агента	v2
PluggetSystemType	RKMid

Формат запроса

{
  "taskType": "UndoBill",
  "params": {
    "async": {
      "objectId": number,
       "timeout": number
    },
    "sync": {
      "objectId": number,
       "timeout": number
    },
    "cashStationId": number,
    "orderGuid": "string",
    "seat": number,
    "stationCode": number,
    "cashierCode": number
 }
}

JSON

Параметр	Тип	Обязательный	Описание
taskType	string	да	Тип задачи
-async			Асинхронный вызов метода: либо синхронный, либо асинхронный
-sync			Синхронный вызов метода: либо синхронный, либо асинхронный
--timeout	int	нет	Время ожидания ответа от агента в секундах. По умолчанию — 120 секунд
--objectId	int	да	Код ресторана в системе лицензирования
-seat	int	нет	Номер места, для которого будет отменен пречек. Счет может делится на количество гостей. Значение по умолчанию — 0. Если 0, то будут отменены все пречеки.
-stationCode	int	нет	Код кассы, на которой будет произведена отмена пречека. Если не указан, пречек будет отменен на кассе, указанной в конфигурации Агента
-cashierCode	int	нет	Код кассира, от имени которого будет произведена отмена пречека. Если не указан, пречек будет отменен от имени кассира, указанного в конфигурации Агента
cashStationId	int	-	Id кассовой станции, если не указан, и так же не указан stationCode, то кассовая станция берется из параметров ресторана установленных в административной панели WS. При указании кассовой станции с mid, отличного от выбранного в "параметрах создания заказа", указываем этот mid в поле systemName Маршрутизация запросов

Формат ответа

Успешный ответ

{ 
   "responseCommon":{ 
      "taskGuid": "string",
      "taskType": "UndoBill",
      "objectId": number
   }
}

JSON

Ответ с ошибкой

{ 
   "responseCommon":{ 
      "taskGuid": "string",
      "taskType": "UndoBill",
      "objectId": number
   },
   "error":{ 
      "wsError":{ 
         "code":"string",
         "desc":"string"
      }
   }
}

JSON

Параметр	Тип	Описание
-taskGuid	guid	Уникальный код этой задачи. Используется при получении задачи через очередь
-taskType	string enum	Тип задачи
-objectId	int	Код ресторана в системе лицензирования
error		Контейнер ошибок, подробнее читайте в статье Описание ошибок

Формат асинхронного ответа

Успешный ответ

{
  "taskResponse": {
  },
  "responseCommon": {
    "taskGuid": "string",
    "taskType": "UndoBill",
    "objectId": 0
  }
}

JSON

Ответ с ошибкой

{
  "responseCommon": {
    "taskGuid": "string",
    "taskType": "UndoBill",
    "objectId": 0
  },
  "error": {
    "wsError": {
      "code": "string",
      "desc": "string"
    },
    "agentError": {
      "code": "string",
      "desc": "string"
    }
  }
}

JSON

Параметр	Тип параметра	Обязательный	Описание
status	string		Статус заказа. Ok — заказ успешно отменился
error	string enum		Контейнер ошибок, подробнее читайте в статье Описание ошибок