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.

Business capability
Front Office Operations BC-4060.10

Operations 203

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /hotels/{hotelId}/memberships/{membershipId}/compRedemptions List comp redemptions for a PTS member · Operation to get complimentary redemptions for a guest having PTS Membership… #
Ask an LLM
“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?”
Tell an agent
Show the complimentary redemptions available to membership {membershipId} at hotel {hotelId}.
Fetch comp redemption options for PTS member {membershipId}.
PUT /hotels/{hotelId}/memberships/{membershipId}/compRedemptionAuthorizations Authorize comp redemptions for a PTS member · Operation to authorize complimentary redemptions for a guest having PTS… #
Ask an LLM
“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?”
Tell an agent
Authorize the comp redemptions for membership {membershipId} at hotel {hotelId}.
Request authorization of {compRedemptions} for PTS member {membershipId}.
POST /hotels/{hotelId}/memberships/{membershipId}/compRedemptionPostings Post comp redemptions against a membership · Operation to post complimentary redemptions for a guest having PTS Membership… #
Ask an LLM
“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?”
Tell an agent
Post comp redemptions to membership {membershipId} at hotel {hotelId}.
Post these redemptions {compRedemptions} against PTS member {membershipId}'s account.
POST /hotels/{hotelId}/memberships/{membershipId}/compRedemptionReversals Reverse comp redemptions on a membership · Operation to reverse complimentary redemptions for a guest having PTS… #
Ask an LLM
“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?”
Tell an agent destructive · confirm first
Reverse the comp redemptions posted to membership {membershipId} at hotel {hotelId}.
Undo redemptions {compRedemptions} on PTS member {membershipId}.
PUT /hotels/{hotelId}/asyncCompPostingsApproval Submit bulk comp postings for vendor approval · Operation to request for submitting bulk comp postings for vendor approval #
Ask an LLM
“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?”
Tell an agent
Submit bulk comp postings for asynchronous vendor approval at hotel {hotelId}.
Queue comp postings {compPostings} for vendor approval in the background.
PUT /hotels/{hotelId}/compPostingsApproval Request approval of comp postings · Operation to request for comp postings approval #
Ask an LLM
“How do I request approval for comp postings right away rather than in bulk?”
“Which call asks for comp postings to be approved synchronously?”
Tell an agent
Request approval for comp postings {compPostings} at hotel {hotelId}.
Send the pending comp postings at hotel {hotelId} for approval now.
PUT /hotels/{hotelId}/compPostingsReversal Request reversal of comp postings · Operation to request for comp postings reversal #
Ask an LLM
“How can I reverse comp postings that were already approved?”
“Is it possible to request a reversal of several comp postings together?”
Tell an agent destructive · confirm first
Request reversal of comp postings {compPostings} at hotel {hotelId}.
Reverse the comp postings I list at hotel {hotelId}.
GET /cashierReportPostings Get postings for a cashier report · Get Cashier Report Postings #
Ask an LLM
“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?”
Tell an agent
Get cashier report postings at hotel {hotelId} from {startDate} to {endDate}.
Pull cashier report postings for cashier {cashierId} at hotel {hotelId}.
PUT /cashiers/{cashierId}/closure Close a cashier · Close Cashier #
Ask an LLM
“How do I close out a cashier at the end of a shift?”
“Does closing a cashier need the cashier lock handle I acquired?”
Tell an agent
Close cashier {cashierId} at hotel {hotelId}.
Close cashier {cashierId} using lock handle {cashierLockHandle}.
GET /cashiers/{cashierId}/locks Acquire a lock on a cashier · Acquire Cashier Locks #
Ask an LLM
“How do I lock a cashier before starting its closure?”
“Can I obtain a cashier lock so nobody else posts while I close?”
Tell an agent
Acquire a lock on cashier {cashierId} at hotel {hotelId}.
Lock cashier {cashierId} so I can close it.
DELETE /cashiers/{cashierId}/locks Break an existing cashier lock · Break Cashier Lock #
Ask an LLM
“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?”
Tell an agent destructive · confirm first
Break the lock on cashier {cashierId} at hotel {hotelId}.
Force-remove whatever lock is held on cashier {cashierId}.
GET /cashiers/{cashierId}/transactions List a cashier's transactions · Get Cashier Transactions #
Ask an LLM
“What transactions has a particular cashier posted during their shift?”
“Can I filter a cashier's transactions by closure number or bag number?”
Tell an agent
List transactions for cashier {cashierId} at hotel {hotelId}.
Show cashier {cashierId}'s transactions for closure {closureNo}.
DELETE /cashiersLock/{lockId} Release a cashier lock by lock ID · Release Cashier Lock #
Ask an LLM
“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?”
Tell an agent destructive · confirm first
Release cashier lock {lockId} at hotel {hotelId}.
Let go of lock {lockId} on the cashier.
GET /compAccountingJournal Read the comp journal via the deprecated endpoint · Get Comp Accounting Journal #
Ask an LLM
“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?”
Tell an agent
Use the deprecated comp accounting journal call at hotel {hotelId} from {startDate} to {endDate}.
Pull legacy comp accounting journal rows for room {filterRoomNumber} via the deprecated endpoint.
POST /fbaReimbursements Create a food and beverage allowance reimbursement · Create FBA Reimbursement #
Ask an LLM
“How do I record a reimbursement for food and beverage allowance certificates?”
“Can I reconcile FBA certificates as a reimbursement?”
Tell an agent
Create an FBA reimbursement at hotel {hotelId}.
Record an FBA reimbursement for certificate reconciliation types {certificateReconciliationTypes}.
POST /fbaSettlements Create a food and beverage allowance settlement · Create FBA Settlement #
Ask an LLM
“How can I settle food and beverage allowance certificates?”
“What records an FBA settlement instead of a reimbursement?”
Tell an agent
Create an FBA settlement at hotel {hotelId}.
Settle FBA certificates of reconciliation types {certificateReconciliationTypes}.
PUT /foreignCurrency Calculate a foreign currency exchange amount · Calculate Foreign Currency #
Ask an LLM
“How much local currency does a guest get for a foreign cash amount?”
“Can the exchange calculation include the exchange commission?”
Tell an agent
Calculate the foreign currency exchange {exchange} at hotel {hotelId}.
Work out exchange {exchange} with commission added.
POST /foreignCurrencyExchange Record a foreign currency exchange · Create Foreign Currency Exchange #
Ask an LLM
“How do I record that a guest exchanged foreign cash at the front desk?”
“Can several currency exchanges be posted in one request?”
Tell an agent
Post a foreign currency exchange at hotel {hotelId}.
Record these currency exchanges {foreignCurrencyExchangeList}.
POST /hotels/{hotelId}/advanceFolio/batchJobs Start a batch advance folio job · Create Batch Advance Folio #
Ask an LLM
“How do I generate advance folios for many reservations in one batch job?”
“Is there a batch job for advance folios?”
Tell an agent
Start a batch advance folio job at hotel {hotelId}.
Run batch advance folio {batchAdvanceFolio}.
POST /hotels/{hotelId}/articlesSale Post an articles sale · Create Articles Sale #
Ask an LLM
“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?”
Tell an agent
Post an articles sale at hotel {hotelId}.
Record an article sale with criteria {criteria}.
GET /hotels/{hotelId}/authorizers/credits Get comp authorizers' credit information · Get Authorizers Credit Info #
Ask an LLM
“How much comp credit does each authorizer have available for a period?”
“Can I see credit details for a specific comp authorizer code?”
Tell an agent
Get authorizer credit info at hotel {hotelId} from {startDate} to {endDate}.
Show credit details for authorizer {code}.
POST /hotels/{hotelId}/autoCheckoutReservations/batchJobs Start an auto checkout batch job · Create Auto Checkout Reservation Batch #
Ask an LLM
“How can I check out a batch of departing reservations automatically?”
“Is there a batch job that runs auto checkout for reservations?”
Tell an agent
Start an auto checkout batch for reservations at hotel {hotelId}.
Auto check out reservations matching {criteria}.
POST /hotels/{hotelId}/autoSettlements/batchJobs Start a batch auto settlement job · Create Batch Auto Settlement #
Ask an LLM
“How do I run auto settlement across many folios in a batch?”
“Can auto settlement be kicked off as a background batch job?”
Tell an agent
Start a batch auto settlement at hotel {hotelId}.
Run auto settlement for folios matching {criteria}.
POST /hotels/{hotelId}/batchDeposits Create batch deposits · Create batch deposits #
Ask an LLM
“How do I post deposits for many reservations at once?”
“Can I take a batch deposit across several reservations in one call?”
Tell an agent
Create batch deposits at hotel {hotelId}.
Post batch deposit {batchDeposit}.
GET /hotels/{hotelId}/bedTax Get bed tax information · Get bed tax information #
Ask an LLM
“What bed tax registration details are on file for arrivals on a date?”
“Can I look up bed tax info by arrival date?”
Tell an agent
Get bed tax information at hotel {hotelId} for arrivals on {arrival}.
Show the bed tax records at hotel {hotelId}.
POST /hotels/{hotelId}/bedTax Create bed tax information · Create bed tax information #
Ask an LLM
“How do I register new bed tax information for guests?”
“Can I add a bed tax registration record?”
Tell an agent
Create bed tax information at hotel {hotelId}.
Add bed tax record {bedTaxInfoType}.
PUT /hotels/{hotelId}/bedTax/{taxRegistraitionNo} Update a bed tax registration · Change bed tax information #
Ask an LLM
“How do I correct an existing bed tax registration?”
“Can I change bed tax details using the tax registration number?”
Tell an agent
Update bed tax registration {taxRegistraitionNo} at hotel {hotelId}.
Change bed tax registration {taxRegistraitionNo} to {bedTaxInfoType}.
DELETE /hotels/{hotelId}/bedTax/{taxRegistraitionNo} Delete a bed tax registration · Delete bed tax information #
Ask an LLM
“How do I remove a bed tax registration that was entered by mistake?”
“Can a bed tax record be deleted by its registration number?”
Tell an agent destructive · confirm first
Delete bed tax registration {taxRegistraitionNo} at hotel {hotelId}.
Remove bed tax record {taxRegistraitionNo}.
PUT /hotels/{hotelId}/billingCharges Change billing charges · Change Billing Charges #
Ask an LLM
“How do I edit billing charges that were already posted?”
“Can I change several billing charges together by criteria?”
Tell an agent
Change billing charges at hotel {hotelId}.
Update the billing charges matching {criteria}.
GET /hotels/{hotelId}/bulkCCSettlements/{batchId}/status Check status of a batch card settlement job · Get Batch CC Settlements Status #
Ask an LLM
“Has my batch credit card settlement job finished yet?”
“Can I check the progress of a bulk card settlement by batch ID?”
Tell an agent
Check the status of batch card settlement {batchId} at hotel {hotelId}.
Is bulk settlement batch {batchId} done — show its status.
POST /hotels/{hotelId}/bulkPrepaidCards Create multiple prepaid cards · Create multiple Prepaid Cards #
Ask an LLM
“How do I issue a large number of prepaid cards in one go?”
“Can I create prepaid cards in bulk with card details?”
Tell an agent
Create prepaid cards in bulk at hotel {hotelId}.
Issue multiple prepaid cards with details {cardDetails}.
GET /hotels/{hotelId}/cashiers/{cashierId}/closure Get closure details for a cashier · Get Cashier Closure #
Ask an LLM
“What does a cashier's closure summary look like before I close?”
“Can I preview a cashier closure using my lock handle?”
Tell an agent
Get closure details for cashier {cashierId} at hotel {hotelId}.
Preview closing cashier {cashierId} with lock handle {cashierLockHandle}.
GET /hotels/{hotelId}/cashiers/{cashierId}/closureReports List a cashier's closure reports · Get Cashier Closure Reports List #
Ask an LLM
“Which closure reports are available for a cashier?”
“Can I find a cashier's closure reports by closure number?”
Tell an agent
List closure reports for cashier {cashierId} at hotel {hotelId}.
Show closure report {closureNo} for cashier {cashierId}.
PUT /hotels/{hotelId}/cashiers/{cashierId}/folioTaxPayments Reverse a folio tax payment · Change folio tax payments #
Ask an LLM
“How do I reverse a folio tax payment a cashier posted?”
“Can a cashier undo a folio tax payment with reverse criteria?”
Tell an agent destructive · confirm first
Reverse a folio tax payment for cashier {cashierId} at hotel {hotelId}.
Undo folio tax payment {reverseCriteria} under cashier {cashierId}.
PUT /hotels/{hotelId}/cashierslock/{lockId} Extend a cashier lock · Extend Cashier Lock #
Ask an LLM
“My cashier lock is about to expire — can I extend it?”
“How much extra time can I add to a cashier lock?”
Tell an agent
Extend cashier lock {lockId} at hotel {hotelId}.
Add {additionalTimeToLive} more time to lock {lockId}.
GET /hotels/{hotelId}/cashsurcharge Get the surcharge for a cash payment · Get Cash Surcharge Information #
Ask an LLM
“Is there a surcharge when a guest pays cash, and how much?”
“Can I calculate the cash surcharge for a specific amount and currency?”
Tell an agent
Get the cash surcharge at hotel {hotelId} for {trxAmount} {currencyCode}.
Check cash surcharge for payment method {paymentMethod}.
POST /hotels/{hotelId}/ccSettlement Settle a credit card payment · Create CreditCard Settlement #
Ask an LLM
“How do I settle a single credit card transaction?”
“Can I push one credit card settlement outside the batch job?”
Tell an agent
Create a credit card settlement at hotel {hotelId}.
Settle card transaction {creditCardSettlement}.
POST /hotels/{hotelId}/ccSettlements/batchJobs Start a batch credit card settlement job · Create Batch CC Settlements #
Ask an LLM
“How can I settle all outstanding credit card transactions in a batch?”
“Is there a batch job for settling many card payments?”
Tell an agent
Start a batch credit card settlement job at hotel {hotelId}.
Run batch card settlements for {criteria}.
GET /hotels/{hotelId}/check/{checkNumber} Get details of a guest check · Get check details #
Ask an LLM
“What's on a restaurant guest check by its check number?”
“Can I look up a guest check's details?”
Tell an agent
Get details of check {checkNumber} at hotel {hotelId}.
Show guest check {checkNumber}.
POST /hotels/{hotelId}/check/{checkNumber} Post a guest check to a reservation · Post Guest Check Details #
Ask an LLM
“How do I post an outlet guest check onto a reservation's bill?”
“Can a new guest check be posted with its line details?”
Tell an agent
Post guest check {checkNumber} at hotel {hotelId}.
Post check {checkNumber} to reservation {reservationId}'s bill.
PUT /hotels/{hotelId}/check/{checkNumber} Update a guest check · Update Guest Check Details #
Ask an LLM
“How do I update the details on an existing guest check?”
“Can I change which reservation a guest check belongs to?”
Tell an agent
Update guest check {checkNumber} at hotel {hotelId}.
Change check {checkNumber} to reservation {reservationId}.
DELETE /hotels/{hotelId}/check/{checkNumber}/charges Void charges posted from a check · Delete Billing Check Charges #
Ask an LLM
“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?”
Tell an agent destructive · confirm first
Void the charges for check {checkNumber} at hotel {hotelId}.
Remove {amount} charged from check {checkNumber} on reservation {reservationId}.
GET /hotels/{hotelId}/closureList Look up cashier closures · Get Cashier Closure Information #
Ask an LLM
“Which cashier closures happened on a business date?”
“Can I search closures by cashier, closure number or bag number?”
Tell an agent
Look up cashier closures at hotel {hotelId} for business date {closureBusinessDate}.
Find closure {closureNo} for cashier {cashierId}.
GET /hotels/{hotelId}/compAccountingJournal Get the comp posting journal · Get Comp Accounting Journal #
Ask an LLM
“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?”
Tell an agent
Get the comp posting journal at hotel {hotelId} from {startDate} to {endDate}.
Show comp posting journal entries for authorizer {authorizerNameCode}, {limit} per page.
GET /hotels/{hotelId}/compRoutingInstructions List comp routing instructions · Get Comp Routing Instructions #
Ask an LLM
“Which reservations have comp routing instructions set up?”
“Can I list comp routing instructions by guest name or room number?”
Tell an agent
List comp routing instructions at hotel {hotelId}.
Show comp routings for guests named {nameWildcard}.
POST /hotels/{hotelId}/compRoutingInstructions/searches Search comp routing instructions with a POST body · Get Comp Routing Instructions #
Ask an LLM
“Can I search comp routing instructions by sending criteria in a request body?”
“What if my comp routing filters are too long for a query string?”
Tell an agent
Search comp routing instructions at hotel {hotelId} with body criteria.
POST a comp routing search for membership {membershipId}.
GET /hotels/{hotelId}/compTrxAuthorizers Get authorizers for a comp transaction · Get Comp Trx Authorizers #
Ask an LLM
“Who can authorize a particular comp transaction?”
“Can I find comp authorizers by cashier and target folio window?”
Tell an agent
Get comp transaction authorizers at hotel {hotelId} for cashier {cashierId}.
Find who can authorize comp transaction {transaction}.
GET /hotels/{hotelId}/covers Get covers counted for transactions · Get transaction covers #
Ask an LLM
“How many covers were recorded for outlet transactions on a date?”
“Can I see covers for one transaction code?”
Tell an agent
Get transaction covers at hotel {hotelId} for {coversDate}.
Show covers on {coversDate} for transaction code {transactionCode}.
PUT /hotels/{hotelId}/covers Change transaction covers · Change Transaction Covers #
Ask an LLM
“How do I correct the number of covers recorded for a transaction?”
“Can covers info be updated after posting?”
Tell an agent
Change transaction covers at hotel {hotelId}.
Update covers to {coversInfo}.
POST /hotels/{hotelId}/creditBill Create a credit bill · Create Credit Bill #
Ask an LLM
“How do I issue a credit bill against a folio?”
“Can I generate a credit note for an already billed folio?”
Tell an agent
Create a credit bill at hotel {hotelId}.
Issue a credit bill with criteria {criteria}.
PUT /hotels/{hotelId}/creditBill/action/validate Validate a credit bill before issuing it · Validate Credit Bill #
Ask an LLM
“Can I check whether a credit bill is allowed before actually creating it?”
“What validation runs ahead of issuing a credit bill?”
Tell an agent
Validate a credit bill at hotel {hotelId} without issuing it.
Dry-run credit bill checks for {criteria}.
GET /hotels/{hotelId}/creditLimitsOveragePayments List guests over their credit limit · Get Credit Limits Overage Payments #
Ask an LLM
“Which in-house guests have gone over their credit limit and owe a payment?”
“Can I find credit limit overages by guest name or room number?”
Tell an agent
List credit limit overages at hotel {hotelId}.
Show overage payments due for room {roomNumberWildCard}.
POST /hotels/{hotelId}/creditLimitsOveragePayments Collect payments for credit limit overages · Create Credit Limit Overage Payments #
Ask an LLM
“How do I take payment from guests who exceeded their credit limit?”
“Can I post overage payments for several guests together?”
Tell an agent
Post credit limit overage payments at hotel {hotelId}.
Collect overage payments matching {criteria}.
POST /hotels/{hotelId}/creditcardTransaction/logs Log a credit card vault transaction · Register Vault Transaction #
Ask an LLM
“How do I register a card vault HTTP transaction in the log?”
“Can the tokenization vault's request and response be recorded for audit?”
Tell an agent
Register a vault transaction log at hotel {hotelId}.
Log vault message {httpTransactionMessage}.
GET /hotels/{hotelId}/creditcardsurcharge Get the surcharge for a credit card payment · Get CC Surcharge Information #
Ask an LLM
“Will a guest be charged a surcharge for paying by credit card?”
“Does the card type change the credit card surcharge?”
Tell an agent
Get the credit card surcharge at hotel {hotelId} for card type {cardType}.
Check card surcharge for payment method {paymentMethod} at cashier {cashierId}.
GET /hotels/{hotelId}/depositFolio Get a deposit folio · Get Deposit Folio #
Ask an LLM
“What's on the deposit folio for a reservation or block?”
“Can I look up a deposit folio by block or deposit policy?”
Tell an agent
Get the deposit folio at hotel {hotelId}.
Show the deposit folio for block {blockIdId}.
GET /hotels/{hotelId}/depositTransactions Get deposit folio transaction details · Get Deposit Folio Transaction Details #
Ask an LLM
“What are the details of a transaction posted on a deposit folio?”
“Can I include generated taxes when viewing a deposit transaction?”
Tell an agent
Get deposit folio transaction {transactionNo} at hotel {hotelId}.
Show deposit transaction {transactionNo} with its generates.
PUT /hotels/{hotelId}/depositfolios/action/validate Validate a deposit folio · Validate Deposit Folio #
Ask an LLM
“Can I verify that a deposit folio is valid before generating it?”
“What checks does the system run on a deposit folio?”
Tell an agent
Validate the deposit folio at hotel {hotelId}.
Check deposit folio validity for {criteria}.
POST /hotels/{hotelId}/externalSystems/{externalSysCode}/reservations/{reservationId}/depositPayments Take a deposit using an external reservation ID · Create Deposit Payment using external reference #
Ask an LLM
“How can a partner system post a deposit using its own reservation reference?”
“Can I take a deposit without knowing the internal reservation ID?”
Tell an agent
Post a deposit for external reservation {reservationId} from system {externalSysCode} at hotel {hotelId}.
Record deposit {criteria} on {externalSysCode} booking {reservationId}.
GET /hotels/{hotelId}/financialPostings Search financial postings · Get Financial Postings #
Ask an LLM
“Which charges and payments were posted over the last few days?”
“Can I filter financial postings by cashier, transaction code or room?”
Tell an agent
Get financial postings at hotel {hotelId} from {startDate} to {endDate}.
Find postings by cashier {cashierId} for room {filterRoomNumber}.
GET /hotels/{hotelId}/financialPostingsNetVat Get a folio's postings with net and VAT split · Get Financial Postings with breakdown #
Ask an LLM
“Can I see a folio's postings broken down into net and VAT amounts?”
“What's the VAT breakdown for one folio window on a reservation?”
Tell an agent
Get net and VAT postings for reservation {reservationId} window {folioWindowNo} at hotel {hotelId}.
Show VAT breakdown of window {folioWindowNo} on reservation {reservationId}.
POST /hotels/{hotelId}/fiscalCommands Create a fiscal invoice · Create Fiscal Invoice #
Ask an LLM
“How do I issue a fiscal invoice to meet local tax rules?”
“What is the current call for creating fiscal invoices?”
Tell an agent
Create a fiscal invoice at hotel {hotelId}.
Issue a fiscal command invoice for {criteria}.
GET /hotels/{hotelId}/fiscalFolioResponse Get fiscal activity for a folio · Get the Fiscal Folio Activity for a folio #
Ask an LLM
“What fiscal responses has a folio received from the fiscal partner?”
“Can I see fiscal activity by folio sequence number?”
Tell an agent
Get fiscal folio activity at hotel {hotelId} for folio sequence {folioSeqNo}.
List fiscal activity on folio {folioSeqNo}.
GET /hotels/{hotelId}/fiscalFolioResponse/{folioSeqNo} Get a fiscal response attempt's details · Get the Fiscal Folio Activity Response details for a folio #
Ask an LLM
“What exactly did the fiscal partner return for a folio's response attempt?”
“Can I inspect a specific retry attempt for a fiscal folio?”
Tell an agent
Get fiscal response details for folio {folioSeqNo} at hotel {hotelId}.
Show attempt {responseAttemptNo} of fiscal folio {folioSeqNo}.
POST /hotels/{hotelId}/fiscalFolios Generate a fiscal information folio · Create Fiscal Information Folio #
Ask an LLM
“How do I create an information folio for fiscal reporting?”
“Can a fiscal info folio be generated on request?”
Tell an agent
Generate a fiscal information folio at hotel {hotelId}.
Create fiscal info folio for {criteria}.
GET /hotels/{hotelId}/fiscalPrinting Validate fiscal printing details for a folio · Get Fiscal Printing Details #
Ask an LLM
“Before printing a fiscal folio, can I check its printing details for the queue?”
“Which fiscal printing details apply to a debit or manual folio?”
Tell an agent
Validate fiscal printing details at hotel {hotelId} for folio type {folioType}.
Check fiscal printing for manual folio {manualFolioNo}.
GET /hotels/{hotelId}/fiscalSupportingDocuments List fiscal supporting documents · Get supporting documents details #
Ask an LLM
“Which fiscal supporting documents are still pending with the fiscal partner?”
“Can I find supporting documents by guest surname or confirmation number?”
Tell an agent
List fiscal supporting documents at hotel {hotelId}.
Show supporting documents for confirmation {confirmationNo}.
POST /hotels/{hotelId}/fiscalSupportingDocuments Resend failed supporting documents · Operation to resend the failed supporting documents to fiscal partner #
Ask an LLM
“A supporting document failed to reach the fiscal partner — how do I resend it?”
“Can failed fiscal documents be retried?”
Tell an agent
Resend failed supporting documents at hotel {hotelId}.
Retry sending documents matching {criteria} to the fiscal partner.
POST /hotels/{hotelId}/fiscalSupportingDocuments/searches Search supporting documents with a POST body · Get supporting documents details #
Ask an LLM
“Can I search fiscal supporting documents with criteria in a request body?”
“Is there a body-based search for supporting documents by departure dates?”
Tell an agent
Search supporting documents at hotel {hotelId} using a request body.
POST a supporting document search for document number {documentNo}.
PUT /hotels/{hotelId}/folio/{folioId}/convert Convert a folio's type (deprecated) · Convert Folio #
Ask an LLM
“How did the older deprecated call convert a folio to another type?”
“Is the convert folio endpoint still supported for legacy use?”
Tell an agent
Convert folio {folioId} at hotel {hotelId} with the deprecated call.
Use legacy folio conversion on {folioId}.
POST /hotels/{hotelId}/folio/{folioId}/customerVatFolio Create a customer factura VAT folio · Create Customer Factura Vat Folio #
Ask an LLM
“How do I generate a customer factura VAT folio from an existing folio?”
“Can a VAT factura be issued for a guest's folio?”
Tell an agent
Create a customer VAT folio from folio {folioId} at hotel {hotelId}.
Issue factura for folio {folioId}.
POST /hotels/{hotelId}/folio/{folioId}/fiscalCommands Create a fiscal invoice for a folio (deprecated) · Create Fiscal Invoice #
Ask an LLM
“Which deprecated call created a fiscal invoice tied to a specific folio ID?”
“Can I still issue a fiscal invoice per folio through the older endpoint?”
Tell an agent
Create a fiscal invoice for folio {folioId} at hotel {hotelId} using the deprecated call.
Use the legacy per-folio fiscal invoice for {folioId}.
GET /hotels/{hotelId}/folioHistory Look up folio history · Get folio history #
Ask an LLM
“Can I find past folios for a guest by name or room?”
“Which folios were produced at checkout on a given date?”
Tell an agent
Look up folio history at hotel {hotelId} for folio date {folioDate}.
Find old folios for guest {name} in room {room}.
POST /hotels/{hotelId}/folioHistory/searches Search folio history with a POST body · Get folio history #
Ask an LLM
“Is there a way to search folio history by sending filters in the body?”
“Can I POST a folio history search for a credit card number?”
Tell an agent
Search folio history at hotel {hotelId} with a request body.
POST a folio history search for folio number {folioNo}.
GET /hotels/{hotelId}/folioPrinters Get printers available for folios · Get folio printers #
Ask an LLM
“Which printers can I send a folio to?”
“Are there fiscal terminal printers for a given folio window?”
Tell an agent
Get folio printers at hotel {hotelId}.
Show printers for folio window {folioWindowNo} at cashier {cashierId}.
GET /hotels/{hotelId}/folioTypeNames Get the name of a folio type · Get Folio Type Name #
Ask an LLM
“What folio type name applies to an internal folio window?”
“Can I get folio type names in a particular language?”
Tell an agent
Get the folio type name at hotel {hotelId} for window {internalFolioWindowId}.
Show folio type names in language {languageCode}.
GET /hotels/{hotelId}/folioTypes List folio types · Get Folio Types #
Ask an LLM
“What folio types are configured at the property?”
“Can I include credit and compressed folio types in the list?”
Tell an agent
List folio types at hotel {hotelId}.
Show folio type {folioType} with credit types included.
PUT /hotels/{hotelId}/folios/{folioId}/fiscal Retry fiscal processing for a folio · Process Fiscal retry #
Ask an LLM
“A folio's fiscal submission failed — how do I retry it?”
“Can I reprocess the fiscal retry status on a folio?”
Tell an agent
Retry fiscal processing for folio {folioId} at hotel {hotelId}.
Reprocess fiscal status of folio {folioId}.
POST /hotels/{hotelId}/passerBySale Post a passer-by sale · Create passer by sale #
Ask an LLM
“How do I charge someone who isn't staying at the hotel?”
“Can I post a sale for a walk-in without a reservation?”
Tell an agent
Post a passer-by sale at hotel {hotelId}.
Record a walk-in sale with {criteria}.
PUT /hotels/{hotelId}/payees/{payeeId}/taxNumber Change a payee's tax number · Change Payee Tax Number #
Ask an LLM
“How do I update the tax ID for a payee on a folio?”
“Can a payee's tax number be corrected after billing?”
Tell an agent
Change the tax number for payee {payeeId} at hotel {hotelId}.
Set payee {payeeId}'s tax number using {criteria}.
PUT /hotels/{hotelId}/policies/{policyId}/transactions/{transactionId}/deposit Attach a deposit policy to a payment · Attach Deposit Policy to Payment #
Ask an LLM
“How do I apply a payment toward a specific deposit policy?”
“Can an existing payment transaction be linked to a deposit rule?”
Tell an agent
Attach deposit policy {policyId} to payment {transactionId} at hotel {hotelId}.
Link transaction {transactionId} to deposit policy {policyId}.
GET /hotels/{hotelId}/postingDates/date/postingSummary Get a posting summary for a date · Get Posting Summary #
Ask an LLM
“What's the total of postings made on a business date?”
“Can the posting summary be broken out by cashier or external system?”
Tell an agent
Get the posting summary at hotel {hotelId} for {postingDate}.
Summarize postings by cashier {cashierId} in {currency}.
POST /hotels/{hotelId}/prepaidCards Create a prepaid card · Create Prepaid Cards #
Ask an LLM
“How do I issue a new prepaid card to a guest?”
“Can a single prepaid card be created at the desk?”
Tell an agent
Create a prepaid card at hotel {hotelId}.
Issue a prepaid card with {criteria}.
PUT /hotels/{hotelId}/prepaidCards/activate Activate a prepaid card · Operation to activate prepaid card #
Ask an LLM
“How do I activate a prepaid card before it can be used?”
“Does a new prepaid card need activation?”
Tell an agent
Activate a prepaid card at hotel {hotelId}.
Activate prepaid card {criteria}.
PUT /hotels/{hotelId}/prepaidCards/cancel Cancel a prepaid card transaction · Operation to cancel prepaid card transaction #
Ask an LLM
“How do I cancel a transaction made on a prepaid card?”
“Can a prepaid card load or redemption be cancelled?”
Tell an agent destructive · confirm first
Cancel a prepaid card transaction at hotel {hotelId}.
Cancel prepaid card transaction {criteria}.
PUT /hotels/{hotelId}/prepaidCards/cashOut Cash out a prepaid card · Operation to cash out prepaid card #
Ask an LLM
“Can a guest get the remaining balance of a prepaid card back in cash?”
“How do I cash out a prepaid card?”
Tell an agent
Cash out a prepaid card at hotel {hotelId}.
Pay out the remaining balance on prepaid card {criteria}.
PUT /hotels/{hotelId}/prepaidCards/reload Reload a prepaid card · Operation to reload prepaid card #
Ask an LLM
“How do I top up a prepaid card with more value?”
“Can I add funds to an existing prepaid card?”
Tell an agent
Reload a prepaid card at hotel {hotelId}.
Top up prepaid card {criteria}.
GET /hotels/{hotelId}/profiles/{profileId}/creditCardWallet Get a profile's credit card wallet · credit card wallet #
Ask an LLM
“Which credit cards are saved on a guest profile's wallet?”
“Can I view stored cards for a profile?”
Tell an agent
Get the card wallet for profile {profileId} at hotel {hotelId}.
Show cards saved on profile {profileId}.
DELETE /hotels/{hotelId}/profiles/{profileId}/creditCardWallet Remove cards from a profile's wallet · Delete Credit Cards from Wallet #
Ask an LLM
“How do I delete a saved credit card from a guest profile?”
“Can I remove a specific card from a profile wallet?”
Tell an agent destructive · confirm first
Delete card {creditCardId} from profile {profileId}'s wallet at hotel {hotelId}.
Remove stored card {creditCardId} from profile {profileId}.
POST /hotels/{hotelId}/profiles/{profileId}/paymentMethods/creditCard/authorize Authorize a card amount on a profile · Authorize Credit Card Amount by Profile #
Ask an LLM
“How do I place a credit card authorization using a guest profile rather than a reservation?”
“Can a card pre-authorization be taken for a profile?”
Tell an agent
Authorize a credit card amount for profile {profileId} at hotel {hotelId}.
Pre-authorize {criteria} on profile {profileId}'s card.
POST /hotels/{hotelId}/profiles/{profileId}/paymentMethods/creditCard/authorizeInstructions Get card authorization instructions for a profile · Get CC Authorization Instructions By Profile #
Ask an LLM
“What card authorization rules apply to a guest profile?”
“Can I fetch authorization instructions using a profile ID?”
Tell an agent
Get card authorization instructions for profile {profileId} at hotel {hotelId}.
Fetch profile {profileId}'s card auth instructions for {criteria}.
GET /hotels/{hotelId}/receiptHistory Look up receipt history · Get Receipt History #
Ask an LLM
“Can I find receipts issued to a guest in a date range?”
“Which receipts match a receipt number or tax invoice?”
Tell an agent
Look up receipt history at hotel {hotelId} from {fromDate} to {toDate}.
Find receipt {receiptNo}.
POST /hotels/{hotelId}/receiptHistory/searches Search receipt history with a POST body · Get Receipt History #
Ask an LLM
“Can I search receipts by sending filters in a request body?”
“Is there a body-based receipt search by receipt type name?”
Tell an agent
Search receipt history at hotel {hotelId} with a request body.
POST a receipt search for custom number {customNumber}.
POST /hotels/{hotelId}/reservation/{reservationId}/rateCode/{rateCode} Post a rate code to a reservation · Create rate codes #
Ask an LLM
“How do I post a rate code's charges onto a reservation?”
“Can I apply a rate code posting to one booking?”
Tell an agent
Post rate code {rateCode} on reservation {reservationId} at hotel {hotelId}.
Apply rate code {rateCode} charges to booking {reservationId}.
PUT /hotels/{hotelId}/reservation/{reservationId}/rateCode/{rateCode}/action/validate Validate a rate code posting · Change posted rate codes #
Ask an LLM
“Can I check a rate code posting on a reservation before committing it?”
“Will posting this rate code to the booking pass validation?”
Tell an agent
Validate posting rate code {rateCode} on reservation {reservationId} at hotel {hotelId}.
Check rate code {rateCode} can be posted to {reservationId}.
POST /hotels/{hotelId}/reservations/billingCharges Post charges to many reservations · Create Billing Charges in Batch #
Ask an LLM
“How do I post the same charge to many reservations at once?”
“Can billing charges be posted in batch?”
Tell an agent
Post billing charges in batch at hotel {hotelId}.
Batch post charges for {criteria}.
GET /hotels/{hotelId}/reservations/cCSettlements List reservations for batch card settlement · Get batch CC Settlements #
Ask an LLM
“Which reservations are pending credit card settlement?”
“Can I filter pending card settlements by guest or offline status?”
Tell an agent
List batch card settlements at hotel {hotelId}.
Show pending card settlements for guest {guestName} on {transactionDate}.
GET /hotels/{hotelId}/reservations/vouchers List vouchers for a guest's reservations · Get the list of vouchers generated from a list of reservations #
Ask an LLM
“Which vouchers were generated across a guest's reservations?”
“Can I get vouchers by guest ID?”
Tell an agent
List vouchers for guest {guestId} at hotel {hotelId}.
Show every voucher issued to guest {guestId}.
GET /hotels/{hotelId}/reservations/{reservationId}/additionalTaxes Get additional taxes on a reservation · Get additional Taxes #
Ask an LLM
“What additional taxes apply to a reservation?”
“Can I see additional taxes in a different currency?”
Tell an agent
Get additional taxes for reservation {reservationId} at hotel {hotelId}.
Show additional taxes on {reservationId} in {currencyCode}.
GET /hotels/{hotelId}/reservations/{reservationId}/advancePaymentBalance Get a reservation's advance payment balance · Get advance payment balance #
Ask an LLM
“How much does a guest need to pay in advance for their nights?”
“Can I compute the advance balance for a number of nights?”
Tell an agent
Get the advance payment balance for reservation {reservationId} at hotel {hotelId}.
Calculate advance balance on {reservationId} for {numberOfNights} nights.
POST /hotels/{hotelId}/reservations/{reservationId}/advanceRoomCharges Post room charges in advance · Create advance Room Charges #
Ask an LLM
“How do I charge a guest's room nights up front?”
“Can room charges be posted in advance for a reservation?”
Tell an agent
Post advance room charges on reservation {reservationId} at hotel {hotelId}.
Charge the room nights ahead of time for booking {reservationId}.
DELETE /hotels/{hotelId}/reservations/{reservationId}/advanceRoomCharges Remove advance folio transactions · Delete Advance Folio Transactions #
Ask an LLM
“How do I undo room charges that were posted in advance?”
“Can I delete advance folio transactions for a booking?”
Tell an agent destructive · confirm first
Delete advance room charges on reservation {reservationId} at hotel {hotelId}.
Remove the advance folio postings from {reservationId} as cashier {cashierId}.
GET /hotels/{hotelId}/reservations/{reservationId}/alerts Get alert notices on a reservation · Get Alert Notices #
Ask an LLM
“Are there any alerts the cashier should see for this reservation?”
“Can I filter reservation alerts by area such as checkout?”
Tell an agent
Get alerts for reservation {reservationId} at hotel {hotelId}.
Show {alertArea} alerts on booking {reservationId}.
GET /hotels/{hotelId}/reservations/{reservationId}/authorizationHistory Get card authorization history · Get authorization history #
Ask an LLM
“What credit card authorizations have been taken on a reservation?”
“Can I include failed authorizations and refunds in the history?”
Tell an agent
Get card authorization history for reservation {reservationId} at hotel {hotelId}.
Show authorizations and failures on booking {reservationId}.
GET /hotels/{hotelId}/reservations/{reservationId}/charges Preview a charge before posting it · Get Billing Charges #
Ask an LLM
“Can I see how a charge would post, with routing applied, before posting it?”
“What would a billing charge of a given amount look like on the folio?”
Tell an agent
Preview billing charge {transactionCode} on reservation {reservationId} at hotel {hotelId}.
Show how {amount} would post to window {folioWindowNo} on {reservationId}.
POST /hotels/{hotelId}/reservations/{reservationId}/charges Post a charge to a folio · Post Charge to a folio #
Ask an LLM
“How do I post a charge to a guest's folio?”
“Can a cashier add a room service charge to a reservation's bill?”
Tell an agent
Post a charge to reservation {reservationId}'s folio at hotel {hotelId}.
Charge booking {reservationId} with {criteria}.
POST /hotels/{hotelId}/reservations/{reservationId}/chargesAndPayments Post charges and payments together · Post charges and payments on a reservation #
Ask an LLM
“Can I post both charges and a payment to a reservation in one request?”
“How do I charge a guest and settle it in the same call?”
Tell an agent
Post charges and payments on reservation {reservationId} at hotel {hotelId}.
Add charges {charges} and payments {payments} to {reservationId}.
POST /hotels/{hotelId}/reservations/{reservationId}/check/{checkNumber}/charges Pre-validate a check charge · Pre-validate the Billing Charge #
Ask an LLM
“Can I validate a guest check charge before it posts to the folio?”
“Will this outlet check post cleanly to the reservation?”
Tell an agent
Pre-validate check {checkNumber} for reservation {reservationId} at hotel {hotelId}.
Check that check {checkNumber} can post to {reservationId}.
POST /hotels/{hotelId}/reservations/{reservationId}/checkOuts Check out a guest · Check out a guest #
Ask an LLM
“How do I check a guest out of their room?”
“Can I run a checkout as verification only without completing it?”
Tell an agent
Check out reservation {reservationId} at hotel {hotelId}.
Verify checkout of {reservationId} without completing it.
PUT /hotels/{hotelId}/reservations/{reservationId}/checkOuts/reinstate Reinstate a checked-out reservation · Reinstate Checked Out Reservation #
Ask an LLM
“A guest was checked out by mistake — how do I reinstate them?”
“Can I reverse a checkout and notify interfaces?”
Tell an agent
Reinstate checked-out reservation {reservationId} at hotel {hotelId}.
Undo checkout of {reservationId} and notify interfaces.
PUT /hotels/{hotelId}/reservations/{reservationId}/comp/folios/autoSettlements Auto-settle a reservation's comp folios · Operation to auto settle comp folios #
Ask an LLM
“How do I settle comp folios on a reservation automatically?”
“Can comp folios be auto-settled at checkout?”
Tell an agent
Auto-settle comp folios on reservation {reservationId} at hotel {hotelId}.
Settle comp windows for booking {reservationId} using {criteria}.
POST /hotels/{hotelId}/reservations/{reservationId}/compRedemptionPostings Post comp bucket redemptions on a reservation · Operation to post complimentary bucket redemptions for a guest having PTS… #
Ask an LLM
“How do I post complimentary bucket redemptions onto a reservation's folio?”
“Can a PTS member's comp buckets be redeemed against their stay?”
Tell an agent
Post comp bucket redemptions on reservation {reservationId} at hotel {hotelId}.
Redeem comp buckets for stay {reservationId} with {criteria}.
POST /hotels/{hotelId}/reservations/{reservationId}/compRedemptionReversals Reverse comp bucket redemptions on a reservation · Operation to reverse complimentary bucket redemptions for a guest having PTS… #
Ask an LLM
“How do I reverse comp bucket redemptions posted to a reservation?”
“Can bucket redemptions on a stay be undone?”
Tell an agent destructive · confirm first
Reverse comp bucket redemptions on reservation {reservationId} at hotel {hotelId}.
Undo bucket redemptions on stay {reservationId} for {criteria}.
POST /hotels/{hotelId}/reservations/{reservationId}/compositeDeposit Take a deposit payment or create a deposit folio · Create Deposit Payment or Deposit Folio #
Ask an LLM
“Can I take a deposit and create its deposit folio in one step?”
“How do I record a deposit that may also need a folio?”
Tell an agent
Create a composite deposit on reservation {reservationId} at hotel {hotelId}.
Post deposit payment or folio for {reservationId} with {criteria}.
GET /hotels/{hotelId}/reservations/{reservationId}/creditCardWallet Get a reservation's credit card wallet · Credit Card Wallet #
Ask an LLM
“Which cards are stored against a reservation?”
“Can I see a reservation's wallet for one profile on it?”
Tell an agent
Get the card wallet on reservation {reservationId} at hotel {hotelId}.
Show cards on booking {reservationId} for profile {profileId}.
DELETE /hotels/{hotelId}/reservations/{reservationId}/creditCardWallet Remove cards from a reservation's wallet · Delete Credit Cards from Wallet #
Ask an LLM
“How do I delete a stored card from a reservation?”
“Can a card be removed from a reservation wallet for one profile?”
Tell an agent destructive · confirm first
Delete card {creditCardId} for profile {profileId} from reservation {reservationId} at hotel {hotelId}.
Remove card {creditCardId} from booking {reservationId}'s wallet (profile {profileId}).
POST /hotels/{hotelId}/reservations/{reservationId}/deferredTaxesProcess Submit a job to post deferred taxes · Request to submit a job to post the deferred taxes #
Ask an LLM
“How do I post taxes that were deferred on a reservation?”
“Is there a background job for deferred taxes?”
Tell an agent
Submit a deferred taxes job for reservation {reservationId} at hotel {hotelId}.
Post the deferred taxes on {reservationId}.
POST /hotels/{hotelId}/reservations/{reservationId}/deposit Process a reservation deposit · Process Reservations deposit #
Ask an LLM
“How do I process the deposit due on a reservation?”
“Can deposit processing be run for a single booking?”
Tell an agent
Process the deposit on reservation {reservationId} at hotel {hotelId}.
Run deposit processing for {reservationId} with {criteria}.
POST /hotels/{hotelId}/reservations/{reservationId}/depositCreditBill Create a credit bill for a deposit · Deposit Credit Bill #
Ask an LLM
“How do I issue a credit bill against a reservation's deposit?”
“Can a deposit be credited back with a credit bill?”
Tell an agent
Create a deposit credit bill on reservation {reservationId} at hotel {hotelId}.
Credit-bill the deposit for {reservationId}.
POST /hotels/{hotelId}/reservations/{reservationId}/depositFolios Create a deposit folio for a reservation · Create Deposit Folio #
Ask an LLM
“How do I produce a deposit folio for a booking?”
“Can a deposit folio be generated for the guest?”
Tell an agent
Create a deposit folio on reservation {reservationId} at hotel {hotelId}.
Generate the deposit folio for {reservationId}.
GET /hotels/{hotelId}/reservations/{reservationId}/depositMaturity Get deposit maturity information · Get Deposit Maturity Information #
Ask an LLM
“When do a reservation's deposits mature?”
“Can I see deposit maturity for a cashier?”
Tell an agent
Get deposit maturity info for reservation {reservationId} at hotel {hotelId}.
Show when deposits on {reservationId} mature.
POST /hotels/{hotelId}/reservations/{reservationId}/depositPayments Take a deposit payment · Create Deposit Payment #
Ask an LLM
“How do I take a deposit from a guest on their reservation?”
“Can a deposit be posted using the internal reservation ID?”
Tell an agent
Post a deposit payment on reservation {reservationId} at hotel {hotelId}.
Take deposit {criteria} for booking {reservationId}.
GET /hotels/{hotelId}/reservations/{reservationId}/depositPayments List matured deposits on a reservation · Get matured deposits #
Ask an LLM
“Which deposit payments on a reservation have already matured?”
“What matured deposits can I transfer to the guest folio?”
Tell an agent
List matured deposits on reservation {reservationId} at hotel {hotelId}.
Show matured deposit payments for {reservationId}.
PUT /hotels/{hotelId}/reservations/{reservationId}/depositTransition Move a deposit to the guest folio · Transition Deposit to Guest Folio #
Ask an LLM
“How do I transfer a deposit onto the guest folio at check-in?”
“Can deposits transition to the folio before arrival?”
Tell an agent
Transition the deposit to the guest folio on reservation {reservationId} at hotel {hotelId}.
Move deposits for {reservationId} onto the guest folio.
PUT /hotels/{hotelId}/reservations/{reservationId}/earlyDeparture Process an early departure · Change early Departure #
Ask an LLM
“How do I handle a guest leaving earlier than booked?”
“Can an early departure penalty be applied?”
Tell an agent
Process early departure on reservation {reservationId} at hotel {hotelId}.
Shorten stay {reservationId} for early departure with {criteria}.
GET /hotels/{hotelId}/reservations/{reservationId}/earlyDeparture/verify Check the impact of an early departure · Verify for early Departure #
Ask an LLM
“What happens to rates and penalties if a guest leaves early?”
“Can I check early departure while ignoring rate restrictions?”
Tell an agent
Verify early departure for reservation {reservationId} at hotel {hotelId}.
Check early departure on {reservationId} with penalty {postEarlyDeparturePenalty}.
GET /hotels/{hotelId}/reservations/{reservationId}/eligibleBillAmount Get the amount eligible for redemption · Get Eligible Bill Amount #
Ask an LLM
“How much of a folio is eligible to be paid with a redemption?”
“Can I see the eligible bill amount for one folio view?”
Tell an agent
Get the eligible bill amount on reservation {reservationId} at hotel {hotelId}.
Show redemption-eligible amount for {reservationId} folio view {folioView}.
GET /hotels/{hotelId}/reservations/{reservationId}/fetchStagedTransactions Get staged transactions for a reservation · Get fetchStagedTransactions #
Ask an LLM
“Which transactions are staged but not yet posted on a reservation?”
“Can I see staged transactions on one folio window?”
Tell an agent
Get staged transactions for reservation {reservationId} at hotel {hotelId}.
Show staged items on window {folioWindowNo} of {reservationId}.
POST /hotels/{hotelId}/reservations/{reservationId}/finalCharges Apply final postings before checkout · Apply final Postings #
Ask an LLM
“How do I apply the final charges to a reservation at departure?”
“Can final postings be applied ahead of checkout?”
Tell an agent
Apply final postings on reservation {reservationId} at hotel {hotelId}.
Post the final charges for departing booking {reservationId}.
POST /hotels/{hotelId}/reservations/{reservationId}/fiscalInfo Generate the fiscal checkout payload · Post fiscal Info #
Ask an LLM
“How do I produce the fiscal checkout payload for a reservation?”
“Can fiscal info be generated at checkout for a partner?”
Tell an agent
Generate fiscal checkout info for reservation {reservationId} at hotel {hotelId}.
Post fiscal payload {fiscalPayloadType} for {reservationId}.
GET /hotels/{hotelId}/reservations/{reservationId}/fiscalPrinting Get fiscal printing details for a reservation · Get Fiscal Printing Details #
Ask an LLM
“What fiscal printing details apply to a reservation's folio?”
“Can I fetch fiscal print info per reservation and folio type?”
Tell an agent
Get fiscal printing details for reservation {reservationId} at hotel {hotelId}.
Show fiscal print data on {reservationId} for folio type {folioType}.
GET /hotels/{hotelId}/reservations/{reservationId}/fixedCharges Get a reservation's fixed charges · Get Fixed Charges #
Ask an LLM
“Which recurring fixed charges are set on a reservation?”
“Can I see scheduled fixed charges for a stay?”
Tell an agent
Get fixed charges for reservation {reservationId} at hotel {hotelId}.
Show recurring fixed charges on {reservationId}.
PUT /hotels/{hotelId}/reservations/{reservationId}/fixedCharges Update a reservation's fixed charges · Updates Fixed Charges #
Ask an LLM
“How do I change an existing fixed charge on a stay?”
“Can fixed charge amounts or schedules be edited?”
Tell an agent
Update fixed charges on reservation {reservationId} at hotel {hotelId}.
Change fixed charges on {reservationId} to {fixedCharges}.
DELETE /hotels/{hotelId}/reservations/{reservationId}/fixedCharges Delete a fixed charge from a reservation · Delete Fixed Charges #
Ask an LLM
“How do I remove a fixed charge from a reservation?”
“Can a single fixed charge be deleted by its ID?”
Tell an agent destructive · confirm first
Delete fixed charge {fixedChargeID} from reservation {reservationId} at hotel {hotelId}.
Remove the fixed charges on booking {reservationId}.
POST /hotels/{hotelId}/reservations/{reservationId}/fixedCharges Add fixed charges to a reservation · Create Fixed Charges #
Ask an LLM
“How do I set up a new recurring charge like parking on a reservation?”
“Can I add a fixed charge to a stay?”
Tell an agent
Add fixed charges to reservation {reservationId} at hotel {hotelId}.
Create fixed charges {fixedCharges} on booking {reservationId}.
POST /hotels/{hotelId}/reservations/{reservationId}/flexibleBenefitPostings Apply flexible benefit postings · Apply flexible benefit postings #
Ask an LLM
“How do I apply a guest's flexible benefits to their folio?”
“Can flexible benefit postings be applied to a stay?”
Tell an agent
Apply flexible benefit postings on reservation {reservationId} at hotel {hotelId}.
Post flexible benefits for {reservationId} using {applyFlexibleBenefitCriteria}.
GET /hotels/{hotelId}/reservations/{reservationId}/folioTaxPayments Get folio tax payment information · Get folio tax payments information #
Ask an LLM
“What tax payments apply to a reservation's folio window?”
“Can I see folio tax payment info for a card payment method?”
Tell an agent
Get folio tax payment info for reservation {reservationId} at hotel {hotelId}.
Show tax payments on window {folioWindowNo} of {reservationId}.
GET /hotels/{hotelId}/reservations/{reservationId}/folios Get a reservation's folios · Get folios #
Ask an LLM
“What's on a guest's bill right now?”
“Can I get just the balance or a summary of a reservation's folios?”
Tell an agent
Get folios for reservation {reservationId} at hotel {hotelId}.
Show folio window {folioWindowNo} for {reservationId}.
PUT /hotels/{hotelId}/reservations/{reservationId}/folios Close a reservation's folio · Close Reservation Folio #
Ask an LLM
“How do I close a folio once it's settled?”
“Can a reservation folio be closed without checkout?”
Tell an agent
Close the folio on reservation {reservationId} at hotel {hotelId}.
Close folio {criteria} for {reservationId}.
POST /hotels/{hotelId}/reservations/{reservationId}/folios Generate folios for a reservation · Generate Folios #
Ask an LLM
“How do I generate a printable folio for a guest?”
“Can folios be generated for all windows of a stay?”
Tell an agent
Generate folios for reservation {reservationId} at hotel {hotelId}.
Produce the folio for {reservationId} with {criteria}.
POST /hotels/{hotelId}/reservations/{reservationId}/memberships/{membershipId}/awardTransactions Pay with a membership award · Post a membership award payment transaction #
Ask an LLM
“How do I pay part of a bill with loyalty points or an award voucher?”
“Can a member redeem points against their reservation folio?”
Tell an agent
Post an award payment for membership {membershipId} on reservation {reservationId} at hotel {hotelId}.
Redeem {redeemAmount} from membership {membershipId} on booking {reservationId}.
DELETE /hotels/{hotelId}/reservations/{reservationId}/packageAllowance/links Unlink a shared package allowance · Unlink reservation package allowance #
Ask an LLM
“How do I stop two reservations from sharing a package allowance?”
“Can a package allowance link be removed?”
Tell an agent destructive · confirm first
Unlink the package allowance on reservation {reservationId} at hotel {hotelId}.
Remove package allowance links from {reservationId}.
GET /hotels/{hotelId}/reservations/{reservationId}/packageOptions Get a reservation's package options · Get Reservation Package Options #
Ask an LLM
“What package options are available on a reservation?”
“Which packages could this stay use?”
Tell an agent
Get package options for reservation {reservationId} at hotel {hotelId}.
Show packages available to {reservationId}.
POST /hotels/{hotelId}/reservations/{reservationId}/paymentMethods/creditCard/authorize Authorize a card amount on a reservation · Authorize Credit Card Amount #
Ask an LLM
“How do I take a credit card pre-authorization for a reservation?”
“Can I raise the authorized amount on a guest's card?”
Tell an agent
Authorize a card amount on reservation {reservationId} at hotel {hotelId}.
Pre-authorize {criteria} on booking {reservationId}'s card.
POST /hotels/{hotelId}/reservations/{reservationId}/paymentMethods/creditCard/authorize/manual Register a manual card authorization · Register Manual Authorization #
Ask an LLM
“How do I record an authorization code obtained by phone?”
“Can a manual credit card authorization be registered on a reservation?”
Tell an agent
Register a manual card authorization on reservation {reservationId} at hotel {hotelId}.
Record manual auth {criteria} for {reservationId}.
POST /hotels/{hotelId}/reservations/{reservationId}/paymentMethods/creditCard/authorizeInstructions Get card authorization instructions for a reservation · Get CC Authorization Instructions #
Ask an LLM
“What authorization amount rules apply to a reservation's card?”
“Can I fetch card authorization instructions by reservation?”
Tell an agent
Get card authorization instructions for reservation {reservationId} at hotel {hotelId}.
Fetch auth instructions on booking {reservationId} for {criteria}.
POST /hotels/{hotelId}/reservations/{reservationId}/payments Post a payment to a reservation · Create Billing Payment #
Ask an LLM
“How do I record a guest's payment on their bill?”
“Can a payment be posted as an advance deposit?”
Tell an agent
Record a guest payment against the bill of reservation {reservationId} at hotel {hotelId}.
Record payment {criteria} for {reservationId}.
GET /hotels/{hotelId}/reservations/{reservationId}/postingActivities Get posting activity log for a reservation · Get posting activity details #
Ask an LLM
“Who posted or changed charges on a reservation, and when?”
“Can I filter posting activity by user or action type?”
Tell an agent
Get posting activity for reservation {reservationId} at hotel {hotelId}.
Show posting activity on {reservationId} by user {logUserName}.
PUT /hotels/{hotelId}/reservations/{reservationId}/prepaidCards/redemptions Redeem prepaid cards against a reservation · Operation to redeem prepaid cards #
Ask an LLM
“How do I pay a reservation's bill with a prepaid card?”
“Can multiple prepaid cards be redeemed on a stay?”
Tell an agent
Redeem prepaid cards on reservation {reservationId} at hotel {hotelId}.
Use prepaid cards {criteria} to pay {reservationId}.
POST /hotels/{hotelId}/reservations/{reservationId}/proforma Create a pro-forma invoice for a reservation · Create proforma #
Ask an LLM
“How do I produce a pro-forma invoice for a guest before they pay?”
“Can I preview charges as a pro-forma for a stay?”
Tell an agent
Create a pro-forma for reservation {reservationId} at hotel {hotelId}.
Generate pro-forma {criteria} for {reservationId}.
POST /hotels/{hotelId}/reservations/{reservationId}/proformaFolio Create a pro-forma folio for external partners · Create proforma #
Ask an LLM
“Can an external partner request a pro-forma folio for a reservation?”
“Which call gives partners a pro-forma folio rather than the in-house pro-forma?”
Tell an agent
Create a partner pro-forma folio for reservation {reservationId} at hotel {hotelId}.
Produce an external-partner pro-forma folio on {reservationId}.
GET /hotels/{hotelId}/reservations/{reservationId}/revenueBuckets Get revenue bucket totals for a reservation · Get Reservations Revenue Bucket Totals #
Ask an LLM
“How much revenue has a reservation generated in each revenue bucket?”
“Can I include comp revenue in the bucket totals?”
Tell an agent
Get revenue bucket totals for reservation {reservationId} at hotel {hotelId}.
Show {revenueBucketType} totals on {reservationId}.
POST /hotels/{hotelId}/reservations/{reservationId}/reverseCertificate Reverse certificate postings · Reverse certificate postings #
Ask an LLM
“How do I reverse a gift or award certificate posted to a reservation?”
“Can certificate postings be backed out?”
Tell an agent destructive · confirm first
Reverse certificate postings on reservation {reservationId} at hotel {hotelId}.
Undo certificate postings {reverseCriteria} on {reservationId}.
GET /hotels/{hotelId}/reservations/{reservationId}/routingInstructions Get a reservation's routing instructions · Get routing instructions #
Ask an LLM
“Where are a guest's charges being routed?”
“Can I see room and window routing effective on a date?”
Tell an agent
Get routing instructions for reservation {reservationId} at hotel {hotelId}.
Show routing on {reservationId} effective {effectiveOn}.
DELETE /hotels/{hotelId}/reservations/{reservationId}/routingInstructions Delete all routing instructions on a reservation · Delete routing instructions #
Ask an LLM
“How do I clear every routing instruction on a reservation?”
“Can I wipe all billing routing from a stay at once?”
Tell an agent destructive · confirm first
Delete all routing instructions on reservation {reservationId} at hotel {hotelId}.
Clear every routing rule from {reservationId}.
PUT /hotels/{hotelId}/reservations/{reservationId}/routingInstructions/change Change existing routing instructions · Change routing instructions #
Ask an LLM
“How do I edit a routing instruction that's already on a reservation?”
“Can routing limits or dates be changed?”
Tell an agent
Change routing instructions on reservation {reservationId} at hotel {hotelId}.
Modify routing on {reservationId} to {criteria}.
DELETE /hotels/{hotelId}/reservations/{reservationId}/routingInstructions/comp Delete comp routing on a reservation · Delete comp routing instructions #
Ask an LLM
“How do I remove comp routing from a reservation?”
“Can comp routing for a specific authorizer be deleted?”
Tell an agent destructive · confirm first
Delete comp routing on reservation {reservationId} at hotel {hotelId}.
Remove comp routing by authorizer {authorizerId} from {reservationId}.
PUT /hotels/{hotelId}/reservations/{reservationId}/routingInstructions/create Create routing instructions · Create routing instructions #
Ask an LLM
“How do I route a guest's charges to another folio or company?”
“Can I set up new billing routing on a reservation?”
Tell an agent
Create routing instructions on reservation {reservationId} at hotel {hotelId}.
Add new routing {criteria} to {reservationId}.
DELETE /hotels/{hotelId}/reservations/{reservationId}/routingInstructions/folio Delete folio window routing · Delete Folio routing instructions #
Ask an LLM
“How do I remove routing to a particular folio window?”
“Can window routing for one payee be deleted?”
Tell an agent destructive · confirm first
Delete folio routing on reservation {reservationId} at hotel {hotelId}.
Remove window {folioWindowNo} routing from {reservationId}.
DELETE /hotels/{hotelId}/reservations/{reservationId}/routingInstructions/request Delete a comp routing request · Delete request routing instructions #
Ask an LLM
“How do I withdraw a pending comp routing request?”
“Can a routing request be deleted with a comment?”
Tell an agent destructive · confirm first
Delete the routing request on reservation {reservationId} at hotel {hotelId}.
Withdraw the routing request on {reservationId} with comment {comments}.
DELETE /hotels/{hotelId}/reservations/{reservationId}/routingInstructions/room Delete room-to-room routing · Delete Room routing instructions #
Ask an LLM
“How do I stop charges routing from one room to another?”
“Can room routing be removed for a date range?”
Tell an agent destructive · confirm first
Delete room routing on reservation {reservationId} at hotel {hotelId}.
Remove room routing from {reservationId} between {startDate} and {endDate}.
PUT /hotels/{hotelId}/reservations/{reservationId}/transactions Delete today's transactions on a reservation · Delete transactions for specific reservation on current business day #
Ask an LLM
“How do I delete charges posted to a reservation today?”
“Is a reason code required to delete same-day transactions?”
Tell an agent destructive · confirm first
Delete transactions {transactionList} on reservation {reservationId} at hotel {hotelId}.
Remove today's postings on {reservationId} with reason {reasonCode}.
GET /hotels/{hotelId}/reservations/{reservationId}/transactions/{transactionId} Check if a deposit can be refunded · Get eligibility of Deposit Refund #
Ask an LLM
“Is a guest's deposit eligible for a refund?”
“Can I check refund eligibility for a specific deposit transaction?”
Tell an agent
Check refund eligibility of deposit {transactionId} on reservation {reservationId} at hotel {hotelId}.
Can deposit {transactionId} on {reservationId} be refunded — check it.
PUT /hotels/{hotelId}/reservations/{reservationId}/transactions/{transactionId} Split a deposit transaction · Split deposit transaction #
Ask an LLM
“How do I split one deposit into several amounts?”
“Can a deposit payment be divided across policies?”
Tell an agent
Split deposit {transactionId} on reservation {reservationId} at hotel {hotelId}.
Divide deposit {transactionId} on {reservationId} as {depositTransaction}.
PUT /hotels/{hotelId}/reservations/{reservationId}/transferFolioTransactions Move a whole folio to another window · Transfer Folio to Window #
Ask an LLM
“How do I move everything on one folio window to another?”
“Can a full folio be transferred between windows?”
Tell an agent
Transfer a folio to another window on reservation {reservationId} at hotel {hotelId}.
Move the whole folio on {reservationId} per {criteria}.
PUT /hotels/{hotelId}/reservations/{reservationId}/transferTransactions Move transactions to another window · Transfer Transaction to Window #
Ask an LLM
“How do I move individual charges to a different folio window?”
“Can selected transactions be shifted between windows?”
Tell an agent
Transfer transactions to another window on reservation {reservationId} at hotel {hotelId}.
Move selected charges on {reservationId} per {criteria}.
PUT /hotels/{hotelId}/reservations/{reservationId}/voidfolios/{folioId} Void a folio · Void folio #
Ask an LLM
“How do I void a folio that was generated in error?”
“Can a specific folio on a reservation be voided?”
Tell an agent destructive · confirm first
Void folio {folioId} on reservation {reservationId} at hotel {hotelId}.
Cancel folio {folioId} for {reservationId}.
GET /hotels/{hotelId}/reservations/{reservationId}/vouchers List vouchers for one reservation · Get the list of vouchers generated for a reservation #
Ask an LLM
“Which vouchers have been generated for a reservation?”
“Can I see a single stay's vouchers?”
Tell an agent
List vouchers for reservation {reservationId} at hotel {hotelId}.
Show vouchers issued on booking {reservationId}.
POST /hotels/{hotelId}/reservations/{reservationId}/vouchers Generate vouchers for a reservation · Generate Reservation Vouchers #
Ask an LLM
“How do I generate vouchers for a guest's reservation?”
“Can vouchers be created for one booking?”
Tell an agent
Generate vouchers for reservation {reservationId} at hotel {hotelId}.
Create the vouchers on booking {reservationId}.
GET /hotels/{hotelId}/reservations/{resvNameId}/compTransactionAuthorizers Get comp authorizers for a reservation's transaction · Get Comp Transaction Authorizers #
Ask an LLM
“Who can authorize a comp for a transaction on a specific reservation?”
“Can I filter a reservation's comp authorizers by name?”
Tell an agent
Get comp authorizers for transaction {transactionId} on reservation {resvNameId} at hotel {hotelId}.
Find authorizers named {authorizerName} for {transactionId} on {resvNameId}.
PUT /hotels/{hotelId}/reservations/{sourceReservationId}/deposit/transfers Transfer a deposit to another reservation · Change Reservation Deposit Transfer #
Ask an LLM
“How do I move a deposit from one reservation to another?”
“Can deposits be transferred between bookings?”
Tell an agent
Transfer the deposit from reservation {sourceReservationId} at hotel {hotelId}.
Move deposit from {sourceReservationId} per {criteria}.
PUT /hotels/{hotelId}/reservations/{toReservationId}/transferTransaction Transfer transactions to another reservation · Transfer Transaction to Reservation #
Ask an LLM
“How do I move a charge from one guest's bill to another reservation?”
“Can transactions be transferred to a different booking?”
Tell an agent
Transfer transactions to reservation {toReservationId} at hotel {hotelId}.
Move charges {criteria} onto booking {toReservationId}.
GET /hotels/{hotelId}/revenue Get hotel revenue for a business date · Get Hotel Revenue #
Ask an LLM
“What was the hotel's revenue on a given business date?”
“Can I pull property revenue for yesterday?”
Tell an agent
Get hotel revenue at hotel {hotelId} for {businessDate}.
Show revenue for business date {businessDate}.
GET /hotels/{hotelId}/routingInstructionCodes List billing routing instruction codes · Get Billing (routing) Instruction Codes #
Ask an LLM
“What routing instruction codes are configured for billing?”
“Can I search billing instruction codes by description?”
Tell an agent
List billing instruction codes at hotel {hotelId}.
Find routing codes matching {codeWildCard}.
POST /hotels/{hotelId}/sourceReservations/{sourceReservationId}/destinationReservations/{destinationReservationId}/packageAllowance/links Share a package allowance between reservations · Link Reservation package allowance #
Ask an LLM
“How do I let two reservations share one package allowance?”
“Can a package allowance be linked from one stay to another?”
Tell an agent
Link package allowance from reservation {sourceReservationId} to {destinationReservationId} at hotel {hotelId}.
Share allowances of {sourceReservationId} with {destinationReservationId}.
GET /hotels/{hotelId}/sourceReservations/{sourceReservationId}/targetReservations/{targetReservationId}/roomRouting Get postings to refresh room routing · Get Postings For Refresh #
Ask an LLM
“Which postings would move if I refresh room routing between two reservations?”
“Can I preview room routing refresh postings for a date range?”
Tell an agent
Get postings for routing refresh from {sourceReservationId} to {targetReservationId} at hotel {hotelId}.
Preview routing refresh postings {sourceReservationId} to {targetReservationId} from {startDate}.
PUT /hotels/{hotelId}/sourceReservations/{sourceReservationId}/targetReservations/{targetReservationId}/roomRouting Refresh room routing between reservations · Process Room Routing Refresh #
Ask an LLM
“How do I re-apply room routing so postings move to the target reservation?”
“Can room routing be refreshed after it changes?”
Tell an agent
Refresh room routing from {sourceReservationId} to {targetReservationId} at hotel {hotelId}.
Process routing refresh {sourceReservationId} into {targetReservationId}.
GET /hotels/{hotelId}/storedFolios/{folioId} Get a stored folio's details · Get Stored Folio Details #
Ask an LLM
“What details are stored for a folio after it was issued?”
“Can I look up a stored folio by invoice number?”
Tell an agent
Get stored folio {folioId} at hotel {hotelId}.
Show stored folio {folioId} for invoice {invoiceNo}.
POST /hotels/{hotelId}/storedFolios/{folioId} Save stored folio details · Create Stored Folio Details #
Ask an LLM
“How do I store details for an issued folio?”
“Can stored folio details be recorded for a folio ID?”
Tell an agent
Save stored details for folio {folioId} at hotel {hotelId}.
Store {storedFolioDetails} on folio {folioId}.
POST /hotels/{hotelId}/supplementFolios Post a supplemental folio · Post supplemental folio #
Ask an LLM
“How do I issue a supplemental folio after the main one?”
“Can I add a supplemental folio for extra charges?”
Tell an agent
Post a supplemental folio at hotel {hotelId}.
Create a supplement folio with {criteria}.
GET /hotels/{hotelId}/transactionCodes List transaction codes · Get Transaction Codes #
Ask an LLM
“Which transaction codes can I post charges with?”
“Can I list only codes that allow manual posting?”
Tell an agent
List transaction codes at hotel {hotelId}.
Find transaction codes matching {wildCard}.
GET /hotels/{hotelId}/transactionDetails Get folio transaction details · Get Folio Transaction Details #
Ask an LLM
“What are the full details of a transaction on a guest folio?”
“Can I include exchange information for a folio transaction?”
Tell an agent
Get folio transaction {transactionNo} at hotel {hotelId}.
Show guest-folio transaction {transactionNo} with exchange details.
GET /hotels/{hotelId}/transactions List transactions across reservations · Get Guests Transactions #
Ask an LLM
“What transactions are posted across a list of reservations?”
“Can I filter guests' transactions by transaction group?”
Tell an agent
List transactions for reservations {reservationList} at hotel {hotelId}.
Show {transactionGroup} transactions for {reservationList}.
PUT /hotels/{hotelId}/transactions/adjust Adjust posted transactions · Adjust Transactions #
Ask an LLM
“How do I adjust a charge that was posted wrong?”
“Can posted transactions be adjusted with a reason?”
Tell an agent
Adjust transactions at hotel {hotelId}.
Make adjustments {criteria}.
DELETE /hotels/{hotelId}/transactions/arInvoices/reverse Reverse an AR invoice · Reverse AR Invoice #
Ask an LLM
“How do I reverse an invoice that was sent to accounts receivable?”
“Is a reason code needed to reverse an AR invoice?”
Tell an agent destructive · confirm first
Reverse the AR invoice at hotel {hotelId} with reason {reasonCode}.
Reverse AR invoice transactions {transactionCodes} as cashier {cashierId}.
PUT /hotels/{hotelId}/transactions/split Split a transaction · Split transactions #
Ask an LLM
“How do I split one charge into smaller amounts?”
“Can a transaction be split by percentage or amount?”
Tell an agent
Split a transaction at hotel {hotelId}.
Split charge per {criteria}.
PUT /hotels/{hotelId}/transactions/splitAndTransfer Split a transaction and transfer part · Split and transfer transactions #
Ask an LLM
“How do I split a charge and move part of it to another folio?”
“Can splitting and transferring happen in one request?”
Tell an agent
Split and transfer a transaction at hotel {hotelId}.
Split then move charge per {criteria}.
GET /hotels/{hotelId}/transactions/{transactionId} Validate a transaction code · Validate Transaction Codes #
Ask an LLM
“Is a transaction code valid for posting on a folio?”
“Can I validate a code for a specific event?”
Tell an agent
Validate transaction code {transactionId} at hotel {hotelId}.
Check code {transactionId} for event {event}.
POST /hotels/{hotelId}/transactions/{transactionId} Submit a comp transaction · Submit Comp Transaction #
Ask an LLM
“How do I submit a comp transaction for processing?”
“Can a comp be submitted using its transaction number?”
Tell an agent
Submit comp transaction {transactionId} at hotel {hotelId}.
Submit comp {transactionId} with trx number {trxNo}.
PUT /hotels/{hotelId}/transactions/{transactionId}/charges Change a posted charge · Change Billing Charge #
Ask an LLM
“How do I edit a single posted charge?”
“Can a charge's amount or details be changed after posting?”
Tell an agent
Change charge {transactionId} at hotel {hotelId}.
Update posted charge {transactionId} with {criteria}.
GET /hotels/{hotelId}/transactions/{transactionId}/compRequestStatus Get a gaming comp request's status · Get Gaming Request Status #
Ask an LLM
“What's the status of a gaming comp request?”
“Has the casino system approved a comp request yet?”
Tell an agent
Get gaming request status for transaction {transactionId} at hotel {hotelId}.
Check comp request status on {transactionId}.
DELETE /hotels/{hotelId}/transactions/{transactionId}/flexibleBenefitPostings Reverse a flexible benefit posting · Delete flexible benefit postings #
Ask an LLM
“How do I undo a flexible benefit that was applied to a folio?”
“Can a flexible benefit posting be removed?”
Tell an agent destructive · confirm first
Reverse flexible benefit posting {transactionId} at hotel {hotelId}.
Delete flexible benefit on {transactionId}.
PUT /hotels/{hotelId}/transactions/{transactionId}/payments Change a posted payment · Change Billing Payment #
Ask an LLM
“How do I edit a payment that was already recorded?”
“Can a payment's details be corrected?”
Tell an agent
Change payment {transactionId} at hotel {hotelId}.
Update payment {transactionId} with {criteria}.
PUT /hotels/{hotelId}/transactions/{transactionId}/policies/detach/deposit Detach a deposit policy from a payment · Detach Deposit Policy from Payment #
Ask an LLM
“How do I unlink a payment from a deposit policy?”
“Can a deposit rule be detached from a transaction?”
Tell an agent
Detach the deposit policy from payment {transactionId} at hotel {hotelId}.
Unlink deposit policy from {transactionId}.
POST /hotels/{hotelId}/transactions/{transactionId}/reversePayments Reverse a payment · Create reverse payments #
Ask an LLM
“How do I reverse a payment that was posted?”
“Can a card payment be reversed?”
Tell an agent destructive · confirm first
Reverse payment {transactionId} at hotel {hotelId}.
Reverse payment {transactionId} using {payment}.
GET /hotels/{hotelId}/transactionsTotal Get balance information (deprecated) · Get Balance Information #
Ask an LLM
“How did the deprecated balance information call compute a folio balance?”
“Is the older transactions total endpoint still usable?”
Tell an agent
Get balance info at hotel {hotelId} with the deprecated call.
Use legacy balance total for window {folioWindowNo}.
POST /hotels/{hotelId}/transferCompTransactions Move comp transactions to a window · Transfer comp transactions to window #
Ask an LLM
“How do I transfer comp transactions to another folio window?”
“Can comp charges be moved between windows?”
Tell an agent
Transfer comp transactions to a window at hotel {hotelId}.
Move comp transactions per {criteria}.
POST /hotels/{hotelId}/vouchers/batchJobs Start a batch voucher generation job · Generate Batch Vouchers #
Ask an LLM
“How do I generate vouchers for many reservations at once?”
“Is there a batch job for voucher generation?”
Tell an agent
Start batch voucher generation at hotel {hotelId}.
Generate vouchers in batch for {criteria}.
POST /hotels/{hotelId}/zeroBalanceCheckoutReservations/batchJobs Batch check out zero-balance reservations · Create Zero Balance Checkout Reservation Batch #
Ask an LLM
“How can I check out every departing guest whose balance is zero?”
“Is there a batch job for zero balance checkouts?”
Tell an agent
Start a zero balance checkout batch at hotel {hotelId}.
Check out zero-balance reservations matching {criteria}.
POST /reservations/{reservationId}/postRoomAndTaxForDayUse Post room and tax for a day-use stay · Operation to post room and tax for day use #
Ask an LLM
“How do I charge room and tax for a day-use reservation?”
“Can day-use room charges be posted by a cashier?”
Tell an agent
Post room and tax for day-use reservation {reservationId} at hotel {hotelId}.
Charge day-use room and tax on {reservationId} as cashier {cashierId}.
GET /roundingDifference Get a payment's rounding difference · Get Rounding Difference #
Ask an LLM
“What rounding difference applies when a guest pays a certain amount?”
“Can I calculate rounding for a cash payment in a currency?”
Tell an agent
Get the rounding difference at hotel {hotelId} for {amount} {currencyCode}.
Check rounding on window {folioWindowNo} for payment method {paymentMethod}.
GET /services/cashiering/status Check the cashiering service status · Status check of cashiering services #
Ask an LLM
“Is the cashiering service up and responding?”
“Can I health-check the cashiering API?”
Tell an agent
Check the cashiering service status at hotel {hotelId}.
Ping the cashiering service.
GET /hotels/{hotelId}/financialPostingsNetVat/{statusId} Get async financial postings results · Get results of Financial Postings with Net and Vat breakdown #
Ask an LLM
“How do I fetch the results of an asynchronous financial postings request?”
“Where do I get net and VAT postings once the async job is done?”
Tell an agent
Get async financial postings results {statusId} at hotel {hotelId}.
Fetch finished financial postings job {statusId}.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/oracle-hospitality:oracle-hospitality-cashiering-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

oracle-hospitality-cashiering-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Oracle Hospitality Cashiering API
  version: 26.2.0.0
  contact:
    email: hospitality_apis_ww_grp@oracle.com
  license:
    name: UPL
    url: https://opensource.org/licenses/upl
  termsOfService: https://www.oracle.com/legal/terms.html
  description: 'Operations tagged Cashiering across 3 of this provider''s published API definitions: oracle-hospitality-property-outbound-cshoutbound.json, oracle-hospitality-property-v1-csh.json, oracle-hospitality-property-v1-cshasync.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /csh/v1
- url: /csh/async/v1
tags:


# --- truncated at 32 KB (1346 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle-hospitality/refs/heads/main/openapi/oracle-hospitality-cashiering-api-openapi.yml