Oracle Hospitality Commissions API
Commission web service provides commission processing service like payment processing, payment activity and search.
Oracle Hospitality Commissions API is one of 154 APIs that Oracle Hospitality publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Commissions. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 23 operations across 18 paths, and defines 178 schemas. It is described by OpenAPI 3.2.0, at version 26.2.0.0.
Requests are made against a single base URL, /fof/v1.
23 operations
18 paths
178 schemas
3 DELETE9 GET3 POST8 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 23
Across 18 paths, the API surfaces 23 operations — 3 DELETE, 9 GET, 3 POST, 8 PUT. Each is listed below with its method, path, parameters, and response codes.
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
Schemas 178
The contract defines 178 schemas that model the data the API accepts and returns. The most detailed are reservationInfoType (53 properties), stayInfoType (37 properties), resGuestInfoType (30 properties), commissionDetailType (29 properties). Each schema is shown below with its type and property counts.
reservationQueueInformationType
object
Information regarding the Date, Duration and Priority of the reservation on Queue for Check in.
6 properties
guestHousekeepingServiceRequestType
string
Possible values for the Guest Service Status.
resAccompanyGuestInfoType
object
5 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
commissionCheckStatus
object
Response Body.
2 properties
commissionAgentTypeType
string
Simple type for commission agent type. Valid values are Agent and Source.
resSharedGuestInfoType
object
Contains information regarding the share reservation.
4 properties
cardTypeType
string
This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method.
commissionsDetails
object
Commissions for the requested account or agent id.
9 properties
reservationFolioWindowsType
array
Collection of reservation folio windows.
namePrefixType
string
Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.)
reservationInfoType
object
The Reservation class contains the current reservation being created or altered.
53 properties
commissionProcessingInstructionsType
object
Type for commission process instruction. Possible instruction types are on hold and offset AR.
3 properties
pointsType
object
The Redeem Points contains the number of points required to book a room type.
2 properties
resAccessRestrictionType
string
Indicates any Updates/Changes on the reservation as well as Reservation Cancellation are not allowed.
reservationIdList
array
Unique Id that references an object uniquely in the system.
communicationStatusType
string
Enum to denote the Status of Readiness messages sent to Guest Devices.
resCashieringType
object
Cashiering Information for the reservation.
14 properties
commissionPaymentsActivityType
array
List of payment activity information
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
resPaymentCardType
object
Information on a credit card for the customer.
19 properties
reservationDepositType
object
Reservation Deposit Type.
7 properties
bankAccountType
object
Bank account information like Account ID, Bank Name, Currency, etc.
13 properties
resHousekeepingType
object
Holds housekeeping turndown service information for the room.
7 properties
reservationPaymentMethodType
object
8 properties
queueTextInfoType
object
Information regarding the message sent to guest.
2 properties
indicatorsType
array
Collection of lamp indicators.
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
indicatorType
object
Lamp indicator Type.
2 properties
addressInfoType
object
Provides address information.
3 properties
warningsType
array
Used in conjunction with the Success element to define a business error.
commissionNotesListType
array
Commission Note for the reservation.
folioTextsType
array
This stores the description for the type of tax calculation especially with tax exemption, etc.
changeCommissionPaymentActivityRangeCriteriaType
object
Base type for payment activity information
5 properties
aRAccountShortInfoType
object
Accounts Receivabales Account details type charged for batched posting.
4 properties
cardNumberTypeType
string
Simple type for indicating if credit card number is tokenized.
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
telephoneType
object
Information on a telephone number for the customer.
12 properties
reprintCommissionCheckByRangeStatus
object
Response type for reprinting a range of check payments.
3 properties
currencyAmountType
object
A monetary value expressed with a currency code.
2 properties
telephoneInfoType
object
Information on a telephone number for the customer.
3 properties
reservationTurndownInfoType
object
Turndown information for a reservation
2 properties
commissionProcessingAgentsType
array
Commission processing instructions for an Agent.
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…
agentInfoType
object
Agent or source commission information.
12 properties
resProfileTypeType
string
commissionPaymentsActivityDetails
object
Response type for commission payments activity.
3 properties
waitlistResType
object
Information regarding why reservation is being /has been waitlisted.
6 properties
instanceLink
object
Metadata describing link description objects that MAY appear in the JSON instance representation.
7 properties
hotelReservationsIDType
object
List of Reservation Unique identifiers to represent multiple reservations with each reservation's one unique id.
2 properties
commissionAgentIDType
object
Type which contains the Commission Agent id and its type.
3 properties
commissionToBeChanged
object
Request type for update of commission detail.
3 properties
commissionReservationFailuresType
array
Reservation that wasn't successfully associated with the agent.
hotelInterfaceType
object
8 properties
commissionCheckToBeChanged
object
Request type for updating commission check.
3 properties
cardProcessingType
string
authorizerInfoType
object
Authorizer Information
5 properties
resCommunicationType
object
Communication details for a reservation.
2 properties
status
object
Response Body.
2 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
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
nameTypeType
string
commissionPaymentActivityStatusCriteriaType
object
Criteria for updating status of a range of payment activity .
2 properties
membershipInfoType
object
The Membership object identifies the frequent customer reward program.
8 properties
housekeepingTaskCodeType
object
Information related to a Task Code. Task Codes are used to generate task sheets in Rooms Management.
7 properties
commissionAgentsType
array
Agent or source profiles that were returned by the search.
commissionProcessingReservationsType
array
Commission processing instructions for a reservation.
commissionPaymentReportType
object
Contains report id, batch id (for check payments) or export file (for eft payments)
5 properties
searchBankAccountsRequest
object
3 properties
payeeInfoType
object
Payee information.
7 properties
resAccompanyGuestListType
array
Collection of accompany guests
blockIdList
array
Unique Id that references an object uniquely in the system.
basicEmailType
string
Email address
commissionInfoType
object
Commission processing information including related bank, agents or source and funds details.
3 properties
commissionCodeType
object
Type for commission code info.
2 properties
resSharedGuestListType
array
Collection of shared guest reservations.
commissionPaymentActivityByRangeToBeChanged
object
Request type for updating a range of payments activity.
3 properties
resMobileNotificationsType
object
Contains the status of Room Ready and Key Ready messages.
5 properties
facilityTaskType
object
Information regarding facility task on a reservation.
3 properties
sourceOfSaleType
object
Point of Sale of reservation. Identifies the entity/channel who made the reservation.
2 properties
commissionPaymentInfo
object
Information on a commission payment for a reservation.
8 properties
codeDescriptionType
object
This contains a generic code and description information.
2 properties
associateCommissionAgentToReservations
object
Request type for associating reservations to Travel Agent or Source Profile.
5 properties
commissionInfoListType
array
List of commission info.
commissionStatusType
string
Simple type for commission status. Valid values are Unpaid and Paid.
commissionPaymentDetails
object
Response to get the commission payment details.
3 properties
surnameType
string
Family name, last name.
guestLastStayInfoType
object
Contains last stay related details of the guest.
4 properties
commissionStatus
object
Response Body.
2 properties
commissionReservationFailureType
object
Collection of error and warning if any.
3 properties
emailInfoType
object
Information on an email for the customer.
3 properties
bankAccountsType
array
List of bank accounts.
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
resPeriodicFolioType
object
Information regarding periodic folios set on the reservation.
3 properties
facilityCodesType
array
List of the facility codes.
resAttachedProfileListType
array
commissionDetailsType
array
Commission details related to the stays for which the agent or source is eligible to receive commissions.
searchMatchType
object
Search match indicating attribute and the matching value.
2 properties
resGuestExternalInfoType
object
Specifies Company or Travel Agent profile using IATA or Corp. No.
2 properties
bankAccountsDetails
object
Returns bank accounts that match the request criteria.
3 properties
resGuaranteeType
object
Validations type record returned after Validations are done.
3 properties
resCompAccountingType
object
Information regarding comp accounting on the reservation.
3 properties
phoneNumberType
string
Phone number
commissionAgentType
object
Agent or source information along with their commission details.
2 properties
commissionPayoutToType
string
hotelInterfaceStatusType
string
Status of the Hotel Interface either STOPPED or RUNNING.
givenNameType
string
Given name, first name or names
reprintCommissionCheckByRange
object
Request type for reprinting a range of check payments.
3 properties
commissionNotesDetails
object
Response type for fetching commission notes.
5 properties
advanceCheckInType
object
Information relating to Reservation's Advance Checked In state and Expected Time of Return
3 properties
commissionPaymentActivityStatusType
string
Simple type for payment activity status type. Valid values are Outstanding, Reconciled, Unpresented and Void.
resRevenueBalanceType
object
Revenue and Balance Amount summary for the reservation.
10 properties
commissionBaseDetailType
object
Criteria for updating a commission record.
6 properties
numberRangeType
object
Date Range with Start and End dates.
2 properties
calculateCommissions
object
Request type for calculation of commission for all Travel Agent and/or Source.
2 properties
facilityCodeType
object
Facility Housekeeping Code, its description and quantity.
3 properties
resAttachedProfileType
object
3 properties
processCommissionPaymentsStatus
object
Response type for processing commission payments.
3 properties
commissionDetails
object
Response type for fetch commission detail.
3 properties
emailType
object
Information on an email for the customer.
11 properties
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
operaVersionNumberType
string
Current Opera Version Number
errorsType
array
An error that occurred during the processing of a message.
reprintCommissionCheckRangeCriteriaType
object
Base type for payment activity information
6 properties
addressType
object
Provides address information.
19 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.
processCommissionPaymentsCriteriaType
object
Generic commission criteria including hotel code, bank account id, agent id, reservation id and/or commission id
7 properties
taxTypeType
object
Provides information about the Tax Type.
8 properties
commissionPaymentActivityByRangeStatus
object
Response Body.
2 properties
setProcessingInstructions
object
Request Type for setting instructions for commission processing on Agent or Reservation level.
3 properties
childAgesType
array
Age of a child in years.
bedTaxReportingType
object
This stores the information for Bed Tax Reporting. Mainly used in Maldives.
5 properties
reservationAllowedActionsType
array
Allowed action.
commissionsReservationStatusTypeEnum
string
changeCommissionCheckCriteriaType
object
Base type for payment activity information
5 properties
vIPType
object
The supplier's ranking of the customer.
2 properties
searchMatchesType
array
List of Generic Name-Value-Pair Parameters used for super search matches.
externalReferencesType
array
This type contains unique information of external reference.
commissionDetailType
object
Criteria for updating a commission record.
29 properties
countryNameType
object
Code for a country or a nationality.
4 properties
errorInstance
object
Complex type that contains error instance details for a REST call.
7 properties
2 required
recalculateCommissionOnCodeChange
object
Request type for recalculating commission amount when commission code of unpaid commission is changed.
2 properties
resExpectedTimesType
object
Holds the Arrival and Departure Time Information
2 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.
resPreConfiguredRoutingInstrType
object
Instruction to attach Pre-Configured Routing Instructions to a Reservation.
4 properties
associateCommissionAgentToReservationsStatus
object
Response type for associating reservations to Travel Agent or Source Profile.
3 properties
interfaceRightsStatusType
object
4 properties
processCommissionPayments
object
Request type for processing commission payments.
3 properties
aRAccountStatusType
object
Type for the Account Status. Status can be restricted and a message/description added to the Account.
3 properties
resGuestInfoType
object
Specifies Company or Travel Agent profile using IATA or Corp. No.
30 properties
billingPrivilegesType
object
This stores the information for Bed Tax Reporting. Mainly used in Maldives.
13 properties
reservationFolioWindowType
object
Folio window view which holds the set of folios for a reservation.
4 properties
reservationBlockType
object
Key information about the block for a reservation.
3 properties
reservationTaxTypeInfo
object
Provides information about the Tax Type.
9 properties
commissionPaymentActivityType
object
Base type for payment activity information
13 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
profileTypeType
string
The types of Profile handled by the web service.
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
searchReservationsForCommissionsRequest
object
8 properties
anonymizationStatusType
string
Guest has been anonymized.
commissionSummaryType
object
Summary of the commission payment information totaled for all agents/sources.
4 properties
profileIdList
array
Unique Id that references an object uniquely in the system.
childAgeType
object
Defines Child's Age.
1 property
commissionPaymentMethodType
object
This contains a generic code and description information.
3 properties
calculateCommissionsStatus
object
Response Body.
2 properties
recalculateCommissionOnCodeChangeStatus
object
Response type for recalculating commission amount when commission code of unpaid commission is changed
3 properties
reservationInterfaceStatusType
object
Hotel Interface Type for a reservation and status of the various services
3 properties
operaVersion
object
Response for Ping operation.
3 properties
externalReferenceType
object
This type contains unique information of external reference.
3 properties
links
array
reservationAllowedActionType
string
Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation.
commissionReservationInstructionsType
string
Type for commission reservation instructions.
addressSearchType
object
Address Details such as city, state, country, postal code etc.
6 properties
authorizationRuleType
object
Configured rule for computing the amount to authorize.
3 properties
anonymizationType
object
Provides information about guest's anonymization status.
2 properties
hotelInterfaceTypeType
string
XML Posting Interface
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…
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 RnA Activities GraphQL API
OPERA Cloud RnA ARAccountsReceivable GraphQL API
OPERA Cloud RnA ARAgingReport GraphQL API
OPERA Cloud RnA ARLedger GraphQL API
OPERA Cloud RnA BookingReservationExtended GraphQL API
OPERA Cloud RnA BookingsBlockProductionChanges GraphQL API
OPERA Cloud RnA BookingsBlockStatusChanges GraphQL API
OPERA Cloud RnA BookingsBlock GraphQL API
OPERA Cloud RnA BookingsReservation GraphQL API
OPERA Cloud RnA CateringEventForecast GraphQL API
OPERA Cloud RnA CateringEventPostings GraphQL API
OPERA Cloud RnA CateringEventStatusChanges GraphQL API
#Commissions
Where this information came from
This is an independent, third-party profile of Oracle Hospitality Commissions API, 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.