OPERA Cloud Front Desk Operations Service
APIs to cater for Front Desk Operations and Front Desk Statistic functionality in OPERA Cloud. Front Desk features some of the most commonly used operations in OPERA Cloud, such as managing guest arrivals, managing in-house guests, and managing guest departures. Some additional tasks you can complete from the Front Desk menu are room searches, room assignments, and quick check outs as well as opening folios, creating registration cards, setting wake up calls, and sending messages to guests. Compatible with OPERA Cloud release 26.2.0.0. 91 operation(s) documented; base path /fof/v1. Harvested verbatim from Oracle's public hospitality-api-docs repository (Swagger 2.0, release 26.2.0.0).
OPERA Cloud Front Desk Operations Service is one of 135 APIs that Oracle Hospitality publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include FOFStats, FrontDeskOperations, Commissions, Property Management, and OPERA Cloud. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 91 operations across 70 paths, organized into 3 resource areas, and defines 684 schemas. It is described by OpenAPI 2.0, at version 26.2.0.0.
91 operations
70 paths
684 schemas
11 DELETE40 GET19 POST21 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 91
Across 70 paths, the API surfaces 91 operations — 11 DELETE, 40 GET, 19 POST, 21 PUT. They span 3 resource areas: FrontDeskOperations, Commissions, FOFStats. Each is listed below with its method, path, parameters, and response codes.
FrontDeskOperations 61
Front Desk module provides APIs related to a guests stay in the property. For example, checking a guest into the property, providing room information, splitting reservations, as w…
GET
/hotels/{hotelId}/authorizationReservations
Get resrvation for batch CCAuth
PUT
/hotels/{hotelId}/batchReservationAuthorizations
Process batch CC Auth
GET
/hotels/{hotelId}/billingReservations
Get Reservations for billing
GET
/hotels/{hotelId}/dailyDocket
Get Daily Docket
PUT
/hotels/{hotelId}/dailyDocket
Change Daily Docket
POST
/hotels/{hotelId}/dailyDocket
Create Daily Docket
DELETE
/hotels/{hotelId}/dailyDocket/{docketId}
Delete Daily Docket
POST
/hotels/{hotelId}/externalRoomKeysdeprecated
Requests room key(s)
GET
/hotels/{hotelId}/floorPlans
Get floor plans
GET
/hotels/{hotelId}/fulfillmentActivityLogs
Get the fullfillment activity log
GET
/hotels/{hotelId}/interfaces/{interfaceId}/roomStatuses
Get room interface status
PUT
/hotels/{hotelId}/interfaces/{interfaceId}/roomStatuses
Change room interface status
GET
/hotels/{hotelId}/keyInterfaces
Get key encoder interface configuration details
GET
/hotels/{hotelId}/queuedReservations
Get the reservation in queue
PUT
/hotels/{hotelId}/queuedReservations/{reservationId}
Add reservation to queue
DELETE
/hotels/{hotelId}/queuedReservations/{reservationId}
Delete reservation from queue
GET
/hotels/{hotelId}/reservationSummaries
Get reservation summaries
POST
/hotels/{hotelId}/reservations/ai/rooms
AI Assign Rooms
GET
/hotels/{hotelId}/reservations/ai/rooms
Automated Intelligence Room Assignment last run status
POST
/hotels/{hotelId}/reservations/autoRoomAssignments
Assign the room automatically
DELETE
/hotels/{hotelId}/reservations/autoRoomAssignments
Auto unassign room
POST
/hotels/{hotelId}/reservations/massAdvanceCheckIns
Mass Advance Check in Reservations
POST
/hotels/{hotelId}/reservations/massCheckIns
Mass checkin reservations
POST
/hotels/{hotelId}/reservations/{reservationId}/advanceCheckIns
Advance checkin a reservation
DELETE
/hotels/{hotelId}/reservations/{reservationId}/advanceCheckIns
Reverse Advance Checkin
DELETE
/hotels/{hotelId}/reservations/{reservationId}/checkIns
Revert a checked-in Reservation
POST
/hotels/{hotelId}/reservations/{reservationId}/checkIns
Checks in a guest
GET
/hotels/{hotelId}/reservations/{reservationId}/keyOptions
Fetch the keysOptions
GET
/hotels/{hotelId}/reservations/{reservationId}/linked
Get linked reservations
PUT
/hotels/{hotelId}/reservations/{reservationId}/priority
Change the reservation queue priority
POST
/hotels/{hotelId}/reservations/{reservationId}/roomAssignments
Assign a Room to a Reservation
GET
/hotels/{hotelId}/reservations/{reservationId}/roomKeys
Fetch the room keys
POST
/hotels/{hotelId}/reservations/{reservationId}/roomKeys
Requests room key(s)
DELETE
/hotels/{hotelId}/reservations/{reservationId}/roomKeys
Delete room key
PUT
/hotels/{hotelId}/reservations/{reservationId}/roomKeys
Update room keys.
GET
/hotels/{hotelId}/reservations/{reservationId}/roomMoveHistory
Get room move history of a reservation
PUT
/hotels/{hotelId}/reservations/{reservationId}/rooms
Remove an assigned room
PUT
/hotels/{hotelId}/reservations/{reservationId}/rooms/{roomId}/roomMoves
Move in-house guest
GET
/hotels/{hotelId}/reservations/{reservationId}/suggestedRooms
Get Suggested Rooms
PUT
/hotels/{hotelId}/reservations/{reservationId}/textMessages/{messageType}
Deliver Queue rooms text message
GET
/hotels/{hotelId}/reservations/{reservationId}/verifyCheckIns
Verify checkin reservation
GET
/hotels/{hotelId}/reservations/{reservationId}/wakeUpCalls
Get Wake Up Call
PUT
/hotels/{hotelId}/reservations/{reservationId}/wakeUpCalls
Change Wake Up Call
DELETE
/hotels/{hotelId}/reservations/{reservationId}/wakeUpCalls
Delete Wake Up Call
POST
/hotels/{hotelId}/reservations/{reservationId}/wakeUpCalls
Create Wake Up Call
GET
/hotels/{hotelId}/reservationsKeyOptions
Fetch keysOptions for the reservation and the guest profile
GET
/hotels/{hotelId}/roomKeysDetails
Read room key
POST
/hotels/{hotelId}/roomKeysExternal
Requests room key(s)
GET
/hotels/{hotelId}/rooms
Get hotel rooms
POST
/hotels/{hotelId}/rooms/onHold
Place Rooms On Hold
POST
/hotels/{hotelId}/rooms/onHold/release
Release Rooms On Hold
GET
/hotels/{hotelId}/serviceRequests
Get Service Requests
PUT
/hotels/{hotelId}/serviceRequests
Change Service Requests
POST
/hotels/{hotelId}/serviceRequests
Create Service Requests
DELETE
/hotels/{hotelId}/serviceRequests/{serviceRequestId}
Delete Service Requests
PUT
/hotels/{hotelId}/sourceReservations/{sourceReservationId}/targetReservations/{targetReservationId}/shiftRooms
Operation for Shift Rooms between two reservations
PUT
/hotels/{hotelId}/sourceReservations/{sourceReservationId}/targetReservations/{targetReservationId}/swapRooms
Operation for Swap/Shift Rooms between two reservations
GET
/hotels/{hotelId}/textMessages/{messageType}
Get Queue room text message
GET
/hotels/{hotelId}/wakeUpCallsdeprecated
Get Wake Up Calls
POST
/hotels/{hotelId}/wakeUpCalls/searches
Get Wake Up Calls
GET
/services/frontDeskOperations/status
Ping Front Desk Service
Commissions 23
Commission web service provides commission processing service like payment processing, payment activity and search.
GET
/hotels/{hotelId}/bankAccountsdeprecated
Operation to fetch bank accounts.
POST
/hotels/{hotelId}/bankAccounts/searches
Operation to fetch bank accounts.
GET
/hotels/{hotelId}/bankAccounts/{bankAccountId}/agents/{agentId}/reservationsForCommissionsdeprecated
Operation to fetch Reservations for Commissions associated to a Travel Agent
POST
/hotels/{hotelId}/bankAccounts/{bankAccountId}/agents/{agentId}/reservationsForCommissions/searches
Operation to fetch Reservations for Commissions associated to a Travel Agent
PUT
/hotels/{hotelId}/bankAccounts/{bankAccountId}/commissionChecks
Operation to change commission check.
GET
/hotels/{hotelId}/bankAccounts/{bankAccountId}/commissionPayments
Operation to fetch commission payments activity.
PUT
/hotels/{hotelId}/bankAccounts/{bankAccountId}/commissionPayments
Operation to change commission payment activity by range.
PUT
/hotels/{hotelId}/bankAccounts/{bankAccountId}/reprintCommission
Operation to reprint commission check by range.
GET
/hotels/{hotelId}/bankAccounts/{bankAccountId}/travelAgentsForCommissions
Operation to fetch Travel Agents associated with commissions for the given bank Account.
PUT
/hotels/{hotelId}/commissionAgent/{commissionAgentId}/commissions
Operation to associate commission agent to reservations.
DELETE
/hotels/{hotelId}/commissionAgent/{commissionAgentId}/commissions
Operation to remove commission agent from reservations.
DELETE
/hotels/{hotelId}/commissionChecks
Operation to discard commission checks.
PUT
/hotels/{hotelId}/commissionPayments
Operation to process commission payments.
GET
/hotels/{hotelId}/commissions
Operation to fetch commissions. The search results are filtered based on the provided criteria, with a specific hierarchy applied when multiple parameters are specified. The filtering parameters are…
PUT
/hotels/{hotelId}/commissions
Operation to calculate commissions.
POST
/hotels/{hotelId}/commissions/instructions
Operation to set processing instructions.
GET
/hotels/{hotelId}/commissions/{commissionId}
Operation to fetch commission.
PUT
/hotels/{hotelId}/commissions/{commissionId}
Operation to change commission.
DELETE
/hotels/{hotelId}/commissions/{commissionId}
Operation to remove commission.
PUT
/hotels/{hotelId}/commissions/{commissionId}/commissionCodes/{commissionCode}/recalculate
Operation to recalculate commission on code change.
GET
/hotels/{hotelId}/reservations/{reservationId}/commissionNotes
Operation to fetch commission notes.
GET
/hotels/{hotelId}/reservations/{reservationId}/commissionPaymentDetails
Fetch Commission Payment Details
GET
/services/commissions/status
Ping Commissions
FOFStats 7
The Front Desk Statistics module will provide statistical data related to front desk operations in a property.
GET
/hotels/{hotelId}/frontOfficeStatistics/{statisticsCode}
Get front office Statistics
GET
/hotels/{hotelId}/frontOfficeStatisticsRange/{statisticsCode}
Get front office Statistics
GET
/hotels/{hotelId}/houseKeepingStatistics
Get housekeeping statistics
GET
/hotels/{hotelId}/queueReservationsStatistics
Get reservation queue statistics
GET
/hotels/{hotelId}/reservationStatusStatistics
Get Reservation Status Statistics
GET
/hotels/{hotelId}/roomStatusStatistics
Get counts of rooms by housekeeping status and front office status.
GET
/services/fofStats/status
Ping FOF
Schemas 684
The contract defines 684 schemas that model the data the API accepts and returns. The most detailed are hotelReservationType (101 properties), profileType (55 properties), reservationInfoType (53 properties), roomRateType (43 properties). Each schema is shown below with its type and property counts.
resvForBatchCCAut
object
Response which contains a listing of reservations, and associated payment methods, that require credit card authorization.
4 properties
codeType
string
Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.
reservationsForCCAuthType
array
List of reservations with their payment methods.
reservationForCCAuthType
object
Reservation details, including a list of the associated payment methods.
13 properties
reservationId
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
6 properties
housekeepingRoomReservationStatusType
string
Room Reservation status types used in housekeeping. These may be different from the actual reservation statuses as these relate to the current reservation for…
stayDateInfoType
object
Room attached with stay detail information
2 properties
timeSpanType
object
Allows for a choice in description of the amount of time spanned by this type. EndDate specifies a specific date, while Duration provides a measure of time to…
3 properties
resExpectedTimesType
object
Holds the Arrival and Departure Time Information
2 properties
vIPStatusType
object
VIP status of the customer.
2 properties
uniqueID_Type
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
2 properties
reservationPaymentMethodsType
array
Defines reservation payment methods.
reservationPaymentMethodType
object
8 properties
resPaymentCardType
object
Information on a credit card for the customer.
19 properties
currencyAmountType
object
A monetary value expressed with a currency code.
2 properties
cardTypeType
string
This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method.
cardProcessingType
string
cardNumberTypeType
string
Simple type for indicating if credit card number is tokenized.
authorizationRuleType
object
Configured rule for computing the amount to authorize.
3 properties
emailType
object
Information on an email for the customer.
11 properties
links
array
instanceLink
object
Metadata describing link description objects that MAY appear in the JSON instance representation.
7 properties
warningsType
array
Used in conjunction with the Success element to define a business error.
warningType
object
Used when a message has been successfully processed to report any warnings or business errors that occurred.
10 properties
exceptionDetailType
object
Complex type that contains error details for a REST call.
9 properties
2 required
errorInstance
object
Complex type that contains error instance details for a REST call.
7 properties
2 required
bankAccountsDetails
object
Returns bank accounts that match the request criteria.
3 properties
bankAccountsType
array
List of bank accounts.
bankAccountType
object
Bank account information like Account ID, Bank Name, Currency, etc.
13 properties
commissionPaymentMethodType
object
This contains a generic code and description information.
3 properties
codeDescriptionType
object
This contains a generic code and description information.
2 properties
commissionCheckToBeChanged
object
Request type for updating commission check.
3 properties
changeCommissionCheckCriteriaType
object
Base type for payment activity information
5 properties
commissionCheckStatus
object
Response Body.
2 properties
commissionPaymentsActivityDetails
object
Response type for commission payments activity.
3 properties
commissionPaymentsActivityType
array
List of payment activity information
commissionPaymentActivityType
object
Base type for payment activity information
13 properties
commissionPaymentActivityStatusType
string
Simple type for payment activity status type. Valid values are Outstanding, Reconciled, Unpresented and Void.
commissionPaymentActivityByRangeToBeChanged
object
Request type for updating a range of payments activity.
3 properties
changeCommissionPaymentActivityRangeCriteriaType
object
Base type for payment activity information
5 properties
numberRangeType
object
Date Range with Start and End dates.
2 properties
commissionPaymentActivityStatusCriteriaType
object
Criteria for updating status of a range of payment activity .
2 properties
commissionPaymentActivityByRangeStatus
object
Response Body.
2 properties
reprintCommissionCheckByRange
object
Request type for reprinting a range of check payments.
3 properties
reprintCommissionCheckRangeCriteriaType
object
Base type for payment activity information
6 properties
reprintCommissionCheckByRangeStatus
object
Response type for reprinting a range of check payments.
3 properties
commissionPaymentReportType
object
Contains report id, batch id (for check payments) or export file (for eft payments)
5 properties
batchCCAuth
object
Request to start a batch job that will process a list of reservation, and their associated payment methods, that require credit card authorizations.
4 properties
batchCCAuthToProcess
object
Response for starting a credit card authorization batch job, which contains the batch ID upon success.
4 properties
stringLength200
string
Used for Character Strings, length 0 to 200.
reservationsInfo
object
Response object to the Fetch Reservation Request operation. Based on the criteria, reservation information is returned.
4 properties
reservationInfoType
object
The Reservation class contains the current reservation being created or altered.
53 properties
reservationIdList
array
Unique Id that references an object uniquely in the system.
externalReferencesType
array
This type contains unique information of external reference.
externalReferenceType
object
This type contains unique information of external reference.
3 properties
stayInfoType
object
Details on the Room Stay including Guest Counts, Time Span of this Room Stay, pointers to Res Guests, guest Memberships, Comments and Special Requests pertaini…
37 properties
pointsType
object
The Redeem Points contains the number of points required to book a room type.
2 properties
reservationBlockType
object
Key information about the block for a reservation.
3 properties
blockIdList
array
Unique Id that references an object uniquely in the system.
resGuaranteeType
object
Validations type record returned after Validations are done.
3 properties
promotionType
object
Type to specify a rate promotion. Usually attached to a reservation to indicate a specific promotion is applied to the reservation.
3 properties
guestHousekeepingServiceRequestType
string
Possible values for the Guest Service Status.
resGuestInfoType
object
Specifies Company or Travel Agent profile using IATA or Corp. No.
30 properties
membershipInfoType
object
The Membership object identifies the frequent customer reward program.
8 properties
namePrefixType
string
Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.)
givenNameType
string
Given name, first name or names
surnameType
string
Family name, last name.
phoneNumberType
string
Phone number
basicEmailType
string
Email address
countryNameType
object
Code for a country or a nationality.
4 properties
vIPType
object
The supplier's ranking of the customer.
2 properties
addressSearchType
object
Address Details such as city, state, country, postal code etc.
6 properties
anonymizationType
object
Provides information about guest's anonymization status.
2 properties
anonymizationStatusType
string
Guest has been anonymized.
resAccompanyGuestListType
array
Collection of accompany guests
resAccompanyGuestInfoType
object
5 properties
profileIdList
array
Unique Id that references an object uniquely in the system.
resGuestExternalInfoType
object
Specifies Company or Travel Agent profile using IATA or Corp. No.
2 properties
guestLastStayInfoType
object
Contains last stay related details of the guest.
4 properties
nameTypeType
string
resSharedGuestListType
array
Collection of shared guest reservations.
resSharedGuestInfoType
object
Contains information regarding the share reservation.
4 properties
profileId
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
6 properties
resAttachedProfileListType
array
resAttachedProfileType
object
3 properties
resProfileTypeType
string
reservationFolioWindowsType
array
Collection of reservation folio windows.
reservationFolioWindowType
object
Folio window view which holds the set of folios for a reservation.
4 properties
payeeInfoType
object
Payee information.
7 properties
addressInfoType
object
Provides address information.
3 properties
addressType
object
Provides address information.
19 properties
aRAccountShortInfoType
object
Accounts Receivabales Account details type charged for batched posting.
4 properties
aRAccountStatusType
object
Type for the Account Status. Status can be restricted and a message/description added to the Account.
3 properties
indicatorsType
array
Collection of lamp indicators.
indicatorType
object
Lamp indicator Type.
2 properties
housekeepingRoomStatusType
string
Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOf…
searchMatchesType
array
List of Generic Name-Value-Pair Parameters used for super search matches.
searchMatchType
object
Search match indicating attribute and the matching value.
2 properties
sourceOfSaleType
object
Point of Sale of reservation. Identifies the entity/channel who made the reservation.
2 properties
waitlistResType
object
Information regarding why reservation is being /has been waitlisted.
6 properties
reservationQueueInformationType
object
Information regarding the Date, Duration and Priority of the reservation on Queue for Check in.
6 properties
queueTextInfoType
object
Information regarding the message sent to guest.
2 properties
resHousekeepingType
object
Holds housekeeping turndown service information for the room.
7 properties
facilityTaskType
object
Information regarding facility task on a reservation.
3 properties
housekeepingTaskCodeType
object
Information related to a Task Code. Task Codes are used to generate task sheets in Rooms Management.
7 properties
facilityCodesType
array
List of the facility codes.
facilityCodeType
object
Facility Housekeeping Code, its description and quantity.
3 properties
resCashieringType
object
Cashiering Information for the reservation.
14 properties
resRevenueBalanceType
object
Revenue and Balance Amount summary for the reservation.
10 properties
billingPrivilegesType
object
This stores the information for Bed Tax Reporting. Mainly used in Maldives.
13 properties
reservationTaxTypeInfo
object
Provides information about the Tax Type.
9 properties
bedTaxReportingType
object
This stores the information for Bed Tax Reporting. Mainly used in Maldives.
5 properties
folioTextsType
array
This stores the description for the type of tax calculation especially with tax exemption, etc.
resPeriodicFolioType
object
Information regarding periodic folios set on the reservation.
3 properties
resCompAccountingType
object
Information regarding comp accounting on the reservation.
3 properties
resPreConfiguredRoutingInstrType
object
Instruction to attach Pre-Configured Routing Instructions to a Reservation.
4 properties
authorizerInfoType
object
Authorizer Information
5 properties
taxTypeType
object
Provides information about the Tax Type.
8 properties
reservationDepositType
object
Reservation Deposit Type.
7 properties
reservationAllowedActionsType
array
Allowed action.
reservationAllowedActionType
string
Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation.
reservationInterfaceStatusType
object
Hotel Interface Type for a reservation and status of the various services
3 properties
hotelInterfaceType
object
8 properties
hotelInterfaceTypeType
string
XML Posting Interface
hotelInterfaceStatusType
string
Status of the Hotel Interface either STOPPED or RUNNING.
interfaceRightsStatusType
object
4 properties
reservationTurndownInfoType
object
Turndown information for a reservation
2 properties
turndownStatusType
string
Simple type for turndown status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Required, Not Required and Complet…
resMobileNotificationsType
object
Contains the status of Room Ready and Key Ready messages.
5 properties
communicationStatusType
string
Enum to denote the Status of Readiness messages sent to Guest Devices.
resCommunicationType
object
Communication details for a reservation.
2 properties
telephoneInfoType
object
Information on a telephone number for the customer.
3 properties
telephoneType
object
Information on a telephone number for the customer.
12 properties
emailInfoType
object
Information on an email for the customer.
3 properties
advanceCheckInType
object
Information relating to Reservation's Advance Checked In state and Expected Time of Return
3 properties
pMS_ResStatusType
string
This reservation is in checked in status and the business date is past departure date. This could occur when ORS and PMS are in same environment.
resAccessRestrictionType
string
Indicates any Updates/Changes on the reservation as well as Reservation Cancellation are not allowed.
commissionPayoutToType
string
masterInfoType
object
2 properties
codeInfoType
object
4 properties
addtionalCodeInfoType
array
Holds name of additional code information
masterInfoCodeDetailType
string
masterType
string
associateCommissionAgentToReservations
object
Request type for associating reservations to Travel Agent or Source Profile.
5 properties
commissionAgentIDType
object
Type which contains the Commission Agent id and its type.
3 properties
commissionAgentTypeType
string
Simple type for commission agent type. Valid values are Agent and Source.
hotelReservationsIDType
object
List of Reservation Unique identifiers to represent multiple reservations with each reservation's one unique id.
2 properties
commissionReservationInstructionsType
string
Type for commission reservation instructions.
associateCommissionAgentToReservationsStatus
object
Response type for associating reservations to Travel Agent or Source Profile.
3 properties
commissionReservationFailuresType
array
Reservation that wasn't successfully associated with the agent.
commissionReservationFailureType
object
Collection of error and warning if any.
3 properties
errorsType
array
An error that occurred during the processing of a message.
errorType
object
Standard way to indicate that an error occurred during the processing of an message. If the message successfully processes, but there are business errors, thos…
10 properties
status
object
Response Body.
2 properties
processCommissionPayments
object
Request type for processing commission payments.
3 properties
processCommissionPaymentsCriteriaType
object
Generic commission criteria including hotel code, bank account id, agent id, reservation id and/or commission id
7 properties
processCommissionPaymentsStatus
object
Response type for processing commission payments.
3 properties
commissionsDetails
object
Commissions for the requested account or agent id.
9 properties
commissionInfoListType
array
List of commission info.
commissionInfoType
object
Commission processing information including related bank, agents or source and funds details.
3 properties
commissionAgentsType
array
Agent or source profiles that were returned by the search.
commissionAgentType
object
Agent or source information along with their commission details.
2 properties
agentInfoType
object
Agent or source commission information.
12 properties
profileTypeType
string
The types of Profile handled by the web service.
commissionCodeType
object
Type for commission code info.
2 properties
commissionDetailsType
array
Commission details related to the stays for which the agent or source is eligible to receive commissions.
commissionDetailType
object
Criteria for updating a commission record.
29 properties
commissionStatusType
string
Simple type for commission status. Valid values are Unpaid and Paid.
commissionSummaryType
object
Summary of the commission payment information totaled for all agents/sources.
4 properties
calculateCommissions
object
Request type for calculation of commission for all Travel Agent and/or Source.
2 properties
calculateCommissionsStatus
object
Response Body.
2 properties
setProcessingInstructions
object
Request Type for setting instructions for commission processing on Agent or Reservation level.
3 properties
commissionProcessingAgentsType
array
Commission processing instructions for an Agent.
commissionProcessingAgentType
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
9 properties
commissionProcessingInstructionsType
object
Type for commission process instruction. Possible instruction types are on hold and offset AR.
3 properties
commissionProcessingReservationsType
array
Commission processing instructions for a reservation.
commissionProcessingReservationType
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
7 properties
commissionDetails
object
Response type for fetch commission detail.
3 properties
commissionToBeChanged
object
Request type for update of commission detail.
3 properties
commissionBaseDetailType
object
Criteria for updating a commission record.
6 properties
commissionStatus
object
Response Body.
2 properties
recalculateCommissionOnCodeChange
object
Request type for recalculating commission amount when commission code of unpaid commission is changed.
2 properties
recalculateCommissionOnCodeChangeStatus
object
Response type for recalculating commission amount when commission code of unpaid commission is changed
3 properties
dailyDocket
object
Response object for fetching log book entries.
3 properties
dailyDocketType
array
log book entry.
dailyDocketEntryType
object
Log book entry.
7 properties
roleUserEntryType
object
Role or User in which the log book entry belongs to.
2 properties
changeHistoryType
object
Creation date time, Creator Id, last modification date time and last Modifier Id.
5 properties
floorPlans
object
Response object to the Fetch Reservation Request operation. Based on the criteria, reservation information is returned.
3 properties
floorPlanType
object
Floor information containing collection of Room records that contain Housekeeping and Out Of Order information.
4 properties
floorPlanRoomType
object
This type represents the primary room attributes.
27 properties
roomTypeShortInfoType
object
Basic information of room type.
14 properties
ratePlanRatingType
string
Possible Rate plan rating values.
roomFeaturesType
array
A recurring element that identifies the room features.
roomFeatureType
object
Room Feature Information.
4 properties
translationTextType2000
object
Contains Multiple translated texts and language codes.
2 properties
translationsTextType
array
Language code for the translation.
roomSectionType
object
2 properties
housekeepingType
object
Identifies the Housekeeping information.
7 properties
roomStatusType
object
4 properties
frontOfficeRoomStatusType
string
Simple type for front office room status instructions to be used in requests for fetching housekeeping rooms. Valid values are Vacant and Occupied.
roomPersonsType
object
2 properties
roomCleaningPriorityType
object
Type to indicate the cleaning priority for a room.
1 property
roomConditionType
object
Condition to be assigned on the room.
3 properties
roomConditionAssigmentType
string
Simple type for Room Condition assignment type. Valid values are Available and NotAvailable Only.
codeListType
array
roomsOutOfOrderType
array
Date Range and reasons for a room being Out of Order/Out Of Service (If the room is OO/OS).
roomOutOfOrderType
object
Out Of Order and Out Of Service Room information.
8 properties
dateRangeType
object
Date Range with Start and End dates.
2 properties
roomDiscrepanciesType
array
Room Discrepancies between front office and housekeeping room status and number of persons in the room.
roomDiscrepancyType
string
Simple type for discrepant room status instructions to be used in requests for fetching housekeeping and front office room discrepancy. Valid values are Sleep,…
sitePlanSectionType
object
Represents the site plan section record.
5 properties
roomRoomsType
array
Collection of rooms.
roomRoomType
object
This type represents the primary room attributes.
14 properties
currentServicingAttendantType
object
The Attendant Name and ID of the attendant servicing the room.
16 properties
housekeepingSectionType
object
Information regarding Housekeeping Sections.
9 properties
applicationUserType
object
18 properties
employeeInfoType
object
9 properties
personNameType
object
This provides name information for a person.
12 properties
personNameTypeType
string
Person's name in an external system.
userSessionInfoType
object
11 properties
userSessionDefaultsType
object
9 properties
parametersType
array
Collection of generic Name-Value-Pair parameters.
parameterType
object
Name value pair type that will hold generic parameter information. Only use this type when the parameters being passed are too dynamic to be defined.
2 properties
attendantType
object
2 properties
servicingAttendantStatusType
string
Possible values for the Status of a Servicing Attendant.
roomHoldType
object
3 properties
turndownInfoType
object
1 property
reservationShortInfoType
object
8 properties
floorPlanRoomGuestType
object
6 properties
statistics
object
Response element for frontOffice statistics.
5 properties
hSKStatReportCodeType
string
Supported Housekeeping report codes.
hSKStatType
object
Since the statistical value can be represented in different measure of units, this element will provide a flexible definition for the supported Opera9 statisti…
3 properties
statUnitCategoryType
string
Supported statistical units.
hSKStatCodeType
string
Supported housekeeping statistical codes.
activityLog
object
Fulfillment activity log response.
3 properties
activityLogListType
object
7 properties
activityLogType
object
12 properties
taskSheetStatistics
object
3 properties
hSKTaskSheetStatisticsInfoType
object
Holds the task sheet statistics information.
2 properties
hSKTaskSheetInfoType
object
Holds the information for the task sheet.
11 properties
assignedTasksType
array
Holds the assigned task codes for a tasksheet.
assignedTaskType
object
Holds the assigned task code for a tasksheet.
1 property
taskSheetType
string
Task Sheet classification.
hSKTaskSheetDetailsInfoType
object
Holds the task sheet statistics details information.
1 property
hSKAttendantTimeLogsType
object
Holds the information for the task sheet.
4 properties
roomInterfaceStatus
object
Response object for fetching room interface status
3 properties
reservationInterface
object
Request to change the interface status for a reservation.
3 properties
changeInterfaceStatusType
object
This will contain reservation id and corresponding interface information for which the interface status needs to be updated.
3 properties
roomKeyInterfaceDetails
object
Response with the configuration details of active room key interfaces including the available key encoders.
3 properties
roomKeyInterfaceDetailsType
array
Configuration details of room key interface.
roomKeyInterfaceDetailType
object
11 properties
roomKeyInterfaceRightsType
array
Holds the key encoder right.
roomKeyInterfaceRightType
object
3 properties
roomKeyEncodersType
array
Holds the key encoder right.
roomKeyEncoderType
object
5 properties
reservationQueueStatistics
object
Response for the fetch of current Reservations In Queue statistics. Contains the statistic information.
3 properties
reservationQueueStatisticsType
object
Type for statistics of the reservations currently in Queue for Check-In.
3 properties
reservationQueueRoomTypeStatisticsType
object
Type for Room Type statistics for reservations currently in Queue for Check-In. Statistics would be the number of rooms for each room type which is currently i…
3 properties
reservationsInQueue
object
Response for the operation to fetch Reservations in Queue
4 properties
reservationList
object
A collection of reservation details attached to Profiles.
4 properties
hotelRoomsType
object
Collection of Room record that contain Housekeeping and Out Of Order information.
2 properties
roomType
object
This type represents the primary room attributes.
30 properties
queueReservation
object
Request to add a reservation to the Queue for Check-In. A reservation can be added to the queue prior to Check-In on the day of arrival.
4 properties
reservationQueuePriority
object
Response to the request to add a reservation to the Queue for Check-In.
3 properties
shortReservation
object
10 properties
reservationsSummaryType
object
Type which shows all fetched reservations summary depends on Fetch Summary Instruction.
3 properties
roomSummaryType
object
2 properties
assignedRoomsSummaryType
object
Indicates summary of the assigned rooms.
1 property
unassignedRoomsSummaryType
object
Indicates summary of the unassigned rooms.
1 property
paymentMethodsSummaryType
object
2 properties
blockResvSummaryType
object
Indicates summary of the Total reservations for the block.
1 property
roomsAI
object
Request to run AI Room Assignment and allocate rooms to incoming reservations.
2 properties
autoAssignRoom
object
Request for auto assignment of rooms to reservations.
3 properties
reservationAutoRoomAssignRequestType
object
Request criteria for auto assignment of rooms to reserved reservations.
3 properties
roomRangeType
object
2 properties
autoAssignedRoom
array
Collection of result set which is made of reservation id, error and warning.
autoRoomAssignType
object
Collection of error and warning if any.
9 properties
massAdvanceCheckInReservations
object
Request object to Submit Batch job for Mass Advance Check In of Reservations.
3 properties
massAdvanceCheckInCriteriaType
object
Criteria for performing Mass Advance Check In of Reservations
4 properties
massCheckInReservations
object
Request object to Submit Batch job for Mass Checkin of Reservations.
3 properties
massCheckInCriteriaType
object
This will have details of reservations and advance criteria for performing Mass Checkin of Reservations
4 properties
roomStatusListType
array
Room Status Type.
advanceCheckInReservation
object
Request object to perform Advance Check In of a Reservation.
3 properties
advanceCheckInReservationType
object
Information needed to perform Advance Check In of a Reservation
7 properties
reservation
object
Validation checks includes the following: - Reservation is not valid to be checked in. - Split is still required before the reservation can be checked in. - Ro…
5 properties
checkedInReservationInstructionType
string
Fetch Instruction to indicate if any automatically generated folios information should be returned in the response. For example, in a scenario when automatic c…
checkedinReservation
object
CheckIn response will commonly be errors over warnings. If a check has to be done before checking a reservation to a hotel, then the VerifyCheckinReservation o…
3 properties
hotelReservationType
object
The Reservation class contains the current reservation being created or altered.
101 properties
scheduledRoomMoveType
object
Scheduled Room Move information.
4 properties
scheduledRoomMoveInfoType
object
Scheduled Room Move information.
6 properties
scheduledRoomMoveStatusType
string
Flag indicating scheduled room move status.
roomOccupancyType
object
Room Occupancy information.
6 properties
associatedResType
object
Information regarding associated reservations to the reservation.
2 properties
roomStayType
object
27 properties
currentRoomInfoType
object
Room information of the reservation for the current day.
8 properties
roomRateType
object
43 properties
totalType
object
The total amount charged for the service including additional amounts and fees.
11 properties
taxesType
object
A collection of taxes.
3 properties
taxType
object
Applicable tax element. This element allows for both percentages and flat amounts. If one field is used, the other should be zero since logically, taxes should…
5 properties
amountDeterminationType
string
Used to indicate if an amount is inclusive or exclusive of other charges, such as taxes.
feesType
object
A collection of fees or service charges.
3 properties
feeType
object
Applicable service charges or fees.
5 properties
ratesType
object
Individual rate amount.
2 properties
amountType
object
Base charge and additional charges related to a room that includes such things as additional guest amounts, cancel fees, etc. Also includes Discount percentage…
10 properties
additionalGuestAmountType
object
2 properties
discountType
object
Identifies and provides details about the discount. This allows for both percentages and flat amounts. If one field is used, the other should be zero/not speci…
5 properties
shareDistributionInstructionType
string
The type of Rate Amount Change to be done on the Sharer reservation. This can be FULL - Full Rate for each Sharer. SPLIT- Split the Rate amount between Sharer…
rateRangeType
object
Rate Range details like maximum rate amount and minimum rate amount in each available rate category.
2 properties
packageElementType
object
15 properties
reservationProfileType
object
3 properties
profileType
object
Type provides the detailed information about the profile and its children.
55 properties
customerType
object
Contains basic data on the customer's identity, location, relationships, finances, memberships, etc.
26 properties
identificationInfoType
object
Information on the identification of the customer.
3 properties
identificationType
object
Identification information of the customer.
10 properties
alienInfoType
object
immigration/visa information of a foreign person.
3 properties
companyInfoType
object
Company Information of the Profile.
3 properties
companyType
object
20 properties
iATAInfoType
object
IATA Information of the profile.
3 properties
imageSetType
object
Represents on image set record.
11 properties
imageStyleType
string
An enumeration of image styles.
uRLInfoType
object
Web site address.
3 properties
uRLType
object
Web site address, in IETF(The Internet Engineering Task Force) specified format.
5 properties
commentInfoType
object
Comment related to the profile/reservation.
8 properties
commentType
object
An indication of a new paragraph for a sub-section of a formatted text message.
19 properties
formattedTextTextType
object
Provides text and indicates whether it is formatted or not.
2 properties
profileDeliveryMethod
object
Delivery Information type to the profile.
7 properties
profileDeliveryModuleType
string
Module where this delivery type will be used. Example : EFolio Export, EInvoice , Fiscal, etc..
profileMembershipType
object
Detailed information of the memberships.
41 properties
paragraphType
object
An indication of a new paragraph for a sub-section of a formatted text message.
3 properties
membershipEarningPreferenceType
string
The earning preference of a membership, it depends on the type of property. eg. when the property is a airline it should be Miles, other than Points.
benefitsType
array
Basic information about membership benefit.
benefitType
object
Basic information about membership benefit.
3 properties
tierAdministrationType
string
Do not upgrade membership. The membership may be downgraded.
downgradeType
string
Do not downgrade membership when the next downgrade process runs. When the downgrade process runs, the membership will be automatically set to Grace.
cardReIssueType
string
Request to re issue a new card.
preferenceTypeType
object
Preference details for the profile.
13 properties
preferenceType
object
Guest Preference details for the profile.
8 properties
keywordType
object
3 properties
keywordDetailType
object
1 property
negotiatedType
object
This holds a list of NegotiatedInfoType.
3 properties
negotiatedInfoType
object
This provides information for a profile negotiated rate.
6 properties
gdsNegotiatedType
object
This holds a list of GdsNegotiatedInfoType.
4 properties
gdsNegotiatedInfoType
object
This provides information for a channel negotiated rate.
5 properties
relationshipInfoType
object
Relationship Type contains information about the associations between and among individuals, companies, travel agents, groups, sources, and contact profiles.
8 properties
changeRelationsType
object
Detailed information regarding the changes made to relationships for the profile.
5 properties
relationshipProfileType
object
13 properties
ownerType
object
Generic type for information about an owner.
11 properties
uniqueIDListType
array
Unique Id that references an object uniquely in the system.
profileStatusType
string
masterAccountInfoType
object
2 properties
relationshipInfoSummaryType
object
RelationshipInfoSummaryType contains information about the associations between and among individuals, companies, travel agents, groups, sources, and contact p…
7 properties
relationshipProfileSummaryType
object
11 properties
relationshipAddressType
object
Provides address information for a Relationship.
5 properties
reservationHistoryFutureInfoType
object
Information of History and Future Reservation details attached to Profiles.
2 properties
historyListType
object
A collection of reservation history details attached to Profiles.
4 properties
futureListType
object
A collection of reservation history details attached to Profiles.
4 properties
reservationStayHistoryFutureInfoType
object
Information of History and Future Reservation details attached to Profiles.
2 properties
stayHistoryListType
object
A collection of reservation history details attached to Profiles.
4 properties
stayReservationInfoType
object
The Reservation class contains the current reservation being created or altered.
6 properties
stayFutureListType
object
A collection of reservation history details attached to Profiles.
4 properties
lastStayInfoType
object
Contains last stay related details for the profile
4 properties
profileAccessType
object
4 properties
profileSharedLevelType
string
Simple types for Shared level.
profileRestrictions
object
3 properties
mailingActionsType
object
Defines mailing action list for the profile.
5 properties
privacyInfoType
object
Defines Privacy related information for the profile.
14 properties
profileCashieringType
object
Contains cashiering related details for the profile
14 properties
directBillingType
object
This is the preconfigured routing instruction type.
2 properties
profileCommissionType
object
This is the preconfigured routing instruction type.
7 properties
commissionPaymentMethods
string
Check
userDefinedFieldsType
object
A common type used to hold user defined fields(UDFs). This type should be used to handle UDFs on RReservation, Profiles, etc.
3 properties
characterUDFsType
array
Used to hold collection of user defined fields of Character/String Type.
characterUDFType
object
Used to hold user defined field of Character/String Type.
3 properties
numericUDFsType
array
Used to hold collection of user defined fields of Numeric Type.
numericUDFType
object
Used to hold user defined field of Numeric Type. It is highly recommended to use UDFN01, UDFN02,...UDFN40 (Total 40) as Numeric UDF names(commonly used on Rese…
3 properties
dateUDFsType
array
Used to hold collection of user defined fields of Date Type.
dateUDFType
object
Used to hold user defined field of Date Type.
3 properties
webUserAccountsType
array
Web User Accounts List.
webUserAccountType
object
Web User Account of the guest.
11 properties
webUserHistoryType
object
Creation date time, Creator Id, last modification date time and last Modifier Id.
8 properties
profileTaxInfoType
object
Profile information related to tax.
7 properties
salesInfoType
object
Provides sales information about the profiles of type company, travel agent, source and contact.
13 properties
eCertificatesType
array
List of e-certificates for the profile.
eCertificateType
object
E-Certificates details.
23 properties
eCertificateInfoType
object
E-Certificates details.
14 properties
eCertificateScopeType
string
Indicates that OPERA E-Certificate is available for a specific list of hotels.
eCertificateUsageCriteriaType
object
E-Certificates details.
8 properties
eCertificateConsumptionType
object
E-Certificates details.
13 properties
eCertificateConsumeSourceType
string
Indicates that OPERA E-Certificate is consumed by hotelPMS.
eCertificateStatusType
string
Indicates that OPERA E-Certificate is reserved.
awardId
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
6 properties
eCertificateIssueSourceType
string
Indicates that OPERA E-Certificate is issued by external system.
eCertificateIssueType
string
Indicates that guest purchased OPERA E-Certificate.
eCertificateGenerationType
object
E-Certificates details.
3 properties
profileSubscriptionListType
array
Details of the OPERA Profile subscription to external system
profileSubscriptionType
object
Contains details of the profile subscription. The subscription represents the link between the OPERA profile and the external profile within a particular exter…
11 properties
roomOwnershipType
object
Define the search criteria for retrieving room ownership records
9 properties
guestCountsType
object
A collection of GuestCount by age group.
4 properties
childAgesType
array
Age of a child in years.
childAgeType
object
Defines Child's Age.
1 property
childBucketsType
object
Defines children counts with Age Qualifying Group(Child Bucket) classification.
5 properties
resAwardsType
object
Membership Awards code applied on the reservation.
4 properties
awardVouchersType
array
This stores the Membership Awards code applied on the reservation.
foreignExchangeType
object
Foreign Exchange info.
2 properties
mealPlansType
array
Meal plan codes associated with the rate codes.
mealPlanCodeType
object
Meal plan codes associated with the rate codes.
5 properties
roomRateAvailReasonType
string
Indicates the Room Rate is not available due to unavailability of enough items for the rate code.
upsellInfoType
object
Information regarding upsell for a reservation.
2 properties
ownerResTypeType
string
primaryShareTypeType
string
compAuthorizerInfoType
object
Authorizer Information
3 properties
resGuestType
object
A collection of ResGuest objects, identifying the guests associated with this reservation. Which guests are in which room is determined by each RoomStays ResGu…
6 properties
profileCashieringDetailType
object
The type contains routing instructions for the profile.
6 properties
profileRoutingInstructionsType
object
The type contains routing instructions for the profile.
3 properties
trxCodesInfoType
array
List of Transaction codes info.
trxInfoType
object
Transaction codes info.
10 properties
articleInfoType
object
Information regarding an article.
9 properties
articlePostItType
object
Post it information of an article.
2 properties
colorType
string
Color configuration type. This color configuration provides a visual category of entities.
billingInstructionsType
array
Set of Billing Instruction codes.
billingInstructionType
object
Configured Billing Instruction which represents a set of Transaction Codes.
4 properties
transportInfoType
object
7 properties
visaInfoType
object
3 properties
resGuestAdditionalInfoType
object
8 properties
awardsType
array
List of awards.
awardType
object
Detailed information of the awards.
34 properties
awardKindType
string
Indicates that this is electronic certificate.
reservationCertificateType
string
Certificate is incentive.
rewardCertificateType
string
Point Saver reward.
awardStatusType
string
Indicates that certificate is in use.
fBAInfoType
object
FBA ( Flexible Benefits Awards ) related fields.
22 properties
fBAStatusType
string
Flexible benefit award has been reimbursed.
trackItItemsType
array
trackItItemType
object
Detailed information of a Track It item.
14 properties
trackItId
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
6 properties
trackItGroup
string
Group to which the Track It items belong.
trackItType
object
Identifies the kind of Parcel, Baggage, or Lost items or Valet-managed vehicles or services.
2 properties
trackItActionType
object
Identifies the response expected from staff or other parties relative to a Track It ticket.
2 properties
actionStatusType
string
Action status of the Track It item(Open, Closed, InProgress).
trackItReservationInfoType
object
Reservation info associated with a Track It item.
9 properties
trackItLogListType
array
trackItLogType
object
Individual activity log related to the Track It ticket.
9 properties
hotelReservationsType
object
A collection of Reservation objects and Unique IDs of Reservation.
4 properties
reservationLocatorsType
array
Holds the Locator Information.
reservationLocatorType
object
Holds the information for a Reservation Guest Locator
6 properties
dateTimeSpanType
object
Allows for a choice in description of the amount of time spanned by this type. EndDate specifies a specific date, while Duration provides a measure of time to…
2 properties
attachmentsType
array
Attachment List.
attachmentType
object
Attached files.
12 properties
dateTimeStampGroupType
object
5 properties
serviceRequests
array
Service request.
serviceRequest
object
Service request.
19 properties
serviceRequestStatusType
string
activityLookUpList
array
Criteria for fetching Activity Bookings.
fetchActivityBookingsType
object
Used in the request message to describe the "filtering Criteria" when executing an activity lookup.
5 properties
activityList
array
A collection of Activity objects.
prepaidCardsType
array
Holds fixed charge detail.
prepaidCardType
object
Holds fixed charge information.
17 properties
prepaidCardDetailsType
object
Prepaid Card Details.
10 properties
prepaidCardTransactionType
object
Prepaid Card transaction.
9 properties
prepaidCardTrxTypeType
string
Reload transaction.
reservationPackageType
object
A ReservationPackageType class.
13 properties
packageCodeHeaderType
object
4 properties
configPackagePrimaryDetailsType
object
A Config Package Info type.
6 properties
configPackageTransactionType
object
A HotelPackageTransaction type.
5 properties
packagePostingRulesType
object
5 properties
packageTransactionCodeType
object
3 properties
configPostingAttributesType
object
A config Package posting attributes type.
18 properties
functionArgumentsType
array
Collection of function arguments and their corresponding values.
functionArgumentType
object
This type provided details of a function argument and the value it holds.
5 properties
packagePostingRhythmType
object
Package Posting rhythm type.
5 properties
postingRhythmType
string
Simple type for posting Rhythm types.
packageCalculationRuleType
string
Simple type for package caluculation rules.
pkgInventoryItemType
object
4 properties
configPackageUsageDetailType
object
A Config Package Usage Detail type.
4 properties
productSourceType
string
Sources of Products
reservationPackageScheduleType
object
A HotelPackageSchedule type.
8 properties
packageConsumptionType
object
Package Consumption Information. Includes information on quantity of the package used, allowance consumption etc.
4 properties
resInventoryItemsType
object
Defines a collection of inventory items attached to a reservation.
2 properties
resInventoryItemType
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
10 properties
itemInfoType
object
Basic information regarding an Item.
15 properties
timeWindowType
object
Defines a Time period with start time and an end time.
2 properties
resInventoryItemSourceType
object
Defines whether the item is setup due to a Rate Plan, Package or a Block.
5 properties
blockId
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
6 properties
membershipType
object
Detailed information of the memberships.
41 properties
reservationMembershipType
object
Detailed information of the memberships.
43 properties
routingInfoListType
array
A routing info object can either be of type Folio OR of type Room with its corresponding instructions.
routingInfoType
object
A routing info object can either be of type Folio OR of type Room with its corresponding object.
5 properties
routingInstructionType
object
Routing limit can be one of the three: Credit Limit, Percetage Limit, Covers Limit
8 properties
compAccountingType
object
Authorizer Information
12 properties
compRoutingRequestType
object
Type for the details of a Comp Routing Request
4 properties
userInfoType
object
Opera User Information
2 properties
compRoutingStatusType
string
Status which indicates that the Request of Comp Routing was declined
reservationPoliciesType
object
A collection of reservation deposit and cancellation policies.
4 properties
resCancellationPoliciesType
array
A list of reservation cancellation policies.
resCancellationPolicyType
object
A cancellation policy attached with the reservation.
5 properties
depositCancelRevenueType
string
The type to indicate what revenue is to be used for calculating deposit/cancellation amounts.
resCancelPenaltyType
object
The CancelPenalty class defines the cancellation policy of the hotel facility.
9 properties
policyDeadlineType
object
Cancellation deadline, absolute or relative.
4 properties
policyAmountPercentType
object
Defines the percentage basis for calculating the fee amount or the amount.
5 properties
policyBasisTypeType
string
Full Amount.
offsetUnitType
string
Indicates deadline offset unit type.
resDepositPoliciesType
array
A list of deposit policies attached with the reservation.
resDepositPolicyType
object
A deposit policy attached with the reservation.
6 properties
depositPolicyType
object
Used to define the deposit policy, guarantees policy, and/or accepted forms of payment.
10 properties
linkedReservationsInfoType
object
Linked Reservations.
7 properties
linkedReservationInfoType
object
20 properties
linkedReservationType
string
Enumeration of the different Linked Reservation Types.
cateringResInfoType
object
Information regarding catering event and catering revenue type associated to the reservation.
2 properties
eventId
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
6 properties
resStatClassificationType
object
Statistical Classification information for the reservation.
2 properties
alertsType
array
List of alerts.
alertType
object
25 properties
alertAreaType
string
alertGuestInfoType
object
13 properties
languageType
string
welcomeOfferType
object
2 properties
welcomeOfferOptionsType
string
None of the Welcome Offer option is selected.
hotelReservationTracesType
array
List of Reservation Traces.
hotelReservationTraceType
object
Extended Trace object to hold information for a reservation.
16 properties
traceTimeInfoType
object
4 properties
traceResolveType
object
2 properties
confirmationsType
array
List of confirmation letters.
confirmationType
object
11 properties
confRecipientInfoType
object
7 properties
profileNameType
object
This provides name information for a person.
8 properties
confDeliveryInfoTypes
array
List of confirmation letter delivery methods and their status
confDeliveryInfoType
object
4 properties
confDeliveryMethod
string
sentConfirmationStatus
string
confirmationStyle
object
7 properties
callHistoryType
array
Holds call information.
callType
object
Holds call information.
11 properties
callerType
object
Holds caller information.
11 properties
fixedChargesType
array
Holds fixed charge detail.
fixedChargeType
object
Holds fixed charge information.
8 properties
fixedChargeScheduleType
object
Holds schedule of fixed charge.
5 properties
fixedChargeFrequencyType
string
Yearly.
fixedChargeDetailType
object
Fixed charge amount could be specified by flat fee or be a percentage of the rate amount.
7 properties
guestMessagesType
array
Holds the Message Information
guestMessageType
object
Holds the Message information for a Reservation
13 properties
messageType
object
Holds the Message Information
5 properties
typeOfMessageType
string
The type of Message for Guest Messages.
messageDeliveryType
object
Holds the Delivery Information of the Message
8 properties
messageStatusType
string
Status of the Message.
overrideInstructionsType
array
List of override actions done.
overrideInstructionType
object
Type for Overrides. Contains information for the override action performed while booking a reservation.
6 properties
eCouponsType
array
Collection of ECouponType object.
eCouponType
object
Reservation eCoupon Type Information.
9 properties
reservationTransactionDiversionsType
array
List of Transaction Diversion rules.
reservationTransactionDiversionType
object
A Transaction Diversion Rule Type
16 properties
membershipTypeLevelType
object
2 properties
transactionDiversionRuleLevelType
string
Reservation level.
thresholdDetailsType
object
Type for the threshold elements.
5 properties
entityType
string
Indicates the rule is based on Minutes associated with the charge.
scopeType
string
Minimum required and complimentary values are applicable Per Stay.
transactionDiversionRuleTypeType
string
The rule type on which the Transaction Diversion Rule is based. If a reservation has any of the following code, Transaction Diversion rule gets active for that…
transactionDiversionDailyDetailsType
array
List of daily details for Transaction Diversion rule.
transactionDiversionDailyDetailType
object
List of daily details for Transaction Diversion rule.
3 properties
ticketsType
array
Collection of TicketType objects.
ticketType
object
Reservation Ticket Type Information.
13 properties
reservationECertificatesType
array
Collection of ECertificateType object.
reservationECertificateType
object
Reservation ECertificate Type Information.
3 properties
requestActionType
string
eCertificateClassficationType
string
Enumeration of the different type of Ecertificate.
nameValueDetailType
object
Detailed information returned during name value search.
1 property
nameValuesType
array
List of name value pairs.
nameValueType
object
Contains name value pair.
6 properties
nameValueDataTypeType
string
nameValueOriginType
object
Contains origin details.
4 properties
nameValueModuleType
string
customChargeExemptionsType
array
List of Custom Charge Exemptions.
customChargeExemptionType
object
Contains custom charges exemption information.
6 properties
customChargeQuantityType
object
Contains quantity of custom charge exemptions.
2 properties
customChargeExemptionDatesType
array
Contains List of Custom Charge Exemption information for a day.
customChargeExemptionDateType
object
Contains Custom Charge Exemption information for a day.
2 properties
excludedDatesType
array
Contains list of dates which are valid for custom charge exemptions.
excludedDateType
object
Specifies all the enabled dates.
2 properties
exclusionReasonType
string
Custom Charge has already been Processed for this date within the reservation stay.
foliosShortInfoType
array
This type contains a list of generated bills for a reservation.
folioShortInfoType
object
This type contains information of generated bills.
8 properties
folioStatusType
string
The Folio Status Example: DEPOSIT folio, VOID folio or the default OK folio status.
commissionNotesDetails
object
Response type for fetching commission notes.
5 properties
commissionNotesListType
array
Commission Note for the reservation.
linkedReservations
object
3 properties
room
object
The reservation must still be reserved to use this operation.
3 properties
reservationRoomSelectionType
object
Defines search criteria needed to configure a room to a reservation.
16 properties
reservationRoomSelectionOverrideType
object
Define the override flag which will be used when configuring a room to a reservation.
18 properties
rateChangeInstructionType
object
Defines override rate type.
2 properties
rateChangeType
string
Simple type for rate change type.
assignedRoom
object
Possible errors that the operation will generate: The reservation is not in Reserved state. The room being requested does not exist.
5 properties
dailyRatesType
array
Defines room rate information on a daily basis.
dailyRateType
object
The total amount charged for the service including additional amounts and fees.
14 properties
effectiveRatesType
array
Collection of effective rate amount per guest on specific dates.
effectiveRateType
object
Effective rate amount per guest on specific dates.
22 properties
rateByAgeBucketsType
array
Rate amount by age bucket.
rateByAgeBucketType
object
Rate amount by age bucket.
3 properties
roomKeyInfo
object
Response of fetch room keys operation.
5 properties
roomKeysInfoListType
array
Contains details of Room key.
roomKeyInfoType
object
Contains detail information of room keys .
12 properties
keyTrackType
object
4 properties
roomKey
object
Request for generation of room key.
19 properties
roomKeyType
string
Simple type for representing room key type.
keyCardType
string
Key card types.
roomKeyDetails
object
Response for room key creation.
6 properties
roomMoveHistory
object
Response for the fetch room move history of a reservation.
3 properties
roomMoveDetailsType
array
List of room move details
roomMoveDetailType
object
Room move history information.
8 properties
unAssignRoomCriteria
object
Request to the remove a room(unassign) from a reserved reservation.
6 properties
unAssignedRoom
object
Response Body.
2 properties
moveInHouseGuest
object
To move a reservation, the reservation needs to be in Checked-In state.
3 properties
stringLength2000
string
Used for Character Strings, length 0 to 2000.
movedInHouseGuest
object
Potential errors which this operation might respond are the following: - Reservation is NOT In-House. - The room is NON-EXISTENT for the hotel. - The room is N…
5 properties
suggestedRooms
object
Response of fetch suggested rooms operation.
3 properties
suggestedRoomType
object
List of suggested rooms and component rooms.
2 properties
deliverQueueRoomsTextMessage
object
Request to deliver a text message via Queue Reservations (for a guest) or Queue Rush (for housekeeping).
3 properties
queueRoomsTextCriteriaType
object
Text message criteria type, used to deliver a text message via Queue Reservations (to a guest) or Queue Rush (to housekeeping).
4 properties
queueRoomsTextMessageType
string
Text message will be delivered via Queue Rush, to housekeeping.
QueueRoomsTextMessage
object
Response for delivering a text message via Queue Reservations (to a guest) or Queue Rush (to housekeeping).
3 properties
verifiedCheckinReservation
object
3 properties
wakeUpCalls
object
Fetch wake up calls response.
3 properties
wakeUpCallsType
array
List of the wake up calls
wakeUpCallType
object
Criteria to search and retrieve wake up calls.
16 properties
wakeUpCallResvInfoType
object
Criteria to search and retrieve wake up calls.
16 properties
wakeUpCallStatusType
string
Statuses of the wake up call.
changedWakeUpCalls
object
Response Body.
2 properties
roomKeyStatus
object
Respose for the reading of room key.
9 properties
dateTimeRangeType
object
Date Range with Start and End dates.
2 properties
hotelRooms
object
9 properties
holdRooms
object
Request to place rooms on hold.
4 properties
roomsHoldsType
array
List of rooms, reason, and comments.
roomsHoldType
object
Hold reason and the list of the rooms that are to be put on hold under that reason.
4 properties
serviceRequestsInfo
object
Response object for service requests.
3 properties
queuedRoomsTextMessage
object
Response for retrieving a predefined text message, for Queue Reservations or Queue Rush.
3 properties
reservationQueuePriorityNumber
object
Request to change the current priority of a reservation in Queue for Check-In.
3 properties
shiftRooms
object
To quickly shift rooms for two reservations that are for the same arrival date and room type
5 properties
swapRooms
object
To quickly swap or shift rooms for two reservations that are for the same arrival date and room type
5 properties
stayRoominfo
object
Request which contains parameters needed to swap or shift rooms
3 properties
roomStatusStatisticsListType
object
3 properties
roomStatusStatisticsType
object
4 properties
roomStatusStatisticsCountType
object
2 properties
reservationDisplayColorInfoType
object
Information of reservation display color, determined based on OPERA parameter RESERVATIONCOLORDEFINITION
3 properties
colorDefinitionType
string
Color definition type. This color definition type is used to determine the defintion of color
roomKeyGuest
object
Information about the guest for whom a key can be created.
9 properties
roomKeyMultipleGuests
object
Short room key information containing information about the multiple guests and room key options .
4 properties
updateRoomKeys
object
Collection of error and warning if any.
2 properties
reservationRoomOwnershipType
string
Indicates if the assigned reservation room is an Owner/Referral or Regular room.
commissionPaymentDetails
object
Response to get the commission payment details.
3 properties
commissionPaymentInfo
object
Information on a commission payment for a reservation.
8 properties
reservationStatusEnumType
string
Reservation Status Enum Type
reservationStatusStatisticsType
object
Reservation Statistics for a Reservation Status
3 properties
reservationStatusStatisticsResponseType
object
Reservation Status Statistics
1 property
roomTypeStatisticsType
object
Reservation Statistics for a Room Type
2 properties
roomClassStatisticsType
object
Reservation Statistics for a Room Class
3 properties
hotelRoomsOrderBy
string
This type is used to support various sortings for available rooms search results.
airaLastRunStatusInfo
object
Response of last execution status for AI Room Assignment
6 properties
roomKeyOutBoundType
string
Simple type for representing room key type.
requestType
string
Simple type for representing request type.
roomKeyResponseCodeType
string
Response Code
roomKeyExternal
object
Request for generation of room key used for OutBound.
19 properties
3 required
roomKeyExternalDetails
object
Response for the key request made to DLS from Opera PMS.
11 properties
3 required
reservationKeyInfoType
object
Holds the room key information provided by the Door Lock System.
1 property
keyOptionsInfo
object
Response of fetch keyOptions operation.
5 properties
profileKeyOptionsType
object
2 properties
keyOptionsType
object
This contains code and description information for key options.
2 properties
externalRoomKeyType
string
Simple type for representing room key request type. 'HardKey' = request for physical key card with RFID; 'MobileKey' = request for mobile key (no physical key)…
keyUserType
string
Simple type for representing key user type. 'Guest' = request Opera Guest room key
printDataType
object
Lists the text, file or picture to print onto a Guest room key (only for roomKeyType is HardKey).
3 properties
keyOptionsResponseType
object
This contains code and description information for key options.
4 properties
roomKeysExternal
object
Request for generation of room key used for OutBound.
24 properties
6 required
roomKeysExternalDetails
object
Response for the key request made to DLS from OPERA Cloud.
20 properties
8 required
bookingTimeSpanType
object
The booking time span of the reservation, only applicable when time increments are being used.
2 properties
backToBackResSequenceType
object
Type object represents Back To Back Sequence Position and Total Count of Linked Back To Back Reservations ordered by consecutive Stay Dates.
2 properties
keyOptionsInfoListType
object
9 properties
keyOptionsInfoType
object
Response of fetch keyOptions operation.
4 properties
batchCCAuthReservationStatusType
string
reservation statuses for credit card authorizations
operaVersionNumberType
string
Current Opera Version Number
operaVersion
object
Response for Ping operation.
3 properties
swapShiftOverrideInstructionType
object
Contains information for the override actions performed while swapping or shifting rooms.
1 property
roomOccupancyInfoType
object
Information about room's recent and upcoming stays to help determine vacancy history and future occupancy.
4 properties
searchBankAccountsRequest
object
3 properties
searchReservationsForCommissionsRequest
object
8 properties
commissionsReservationStatusTypeEnum
string
searchWakeUpCallsRequest
object
15 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Oracle Hospitality 12
Other APIs Oracle Hospitality publishes across the network.
OPERA Cloud Distribution ARI Publication
OPERA Cloud Distribution Outbound Lookup
OPERA Cloud Distribution Content Notification
OPERA Cloud Distribution Book
OPERA Cloud Distribution Content
OPERA Cloud Distribution Property Controls
OPERA Cloud Distribution Reservation Service
OPERA Cloud Distribution Authentication API
OPERA Cloud Distribution Onboarding
OPERA Cloud Distribution Reservation Notification
OPERA Cloud Distribution Shop
Nor1 Integrated Upsell API
#FOFStats#FrontDeskOperations#Commissions#Property Management#OPERA Cloud
Where this information came from
This is an independent, third-party profile of OPERA Cloud Front Desk Operations Service, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.