Get Table Command

Overview

The getTable command returns check details for a specific table. This could be a single check or, multiple checks if the guests requested separate checks.

Request Structure

ELEMENT	TYPE	DESCRIPTION	SIZE	REQUIRED
terminalId	String	Terminal ID request originated from	V8	Required
merchantId	String	Merchant ID of requestor	V13	Required
apiVersion	String	API version number	V20	Required
requestId	String	A unique identifier for this request	V50	Required
requestTimestamp	String	Date and time of the request	F19	Required
action	String	Transaction type – “getTable”	V24	Conditional
data	Object	Data applicable to this transaction type	–	–
server	Object	–	–	–
serverId	String	Server ID entered on the terminal	V50	Optional
trackData	Object	–	–	–
Track1	String	Track 1 from server card swiped	V50	Optional
Track2	String	Track 2 from server card swiped	V50	Optional
Track3	String	Track 3 from server card swiped	V50	Optional
tableId	String	Table ID for internal use by the system	V50	Required
error	Object	Present if the terminal detects an error in the previous response. Applicable to all actions.	–	–
status	String	Status code	F3	Conditional
statusDesc	String	Description for status code	V50	Conditional
session	String	Session ID from Moneris cloud	V50	Conditional


{
   "terminalId": "I9000001",
   "merchantId": "0030112345678",
   "apiVersion": "1.0",
   "requestId": "I9000001-1555449670-037",
   "requestTimestamp": "2020-01-01 09:00:00",
   "action": "getTable",
   "data": {
      "server": {
         "serverId": "1234",
         "trackData": {
            "track1": "",
            "track2": "",
            "track3": ""
         }
      },
      "tableId": "15cbb687bb376894ed03662db"
   },
   "error": {
      "status": "703",
      "statusDesc": "Table Number Error"
   },
   "session": "c9e5558c-3dfb-4359-adcf-c3c3de0d269d"
}

Response Structure

ELEMENT	TYPE	DESCRIPTION	SIZE	REQUIRED
terminalId	String	Terminal ID request originated from	V8	Required
merchantId	String	Merchant ID of requestor	V13	Required
configCode	String	Integration configuration code provided by Moneris	V25	Required
requestId	String	A unique identifier for this request	V50	Required
requestTimestamp	String	Date and time of the request	F19	Required
status	String	RMS status code	F3	Required
statusDesc	String	RMS status code description	V50	Required
data	Object	Data applicable to this transaction type	–	–
table	Array	An object containing a single table	–	–
tableId	String	Primary key, used in subsequent requests to address particular table	V50	Required
tableName	String	Table name for display in terminal user interface	V50	Required
tableTotalAmount	Number	Total amount due for the table (in cents)	V9	Required
tableRemainingAmount	Number	Amount due, partial authorisation (in cents)	V9	Required
splitMethod	Number	The method used for split payment 1 = No Split 2 = Split by Amount 3 = Split by Check initially set to 1 and replaced by 2 or 3 depending on checkId from the ApplyPayment response. If checkId == 1 then set it to 2 else set it to 3	V1	Required
masterCheck	Object	Table Check Details	–	Required
checkId	String	Primary key, used in subsequent request to address this particular check	V50	Required
checkName	String	Check name for display in terminal user interface	V50	Optional
totalAmount	Number	Total transaction amount	V9	Required
preTaxAmount	Number	Transaction Amount Before Taxes	V9	Optional
gratuity	Number	Service charges. This is a charge the restaurant may automatically add to a bill. For example, some restaurants add a gratuity for large parties or groups.	V9	Optional
remainingAmount	Number	The amount due of a partially approved amount	V9	Required
receipt	Object	Details of Items Purchased	–	–
taxes	Array	–	–	–
taxName	String	Tax type: GST, HST etc	V50	Optional
taxValue	Number	Tax Amount	V9	Optional
discounts	Array	–	–	–
discountName	String	Discount Type: Dollar Amount, Percentage etc	V50	Optional
discountValue	Number	Discount Amount	V9	Optional
lineItems	Array	–	–	–
itemId	String	Unique ID of Item Purchased	V50	Optional
itemName	String	Name of Item Purchased	V50	Optional
itemQuantity	Number	Quantity of Item Purchased	V9	Optional
itemSubTotal	Number	Item amount, before taxes and discounts, multiplied by item quantity	V9	Optional
itemTaxes	Array	–	–	–
itemTaxName	String	Item level tax type: GST, HST etc	V50	Optional
itemTaxValue	Number	Item level tax Amount	V9	Optional
itemDiscounts	Array	–	–	–
itemDiscountName	String	Discount Type: Dollar Amount, Percentage etc	V50	Optional
ItemDiscountValue	Number	Discount Amount	V9	Optional
itemTotal	Number	Total cost of Item Purchased	V9	Optional
checks	Array	–	–	–
checkId	String	Primary key, used in subsequent request to address this particular check	V50	Required
checkName	String	Check name for display in terminal user interface	V50	Optional
totalAmount	Number	Total transaction amount	V9	Required
preTaxAmount	Number	Transaction Amount Before Taxes	V9	Optional
gratuity	Number	Service charges. This is a charge the restaurant may automatically add to a bill. For example, some restaurants add a gratuity for large parties or groups.	V9	Optional
remainingAmount	Number	The amount due of a partially approved amount	V9	Required
receipt	Object	Details of Items Purchased	–	–
session	String	Session ID from Moneris cloud	V50	Conditional


