OPERA Cloud Cashiering Outbound API
APIs to cater for Cashiering related external (outbound) functionality with OPERA. These APIs facilitate various operations related to getting data from an external system, and inserting it into OPERA. Compatible with OPERA Cloud release 26.2.0.0. 7 operation(s) documented; base path /csh/v1. Harvested verbatim from Oracle's public hospitality-api-docs repository (Swagger 2.0, release 26.2.0.0).
OPERA Cloud Cashiering Outbound API is one of 135 APIs that Oracle Hospitality publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Cashiering, Property Management, and OPERA Cloud. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
7 operations
across 7 paths,
and defines 38 schemas.
It is described by OpenAPI 2.0, at version 26.2.0.0.
The identity and technical contract details declared by the specification.
Cashiering 7
Cashiering module provides APIs to service front desk billing requirements, as well as any requirements related to a reservation's folio. You can retrieve a guest folio, post bill…
GET
/hotels/{hotelId}/memberships/{membershipId}/compRedemptions
Operation to get complimentary redemptions for a guest having PTS Membership Type
getCompRedemptions
8 params
→ 200204400401403404405406
PUT
/hotels/{hotelId}/memberships/{membershipId}/compRedemptionAuthorizations
Operation to authorize complimentary redemptions for a guest having PTS Membership Type
authorizeCompRedemptions
9 params
→ 200400401403404405406413
POST
/hotels/{hotelId}/memberships/{membershipId}/compRedemptionPostings
Operation to post complimentary redemptions for a guest having PTS Membership Type
postCompRedemptions
9 params
→ 200400401403404405406413
POST
/hotels/{hotelId}/memberships/{membershipId}/compRedemptionReversals
Operation to reverse complimentary redemptions for a guest having PTS Membership Type
reverseCompRedemptions
9 params
→ 201400401403404405406413
PUT
/hotels/{hotelId}/asyncCompPostingsApproval
Operation to request for submitting bulk comp postings for vendor approval.
asyncApproveCompPostings
8 params
→ 200400401403404405406413
PUT
/hotels/{hotelId}/compPostingsApproval
Operation to request for comp postings approval.
approveCompPostings
8 params
→ 200400401403404405406413
PUT
/hotels/{hotelId}/compPostingsReversal
Operation to request for comp postings reversal.
reverseCompPostings
8 params
→ 200400401403404405406413
currencyAmountType
object
A monetary value expressed with a currency code.
2 properties
sendBulkCompTransactionsStatus
object
2 properties
sendCompTransactionsStatus
object
3 properties
compTransactionsInfoType
array
List of comp transactions.
compTransactionInfoType
object
Transaction information being processed by the vendor.
12 properties
cashierId
number
The Cashier ID of the Cashier who is currently processing the transaction(s).
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
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
instanceLink
object
Metadata describing link description objects that MAY appear in the JSON instance representation.
7 properties
fetchCompRedemptionsRS
object
Response type for retrieval of Complimentary Redemption codes and their respective Available Amount.
1 property
fetchCompRedemptionsRSCompRedemptionsType
array
Collection of Complimentary Redemption codes and their respective Available Amount.
fetchCompRedemptionsRSCompRedemptionType
object
Information about a Complimentary Redemption code and its Available Amount.
3 properties
authorizeCompRedemptionsRQ
object
Request type of Complimentary Redemptions for approval.
1 property
authorizeCompRedemptionsRQCompRedemptionsType
array
Collection of Complimentary Redemptions for approval.
authorizeCompRedemptionsRQCompRedemptionType
object
Information about a Complimentary Redemption for approval.
4 properties
authorizeCompRedemptionsRS
object
Response type of Complimentary Redemptions for approval.
2 properties
authorizeCompRedemptionsRSCompRedemptionsType
array
Collection of Complimentary Redemption codes and their respective Approval Code.
authorizeCompRedemptionsRSCompRedemptionType
object
Information about a Complimentary Redemption including its approval code.
2 properties
postCompRedemptionsRQ
object
Request type of Complimentary Redemptions posting.
1 property
postCompRedemptionsRQCompRedemptionsType
array
Collection of Complimentary Redemptions for posting.
postCompRedemptionsRQCompRedemptionType
object
Information about a Complimentary Redemption for posting.
5 properties
postCompRedemptionsRS
object
Response type of Complimentary Redemptions for posting.
2 properties
postCompRedemptionsRSCompRedemptionsType
array
Collection of Complimentary Redemption codes and their respective Approval Code.
postCompRedemptionsRSCompRedemptionType
object
Information about a Complimentary Redemption including its approval code.
2 properties
status
object
Response Body.
2 properties
reverseCompRedemptionsRQ
object
Request type of Complimentary Redemptions reversal.
1 property
reverseCompRedemptionsRQCompRedemptionsType
array
Collection of Complimentary Redemptions for reversal.
reverseCompRedemptionsRQCompRedemptionType
object
Information about a Complimentary Redemption for reversal.
4 properties
reverseCompRedemptionsRS
object
Response type of Complimentary Redemptions for reversal
1 property
compTransactionsCriteriaType
object
Contains all transactions to be submitted to the vendor
1 property
bulkCompTransactionsCriteriaType
object
Contains all transactions to be submitted to the vendor
1 property
bulkCompTransactionType
object
Contains the transaction to be submitted to the vendor
21 properties
generateCompTransactionType
object
Contains the transaction generate to be submitted to the vendor
5 properties
compTransactionType
object
Contains the transaction to be submitted to the vendor
28 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Oracle Hospitality publishes across the network.