Skip to main content

Enriched Payload Feature

Introduction​

The optional ENRICHED_PAYLOAD feature can be specified on creation or update of an existing PMS provider. When this feature is activated, the payloads sent to the PMS will have fields that contain the following:

  • The transaction type, which is otherwise only found via the Financial API.
  • In tax exclusive and multi-tax businesses, the enriched payload also returns a detailed tax breakdown for each sale line.

Example PMS Payload​

The following is an example enriched payload for a tax exclusive account, with the service charge feature enabled.

Notice the added taxLines array, as well as the type field contained in each sale line object in the transactions array.

{
    "name": "",
    "openDate": "2024-05-10T19:26:53.958Z",
    "closeDate": "2024-05-10T19:27:13.794Z",
    "covers": 0,
    "ownerId": 14670,
    "ownerName": "Manager",
    "deviceId": 92844,
    "transactions": [
        {
            "unitAmount": 9.0000,
            "quantity": 1.00000,
            "amount": 9.0000,
            "description": "Hamburger",
            "staffId": 14670,
            "staffName": "Manager",
            "groupId": 141948669132845,
            "groupName": "Food",
            "taxId": 0,
            "taxName": "MULTI",
            "taxRate": 1.1498,
            "taxIncluded": false,
            "sku": "52",
            "taxLines": [
                {
                    "taxId": "141948669132806",
                    "taxName": "5% GST",
                    "taxRate": 1.0500,
                    "taxIncluded": false,
                    "taxAmount": 0.4950
                },
                {
                    "taxId": "141948669132805",
                    "taxName": "9.975% PST",
                    "taxRate": 1.0998,
                    "taxIncluded": false,
                    "taxAmount": 0.9875
                }
            ],
            "serviceChargeContribution": 0.9000,
            "type": "Sale"
        },
        {
            "unitAmount": 1.0000,
            "quantity": 1.00000,
            "amount": 1.0000,
            "description": "Extra Cheese",
            "staffId": 14670,
            "staffName": "Manager",
            "groupId": 141948669132845,
            "groupName": "Food",
            "taxId": 0,
            "taxName": "MULTI",
            "taxRate": 1.1498,
            "taxIncluded": false,
            "sku": "35",
            "taxLines": [
                {
                    "taxId": "141948669132806",
                    "taxName": "5% GST",
                    "taxRate": 1.0500,
                    "taxIncluded": false,
                    "taxAmount": 0.0550
                },
                {
                    "taxId": "141948669132805",
                    "taxName": "9.975% PST",
                    "taxRate": 1.0998,
                    "taxIncluded": false,
                    "taxAmount": 0.1097
                }
            ],
            "serviceChargeContribution": 0.1000,
            "type": "Sale"
        }
    ],
    "payments": [
        {
            "paymentDate": "2024-05-10T19:27:13.786Z",
            "staffId": 14670,
            "staffName": "Manager",
            "gratuity": 0.0000,
            "amount": 12.6500,
            "methodName": "room",
            "reservationId": "001",
            "methodCode": "IKPMS"
        }
    ],
    "receiptId": "R92844.1",
    "receipt": null,
    "uuid": "RnTD03DnQ4-Phya5iwVh7Q==",
    "id": null,
    "initialAccountId": "A92844.1",
    "fiscId": "A92844.1",
    "revenueCenterId": 141948669132822,
    "revenueCenterName": "Fixed POS",
    "type": "SALE",
    "serviceCharge": {
        "amount": 1.0000,
        "type": "APPORTIONED"
    },
    "businessExternalReference": "business-external-reference",
    "apiKey": "fake-api-key",
    "identifier": "A92844.1"
}