Oracle Hospitality · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Oracle Hospitality Cashiering API
204 actions
204 updates
phrasing
extends
openapi/oracle-hospitality-cashiering-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Oracle Hospitality's API. It is a proposal applied on top of the contract, not a document Oracle Hospitality publishes.
What the actions change
x-apievangelist-phrasing
Targets 204 · first 16 shown; the file carries all of them
$.info
$.paths['/hotels/{hotelId}/memberships/{membershipId}/compRedemptions'].get
$.paths['/hotels/{hotelId}/memberships/{membershipId}/compRedemptionAuthorizations'].put
$.paths['/hotels/{hotelId}/memberships/{membershipId}/compRedemptionPostings'].post
$.paths['/hotels/{hotelId}/memberships/{membershipId}/compRedemptionReversals'].post
$.paths['/hotels/{hotelId}/asyncCompPostingsApproval'].put
$.paths['/hotels/{hotelId}/compPostingsApproval'].put
$.paths['/hotels/{hotelId}/compPostingsReversal'].put
$.paths['/cashierReportPostings'].get
$.paths['/cashiers/{cashierId}/closure'].put
$.paths['/cashiers/{cashierId}/locks'].get
$.paths['/cashiers/{cashierId}/locks'].delete
$.paths['/cashiers/{cashierId}/transactions'].get
$.paths['/cashiersLock/{lockId}'].delete
$.paths['/compAccountingJournal'].get
$.paths['/fbaReimbursements'].post
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Oracle Hospitality Cashiering API
version: 1.0.0
extends: openapi/oracle-hospitality-cashiering-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 203
- target: $.paths['/hotels/{hotelId}/memberships/{membershipId}/compRedemptions'].get
update:
x-apievangelist-phrasing:
intent: List comp redemptions for a PTS member
effect: read
questions:
- What complimentary redemptions can a guest with a PTS membership use?
- Can I see the comp buckets available to a player's membership before redeeming?
instructions:
- text: Show the complimentary redemptions available to membership {membershipId} at hotel {hotelId}.
slots:
membershipId: path.membershipId
hotelId: path.hotelId
- text: Fetch comp redemption options for PTS member {membershipId}.
slots:
membershipId: path.membershipId
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/memberships/{membershipId}/compRedemptionAuthorizations'].put
update:
x-apievangelist-phrasing:
intent: Authorize comp redemptions for a PTS member
effect: write
questions:
- How do I get complimentary redemptions approved for a PTS member before posting them?
- Is there a step to authorize a player's comp redemption ahead of charging it?
instructions:
- text: Authorize the comp redemptions for membership {membershipId} at hotel {hotelId}.
slots:
membershipId: path.membershipId
hotelId: path.hotelId
- text: Request authorization of {compRedemptions} for PTS member {membershipId}.
slots:
compRedemptions: requestBody.compRedemptions
membershipId: path.membershipId
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/memberships/{membershipId}/compRedemptionPostings'].post
update:
x-apievangelist-phrasing:
intent: Post comp redemptions against a membership
effect: write
questions:
- How can I post a complimentary redemption directly against a guest's PTS membership number?
- Can comp redemptions be posted by membership rather than by reservation?
instructions:
- text: Post comp redemptions to membership {membershipId} at hotel {hotelId}.
slots:
membershipId: path.membershipId
hotelId: path.hotelId
- text: Post these redemptions {compRedemptions} against PTS member {membershipId}'s account.
slots:
compRedemptions: requestBody.compRedemptions
membershipId: path.membershipId
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/memberships/{membershipId}/compRedemptionReversals'].post
update:
x-apievangelist-phrasing:
intent: Reverse comp redemptions on a membership
effect: destructive
questions:
- How do I undo a complimentary redemption that was posted to a player's membership?
- Can a PTS membership comp redemption be reversed using just the membership number?
instructions:
- text: Reverse the comp redemptions posted to membership {membershipId} at hotel {hotelId}.
slots:
membershipId: path.membershipId
hotelId: path.hotelId
- text: Undo redemptions {compRedemptions} on PTS member {membershipId}.
slots:
compRedemptions: requestBody.compRedemptions
membershipId: path.membershipId
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/asyncCompPostingsApproval'].put
update:
x-apievangelist-phrasing:
intent: Submit bulk comp postings for vendor approval
effect: write
questions:
- Can I send a large batch of comp postings to the vendor for approval asynchronously?
- What's the way to queue many comp postings for vendor sign-off at once?
instructions:
- text: Submit bulk comp postings for asynchronous vendor approval at hotel {hotelId}.
slots:
hotelId: path.hotelId
- text: Queue comp postings {compPostings} for vendor approval in the background.
slots:
compPostings: requestBody.compPostings
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/compPostingsApproval'].put
update:
x-apievangelist-phrasing:
intent: Request approval of comp postings
effect: write
questions:
- How do I request approval for comp postings right away rather than in bulk?
- Which call asks for comp postings to be approved synchronously?
instructions:
- text: Request approval for comp postings {compPostings} at hotel {hotelId}.
slots:
compPostings: requestBody.compPostings
hotelId: path.hotelId
- text: Send the pending comp postings at hotel {hotelId} for approval now.
slots:
hotelId: path.hotelId
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/compPostingsReversal'].put
update:
x-apievangelist-phrasing:
intent: Request reversal of comp postings
effect: destructive
questions:
- How can I reverse comp postings that were already approved?
- Is it possible to request a reversal of several comp postings together?
instructions:
- text: Request reversal of comp postings {compPostings} at hotel {hotelId}.
slots:
compPostings: requestBody.compPostings
hotelId: path.hotelId
- text: Reverse the comp postings I list at hotel {hotelId}.
slots:
hotelId: path.hotelId
method: generated
generated: '2026-09-26'
- target: $.paths['/cashierReportPostings'].get
update:
x-apievangelist-phrasing:
intent: Get postings for a cashier report
effect: read
questions:
- Which postings make up a cashier report for a given date range?
- Can I pull cashier report postings filtered by closure number or drop bag?
instructions:
- text: Get cashier report postings at hotel {hotelId} from {startDate} to {endDate}.
slots:
hotelId: query.hotelId
startDate: query.startDate
endDate: query.endDate
- text: Pull cashier report postings for cashier {cashierId} at hotel {hotelId}.
slots:
cashierId: query.cashierId
hotelId: query.hotelId
method: generated
generated: '2026-09-26'
- target: $.paths['/cashiers/{cashierId}/closure'].put
update:
x-apievangelist-phrasing:
intent: Close a cashier
effect: write
questions:
- How do I close out a cashier at the end of a shift?
- Does closing a cashier need the cashier lock handle I acquired?
instructions:
- text: Close cashier {cashierId} at hotel {hotelId}.
slots:
cashierId: path.cashierId
hotelId: header.x-hotelid
- text: Close cashier {cashierId} using lock handle {cashierLockHandle}.
slots:
cashierId: path.cashierId
cashierLockHandle: requestBody.cashierLockHandle
method: generated
generated: '2026-09-26'
- target: $.paths['/cashiers/{cashierId}/locks'].get
update:
x-apievangelist-phrasing:
intent: Acquire a lock on a cashier
effect: write
questions:
- How do I lock a cashier before starting its closure?
- Can I obtain a cashier lock so nobody else posts while I close?
instructions:
- text: Acquire a lock on cashier {cashierId} at hotel {hotelId}.
slots:
cashierId: path.cashierId
hotelId: header.x-hotelid
- text: Lock cashier {cashierId} so I can close it.
slots:
cashierId: path.cashierId
method: generated
generated: '2026-09-26'
- target: $.paths['/cashiers/{cashierId}/locks'].delete
update:
x-apievangelist-phrasing:
intent: Break an existing cashier lock
effect: destructive
questions:
- A cashier is stuck locked by someone else — how can I force the lock off?
- Can I break a cashier lock using only the cashier ID?
instructions:
- text: Break the lock on cashier {cashierId} at hotel {hotelId}.
slots:
cashierId: path.cashierId
hotelId: header.x-hotelid
- text: Force-remove whatever lock is held on cashier {cashierId}.
slots:
cashierId: path.cashierId
method: generated
generated: '2026-09-26'
- target: $.paths['/cashiers/{cashierId}/transactions'].get
update:
x-apievangelist-phrasing:
intent: List a cashier's transactions
effect: read
questions:
- What transactions has a particular cashier posted during their shift?
- Can I filter a cashier's transactions by closure number or bag number?
instructions:
- text: List transactions for cashier {cashierId} at hotel {hotelId}.
slots:
cashierId: path.cashierId
hotelId: header.x-hotelid
- text: Show cashier {cashierId}'s transactions for closure {closureNo}.
slots:
cashierId: path.cashierId
closureNo: query.closureNo
method: generated
generated: '2026-09-26'
- target: $.paths['/cashiersLock/{lockId}'].delete
update:
x-apievangelist-phrasing:
intent: Release a cashier lock by lock ID
effect: destructive
questions:
- How do I release the cashier lock I hold once I'm done?
- Can a cashier lock be released using the lock ID it returned?
instructions:
- text: Release cashier lock {lockId} at hotel {hotelId}.
slots:
lockId: path.lockId
hotelId: header.x-hotelid
- text: Let go of lock {lockId} on the cashier.
slots:
lockId: path.lockId
method: generated
generated: '2026-09-26'
- target: $.paths['/compAccountingJournal'].get
update:
x-apievangelist-phrasing:
intent: Read the comp journal via the deprecated endpoint
effect: read
questions:
- Is the older, deprecated comp accounting journal call still usable for legacy integrations?
- Which deprecated call did comp journal lookups use before the posting journal replaced it?
instructions:
- text: Use the deprecated comp accounting journal call at hotel {hotelId} from {startDate} to {endDate}.
slots:
hotelId: query.hotelId
startDate: query.startDate
endDate: query.endDate
- text: Pull legacy comp accounting journal rows for room {filterRoomNumber} via the deprecated endpoint.
slots:
filterRoomNumber: query.filterRoomNumber
method: generated
generated: '2026-09-26'
- target: $.paths['/fbaReimbursements'].post
update:
x-apievangelist-phrasing:
intent: Create a food and beverage allowance reimbursement
effect: write
questions:
- How do I record a reimbursement for food and beverage allowance certificates?
- Can I reconcile FBA certificates as a reimbursement?
instructions:
- text: Create an FBA reimbursement at hotel {hotelId}.
slots:
hotelId: header.x-hotelid
- text: Record an FBA reimbursement for certificate reconciliation types {certificateReconciliationTypes}.
slots:
certificateReconciliationTypes: requestBody.certificateReconciliationTypes
method: generated
generated: '2026-09-26'
- target: $.paths['/fbaSettlements'].post
update:
x-apievangelist-phrasing:
intent: Create a food and beverage allowance settlement
effect: write
questions:
- How can I settle food and beverage allowance certificates?
- What records an FBA settlement instead of a reimbursement?
instructions:
- text: Create an FBA settlement at hotel {hotelId}.
slots:
hotelId: header.x-hotelid
- text: Settle FBA certificates of reconciliation types {certificateReconciliationTypes}.
slots:
certificateReconciliationTypes: requestBody.certificateReconciliationTypes
method: generated
generated: '2026-09-26'
- target: $.paths['/foreignCurrency'].put
update:
x-apievangelist-phrasing:
intent: Calculate a foreign currency exchange amount
effect: read
questions:
- How much local currency does a guest get for a foreign cash amount?
- Can the exchange calculation include the exchange commission?
instructions:
- text: Calculate the foreign currency exchange {exchange} at hotel {hotelId}.
slots:
exchange: requestBody.exchange
hotelId: header.x-hotelid
- text: Work out exchange {exchange} with commission added.
slots:
exchange: requestBody.exchange
method: generated
generated: '2026-09-26'
- target: $.paths['/foreignCurrencyExchange'].post
update:
x-apievangelist-phrasing:
intent: Record a foreign currency exchange
effect: write
questions:
- How do I record that a guest exchanged foreign cash at the front desk?
- Can several currency exchanges be posted in one request?
instructions:
- text: Post a foreign currency exchange at hotel {hotelId}.
slots:
hotelId: header.x-hotelid
- text: Record these currency exchanges {foreignCurrencyExchangeList}.
slots:
foreignCurrencyExchangeList: requestBody.foreignCurrencyExchangeList
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/advanceFolio/batchJobs'].post
update:
x-apievangelist-phrasing:
intent: Start a batch advance folio job
effect: write
questions:
- How do I generate advance folios for many reservations in one batch job?
- Is there a batch job for advance folios?
instructions:
- text: Start a batch advance folio job at hotel {hotelId}.
slots:
hotelId: path.hotelId
- text: Run batch advance folio {batchAdvanceFolio}.
slots:
batchAdvanceFolio: requestBody.batchAdvanceFolio
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/articlesSale'].post
update:
x-apievangelist-phrasing:
intent: Post an articles sale
effect: write
questions:
- How do I ring up a sale of articles like minibar items or merchandise?
- Can I post an article sale that isn't tied to a room charge flow?
instructions:
- text: Post an articles sale at hotel {hotelId}.
slots:
hotelId: path.hotelId
- text: Record an article sale with criteria {criteria}.
slots:
criteria: requestBody.criteria
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/authorizers/credits'].get
update:
x-apievangelist-phrasing:
intent: Get comp authorizers' credit information
effect: read
questions:
- How much comp credit does each authorizer have available for a period?
- Can I see credit details for a specific comp authorizer code?
instructions:
- text: Get authorizer credit info at hotel {hotelId} from {startDate} to {endDate}.
slots:
hotelId: path.hotelId
startDate: query.startDate
endDate: query.endDate
- text: Show credit details for authorizer {code}.
slots:
code: query.code
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/autoCheckoutReservations/batchJobs'].post
update:
x-apievangelist-phrasing:
intent: Start an auto checkout batch job
effect: write
questions:
- How can I check out a batch of departing reservations automatically?
- Is there a batch job that runs auto checkout for reservations?
instructions:
- text: Start an auto checkout batch for reservations at hotel {hotelId}.
slots:
hotelId: path.hotelId
- text: Auto check out reservations matching {criteria}.
slots:
criteria: requestBody.criteria
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/autoSettlements/batchJobs'].post
update:
x-apievangelist-phrasing:
intent: Start a batch auto settlement job
effect: write
questions:
- How do I run auto settlement across many folios in a batch?
- Can auto settlement be kicked off as a background batch job?
instructions:
- text: Start a batch auto settlement at hotel {hotelId}.
slots:
hotelId: path.hotelId
- text: Run auto settlement for folios matching {criteria}.
slots:
criteria: requestBody.criteria
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/batchDeposits'].post
update:
x-apievangelist-phrasing:
intent: Create batch deposits
effect: write
questions:
- How do I post deposits for many reservations at once?
- Can I take a batch deposit across several reservations in one call?
instructions:
- text: Create batch deposits at hotel {hotelId}.
slots:
hotelId: path.hotelId
- text: Post batch deposit {batchDeposit}.
slots:
batchDeposit: requestBody.batchDeposit
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/bedTax'].get
update:
x-apievangelist-phrasing:
intent: Get bed tax information
effect: read
questions:
- What bed tax registration details are on file for arrivals on a date?
- Can I look up bed tax info by arrival date?
instructions:
- text: Get bed tax information at hotel {hotelId} for arrivals on {arrival}.
slots:
hotelId: path.hotelId
arrival: query.arrival
- text: Show the bed tax records at hotel {hotelId}.
slots:
hotelId: path.hotelId
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/bedTax'].post
update:
x-apievangelist-phrasing:
intent: Create bed tax information
effect: write
questions:
- How do I register new bed tax information for guests?
- Can I add a bed tax registration record?
instructions:
- text: Create bed tax information at hotel {hotelId}.
slots:
hotelId: path.hotelId
- text: Add bed tax record {bedTaxInfoType}.
slots:
bedTaxInfoType: requestBody.bedTaxInfoType
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/bedTax/{taxRegistraitionNo}'].put
update:
x-apievangelist-phrasing:
intent: Update a bed tax registration
effect: write
questions:
- How do I correct an existing bed tax registration?
- Can I change bed tax details using the tax registration number?
instructions:
- text: Update bed tax registration {taxRegistraitionNo} at hotel {hotelId}.
slots:
taxRegistraitionNo: path.taxRegistraitionNo
hotelId: path.hotelId
- text: Change bed tax registration {taxRegistraitionNo} to {bedTaxInfoType}.
slots:
taxRegistraitionNo: path.taxRegistraitionNo
bedTaxInfoType: requestBody.bedTaxInfoType
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/bedTax/{taxRegistraitionNo}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a bed tax registration
effect: destructive
questions:
- How do I remove a bed tax registration that was entered by mistake?
- Can a bed tax record be deleted by its registration number?
instructions:
- text: Delete bed tax registration {taxRegistraitionNo} at hotel {hotelId}.
slots:
taxRegistraitionNo: path.taxRegistraitionNo
hotelId: path.hotelId
- text: Remove bed tax record {taxRegistraitionNo}.
slots:
taxRegistraitionNo: path.taxRegistraitionNo
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/billingCharges'].put
update:
x-apievangelist-phrasing:
intent: Change billing charges
effect: write
questions:
- How do I edit billing charges that were already posted?
- Can I change several billing charges together by criteria?
instructions:
- text: Change billing charges at hotel {hotelId}.
slots:
hotelId: path.hotelId
- text: Update the billing charges matching {criteria}.
slots:
criteria: requestBody.criteria
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/bulkCCSettlements/{batchId}/status'].get
update:
x-apievangelist-phrasing:
intent: Check status of a batch card settlement job
effect: read
questions:
- Has my batch credit card settlement job finished yet?
- Can I check the progress of a bulk card settlement by batch ID?
instructions:
- text: Check the status of batch card settlement {batchId} at hotel {hotelId}.
slots:
batchId: path.batchId
hotelId: path.hotelId
- text: Is bulk settlement batch {batchId} done — show its status.
slots:
batchId: path.batchId
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/bulkPrepaidCards'].post
update:
x-apievangelist-phrasing:
intent: Create multiple prepaid cards
effect: write
questions:
- How do I issue a large number of prepaid cards in one go?
- Can I create prepaid cards in bulk with card details?
instructions:
- text: Create prepaid cards in bulk at hotel {hotelId}.
slots:
hotelId: path.hotelId
- text: Issue multiple prepaid cards with details {cardDetails}.
slots:
cardDetails: requestBody.cardDetails
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/cashiers/{cashierId}/closure'].get
update:
x-apievangelist-phrasing:
intent: Get closure details for a cashier
effect: read
questions:
- What does a cashier's closure summary look like before I close?
- Can I preview a cashier closure using my lock handle?
instructions:
- text: Get closure details for cashier {cashierId} at hotel {hotelId}.
slots:
cashierId: path.cashierId
hotelId: path.hotelId
- text: Preview closing cashier {cashierId} with lock handle {cashierLockHandle}.
slots:
cashierId: path.cashierId
cashierLockHandle: query.cashierLockHandle
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/cashiers/{cashierId}/closureReports'].get
update:
x-apievangelist-phrasing:
intent: List a cashier's closure reports
effect: read
questions:
- Which closure reports are available for a cashier?
- Can I find a cashier's closure reports by closure number?
instructions:
- text: List closure reports for cashier {cashierId} at hotel {hotelId}.
slots:
cashierId: path.cashierId
hotelId: path.hotelId
- text: Show closure report {closureNo} for cashier {cashierId}.
slots:
closureNo: query.closureNo
cashierId: path.cashierId
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/cashiers/{cashierId}/folioTaxPayments'].put
update:
x-apievangelist-phrasing:
intent: Reverse a folio tax payment
effect: destructive
questions:
- How do I reverse a folio tax payment a cashier posted?
- Can a cashier undo a folio tax payment with reverse criteria?
instructions:
- text: Reverse a folio tax payment for cashier {cashierId} at hotel {hotelId}.
slots:
cashierId: path.cashierId
hotelId: path.hotelId
- text: Undo folio tax payment {reverseCriteria} under cashier {cashierId}.
slots:
reverseCriteria: requestBody.reverseCriteria
cashierId: path.cashierId
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/cashierslock/{lockId}'].put
update:
x-apievangelist-phrasing:
intent: Extend a cashier lock
effect: write
questions:
- My cashier lock is about to expire — can I extend it?
- How much extra time can I add to a cashier lock?
instructions:
- text: Extend cashier lock {lockId} at hotel {hotelId}.
slots:
lockId: path.lockId
hotelId: path.hotelId
- text: Add {additionalTimeToLive} more time to lock {lockId}.
slots:
additionalTimeToLive: requestBody.additionalTimeToLive
lockId: path.lockId
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/cashsurcharge'].get
update:
x-apievangelist-phrasing:
intent: Get the surcharge for a cash payment
effect: read
questions:
- Is there a surcharge when a guest pays cash, and how much?
- Can I calculate the cash surcharge for a specific amount and currency?
instructions:
- text: Get the cash surcharge at hotel {hotelId} for {trxAmount} {currencyCode}.
slots:
hotelId: path.hotelId
trxAmount: query.trxAmount
currencyCode: query.currencyCode
- text: Check cash surcharge for payment method {paymentMethod}.
slots:
paymentMethod: query.paymentMethod
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/ccSettlement'].post
update:
x-apievangelist-phrasing:
intent: Settle a credit card payment
effect: write
questions:
- How do I settle a single credit card transaction?
- Can I push one credit card settlement outside the batch job?
instructions:
- text: Create a credit card settlement at hotel {hotelId}.
slots:
hotelId: path.hotelId
- text: Settle card transaction {creditCardSettlement}.
slots:
creditCardSettlement: requestBody.creditCardSettlement
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/ccSettlements/batchJobs'].post
update:
x-apievangelist-phrasing:
intent: Start a batch credit card settlement job
effect: write
questions:
- How can I settle all outstanding credit card transactions in a batch?
- Is there a batch job for settling many card payments?
instructions:
- text: Start a batch credit card settlement job at hotel {hotelId}.
slots:
hotelId: path.hotelId
- text: Run batch card settlements for {criteria}.
slots:
criteria: requestBody.criteria
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/check/{checkNumber}'].get
update:
x-apievangelist-phrasing:
intent: Get details of a guest check
effect: read
questions:
- What's on a restaurant guest check by its check number?
- Can I look up a guest check's details?
instructions:
- text: Get details of check {checkNumber} at hotel {hotelId}.
slots:
checkNumber: path.checkNumber
hotelId: path.hotelId
- text: Show guest check {checkNumber}.
slots:
checkNumber: path.checkNumber
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/check/{checkNumber}'].put
update:
x-apievangelist-phrasing:
intent: Update a guest check
effect: write
questions:
- How do I update the details on an existing guest check?
- Can I change which reservation a guest check belongs to?
instructions:
- text: Update guest check {checkNumber} at hotel {hotelId}.
slots:
checkNumber: path.checkNumber
hotelId: path.hotelId
- text: Change check {checkNumber} to reservation {reservationId}.
slots:
checkNumber: path.checkNumber
reservationId: requestBody.reservationId
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/check/{checkNumber}'].post
update:
x-apievangelist-phrasing:
intent: Post a guest check to a reservation
effect: write
questions:
- How do I post an outlet guest check onto a reservation's bill?
- Can a new guest check be posted with its line details?
instructions:
- text: Post guest check {checkNumber} at hotel {hotelId}.
slots:
checkNumber: path.checkNumber
hotelId: path.hotelId
- text: Post check {checkNumber} to reservation {reservationId}'s bill.
slots:
checkNumber: path.checkNumber
reservationId: requestBody.reservationId
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/check/{checkNumber}/charges'].delete
update:
x-apievangelist-phrasing:
intent: Void charges posted from a check
effect: destructive
questions:
- How do I void the charges that came from a guest check?
- Can I remove a check's charges for a specific amount and revenue date?
instructions:
- text: Void the charges for check {checkNumber} at hotel {hotelId}.
slots:
checkNumber: path.checkNumber
hotelId: path.hotelId
- text: Remove {amount} charged from check {checkNumber} on reservation {reservationId}.
slots:
amount: query.amount
checkNumber: path.checkNumber
reservationId: query.reservationId
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/closureList'].get
update:
x-apievangelist-phrasing:
intent: Look up cashier closures
effect: read
questions:
- Which cashier closures happened on a business date?
- Can I search closures by cashier, closure number or bag number?
instructions:
- text: Look up cashier closures at hotel {hotelId} for business date {closureBusinessDate}.
slots:
hotelId: path.hotelId
closureBusinessDate: query.closureBusinessDate
- text: Find closure {closureNo} for cashier {cashierId}.
slots:
closureNo: query.closureNo
cashierId: query.cashierId
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/compAccountingJournal'].get
update:
x-apievangelist-phrasing:
intent: Get the comp posting journal
effect: read
questions:
- Where can I see comp postings journaled over the last 30 days?
- Can I page through the comp posting journal, up to 50 entries at a time, by authorizer?
instructions:
- text: Get the comp posting journal at hotel {hotelId} from {startDate} to {endDate}.
slots:
hotelId: path.hotelId
startDate: query.startDate
endDate: query.endDate
- text: Show comp posting journal entries for authorizer {authorizerNameCode}, {limit} per page.
slots:
authorizerNameCode: query.authorizerNameCode
limit: query.limit
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/compRoutingInstructions'].get
update:
x-apievangelist-phrasing:
intent: List comp routing instructions
effect: read
questions:
- Which reservations have comp routing instructions set up?
- Can I list comp routing instructions by guest name or room number?
instructions:
- text: List comp routing instructions at hotel {hotelId}.
slots:
hotelId: path.hotelId
- text: Show comp routings for guests named {nameWildcard}.
slots:
nameWildcard: query.nameWildcard
method: generated
generated: '2026-09-26'
# --- truncated at 32 KB (145 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle-hospitality/refs/heads/main/overlays/oracle-hospitality-cashiering-api-phrasing-overlay.yaml