Purpose

Printing a guest bill

Request typeAsynchronous/synchronous
Supported agent versionv2
PluggetSystemTypeRKMid

Request format


JSON

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

Parameter

Type

Mandatory

Description

taskType
yesTask type
-async

Asynchronous method call: either synchronous or asynchronous
-sync

Synchronous method call: either synchronous or asynchronous
-objectId

Restaurant code in the licensing system
--timeoutintnoAgent response time in seconds. Default is 120 seconds
-orderGuidguidyesGUID of the order for which you want to print a guest bill
-stationCodeintnoThe code of the cash register where the guest bill will be printed. If not specified, the guest bill will be printed at the cash register specified in the Agent configuration
-cashierCodeintnoThe code of the cashier on whose behalf the guest bill will be printed. If not specified, the guest bill will be printed on behalf of the cashier specified in the Agent configuration

Synchronous response format

Successful response


JSON

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


Response with error


JSON

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

Parameter

Type

Description

-taskGuidguidUnique code for this task. Used when receiving a task via the queue
-taskTypestring enumTask type
-objectIdintRestaurant code in the licensing system
error
Error container, for more details see the article Error Description

Asynchronous response format

Successful response


JSON

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


Response with error


JSON

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