{
   "terminalId": "I9000001",
   "merchantId": "0030112345678",
   "configCode": "C12345678SI",
   "requestId": "I9000001-1555449670-037",
   "responseTimestamp": "yyyy-mm-dd hh:mm:ss",
   "status": "605",
   "statusDesc": "Missing Table ID",
   "data": {
      "table": {
         "tableId": "5cbb687bb376894ed03662db",
         "tableName": "DiningRoom1",
         "tableTotalAmount": 52400,
         "tableRemainingAmount": 52400,
         "splitMethod": 1,
         "masterCheck": {
            "checkId": "1",
            "checkName": "Full Table",
            "totalAmount": 52400,
            "preTaxAmount": 40000,
            "gratuity": 7200,
            "remainingAmount": 52400,
            "receipt": {
               "taxes": [
                  {
                     "taxName": "GST",
                     "taxValue": 5200
                  },
                  {
                     "name": "PST",
                     "value": 5200
                  }
               ],
               "discounts": [
                  {
                     "discountName": "25% Sale",
                     "discountValue": 10000
                  }
               ],
               "lineItems": [
                  {
                     "itemId": "1",
                     "itemName": "beer",
                     "itemQuantity": 2,
                     "itemSubtotal": 1200,
                     "itemTaxes": [
                        {
                           "itemTaxName": "GST",
                           "itemTaxValue": 156
                        },
                        {
                           "itemTaxName": "PST",
                           "itemTaxValue": 156
                        }
                     ],
                     "itemDiscounts": [
                        {
                           "itemDiscountName": "25% Sale",
                           "itemDiscountValue": 0
                        }
                     ],
                     "itemTotal": 1500
                  }
               ]
            }
         },
         "checks": [
            {
               "checkId": "2",
               "checkName": "Jim",
               "totalAmount": 13100,
               "preTaxAmount": 10000,
               "gratuity": 1800,
               "remainingAmount": 13100,
               "receipt": {}
            },
            {
               "checkId": "3",
               "checkName": "Bob",
               "totalAmount": 26200,
               "preTaxAmount": 20000,
               "gratuity": 3600,
               "remainingAmount": 26200,
               "receipt": {}
            }
         ]
      }
   },
   "session": "c9e5558c-3dfb-4359-adcf-c3c3de0d269d"
}