Base Notification Schema

Field	Type	Description
bookingId	Number	The id of the reservation
businessId	Number	The id of the property
businessType	String	The type of the business. Usually VENUE
internalTransactionId	Number	The id of the transaction that originated this notification
internalTransactionItemId	Number	The id of the item that originated this notification
paymentMethod	String	The payment type Payment Methods
paymentMethodId	Number	The payment type id (This is different for every property)
dynamicPaymentMethodName	String	The specific payment method name
type	String	The type of the transaction Transaction Types
description	String	The description of the transaction
netAmount	Number	The net amount
grossAmount	Number	The gross amount
currency	String	The currency of the transaction (GBP, EUR, etc)
deviceCreatedDate	Date	The date when the transaction was created (YYYY-MM-DD HH:mm:ss)

Specific Schemas

Sales

Field	Type	Description
name	String	The name of the product
productSkuId	Number	The id of the SKU of the product
productSku	String	The SKU
productId	Number	The id of the product
quantity	Number	The quantity of products
taxes	Array	The taxes for the transaction
- id	Number	The id of the tax (This is unique for each Venue)
- amount	Number	The value of the tax
- percentage	Number	The percentage of the tax
- description	String	The description of the tax
categories	Array	The categories associated with the product of the transaction
- id	Number	The id of the category
- name	String	The name of the category
- description	String	The description of the category

Guest

Field	Type	Description
firstName	String	The first name of the guest
lastName	String	The last name of the guest
sex	String	The gender of the guest
email	String	The email of the guest
phone	String	The phone number of the guest
birthDate	String	The birth date of the guest
countryCode	String	The country code of the guest nationality

Examples

Sale

{
  "event":"POSTPAID",
  "businessId":203,
  "businessType":"VENUE",
  "data":{
    "name":"Big Champ (A) - austin",
    "productSkuId":20255,
    "productSku":"SP1064",
    "quantity":1,
    "taxes":[
      {
        "id":1,
        "amount":5.571432,
        "percentage":8,
        "description":"Test Tax for Big Champ (A) - austin (#400250)"
      }
    ],
    "customerId":"G1006",
    "bookingId":4084,
    "businessId":203,
    "businessType":"VENUE",
    "internalTransactionId":218572,
    "internalTransactionItemId":400250,
    "paymentMethod":"POUCH_PAY",
    "paymentMethodId":9415,
    "type":"POSTPAID",
    "description":"Payment for Transaction No. 218572 with Item No. 400250 using PostPaid Credits",
    "netAmount":46.428568,
    "grossAmount":52.0,
    "currency":"GBP",
    "deviceCreatedDate":"2022-02-12 10:13:30"
  }
}

Topup

{
  "event":"TOPUP",
  "businessId":203,
  "businessType":"VENUE",
  "data":{
    "customerId":"G1006",
    "bookingId":4084,
    "businessId":203,
    "businessType":"VENUE",
    "internalTransactionId":218566,
    "internalTransactionItemId":218566,
    "paymentMethod":"CASH",
    "paymentMethodId":4169,
    "type":"TOPUP",
    "description":"Payment for Transaction No. 218566 with Transaction ID 218566 for Top-up",
    "netAmount":500.0,
    "grossAmount":500.0,
    "currency":"GBP",
    "deviceCreatedDate":"2022-02-12 10:13:30"
  }
}

Additional Charge

{
  "event":"ADDITIONAL_CHARGE_POSTPAID",
  "businessId":203,
  "businessType":"VENUE",
  "data":{
    "customerId":"G1006",
    "bookingId":4084,
    "businessId":203,
    "businessType":"VENUE",
    "internalTransactionId":218570,
    "internalTransactionItemId":218570,
    "paymentMethod":"POUCH_PAY",
    "paymentMethodId":9415,
    "type":"ADDITIONAL_CHARGE_POSTPAID",
    "description":"Additional Charges for Transaction No. 218570 with Transaction ID 218570",
    "currency":"GBP",
    "deviceCreatedDate":"2022-02-12 10:13:30"
  }
}

Tip

