|
2
|
Alternative: Partner retrieving the notification of
reservation checked in using the Streaming Business
Event (push BE option).
Store the reservationId out of the CHECK IN Business Event.
The reservationId is in the "primaryKey" field of the BE.
Ensure that the "primaryKey" element is requested within the
Streaming Business Event setup 'subscribe' request.
|
Streaming CHECK IN Business Event
Check In BE using Streaming BE
{
"id": "1",
"type": "next",
"payload": {
"data": {
"newEvent": {
"metadata": {
"offset": "1099511750874"
},
"moduleName": "RESERVATION",
"eventName": "CHECK IN",
"hotelId": "SAND01CN",
"primaryKey": "158169",
"detail": [
{
"elementName": "NAME",
"oldValue": "LastName",
"newValue": "LastName"
},
{
"elementName": "FIRST NAME",
"oldValue": "FirstName",
"newValue": "FirstName"
},
{
"elementName": "MIDDLE NAME",
"oldValue": "",
"newValue": ""
},
{
"elementName": "CONFIRMATION NO",
"oldValue": "2474840",
"newValue": "2474840"
},
{
"elementName": "CONFIRMATION LEG NO",
"oldValue": "1",
"newValue": "1"
},
{
"elementName": "TRAVEL AGENT NAME",
"oldValue": "",
"newValue": ""
},
{
"elementName": "COMPANY NAME",
"oldValue": "",
"newValue": ""
},
{
"elementName": "SOURCE NAME",
"oldValue": "",
"newValue": ""
},
{
"elementName": "GROUP NAME",
"oldValue": "",
"newValue": ""
},
{
"elementName": "PARTY CODE",
"oldValue": "",
"newValue": ""
},
{
"elementName": "TRAVEL AGENT NAME ID",
"oldValue": "",
"newValue": ""
},
{
"elementName": "COMPANY NAME ID",
"oldValue": "",
"newValue": ""
},
{
"elementName": "SOURCE NAME ID",
"oldValue": "",
"newValue": ""
},
{
"elementName": "GROUP NAME ID",
"oldValue": "",
"newValue": ""
},
{
"elementName": "GUEST NAME ID",
"oldValue": "859098",
"newValue": "859098"
},
{
"elementName": "RESERVATION STATUS",
"oldValue": "CHECKED IN",
"newValue": "CHECKED IN"
},
{
"elementName": "ARRIVAL DATE",
"oldValue": "2024-03-21",
"newValue": "2024-03-21"
},
{
"elementName": "ARRIVAL TIME",
"oldValue": "23:34:45",
"newValue": "23:34:45"
},
{
"elementName": "LENGTH OF STAY",
"oldValue": "1",
"newValue": "1"
},
{
"elementName": "DEPARTURE DATE",
"oldValue": "2024-03-22",
"newValue": "2024-03-22"
},
{
"elementName": "ADVANCE CHECKED IN YN",
"oldValue": "N",
"newValue": "N"
},
{
"elementName": "EXPECTED TIME OF RETURN",
"oldValue": "",
"newValue": ""
},
{
"elementName": "ETR COMMENTS",
"oldValue": "",
"newValue": ""
},
{
"elementName": "OPTED FOR COMM YN",
"oldValue": "",
"newValue": ""
},
{
"elementName": "CREDIT LIMIT AUTO PAY ALLOW YN",
"oldValue": "",
"newValue": ""
},
{
"elementName": "CHECKOUT TIME",
"oldValue": "00:00:00",
"newValue": "00:00:00"
},
{
"elementName": "NUMBER OF ROOMS",
"oldValue": "1",
"newValue": "1"
},
{
"elementName": "ROOM TYPE",
"oldValue": "SUP",
"newValue": "SUP"
},
{
"elementName": "RTC",
"oldValue": "SUP",
"newValue": "SUP"
},
{
"elementName": "ROOM",
"oldValue": "403",
"newValue": "403"
},
{
"elementName": "MEMBERSHIP NUMBER",
"oldValue": "",
"newValue": ""
},
{
"elementName": "MEMBERSHIP TYPE",
"oldValue": "",
"newValue": ""
},
{
"elementName": "AWARD CODE 1",
"oldValue": "",
"newValue": ""
},
{
"elementName": "AWARD VOUCHER 1",
"oldValue": "",
"newValue": ""
},
{
"elementName": "GP_ELIGIBILITY",
"oldValue": "",
"newValue": ""
},
{
"elementName": "ADULTS",
"oldValue": "1",
"newValue": "1"
},
{
"elementName": "CHILDREN",
"oldValue": "1",
"newValue": "1"
},
{
"elementName": "CURRENCY CODE",
"oldValue": "USD",
"newValue": "USD"
},
{
"elementName": "MARKET CODE",
"oldValue": "BUSINESS",
"newValue": "BUSINESS"
},
{
"elementName": "RATE AMOUNT",
"oldValue": "200",
"newValue": "200"
},
{
"elementName": "RATE CODE",
"oldValue": "USRATE",
"newValue": "USRATE"
},
{
"elementName": "SOURCE CODE",
"oldValue": "SAND01CN",
"newValue": "SAND01CN"
},
{
"elementName": "CONNECTING YN",
"oldValue": "N",
"newValue": "N"
},
{
"elementName": "FIXED RATE",
"oldValue": "N",
"newValue": "N"
},
{
"elementName": "PRINT RATE YN",
"oldValue": "Y",
"newValue": "Y"
},
{
"elementName": "BLOCK CODE",
"oldValue": "",
"newValue": ""
},
{
"elementName": "RESERVATION TYPE",
"oldValue": "CHECKED IN",
"newValue": "CHECKED IN"
},
{
"elementName": "ORIGIN",
"oldValue": "",
"newValue": ""
},
{
"elementName": "EXT SEG NO",
"oldValue": "",
"newValue": ""
},
{
"elementName": "SHARE YN",
"oldValue": "N",
"newValue": "N"
},
{
"elementName": "PAYMENT METHOD",
"oldValue": "CA",
"newValue": "CA"
},
{
"elementName": "PAYMENT METHOD DESC",
"oldValue": "Cash",
"newValue": "Cash"
},
{
"elementName": "CREDIT CARD NUMBER",
"oldValue": "",
"newValue": ""
},
{
"elementName": "CREDIT CARD EXPIRATION DATE",
"oldValue": "",
"newValue": ""
},
{
"elementName": "AUTHORIZER",
"oldValue": "",
"newValue": ""
},
{
"elementName": "EXTERNAL USER ID",
"oldValue": "",
"newValue": ""
},
{
"elementName": "CREDIT CARD TYPE",
"oldValue": "",
"newValue": ""
},
{
"elementName": "DISCOUNT AMOUNT",
"oldValue": "",
"newValue": ""
},
{
"elementName": "DISCOUNT PERCENT",
"oldValue": "",
"newValue": ""
},
{
"elementName": "DISCOUNT REASON",
"oldValue": "",
"newValue": ""
},
{
"elementName": "SPECIAL REQUEST",
"oldValue": "",
"newValue": ""
},
{
"elementName": "ROOM FEATURES",
"oldValue": "",
"newValue": ""
},
{
"elementName": "PRODUCTS",
"oldValue": "",
"newValue": ""
},
{
"elementName": "PROMOTIONS",
"oldValue": "",
"newValue": ""
},
{
"elementName": "NO POST",
"oldValue": "N",
"newValue": "N"
},
{
"elementName": "VIDEO CHECKOUT",
"oldValue": "N",
"newValue": "N"
},
{
"elementName": "AUTHORIZE DIRECT BILL",
"oldValue": "N",
"newValue": "N"
},
{
"elementName": "YIELD MARKET TYPE",
"oldValue": "",
"newValue": ""
},
{
"elementName": "TAX TYPE",
"oldValue": "",
"newValue": ""
},
{
"elementName": "ARRIVAL TRANSPORT TYPE",
"oldValue": "",
"newValue": ""
},
{
"elementName": "ARRIVAL STATION CODE",
"oldValue": "",
"newValue": ""
},
{
"elementName": "ARRIVAL CARRIER CODE",
"oldValue": "",
"newValue": ""
},
{
"elementName": "ARRIVAL TRANSPORT CODE",
"oldValue": "",
"newValue": ""
},
{
"elementName": "ARRIVAL DATETIME",
"oldValue": "",
"newValue": ""
},
{
"elementName": "ARRIVAL TRANSPORT TIME",
"oldValue": "",
"newValue": ""
},
{
"elementName": "ARRIVAL ESTIMATE TIME",
"oldValue": "",
"newValue": ""
},
{
"elementName": "ARRIVAL TRANSPORTATION",
"oldValue": "",
"newValue": ""
},
{
"elementName": "ARRIVAL COMMENTS",
"oldValue": "",
"newValue": ""
},
{
"elementName": "DEPARTURE TRANSPORT TYPE",
"oldValue": "",
"newValue": ""
},
{
"elementName": "DEPARTURE STATION CODE",
"oldValue": "",
"newValue": ""
},
{
"elementName": "DEPARTURE CARRIER CODE",
"oldValue": "",
"newValue": ""
},
{
"elementName": "DEPARTURE TRANSPORT CODE",
"oldValue": "",
"newValue": ""
},
{
"elementName": "DEPARTURE DATETIME",
"oldValue": "",
"newValue": ""
},
{
"elementName": "DEPARTURE TRANSPORT TIME",
"oldValue": "",
"newValue": ""
},
{
"elementName": "DEPARTURE ESTIMATE TIME",
"oldValue": "",
"newValue": ""
},
{
"elementName": "DEPARTURE TRANSPORTATION",
"oldValue": "",
"newValue": ""
},
{
"elementName": "DEPARTURE COMMENTS",
"oldValue": "",
"newValue": ""
},
{
"elementName": "COMMISSION PAID TO",
"oldValue": "0",
"newValue": "0"
},
{
"elementName": "COMMISSION PAYOUT TO",
"oldValue": "N",
"newValue": "N"
},
{
"elementName": "TA RECORD LOCATOR",
"oldValue": "",
"newValue": ""
},
{
"elementName": "HURDLE RATE",
"oldValue": "",
"newValue": ""
},
{
"elementName": "RATEABLE VALUE",
"oldValue": "",
"newValue": ""
},
{
"elementName": "RESTRICTION OVERRIDE",
"oldValue": "",
"newValue": ""
},
{
"elementName": "HURDLE OVERRIDE",
"oldValue": "",
"newValue": ""
},
{
"elementName": "YIELD STATUS",
"oldValue": "N",
"newValue": "N"
},
{
"elementName": "SPG UPGRADE REASON CODE",
"oldValue": "N",
"newValue": "N"
},
{
"elementName": "SPG DISCLOSE ROOM TYPE YN",
"oldValue": "N",
"newValue": "N"
},
{
"elementName": "APP USER",
"oldValue": "3976",
"newValue": "3976"
},
{
"elementName": "EXTERNAL EFOLIO YN",
"oldValue": "",
"newValue": ""
},
{
"elementName": "FOLIO OPT IN",
"oldValue": "",
"newValue": ""
},
{
"elementName": "CHILDREN 1",
"oldValue": "0",
"newValue": "0"
},
{
"elementName": "CHILDREN 2",
"oldValue": "1",
"newValue": "1"
},
{
"elementName": "CHILDREN 3",
"oldValue": "0",
"newValue": "0"
},
{
"elementName": "CONFIRMATION LETTER YN",
"oldValue": "",
"newValue": ""
},
{
"elementName": "WAITLIST PRIORITY",
"oldValue": "",
"newValue": ""
},
{
"elementName": "WAITLIST REASON CODE",
"oldValue": "",
"newValue": ""
},
{
"elementName": "WAITLIST REASON DESCRIPTION",
"oldValue": "",
"newValue": ""
},
{
"elementName": "INSERT DATE",
"oldValue": "2024-03-20T22:39:54",
"newValue": "2024-03-20T22:39:54"
},
{
"elementName": "UPDATE DATE",
"oldValue": "2024-03-20T23:34:45",
"newValue": "2024-03-20T23:34:45"
},
{
"elementName": "UPDATE USER",
"oldValue": "3976",
"newValue": "3976"
},
{
"elementName": "FOLIO FLAG",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF CHAR 01",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF CHAR 02",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF CHAR 03",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF CHAR 04",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF CHAR 05",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF CHAR 06",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF CHAR 07",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF CHAR 08",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF CHAR 09",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF CHAR 10",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF CHAR 11",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF CHAR 12",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF CHAR 13",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF CHAR 14",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF CHAR 15",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF CHAR 16",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF CHAR 17",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF CHAR 18",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF CHAR 19",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF CHAR 20",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF CHAR 21",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF CHAR 22",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF CHAR 23",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF CHAR 24",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF CHAR 25",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF CHAR 26",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF CHAR 27",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF CHAR 28",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF CHAR 29",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF CHAR 30",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF CHAR 31",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF CHAR 32",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF CHAR 33",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF CHAR 34",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF CHAR 35",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF CHAR 36",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF CHAR 37",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF CHAR 38",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF CHAR 39",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF CHAR 40",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF NUMBER 01",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF NUMBER 02",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF NUMBER 03",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF NUMBER 04",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF NUMBER 05",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF NUMBER 06",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF NUMBER 07",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF NUMBER 08",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF NUMBER 09",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF NUMBER 10",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF NUMBER 11",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF NUMBER 12",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF NUMBER 13",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF NUMBER 14",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF NUMBER 15",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF NUMBER 16",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF NUMBER 17",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF NUMBER 18",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF NUMBER 19",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF NUMBER 20",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF NUMBER 21",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF NUMBER 22",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF NUMBER 23",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF NUMBER 24",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF NUMBER 25",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF NUMBER 26",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF NUMBER 27",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF NUMBER 28",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF NUMBER 29",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF NUMBER 30",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF NUMBER 31",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF NUMBER 32",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF NUMBER 33",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF NUMBER 34",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF NUMBER 35",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF NUMBER 36",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF NUMBER 37",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF NUMBER 38",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF NUMBER 39",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF NUMBER 40",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF DATE 01",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF DATE 02",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF DATE 03",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF DATE 04",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF DATE 05",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF DATE 06",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF DATE 07",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF DATE 08",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF DATE 09",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF DATE 10",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF DATE 11",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF DATE 12",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF DATE 13",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF DATE 14",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF DATE 15",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF DATE 16",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF DATE 17",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF DATE 18",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF DATE 19",
"oldValue": "",
"newValue": ""
},
{
"elementName": "UDF DATE 20",
"oldValue": "",
"newValue": ""
},
{
"elementName": "PARENT RESV NAME ID",
"oldValue": "",
"newValue": ""
},
{
"elementName": "SPLIT YN",
"oldValue": "",
"newValue": "N"
},
{
"elementName": "WALK IN",
"oldValue": "",
"newValue": "N"
},
{
"elementName": "VIP STATUS",
"oldValue": "",
"newValue": ""
},
{
"elementName": "LANGUAGE",
"oldValue": "fr",
"newValue": "fr"
},
{
"elementName": "TITLE",
"oldValue": "",
"newValue": ""
},
{
"elementName": "GUEST MESSAGE YN",
"oldValue": "N",
"newValue": "N"
},
{
"elementName": "COMP TYPE",
"oldValue": "",
"newValue": ""
},
{
"elementName": "CREDIT CARD VAULT ID",
"oldValue": "",
"newValue": ""
},
{
"elementName": "CREDIT CARD NUMBER 4 DIGITS",
"oldValue": "",
"newValue": ""
},
{
"elementName": "BASE RATE CODE",
"oldValue": "",
"newValue": ""
},
{
"elementName": "LOCAL BASE RATE AMOUNT",
"oldValue": "",
"newValue": ""
},
{
"elementName": "BASE RATE CURRENCY CODE",
"oldValue": "",
"newValue": ""
},
{
"elementName": "TURNDOWN DATE",
"oldValue": "",
"newValue": ""
},
{
"elementName": "TURNDOWN STATUS",
"oldValue": "NR",
"newValue": "NR"
}
]
}
}
}
}
|
|
3
|
Alternative: Retrieve CHECK IN Business Events to receive
notification of reservation/room checked in (pull BE
option).
Store the reservationId out of the CHECK IN Business Event.
The reservationId is in the "primaryKey" field of the BE.
|
getBusinessEvents
CHECK IN Business Event
getBusinessEvents
GET {{HostName}}/VAB_ENT1/operarest/{{SchemaName}}/int/v1/externalSystem/{{ExternalSystemCode}}/hotels/{{HotelId}}/businessEvents?limit=1
200 Response
{
"businessEventData": [
{
"businessEvent": {
"header": {
"moduleName": "Reservation",
"actionType": "CHECK IN",
"actionId": 6258146,
"primaryKey": "2130534",
"publisherId": 130509,
"createdDateTime": "2024-02-19 14:56:35.0",
"hotelId": "MBOESEL"
},
"details": [
{
"dataElement": "NAME",
"oldValue": "Guest",
"newValue": "Guest"
},
{
"dataElement": "FIRST NAME",
"oldValue": "Test",
"newValue": "Test"
},
{
"dataElement": "MIDDLE NAME"
},
{
"dataElement": "CONFIRMATION NO",
"oldValue": "3588260",
"newValue": "3588260"
},
{
"dataElement": "CONFIRMATION LEG NO",
"oldValue": "1",
"newValue": "1"
},
{
"dataElement": "TRAVEL AGENT NAME"
},
{
"dataElement": "COMPANY NAME"
},
{
"dataElement": "SOURCE NAME"
},
{
"dataElement": "GROUP NAME"
},
{
"dataElement": "PARTY CODE"
},
{
"dataElement": "TRAVEL AGENT NAME ID"
},
{
"dataElement": "COMPANY NAME ID"
},
{
"dataElement": "SOURCE NAME ID"
},
{
"dataElement": "GROUP NAME ID"
},
{
"dataElement": "GUEST NAME ID",
"oldValue": "3526607",
"newValue": "3526607"
},
{
"dataElement": "RESERVATION STATUS",
"oldValue": "CHECKED IN",
"newValue": "CHECKED IN"
},
{
"dataElement": "ARRIVAL DATE",
"oldValue": "2020-08-31",
"newValue": "2020-08-31"
},
{
"dataElement": "ARRIVAL TIME",
"oldValue": "14:56:28",
"newValue": "14:56:28"
},
{
"dataElement": "LENGTH OF STAY",
"oldValue": "1",
"newValue": "1"
},
{
"dataElement": "DEPARTURE DATE",
"oldValue": "2020-09-01",
"newValue": "2020-09-01"
},
{
"dataElement": "ADVANCE CHECKED IN YN",
"oldValue": "N",
"newValue": "N"
},
{
"dataElement": "EXPECTED TIME OF RETURN"
},
{
"dataElement": "ETR COMMENTS"
},
{
"dataElement": "OPTED FOR COMM YN"
},
{
"dataElement": "CREDIT LIMIT AUTO PAY ALLOW YN"
},
{
"dataElement": "CHECKOUT TIME",
"oldValue": "00:00:00",
"newValue": "00:00:00"
},
{
"dataElement": "NUMBER OF ROOMS",
"oldValue": "1",
"newValue": "1"
},
{
"dataElement": "ROOM TYPE",
"oldValue": "CLASSIC",
"newValue": "CLASSIC"
},
{
"dataElement": "RTC",
"oldValue": "CLASSIC",
"newValue": "CLASSIC"
},
{
"dataElement": "ROOM",
"oldValue": "103",
"newValue": "103"
},
{
"dataElement": "MEMBERSHIP NUMBER"
},
{
"dataElement": "MEMBERSHIP TYPE"
},
{
"dataElement": "AWARD CODE 1",
"scopeFrom": "2020-08-31",
"scopeTo": "2020-09-01"
},
{
"dataElement": "AWARD VOUCHER 1",
"scopeFrom": "2020-08-31",
"scopeTo": "2020-09-01"
},
{
"dataElement": "GP_ELIGIBILITY",
"scopeFrom": "2020-08-31",
"scopeTo": "2020-09-01"
},
{
"dataElement": "ADULTS",
"oldValue": "1",
"newValue": "1",
"scopeFrom": "2020-08-31",
"scopeTo": "2020-09-01"
},
{
"dataElement": "CHILDREN",
"oldValue": "0",
"newValue": "0",
"scopeFrom": "2020-08-31",
"scopeTo": "2020-09-01"
},
{
"dataElement": "CURRENCY CODE",
"oldValue": "USD",
"newValue": "USD",
"scopeFrom": "2020-08-31",
"scopeTo": "2020-09-01"
},
{
"dataElement": "MARKET CODE",
"oldValue": "G",
"newValue": "G",
"scopeFrom": "2020-08-31",
"scopeTo": "2020-09-01"
},
{
"dataElement": "RATE AMOUNT",
"oldValue": "100",
"newValue": "100",
"scopeFrom": "2020-08-31",
"scopeTo": "2020-09-01"
},
{
"dataElement": "RATE CODE",
"oldValue": "1MBOE",
"newValue": "1MBOE",
"scopeFrom": "2020-08-31",
"scopeTo": "2020-09-01"
},
{
"dataElement": "SOURCE CODE",
"oldValue": "REF",
"newValue": "REF",
"scopeFrom": "2020-08-31",
"scopeTo": "2020-09-01"
},
{
"dataElement": "CONNECTING YN",
"oldValue": "N",
"newValue": "N"
},
{
"dataElement": "FIXED RATE",
"oldValue": "Y",
"newValue": "Y"
},
{
"dataElement": "PRINT RATE YN",
"oldValue": "Y",
"newValue": "Y"
},
{
"dataElement": "BLOCK CODE"
},
{
"dataElement": "RESERVATION TYPE",
"oldValue": "CHECKED IN",
"newValue": "CHECKED IN"
},
{
"dataElement": "ORIGIN"
},
{
"dataElement": "EXT SEG NO"
},
{
"dataElement": "SHARE YN",
"oldValue": "N",
"newValue": "N"
},
{
"dataElement": "PAYMENT METHOD",
"oldValue": "CA",
"newValue": "CA"
},
{
"dataElement": "PAYMENT METHOD DESC",
"oldValue": "Cash",
"newValue": "Cash"
},
{
"dataElement": "CREDIT CARD NUMBER"
},
{
"dataElement": "CREDIT CARD EXPIRATION DATE"
},
{
"dataElement": "AUTHORIZER"
},
{
"dataElement": "EXTERNAL USER ID"
},
{
"dataElement": "CREDIT CARD TYPE"
},
{
"dataElement": "DISCOUNT AMOUNT"
},
{
"dataElement": "DISCOUNT PERCENT"
},
{
"dataElement": "DISCOUNT REASON"
},
{
"dataElement": "SPECIAL REQUEST"
},
{
"dataElement": "ROOM FEATURES"
},
{
"dataElement": "PRODUCTS"
},
{
"dataElement": "PROMOTIONS"
},
{
"dataElement": "NO POST",
"oldValue": "N",
"newValue": "N"
},
{
"dataElement": "VIDEO CHECKOUT",
"oldValue": "N",
"newValue": "N"
},
{
"dataElement": "AUTHORIZE DIRECT BILL",
"oldValue": "N",
"newValue": "N"
},
{
"dataElement": "YIELD MARKET TYPE"
},
{
"dataElement": "TAX TYPE"
},
{
"dataElement": "ARRIVAL TRANSPORT TYPE"
},
{
"dataElement": "ARRIVAL STATION CODE"
},
{
"dataElement": "ARRIVAL CARRIER CODE"
},
{
"dataElement": "ARRIVAL TRANSPORT CODE"
},
{
"dataElement": "ARRIVAL DATETIME"
},
{
"dataElement": "ARRIVAL TRANSPORT TIME"
},
{
"dataElement": "ARRIVAL ESTIMATE TIME"
},
{
"dataElement": "ARRIVAL TRANSPORTATION",
"oldValue": "N",
"newValue": "N"
},
{
"dataElement": "ARRIVAL COMMENTS"
},
{
"dataElement": "DEPARTURE TRANSPORT TYPE"
},
{
"dataElement": "DEPARTURE STATION CODE"
},
{
"dataElement": "DEPARTURE CARRIER CODE"
},
{
"dataElement": "DEPARTURE TRANSPORT CODE"
},
{
"dataElement": "DEPARTURE DATETIME"
},
{
"dataElement": "DEPARTURE TRANSPORT TIME"
},
{
"dataElement": "DEPARTURE ESTIMATE TIME"
},
{
"dataElement": "DEPARTURE TRANSPORTATION",
"oldValue": "N",
"newValue": "N"
},
{
"dataElement": "DEPARTURE COMMENTS"
},
{
"dataElement": "COMMISSION PAID TO",
"oldValue": "0",
"newValue": "0"
},
{
"dataElement": "COMMISSION PAYOUT TO",
"oldValue": "N",
"newValue": "N"
},
{
"dataElement": "TA RECORD LOCATOR"
},
{
"dataElement": "HURDLE RATE"
},
{
"dataElement": "RATEABLE VALUE"
},
{
"dataElement": "RESTRICTION OVERRIDE"
},
{
"dataElement": "HURDLE OVERRIDE"
},
{
"dataElement": "YIELD STATUS",
"oldValue": "N",
"newValue": "N"
},
{
"dataElement": "SPG UPGRADE REASON CODE",
"oldValue": "N",
"newValue": "N"
},
{
"dataElement": "SPG DISCLOSE ROOM TYPE YN",
"oldValue": "N",
"newValue": "N"
},
{
"dataElement": "APP USER",
"oldValue": "130509",
"newValue": "130509"
},
{
"dataElement": "EXTERNAL EFOLIO YN"
},
{
"dataElement": "FOLIO OPT IN"
},
{
"dataElement": "CHILDREN 1",
"oldValue": "0",
"newValue": "0"
},
{
"dataElement": "CHILDREN 2",
"oldValue": "0",
"newValue": "0"
},
{
"dataElement": "CHILDREN 3",
"oldValue": "0",
"newValue": "0"
},
{
"dataElement": "CONFIRMATION LETTER YN"
},
{
"dataElement": "WAITLIST PRIORITY"
},
{
"dataElement": "WAITLIST REASON CODE"
},
{
"dataElement": "WAITLIST REASON DESCRIPTION"
},
{
"dataElement": "INSERT DATE",
"oldValue": "2024-02-19T14:53:00",
"newValue": "2024-02-19T14:53:00"
},
{
"dataElement": "UPDATE DATE",
"oldValue": "2024-02-19T14:56:32",
"newValue": "2024-02-19T14:56:32"
},
{
"dataElement": "UPDATE USER",
"oldValue": "130509",
"newValue": "130509"
},
{
"dataElement": "FOLIO FLAG"
},
{
"dataElement": "UDF CHAR 01"
},
{
"dataElement": "UDF CHAR 02"
},
{
"dataElement": "UDF CHAR 03"
},
{
"dataElement": "UDF CHAR 04"
},
{
"dataElement": "UDF CHAR 05"
},
{
"dataElement": "UDF CHAR 06"
},
{
"dataElement": "UDF CHAR 07"
},
{
"dataElement": "UDF CHAR 08"
},
{
"dataElement": "UDF CHAR 09"
},
{
"dataElement": "UDF CHAR 10"
},
{
"dataElement": "UDF CHAR 11"
},
{
"dataElement": "UDF CHAR 12"
},
{
"dataElement": "UDF CHAR 13"
},
{
"dataElement": "UDF CHAR 14"
},
{
"dataElement": "UDF CHAR 15"
},
{
"dataElement": "UDF CHAR 16"
},
{
"dataElement": "UDF CHAR 17"
},
{
"dataElement": "UDF CHAR 18"
},
{
"dataElement": "UDF CHAR 19"
},
{
"dataElement": "UDF CHAR 20"
},
{
"dataElement": "UDF CHAR 21"
},
{
"dataElement": "UDF CHAR 22"
},
{
"dataElement": "UDF CHAR 23"
},
{
"dataElement": "UDF CHAR 24"
},
{
"dataElement": "UDF CHAR 25"
},
{
"dataElement": "UDF CHAR 26"
},
{
"dataElement": "UDF CHAR 27"
},
{
"dataElement": "UDF CHAR 28"
},
{
"dataElement": "UDF CHAR 29"
},
{
"dataElement": "UDF CHAR 30"
},
{
"dataElement": "UDF CHAR 31"
},
{
"dataElement": "UDF CHAR 32"
},
{
"dataElement": "UDF CHAR 33"
},
{
"dataElement": "UDF CHAR 34"
},
{
"dataElement": "UDF CHAR 35"
},
{
"dataElement": "UDF CHAR 36"
},
{
"dataElement": "UDF CHAR 37"
},
{
"dataElement": "UDF CHAR 38"
},
{
"dataElement": "UDF CHAR 39"
},
{
"dataElement": "UDF CHAR 40"
},
{
"dataElement": "UDF NUMBER 01"
},
{
"dataElement": "UDF NUMBER 02"
},
{
"dataElement": "UDF NUMBER 03"
},
{
"dataElement": "UDF NUMBER 04"
},
{
"dataElement": "UDF NUMBER 05"
},
{
"dataElement": "UDF NUMBER 06"
},
{
"dataElement": "UDF NUMBER 07"
},
{
"dataElement": "UDF NUMBER 08"
},
{
"dataElement": "UDF NUMBER 09"
},
{
"dataElement": "UDF NUMBER 10"
},
{
"dataElement": "UDF NUMBER 11"
},
{
"dataElement": "UDF NUMBER 12"
},
{
"dataElement": "UDF NUMBER 13"
},
{
"dataElement": "UDF NUMBER 14"
},
{
"dataElement": "UDF NUMBER 15"
},
{
"dataElement": "UDF NUMBER 16"
},
{
"dataElement": "UDF NUMBER 17"
},
{
"dataElement": "UDF NUMBER 18"
},
{
"dataElement": "UDF NUMBER 19"
},
{
"dataElement": "UDF NUMBER 20"
},
{
"dataElement": "UDF NUMBER 21"
},
{
"dataElement": "UDF NUMBER 22"
},
{
"dataElement": "UDF NUMBER 23"
},
{
"dataElement": "UDF NUMBER 24"
},
{
"dataElement": "UDF NUMBER 25"
},
{
"dataElement": "UDF NUMBER 26"
},
{
"dataElement": "UDF NUMBER 27"
},
{
"dataElement": "UDF NUMBER 28"
},
{
"dataElement": "UDF NUMBER 29"
},
{
"dataElement": "UDF NUMBER 30"
},
{
"dataElement": "UDF NUMBER 31"
},
{
"dataElement": "UDF NUMBER 32"
},
{
"dataElement": "UDF NUMBER 33"
},
{
"dataElement": "UDF NUMBER 34"
},
{
"dataElement": "UDF NUMBER 35"
},
{
"dataElement": "UDF NUMBER 36"
},
{
"dataElement": "UDF NUMBER 37"
},
{
"dataElement": "UDF NUMBER 38"
},
{
"dataElement": "UDF NUMBER 39"
},
{
"dataElement": "UDF NUMBER 40"
},
{
"dataElement": "UDF DATE 01"
},
{
"dataElement": "UDF DATE 02"
},
{
"dataElement": "UDF DATE 03"
},
{
"dataElement": "UDF DATE 04"
},
{
"dataElement": "UDF DATE 05"
},
{
"dataElement": "UDF DATE 06"
},
{
"dataElement": "UDF DATE 07"
},
{
"dataElement": "UDF DATE 08"
},
{
"dataElement": "UDF DATE 09"
},
{
"dataElement": "UDF DATE 10"
},
{
"dataElement": "UDF DATE 11"
},
{
"dataElement": "UDF DATE 12"
},
{
"dataElement": "UDF DATE 13"
},
{
"dataElement": "UDF DATE 14"
},
{
"dataElement": "UDF DATE 15"
},
{
"dataElement": "UDF DATE 16"
},
{
"dataElement": "UDF DATE 17"
},
{
"dataElement": "UDF DATE 18"
},
{
"dataElement": "UDF DATE 19"
},
{
"dataElement": "UDF DATE 20"
},
{
"dataElement": "PARENT RESV NAME ID"
},
{
"dataElement": "SPLIT YN",
"newValue": "N"
},
{
"dataElement": "WALK IN",
"newValue": "N"
},
{
"dataElement": "VIP STATUS"
},
{
"dataElement": "LANGUAGE",
"oldValue": "E",
"newValue": "E"
},
{
"dataElement": "TITLE",
"oldValue": "MR",
"newValue": "MR"
},
{
"dataElement": "GUEST MESSAGE YN",
"oldValue": "N",
"newValue": "N"
},
{
"dataElement": "COMP TYPE"
},
{
"dataElement": "CREDIT CARD VAULT ID"
},
{
"dataElement": "CREDIT CARD NUMBER 4 DIGITS"
},
{
"dataElement": "BASE RATE CODE"
},
{
"dataElement": "LOCAL BASE RATE AMOUNT"
},
{
"dataElement": "BASE RATE CURRENCY CODE"
},
{
"dataElement": "TURNDOWN DATE"
},
{
"dataElement": "TURNDOWN STATUS",
"oldValue": "NR",
"newValue": "NR"
}
]
},
"businessEventId": {
"id": "6258146"
}
}
]
}
|
|
4
|
Post the charge to the reservation
account.
Partner system sends Posting charge using the postBillingCharges
operation containing all amounts to post to the reservation account.
OPERA Cloud responds with a 201 response message when the posting is
successful.
Note that the postBillingCharge call must include the reservationId,
the revenue transactionCode, and the cashierId.
It is possible to send a single postBillingCharges call against the
guest account containing multiple sub-amounts (revenue amounts
and/or tax amounts).
Usually used by Restaurant POS or other systems that charge full
guest checks to the guest account or to a Paymaster account (such as
for revenue paid by Cash or credit card).
Post the charge to a non-room account (Paymaster account).
Non-Room charges are Cash, Creditcard postings from a property System
(Restaurant POS, SPA, Golf) that a customer wants posted to a
specific account in OPERA Cloud PMS. These virtual accounts are
called Posting accounts or Paymaster accounts.
These accounts are set up in OPERA Cloud as pseudo rooms that are
defined for the system's non-room payment method.
For example, a cash payment Restaurant POS charge will be posted to
its respective Posting Master with the revenue amount and against
the revenue transaction code.
Usually these Posting Master accounts will be checked-in for a day,
checked out before night audit, and checked-in again after night
audit. Depending on the customer usage, these Paymaster accounts
might get a new reservationId.
Posting charges to these Posting accounts works the same way as
posting charges to a guest reservation account. Each Posting account
has its own reservationId that must be sent to identify the account
in OPERA Cloud PMS.
Post the revenue to the payment account.
Partner requests Posting account reservation information using the
getReservation operation. Typically using query parameter "roomId"
or "surname" of the Posting account.
OPERA Cloud responds with 200 containing the reservation
information.
User of partner system confirms the reservation information is
correct as received from the guest.
The partner sends a charge posting using the postBillingCharges
operation containing all amounts to post to the paymaster
account.
OPERA Cloud responds with 201 containing confirmation of posting
accepted and completed.
|
postBillingCharges
postBillingCharges with two sub-amounts
POST {{HostName}}/csh/v1/hotels/{{HotelId}}/reservations/{{ReservationId}}/charges
{
"criteria": {
"hotelId": "SAND01",
"charges": [
{
"transactionCode": "2010",
"articleCode": "",
"price": {
"amount": 27.33,
"currencyCode": "USD"
},
"postingQuantity": 1,
"postingReference": "Restaurant Food",
"postingRemark": "Buffet",
"checkNumber": "2024011101",
"arrangementCode": "",
"applyRoutingInstructions": false,
"usePackageAllowance": false,
"autoPosting": true,
"financialTransactionIdList": [
{
"id": "Vendor trans ID",
"type": ""
}
],
"folioWindowNo": 1,
"cashierId": 113
},
{
"transactionCode": "8002",
"articleCode": "",
"price": {
"amount": 2.67,
"currencyCode": "USD"
},
"postingQuantity": 1,
"postingReference": "Tax 14%",
"postingRemark": "Food",
"checkNumber": "2024011101",
"arrangementCode": "",
"applyRoutingInstructions": false,
"usePackageAllowance": false,
"autoPosting": true,
"financialTransactionIdList": [
{
"id": "Vendor trans ID",
"type": ""
}
],
"folioWindowNo": 1,
"cashierId": 113
}
],
"reservationId": {
"url": "string",
"type": "string",
"instance": "string",
"idContext": "string",
"id": "{{ReservationId}}",
"idExtension": 0
},
"incomeAuditDate": "2024-01-11",
"postIt": false,
"cashierId": 113,
"welcomeOfferPosting": true
},
"links": [
{
"href": "string",
"rel": "string",
"templated": false,
"method": "GET",
"targetSchema": "string",
"operationId": "string",
"title": "string"
}
]
}
201 Response:
{
"postings": [
{
"remark": "Food",
"reference": "Tax 14% 2024011101",
"checkNo": "2024011101",
"postedAmount": {
"amount": 2.67,
"currencyCode": "USD"
},
"price": {
"amount": 2.67,
"currencyCode": "USD"
},
"quantity": 1,
"transactionType": "Revenue",
"debitAmount": {
"amount": 2.67,
"currencyCode": "USD"
},
"cashierInfo": {
"cashierId": 113,
"cashierName": "MBOE Cashier"
},
"paidOut": false,
"exchange": {
"debitAmount": {
"amount": 2.67,
"currencyCode": "USD"
}
},
"stampDuty": false,
"customCharge": false,
"transactionNo": 332713,
"transactionDate": "2024-01-11",
"transactionCode": "8002",
"transactionAmount": 2.67,
"postingDate": "2024-01-11",
"postingTime": {
"time": "2024-01-11 15:12:19.0",
"timezone": "UTC"
},
"revenueDate": "2024-01-11",
"roundingDifferenceTrx": false,
"folioWindowNo": 1,
"deferredTax": false
}
],
"trxCodesInfo": [
{
"description": "Restaurant Food",
"transactionGroup": "REV",
"transactionSubGroup": "FB",
"trxServiceType": "S",
"transactionCode": "2010",
"hotelId": "SAND01CN",
"printTrxReceipt": false
},
{
"description": "VAT 14%",
"transactionGroup": "REV",
"transactionSubGroup": "VAT",
"trxServiceType": "S",
"transactionCode": "8002",
"hotelId": "SAND01CN",
"printTrxReceipt": false
}
]
}
Posting charges to Paymaster
POST {{HostName}}/csh/v1/hotels/{{HotelId}}/reservations/95825/charges
{
"criteria": {
"hotelId": "SAND01CN",
"charges": [
{
"transactionCode": "2000",
"articleCode": "",
"price": {
"amount": 30.00,
"currencyCode": "USD"
},
"postingQuantity": 1,
"postingReference": "Restaurant Breakfast",
"postingRemark": "Breakfast Buffet",
"checkNumber": "2024020701",
"arrangementCode": "",
"applyRoutingInstructions": false,
"usePackageAllowance": false,
"autoPosting": true,
"financialTransactionIdList": [
{
"id": "Vendor trans ID",
"type": "string"
}
],
"folioWindowNo": 1,
"cashierId": 113
}
],
"reservationId": {
"url": "string",
"type": "string",
"instance": "string",
"idContext": "string",
"id": "95825",
"idExtension": 0
},
"incomeAuditDate": "2024-02-07",
"postIt": false,
"cashierId": 113,
"welcomeOfferPosting": true
},
"links": [
{
"href": "string",
"rel": "string",
"templated": false,
"method": "GET",
"targetSchema": "string",
"operationId": "string",
"title": "string"
}
]
}
201 Response:
{
"postings": [
{
"remark": "Breakfast Buffet",
"reference": "Restaurant Breakfast 2024020701",
"checkNo": "2024020701",
"postedAmount": {
"amount": 30,
"currencyCode": "USD"
},
"price": {
"amount": 30,
"currencyCode": "USD"
},
"quantity": 1,
"transactionType": "Revenue",
"debitAmount": {
"amount": 30,
"currencyCode": "USD"
},
"cashierInfo": {
"cashierId": 113,
"cashierName": "MBOE Cashier"
},
"paidOut": false,
"exchange": {
"debitAmount": {
"amount": 30,
"currencyCode": "USD"
}
},
"stampDuty": false,
"customCharge": false,
"transactionNo": 339390,
"transactionDate": "2024-02-06",
"transactionCode": "2000",
"transactionAmount": 30,
"postingDate": "2024-02-06",
"postingTime": {
"time": "2024-02-07 07:56:08.0",
"timezone": "UTC"
},
"revenueDate": "2024-02-06",
"roundingDifferenceTrx": false,
"folioWindowNo": 1,
"deferredTax": false
},
{
"referenceTransactionNo": 339390,
"reference": "[Add: 14%.(B)]2024020701",
"checkNo": "2024020701",
"postedAmount": {
"amount": 4.2,
"currencyCode": "USD"
},
"price": {
"amount": 4.2,
"currencyCode": "USD"
},
"quantity": 1,
"transactionType": "Revenue",
"debitAmount": {
"amount": 4.2,
"currencyCode": "USD"
},
"cashierInfo": {
"cashierId": 113,
"cashierName": "MBOE Cashier"
},
"paidOut": false,
"exchange": {
"debitAmount": {
"amount": 4.2,
"currencyCode": "USD"
}
},
"stampDuty": false,
"customCharge": false,
"transactionNo": 339391,
"transactionDate": "2024-02-06",
"transactionCode": "8002",
"transactionAmount": 4.2,
"postingDate": "2024-02-06",
"postingTime": {
"time": "2024-02-07 07:56:08.0",
"timezone": "UTC"
},
"revenueDate": "2024-02-06",
"roundingDifferenceTrx": false,
"folioWindowNo": 1,
"deferredTax": false
}
],
"trxCodesInfo": [
{
"description": "Breakfast",
"transactionGroup": "REV",
"transactionSubGroup": "FB",
"trxServiceType": "S",
"transactionCode": "2000",
"hotelId": "SAND01CN",
"printTrxReceipt": true
},
{
"description": "VAT 14%",
"transactionGroup": "REV",
"transactionSubGroup": "VAT",
"trxServiceType": "S",
"transactionCode": "8002",
"hotelId": "SAND01CN",
"printTrxReceipt": false
}
]
}
|
