Oracle Hospitality Cashiering API
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 billing charges to guest folio, add routing instructions to a reservation, view authorization history, all the way through to checking the guest out using the postCheckOut API.
Oracle Hospitality Cashiering 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 Cashiering. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 203 operations across 179 paths, and defines 721 schemas. It is described by OpenAPI 3.2.0, at version 26.2.0.0.
Requests are made against 2 base URLs: /csh/v1, /csh/async/v1.
203 operations
179 paths
721 schemas
16 DELETE71 GET70 POST46 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 203
Across 179 paths, the API surfaces 203 operations — 16 DELETE, 71 GET, 70 POST, 46 PUT. Each is listed below with its method, path, parameters, and response codes.
Cashiering 203
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
PUT
/hotels/{hotelId}/memberships/{membershipId}/compRedemptionAuthorizations
Operation to authorize complimentary redemptions for a guest having PTS Membership Type
POST
/hotels/{hotelId}/memberships/{membershipId}/compRedemptionPostings
Operation to post complimentary redemptions for a guest having PTS Membership Type
POST
/hotels/{hotelId}/memberships/{membershipId}/compRedemptionReversals
Operation to reverse complimentary redemptions for a guest having PTS Membership Type
PUT
/hotels/{hotelId}/asyncCompPostingsApproval
Operation to request for submitting bulk comp postings for vendor approval.
PUT
/hotels/{hotelId}/compPostingsApproval
Operation to request for comp postings approval.
PUT
/hotels/{hotelId}/compPostingsReversal
Operation to request for comp postings reversal.
GET
/cashierReportPostings
Get Cashier Report Postings
PUT
/cashiers/{cashierId}/closure
Close Cashier
GET
/cashiers/{cashierId}/locks
Acquire Cashier Locks
DELETE
/cashiers/{cashierId}/locks
Break Cashier Lock
GET
/cashiers/{cashierId}/transactions
Get Cashier Transactions
DELETE
/cashiersLock/{lockId}
Release Cashier Lock
GET
/compAccountingJournaldeprecated
Get Comp Accounting Journal
POST
/fbaReimbursements
Create FBA Reimbursement
POST
/fbaSettlements
Create FBA Settlement
PUT
/foreignCurrency
Calculate Foreign Currency
POST
/foreignCurrencyExchange
Create Foreign Currency Exchange
POST
/hotels/{hotelId}/advanceFolio/batchJobs
Create Batch Advance Folio
POST
/hotels/{hotelId}/articlesSale
Create Articles Sale
GET
/hotels/{hotelId}/authorizers/credits
Get Authorizers Credit Info
POST
/hotels/{hotelId}/autoCheckoutReservations/batchJobs
Create Auto Checkout Reservation Batch
POST
/hotels/{hotelId}/autoSettlements/batchJobs
Create Batch Auto Settlement
POST
/hotels/{hotelId}/batchDeposits
Create batch deposits
GET
/hotels/{hotelId}/bedTax
Get bed tax information
POST
/hotels/{hotelId}/bedTax
Create bed tax information
PUT
/hotels/{hotelId}/bedTax/{taxRegistraitionNo}deprecated
Change bed tax information
DELETE
/hotels/{hotelId}/bedTax/{taxRegistraitionNo}deprecated
Delete bed tax information
PUT
/hotels/{hotelId}/billingCharges
Change Billing Charges
GET
/hotels/{hotelId}/bulkCCSettlements/{batchId}/status
Get Batch CC Settlements Status
POST
/hotels/{hotelId}/bulkPrepaidCards
Create multiple Prepaid Cards
GET
/hotels/{hotelId}/cashiers/{cashierId}/closure
Get Cashier Closure
GET
/hotels/{hotelId}/cashiers/{cashierId}/closureReports
Get Cashier Closure Reports List
PUT
/hotels/{hotelId}/cashiers/{cashierId}/folioTaxPayments
Change folio tax payments
PUT
/hotels/{hotelId}/cashierslock/{lockId}
Extend Cashier Lock
GET
/hotels/{hotelId}/cashsurcharge
Get Cash Surcharge Information
POST
/hotels/{hotelId}/ccSettlement
Create CreditCard Settlement
POST
/hotels/{hotelId}/ccSettlements/batchJobs
Create Batch CC Settlements
GET
/hotels/{hotelId}/check/{checkNumber}
Get check details
POST
/hotels/{hotelId}/check/{checkNumber}
Post Guest Check Details
PUT
/hotels/{hotelId}/check/{checkNumber}
Update Guest Check Details
DELETE
/hotels/{hotelId}/check/{checkNumber}/charges
Delete Billing Check Charges
GET
/hotels/{hotelId}/closureList
Get Cashier Closure Information
GET
/hotels/{hotelId}/compAccountingJournal
Get Comp Accounting Journal
GET
/hotels/{hotelId}/compRoutingInstructionsdeprecated
Get Comp Routing Instructions
POST
/hotels/{hotelId}/compRoutingInstructions/searches
Get Comp Routing Instructions
GET
/hotels/{hotelId}/compTrxAuthorizers
Get Comp Trx Authorizers
GET
/hotels/{hotelId}/covers
Get transaction covers
PUT
/hotels/{hotelId}/covers
Change Transaction Covers
POST
/hotels/{hotelId}/creditBill
Create Credit Bill
PUT
/hotels/{hotelId}/creditBill/action/validate
Validate Credit Bill
GET
/hotels/{hotelId}/creditLimitsOveragePayments
Get Credit Limits Overage Payments
POST
/hotels/{hotelId}/creditLimitsOveragePayments
Create Credit Limit Overage Payments
POST
/hotels/{hotelId}/creditcardTransaction/logs
Register Vault Transaction
GET
/hotels/{hotelId}/creditcardsurcharge
Get CC Surcharge Information
GET
/hotels/{hotelId}/depositFolio
Get Deposit Folio
GET
/hotels/{hotelId}/depositTransactions
Get Deposit Folio Transaction Details
PUT
/hotels/{hotelId}/depositfolios/action/validate
Validate Deposit Folio
POST
/hotels/{hotelId}/externalSystems/{externalSysCode}/reservations/{reservationId}/depositPayments
Create Deposit Payment using external reference.
GET
/hotels/{hotelId}/financialPostings
Get Financial Postings
GET
/hotels/{hotelId}/financialPostingsNetVat
Get Financial Postings with breakdown
POST
/hotels/{hotelId}/fiscalCommands
Create Fiscal Invoice
GET
/hotels/{hotelId}/fiscalFolioResponse
Get the Fiscal Folio Activity for a folio
GET
/hotels/{hotelId}/fiscalFolioResponse/{folioSeqNo}
Get the Fiscal Folio Activity Response details for a folio
POST
/hotels/{hotelId}/fiscalFolios
Create Fiscal Information Folio
GET
/hotels/{hotelId}/fiscalPrinting
Get Fiscal Printing Details
GET
/hotels/{hotelId}/fiscalSupportingDocumentsdeprecated
Get supporting documents details.
POST
/hotels/{hotelId}/fiscalSupportingDocuments
Operation to resend the failed supporting documents to fiscal partner.
POST
/hotels/{hotelId}/fiscalSupportingDocuments/searches
Get supporting documents details.
PUT
/hotels/{hotelId}/folio/{folioId}/convertdeprecated
Convert Folio
POST
/hotels/{hotelId}/folio/{folioId}/customerVatFolio
Create Customer Factura Vat Folio.
POST
/hotels/{hotelId}/folio/{folioId}/fiscalCommandsdeprecated
Create Fiscal Invoice
GET
/hotels/{hotelId}/folioHistorydeprecated
Get folio history
POST
/hotels/{hotelId}/folioHistory/searches
Get folio history
GET
/hotels/{hotelId}/folioPrinters
Get folio printers
GET
/hotels/{hotelId}/folioTypeNames
Get Folio Type Name
GET
/hotels/{hotelId}/folioTypes
Get Folio Types
PUT
/hotels/{hotelId}/folios/{folioId}/fiscal
Process Fiscal retry
POST
/hotels/{hotelId}/passerBySale
Create passer by sale
PUT
/hotels/{hotelId}/payees/{payeeId}/taxNumber
Change Payee Tax Number
PUT
/hotels/{hotelId}/policies/{policyId}/transactions/{transactionId}/deposit
Attach Deposit Policy to Payment
GET
/hotels/{hotelId}/postingDates/date/postingSummary
Get Posting Summary
POST
/hotels/{hotelId}/prepaidCards
Create Prepaid Cards
PUT
/hotels/{hotelId}/prepaidCards/activate
Operation to activate prepaid card.
PUT
/hotels/{hotelId}/prepaidCards/cancel
Operation to cancel prepaid card transaction.
PUT
/hotels/{hotelId}/prepaidCards/cashOut
Operation to cash out prepaid card.
PUT
/hotels/{hotelId}/prepaidCards/reload
Operation to reload prepaid card.
GET
/hotels/{hotelId}/profiles/{profileId}/creditCardWallet
credit card wallet
DELETE
/hotels/{hotelId}/profiles/{profileId}/creditCardWallet
Delete Credit Cards from Wallet
POST
/hotels/{hotelId}/profiles/{profileId}/paymentMethods/creditCard/authorize
Authorize Credit Card Amount by Profile
POST
/hotels/{hotelId}/profiles/{profileId}/paymentMethods/creditCard/authorizeInstructions
Get CC Authorization Instructions By Profile
GET
/hotels/{hotelId}/receiptHistorydeprecated
Get Receipt History
POST
/hotels/{hotelId}/receiptHistory/searches
Get Receipt History
POST
/hotels/{hotelId}/reservation/{reservationId}/rateCode/{rateCode}
Create rate codes
PUT
/hotels/{hotelId}/reservation/{reservationId}/rateCode/{rateCode}/action/validate
Change posted rate codes
POST
/hotels/{hotelId}/reservations/billingCharges
Create Billing Charges in Batch
GET
/hotels/{hotelId}/reservations/cCSettlements
Get batch CC Settlements
GET
/hotels/{hotelId}/reservations/vouchers
Get the list of vouchers generated from a list of reservations.
GET
/hotels/{hotelId}/reservations/{reservationId}/additionalTaxes
Get additional Taxes
GET
/hotels/{hotelId}/reservations/{reservationId}/advancePaymentBalance
Get advance payment balance
POST
/hotels/{hotelId}/reservations/{reservationId}/advanceRoomCharges
Create advance Room Charges
DELETE
/hotels/{hotelId}/reservations/{reservationId}/advanceRoomCharges
Delete Advance Folio Transactions
GET
/hotels/{hotelId}/reservations/{reservationId}/alertsdeprecated
Get Alert Notices
GET
/hotels/{hotelId}/reservations/{reservationId}/authorizationHistory
Get authorization history
GET
/hotels/{hotelId}/reservations/{reservationId}/charges
Get Billing Charges
POST
/hotels/{hotelId}/reservations/{reservationId}/charges
Post Charge to a folio
POST
/hotels/{hotelId}/reservations/{reservationId}/chargesAndPayments
Post charges and payments on a reservation
POST
/hotels/{hotelId}/reservations/{reservationId}/check/{checkNumber}/charges
Pre-validate the Billing Charge
POST
/hotels/{hotelId}/reservations/{reservationId}/checkOuts
Check out a guest
PUT
/hotels/{hotelId}/reservations/{reservationId}/checkOuts/reinstate
Reinstate Checked Out Reservation
PUT
/hotels/{hotelId}/reservations/{reservationId}/comp/folios/autoSettlements
Operation to auto settle comp folios.
POST
/hotels/{hotelId}/reservations/{reservationId}/compRedemptionPostings
Operation to post complimentary bucket redemptions for a guest having PTS Membership Type
POST
/hotels/{hotelId}/reservations/{reservationId}/compRedemptionReversals
Operation to reverse complimentary bucket redemptions for a guest having PTS Membership Type
POST
/hotels/{hotelId}/reservations/{reservationId}/compositeDeposit
Create Deposit Payment or Deposit Folio
GET
/hotels/{hotelId}/reservations/{reservationId}/creditCardWallet
Credit Card Wallet
DELETE
/hotels/{hotelId}/reservations/{reservationId}/creditCardWallet
Delete Credit Cards from Wallet
POST
/hotels/{hotelId}/reservations/{reservationId}/deferredTaxesProcess
Request to submit a job to post the deferred taxes.
POST
/hotels/{hotelId}/reservations/{reservationId}/deposit
Process Reservations deposit
POST
/hotels/{hotelId}/reservations/{reservationId}/depositCreditBill
Deposit Credit Bill
POST
/hotels/{hotelId}/reservations/{reservationId}/depositFolios
Create Deposit Folio
GET
/hotels/{hotelId}/reservations/{reservationId}/depositMaturity
Get Deposit Maturity Information
POST
/hotels/{hotelId}/reservations/{reservationId}/depositPayments
Create Deposit Payment
GET
/hotels/{hotelId}/reservations/{reservationId}/depositPayments
Get matured deposits
PUT
/hotels/{hotelId}/reservations/{reservationId}/depositTransition
Transition Deposit to Guest Folio
PUT
/hotels/{hotelId}/reservations/{reservationId}/earlyDeparture
Change early Departure
GET
/hotels/{hotelId}/reservations/{reservationId}/earlyDeparture/verify
Verify for early Departure
GET
/hotels/{hotelId}/reservations/{reservationId}/eligibleBillAmount
Get Eligible Bill Amount
GET
/hotels/{hotelId}/reservations/{reservationId}/fetchStagedTransactions
Get fetchStagedTransactions
POST
/hotels/{hotelId}/reservations/{reservationId}/finalCharges
Apply final Postings
POST
/hotels/{hotelId}/reservations/{reservationId}/fiscalInfo
Post fiscal Info
GET
/hotels/{hotelId}/reservations/{reservationId}/fiscalPrintingdeprecated
Get Fiscal Printing Details
GET
/hotels/{hotelId}/reservations/{reservationId}/fixedCharges
Get Fixed Charges
PUT
/hotels/{hotelId}/reservations/{reservationId}/fixedCharges
Updates Fixed Charges
DELETE
/hotels/{hotelId}/reservations/{reservationId}/fixedCharges
Delete Fixed Charges
POST
/hotels/{hotelId}/reservations/{reservationId}/fixedCharges
Create Fixed Charges
POST
/hotels/{hotelId}/reservations/{reservationId}/flexibleBenefitPostings
Apply flexible benefit postings
GET
/hotels/{hotelId}/reservations/{reservationId}/folioTaxPayments
Get folio tax payments information
GET
/hotels/{hotelId}/reservations/{reservationId}/folios
Get folios
PUT
/hotels/{hotelId}/reservations/{reservationId}/folios
Close Reservation Folio
POST
/hotels/{hotelId}/reservations/{reservationId}/folios
Generate Folios
POST
/hotels/{hotelId}/reservations/{reservationId}/memberships/{membershipId}/awardTransactions
Post a membership award payment transaction.
DELETE
/hotels/{hotelId}/reservations/{reservationId}/packageAllowance/links
Unlink reservation package allowance
GET
/hotels/{hotelId}/reservations/{reservationId}/packageOptions
Get Reservation Package Options
POST
/hotels/{hotelId}/reservations/{reservationId}/paymentMethods/creditCard/authorize
Authorize Credit Card Amount
POST
/hotels/{hotelId}/reservations/{reservationId}/paymentMethods/creditCard/authorize/manual
Register Manual Authorization
POST
/hotels/{hotelId}/reservations/{reservationId}/paymentMethods/creditCard/authorizeInstructions
Get CC Authorization Instructions
POST
/hotels/{hotelId}/reservations/{reservationId}/payments
Create Billing Payment
GET
/hotels/{hotelId}/reservations/{reservationId}/postingActivities
Get posting activity details
PUT
/hotels/{hotelId}/reservations/{reservationId}/prepaidCards/redemptions
Operation to redeem prepaid cards.
POST
/hotels/{hotelId}/reservations/{reservationId}/proformadeprecated
Create proforma
POST
/hotels/{hotelId}/reservations/{reservationId}/proformaFolio
Create proforma
GET
/hotels/{hotelId}/reservations/{reservationId}/revenueBuckets
Get Reservations Revenue Bucket Totals
POST
/hotels/{hotelId}/reservations/{reservationId}/reverseCertificate
Reverse certificate postings
GET
/hotels/{hotelId}/reservations/{reservationId}/routingInstructions
Get routing instructions
DELETE
/hotels/{hotelId}/reservations/{reservationId}/routingInstructionsdeprecated
Delete routing instructions
PUT
/hotels/{hotelId}/reservations/{reservationId}/routingInstructions/change
Change routing instructions
DELETE
/hotels/{hotelId}/reservations/{reservationId}/routingInstructions/comp
Delete comp routing instructions
PUT
/hotels/{hotelId}/reservations/{reservationId}/routingInstructions/create
Create routing instructions
DELETE
/hotels/{hotelId}/reservations/{reservationId}/routingInstructions/folio
Delete Folio routing instructions
DELETE
/hotels/{hotelId}/reservations/{reservationId}/routingInstructions/request
Delete request routing instructions
DELETE
/hotels/{hotelId}/reservations/{reservationId}/routingInstructions/room
Delete Room routing instructions
PUT
/hotels/{hotelId}/reservations/{reservationId}/transactions
Delete transactions for specific reservation on current business day
GET
/hotels/{hotelId}/reservations/{reservationId}/transactions/{transactionId}
Get eligibility of Deposit Refund
PUT
/hotels/{hotelId}/reservations/{reservationId}/transactions/{transactionId}
Split deposit transaction
PUT
/hotels/{hotelId}/reservations/{reservationId}/transferFolioTransactions
Transfer Folio to Window.
PUT
/hotels/{hotelId}/reservations/{reservationId}/transferTransactions
Transfer Transaction to Window
PUT
/hotels/{hotelId}/reservations/{reservationId}/voidfolios/{folioId}
Void folio
GET
/hotels/{hotelId}/reservations/{reservationId}/vouchers
Get the list of vouchers generated for a reservation.
POST
/hotels/{hotelId}/reservations/{reservationId}/vouchers
Generate Reservation Vouchers
GET
/hotels/{hotelId}/reservations/{resvNameId}/compTransactionAuthorizers
Get Comp Transaction Authorizers
PUT
/hotels/{hotelId}/reservations/{sourceReservationId}/deposit/transfers
Change Reservation Deposit Transfer.
PUT
/hotels/{hotelId}/reservations/{toReservationId}/transferTransaction
Transfer Transaction to Reservation
GET
/hotels/{hotelId}/revenue
Get Hotel Revenue
GET
/hotels/{hotelId}/routingInstructionCodes
Get Billing (routing) Instruction Codes
POST
/hotels/{hotelId}/sourceReservations/{sourceReservationId}/destinationReservations/{destinationReservationId}/packageAllowance/links
Link Reservation package allowance
GET
/hotels/{hotelId}/sourceReservations/{sourceReservationId}/targetReservations/{targetReservationId}/roomRouting
Get Postings For Refresh
PUT
/hotels/{hotelId}/sourceReservations/{sourceReservationId}/targetReservations/{targetReservationId}/roomRouting
Process Room Routing Refresh
GET
/hotels/{hotelId}/storedFolios/{folioId}
Get Stored Folio Details
POST
/hotels/{hotelId}/storedFolios/{folioId}
Create Stored Folio Details
POST
/hotels/{hotelId}/supplementFolios
Post supplemental folio
GET
/hotels/{hotelId}/transactionCodes
Get Transaction Codes
GET
/hotels/{hotelId}/transactionDetails
Get Folio Transaction Details
GET
/hotels/{hotelId}/transactions
Get Guests Transactions
PUT
/hotels/{hotelId}/transactions/adjust
Adjust Transactions
DELETE
/hotels/{hotelId}/transactions/arInvoices/reverse
Reverse AR Invoice
PUT
/hotels/{hotelId}/transactions/split
Split transactions
PUT
/hotels/{hotelId}/transactions/splitAndTransfer
Split and transfer transactions
GET
/hotels/{hotelId}/transactions/{transactionId}
Validate Transaction Codes
POST
/hotels/{hotelId}/transactions/{transactionId}
Submit Comp Transaction
PUT
/hotels/{hotelId}/transactions/{transactionId}/charges
Change Billing Charge
GET
/hotels/{hotelId}/transactions/{transactionId}/compRequestStatus
Get Gaming Request Status
DELETE
/hotels/{hotelId}/transactions/{transactionId}/flexibleBenefitPostings
Delete flexible benefit postings
PUT
/hotels/{hotelId}/transactions/{transactionId}/payments
Change Billing Payment
PUT
/hotels/{hotelId}/transactions/{transactionId}/policies/detach/deposit
Detach Deposit Policy from Payment
POST
/hotels/{hotelId}/transactions/{transactionId}/reversePayments
Create reverse payments
GET
/hotels/{hotelId}/transactionsTotaldeprecated
Get Balance Information
POST
/hotels/{hotelId}/transferCompTransactions
Transfer comp transactions to window
POST
/hotels/{hotelId}/vouchers/batchJobs
Generate Batch Vouchers
POST
/hotels/{hotelId}/zeroBalanceCheckoutReservations/batchJobs
Create Zero Balance Checkout Reservation Batch
POST
/reservations/{reservationId}/postRoomAndTaxForDayUse
Operation to post room and tax for day use.
GET
/roundingDifference
Get Rounding Difference
GET
/services/cashiering/status
Status check of cashiering services
GET
/hotels/{hotelId}/financialPostingsNetVat/{statusId}
Get results of Financial Postings with Net and Vat breakdown.
Schemas 721
The contract defines 721 schemas that model the data the API accepts and returns. The most detailed are detailPostingType (63 properties), detailPostingType_2 (62 properties), summaryPostingType (54 properties), depositDetailPostingType (53 properties). Each schema is shown below with its type and property counts.
compTransactionsCriteriaType
object
Contains all transactions to be submitted to the vendor
1 property
sendBulkCompTransactionsStatus
object
2 properties
fetchCompRedemptionsRSCompRedemptionsType
array
Collection of Complimentary Redemption codes and their respective Available Amount.
compTransactionType
object
Contains the transaction to be submitted to the vendor
28 properties
reverseCompRedemptionsRQCompRedemptionType
object
Information about a Complimentary Redemption for reversal.
4 properties
compTransactionInfoType
object
Transaction information being processed by the vendor.
12 properties
postCompRedemptionsRS
object
Response type of Complimentary Redemptions for posting.
2 properties
authorizeCompRedemptionsRSCompRedemptionsType
array
Collection of Complimentary Redemption codes and their respective Approval Code.
cashierId
number
The Cashier ID of the Cashier who is currently processing the transaction(s).
fetchCompRedemptionsRSCompRedemptionType
object
Information about a Complimentary Redemption code and its Available Amount.
3 properties
instanceLink
object
Metadata describing link description objects that MAY appear in the JSON instance representation.
7 properties
errorInstance
object
Complex type that contains error instance details for a REST call.
7 properties
2 required
bulkCompTransactionsCriteriaType
object
Contains all transactions to be submitted to the vendor
1 property
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
compTransactionsInfoType
array
List of comp transactions.
sendCompTransactionsStatus
object
3 properties
postCompRedemptionsRQ
object
Request type of Complimentary Redemptions posting.
1 property
status
object
Response Body.
2 properties
authorizeCompRedemptionsRQCompRedemptionType
object
Information about a Complimentary Redemption for approval.
4 properties
postCompRedemptionsRQCompRedemptionType
object
Information about a Complimentary Redemption for posting.
5 properties
authorizeCompRedemptionsRQ
object
Request type of Complimentary Redemptions for approval.
1 property
reverseCompRedemptionsRQ
object
Request type of Complimentary Redemptions reversal.
1 property
reverseCompRedemptionsRQCompRedemptionsType
array
Collection of Complimentary Redemptions for reversal.
fetchCompRedemptionsRS
object
Response type for retrieval of Complimentary Redemption codes and their respective Available Amount.
1 property
authorizeCompRedemptionsRS
object
Response type of Complimentary Redemptions for approval.
2 properties
warningsType
array
Used in conjunction with the Success element to define a business error.
authorizeCompRedemptionsRQCompRedemptionsType
array
Collection of Complimentary Redemptions for approval.
bulkCompTransactionType
object
Contains the transaction to be submitted to the vendor
21 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
links
array
generateCompTransactionType
object
Contains the transaction generate to be submitted to the vendor
5 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
authorizeCompRedemptionsRSCompRedemptionType
object
Information about a Complimentary Redemption including its approval code.
2 properties
currencyAmountType
object
A monetary value expressed with a currency code.
2 properties
postCompRedemptionsRQCompRedemptionsType
array
Collection of Complimentary Redemptions for posting.
reservationQueueInformationType
object
Information regarding the Date, Duration and Priority of the reservation on Queue for Check in.
6 properties
cashSurchargeAmountType
object
Information regarding the Surcharge amount which will be applied to a payment.
4 properties
batchZeroBalanceCheckoutDetails
object
Response for batch zero balance check out.
4 properties
cardReIssueType
string
Request to re issue a new card.
fiscalInvoiceSummaryType
object
Contains information required for the generation of fiscal invoice.
13 properties
maturedDepositsType
array
Detailed information of matured deposits.
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…
42 properties
ccManualAuthorizationCriteria
object
Request for registering a Manual Authorization.
3 properties
postedRateCode
object
Response for the operation that posts a Rate Code amount on the reservation.
3 properties
routingInstructionStatusType
string
Routing instruction set is deleted.
creditLimitOveragePaymentsDetails
object
Response for Submit Credit Limit Overage Payments request
3 properties
policyBasisTypeType
string
Full Amount.
batchVouchersCriteria
object
Request type for batch vouchers.
3 properties
successType
object
Returning an empty element of this type indicates the successful processing of an message. This is used in conjunction with the Warning Type to report any warn…
folioStatusType
string
The Folio Status Example: DEPOSIT folio, VOID folio or the default OK folio status.
depositToGuestFolio
object
Request to post an existing deposit on a reservation to the Guest Folio for No Show or Canceled Reservations. Deposits remain in the deposit ledger until Check…
3 properties
ccAuthorizationInstructions
object
Response to the fetch authorization instructions. Based on the criteria requested, the response can contain information required to send a credit card authoriz…
3 properties
colorType
string
Color configuration type. This color configuration provides a visual category of entities.
folioTypeValidationType
string
Profile detail is not configured with Tax ID.
pointsType
object
The Redeem Points contains the number of points required to book a room type.
2 properties
cCAuthorizationCriteriaType
object
Contains the credit card criteria for authorization.
13 properties
additionalTaxesDetails
object
Response object containing additional tax information.
3 properties
fiscalFolioCriteriaType
object
Criteria for calling fiscal folio service for the generation of invoices
4 properties
compositeDepositCriteriaType
object
Criteria for posting a deposit to a reservation.
16 properties
billingInstructionCodes
object
4 properties
postingGroupType
object
Transaction group information. Ever posting could represent a. Regular transaction b. Group header - has Group Id, Count, Descripton and Includes Group Memeber…
4 properties
fiscalSupportingDocumentTypeEnum
string
taxAmountInfoType
object
Tax amount to be adjusted for the guest
1 property
receiptType
string
This contains the receipt type.
alertType
object
25 properties
characterUDFsType
array
Used to hold collection of user defined fields of Character/String Type.
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
reservationTransaction
object
Request to transfer a transaction(s) to a reservation. In the criteria, the target Reservation Id is required for the transfer.
3 properties
indicatorType
object
Lamp indicator Type.
2 properties
fixedChargesType
array
Holds fixed charge detail.
addressInfoType
object
Provides address information.
3 properties
reservationTrxTransferCriteria
object
Criteria for transaction transfer. The choice element should have the target Reservation Id.
10 properties
cardNumberTypeType
string
Simple type for indicating if credit card number is tokenized.
storedFolioDetails
object
Request object to update stored folio details.
3 properties
folioCommandType
string
hotelRevenueType
object
Hotel revenue type.
8 properties
authorizersCreditInfo
object
Returns credit information of Comp Accounting Authorizers.
3 properties
currencyAmountType_2
object
A monetary value expressed with a currency code.
2 properties
creditCardWallet
object
Response to the credit card wallet request. The wallet contains all the credit cards used in OPERA for a profile/reservation.
3 properties
folioTaxPaymentsInfo
object
Response to the request for Payment Tax records for a reservation. Lists all the Payment Taxes for the reservation which are available.
3 properties
cashierTransactionsDetails
object
Response for the fetch cashier's shift transactions.
3 properties
stagedTransactions
object
Response to the request to get staged transaction information for a Reservation
3 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…
prepaidCardCriteriaType
object
Holds fixed charge information.
21 properties
batchZeroBalanceCheckoutReservation
object
Request type for batch zero balance checkout.
3 properties
excludedDateType
object
Specifies all the enabled dates.
2 properties
earlyDepartureInfoType
object
Information regarding Early Departure for a reservation. Contains information regarding penalty, if any.
2 properties
cashierClosureType
object
Cashier Shift Totals and Per Hotel amounts group by currency code
3 properties
foreignCurrencyExchange
object
A set of posting transactions that need to be posted with regards to exchange.
3 properties
paymentMethodSearchType
object
Reservation Payment method search criteria for searching a reservation.
1 property
creditLimitOveragePaymentsInfo
object
Response for Fetch Credit Limit Overage Payments request
3 properties
depositFolioTransactionDetails
object
Response for the fetch transaction details request. Detail information regarding the folio transaction will be returned
4 properties
attachPolicyApplyCriteria
object
Request to attach an existing Deposit Policy on a reservation towards an existing deposit payment on the same reservation.
3 properties
convertFolioDetails
object
Response to the request to Convert Folio. Includes the new converted folio information.
3 properties
folioSplitInfoType
object
Containsts the folio split posting information.
5 properties
transactionReversal
object
Request to reverse a Payment Tax record for Thailand Tax requirement.
3 properties
applyFlexibleBenefitPostingsCriteriaType
object
Criteria for retrieving one or more guest's folio transactions.
3 properties
hotelInterfaceType
object
8 properties
depositPostingType
object
Posting details.
50 properties
cardProcessingType
string
authorizersCreditType
array
List of Comp Accounting Authorizers Credits
checkDetailsType
object
Holds check details information.
3 properties
exchangeAmounts
object
Converted values for the Exchange Currency requested.
2 properties
transactionARInfoType
object
Details of the AR account where this transaction was posted to.
3 properties
errorType
object
Standard way to indicate that an error occurred during the processing of an OpenTravel message. If the message successfully processes, but there are business e…
10 properties
autoSettleCompFoliosStatus
object
Response for auto settle comp folios. This includes collection of auto settled comp folios.
2 properties
billingChargesCriteriaType
object
Criteria type for posting charges.
7 properties
housekeepingTaskCodeType
object
Information related to a Task Code. Task Codes are used to generate task sheets in Rooms Management.
7 properties
transactionType
object
Transaction type.
4 properties
resAccompanyGuestListType
array
Collection of accompany guests
compAccountingJournal
object
Response for fetching the Complimentary Posting Journal.
9 properties
cCSurchargeAmountType
object
Information regarding the Surcharge amount which will be applied to a payment.
4 properties
resSharedGuestListType
array
Collection of shared guest reservations.
postRateCodeCriteria
object
Request to check if a Rate Code can be posted to the room manually. This will check if the Rate Code is valid, if the Products(Packages) which are defined as p…
3 properties
checkPostBillingChargesOptionsType
array
TAvailable options for this consumable
depositType
string
Enumeration Type of Deposit.
benefitsType
array
Basic information about membership benefit.
transactionsAdjustment
object
Request to adjust a transaction. In order to adjust a transaction, a valid amount or percentage is required. A valid reason code and reason text is also requir…
3 properties
facilityTaskType
object
Information regarding facility task on a reservation.
3 properties
prepaidCardCriteria
object
Request type for prepaid card creation/reload/redeem/removal process
3 properties
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.
chargesAndPaymentsCriteria
object
Request to post charges and payments on a reservation.
3 properties
codeDescriptionType
object
This contains a generic code and description information.
2 properties
fiscalResponseType
object
Provides information which is used for fiscal response processing.
2 properties
vaultHTTPTransactionMessageType
object
7 properties
transactionToSplitAndTransfer
object
Request to split a transaction on a reservation and transfer the new transaction to a different reservation or a different window on the same reservation. Spli…
3 properties
cashierClosureReportsType
array
Information of the Cashier.
reverseCertificatePostingsCriteria
object
Request to reverse the certificate postings of transactions.
3 properties
resvRoutingInfoType
object
A routing info object can either be of type Folio OR of type Room with its corresponding object.
6 properties
surnameType
string
Family name, last name.
transferCompTransactions
object
Request type for comp transactions transfer.
2 properties
depositFolioValidateCriteria
object
Request to validate a Deposit Folio for a reservation.
3 properties
autoSettlementType
object
10 properties
hotelRevenueDetails
object
Response object for hotel room revenue for all HHonors redemption reservation.
3 properties
orderByEnum
string
deferredTaxesProcessDetails
object
Response of submitting post deferred taxes for a reservation.
3 properties
earlyDepartureCriteriaType
object
Criteria type for verifying or changing an Early Departure reservation.
7 properties
postDepositToGuestFolioType
object
Criteria for transferring the Deposit Amount to the Guest Folio
3 properties
createdRoutingInstructions
object
Response when creating a routing instruction. It may optionally return a list of postings which are eligible for transfer as per the new routing instruction in…
3 properties
cCSurchargeInfoType
object
Credit Card Surcharge Information type. Information regarding surcharge which can be applied to a Credit Card payment.
3 properties
authorizationInfoType
object
5 properties
transactionServiceTypeType
object
Containsts service type posting information.
5 properties
postedBillingChargesInBatch
object
Operation response to post billing charge with list of reservations.
3 properties
searchMatchType
object
Search match indicating attribute and the matching value.
2 properties
postFiscalInfoType
object
FiscalInfo criteria type.
1 property
stringLength32000
string
Used for Character Strings, length 0 to 32000.
transactionsType
array
List of transaction information.
depositCreditBillCriteria
object
Request to Deposit Credit Bill for a reservation.
3 properties
deferredTaxesProcess
object
Request for submitting post deferred taxes for a reservation.
3 properties
fiscalSupportingDocumentCriteria
object
Request to send supporting document to fiscal partner.
3 properties
prepaidCardTrxTypeType
string
Reload transaction.
exchangeRateTransactionGenerateTaxesType
array
Exchange rate calculation tax information based on Transaction Code Generate.
uniqueIDListType
array
Unique Id that references an object uniquely in the system.
fixedChargesDetails
object
Response that contains either the fixed charges list if fetch was successful or error(s) if not.
3 properties
searchCompRoutingInstructionsRequest
object
12 properties
postingsForRefresh
object
Response object that lists the transactions that can be refreshed when a routing instruction set is refreshed.
3 properties
operaVersionNumberType
string
Current Opera Version Number
compRoutingStatusType
string
Status which indicates that the Request of Comp Routing was declined
reservations
array
Unique identifier for a reservation.
errorsType
array
An error that occurred during the processing of a message.
addressType
object
Provides address information.
19 properties
depositMaturityType
string
The deposit is transferred when the guest checks in.
cashierClosure
object
Request to close cashier's shift.
5 properties
ccBatchSettlements
object
Response for credit card settlements.
3 properties
fiscalResponseInfoType
object
Invoice information returned from the fiscal service.
2 properties
depositedFolioValidate
object
Information regarding the Deposit Policy if a Deposit Folio is going to be created for this policy.
3 properties
nameValueDetailType
object
Detailed information returned during name value search.
1 property
cashierClosureReportsList
object
Returns whether a particular report is applicable or not based on payment posting type. When no postings for a particular payment type is found, that report is…
3 properties
cCBatchSettlementsType
array
List of Settlement transaction details for credit card transaction.
folioShortInfoType
object
This type contains information of generated folios.
8 properties
proformaResponseInstructionType
string
Response instructions for Proforma Creation.
billingChargesInBatchCriteria
object
Operation to post billing charge to list of reservations.
3 properties
folioHistoryResponse
object
Response for the fetch Folio History.
9 properties
checkoutZeroBalanceReservationType
object
2 properties
countryNameType
object
Code for a country or a nationality.
2 properties
bulkPrepaidCardDetailsType
object
Holds prepaid card information.
9 properties
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
cashSurchargeDetails
object
Response to the request to fetch Cash Surcharge information for a Cash/Cheque Payment method.
3 properties
resExpectedTimesType
object
Holds the Arrival and Departure Time Information
2 properties
prepaidCardInfoType
object
Detailed information about the prepaid card.
19 properties
postedBillingPayment
object
Response notifying if the posting of a payment to a reservation was successful.
4 properties
detailPostingsType
array
Details of the transaction(Posting).
redeemPrepaidCardsStatus
object
Response for redeem Prepaid cards request.
2 properties
dateRangeType
object
Date Range with Start and End dates.
2 properties
fiscalCallStatus
object
Check if it will call fiscal or not.
4 properties
paymentCriteriaType
object
25 properties
aRAccountStatusType
object
Type for the Account Status. Status can be restricted and a message/description added to the Account.
3 properties
batchAdvanceFolioType
object
Contains criteria for process batch advance folio.
3 properties
benefitType
object
Basic information about membership benefit.
3 properties
billingPrivilegesType
object
This stores the information for Bed Tax Reporting. Mainly used in Maldives.
13 properties
finalPostings
object
Request to apply any final charges or payments to a reservation prior to checkout. This operation should be called prior to the guest settlement which would th…
4 properties
reservationDepositFolios
object
Deposit Posting Information for a reservation. Contains all deposit payments made for a reservation.
4 properties
supplementalFolioCriteriaType
object
Criteria for posting the Supplemental Folio. Includes charges and payments.
10 properties
compAccountingType
object
Authorizer Information
12 properties
reservationTaxTypeInfo
object
Provides information about the Tax Type.
9 properties
folioPrinterType
object
Information about a Printer which can be used to print a Folio.
4 properties
financialPostingsNetVat
object
Response for fetching the Posting Journal with Net and Vat breakdown.
9 properties
folioQueueType
object
List of charges that will be posted against the transaction code based from the test criteria.
3 properties
fiscalCommandsResponseInfo
object
Response after generating a commands from Fiscal Terminals screen.
3 properties
articlesSaleCriteria
object
Request to post a set of charges, payments and generate a bill for a PasserBy or for the Post-It functionality . A PasserBy is someone who is not staying at th…
3 properties
deleteTransactionCriteriaType
object
Criteria type for deletion of transactions.
4 properties
transactionServiceTypesType
array
Details about service type postings.
changedRoutingInstructions
object
Response when changing a routing instruction. It may optionally return a list of postings which are eligible for transfer as per the modified routing instructi…
3 properties
fbaReimbursementCriteria
object
PostFBA Reimbursement/Settlement operation posts reimbursement/settlement against the selected certificate records.
3 properties
formattedTextTextType
object
Provides text and indicates whether it is formatted or not.
2 properties
associatedBillInfoType
object
Associated Bill info.
5 properties
operaVersion
object
Response for Ping operation.
3 properties
resCancellationPolicyType
object
A cancellation policy attached with the reservation.
5 properties
fiscalInfoFolioCriteriaType
object
Criteria for calling fiscal Info type folio service
3 properties
passerByCriteriaType
object
Criteria type for posting charges.
12 properties
payeeTaxNumber
object
Request to validate and change Payee Tax Number.
3 properties
reservationOveragePaymentsType
object
List of Reservation details for payment that has a folio window balance equal or higher to the credit limit set for the credit card payment method of that foli…
3 properties
processReservationDepositCriteriaType
object
Criteria to process reservation deposit.
6 properties
deleteTransactionsCriteriaType
object
Criteria type for deletion of transactions.
5 properties
depositCancelRevenueType
string
The type to indicate what revenue is to be used for calculating deposit/cancellation amounts.
authorizationRuleType
object
Configured rule for computing the amount to authorize.
3 properties
summaryPostingsType
array
List of postings.
bookingTimeSpanType
object
The booking time span of the reservation, only applicable when time increments are being used.
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…
guestHousekeepingServiceRequestType
string
Possible values for the Guest Service Status.
bucketTypeType
string
Fiscal Bucket Type.
nameValueType
object
Contains name value pair.
6 properties
postedCompositeDeposit
object
Response for the post composite deposit request.
5 properties
alertAreaType
string
trxPostingInfoType
object
Transaction codes info.
13 properties
reservationPolicySummaryType
object
A collection of reservation deposit and cancellation policies.
4 properties
folioSummaryType
object
Contains Folio Details including payee information and the reservation which it's attached to.
46 properties
searchReceiptHistoryRequest
object
8 properties
reservationInfoType
object
The Reservation class contains the current reservation being created or altered.
51 properties
compPostingsType
object
Collection of comp postings.
2 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.
processFiscalRetryStatus
object
The response object to send back the fiscal service response to opera.
4 properties
transactionToWindow
object
Request for transaction transfer
3 properties
ccSurchargeDetails
object
Response to the request to fetch Credit Card Surcharge information for a Credit Card Payment.
3 properties
resCashieringType
object
Cashiering Information for the reservation.
14 properties
depositFolioCriteriaType
object
The Deposit folio posting and payments information.
17 properties
detailPostingType
object
Posting information of the transaction.
63 properties
depositTransitionStatus
object
Response Body.
3 properties
unAssociatedCreditBillType
object
Unassociated Credit Bill Details. This input is to generate a Credit Bill without having the original folio details in OPERA
3 properties
depositTransferCriteriaType
object
Criteria type for transfer of deposit amount from one reservation to one or more reservation(s).
5 properties
reservationDepositType
object
Reservation Deposit Type.
7 properties
reservationFolioInformation
object
Response for the Create Proforma WS. After the proforma is created by this request, the Opera Proforma report should be called to generate the actual physical…
3 properties
hotelCashierClosureCurrencyAmountType
object
Cashier Shift amounts for each Hotel group by currency code
3 properties
routingInstructionType
object
Routing limit can be one of the three: Credit Limit, Percetage Limit, Covers Limit
8 properties
gamingRequestStatusType
object
Type that holds guest request status details.
6 properties
reservationPaymentMethodType
object
7 properties
cashierLockCriteriaToExtend
object
Operation for extending the lifetime of a lock on a cashier.
4 properties
reservationFolioInfoType
object
Each folio will include summary and/or detailed information.
11 properties
postedCreditBill
object
Response for the request to create a Credit Folio.
5 properties
authorizerCreditDetailsType
array
List of Comp Accounting Authorizers details
redemptionType
object
Redemption information.
8 properties
fiscalFolioCriteria
object
Request to generate an Initial/Zero invoice from Fiscal Terminals screen.
3 properties
maturedDepositType
object
Matured Deposits detail.
6 properties
folioTextsType
array
This stores the description for the type of tax calculation especially with tax exemption, etc.
authorizerCreditType
object
Authorizer Information
10 properties
awardFolioInfo
object
eligible amount that is allowed to pay with award payment
2 properties
closeFolioCriteriaType
object
3 properties
postForeignCurrencyExchangeType
object
Currency conversion calculation type.
12 properties
cashierTransactionType
object
Cashier Shift Transaction Type.
4 properties
batchAutoCheckoutDetails
object
Response for batch auto check out.
3 properties
checkDetails
object
Response object to Fetch the check details for a given posting posted through the POS.
6 properties
packagePostingType
object
Posting details.
46 properties
voidedFolio
object
Response to the request for voiding a Guest Folio.
3 properties
depositDetailPostingsType
array
List of Deposit Postings with details.
ccSettlementCriteria
object
Request object to change credit card settlement information.
4 properties
postCustomerVatStatus
object
Response for the request to create a Customer Vat Folio.
3 properties
telephoneInfoType
object
Information on a telephone number for the customer.
3 properties
fiscalServiceType
object
Generate Fiscal Folio Criteria type to be used for fiscal folio generation
5 properties
autoSettleCompFolios
object
Request to auto settle comp folios. OPERA will reference the 'Default Comp Payment Method' setting to settle the folio if no authorizer AR account is associate…
2 properties
depositPostingsType
array
A List of Deposit Payments.
folioWindowType
object
A folio window view which holds the set of folios for a reservation.
38 properties
linkReservationPackageAllowance
object
Method to create package allowance link from a source reservation to the target reservation.
6 properties
coversInfoType
object
Type to provide the information related to covers based on the transaction code and date.
8 properties
autoSettleCompFolioType
object
Information about comp folio that was auto settled.
12 properties
trxSplitCriteriaType
object
Criteria which should be used for Splitting a financial transaction which belongs to a reservation.
4 properties
cashierTransactionsType
object
Cashier Shift Totals and Per Hotel transactions group by transaction code
4 properties
stagedCompTransactionsInfoType
array
Transaction ID List of staged comp transactions for the reservation.
waitlistResType
object
Information regarding why reservation is being /has been waitlisted.
6 properties
prepaidCardTransactionsType
array
Prepaid card transaction details.
depositPaymentCriteriaType
object
Criteria for posting a deposit payment to a reservation.
32 properties
closeFolioCriteria
object
Request to close an Open Folio Reservation. The Property should be using the Open Folio Functionality to use this operation.
3 properties
nameValueOriginType
object
Contains origin details.
4 properties
folioTransferCriteriaType
object
Folio(s) Transfer Criteria type to be used for folio transfer request.
6 properties
transactionToSplit
object
Request to split a transaction on a reservation. Splitting of transactions requires a list of transactions and a valid amount or a percentage by which the amou…
3 properties
postingsInfoType
object
This type is useful to hold the transaction details along the transaction code information.
2 properties
postBillingCheckChargesCriteriaType
object
Details of the check with line item charges to post to a guest folio.
7 properties
profileRestrictions
object
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
checkoutReservationType
object
10 properties
exchangeRateCalculationTaxType
object
Detailed information about exchange rate calculation service tax.
6 properties
transactionCodes
object
Response that contains either the Transaction Code list if fetch was successful or error(s) if not.
3 properties
calculatedForeignCurrency
object
Information regarding charges in batch result for each reservation.
3 properties
voidFolioCriteriaType
object
Criteria for Voiding a Folio.
16 properties
fixedChargeScheduleType
object
Holds schedule of fixed charge.
5 properties
cashierClosureAmountType
object
Cashier Opening Balance and Shift Amounts type.
5 properties
ccAuthorizationCriteria
object
Request for a credit card authorization. An authorization request will be sent to the Credit Card Vendor as part of this request.
3 properties
bedTaxCriteria
object
Request type for change bed transaction info
3 properties
customChargeQuantityType
object
Contains quantity of custom charge exemptions.
3 properties
packagePostingsType
array
List of package postings.
reverseCertificatePostingsCriteriaType
object
Criteria type for reversing certificate postings of transactions.
5 properties
folioTypeNameInfoType
object
Details of a Folio Type configuration.
5 properties
postingActivityDetailType
object
Details of a Posting transaction change.
5 properties
cashieringTransactionTypeType
string
Wrapper Transaction Type.
earlyDeparture
object
Request to change a reservation to an Early Departure. As part of this process the reservation will be changed to a Due Out status with the departure date bein…
3 properties
chargeCriteriaType
object
Criteria information for posting a charge.
18 properties
paymentTax
string
The types of Payment Tax transactions.
trxInfoType
object
Transaction codes info.
13 properties
billingChargesDetails
object
Response notifying if the posting of a charge to a reservation was successful.
4 properties
changeChargeCriteriaType
object
15 properties
batchDeposit
object
Request for submitting batch deposit for reservations.
3 properties
roomRoutingPostings
object
2 properties
resPeriodicFolioType
object
Information regarding periodic folios set on the reservation.
3 properties
resAttachedProfileListType
array
resGuestExternalInfoType
object
Specifies Company or Travel Agent profile using IATA or Corp. No.
2 properties
postBillingCheckChargesItemCriteriaType
object
Line item of check to post.
3 properties
generatePostingType
object
Financial posting with their breakup
5 properties
folioSplitType
string
Indicates the type of folio to be created on the window.
advanceRoomChargesReservationInfo
object
Response for the generate advance folio request. Post Advance Room Charges Request can return the below error codes : FOF00065 - Reservation ID or Resort was n…
3 properties
paymentReversalCriteria
object
Request for posting payment reversal.
3 properties
givenNameType
string
Given name, first name or names
prepaidCardsInfoType
array
Prepaid card info object.
searchFiscalSupportingDocumentsRequest
object
16 properties
fixedCharges
object
Method to update fixed charges of a reservation.
5 properties
advanceCheckInType
object
Information relating to Reservation's Advance Checked In state and Expected Time of Return
3 properties
roomRoutingRefreshCriteriaType
object
Criteria for refreshing the routing instruction set.
8 properties
checkoutInstructionsType
object
4 properties
resRevenueBalanceType
object
Revenue and Balance Amount summary for the reservation.
9 properties
originalReservationInfo
object
Original Reservation Information
5 properties
customChargeExemptionDateType
object
Contains Custom Charge Exemption information for a day.
3 properties
supportingDocumentType
object
Supporting document details.
16 properties
authorizerCreditDetailType
object
Information about the Authorizer Credit detail
3 properties
facilityCodeType
object
Facility Housekeeping Code, its description and quantity.
3 properties
redeemPrepaidCards
object
Request type for Prepaid card redeem amount request
3 properties
amountEligible
object
List of eligible bill amounts for each folio.
1 property
cashierReportPostingsInfo
object
Response for fetching the Cashier report transactions.
4 properties
exclusionReasonType
string
Custom Charge has already been Processed for this date within the reservation stay.
cashSurchargeInfoType
object
Cash Surcharge Information type. Information regarding surcharge which can be applied to a payment.
5 properties
customerVatFolioCriteriaType
object
Criteria for creating Customer Factura Vat Folio.
4 properties
prepaidCardRedemptionType
object
Redemption information.
6 properties
postingActivityDetail
object
Response to the request to get financial details for a Posting Activity. This will return the before and after values for the transactions which were changed.
3 properties
searchFolioHistoryRequest
object
31 properties
putBillingChargesStatus
object
Response Body.
2 properties
deferredTaxesCriteriaType
object
Contains criteria to post the deferred taxes for the given reservation.
4 properties
bedTaxReportingType
object
This stores the information for Bed Tax Reporting. Mainly used in Maldives.
5 properties
fiscalFolioInstruction
string
Action to generate Offline folio when no response is received from fiscal service.
vaultTransaction
object
Request to register the vault HTTP transaction.
3 properties
linkedAllowanceReservationsInfoType
object
List of reservation with linked package allowances.
3 properties
paymentReversalType
object
Information regarding the payment transaction to be reversed.
4 properties
cashierClosureDetails
object
Response for the fetch Cashier Closure information.
3 properties
cashierClosureCurrencyAmountType
object
Cashier Shift Currency Amount type - cash ,check ,credit and others elements.
5 properties
storedFolioDetailsType
object
Stored Folio Details type.Folio can be printed/viewed without re-generation.
5 properties
statusType
string
Status of the batch process.
compRoutingRequestType
object
Type for the details of a Comp Routing Request
4 properties
bedTaxInfo
object
Response for bed transaction info
3 properties
excludedDatesType
array
Contains list of dates which are valid for custom charge exemptions.
interfaceRightsStatusType
object
4 properties
exchangeRateInfoType
object
Exchange rate information of a currency.
2 properties
resGuestInfoType
object
Specifies Company or Travel Agent profile using IATA or Corp. No.
30 properties
reservationFolioWindowType
object
Folio window view which holds the set of folios for a reservation.
4 properties
advanceRoomChargesInfoType
object
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
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
convertFolioType
object
Criteria for Converting Folio.
5 properties
customNameValueConfigType
string
Italian Lottery Number.
createProformaCriteriaType
object
Criteria for creating Proforma transactions for a reservation. These transactions will be used by the Opera Proforma Report.
3 properties
advancePaymentBalance
object
Response for the advance payment balance.
3 properties
cashOutPrepaidCardStatus
object
2 properties
reservationInterfaceStatusType
object
Hotel Interface Type for a reservation and status of the various services
3 properties
billingInstructionsType
array
Set of Billing Instruction codes.
batchAutoSettlementCriteria
object
Request type for batch auto settlement.
3 properties
exchangeRateTransactionGenerateTaxType
object
Tax information based on Transaction Code Generate.
3 properties
addressSearchType
object
Address Details such as city, state, country, postal code etc.
6 properties
depositPolicyType
object
Used to define the deposit policy, guarantees policy, and/or accepted forms of payment.
10 properties
commissionPayoutToType
string
folioActivityDetailsType
object
Fiscal Folio Activity information
3 properties
childAgesType
array
Age of a child in years.
projectedRevenueType
object
Information about projected catering and room revenue for the reservation.
3 properties
advanceRoomCharges
object
Request to post the Room Charges for a reservation in advance. This request posts the Room Charges for a reservation for tonight or for many nights starting fr…
3 properties
postingBreakdownType
object
Details of a financial posting's breakdown.
3 properties
routingInstructions
object
Request to create a routing instruction.
3 properties
compRoutingStatusEnum
string
nameValueBaseSearchType
object
Contains name value information search criteria.
5 properties
cardTypeType
string
This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method.
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
creditBillCriteriaType
object
Criteria for posting the Credit Bill. Includes charges and payments.
13 properties
bulkPrepaidCardCriteria
object
Request type for bulk prepaid card creation/reload/redeem/removal process
4 properties
ccBatchSettlementsStatus
object
Response for credit card settlements status.
3 properties
fiscalSupportingDocumentType
string
Fiscal Supporting Document Type
reservationFolioWindowsType
array
Collection of reservation folio windows.
prepaidCardTransactionType
object
Prepaid Card transaction.
9 properties
activatePrepaidCardStatus
object
2 properties
cashOutPrepaidCard
object
Request type for cashout prepaid card.
2 properties
resAccessRestrictionType
string
Indicates any Updates/Changes on the reservation as well as Reservation Cancellation are not allowed.
billingCharges
object
Request to post a charge on a reservation's folio.
3 properties
nameValuesType
array
List of name value pairs.
commentInfoType
object
Comment related to the profile/reservation.
8 properties
reservationIdList
array
Unique Id that references an object uniquely in the system.
depositDetailPostingType
object
Posting information of the transaction .
53 properties
adjustedTransactions
object
Response for the adjustment of transactions request. Contains any errors or warnings.
4 properties
proformaReservationFolio
object
Request to create a Pro-Forma(folio) transactions for a reservation. The request generates the internal transactions required to create a Pro-Forma folio, pass…
3 properties
foreignCurrencyCriteria
object
Operation to calculate foreign currency exchange.
5 properties
nameValueHeaderDetailType
object
Name value details collected before Folio Settlement
2 properties
routingInfoType
object
A routing info object can either be of type Folio OR of type Room with its corresponding object.
5 properties
createProformaFolioCriteriaType
object
Criteria for creating Pro-Forma transactions for a reservation. These transactions will be used by the Opera Proforma Report.
1 property
bulkPrepaidCardCriteriaType
object
Holds fixed charge information.
13 properties
alertsType
array
List of alerts.
queueTextInfoType
object
Information regarding the message sent to guest.
2 properties
billingInstructionType
object
Configured Billing Instruction which represents a set of Transaction Codes.
4 properties
adjustmentDetailsType
object
Details regarding adjustments of transactions. Adjustment of transactions requires a amount/percentage and the adjustment reason.
5 properties
generatedFolio
object
Generate Folio Response contains generated folio no and invoice number along or errors and warnings in case if folio couldn't be generated: FOF00065 - The hote…
3 properties
folioWindowExchangeAmounts
object
Converted folio windows values for the Exchange Currency requested.
3 properties
childBucketsType
object
Defines children counts with Age Qualifying Group(Child Bucket) classification.
5 properties
aRAccountShortInfoType
object
Accounts Receivabales Account details type charged for batched posting.
4 properties
stringLength100
string
Used for Character Strings, length 0 to 100.
vIPStatusType
object
VIP status of the customer.
2 properties
saleCriteriaType
object
Criteria type for posting charges.
11 properties
cashierInfoType
object
Cashier information. Contains Id and Name details of the cashier.
2 properties
reservationTurndownInfoType
object
Turndown information for a reservation
2 properties
depositMaturityDetails
object
Response object for deposit maturity information type.
3 properties
activatePrepaidCard
object
Request type for activate prepaid card.
2 properties
compRedemptionsType
array
Information regarding Complimentary Bucket Redemption object.
postRateCodeCriteriaType
object
Criteria type for posting a Rate Code amount to a guest folio.
17 properties
folioActivityResponseDetailsType
object
Details of response for the Fiscal Folio Activity made.
5 properties
folioType
object
Represents a single page in a reservation's ledger which will contain transactions and payee information.
16 properties
depositCreditBillCriteriaType
object
The Deposit Credit Bill information.
6 properties
voidFolioModes
string
Different modes to perform void folio.
resProfileTypeType
string
advanceRoomChargesCriteriaType
object
Type to set the criteria for generation of advance folios. This will post the room and tax transactions for the nights requested.
7 properties
codeListType
array
reservationVouchersType
object
Vouchers information of a reservation.
1 property
policyApplyCriteriaType
object
Criteria for Attaching or Detaching a Deposit Policy towards a Deposit payment.
3 properties
customChargeExemptionsType
array
List of Custom Charge Exemptions.
customChargeExemptionType
object
Contains custom charges exemption information.
6 properties
billingCharge
object
Request to edit a billing charge information.
3 properties
financialPostingsType
object
Collection of Reservations and their information.
7 properties
guestCheckDetails
object
Request to process a guest check detail.
4 properties
coversInfo
object
Response that contains either the Transaction Code list with Covers info if fetch was successful or error(s) if not.
3 properties
flexibleBenefitPostingsCriteria
object
Apply Flexible Benefit Postings.
3 properties
commentType
object
An indication of a new paragraph for a sub-section of a formatted text message.
19 properties
compRoutingInstructions
object
Response object containing comp routing instructions for a reservation .
3 properties
reservationFolio
object
Request to create a Proforma(folio) transactions for a reservation. The request generates the internal transactions required to create a Proforma report. After…
3 properties
profileInfoType
object
Provides information about attached profiles to the block.
5 properties
articlePostItType
object
Post it information of an article.
2 properties
resDepositPolicyType
object
A deposit policy attached with the reservation.
6 properties
nameTypeType
string
membershipInfoType
object
The Membership object identifies the frequent customer reward program.
13 properties
reservationDepositCriteria
object
Request object to process reservation deposit.
3 properties
passerBySale
object
Details of the folio created.
3 properties
chargeLongTrxCodeCriteriaType
object
Criteria information for posting a charge.
16 properties
billingPaymentToChange
object
Request to change a payment posting.
3 properties
payeeInfoType
object
Payee information.
8 properties
blockIdList
array
Unique Id that references an object uniquely in the system.
nameValueDataTypeType
string
guestsTransactions
object
Lists a summary of transactions of guests.
4 properties
authorizationHistoryType
object
Information on a single credit card authorization transaction.
11 properties
resMobileNotificationsType
object
Contains the status of Room Ready and Key Ready messages.
5 properties
sourceOfSaleType
object
Point of Sale of reservation. Identifies the entity/channel who made the reservation.
2 properties
reservationStatusCodeEnum
string
membershipType
object
Detailed information of the memberships.
41 properties
transactionAdjustmentInfoType
object
Adjustment details of the transaction, if the transaction was created as part of an adjustment.
3 properties
linkedAllowanceReservationInfoType
object
Linked Allowance Reservation Information.
6 properties
fiscalSupportingDocumentCategory
string
Supporting document category.
welcomeOfferType
object
2 properties
cashieringPaymentMethodType
object
9 properties
authorizationInfo
object
Response to the credit card authorization request.
4 properties
guestLastStayInfoType
object
Contains last stay related details of the guest.
4 properties
maturedDepositsDetails
object
Response of matured deposits.
3 properties
emailInfoType
object
Information on an email for the customer.
3 properties
cCManualAuthorizationCriteriaType
object
Type for registering a manual authorization.
5 properties
creditCardInfo
object
Information on a credit card for the customer.
7 properties
facilityCodesType
array
List of the facility codes.
postingSummaryList
object
Response object to fetch daily summary charges from Opera which are posted in Opera by external system.
3 properties
nameValueTypeType
string
sortOrderEnum
string
roundingDifferenceAmountType
object
Information regarding the rounding difference which can be applied to the payment amount, based on the payment method.
3 properties
personNameTypeType
string
Person's name in an external system.
welcomeOfferOptionsType
string
None of the Welcome Offer option is selected.
postedDepositCreditBill
object
Response to the request to Deposit Credit Bill for a reservation.
5 properties
dateUDFsType
array
Used to hold collection of user defined fields of Date Type.
resCompAccountingType
object
Information regarding comp accounting on the reservation.
3 properties
dateUDFType
object
Used to hold user defined field of Date Type.
3 properties
postSupplementalFolioStatus
object
Response for the request to create Supplemental Folio.
5 properties
cCBatchSettlementsStatusType
object
List of CCBatchSettlementStatusType type
3 properties
folioActivityResponseDetailType
object
Fiscal Folio Activity Details Information
3 properties
creditBillCriteria
object
Request to post a Credit Folio for an existing Folio. Credit Bill Functionality parameter is required.
3 properties
resAttachedProfileType
object
4 properties
compositeDepositInfo
object
Request to post a deposit payment or a deposit folio to a reservation.
3 properties
fiscalSupportingDocumentCriteriaType
object
Criteria for sending supporting document to fiscal partner.
3 properties
taxTypeType
object
Provides information about the Tax Type.
8 properties
receiptHistoryResponse
object
Response for the fetch Receipt History.
3 properties
articlesSale
object
Details of the folio created.
3 properties
cCBatchSettlementsProcessType
object
Type for starting settlements job process.
3 properties
routingInstructionsDetails
object
Response object containing routing instructions for a reservation.
3 properties
changeGuestCheckDetails
object
Request to update a guest check detail.
4 properties
compTransactionAuthorizers
object
Response object for fetch comp authorizers operation.
9 properties
fixedChargeDetailType
object
Fixed charge amount could be specified by flat fee or be a percentage of the rate amount.
7 properties
resvRoutingInfoListType
array
A comp routing info object
bulkPrepaidCardsType
object
Response for posting bulk prepaid cards.
4 properties
splitDepositTransactionStatus
object
Response after spliting deposit transaction.
3 properties
folioTypesInfoType
object
Folio Types details.
5 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.
ccAuthorizationInstructionsCriteria
object
Fetch credit card authorization instructions.
3 properties
autoSettleCompFoliosType
array
Information about comp folio that was auto settled.
cCBatchSettlementType
object
Credit card transaction detail for batch settlement
10 properties
responseInstructionType
string
Response types used in the Apply Final Postings request. Based on the request the folio summary , folio details or no details will be returned in the response.
folioTransactionDetails
object
Response for the fetch transaction details request. Detail information regarding the folio transaction will be returned
4 properties
roomRoutingRefresh
object
The request object for processing refreshing of a routing instruction set. This operation transfers the postings to the respective reservation as per the routi…
3 properties
reinstateCheckedOutReservation
object
Request to reinstate checkout reservation in order to post additional transactions, etc.
7 properties
cashierClosureInformation
object
Response to the request to get financial details for a Posting Activity. This will return the before and after values for the transactions which were changed.
3 properties
postingSummaryType
object
summary of the postings by external system.
3 properties
convertFolioCriteria
object
Request to convert folio from a Non Fiscal Folio type to a Fiscal Folio Type. Functionality is used in Italy and is only available when the country mode is set…
3 properties
reservationDepositFolioInfoType
object
Detailed information of a reservation and its deposit payment posting information.
9 properties
certificateReconciliationTypes
array
List of CertificateReconciliationType criteria
compTransactionCriteria
object
Request object to submit a comp transaction to gaming system
4 properties
profileIdList
array
Unique Id that references an object uniquely in the system.
routingInfoListType
array
A routing info object can either be of type Folio OR of type Room with its corresponding instructions.
customerVatFolioCriteria
object
Request to create Customer Factura Vat Folio from a Rachunek Folio.
3 properties
prepaidCardDetailsType
object
Prepaid Card Details.
10 properties
reservationAllowedActionType
string
Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation.
passerBySalesCriteria
object
Request to post a set of charges, payments and generate a bill for a PasserBy or for the Post-It functionality . A PasserBy is someone who is not staying at th…
3 properties
reservationPackageOptions
object
Response to fetch reservation package options.
5 properties
depositFolioValidateCriteriaType
object
Criteria for posting a Deposit Folio.
5 properties
batchDepositType
object
Contains criteria for batch deposit for reservations.
3 properties
resSharedGuestInfoType
object
Contains information regarding the share reservation.
4 properties
batchVouchersType
object
1 property
folioTypeNameInfo
object
Response for the fetch Folio Type Information.
3 properties
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
folioPrinters
object
Response to the request to fetch the Folio Printers applicable for a Folio, based on the
3 properties
customChargeGuestInfoType
object
4 properties
namePrefixType
string
Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.)
ccBatchSettlementsProcessCriteria
object
Request to process batch settlements
3 properties
proformaFolioResponseInstructionType
string
Response instructions for Proforma Folio Creation.
personNameType
object
This provides name information for a person.
12 properties
fBAStatusType
string
Flexible benefit award has been reimbursed.
paymentMethodsSearchType
array
Defines the payment method to search reservations.
communicationStatusType
string
Enum to denote the Status of Readiness messages sent to Guest Devices.
validatedTransactionCode
object
Response notifying if transaction code is valid.
4 properties
fiscalSupportingDocumentsResponse
object
Response for the supporting documents.
9 properties
billingChargeStatus
object
Response Body.
2 properties
folioTaxPaymentReversal
object
Response for the reverse Thailand Tax Payment Tax record request.
4 properties
depositRefundEligibleCheck
object
Response for the refund deposit payment.
3 properties
proformaFolio
object
Response for the Create Proforma WS. The proforma is created by this request, passed into the response and finally the proforma transactions are removed.
4 properties
resPaymentCardType
object
Information on a credit card for the customer.
20 properties
cancelPrepaidCardTransactionStatus
object
2 properties
ccAuthorizationInstructionsCriteriaType
object
Contains the credit card criteria for fetching authorization instructions.
20 properties
depositProcessType
string
The Deposit is transferred to an internal account for returned deposits to be handled by the property. Users can select to keep all (not exceeding total), a po…
financialPostingsNetVatType
object
Financial Postings with their Net and Vat breakup
2 properties
summaryPostingType
object
Posting details.
54 properties
resHousekeepingType
object
Holds housekeeping turndown service information for the room.
7 properties
exchangeRateCalculationType
object
Currency conversion calculation type.
17 properties
detachPolicyApplyCriteria
object
Request to detach a deposit payment from a Deposit Policy on a reservation.
3 properties
indicatorsType
array
Collection of lamp indicators.
paymentTaxType
object
Information regarding payments made which have Payment Tax.
12 properties
folio
object
Response to the request to get Financial Information for a Reservation
4 properties
batchAutoCheckoutReservation
object
Request type for batch auto checkout.
3 properties
cashieringEventType
string
Event being generated by a Supplemental Folio.
foreignCurrencyExchangeTransactionType
object
Details about posting and generated folio on currency exchange.
2 properties
receiptsType
array
Receipt History details.
revenueBucketTotalsType
array
List of revenue bucket total details
changePayeeTaxNumberCriteriaType
object
Criteria to validate and change payee tax number.
5 properties
depositPayment
object
Request to post a deposit payment to a reservation.
3 properties
telephoneType
object
Information on a telephone number for the customer.
12 properties
depositFolioCriteria
object
Request to create a Deposit Folio for a reservation.
3 properties
autoSettleCompFoliosCriteriaType
object
Criteria to auto settle comp folios of a reservation.
4 properties
postedDepositFolio
object
Response to the request to create a Deposit Folio for a reservation.
5 properties
trxTransferCriteriaType
object
Transactions can be transferred to either a FolioWindow Number of the same reservation or to another Inhouse Reservation.
10 properties
reservation
object
Checkout request can be used to verify a reservation for checkout and do an actual checkout. In case the verificationOnly attribute is sent false, the operatio…
4 properties
cashierClosureInfoType
object
Cashier closure Information.
8 properties
reverseCompRedemptions
object
Request type of complimentary bucket redemptions reversal.
2 properties
nameValueModuleType
string
cancelPrepaidCardTransaction
object
Request type for cancel prepaid card transaction.
2 properties
billingChargesType
object
Criteria for the charge information list to be edited.
2 properties
tierAdministrationType
string
Do not upgrade membership. The membership may be downgraded.
reloadPrepaidCardStatus
object
2 properties
alertGuestInfoType
object
13 properties
foreignCurrencyExchangeTransaction
object
Response of the posting foreign currency exchange transaction.
3 properties
postingSummaryListType
array
Summary of the postings by external system.
billingPayment
object
Request to post a payment on a reservation's folio.
4 properties
prepaidCardTransactionInfoType
object
Prepaid Card Transactions
8 properties
fiscalRetryType
object
Generate Fiscal Folio Retry Criteria type to be used for fiscal folio generation
4 properties
receiptSummaryType
object
Contains Receipt Details.
10 properties
billingChargesStatus
object
Response when checking or inquiring the available options for a set of billing charges.
3 properties
financialPostings
object
Response for fetching the Posting Journal.
9 properties
splitDepositTransaction
object
Request to split deposit transaction for a reservation.
3 properties
bedTaxInfoType
object
Bed Trx Info type
22 properties
folioTypesInfo
object
Information regarding the Folio Types.
3 properties
chargesCriteriaType
array
Collection of Charges to be posted.
authorizerInfoType
object
Authorizer Information
5 properties
resCommunicationType
object
Communication details for a reservation.
2 properties
cCBatchSettlementStatusType
object
Provides status information for credit card settlements .
3 properties
trxSplitAndTransferCriteriaType
object
Type to define the criteria for Splitting and Transferring the new transaction.
6 properties
postCompRedemptions
object
Request type of complimentary bucket redemptions posting.
2 properties
resDepositPoliciesType
array
A list of deposit policies attached with the reservation.
folioActivityDetailType
object
Details of Fiscal Folio Activity made.
9 properties
changeCheckDetailsType
object
Holds check details information.
2 properties
postingTimeType
object
Time of posting.
2 properties
reservationChargesInBatchInfoType
object
Result of charges in batch for each reservation.
9 properties
awardPaymentDetails
object
Request object for fetching a membership transaction.
8 properties
balanceInfoCriteria
object
Response for the fetch balance request. This will contain the current balance for the criteria requested.
5 properties
basicEmailType
string
Email address
acquiredCashierLock
object
Response for the Cashier Lock request.
4 properties
operaLockRecordType
string
routingInstructionsToChange
object
Request when changing a routing instruction.
3 properties
cardAuthorizationTransactionType
string
Currently supported transaction type categories used for credit card authorization.
operaRecordLock
object
This type contains information about a record lock.
8 properties
articleInfoType
object
Information regarding an article.
10 properties
gamingRequestStatusInfo
object
Response object for fetch gaming info
3 properties
earlyDepartureInfo
object
Response for Early departure verification. Contains information regarding early departure penalty amount if applicable and any errors or warnings as to why the…
3 properties
policyAmountPercentType
object
Defines the percentage basis for calculating the fee amount or the amount.
5 properties
hotelCashierTransactionType
object
Cashier Shift amounts for each Hotel group by currency code
2 properties
extendedCashierLock
object
This response will indicate whether or not the extension was successful. This operation may return errors when the lock being requested to be extended no longe…
3 properties
folioPrintersType
object
List of Folio Printers.
2 properties
roundingDifferenceAmount
object
Response to the request to fetch the rounding difference for a payment amount.
3 properties
postPaymentActionType
string
Advance Payment Action.
numericUDFsType
array
Used to hold collection of user defined fields of Numeric Type.
reservationDepositFoliosInfoType
array
Detailed information of a reservation and its deposit payment posting information.
cashierLockHandle
number
The Cashier Lock Handle to pass along with operation which required cashier to be locked.
revenueBucketTotalType
object
reservation revenue bucket total information.
2 properties
offsetUnitType
string
Indicates deadline offset unit type.
revenueBucketTotals
object
Response object for revenue bucket totals for a reservation.
3 properties
activityLogType
object
11 properties
depositTransferCriteria
object
Request to transfer a deposit amount from one reservation to one or more reservations.
3 properties
depositTransferToReservationType
object
Deposit Transfer detail for the target reservation.
3 properties
changePaymentCriteriaType
object
8 properties
resGuaranteeType
object
Validations type record returned after Validations are done.
3 properties
phoneNumberType
string
Phone number
hotelInterfaceStatusType
string
Status of the Hotel Interface either STOPPED or RUNNING.
prepaidCardTransactionSourceType
string
Vendor transaction source type.
cashierClosureNoType
object
Type used in cashier closure to specify a cashier's shift.
5 properties
reservationOveragePaymentType
object
Details of the reservation with the folio balance equal or higher to the credit limit
12 properties
billingChargeType
object
13 properties
processFiscalRetry
object
The request object to process fiscal retry functionality.
3 properties
redeemPrepaidCardCriteriaType
object
Criteria for Prepaid card redeem request.
5 properties
depositTransactionType
object
Deposit transaction of a reservation.
5 properties
stringLength40
string
Used for Character Strings, length 0 to 40.
revenueBucketCodeType
object
This gives detailed information about a trx code arrangement.
8 properties
depositMaturityInfoType
object
Deposit maturity information type.
3 properties
transferTransactionToWindow
object
Response Body.
3 properties
autoFolioSettlementCriteriaType
object
4 properties
generateFolioCriteriaType
object
Generate Folio Criteria type to be used for folio generation request
23 properties
guestCountsType
object
A collection of GuestCount by age group.
4 properties
emailType
object
Information on an email for the customer.
11 properties
folioToWindow
object
Request for transaction folio(s) to specific window
3 properties
postRateCodeCheckType
object
The response type for Checks done before Posting a Rate Code amount to a reservation.
3 properties
postBillingCheckChargesItemsCriteriaType
array
Line items of the check.
cCAuthorizationInstructionType
object
Contains the details to use for a credit card authorization.
14 properties
alertNotices
object
Response with the fetched alerts, includes global alerts.
4 properties
fixedChargeType
object
Holds fixed charge information.
8 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.
gamingRequestStatusInfoType
array
List of guest request status details.
compTrxAuthorizers
object
Response object for fetch comp authorizers operation.
3 properties
customChargeExemptionDatesType
array
Contains List of Custom Charge Exemption information for a day.
paymentTaxInfoType
object
Type for Package Tax Information for Thailand Tax functionality.
3 properties
resvRoutingCriteriaType
object
A routing info object can either be of type Folio OR of type Room with its corresponding object.
8 properties
certificateReconciliationType
object
FBA ( Flexible Benefits Awards ) related fields.
26 properties
trxCodesInfoType
array
List of Transaction codes info.
folioToVoid
object
Request to Void a Guest Folio when the Void Functionality is active.
3 properties
folioReasonType
object
Type for Folio Reason and Text.
2 properties
resCancelPenaltyType
object
The CancelPenalty class defines the cancellation policy of the hotel facility.
9 properties
reservationAllowedActionsType
array
Allowed action.
batchAdvanceFolio
object
Request for submitting batch advance folio.
3 properties
putBillingCharges
object
Request to edit a billing charge information.
3 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.
cashierClosureInfoTypes
array
Information of the Cashier.
postBillingChargesInBatchCriteriaType
object
Criteria type for posting charges.
3 properties
currencyExchangeType
string
E-certificate conversion.
reservationVoucherType
object
Reservation voucher detail.
5 properties
trxCodesPostingInfoType
array
List of TransactionCodes
postRoomAndTaxForDayUse
object
3 properties
stringLength200
string
Used for Character Strings, length 0 to 200.
languageType
string
billingCheckChargesCriteria
object
Request object for PostBillingCheckCharges operation.
3 properties
paymentTaxesType
array
Payment Tax record.
resPreConfiguredRoutingInstrType
object
Instruction to attach Pre-Configured Routing Instructions to a Reservation.
4 properties
userInfoType
object
Opera User Information
2 properties
reloadPrepaidCard
object
Request type for reload prepaid card.
2 properties
postSupplementalFolio
object
Request to post a Supplemental Folio for an existing Folio. Debit Bill ( Supplemental Folio ) Functionality parameter is required
3 properties
depositedPayment
object
Response for the post deposit payment request.
4 properties
checkedRateCode
object
Response for the request to check if a Rate Code can be posted to a reservation .
3 properties
fiscalInfoFolioCriteria
object
Request to generate fiscal Information folio.
3 properties
creditLimitOveragePayments
object
Request to start the Credit Limit Overage process for the reservations with a folio window balance equal or higher to the credit limit set for the credit card…
3 properties
bulkPrepaidCardsStatusType
object
Provides status information for bulk Prepaid Cards.
3 properties
cashierReportType
string
Shift drop report created when cashier closure is completed. It is an integral part of closure report and is not to be printed or accessed by itself.
reservationBlockType
object
Key information about the block for a reservation.
3 properties
fixedChargeFrequencyType
string
Yearly.
trxAdjustCriteriaType
object
9 properties
resCancellationPoliciesType
array
A list of reservation cancellation policies.
anonymizationStatusType
string
Guest has been anonymized.
characterUDFType
object
Used to hold user defined field of Character/String Type.
3 properties
policyDeadlineType
object
Cancellation deadline, absolute or relative.
4 properties
storedFolioDetailsInfo
object
Response object for fetch stored folio details operation
3 properties
fiscalInformationFolio
object
Response Body.
3 properties
childAgeType
object
Defines Child's Age.
1 property
payloadType
string
Fiscal Payload Type.
prepaidCardRedemptionsType
array
A prepaid redemption info object to be used for posting a payment.
foliosType
array
Folio History details.
bedTaxInfoTypes
array
List of Bed Tax info.
validatedCreditBill
object
Response to the request to check if a Folio is valid for Credit Bill.
3 properties
folioCriteria
object
Generate Folio request can be used to create a folio for checked in reservation or reservation with open folios
3 properties
authorizationHistory
object
The result element containing a history list of credit card authorizations for a particular reservation, filtered by the requested criteria.
3 properties
paragraphType
object
An indication of a new paragraph for a sub-section of a formatted text message.
3 properties
vaultHTTPTransactionType
string
transactionCurrencyExchangeInfoType
object
Details of the Exchange Information for this transaction, if the posting was made in a currency different from the default currency.
7 properties
anonymizationType
object
Provides information about guest's anonymization status.
2 properties
hotelInterfaceTypeType
string
XML Posting Interface
reservationRoomOwnershipType
string
Indicates if the assigned reservation room is an Owner/Referral or Regular room.
postingBreakdownType_2
object
Details of a financial posting's breakdown.
3 properties
detailPostingType_2
object
Posting information of the transaction.
62 properties
generatePostingType_2
object
Financial posting with their breakup
5 properties
resPaymentCardType_2
object
Information on a credit card for the customer.
20 properties
exchangeAmounts_2
object
Converted values for the Exchange Currency requested.
2 properties
summaryPostingType_2
object
Posting details.
50 properties
reservationPaymentMethodType_2
object
7 properties
financialPostingsNetVat_2
object
Response for fetching the Posting Journal with Net and Vat breakdown.
5 properties
authorizationRuleType_2
object
Configured rule for computing the amount to authorize.
3 properties
transactionCurrencyExchangeInfoType_2
object
Details of the Exchange Information for this transaction, if the posting was made in a currency different from the default currency.
7 properties
currencyAmountType_3
object
A monetary value expressed with a currency code.
2 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 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
#Cashiering
Where this information came from
This is an independent, third-party profile of Oracle Hospitality Cashiering 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.