{
  "event":"TIP_POSTPAID",
  "businessId":203,
  "businessType":"VENUE",
  "data":{
    "customerId":"G1006",
    "bookingId":4084,
    "businessId":203,
    "businessType":"VENUE",
    "internalTransactionId":218570,
    "internalTransactionItemId":218570,
    "paymentMethod":"POUCH_PAY",
    "paymentMethodId":9415,
    "type":"TIP_POSTPAID",
    "description":"Tip for Transaction No. 218570 with Transaction ID 218570",
    "netAmount":20,
    "grossAmount":20,
    "currency":"GBP",
    "deviceCreatedDate":"2022-02-12 10:13:30"
  }
}

Void

{
  "event":"POSTPAID_VOID",
  "businessId":203,
  "businessType":"VENUE",
  "data":{
    "customerId":"G1006",
    "bookingId":4084,
    "businessId":203,
    "businessType":"VENUE",
    "internalTransactionId":218575,
    "internalTransactionItemId":400253,
    "type":"POSTPAID_VOID",
    "deviceCreatedDate":"2022-02-12 10:13:30"
  }
}

Guest Update

{
  "event":"CUSTOMER_BOOKING_UPDATE",
  "businessId":203,
  "businessType":"VENUE",
  "data":{
    "firstName":"John",
    "lastName":"Doe",
    "sex":"M",
    "email":"[email protected]",
    "phone":"849361809810",
    "birthDate":"1985-01-01 00:00:00",
    "countryCode":"PT",
    "customerId":"G1006",
    "bookingId":4090,
    "businessId":203,
    "businessType":"VENUE",
    "type":"CUSTOMER_BOOKING_UPDATE",
    "deviceCreatedDate":"2022-02-13 13:29:29"
  }
}

Booking Created

{
  "event": "booking.created",
  "businessId": 203,
  "businessType": "VENUE",
  "data": {
    "id": 2456,
    "clientId": "2bm5dmha3me1gubm2v8v4jp3j",
    "source": "TestPMS",
    "externalId": "fb473652-26b5-4673-88fe-0a58ac735451",
    "businessId": 203,
    "bookingNumber": "12345",
    "startTime": "Jan 10, 2022, 12:00:00 AM",
    "endTime": "Jan 11, 2022, 12:00:00 AM",
    "type": "ONLINE"
    "status": "CONFIRMED",
    "adultCount": 3,
    "childCount": 0,
    "reasonForStay": "Leisure",
    "company": "Example",
    "bookedAt": "Jan 10, 2022, 12:00:00 PM",
    "createdAt": "Jan 10, 2022, 3:00:02 PM",
    "updatedAt": "Jan 10, 2022, 3:00:02 PM",
    "rawStatus": "CONFIRMED",
    "bookingCustomers": [
      {
        "id": 35745,
        "bookingId": 2456,
        "customerId": 1234,
        "isBooker": true,
        "isOwner": true,
        "createdAt": "Jan 10, 2022, 3:00:03 PM",
        "updatedAt": "Jan 10, 2022, 3:00:03 PM",
        "customer": {
          "id": 4343,
          "source": "TestPMS",
          "externalId": "G1006",
          "firstName": "Guest2",
          "lastName": "1",
          "email": "[email protected]",
          "mobileNumber": "849361809810",
          "gender": "M",
          "birthdate": "2022-01-01",
          "properties": []
        }
      }
    ],
    "bookingItems": [
      {
        "id": 5475473,
        "source": "TestPMS",
        "externalId": "BI1004",
        "name": "Room20230",
        "type": "PLACE",
        "itemAmount": 150,
        "totalAmount": 150,
        "currency": "USD",
        "quantity": 1,
        "createdAt": "Jan 10, 2022, 3:00:04 PM",
        "updatedAt": "Jan 10, 2022, 3:00:04 PM"
      }
    ]
  }
}

Checkout

{
  "event": "CHECKOUT",
  "businessId": 203,
  "businessType": "VENUE",
  "data": {
    "firstName": "Guest",
    "lastName": "219114",
    "sex": "N/A",
    "email": "N/A",
    "bookingId": 4189,
    "businessId": 203,
    "businessType": "VENUE",
    "type": "CHECKOUT",
    "description": "Checkout for Transaction No. 219114 with Transaction ID 219114",
    "currency": "FJD",
    "deviceCreatedDate": "2022-05-09 01:52:10"
  }
}