Commande getTable (obtenir la table)

Vue d'ensemble

La commande getTable (obtenir la table) renvoie les détails de l’addition pour une table spécifique. Il peut s’agir d’une seule addition ou de plusieurs si les clients ont demandé des additions séparées.

Structure de la requête

ÉLÉMENT	TYPE	DESCRIPTION	TAILLE	OBLIGATOIRE
terminalId	String	Identifiant du terminal à l'origine de la requête	V8	Obligatoire
merchantId	String	Identifiant du commerçant à l'origine de la requête	V13	Obligatoire
apiVersion	String	Numéro de version de l'API	V20	Obligatoire
requestId	String	Identifiant unique pour cette requête	V50	Obligatoire
requestTimestamp	String	Date et heure de la requête	F19	Obligatoire
action	String	Type de transaction – « getTable »	V24	Conditionnel
data	Object	Données applicables à ce type de transaction	–	–
server	Object	–	–	–
serverId	String	Identifiant du serveur saisi sur le terminal	V50	Optionnel
trackData	Object	–	–	–
Track1	String	Piste 1 de la carte serveur balayée	V50	Optionnel
Track2	String	Piste 2 de la carte serveur balayée	V50	Optionnel
Track3	String	Piste 3 de la carte serveur balayée	V50	Optionnel
tableId	String	Identifiant de table pour usage interne du système	V50	Obligatoire
error	Object	Présent si le terminal détecte une erreur dans la réponse précédente. Applicable à toutes les actions.	–	–
status	String	Code d’état	F3	Conditionnel
statusDesc	String	Description du code d’état	V50	Conditionnel
session	String	Identifiant de session provenant du cloud Moneris	V50	Conditionnel


{
   "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"
}

Structure de la réponse

ÉLÉMENT	TYPE	DESCRIPTION	TAILLE	OBLIGATOIRE
terminalId	String	Identifiant du terminal à l'origine de la requête	V8	Obligatoire
merchantId	String	Identifiant du commerçant à l'origine de la requête	V13	Obligatoire
configCode	String	Code de configuration d’intégration fourni par Moneris	V25	Obligatoire
requestId	String	Identifiant unique pour cette requête	V50	Obligatoire
requestTimestamp	String	Date et heure de la requête	F19	Obligatoire
status	String	Code d’état RMS	F3	Obligatoire
statusDesc	String	Description du code d’état RMS	V50	Obligatoire
data	Object	Données applicables à ce type de transaction	–	–
table	Array	Un objet contenant une seule table	–	–
tableId	String	Clé primaire, utilisée dans les requêtes suivantes pour cibler une table en particulier	V50	Obligatoire
tableName	String	Nom de la table pour affichage dans l’interface utilisateur du terminal	V50	Obligatoire
tableTotalAmount	Number	Montant total dû pour la table (en cents)	V9	Obligatoire
tableRemainingAmount	Number	Montant restant dû, autorisation partielle (en cents)	V9	Obligatoire
splitMethod	Number	Méthode utilisée pour le paiement fractionn 1 = Aucun fractionnement 2 = Fractionnement par montant 3 = Fractionnement par addition initialement défini à 1 et remplacé par 2 ou 3 selon le checkId de la réponse ApplyPayment. Si checkId == 1, définir 2 sinon définir 3	F1	Obligatoire
masterCheck	Object	Détails de l’addition de table	–	Obligatoire
checkId	String	Clé primaire, utilisée dans les requêtes suivantes pour cibler cette addition en particulier	V50	Obligatoire
checkName	String	Nom de l’addition pour affichage dans l’interface utilisateur du terminal	V50	Optionnel
totalAmount	Number	Montant total de la transaction	V9	Obligatoire
preTaxAmount	Number	Montant de la transaction avant taxes	V9	Optionnel
gratuity	Number	Frais de service. Il s’agit d’un frais que le restaurant peut ajouter automatiquement à une facture. Par exemple, certains restaurants ajoutent un pourboire pour les grands groupes.	V9	Optionnel
remainingAmount	Number	Montant dû d’un montant partiellement approuvé	V9	Obligatoire
receipt	Object	Détails des articles achetés	–	–
taxes	Array	–	–	–
taxName	String	Type de taxe : TPS, TVH, etc.	V50	Optionnel
taxValue	Number	Montant de la taxe	V9	Optionnel
discounts	Array	–	–	–
discountName	String	Type de rabais : montant fixe, pourcentage, etc.	V50	Optionnel
discountValue	Number	Montant du rabais	V9	Optionnel
lineItems	Array	–	–	–
itemId	String	ID unique de l’article acheté	V50	Optionnel
itemName	String	Nom de l’article acheté	V50	Optionnel
itemQuantity	Number	Quantité d’articles achetés	V9	Optionnel
itemSubTotal	Number	Montant de l’article, avant taxes et rabais, multiplié par la quantité	V9	Optionnel
itemTaxes	Array	–	V9	Optionnel
itemTaxName	String	Type de taxe au niveau de l’article : TPS, TVH, etc.	V50	Optionnel
itemTaxValue	Number	Montant de la taxe au niveau de l’article	V9	Optionnel
itemDiscounts	Array	–	–	–
itemDiscountName	String	Type de rabais : montant fixe, pourcentage, etc.	V50	Optionnel
ItemDiscountValue	Number	Montant du rabais	V9	Optionnel
itemTotal	Number	Coût total de l’article acheté	V9	Optionnel
checks	Array	–	–	–
checkId	String	Clé primaire, utilisée dans les requêtes suivantes pour cibler cette addition en particulier	V50	Obligatoire
checkName	String	Nom de l’addition pour affichage dans l’interface utilisateur du terminal	V50	Optionnel
totalAmount	Number	Montant total de la transaction	V9	Obligatoire
preTaxAmount	Number	Montant de la transaction avant taxes	V9	Optionnel
gratuity	Number	Frais de service. Il s’agit d’un frais que le restaurant peut ajouter automatiquement à une facture. Par exemple, certains restaurants ajoutent un pourboire pour les grands groupes.	V9	Optionnel
remainingAmount	Number	Montant dû d’un montant partiellement approuvé	V9	Obligatoire
receipt	Object	Détails des articles achetés	–	–
session	String	Identifiant de session provenant du cloud Moneris	V50	Conditionnel


{
   "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"
}