OperationId:getCashierReportPostings
This API allows a time span of 30 days.
" }, { "info": { "name": "Close Cashier", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/cashiers/:cashierId/closure", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "cashierId", "value": "", "type": "path", "description": "Unique ID of the cashier." } ] }, "docs": "You can use this API to change Cashier Closure.OperationId:putCashier
" }, { "info": { "name": "Acquire Cashier Locks", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/cashiers/:cashierId/locks", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "cashierId", "value": "", "type": "path", "description": "Unique ID of the cashier." } ] }, "docs": "You can use this API to Acquire Cashier Locks.OperationId:getCashierLock
" }, { "info": { "name": "Break Cashier Lock", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/cashiers/:cashierId/locks", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "cashierId", "value": "", "type": "path", "description": "Unique ID of the cashier." } ] }, "docs": "You can use this API to Break Cashier Lock.OperationId:breakCashierLock
" }, { "info": { "name": "Get Cashier Transactions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/cashiers/:cashierId/transactions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "cashierId", "value": "", "type": "path", "description": "Unique ID of the cashier." }, { "name": "closureNo", "value": "", "type": "query", "description": "The Cashier Shift Number." }, { "name": "shiftDropLocationCode", "value": "", "type": "query", "description": "Cashier closure shift drop location code." }, { "name": "bagNumberForOthers", "value": "", "type": "query", "description": "Cashier closure shift drop others payment method type bag number." }, { "name": "bagNumberForCash", "value": "", "type": "query", "description": "Cashier closure shift drop cash payment method type bag number." } ] }, "docs": "You can use this API to get Cashier Transactions.OperationId:getCashierTransactions
" }, { "info": { "name": "Release Cashier Lock", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/cashiersLock/:lockId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "lockId", "value": "", "type": "path", "description": "Unique ID of the lock." } ] }, "docs": "You can use this API to Release Cashier Lock.OperationId:releaseCashierLock
" }, { "info": { "name": "Get Comp Accounting Journal", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/compAccountingJournal", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned." }, { "name": "startDate", "value": "", "type": "query" }, { "name": "endDate", "value": "", "type": "query" }, { "name": "duration", "value": "", "type": "query" }, { "name": "filterTransactionCode", "value": "", "type": "query" }, { "name": "hotelId", "value": "", "type": "query" }, { "name": "filterRoomNumber", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "type", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)." }, { "name": "approvalCode", "value": "", "type": "query", "description": "Filters the results for approval code." }, { "name": "code", "value": "", "type": "query" }, { "name": "authorizerNameCode", "value": "", "type": "query" }, { "name": "referenceNumberWildCard", "value": "", "type": "query", "description": "Filters the results for reference number." }, { "name": "supplementWildCard", "value": "", "type": "query", "description": "Filter the results for supplement." } ] }, "docs": "You can use this API to get Comp Accounting Journal.This API is deprecated. Please use getCompPostingJournal instead
OperationId:getCompAccountingJournal
The maximum allowable limit for this API is 50.
This API allows a time span of 30 days.
" }, { "info": { "name": "Create FBA Reimbursement", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/fbaReimbursements", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "You can use this API to create FBA Reimbursement.OperationId:postFBAReimbursement
" }, { "info": { "name": "Create FBA Settlement", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/fbaSettlements", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "You can use this API to create FBA Settlement.OperationId:postFBASettlement
" }, { "info": { "name": "Calculate Foreign Currency", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/foreignCurrency", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "This API will allow you to Calculate Foreign Currency exchange.OperationId:calculateForeignCurrency
" }, { "info": { "name": "Create Foreign Currency Exchange", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/foreignCurrencyExchange", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "You can use this API to Create Foreign Currency Exchange.OperationId:postForeignCurrencyExchange
" }, { "info": { "name": "Create Batch Advance Folio", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/advanceFolio/batchJobs", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to create Batch Advance Folio.OperationId:postAdvanceFolio
" }, { "info": { "name": "Create Articles Sale", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/articlesSale", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to create Articles Sale.OperationId:postArticlesSale
" }, { "info": { "name": "Get Authorizers Credit Info", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/authorizers/credits", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "startDate", "value": "", "type": "query" }, { "name": "endDate", "value": "", "type": "query" }, { "name": "duration", "value": "", "type": "query" }, { "name": "code", "value": "", "type": "query" }, { "name": "includeCreditDetails", "value": "", "type": "query", "description": "This flag will notify the service if the Credit details will also be returned or not." } ] }, "docs": "You can use this API to get Authorizers Credit Info.OperationId:getAuthorizersCreditInfo
" }, { "info": { "name": "Create Auto Checkout Reservation Batch ", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/autoCheckoutReservations/batchJobs", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to create Auto Checkout Reservation Batch.OperationId:postAutoCheckoutReservations
" }, { "info": { "name": "Create Batch Auto Settlement", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/autoSettlements/batchJobs", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to create Batch Auto Settlement.OperationId:postBatchAutoSettlement
" }, { "info": { "name": "Create batch deposits", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/batchDeposits", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to create batch deposits.OperationId:postBatchDeposit
" }, { "info": { "name": "Get bed tax information", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/bedTax", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "arrival", "value": "", "type": "query", "description": "Arrival Date of the reservation" } ] }, "docs": "You can use this API to Retrieve bed tax information for a property.OperationId:getBedTaxInfo
" }, { "info": { "name": "Create bed tax information", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/bedTax", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to create new bed tax information for a property.OperationId:postBedTaxInfo
" }, { "info": { "name": "Change bed tax information", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/bedTax/:taxRegistraitionNo", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "taxRegistraitionNo", "value": "", "type": "path", "description": "Unique number of the tax registration." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to Update bed tax information for a property.OperationId:putBedTaxInfo
" }, { "info": { "name": "Delete bed tax information", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/bedTax/:taxRegistraitionNo", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "taxRegistraitionNo", "value": "", "type": "path", "description": "Unique number of the tax registration." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to delete bed tax information for a property.OperationId:removeBedTaxInfo
" }, { "info": { "name": "Change Billing Charges", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/billingCharges", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to change Billing Charges.OperationId:putBillingCharges
" }, { "info": { "name": "Get Batch CC Settlements Status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/bulkCCSettlements/:batchId/status", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "batchId", "value": "", "type": "path", "description": "Unique ID of the batch" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "id", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "type", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)." } ] }, "docs": "You can use this API to get Batch CC Settlements Status.OperationId:getBatchCCSettlementsStatus
" }, { "info": { "name": "Create multiple Prepaid Cards", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/bulkPrepaidCards", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to create multiple Prepaid Cards.OperationId:postBulkPrepaidCards
" }, { "info": { "name": "Get Cashier Closure", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/cashiers/:cashierId/closure", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "cashierId", "value": "", "type": "path", "description": "Unique ID of the cashier." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "cashierLockHandle", "value": "", "type": "query", "description": "The Cashier Lock Handle to pass along with operation which required cashier to be locked." } ] }, "docs": "You can use this API to get Cashier Closure.OperationId:getCashierClosure
" }, { "info": { "name": "Get Cashier Closure Reports List", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/cashiers/:cashierId/closureReports", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "cashierId", "value": "", "type": "path", "description": "Unique ID of the cashier." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "closureNo", "value": "", "type": "query", "description": "The Cashier Shift Number." }, { "name": "shiftDropLocationCode", "value": "", "type": "query", "description": "Cashier closure shift drop location code." }, { "name": "bagNumberForOthers", "value": "", "type": "query", "description": "Cashier closure shift drop others payment method type bag number." }, { "name": "bagNumberForCash", "value": "", "type": "query", "description": "Cashier closure shift drop cash payment method type bag number." } ] }, "docs": "You can use this API to get Cashier Closure Reports List.OperationId:getCashierClosureReportsList
" }, { "info": { "name": "Change folio tax payments", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/cashiers/:cashierId/folioTaxPayments", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "cashierId", "value": "", "type": "path", "description": "Unique ID of the cashier." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to change folio tax payments.OperationId:reverseFolioTaxPayment
" }, { "info": { "name": "Extend Cashier Lock", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/cashierslock/:lockId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "lockId", "value": "", "type": "path", "description": "Unique ID of the lock." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to Extend cashiers lock.OperationId:putCashierLock
" }, { "info": { "name": "Get Cash Surcharge Information", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/cashsurcharge", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "cashierId", "value": "", "type": "query", "description": "The Cashier ID of the Cashier who is currently processing the transaction(s)." }, { "name": "folioView", "value": "", "type": "query" }, { "name": "paymentMethod", "value": "", "type": "query" }, { "name": "trxAmount", "value": "", "type": "query", "description": "Amount on which the Cash Surcharge has to be applied." }, { "name": "currencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." } ] }, "docs": "You can use this API to get the Cash Surcharge Information.OperationId:getCashSurchargeInfo
" }, { "info": { "name": "Create CreditCard Settlement", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/ccSettlement", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to create cc Settlement.OperationId:postCCSettlement
" }, { "info": { "name": "Create Batch CC Settlements", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/ccSettlements/batchJobs", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to create Batch CC Settlements.OperationId:postBatchCCSettlements
" }, { "info": { "name": "Get check details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/check/:checkNumber", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "checkNumber", "value": "", "type": "path", "description": "Unique number of the check" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to get check details.OperationId:getCheckDetails
" }, { "info": { "name": "Post Guest Check Details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/check/:checkNumber", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "checkNumber", "value": "", "type": "path", "description": "Unique number of the check" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "This operation is to add guest check details for posted check transactions.OperationId:postGuestCheckDetails
" }, { "info": { "name": "Update Guest Check Details", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/check/:checkNumber", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "checkNumber", "value": "", "type": "path", "description": "Unique number of the check" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "This operation is to update guest check details for posted check transactions.OperationId:putGuestCheckDetails
" }, { "info": { "name": "Delete Billing Check Charges", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/check/:checkNumber/charges", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "checkNumber", "value": "", "type": "path", "description": "Unique number of the check." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "revenueDate", "value": "", "type": "query", "description": "The date against which void (reverse) charges are posted." }, { "name": "amount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "currencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "reservationId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "reservationIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "reservationIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)." }, { "name": "checkId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "checkIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "checkIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)." }, { "name": "cashierId", "value": "", "type": "query", "description": "Cashier Id of the Cashier." }, { "name": "postingRemark", "value": "", "type": "query", "description": "Text describing any applicable detail of the posting." } ] }, "docs": "You can use this API to delete (void) Billing Check Charges.OperationId:voidBillingCheckCharges
" }, { "info": { "name": "Get Cashier Closure Information", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/closureList", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "closureNo", "value": "", "type": "query", "description": "The Cashier Shift Number." }, { "name": "cashierId", "value": "", "type": "query", "description": "The Cashier ID of the Cashier who is currently processing the transaction(s)." }, { "name": "shiftDropLocationCode", "value": "", "type": "query", "description": "Cashier closure shift drop location code." }, { "name": "bagNumberForOthers", "value": "", "type": "query", "description": "Cashier closure shift drop others payment method type bag number." }, { "name": "bagNumberForCash", "value": "", "type": "query", "description": "Cashier closure shift drop cash payment method type bag number." }, { "name": "closureBusinessDate", "value": "", "type": "query", "description": "Business Date of cashier closure." } ] }, "docs": "You can use this API to get Cashier Closure Information.OperationId:getCashierClosureInfo
" }, { "info": { "name": "Get Comp Accounting Journal", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/compAccountingJournal", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned." }, { "name": "startDate", "value": "", "type": "query" }, { "name": "endDate", "value": "", "type": "query" }, { "name": "duration", "value": "", "type": "query" }, { "name": "filterTransactionCode", "value": "", "type": "query" }, { "name": "filterRoomNumber", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "type", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)." }, { "name": "approvalCode", "value": "", "type": "query", "description": "Filters the results for approval code." }, { "name": "code", "value": "", "type": "query" }, { "name": "authorizerNameCode", "value": "", "type": "query" }, { "name": "referenceNumberWildCard", "value": "", "type": "query", "description": "Filters the results for reference number." }, { "name": "supplementWildCard", "value": "", "type": "query", "description": "Filter the results for supplement." } ] }, "docs": "You can use this API to get Comp Accounting Journal.OperationId:getCompPostingJournal
The maximum allowable limit for this API is 50.
This API allows a time span of 30 days.
" }, { "info": { "name": "Get Comp Routing Instructions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/compRoutingInstructions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "end", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "start", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "nameWildcard", "value": "", "type": "query", "description": "Family name or last name of the guest" }, { "name": "firstNameWildCard", "value": "", "type": "query", "description": "Given name or first name of the guest." }, { "name": "roomNumberCodes", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "type", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)." }, { "name": "membershipId", "value": "", "type": "query", "description": "Membership Card number." }, { "name": "code", "value": "", "type": "query" }, { "name": "resStatusCode", "value": "", "type": "query", "description": "This reservation is in checked in status and the business date is past departure date. This could occur when ORS and PMS are in same environment." }, { "name": "compRoutingStatuses", "value": "", "type": "query", "description": "Status which indicates that the Request of Comp Routing was declined" } ] }, "docs": "You can use this API to get Comp Routing Instructions.OperationId:getCompRoutingInstructions
This API allows a time span of 30 days.
" }, { "info": { "name": "Get Comp Routing Instructions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/compRoutingInstructions/searches", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to get Comp Routing Instructions.OperationId:searchCompRoutingInstructions
This API allows a time span of 30 days.
" }, { "info": { "name": "Get Comp Trx Authorizers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/compTrxAuthorizers", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "cashierId", "value": "", "type": "query", "description": "The Cashier ID of the Cashier who is currently processing the transaction(s)." }, { "name": "id", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "type", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)." }, { "name": "targetFolioWindowNo", "value": "", "type": "query", "description": "Folio Window Number to where transactions will be transfered." }, { "name": "uniqueIdId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "uniqueIdIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "uniqueIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)." }, { "name": "transaction", "value": "", "type": "query", "description": "List of transactions to be transfered." }, { "name": "authorizerIdId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "authorizerIdIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "authorizerIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)." } ] }, "docs": "You can use this API to get Comp Trx Authorizers.OperationId:getCompTrxAuthorizers
" }, { "info": { "name": "Get transaction covers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/covers", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "coversDate", "value": "", "type": "query" }, { "name": "transactionCode", "value": "", "type": "query", "description": "Transaction Code to search." } ] }, "docs": "You can use this API to get Trx Covers.OperationId:getTransactionCovers
" }, { "info": { "name": "Change Transaction Covers", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/covers", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to change Trx Covers.OperationId:changeTransactionCovers
" }, { "info": { "name": "Create Credit Bill", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/creditBill", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to create Credit Bill.OperationId:postCreditBill
" }, { "info": { "name": "Validate Credit Bill", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/creditBill/action/validate", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to validate credit Bill.OperationId:validateCreditBill
" }, { "info": { "name": "Get Credit Limits Overage Payments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/creditLimitsOveragePayments", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "guestNameWildCard", "value": "", "type": "query", "description": "Guest name associated with the transaction." }, { "name": "roomNumberWildCard", "value": "", "type": "query", "description": "Room number associated with the transaction." }, { "name": "code", "value": "", "type": "query" } ] }, "docs": "You can use this API to get Credit Limits Overage Payments.OperationId:getCreditLimitOveragePayments
" }, { "info": { "name": "Create Credit Limit Overage Payments", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/creditLimitsOveragePayments", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to create Credit Limit Overage Payments.OperationId:postCreditLimitOveragePayments
" }, { "info": { "name": "Register Vault Transaction", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/creditcardTransaction/logs", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to create vault transaction.OperationId:registerVaultTransaction
" }, { "info": { "name": "Get CC Surcharge Information", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/creditcardsurcharge", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "cashierId", "value": "", "type": "query", "description": "The Cashier ID of the Cashier who is currently processing the transaction(s)." }, { "name": "description", "value": "", "type": "query" }, { "name": "folioView", "value": "", "type": "query" }, { "name": "paymentMethod", "value": "", "type": "query" }, { "name": "track2Data", "value": "", "type": "query", "description": "Track2 data for the card which would be sent to the CC vendor as part of the authorization." }, { "name": "attachCreditCardToProfile", "value": "", "type": "query", "description": "Attach the credit card to profile." }, { "name": "cardHolderName", "value": "", "type": "query" }, { "name": "cardNumber", "value": "", "type": "query" }, { "name": "cardNumberLast4Digits", "value": "", "type": "query" }, { "name": "cardNumberMasked", "value": "", "type": "query" }, { "name": "cardOrToken", "value": "", "type": "query", "description": "Simple type for indicating if credit card number is tokenized." }, { "name": "cardType", "value": "", "type": "query", "description": "This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method." }, { "name": "expirationDate", "value": "", "type": "query", "description": "Expiration date of the credit card" }, { "name": "expirationDateExpired", "value": "", "type": "query" }, { "name": "expirationDateMasked", "value": "", "type": "query", "description": "Masked Expiration date of the credit card" }, { "name": "processing", "value": "", "type": "query" }, { "name": "swiped", "value": "", "type": "query" }, { "name": "userDefinedCardType", "value": "", "type": "query", "description": "Indicates the user defined credit card type if credit card type from a defined list is not provided" }, { "name": "id", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "type", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)." }, { "name": "amount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "currencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "approvalAmountNeededAmount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "approvalAmountNeededCurrencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "balanceAmount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "balanceCurrencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "code", "value": "", "type": "query", "description": "The authorization rule code." }, { "name": "amountAmount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "amountCurrencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "percent", "value": "", "type": "query", "description": "A percentage value if the authorization rule is percentage based." }, { "name": "emailFolio", "value": "", "type": "query" }, { "name": "uniqueIdId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "uniqueIdIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "uniqueIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)." }, { "name": "createDateTime", "value": "", "type": "query", "description": "Time stamp of the creation." }, { "name": "creatorId", "value": "", "type": "query", "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation." }, { "name": "emailAddress", "value": "", "type": "query", "description": "Defines the e-mail address." }, { "name": "emailFormat", "value": "", "type": "query", "description": "Supported Email format." }, { "name": "lastModifierId", "value": "", "type": "query", "description": "Identifies the last software system or person to modify a record." }, { "name": "lastModifyDateTime", "value": "", "type": "query", "description": "Time stamp of last modification." }, { "name": "orderSequence", "value": "", "type": "query", "description": "Display Order sequence." }, { "name": "primaryInd", "value": "", "type": "query", "description": "When true, indicates a primary information." }, { "name": "purgeDate", "value": "", "type": "query", "description": "Date an item will be purged from a database (e.g., from a live database to an archive)." }, { "name": "emailType", "value": "", "type": "query", "description": "Defines the purpose of the e-mail address (e.g. personal, business, listserve)." }, { "name": "typeDescription", "value": "", "type": "query", "description": "Describes the Type code" }, { "name": "approvalCode", "value": "", "type": "query", "description": "The approval code authenticates the authorization." }, { "name": "originalAuthSequence", "value": "", "type": "query", "description": "Unique Authorization Sequence for the authorization and settlement." }, { "name": "vendorTranId", "value": "", "type": "query", "description": "Vendor transaction id for the authorization." }, { "name": "alternateTransRef", "value": "", "type": "query", "description": "Alternate vendor transaction id for the authorization." }, { "name": "approvalAmountAmount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "approvalAmountCurrencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "postingAmountAmount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "postingAmountCurrencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." } ] }, "docs": "You can use this API to get CC Surcharge Information.OperationId:getCCSurchargeInfo
" }, { "info": { "name": "Get Deposit Folio", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/depositFolio", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "fetchInstructions", "value": "", "type": "query", "description": "Simple type for deposit folio instructions that can be used in requests for partial operations." }, { "name": "id", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "policyIdId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "blockIdId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." } ] }, "docs": "You can use this API to get Deposit Folio.OperationId:getDepositFolio
" }, { "info": { "name": "Get Deposit Folio Transaction Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/depositTransactions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "includeGenerates", "value": "", "type": "query", "description": "Flag to indicate if the automatically generated transactions, related to the main transaction number above, are also to be retrieved as part of this request." }, { "name": "transactionNo", "value": "", "type": "query", "description": "Unique Transaction Number of the transaction(posting) for which details are required." }, { "name": "includeExchangeInformation", "value": "", "type": "query", "description": "Flag to indicate what currency exchange information text needs to be included in response." } ] }, "docs": "You can use this API to get Deposit Folio Transaction Details.OperationId:getDepositFolioTransactionDetails
" }, { "info": { "name": "Validate Deposit Folio", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/depositfolios/action/validate", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to validate Deposit Folio.OperationId:validateDepositFolio
" }, { "info": { "name": "Create Deposit Payment using external reference.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/externalSystems/:externalSysCode/reservations/:reservationId/depositPayments", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "External System's reservation ID." }, { "name": "externalSysCode", "value": "", "type": "path", "description": "Code to identify the external system from which the request is coming. This is the ExternalSystem ID used to exchange information between OPERA and the external system." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to create Deposit Payment with external reference.OperationId:postDepositPaymentByExtId
" }, { "info": { "name": "Get Financial Postings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/financialPostings", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned." }, { "name": "startDate", "value": "", "type": "query" }, { "name": "endDate", "value": "", "type": "query" }, { "name": "duration", "value": "", "type": "query" }, { "name": "cashierId", "value": "", "type": "query", "description": "Cashier Id of the Cashier." }, { "name": "filterTransactionCode", "value": "", "type": "query" }, { "name": "code", "value": "", "type": "query" }, { "name": "filterRoomNumber", "value": "", "type": "query" }, { "name": "referenceNumberWildCard", "value": "", "type": "query", "description": "Filters the results for reference number." }, { "name": "checkNumberWildCard", "value": "", "type": "query", "description": "Filter the results for Cheque number's code." }, { "name": "supplementWildCard", "value": "", "type": "query", "description": "Filter the results for supplement." }, { "name": "approvalCode", "value": "", "type": "query", "description": "Filters the results for approval code." }, { "name": "approvalStatusCode", "value": "", "type": "query" }, { "name": "folioWindowNo", "value": "", "type": "query", "description": "Filters the result to only include transactions in this window number." }, { "name": "attachCreditCardToProfile", "value": "", "type": "query", "description": "Attach the credit card to profile." }, { "name": "cardHolderName", "value": "", "type": "query" }, { "name": "cardNumber", "value": "", "type": "query" }, { "name": "cardNumberLast4Digits", "value": "", "type": "query" }, { "name": "cardNumberMasked", "value": "", "type": "query" }, { "name": "cardOrToken", "value": "", "type": "query", "description": "Simple type for indicating if credit card number is tokenized." }, { "name": "cardType", "value": "", "type": "query", "description": "This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method." }, { "name": "expirationDate", "value": "", "type": "query", "description": "Expiration date of the credit card" }, { "name": "expirationDateExpired", "value": "", "type": "query" }, { "name": "expirationDateMasked", "value": "", "type": "query", "description": "Masked Expiration date of the credit card" }, { "name": "processing", "value": "", "type": "query" }, { "name": "swiped", "value": "", "type": "query" }, { "name": "userDefinedCardType", "value": "", "type": "query", "description": "Indicates the user defined credit card type if credit card type from a defined list is not provided" }, { "name": "id", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "type", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)." }, { "name": "amount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "currencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "approvalAmountNeededAmount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "approvalAmountNeededCurrencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "closureNo", "value": "", "type": "query", "description": "Filters the result to only display the postings that were made during the cashier closure range" } ] }, "docs": "You can use this API to get Financial postings.OperationId:getFinancialPostings
The maximum allowable limit for this API is 50.
This API allows a time span of 30 days.
" }, { "info": { "name": "Get Financial Postings with breakdown", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/financialPostingsNetVat", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "reservationId", "value": "", "type": "query", "description": "Unique ID of the reservation" }, { "name": "folioWindowNo", "value": "", "type": "query" }, { "name": "startDate", "value": "", "type": "query" }, { "name": "endDate", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned." } ] }, "docs": "You can use this API to get Financial postings with Net and Vat breakdown.OperationId:financialPostingsNetVat
The maximum allowable limit for this API is 50.
This API allows a time span of 30 days.
" }, { "info": { "name": "Create Fiscal Invoice", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/fiscalCommands", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to create Fiscal Invoice.OperationId:postFiscalCommandInvoice
" }, { "info": { "name": "Get the Fiscal Folio Activity for a folio", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/fiscalFolioResponse", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "folioSeqNo", "value": "", "type": "query", "description": "Folio Sequence number for a folio" } ] }, "docs": "You can use this API to get the fiscal folio activity details for a folio.OperationId:getFiscalFolioActivity
" }, { "info": { "name": "Get the Fiscal Folio Activity Response details for a folio", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/fiscalFolioResponse/:folioSeqNo", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "folioSeqNo", "value": "", "type": "path", "description": "Unique ID of the folio" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "responseAttemptNo", "value": "", "type": "query", "description": "Number of fiscal response attempt made for the folio" } ] }, "docs": "You can use this API to get the fiscal folio activity response details for a folio.OperationId:getFiscalFolioActivityDetails
" }, { "info": { "name": "Create Fiscal Information Folio", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/fiscalFolios", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to create Fiscal Information Folio.OperationId:generateFiscalFolio
" }, { "info": { "name": "Get Fiscal Printing Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/fiscalPrinting", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "folioView", "value": "", "type": "query", "description": "The folio window where this settlement is applied." }, { "name": "folioType", "value": "", "type": "query", "description": "Folio Type" }, { "name": "id", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "code", "value": "", "type": "query" }, { "name": "fetchInstruction", "value": "", "type": "query", "description": "Reservation Related information." }, { "name": "profileIdId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "fiscalServiceMode", "value": "", "type": "query", "description": "Mode when fiscal printing is called." }, { "name": "cashieringEventType", "value": "", "type": "query", "description": "Cashiering event triggered." }, { "name": "balance", "value": "", "type": "query", "description": "A monetary amount" }, { "name": "queueName", "value": "", "type": "query", "description": "Folio Queue Name" }, { "name": "debitFolio", "value": "", "type": "query", "description": "This flag indicates if the folio to be generated is a Debit Folio." }, { "name": "simpleFolio", "value": "", "type": "query", "description": "This flag indicates if the folio to be generated is a Simple Folio." }, { "name": "manualFolioNo", "value": "", "type": "query", "description": "User provided folio number." } ] }, "docs": "You can use this API to get Fiscal Printing Details.OperationId:getValidateFiscalPrintingDetails
" }, { "info": { "name": "Get supporting documents details.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/fiscalSupportingDocuments", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel." }, { "name": "surname", "value": "", "type": "query", "description": "Family name, last name." }, { "name": "givenName", "value": "", "type": "query", "description": "Given name, first name or names." }, { "name": "confirmationNo", "value": "", "type": "query", "description": "Confirmation number of the reservation." }, { "name": "arrivalStartDate", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "arrivalEndDate", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "departureStartDate", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "departureEndDate", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "roomId", "value": "", "type": "query", "description": "Room number of the the transaction." }, { "name": "documentType", "value": "", "type": "query", "description": "Supporting document type." }, { "name": "documentNo", "value": "", "type": "query", "description": "Supporting document number." }, { "name": "pendingDocumentsOnly", "value": "", "type": "query", "description": "Indicator to fetch only failed supporting documents, that were not sent successfully to the fiscal partner." }, { "name": "fromCreateDateTime", "value": "", "type": "query", "description": "Time stamp of the creation." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records the API should return. Default is 50" }, { "name": "offset", "value": "", "type": "query", "description": "Index of the page being requested. If the index goes out of the bounds of the total set count, no data will be returned." }, { "name": "orderBy", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" } ] }, "docs": "This API is used to get the list of supporting documents for the reservations.OperationId:getSupportingDocuments
The maximum allowable limit for this API is 20.
" }, { "info": { "name": "Operation to resend the failed supporting documents to fiscal partner.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/fiscalSupportingDocuments", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "This API is used to resend the failed supporting documents.OperationId:resendSupportingDocument
" }, { "info": { "name": "Get supporting documents details.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/fiscalSupportingDocuments/searches", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel." } ] }, "docs": "This API is used to get the list of supporting documents for the reservations.OperationId:searchFiscalSupportingDocuments
The maximum allowable limit for this API is 20.
" }, { "info": { "name": "Convert Folio", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/folio/:folioId/convert", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "folioId", "value": "", "type": "path", "description": "Unique ID of the folio" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to Convert folio.This API is deprecated. Please use putFolioType insteadOperationId:convertFolio
" }, { "info": { "name": "Create Customer Factura Vat Folio.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/folio/:folioId/customerVatFolio", "headers": [ { "name": "authorization", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "folioId", "value": "", "type": "path", "description": "Unique ID of the folio" } ] }, "docs": "API to create Customer Factura Vat Folio from a Rachunek Folio.OperationId:postCustomerVatFolio
" }, { "info": { "name": "Create Fiscal Invoice", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/folio/:folioId/fiscalCommands", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "folioId", "value": "", "type": "path", "description": "Unique ID of the folio." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to create Fiscal Invoice.This API is deprecated. Please use postFiscalCommandInvoice instead
OperationId:postFiscalInvoice
" }, { "info": { "name": "Get folio history", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/folioHistory", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "id", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "type", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)." }, { "name": "aR", "value": "", "type": "query", "description": "Indicates if search includes AR Folios." }, { "name": "checkOut", "value": "", "type": "query", "description": "Indicates if search includes Check Out Folios." }, { "name": "creditBill", "value": "", "type": "query", "description": "Indicates if search includes Credit Bill Folios." }, { "name": "supplementalFolio", "value": "", "type": "query", "description": "Indicates if search includes Debit Bill Folios." }, { "name": "includeAssociatedFolios", "value": "", "type": "query", "description": "Indicates if search result includes Associated Bills and is only applied when Folio History for a particular reservation (i.e. ReservationID has a value) is requested." }, { "name": "noShow", "value": "", "type": "query", "description": "Indicates if search includes No Show Folios." }, { "name": "offlineFolio", "value": "", "type": "query", "description": "Indicates if search includes Offline Folios." }, { "name": "passerBy", "value": "", "type": "query", "description": "Indicates if search includes Passer By Folios." }, { "name": "postIt", "value": "", "type": "query", "description": "Indicates if search includes Post-It Folios." }, { "name": "videoCheckOut", "value": "", "type": "query", "description": "Indicates if search includes Video Check Out Folios." }, { "name": "folioDate", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "folioEndDate", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "reservationIdId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "reservationIdIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "reservationIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)." }, { "name": "room", "value": "", "type": "query", "description": "Room Number to which this record applies." }, { "name": "name", "value": "", "type": "query", "description": "Family name, last name or Company Name." }, { "name": "firstName", "value": "", "type": "query", "description": "Given name, first name or names." }, { "name": "creditCardNo", "value": "", "type": "query", "description": "Credit card number used." }, { "name": "folioNo", "value": "", "type": "query", "description": "Folio Number." }, { "name": "invoiceNo", "value": "", "type": "query", "description": "Invoice Number." }, { "name": "addresseeName", "value": "", "type": "query", "description": "Addressee Name filter. Works with the Addressee Functionality." }, { "name": "fiscalFolioNo", "value": "", "type": "query", "description": "Fiscal Folio Number filter. Works with the Fiscal Folio Number Functionality." }, { "name": "code", "value": "", "type": "query" }, { "name": "partnerFiscalFolioStatusCode", "value": "", "type": "query" }, { "name": "customNumber", "value": "", "type": "query", "description": "Custom number" }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned." } ] }, "docs": "You can use this API to get folio history for a reservation.OperationId:getFolioHistory
" }, { "info": { "name": "Get folio history", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/folioHistory/searches", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to get folio history for a reservation.OperationId:searchFolioHistory
" }, { "info": { "name": "Get folio printers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/folioPrinters", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "allFolioWindow", "value": "", "type": "query", "description": "Flag to decide if folios is to be generated for all windows in addition to the one requested with applicable postings and zero balance. If any of the windows have non-zero balance then folios are not generated for other windows." }, { "name": "correction", "value": "", "type": "query", "description": "Correction flag" }, { "name": "debitFolio", "value": "", "type": "query", "description": "Indicates the type of folio to be generated" }, { "name": "folioWindowNo", "value": "", "type": "query" }, { "name": "manualFolioNo", "value": "", "type": "query", "description": "Manual Folio Number used for settlement during checkout" }, { "name": "cashierId", "value": "", "type": "query", "description": "The Cashier ID of the Cashier who is currently processing the transaction(s)." }, { "name": "fiscalTerminalId", "value": "", "type": "query", "description": "Applicable for Fiscal Terminal. The ID of the terminal where the fiscal device is connected." }, { "name": "eventType", "value": "", "type": "query", "description": "Event being generated by a Supplemental Folio." }, { "name": "id", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "profileIdId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "currencyCode", "value": "", "type": "query", "description": "Description of currency Code." }, { "name": "exchangeRate", "value": "", "type": "query", "description": "Description of exchange rate." }, { "name": "associatedBillNumber", "value": "", "type": "query", "description": "The bill number of the original bill for which the Credit Bill is being generated." }, { "name": "associatedBillFolioType", "value": "", "type": "query", "description": "The folio type of the original bill for which the Credit Bill is being generated." }, { "name": "associatedBillQueueName", "value": "", "type": "query", "description": "The folio number queue(used in certain countries) of the original bill for which the Credit Bill is being generated." }, { "name": "associatedBillFiscalBillNumber", "value": "", "type": "query", "description": "The Fiscal Folio Bill Number(from a Fiscal System) of the original bill for which the Credit Bill is being generated." }, { "name": "associatedBillGenerationDate", "value": "", "type": "query", "description": "The bill generation date of the original bill for which the Credit Bill is being generated." }, { "name": "folioType", "value": "", "type": "query", "description": "Folio Type to be assigned to generated folio. This is a country requirement." }, { "name": "generateFiscalFolio", "value": "", "type": "query", "description": "Fiscal folio flag to call fiscal folio web service after folio generation." }, { "name": "queueName", "value": "", "type": "query", "description": "Folio Queue name." }, { "name": "folioSeqId", "value": "", "type": "query", "description": "Fiscal Folio sequence ID stored in queue table." }, { "name": "fiscalFolioInstruction", "value": "", "type": "query", "description": "Action to generate Offline folio when no response is received from fiscal service." }, { "name": "transactionServiceType", "value": "", "type": "query", "description": "Contains transaction service type." }, { "name": "amount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "balanceCurrencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." } ] }, "docs": "You can use this API to get folio printers.OperationId:getFolioPrinters
" }, { "info": { "name": "Get Folio Type Name", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/folioTypeNames", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "internalFolioWindowId", "value": "", "type": "query", "description": "The internal folio window Id for the reservation to determine the guest language details." }, { "name": "languageCode", "value": "", "type": "query", "description": "The Filter language code which will be used to retrieve the report name set for this language." }, { "name": "folioTypeName", "value": "", "type": "query", "description": "The Folio Type for which the details are requested." }, { "name": "folioReportGroup", "value": "", "type": "query", "description": "The Folio Report Group name. The folio report will be defined under each group and based on where the folio has to be printed, Opera will pick up the correct folio report name to print." } ] }, "docs": "You can use this API to get Folio Type Name.OperationId:getFolioTypeName
" }, { "info": { "name": "Get Folio Types", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/folioTypes", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "includeCompress", "value": "", "type": "query", "description": "Folio to be use for compress bills." }, { "name": "includeCredit", "value": "", "type": "query", "description": "Folio to be use for credit bills." }, { "name": "folioType", "value": "", "type": "query", "description": "Folio Type." } ] }, "docs": "You can use this API to get Folio Types.OperationId:getFolioTypes
" }, { "info": { "name": "Process Fiscal retry", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/folios/:folioId/fiscal", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "folioId", "value": "", "type": "path", "description": "Unique ID of the folio." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to process fiscal retry status.OperationId:processFiscalRetry
" }, { "info": { "name": "Create passer by sale", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/passerBySale", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to create passer by sale.OperationId:postPasserBySale
" }, { "info": { "name": "Change Payee Tax Number", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/payees/:payeeId/taxNumber", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "payeeId", "value": "", "type": "path", "description": "Unique ID of the payee" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to change Payee Tax Number.OperationId:putPayeeTaxNumber
" }, { "info": { "name": "Attach Deposit Policy to Payment", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/policies/:policyId/transactions/:transactionId/deposit", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "transactionId", "value": "", "type": "path", "description": "Unique ID of the transaction" }, { "name": "policyId", "value": "", "type": "path", "description": "Unique ID of the policy" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to attach Deposit Policy to Payment.OperationId:attachDepositPolicyToPayment
" }, { "info": { "name": "Get Posting Summary", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/postingDates/date/postingSummary", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "includeGenerates", "value": "", "type": "query", "description": "Configuring this flag to be TRUE will return transactions that are auto generated like taxes." }, { "name": "postingDate", "value": "", "type": "query", "description": "The date on which the charge is posted." }, { "name": "checkPostings", "value": "", "type": "query", "description": "When set to true,the summary of only the postings using checks will be fetched." }, { "name": "postingsByExternalSystem", "value": "", "type": "query", "description": "When set to true,the summary of only the postings done by external systems will be fetched." }, { "name": "cashierId", "value": "", "type": "query", "description": "Cashier Id of the Cashier." }, { "name": "currency", "value": "", "type": "query", "description": "Currency in which the postings are done. If null,amounts posted in local currency will be fetched." }, { "name": "postingSummaryType", "value": "", "type": "query", "description": "Enumeration Type of Posting Summary Information." } ] }, "docs": "You can use this API to get posting Summary.OperationId:getPostingSummary
" }, { "info": { "name": "Create Prepaid Cards", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/prepaidCards", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to create Prepaid Cards.OperationId:postPrepaidCards
" }, { "info": { "name": "Operation to activate prepaid card.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/prepaidCards/activate", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to activate Prepaid Card.OperationId:activatePrepaidCard
" }, { "info": { "name": "Operation to cancel prepaid card transaction.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/prepaidCards/cancel", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to cancel PrepaidCard Transaction.OperationId:cancelPrepaidCardTransaction
" }, { "info": { "name": "Operation to cash out prepaid card.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/prepaidCards/cashOut", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to cashOut Prepaid Card.OperationId:cashOutPrepaidCard
" }, { "info": { "name": "Operation to reload prepaid card.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/prepaidCards/reload", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to reload Prepaid Card.OperationId:reloadPrepaidCard
" }, { "info": { "name": "credit card wallet", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/profiles/:profileId/creditCardWallet", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "profileId", "value": "", "type": "path", "description": "Unique ID of the profile" } ] }, "docs": "This API is used to fetch the credit card wallet from the specified hotel and profile.OperationId: getHotelCreditCardWallet
" }, { "info": { "name": "Delete Credit Cards from Wallet", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/profiles/:profileId/creditCardWallet", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "profileId", "value": "", "type": "path", "description": "Unique ID of the profile" }, { "name": "creditCardId", "value": "", "type": "query", "description": "List of credit card IDs to delete from the wallet" } ] }, "docs": "This API is used to delete credit cards from a wallet for the specified hotel and profile.OperationId: deleteCreditCardsFromProfileWallet
" }, { "info": { "name": "Authorize Credit Card Amount by Profile", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/profiles/:profileId/paymentMethods/creditCard/authorize", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path", "description": "Unique ID of the profile" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to authorize Credit Card Amount by Profile.OperationId:authorizeCreditCardAmountByProfile
" }, { "info": { "name": "Get CC Authorization Instructions By Profile", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/profiles/:profileId/paymentMethods/creditCard/authorizeInstructions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path", "description": "Unique ID of the profile" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to get Credit Card Authorization Instructions by Profile.OperationId:postCCAuthorizationInstructionsByProfile
" }, { "info": { "name": "Get Receipt History", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/receiptHistory", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "fromDate", "value": "", "type": "query", "description": "Receipt History Date Range(from)." }, { "name": "toDate", "value": "", "type": "query", "description": "Receipt History Date Range(to)." }, { "name": "name", "value": "", "type": "query", "description": "Family name, last name or Company Name." }, { "name": "firstName", "value": "", "type": "query", "description": "Given name, first name or names." }, { "name": "receiptTypeName", "value": "", "type": "query", "description": "Receipt Type." }, { "name": "taxInvoice", "value": "", "type": "query", "description": "Tax Invoice Number." }, { "name": "receiptNo", "value": "", "type": "query", "description": "Receipt Number." }, { "name": "customNumber", "value": "", "type": "query", "description": "Custom number" } ] }, "docs": "You can use this API to get Receipt History.OperationId:getReceiptHistory
This API allows a time span of 30 days.
" }, { "info": { "name": "Get Receipt History", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/receiptHistory/searches", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to get Receipt History.OperationId:searchReceiptHistory
This API allows a time span of 30 days.
" }, { "info": { "name": "Create rate codes", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservation/:reservationId/rateCode/:rateCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "rateCode", "value": "", "type": "path", "description": "The Rate Code which is to be posted on the Guest Folio." }, { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to create rate codes.OperationId:postRateCode
" }, { "info": { "name": "Change posted rate codes", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservation/:reservationId/rateCode/:rateCode/action/validate", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "rateCode", "value": "", "type": "path", "description": "The Rate Code which is to be posted on the Guest Folio." }, { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to change posted rate codes.OperationId:checkPostRateCode
" }, { "info": { "name": "Create Billing Charges in Batch", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/billingCharges", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to create Billing Charges in Batch.OperationId:postBillingChargesInBatch
" }, { "info": { "name": "Get batch CC Settlements", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/cCSettlements", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "offlineSettlement", "value": "", "type": "query", "description": "fetch only offline settlements." }, { "name": "transactionDate", "value": "", "type": "query", "description": "Transaction Date associated with the transaction." }, { "name": "guestName", "value": "", "type": "query", "description": "Guest name associated with the transaction." }, { "name": "roomId", "value": "", "type": "query", "description": "Room number associated with the transaction." } ] }, "docs": "You can use this API to get batch CC Settlements.OperationId:getBatchCCSettlements
" }, { "info": { "name": "Get the list of vouchers generated from a list of reservations.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/vouchers", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "guestId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." } ] }, "docs": "This API is used to fetch the list of vouchers from a list of reservations.OperationId:getReservationsVouchers
" }, { "info": { "name": "Get additional Taxes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/additionalTaxes", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "type", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)." }, { "name": "folioView", "value": "", "type": "query", "description": "Folio Window." }, { "name": "currencyCode", "value": "", "type": "query", "description": "Currency code on which tax is to be calculated" } ] }, "docs": "You can use this API to get Additional Taxes.OperationId:getAdditionalTaxes
" }, { "info": { "name": "Get advance payment balance", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/advancePaymentBalance", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "type", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)." }, { "name": "fromDate", "value": "", "type": "query", "description": "From date of reservation." }, { "name": "numberOfNights", "value": "", "type": "query", "description": "Number of nights to calculate advance payment." }, { "name": "eventType", "value": "", "type": "query", "description": "Event to which this process will be logged." } ] }, "docs": "You can use this API to get advance payment balance.OperationId:getAdvancePaymentBalance
" }, { "info": { "name": "Create advance Room Charges", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/advanceRoomCharges", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to create advance Room Charges.OperationId:postAdvanceRoomCharges
" }, { "info": { "name": "Delete Advance Folio Transactions", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/advanceRoomCharges", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "cashierId", "value": "", "type": "query", "description": "The Cashier ID of the Cashier who is currently processing the transaction(s)." } ] }, "docs": "You can use this API to reverse the Advance Folio Transactions on a reservation. As part of reversal, the actual charges may not be deleted but only an offset will be posted.OperationId:reverseAdvanceFolio
" }, { "info": { "name": "Get Alert Notices", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/alerts", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique OPERA reservation ID which is used to find reservation from OPERA. This ID is a primary identification of a reservation in OPERA." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "alertArea", "value": "", "type": "query" } ] }, "docs": "You can use this API to get Alert Notices.This API is deprecated.
OperationId:getAlerts
" }, { "info": { "name": "Get authorization history", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/authorizationHistory", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "type", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)." }, { "name": "includeAuthorizations", "value": "", "type": "query", "description": "A flag which indicates whether authorizations should be included in the returned list." }, { "name": "includePayments", "value": "", "type": "query", "description": "A flag which indicates whether payments should be included in the returned list." }, { "name": "includeRefunds", "value": "", "type": "query", "description": "A flag which indicates whether refunds should be included in the returned list." }, { "name": "includeFailures", "value": "", "type": "query", "description": "A flag which indicates whether failures should be included in the returned list." }, { "name": "folioView", "value": "", "type": "query" }, { "name": "transactionType", "value": "", "type": "query", "description": "Currently supported transaction type categories used for credit card authorization." } ] }, "docs": "You can use this API to get authorization history.OperationId:getAuthorizationHistory
" }, { "info": { "name": "Get Billing Charges", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/charges", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "cashierId", "value": "", "type": "query", "description": "The Cashier ID of the Cashier who is currently processing the transaction(s)." }, { "name": "folioWindowNo", "value": "", "type": "query" }, { "name": "chargeCashierId", "value": "", "type": "query", "description": "The Cashier ID of the Cashier who is currently processing the transaction(s)." }, { "name": "transactionCode", "value": "", "type": "query", "description": "Transaction Code to post." }, { "name": "articleCode", "value": "", "type": "query", "description": "Article ID." }, { "name": "amount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "currencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "postingQuantity", "value": "", "type": "query", "description": "Quantity to post to the folio." }, { "name": "postingReference", "value": "", "type": "query", "description": "User-defined posting reference." }, { "name": "postingRemark", "value": "", "type": "query", "description": "User-defined posting remark." }, { "name": "checkNumber", "value": "", "type": "query", "description": "Indicates the Cheque number." }, { "name": "arrangementCode", "value": "", "type": "query", "description": "Corrected arrangement code from the package associated to this transaction." }, { "name": "applyRoutingInstructions", "value": "", "type": "query", "description": "Apply room routing when making this posting." }, { "name": "usePackageAllowance", "value": "", "type": "query", "description": "Use the applicable package allowance when making this posting." }, { "name": "autoPosting", "value": "", "type": "query", "description": "True indicates the Transaction Code is allowed to be posted automatically." }, { "name": "id", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "type", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)." }, { "name": "reservationIdIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "reservationIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)." }, { "name": "option", "value": "", "type": "query", "description": "This is the Default option. Operation checks if charges can be posted to the reservation based on the status of the reservation." } ] }, "docs": "You can use this API to get post Billing Charges.OperationId:getPostBillingCharges
" }, { "info": { "name": "Post Charge to a folio", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/charges", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to post a charge to a folio window.OperationId:postBillingCharges
" }, { "info": { "name": "Post charges and payments on a reservation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/chargesAndPayments", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation." } ] }, "docs": "You can use this API to post charges and payments on a reservation.This operation can be used to enforce Payment for additional charges posted on the reservationOperationId:postChargesAndPayments
" }, { "info": { "name": "Pre-validate the Billing Charge", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/check/:checkNumber/charges", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "checkNumber", "value": "", "type": "path", "description": "Unique number of the check." }, { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to validate the posting prior to posting the charge to the folioOperationId:postBillingCheckCharges
" }, { "info": { "name": "Check out a guest", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/checkOuts", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "This API enables you to check out a guest reservation which is in due out status, with options to update the room's housekeeping status and set a flag to email the guests folio.OperationId:postCheckOut
" }, { "info": { "name": "Reinstate Checked Out Reservation", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/checkOuts/reinstate", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to reinstate Checked Out Reservation.OperationId:reinstateCheckOut
" }, { "info": { "name": "Operation to auto settle comp folios.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/comp/folios/autoSettlements", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to auto Settle CompFoliosOperationId:autoSettleCompFolios
" }, { "info": { "name": "Operation to post complimentary bucket redemptions for a guest having PTS Membership Type", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/compRedemptionPostings", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to post complimentary bucket redemptions for a guest having PTS Membership TypeOperationId:postCompRedemptions
" }, { "info": { "name": "Operation to reverse complimentary bucket redemptions for a guest having PTS Membership Type", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/compRedemptionReversals", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to reverse complimentary bucket redemptions for a guest having PTS Membership TypeOperationId:reverseCompRedemptions
" }, { "info": { "name": "Create Deposit Payment or Deposit Folio", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/compositeDeposit", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to create either Deposit Payment or Deposit Folio.OperationId:postCompositeDeposit
" }, { "info": { "name": "Credit Card Wallet", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/creditCardWallet", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "profileId", "value": "", "type": "query", "description": "Unique ID of the profile" } ] }, "docs": "This API is used to fetch the credit card wallet from the specified hotel and reservation.OperationId: getReservationCreditCardWallet
" }, { "info": { "name": "Delete Credit Cards from Wallet", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/creditCardWallet", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "profileId", "value": "", "type": "query", "description": "Unique ID of the profile" }, { "name": "creditCardId", "value": "", "type": "query", "description": "List of credit card IDs to delete from the wallet" } ] }, "docs": "This API is used to delete credit cards from a wallet for the specified hotel and reservation.OperationId: deleteCreditCardsFromReservationWallet
" }, { "info": { "name": "Request to submit a job to post the deferred taxes.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/deferredTaxesProcess", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "Request to submit a job to post the deferred taxes.OperationId:postDeferredTaxesProcess
" }, { "info": { "name": "Process Reservations deposit", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/deposit", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to Process reservations deposit.OperationId:processReservationDeposit
" }, { "info": { "name": "Deposit Credit Bill", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/depositCreditBill", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to post Deposit Credit Bill.OperationId:postDepositCreditBill
" }, { "info": { "name": "Create Deposit Folio", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/depositFolios", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to create Deposit Folio.OperationId:postDepositFolio
" }, { "info": { "name": "Get Deposit Maturity Information", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/depositMaturity", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "cashierId", "value": "", "type": "query", "description": "The Cashier ID of the Cashier who is currently processing the transaction(s)." }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "type", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)." } ] }, "docs": "You can use this API to get Deposit Maturity Information.OperationId:getDepositMaturityInfo
" }, { "info": { "name": "Get matured deposits", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/depositPayments", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to fetch matured deposits.OperationId:getMaturedDeposits
" }, { "info": { "name": "Create Deposit Payment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/depositPayments", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to create Deposit Payment.OperationId:postDepositPayment
" }, { "info": { "name": "Transition Deposit to Guest Folio", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/depositTransition", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to Transfer Deposit to Guest Folio.OperationId:transitionDepositToGuestFolio
" }, { "info": { "name": "Change early Departure", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/earlyDeparture", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to change early Departure.OperationId:putForEarlyDeparture
" }, { "info": { "name": "Verify for early Departure", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/earlyDeparture/verify", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "ignoreCheckOnTieredRate", "value": "", "type": "query", "description": "Indicates if check has to be done for Rate Tiers." }, { "name": "ignoreRateRestriction", "value": "", "type": "query", "description": "Indicates if Rate Restriction check should be overridden." }, { "name": "postConsumedAllowanceToGuest", "value": "", "type": "query", "description": "Indicates if any allowance consumed by the guest for today can be posted to the Guest Folio. If this cannot be done then the Early Departure cannot proceed." }, { "name": "postEarlyDeparturePenalty", "value": "", "type": "query", "description": "Indicates if the early departure penalty should be posted ." }, { "name": "cashierId", "value": "", "type": "query", "description": "The Cashier ID of the Cashier who is currently processing the transaction(s)." }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "type", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)." } ] }, "docs": "You can use this API to verify early Departure.OperationId:verifyForEarlyDeparture
" }, { "info": { "name": "Get Eligible Bill Amount", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/eligibleBillAmount", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "folioView", "value": "", "type": "query", "description": "The folio window where this settlement is applied." } ] }, "docs": "Retrieves eligible bill amount in order to post redemption on a reservation folioOperationId:getEligibleBillAmount
" }, { "info": { "name": "Get fetchStagedTransactions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/fetchStagedTransactions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "hotelId", "value": "", "type": "query", "description": "Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X." }, { "name": "folioWindowNo", "value": "", "type": "query", "description": "Folio Window Number of the staged transactions." } ] }, "docs": "This API is used to fetch the staged transactions for a given reservation.OperationId:getfetchStagedTransactions
" }, { "info": { "name": "Apply final Postings", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/finalCharges", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to apply final postings on a reservation.OperationId:applyFinalPostings
" }, { "info": { "name": "Post fiscal Info", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/fiscalInfo", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" } ] }, "docs": "API to generate CHECK OUT payload for a reservation" }, { "info": { "name": "Get Fiscal Printing Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/fiscalPrinting", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "folioView", "value": "", "type": "query", "description": "The folio window where this settlement is applied." }, { "name": "folioType", "value": "", "type": "query", "description": "Folio Type" }, { "name": "id", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "code", "value": "", "type": "query" }, { "name": "fetchInstruction", "value": "", "type": "query", "description": "Reservation Related information." }, { "name": "profileIdId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." } ] }, "docs": "You can use this API to get Fiscal Printing Details.This API is deprecated. Please use getValidateFiscalPrintingDetails instead
OperationId:getFiscalPrintingDetails
" }, { "info": { "name": "Get Fixed Charges", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/fixedCharges", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "type", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)." } ] }, "docs": "You can use this API to get fixed Charges for a reservation.OperationId:getFixedCharges
" }, { "info": { "name": "Create Fixed Charges", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/fixedCharges", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to create a fixed Charge for a reservation.OperationId:postFixedCharges
" }, { "info": { "name": "Updates Fixed Charges ", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/fixedCharges", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to update fixed Charges for a reservation.OperationId:updateFixedCharges
" }, { "info": { "name": "Delete Fixed Charges ", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/fixedCharges", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "fixedChargeID", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." } ] }, "docs": "You can use this API to remove fixed Charges for a reservation.OperationId:removeFixedCharges
" }, { "info": { "name": "Apply flexible benefit postings", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/flexibleBenefitPostings", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to apply flexible benefit postings.OperationId:applyFlexibleBenefitPostings
" }, { "info": { "name": "Get folio tax payments information", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/folioTaxPayments", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "folioWindowNo", "value": "", "type": "query" }, { "name": "cashierId", "value": "", "type": "query", "description": "The Cashier ID of the Cashier who is currently processing the transaction(s)." }, { "name": "description", "value": "", "type": "query" }, { "name": "folioView", "value": "", "type": "query" }, { "name": "paymentMethod", "value": "", "type": "query" }, { "name": "track2Data", "value": "", "type": "query", "description": "Track2 data for the card which would be sent to the CC vendor as part of the authorization." }, { "name": "attachCreditCardToProfile", "value": "", "type": "query", "description": "Attach the credit card to profile." }, { "name": "cardHolderName", "value": "", "type": "query" }, { "name": "cardNumber", "value": "", "type": "query" }, { "name": "cardNumberLast4Digits", "value": "", "type": "query" }, { "name": "cardNumberMasked", "value": "", "type": "query" }, { "name": "cardOrToken", "value": "", "type": "query", "description": "Simple type for indicating if credit card number is tokenized." }, { "name": "cardType", "value": "", "type": "query", "description": "This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method." }, { "name": "expirationDate", "value": "", "type": "query", "description": "Expiration date of the credit card" }, { "name": "expirationDateExpired", "value": "", "type": "query" }, { "name": "expirationDateMasked", "value": "", "type": "query", "description": "Masked Expiration date of the credit card" }, { "name": "processing", "value": "", "type": "query" }, { "name": "swiped", "value": "", "type": "query" }, { "name": "userDefinedCardType", "value": "", "type": "query", "description": "Indicates the user defined credit card type if credit card type from a defined list is not provided" }, { "name": "id", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "type", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)." }, { "name": "amount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "currencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "approvalAmountNeededAmount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "approvalAmountNeededCurrencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "balanceAmount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "balanceCurrencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "code", "value": "", "type": "query", "description": "The authorization rule code." }, { "name": "amountAmount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "amountCurrencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "percent", "value": "", "type": "query", "description": "A percentage value if the authorization rule is percentage based." }, { "name": "emailFolio", "value": "", "type": "query" }, { "name": "uniqueIdId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "uniqueIdIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "uniqueIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)." }, { "name": "createDateTime", "value": "", "type": "query", "description": "Time stamp of the creation." }, { "name": "creatorId", "value": "", "type": "query", "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation." }, { "name": "emailAddress", "value": "", "type": "query", "description": "Defines the e-mail address." }, { "name": "emailFormat", "value": "", "type": "query", "description": "Supported Email format." }, { "name": "lastModifierId", "value": "", "type": "query", "description": "Identifies the last software system or person to modify a record." }, { "name": "lastModifyDateTime", "value": "", "type": "query", "description": "Time stamp of last modification." }, { "name": "orderSequence", "value": "", "type": "query", "description": "Display Order sequence." }, { "name": "primaryInd", "value": "", "type": "query", "description": "When true, indicates a primary information." }, { "name": "purgeDate", "value": "", "type": "query", "description": "Date an item will be purged from a database (e.g., from a live database to an archive)." }, { "name": "emailType", "value": "", "type": "query", "description": "Defines the purpose of the e-mail address (e.g. personal, business, listserve)." }, { "name": "typeDescription", "value": "", "type": "query", "description": "Describes the Type code" }, { "name": "approvalCode", "value": "", "type": "query", "description": "The approval code authenticates the authorization." }, { "name": "originalAuthSequence", "value": "", "type": "query", "description": "Unique Authorization Sequence for the authorization and settlement." }, { "name": "vendorTranId", "value": "", "type": "query", "description": "Vendor transaction id for the authorization." }, { "name": "alternateTransRef", "value": "", "type": "query", "description": "Alternate vendor transaction id for the authorization." }, { "name": "approvalAmountAmount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "approvalAmountCurrencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "postingAmountAmount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "postingAmountCurrencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "postingReference", "value": "", "type": "query", "description": "User-defined posting reference." }, { "name": "postingRemark", "value": "", "type": "query", "description": "User-defined posting remark." }, { "name": "comments", "value": "", "type": "query", "description": "User Defined Comments. Used for Deposit Payment postings." }, { "name": "applyCCSurcharge", "value": "", "type": "query", "description": "Flag to indicate if Credit Card Surcharge has to be applied to this payment, when the functionality for Credit Card Surcharge is available." }, { "name": "manualPaymentTaxInfoFolioWindowNo", "value": "", "type": "query" }, { "name": "transactionCode", "value": "", "type": "query", "description": "Billing Transaction Code of the Payment." }, { "name": "transactionDate", "value": "", "type": "query", "description": "Transaction Date of the Payment." }, { "name": "transactionDescription", "value": "", "type": "query", "description": "Billing Transaction Description." }, { "name": "transactionNo", "value": "", "type": "query", "description": "Unique Transaction Identifier." }, { "name": "taxInvoiceNo", "value": "", "type": "query", "description": "The Tax Invoice for this payment." }, { "name": "paymentType", "value": "", "type": "query", "description": "The types of Payment Tax transactions." }, { "name": "manualPaymentTaxAmount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "manualPaymentTaxCurrencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "taxableAmountAmount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "taxableAmountCurrencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "nonTaxableAmountAmount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "nonTaxableAmountCurrencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "availableCreditAmount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "availableCreditCurrencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "paymentDate", "value": "", "type": "query", "description": "The Payment Invoice date" }, { "name": "taxFolioWindowNo", "value": "", "type": "query" }, { "name": "taxTransactionCode", "value": "", "type": "query", "description": "Billing Transaction Code of the Payment." }, { "name": "taxTransactionDate", "value": "", "type": "query", "description": "Transaction Date of the Payment." }, { "name": "taxTransactionDescription", "value": "", "type": "query", "description": "Billing Transaction Description." }, { "name": "taxTransactionNo", "value": "", "type": "query", "description": "Unique Transaction Identifier." }, { "name": "taxTaxInvoiceNo", "value": "", "type": "query", "description": "The Tax Invoice for this payment." }, { "name": "taxPaymentType", "value": "", "type": "query", "description": "The types of Payment Tax transactions." }, { "name": "creditablePaymentTaxesAmount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "creditablePaymentTaxesCurrencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "creditablePaymentTaxableAmount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "creditablePaymentTaxableCurrencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "creditablePaymentNonTaxableAmount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "creditablePaymentNonTaxableCurrencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "availableTaxCreditAmount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "availableTaxCreditCurrencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "taxPaymentDate", "value": "", "type": "query", "description": "The Payment Invoice date" }, { "name": "terminalId", "value": "", "type": "query", "description": "Applicable for chip and pin. The ID of the terminal where the chip and pin device is connected and where the payment is made." }, { "name": "overrideInsufficientCC", "value": "", "type": "query", "description": "Flag to allow a rebate by Credit Card" }, { "name": "changeDueAmount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "changeDueAmountCurrencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "overrideARCreditLimit", "value": "", "type": "query", "description": "Flag to override account receivable credit limit" }, { "name": "applyCurrencyTaxes", "value": "", "type": "query", "description": "Flag to indidcate if currency taxes need to be applied or not. For ex, in case of Chile, it depends upon nationality of the guest." }, { "name": "vATOffset", "value": "", "type": "query", "description": "Flag to indidcate if currency taxes need to be applied or not. For ex, in case of Chile, it depends upon nationality of the guest." }, { "name": "action", "value": "", "type": "query", "description": "Payment action to know from where the payment has been made." }, { "name": "reservationIdIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "reservationIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)." }, { "name": "profileIdId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "profileIdIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "profileIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)." } ] }, "docs": "You can use this API to get folio tax payments information.OperationId:getFolioTaxPaymentsInfo
" }, { "info": { "name": "Get folios", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/folios", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "guestPayOnly", "value": "", "type": "query", "description": "Flag to return the Folio Windows information where the Reservation Guest is the Payee, i.e the Folio Window is not Routed to another Reservation or another Profile." }, { "name": "includeFolioHistory", "value": "", "type": "query", "description": "This flag will notify the service if the folio history will also be returned or not." }, { "name": "reservationBalanceOnly", "value": "", "type": "query", "description": "This flag will notify the service if the reservation summary information will be returned. If TRUE then we will only return the reservation's outstanding balance." }, { "name": "fetchInstructions", "value": "", "type": "query", "description": "Posting details of each window." }, { "name": "end", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "folioWindowNo", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned." }, { "name": "start", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "summaryOnly", "value": "", "type": "query", "description": "This flag will notify the service that transactional postings will not be returned." }, { "name": "groupType", "value": "", "type": "query", "description": "Grouping by Transactin Type." }, { "name": "exchangeCurrency", "value": "", "type": "query", "description": "Currency to which the Credit and Debit Amounts will be converted for each Folio. The response will have the ExchangeAmounts element with the converted amounts. The Posting Exchange Rate of the current business date will be used for the conversion" }, { "name": "calculateCollectingAgentTaxes", "value": "", "type": "query" }, { "name": "vATOffset", "value": "", "type": "query" }, { "name": "includeDepositTaxes", "value": "", "type": "query" }, { "name": "simpleFolio", "value": "", "type": "query", "description": "This flag signifies that generated Folio is Normal or Simple Folio. Certain countries of the World mandate a simple folio when the invoice amount is less than defined threshold." } ] }, "docs": "This API is used to fetch the folios for a given reservation. A guest reservation could have 1 or more folios per reservation. Folios will only exist for a reservation once the guest has checked into the hotel.OperationId:getFolio
This API allows a time span of 30 days.
" }, { "info": { "name": "Generate Folios", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/folios", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to generate folios for a reservation.OperationId:generateFolio
" }, { "info": { "name": "Close Reservation Folio", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/folios", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to close the Reservation Folio on a reservation.OperationId:closeReservationFolio
" }, { "info": { "name": "Post a membership award payment transaction.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/memberships/:membershipId/awardTransactions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel." }, { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation." }, { "name": "membershipId", "value": "", "type": "path", "description": "Membership number of the guest in the reservation." } ] }, "docs": "Creates a new membership award payment transaction.OperationId:postAwardTransaction
" }, { "info": { "name": "Unlink reservation package allowance", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/packageAllowance/links", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to unlink reservation package allowance.OperationId:unlinkReservationPackageAllowance
" }, { "info": { "name": "Get Reservation Package Options", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/packageOptions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to get Reservation Package Options.OperationId:getReservationPackageOptions
" }, { "info": { "name": "Authorize Credit Card Amount", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/paymentMethods/creditCard/authorize", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to authorize Credit Card Amount by Reservation.OperationId:authorizeCreditCardAmount
" }, { "info": { "name": "Register Manual Authorization", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/paymentMethods/creditCard/authorize/manual", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to register Manual Authorization.OperationId:registerManualAuthorization
" }, { "info": { "name": "Get CC Authorization Instructions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/paymentMethods/creditCard/authorizeInstructions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to get Credit Card Authorization Instructions by Reservation.OperationId:postCCAuthorizationInstructions
" }, { "info": { "name": "Create Billing Payment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/payments", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to create Billing Payment on the folio of a Reservation.OperationId:postBillingPayment
" }, { "info": { "name": "Get posting activity details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/postingActivities", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "type", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)." }, { "name": "module", "value": "", "type": "query" }, { "name": "logDate", "value": "", "type": "query" }, { "name": "refActionId", "value": "", "type": "query" }, { "name": "logUserId", "value": "", "type": "query" }, { "name": "logUserName", "value": "", "type": "query" }, { "name": "machineStation", "value": "", "type": "query" }, { "name": "croCode", "value": "", "type": "query" }, { "name": "actionType", "value": "", "type": "query" }, { "name": "actionDescription", "value": "", "type": "query" }, { "name": "iPAddress", "value": "", "type": "query", "description": "The IP Address of the machine that performed the activity" } ] }, "docs": "You can use this API to get posting activity details.OperationId:getPostingActivityDetail
" }, { "info": { "name": "Operation to redeem prepaid cards.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/prepaidCards/redemptions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to redeem Prepaid CardsOperationId:redeemPrepaidCards
" }, { "info": { "name": "Create proforma", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/proforma", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to create proforma for a specific reservation.OperationId:postProforma
" }, { "info": { "name": "Create proforma", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/proformaFolio", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "API to create Pro-Forma for a specific reservation for external partners.OperationId:postProformaFolio
OperationId:postProformaFolio
" }, { "info": { "name": "Get Reservations Revenue Bucket Totals", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/revenueBuckets", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "type", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)." }, { "name": "revenueBucketType", "value": "", "type": "query", "description": "Type if the revenue bucket." }, { "name": "compRevenue", "value": "", "type": "query", "description": "This flag will notify the service if the revenue is of complimentary type." } ] }, "docs": "You can use this API to get a reservations Revenue Bucket Totals.OperationId:getReservationRevenueBucketTotals
" }, { "info": { "name": "Reverse certificate postings", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/reverseCertificate", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to Reverse certificate postings.OperationId:reverseCertificatePostings
" }, { "info": { "name": "Get routing instructions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/routingInstructions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "includeWindowRouting", "value": "", "type": "query", "description": "Include the window routing instructions to the response." }, { "name": "includeRoomRouting", "value": "", "type": "query", "description": "Include the room routing instructions in the response." }, { "name": "includeCompRouting", "value": "", "type": "query", "description": "Include the comp routing instructions in the response." }, { "name": "includeCompRoutingRequests", "value": "", "type": "query", "description": "Include the comp routing requests in the response." }, { "name": "effectiveOn", "value": "", "type": "query", "description": "If date is included then the search result should only be valid for dates which includes this date." } ] }, "docs": "You can use this API to retrieve routing instructions for a specified reservation.OperationId:getRoutingInstructions
The maximum allowable limit for this API is 20.
" }, { "info": { "name": "Delete routing instructions", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/routingInstructions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to delete routing instructions for a specified reservation.This API is deprecated. Please use deleteFolioRoutingInstructions or deleteRoomRoutingInstructions or deleteCompRoutingInstructions or deleteRequestRoutingInstructions instead
OperationId:deleteRoutingInstructions
" }, { "info": { "name": "Change routing instructions", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/routingInstructions/change", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to update routing instructions for a specified reservation.OperationId:changeRoutingInstructions
" }, { "info": { "name": "Delete comp routing instructions", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/routingInstructions/comp", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "refreshFolio", "value": "", "type": "query", "description": "On a successful update, the transactions that are already posted in the guest's folio will be re-organized based on the configured instructions." }, { "name": "retrievePostingsForRoomRouting", "value": "", "type": "query", "description": "This flag indicates if postings that can be refreshed need to be part of the response when a routing instruction is created, updated or deleted." }, { "name": "folioWindowNo", "value": "", "type": "query" }, { "name": "payeeId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "membershipIdNo", "value": "", "type": "query", "description": "Unique Id of membership" }, { "name": "authorizerId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "userId", "value": "", "type": "query", "description": "User Id of the Opera User" }, { "name": "userName", "value": "", "type": "query", "description": "Name of the Opera User" }, { "name": "comments", "value": "", "type": "query" }, { "name": "daily", "value": "", "type": "query", "description": "Flag to indicate if the routing instruction is a daily instruction." }, { "name": "sunday", "value": "", "type": "query" }, { "name": "monday", "value": "", "type": "query" }, { "name": "tuesday", "value": "", "type": "query" }, { "name": "wednesday", "value": "", "type": "query" }, { "name": "thursday", "value": "", "type": "query" }, { "name": "friday", "value": "", "type": "query" }, { "name": "saturday", "value": "", "type": "query" }, { "name": "startDate", "value": "", "type": "query" }, { "name": "endDate", "value": "", "type": "query" }, { "name": "creditLimit", "value": "", "type": "query", "description": "Allowable credit amount for this routing instruction. Null value means no limit, 0 equals zero." }, { "name": "percentageLimit", "value": "", "type": "query", "description": "The routing limit percentage allowed for this routing instruction." }, { "name": "covers", "value": "", "type": "query", "description": "Number of covers for this routing instruction." }, { "name": "transactionCode", "value": "", "type": "query", "description": "Unique identifier for the Transaction code." }, { "name": "billingCode", "value": "", "type": "query", "description": "Unique identifier for the Billing Instruction." }, { "name": "routingInstructionsId", "value": "", "type": "query", "description": "This is the Routing Instruction Id attached with Reservation. It is only used for internal purpose. It should not be used by external vendor or consumer." }, { "name": "routingLinkId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." } ] }, "docs": "You can use this API to delete comp routing instructions for a specified reservation.OperationId:deleteCompRoutingInstructions
" }, { "info": { "name": "Create routing instructions", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/routingInstructions/create", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to add routing instructions to a reservation.OperationId:putRoutingInstructions
" }, { "info": { "name": "Delete Folio routing instructions", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/routingInstructions/folio", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "refreshFolio", "value": "", "type": "query", "description": "On a successful update, the transactions that are already posted in the guest's folio will be re-organized based on the configured instructions." }, { "name": "retrievePostingsForRoomRouting", "value": "", "type": "query", "description": "This flag indicates if postings that can be refreshed need to be part of the response when a routing instruction is created, updated or deleted." }, { "name": "folioWindowNo", "value": "", "type": "query" }, { "name": "payeeId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "daily", "value": "", "type": "query", "description": "Flag to indicate if the routing instruction is a daily instruction." }, { "name": "sunday", "value": "", "type": "query" }, { "name": "monday", "value": "", "type": "query" }, { "name": "tuesday", "value": "", "type": "query" }, { "name": "wednesday", "value": "", "type": "query" }, { "name": "thursday", "value": "", "type": "query" }, { "name": "friday", "value": "", "type": "query" }, { "name": "saturday", "value": "", "type": "query" }, { "name": "startDate", "value": "", "type": "query" }, { "name": "endDate", "value": "", "type": "query" }, { "name": "creditLimit", "value": "", "type": "query", "description": "Allowable credit amount for this routing instruction. Null value means no limit, 0 equals zero." }, { "name": "percentageLimit", "value": "", "type": "query", "description": "The routing limit percentage allowed for this routing instruction." }, { "name": "covers", "value": "", "type": "query", "description": "Number of covers for this routing instruction." }, { "name": "transactionCode", "value": "", "type": "query", "description": "Unique identifier for the Transaction code." }, { "name": "billingCode", "value": "", "type": "query", "description": "Unique identifier for the Billing Instruction." }, { "name": "routingInstructionsId", "value": "", "type": "query", "description": "This is the Routing Instruction Id attached with Reservation. It is only used for internal purpose. It should not be used by external vendor or consumer." }, { "name": "routingLinkId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." } ] }, "docs": "You can use this API to delete folio routing instructions for a specified reservation.OperationId:deleteFolioRoutingInstructions
" }, { "info": { "name": "Delete request routing instructions", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/routingInstructions/request", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "refreshFolio", "value": "", "type": "query", "description": "On a successful update, the transactions that are already posted in the guest's folio will be re-organized based on the configured instructions." }, { "name": "retrievePostingsForRoomRouting", "value": "", "type": "query", "description": "This flag indicates if postings that can be refreshed need to be part of the response when a routing instruction is created, updated or deleted." }, { "name": "userName", "value": "", "type": "query", "description": "Name of the Opera User" }, { "name": "comments", "value": "", "type": "query" }, { "name": "daily", "value": "", "type": "query", "description": "Flag to indicate if the routing instruction is a daily instruction." }, { "name": "sunday", "value": "", "type": "query" }, { "name": "monday", "value": "", "type": "query" }, { "name": "tuesday", "value": "", "type": "query" }, { "name": "wednesday", "value": "", "type": "query" }, { "name": "thursday", "value": "", "type": "query" }, { "name": "friday", "value": "", "type": "query" }, { "name": "saturday", "value": "", "type": "query" }, { "name": "startDate", "value": "", "type": "query" }, { "name": "endDate", "value": "", "type": "query" } ] }, "docs": "You can use this API to delete request routing instructions for a specified reservation.OperationId:deleteRequestRoutingInstructions
" }, { "info": { "name": "Delete Room routing instructions", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/routingInstructions/room", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "refreshFolio", "value": "", "type": "query", "description": "On a successful update, the transactions that are already posted in the guest's folio will be re-organized based on the configured instructions." }, { "name": "retrievePostingsForRoomRouting", "value": "", "type": "query", "description": "This flag indicates if postings that can be refreshed need to be part of the response when a routing instruction is created, updated or deleted." }, { "name": "reservationNameId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "daily", "value": "", "type": "query", "description": "Flag to indicate if the routing instruction is a daily instruction." }, { "name": "sunday", "value": "", "type": "query" }, { "name": "monday", "value": "", "type": "query" }, { "name": "tuesday", "value": "", "type": "query" }, { "name": "wednesday", "value": "", "type": "query" }, { "name": "thursday", "value": "", "type": "query" }, { "name": "friday", "value": "", "type": "query" }, { "name": "saturday", "value": "", "type": "query" }, { "name": "startDate", "value": "", "type": "query" }, { "name": "endDate", "value": "", "type": "query" }, { "name": "creditLimit", "value": "", "type": "query", "description": "Allowable credit amount for this routing instruction. Null value means no limit, 0 equals zero." }, { "name": "percentageLimit", "value": "", "type": "query", "description": "The routing limit percentage allowed for this routing instruction." }, { "name": "covers", "value": "", "type": "query", "description": "Number of covers for this routing instruction." }, { "name": "transactionCode", "value": "", "type": "query", "description": "Unique identifier for the Transaction code." }, { "name": "billingCode", "value": "", "type": "query", "description": "Unique identifier for the Billing Instruction." }, { "name": "routingInstructionsId", "value": "", "type": "query", "description": "This is the Routing Instruction Id attached with Reservation. It is only used for internal purpose. It should not be used by external vendor or consumer." }, { "name": "routingLinkId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." } ] }, "docs": "You can use this API to delete room routing instructions for a specified reservation.OperationId:deleteRoomRoutingInstructions
" }, { "info": { "name": "Delete transactions for specific reservation on current business day", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/transactions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" } ] }, "docs": "This operation deletes transactions for the specified reservation that occurred on the current business day. Only transactions posted on the current business date are eligible. Filtering by specific transaction numbers and providing a valid deletion reason code are required. The response includes processing status and any warnings or errors." }, { "info": { "name": "Get eligibility of Deposit Refund", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/transactions/:transactionId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "transactionId", "value": "", "type": "path", "description": "Unique ID of the transaction" }, { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "type", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)." } ] }, "docs": "You can use this API to get eligibility of Deposit Refund.OperationId:isDepositRefundEligible
" }, { "info": { "name": "Split deposit transaction", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/transactions/:transactionId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "transactionId", "value": "", "type": "path", "description": "Unique ID of the transaction" }, { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to Split deposit transaction.OperationId:splitDepositTransaction
" }, { "info": { "name": "Transfer Folio to Window.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/transferFolioTransactions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to transfer Folio to Window.OperationId:transferFolioToWindow
" }, { "info": { "name": "Transfer Transaction to Window", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/transferTransactions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to transfer Transaction to Window.OperationId:transferTransactionToWindow
" }, { "info": { "name": "Void folio", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/voidfolios/:folioId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "folioId", "value": "", "type": "path", "description": "Unique ID of the folio." }, { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to void a folio.OperationId:voidFolio
" }, { "info": { "name": "Get the list of vouchers generated for a reservation.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/vouchers", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "This API is used to fetch the list of vouchers from a reservation.OperationId:getReservationVouchers
" }, { "info": { "name": "Generate Reservation Vouchers", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/vouchers", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "Generate vouchers for the reservation.OperationId:postReservationVouchers
" }, { "info": { "name": "Get Comp Transaction Authorizers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:resvNameId/compTransactionAuthorizers", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "resvNameId", "value": "", "type": "path", "description": "Reservation id of the transactions to be transferrred to other window." }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier." }, { "name": "type", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "targetFolioWindowId", "value": "", "type": "query", "description": "Folio Window Number to where transactions will be transfered." }, { "name": "transactionId", "value": "", "type": "query", "description": "List of transactions that are associated to the authorizer." }, { "name": "authorizerId", "value": "", "type": "query", "description": "A unique identifying value assigned for authorizer." }, { "name": "authorizerName", "value": "", "type": "query", "description": "A name of the authorizer." }, { "name": "transactionCodeList", "value": "", "type": "query", "description": "List of Transaction code that are associated to the authorizer." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned." } ] }, "docs": "You can use this API to get Comp Transaction Authorizers.OperationId:getCompTrxAuthorizers
" }, { "info": { "name": "Change Reservation Deposit Transfer.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:sourceReservationId/deposit/transfers", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "sourceReservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to change Reservation Deposit Transfer.OperationId:putReservationDepositTransfer
" }, { "info": { "name": "Transfer Transaction to Reservation", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:toReservationId/transferTransaction", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "toReservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to Transfer Transaction to Reservation.OperationId:transferTransactionToReservation
" }, { "info": { "name": "Get Hotel Revenue", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/revenue", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "businessDate", "value": "", "type": "query", "description": "Business date." } ] }, "docs": "You can use this API to get Hotel Revenue.OperationId:getHotelRevenue
" }, { "info": { "name": "Get Billing (routing) Instruction Codes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/routingInstructionCodes", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "includeTransactionCodes", "value": "", "type": "query", "description": "Flag to include the search in the Transaction Codes." }, { "name": "includeBillingInstructions", "value": "", "type": "query", "description": "Flag to include the search in the Billing Instructions." }, { "name": "includeCompInstructions", "value": "", "type": "query", "description": "Flag to include the comp instructions in the available list." }, { "name": "codeWildCard", "value": "", "type": "query", "description": "Lookup string which will try to match an existing Billing and/or Transaction Codes." }, { "name": "descriptionWildCard", "value": "", "type": "query", "description": "Lookup string which will try to match an existing Billing and/or Transaction Code Description." }, { "name": "id", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "type", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)." } ] }, "docs": "You can use this API to get Billing Instruction Codes.OperationId:getBillingInstructionCodes
" }, { "info": { "name": "Link Reservation package allowance", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/sourceReservations/:sourceReservationId/destinationReservations/:destinationReservationId/packageAllowance/links", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "destinationReservationId", "value": "", "type": "path", "description": "Unique ID of the destination reservation." }, { "name": "sourceReservationId", "value": "", "type": "path", "description": "Unique ID of the source reservation." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to link reservation package allowance.OperationId:linkReservationPackageAllowance
" }, { "info": { "name": "Get Postings For Refresh", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/sourceReservations/:sourceReservationId/targetReservations/:targetReservationId/roomRouting", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "targetReservationId", "value": "", "type": "path", "description": "Unique ID of the target reservation" }, { "name": "sourceReservationId", "value": "", "type": "path", "description": "Unique ID of the source reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "type", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)." }, { "name": "targetResvNameIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "targetResvNameIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)." }, { "name": "daily", "value": "", "type": "query", "description": "Flag to indicate if the routing instruction is a daily instruction." }, { "name": "friday", "value": "", "type": "query" }, { "name": "monday", "value": "", "type": "query" }, { "name": "saturday", "value": "", "type": "query" }, { "name": "sunday", "value": "", "type": "query" }, { "name": "thursday", "value": "", "type": "query" }, { "name": "tuesday", "value": "", "type": "query" }, { "name": "wednesday", "value": "", "type": "query" }, { "name": "startDate", "value": "", "type": "query" }, { "name": "endDate", "value": "", "type": "query" }, { "name": "transactionHotelId", "value": "", "type": "query", "description": "Hotel context of the Transaction code." }, { "name": "printTrxReceipt", "value": "", "type": "query", "description": "Print receipt flag that tells whether the transaction receipt is to be printed or not. This is based on the transaction code." }, { "name": "transactionCode", "value": "", "type": "query", "description": "Unique identifier for the Transaction code." }, { "name": "description", "value": "", "type": "query", "description": "Transaction codes info." }, { "name": "transactionGroup", "value": "", "type": "query", "description": "Category of the transaction code." }, { "name": "transactionSubGroup", "value": "", "type": "query", "description": "Sub category of the transaction code." }, { "name": "universalProductCode", "value": "", "type": "query", "description": "Unique Universal product code of the transaction code." }, { "name": "routingInstructionsId", "value": "", "type": "query", "description": "This is the Routing Instruction Id attached with Reservation. It is only used for internal purpose. It should not be used by external vendor or consumer." }, { "name": "articleCode", "value": "", "type": "query", "description": "Unique code of the article." }, { "name": "articleHotelId", "value": "", "type": "query", "description": "Hotel code to which the article belongs." }, { "name": "inactive", "value": "", "type": "query", "description": "Indicates whether the article is inactive or not." }, { "name": "orderSequence", "value": "", "type": "query", "description": "Display Order sequence." }, { "name": "articleDescription", "value": "", "type": "query", "description": "Description of the article." }, { "name": "articleTransactionCode", "value": "", "type": "query", "description": "Transaction code to which the article belongs." }, { "name": "amount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "currencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "availableForPostIt", "value": "", "type": "query", "description": "Indicates whether the article is available for post it." }, { "name": "color", "value": "", "type": "query", "description": "Color configuration type. This color configuration provides a visual category of entities." }, { "name": "articleUniversalProductCode", "value": "", "type": "query", "description": "Unique Universal product code of the article." }, { "name": "billingCode", "value": "", "type": "query", "description": "Unique identifier for the Billing Instruction." }, { "name": "billingHotelId", "value": "", "type": "query", "description": "Hotel context of the Billing Instruction." }, { "name": "desc", "value": "", "type": "query", "description": "Billing Instruction code description." }, { "name": "billingInstructionRoutingInstructionsId", "value": "", "type": "query", "description": "This is the Routing Instruction Id attached with Reservation. It is only used for internal purpose. It should not be used by external vendor or consumer." }, { "name": "creditLimit", "value": "", "type": "query", "description": "Allowable credit amount for this routing instruction. Null value means no limit, 0 equals zero." }, { "name": "percentageLimit", "value": "", "type": "query", "description": "The routing limit percentage allowed for this routing instruction." }, { "name": "covers", "value": "", "type": "query", "description": "Number of covers for this routing instruction." }, { "name": "limitUsed", "value": "", "type": "query", "description": "Amount of Credit used for this routing instruction." }, { "name": "id", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "routingLinkIdIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "routingLinkIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)." } ] }, "docs": "You can use this API to get postings For Refresh.OperationId:getPostingsForRefresh
" }, { "info": { "name": "Process Room Routing Refresh", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/sourceReservations/:sourceReservationId/targetReservations/:targetReservationId/roomRouting", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "targetReservationId", "value": "", "type": "path", "description": "Unique ID of the target reservation" }, { "name": "sourceReservationId", "value": "", "type": "path", "description": "Unique ID of the source reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to change Room Routing Refresh.OperationId:processRoomRoutingRefresh
" }, { "info": { "name": "Get Stored Folio Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/storedFolios/:folioId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "folioId", "value": "", "type": "path", "description": "Unique ID of the folio." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "fiscalBillNo", "value": "", "type": "query", "description": "The Fiscal Bill number of this posting" }, { "name": "folioDate", "value": "", "type": "query", "description": "Date of Folio Generation." }, { "name": "folioStatus", "value": "", "type": "query", "description": "The Folio Status Example: DEPOSIT folio, VOID folio or the default OK folio status." }, { "name": "folioTypeName", "value": "", "type": "query", "description": "The name of the Folio Type used for the Folio Number sequence." }, { "name": "internalFolioWindowID", "value": "", "type": "query", "description": "Internal window ID which is unique to the reservation. This ID can only be used for reference." }, { "name": "invoiceNo", "value": "", "type": "query", "description": "Invoice No after the folio is generated. Same invoice number may be referred in multiple folios" } ] }, "docs": "You can use this API to get Stored Folio Details.OperationId:getStoredFolioDetails
" }, { "info": { "name": "Create Stored Folio Details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/storedFolios/:folioId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "folioId", "value": "", "type": "path", "description": "Unique ID of the folio." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to create Stored Folio Details.OperationId:postStoredFolioDetails
" }, { "info": { "name": "Post supplemental folio", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/supplementFolios", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to post supplemental folio.OperationId:postSupplementalFolio
" }, { "info": { "name": "Get Transaction Codes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/transactionCodes", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "event", "value": "", "type": "query", "description": "Event being generated by a Supplemental Folio." }, { "name": "includeArticles", "value": "", "type": "query", "description": "Flag to indicate if Article Codes are required, along with the parent Transaction Codes." }, { "name": "userRoleTransactions", "value": "", "type": "query", "description": "Flag to indicate if it is allowed to manually post transaction codes." }, { "name": "manualPostAllowed", "value": "", "type": "query", "description": "Flag to include the search for Manual Post Allowed." }, { "name": "code", "value": "", "type": "query", "description": "Lookup string which will try to match an existing Transaction Codes." }, { "name": "description", "value": "", "type": "query", "description": "Lookup string which will try to match an existing Transaction Code Description." }, { "name": "wildCard", "value": "", "type": "query" }, { "name": "fiscalBillNo", "value": "", "type": "query", "description": "The Fiscal Bill number of this posting" }, { "name": "folioDate", "value": "", "type": "query", "description": "Date of Folio Generation." }, { "name": "folioNo", "value": "", "type": "query", "description": "Folio Number." }, { "name": "folioStatus", "value": "", "type": "query", "description": "The Folio Status Example: DEPOSIT folio, VOID folio or the default OK folio status." }, { "name": "folioTypeName", "value": "", "type": "query", "description": "The name of the Folio Type used for the Folio Number sequence." }, { "name": "internalFolioWindowID", "value": "", "type": "query", "description": "Internal window ID which is unique to the reservation. This ID can only be used for reference." }, { "name": "invoiceNo", "value": "", "type": "query", "description": "Invoice No after the folio is generated. Same invoice number may be referred in multiple folios" }, { "name": "trxServiceType", "value": "", "type": "query", "description": "Goods Type Transactions." } ] }, "docs": "You can use this API to retrieve a list of Transaction Codes configured for a property.OperationId:getTransactionCodes
" }, { "info": { "name": "Get Folio Transaction Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/transactionDetails", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "includeGenerates", "value": "", "type": "query", "description": "Flag to indicate if the automatically generated transactions, related to the main transaction number above, are also to be retrieved as part of this request." }, { "name": "transactionNo", "value": "", "type": "query", "description": "Unique Transaction Number of the transaction(posting) for which details are required." }, { "name": "includeExchangeInformation", "value": "", "type": "query", "description": "Flag to indicate what currency exchange information text needs to be included in response." } ] }, "docs": "You can use this API to get Folio Transaction Details.OperationId:getFolioTransactionDetails
" }, { "info": { "name": "Get Guests Transactions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/transactions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "reservationList", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "includeGenerates", "value": "", "type": "query", "description": "Configuring this flag to be TRUE will return transactions that are auto generated like taxes." }, { "name": "includeTransactionsWithARInvoiceNo", "value": "", "type": "query", "description": "Configuring this flag to be TRUE will return transactions that are included in an Accounts Receivable invoice." }, { "name": "includeTransactionsWithFolioNo", "value": "", "type": "query", "description": "Configuring this flag to be TRUE will return transactions that already belongs to a folio." }, { "name": "includeTransactionsWithManualPostingOnly", "value": "", "type": "query", "description": "Configuring this flag to be TRUE will return transactions whose transaction codes have manual posting enabled, or when an adjustment code is attached to the transaction code, the adjustment code's manual posting is enabled." }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "type", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)." }, { "name": "transactionNo", "value": "", "type": "query", "description": "Transaction number of the payment being corrected." }, { "name": "transactionGroup", "value": "", "type": "query", "description": "Category of the transaction code to filter the result." }, { "name": "transactionSubGroup", "value": "", "type": "query", "description": "Sub category of the transaction code to filter the result." }, { "name": "billingCode", "value": "", "type": "query", "description": "Unique identifier for the Billing Instruction." }, { "name": "billingHotelId", "value": "", "type": "query", "description": "Hotel context of the Billing Instruction." }, { "name": "desc", "value": "", "type": "query", "description": "Billing Instruction code description." }, { "name": "routingInstructionsId", "value": "", "type": "query", "description": "This is the Routing Instruction Id attached with Reservation. It is only used for internal purpose. It should not be used by external vendor or consumer." }, { "name": "trxCodeWildCard", "value": "", "type": "query", "description": "Lookup string which will try to match an existing Transaction Code/s." }, { "name": "trxDescriptionWildCard", "value": "", "type": "query", "description": "Lookup string which will try to match an existing Transaction Code's Description." }, { "name": "checkNumberWildCard", "value": "", "type": "query", "description": "Lookup string which will try to match an existing Cheque number's code." }, { "name": "referenceNumberWildCard", "value": "", "type": "query", "description": "Filters the results for reference number." }, { "name": "supplementWildCard", "value": "", "type": "query", "description": "Filter the results for supplement." }, { "name": "windowNo", "value": "", "type": "query", "description": "Filters the result to only include transactions in this window number." }, { "name": "cashieringTransactionType", "value": "", "type": "query", "description": "Wrapper Transaction Type." }, { "name": "startDate", "value": "", "type": "query" }, { "name": "endDate", "value": "", "type": "query" }, { "name": "cashierId", "value": "", "type": "query", "description": "Cashier Id of the Cashier." }, { "name": "code", "value": "", "type": "query" }, { "name": "commissionable", "value": "", "type": "query", "description": "Filters the result based on its commission property. Do not set this criteria if all transactions should be included whether or not they are commissionable." }, { "name": "serviceRecoveryAllowed", "value": "", "type": "query", "description": "Filters the result which are allow for service recovery." }, { "name": "postedTransactionType", "value": "", "type": "query", "description": "Returns only postings without bill number." }, { "name": "billingSummary", "value": "", "type": "query", "description": "Filters the result on transaction billing summary." } ] }, "docs": "You can use this API to get Guests Transactions.OperationId:getGuestsTransactions
This API allows a time span of 30 days.
" }, { "info": { "name": "Adjust Transactions", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/transactions/adjust", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to Adjust Transactions.OperationId:adjustTransactions
" }, { "info": { "name": "Reverse AR Invoice", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/transactions/arInvoices/reverse", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "reasonCode", "value": "", "type": "query", "description": "The reason code for the deletion." }, { "name": "cashierId", "value": "", "type": "query", "description": "The Cashier ID of the Cashier who is currently processing the transaction(s)." }, { "name": "transactionCodes", "value": "", "type": "query", "description": "The unique transaction number of this transaction." } ] }, "docs": "You can use this API to reverse an AR Invoice.OperationId:reverseARInvoice
" }, { "info": { "name": "Split transactions", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/transactions/split", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to Split transactions.OperationId:splitTransaction
" }, { "info": { "name": "Split and transfer transactions", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/transactions/splitAndTransfer", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to split and transfer transactions.OperationId:splitAndTransferTransaction
" }, { "info": { "name": "Validate Transaction Codes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/transactions/:transactionId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "transactionId", "value": "", "type": "path", "description": "Unique ID of the transaction" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "event", "value": "", "type": "query", "description": "Event being generated by a Supplemental Folio." }, { "name": "fiscalBillNo", "value": "", "type": "query", "description": "The Fiscal Bill number of this posting" }, { "name": "folioDate", "value": "", "type": "query", "description": "Date of Folio Generation." }, { "name": "folioNo", "value": "", "type": "query", "description": "Folio Number." }, { "name": "folioStatus", "value": "", "type": "query", "description": "The Folio Status Example: DEPOSIT folio, VOID folio or the default OK folio status." }, { "name": "folioTypeName", "value": "", "type": "query", "description": "The name of the Folio Type used for the Folio Number sequence." }, { "name": "internalFolioWindowID", "value": "", "type": "query", "description": "Internal window ID which is unique to the reservation. This ID can only be used for reference." }, { "name": "invoiceNo", "value": "", "type": "query", "description": "Invoice No after the folio is generated. Same invoice number may be referred in multiple folios" } ] }, "docs": "You can use this API to validate Transaction Codes.OperationId:validateTransactionCodes
" }, { "info": { "name": "Submit Comp Transaction", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/transactions/:transactionId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "transactionId", "value": "", "type": "path", "description": "Unique ID of the transaction." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to submit Comp Transactions.OperationId:postCompTransaction
" }, { "info": { "name": "Change Billing Charge", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/transactions/:transactionId/charges", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "transactionId", "value": "", "type": "path", "description": "Unique ID of the transaction" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to change Billing Charges.OperationId:putBillingCharge
" }, { "info": { "name": "Get Gaming Request Status ", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/transactions/:transactionId/compRequestStatus", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "transactionId", "value": "", "type": "path", "description": "Unique ID of the transaction." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to get Gaming Request Status Information.OperationId:getGamingRequestStatusInfo
" }, { "info": { "name": "Delete flexible benefit postings", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/transactions/:transactionId/flexibleBenefitPostings", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "transactionId", "value": "", "type": "path", "description": "Unique ID of the transaction" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to delete flexible benefit postings.OperationId:reverseFlexibleBenefitPosting
" }, { "info": { "name": "Change Billing Payment", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/transactions/:transactionId/payments", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "transactionId", "value": "", "type": "path", "description": "Unique ID of the transaction" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "This API can be used to update a posted payment with additional reference, supplement, covers, and checknumber values.OperationId:changeBillingPayment
" }, { "info": { "name": "Detach Deposit Policy from Payment", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/transactions/:transactionId/policies/detach/deposit", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "transactionId", "value": "", "type": "path", "description": "Unique ID of the transaction" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to detach Deposit Policy from Payment.OperationId:detachDepositPolicyFromPayment
" }, { "info": { "name": "Create reverse payments", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/transactions/:transactionId/reversePayments", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "transactionId", "value": "", "type": "path", "description": "Unique ID of the Transaction" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to create reverse payments.OperationId:postReversePayment
" }, { "info": { "name": "Get Balance Information", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/transactionsTotal", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "event", "value": "", "type": "query", "description": "Event being generated by a Supplemental Folio." }, { "name": "id", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "type", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)." }, { "name": "folioWindowNo", "value": "", "type": "query" }, { "name": "cashierId", "value": "", "type": "query", "description": "The Cashier ID of the Cashier who is currently processing the transaction(s)." }, { "name": "transactionCode", "value": "", "type": "query", "description": "Transaction Code to post." }, { "name": "articleCode", "value": "", "type": "query", "description": "Article ID." }, { "name": "amount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "currencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "postingQuantity", "value": "", "type": "query", "description": "Quantity to post to the folio." }, { "name": "postingReference", "value": "", "type": "query", "description": "User-defined posting reference." }, { "name": "postingRemark", "value": "", "type": "query", "description": "User-defined posting remark." }, { "name": "checkNumber", "value": "", "type": "query", "description": "Indicates the Cheque number." }, { "name": "arrangementCode", "value": "", "type": "query", "description": "Corrected arrangement code from the package associated to this transaction." }, { "name": "applyRoutingInstructions", "value": "", "type": "query", "description": "Apply room routing when making this posting." }, { "name": "usePackageAllowance", "value": "", "type": "query", "description": "Use the applicable package allowance when making this posting." }, { "name": "autoPosting", "value": "", "type": "query", "description": "True indicates the Transaction Code is allowed to be posted automatically." }, { "name": "uniqueIdId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "uniqueIdIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "uniqueIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)." }, { "name": "postItNumberId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "postItNumberIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "postItNumberType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)." }, { "name": "profileIdId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "profileIdIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "profileIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)." }, { "name": "reservationIdId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "reservationIdIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "reservationIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)." }, { "name": "policyIdId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "policyIdIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "policyIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)." }, { "name": "fiscalBillNo", "value": "", "type": "query", "description": "The Fiscal Bill number of this posting" }, { "name": "folioDate", "value": "", "type": "query", "description": "Date of Folio Generation." }, { "name": "folioNo", "value": "", "type": "query", "description": "Folio Number." }, { "name": "folioStatus", "value": "", "type": "query", "description": "The Folio Status Example: DEPOSIT folio, VOID folio or the default OK folio status." }, { "name": "folioTypeName", "value": "", "type": "query", "description": "The name of the Folio Type used for the Folio Number sequence." }, { "name": "internalFolioWindowID", "value": "", "type": "query", "description": "Internal window ID which is unique to the reservation. This ID can only be used for reference." }, { "name": "invoiceNo", "value": "", "type": "query", "description": "Invoice No after the folio is generated. Same invoice number may be referred in multiple folios" } ] }, "docs": "You can use this API to get Balance Information.This API is deprecated.
OperationId:getBalanceInfo
" }, { "info": { "name": "Transfer comp transactions to window", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/transferCompTransactions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to transfer comp transactions to windowOperationId:transferCompTransactions
" }, { "info": { "name": "Generate Batch Vouchers", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/vouchers/batchJobs", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "This api can be used to generate Batch Vouchers.OperationId:postGenerateBatchVouchers
" }, { "info": { "name": "Create Zero Balance Checkout Reservation Batch ", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/zeroBalanceCheckoutReservations/batchJobs", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "You can use this API to create Zero Balance Checkout Reservation Batch.OperationId:postZeroBalanceCheckoutReservations
" }, { "info": { "name": "Operation to post room and tax for day use.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/reservations/:reservationId/postRoomAndTaxForDayUse", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation." } ] }, "docs": "You can use this API to post post Room And Tax For DayUseOperationId:postRoomAndTaxForDayUse
" }, { "info": { "name": "Get Rounding Difference", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/roundingDifference", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "event", "value": "", "type": "query", "description": "Event being generated by a Supplemental Folio." }, { "name": "folioWindowNo", "value": "", "type": "query" }, { "name": "internalFolioWindowID", "value": "", "type": "query", "description": "Internal window ID which is unique to the reservation. This ID can only be used for reference." }, { "name": "cashierId", "value": "", "type": "query", "description": "The Cashier ID of the Cashier who is currently processing the transaction(s)." }, { "name": "hotelId", "value": "", "type": "query", "description": "Hotel context of the reservation." }, { "name": "id", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "amount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "currencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "description", "value": "", "type": "query" }, { "name": "folioView", "value": "", "type": "query" }, { "name": "paymentMethod", "value": "", "type": "query" }, { "name": "attachCreditCardToProfile", "value": "", "type": "query", "description": "Attach the credit card to profile." }, { "name": "cardHolderName", "value": "", "type": "query" }, { "name": "cardNumber", "value": "", "type": "query" }, { "name": "cardNumberLast4Digits", "value": "", "type": "query" }, { "name": "cardNumberMasked", "value": "", "type": "query" }, { "name": "cardOrToken", "value": "", "type": "query", "description": "Simple type for indicating if credit card number is tokenized." }, { "name": "cardType", "value": "", "type": "query", "description": "This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method." }, { "name": "expirationDate", "value": "", "type": "query", "description": "Expiration date of the credit card" }, { "name": "expirationDateExpired", "value": "", "type": "query" }, { "name": "expirationDateMasked", "value": "", "type": "query", "description": "Masked Expiration date of the credit card" }, { "name": "processing", "value": "", "type": "query" }, { "name": "swiped", "value": "", "type": "query" }, { "name": "userDefinedCardType", "value": "", "type": "query", "description": "Indicates the user defined credit card type if credit card type from a defined list is not provided" }, { "name": "cardIdId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "currentAuthorizedAmountAmount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "currentAuthorizedAmountCurrencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "approvalAmountNeededAmount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "approvalAmountNeededCurrencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "balanceAmount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "balanceCurrencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "code", "value": "", "type": "query", "description": "The authorization rule code." }, { "name": "amountAmount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "amountCurrencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "percent", "value": "", "type": "query", "description": "A percentage value if the authorization rule is percentage based." }, { "name": "emailFolio", "value": "", "type": "query" }, { "name": "uniqueIdId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "createDateTime", "value": "", "type": "query", "description": "Time stamp of the creation." }, { "name": "creatorId", "value": "", "type": "query", "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation." }, { "name": "emailAddress", "value": "", "type": "query", "description": "Defines the e-mail address." }, { "name": "emailFormat", "value": "", "type": "query", "description": "Supported Email format." }, { "name": "lastModifierId", "value": "", "type": "query", "description": "Identifies the last software system or person to modify a record." }, { "name": "lastModifyDateTime", "value": "", "type": "query", "description": "Time stamp of last modification." }, { "name": "orderSequence", "value": "", "type": "query", "description": "Display Order sequence." }, { "name": "primaryInd", "value": "", "type": "query", "description": "When true, indicates a primary information." }, { "name": "purgeDate", "value": "", "type": "query", "description": "Date an item will be purged from a database (e.g., from a live database to an archive)." }, { "name": "emailType", "value": "", "type": "query", "description": "Defines the purpose of the e-mail address (e.g. personal, business, listserve)." }, { "name": "typeDescription", "value": "", "type": "query", "description": "Describes the Type code" } ] }, "docs": "You can use this API to get Rounding Difference.OperationId:getRoundingDifference
" }, { "info": { "name": "Status check of cashiering services", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/services/cashiering/status", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "You can use this API to Status check of cashiering services.OperationId:pingCashieringService
" } ] } ], "bundled": true }