Oracle Hospitality Cashiering Config API
Cashiering configurations affect the control and management of financial transactions at your property. You can configure cashiering components for articles for sale, cancellation handling, deposits, folios, settlements, exchange rates, payment methods and so on.
Showing the first 250 of 270. The full set is in the contract, and via get_provider_operations.
PUT
/articles
Operation to change Articles.
#
POST
/articles
Operation to create Articles.
#
GET
/articles
Operation to fetch Articles.
#
DELETE
/articles
Operation to delete Articles.
#
PUT
/authorizationConfigRule
Operation to change AuthorizationConfigRule.
#
POST
/authorizationConfigRule
Operation to create AuthorizationConfigRule.
#
DELETE
/authorizationConfigRule
Operation to delete AuthorizationConfigRule.
#
GET
/authorizationConfigRules
Operation to fetch AuthorizationConfigRules.
#
PUT
/authorizerGroups
Operation to change AuthorizerGroups.
#
POST
/authorizerGroups
Operation to create AuthorizerGroups.
#
GET
/authorizerGroups
Operation to fetch AuthorizerGroups.
#
DELETE
/authorizerGroups
Operation to delete AuthorizerGroups.
#
PUT
/budgetForecast
Operation to delete BudgetForecast.
#
GET
/budgetForecast
Operation to fetch BudgetForecast.
#
PUT
/budgetForecast/set
Operation to set BudgetForecast.
#
PUT
/cashSurchargeRange
Operation to change the Cash Surcharge Range.
#
POST
/cashSurchargeRange
Operation to create a Cash Surcharge Range.
#
GET
/cashSurchargeRange
Operation to fetch Cash Surcharge Ranges.
#
DELETE
/cashSurchargeRange
Operation to delete the Cash Surcharge Range.
#
GET
/cashierDetails/cashiers
Operation to fetch Cashiers.
#
POST
/cashierDetails/cashiers/search
Operation to fetch Cashiers.
#
PUT
/cashiers
Operation to change CashiersDetails.
#
POST
/cashiers
Operation to create Cashiers.
#
GET
/cashiers/nextAvailable
Operation to fetch AvailableCashierNumber.
#
PUT
/collectingAgentTaxes
Operation to change CollectingAgentTaxes.
#
POST
/collectingAgentTaxes
Operation to create CollectingAgentTaxes.
#
GET
/collectingAgentTaxes
Operation to fetch CollectingAgentTaxes.
#
DELETE
/collectingAgentTaxes
Operation to delete CollectingAgentTaxes.
#
PUT
/compAuthorizers/set
Operation to set CompAuthorizer.
#
POST
/compTypes
Operation to Create Comp Types
#
PUT
/compTypes
Operation to Change Comp Types.
#
DELETE
/compTypes/codes/{compTypesCode}
Operation to Remove Comp Types.
#
PUT
/currencyExchangeServiceTaxes
Operation to change ExchangeServiceTaxes.
#
POST
/currencyExchangeServiceTaxes
Operation to create CurrencyExchangeServiceTaxes.
#
GET
/currencyExchangeServiceTaxes
Operation to fetch CurrencyExchangeServiceTaxes.
#
DELETE
/currencyExchangeServiceTaxes
Operation to delete CurrencyExchangeServiceTaxes.
#
GET
/customCharges/exemptions
Operation to fetch Custom Charge Exemptions Config.
#
PUT
/dailyPlanCodes
Operation to change DailyPlanCodes.
#
GET
/dailyPlanCodes
Operation to fetch DailyPlanCodes.
#
GET
/defaultPaymentMethodRules
Operation to fetch DefaultPaymentMethodRule.
#
GET
/exchangeRates
Operation to fetch ExchangeRates.
#
PUT
/exchangeRates
Operation to delete ExchangeRates.
#
PUT
/exchangeRates/set
Operation to set ExchangeRates.
#
PUT
/expenseArrangementCodes
Operation to change ExpenseArrangementCodes.
#
POST
/expenseArrangementCodes
Operation to create ExpenseArrangementCodes.
#
GET
/expenseArrangementCodes
Operation to fetch ExpenseArrangementCodes.
#
DELETE
/expenseArrangementCodes
Operation to delete ExpenseArrangementCodes.
#
PUT
/expenseArrangementCodes/copy
Operation to copy ExpenseArrangementCodes.
#
PUT
/fiscalFolioParameters
Operation to change FiscalFolioParameters.
#
GET
/fiscalFolioParameters
Operation to fetch FiscalFolioParameters.
#
DELETE
/fiscalFolioParameters
Operation to delete FiscalFolioParameters.
#
PUT
/fiscalPeriods
Operation to change FiscalPeriods.
#
POST
/fiscalPeriods
Operation to create FiscalPeriods.
#
GET
/fiscalPeriods
Operation to fetch FiscalPeriods.
#
DELETE
/fiscalPeriods
Operation to delete FiscalPeriods.
#
PUT
/fiscalYears
Operation to change FiscalYears.
#
POST
/fiscalYears
Operation to create FiscalYears.
#
GET
/fiscalYears
Operation to fetch FiscalYears.
#
DELETE
/fiscalYears
Operation to delete FiscalYears.
#
PUT
/folioArrangementCodes
Operation to change FolioArrangementCodes.
#
POST
/folioArrangementCodes
Operation to create FolioArrangementCodes.
#
GET
/folioArrangementCodes
Operation to fetch FolioArrangementCodes.
#
DELETE
/folioArrangementCodes
Operation to delete FolioArrangementCodes.
#
PUT
/folioArrangementCodes/copy
Operation to copy FolioArrangementCodes.
#
PUT
/folioCopyLegends
Operation to change FolioCopyLegends.
#
GET
/folioCopyLegends
Operation to fetch FolioCopyLegends.
#
PUT
/folioPrintQueues
Operation to change FolioPrintQueues.
#
POST
/folioPrintQueues
Operation to create FolioPrintQueues.
#
GET
/folioPrintQueues
Operation to fetch FolioPrintQueues.
#
DELETE
/folioPrintQueues
Operation to delete FolioPrintQueues.
#
GET
/folioTypeLegendMappings
Operation to fetch folio type legend mappings config.
#
POST
/folioTypeLegendMappings
Operation to create folio type legend mappings config.
#
PUT
/folioTypeLegendMappings
Operation to change folio type legend mappings config.
#
PUT
/folioTypesConfig
Operation to change FolioTypesConfig.
#
POST
/folioTypesConfig
Operation to create FolioTypesConfig.
#
GET
/folioTypesConfig
Operation to fetch FolioTypesConfig.
#
DELETE
/folioTypesConfig
Operation to delete FolioTypesConfig.
#
PUT
/foreignCurrencies
Operation to change ForeignCurrencies.
#
POST
/foreignCurrencies
Operation to create ForeignCurrencies.
#
GET
/foreignCurrencies
Operation to fetch ForeignCurrencies.
#
DELETE
/foreignCurrencies
Operation to delete ForeignCurrencies.
#
PUT
/generates
Operation to change TransactionGenerates.
#
POST
/generates
Operation to create TransactionGenerates.
#
GET
/globalExchangeRates
Operation to fetch GlobalExchangeRates.
#
PUT
/globalExchangeRates
Operation to delete GlobalExchangeRates.
#
PUT
/globalExchangeRates/set
Operation to set GlobalExchangeRates.
#
PUT
/groupArrangementCodes
Operation to change GroupArrangementCodes.
#
POST
/groupArrangementCodes
Operation to create GroupArrangementCodes.
#
GET
/groupArrangementCodes
Operation to create GroupArrangementCodes.
#
DELETE
/groupArrangementCodes
Operation to delete GroupArrangementCodes.
#
PUT
/groupArrangementCodes/copy
Operation to copy GroupArrangementCodes.
#
PUT
/guiNumberRules
Operation to change GUINumberRules.
#
GET
/guiNumberRules
Operation to fetch GUINumberRules.
#
PUT
/hotelAdjustmentCodes
Operation to change AdjustmentCodes.
#
POST
/hotelAdjustmentCodes
Operation to create AdjustmentCodes.
#
GET
/hotelAdjustmentCodes
Operation to fetch AdjustmentCodes.
#
DELETE
/hotelAdjustmentCodes
Operation to delete AdjustmentCodes.
#
PUT
/hotelAdjustmentCodes/copy
Operation to copy AdjustmentCodes.
#
PUT
/hotelPaymentMethods
Operation to change PaymentMethods.
#
POST
/hotelPaymentMethods
Operation to create PaymentMethods.
#
GET
/hotelPaymentMethods
Operation to fetch PaymentMethods.
#
PUT
/hotelPaymentMethods/copy
Operation to copy PaymentMethods.
#
PUT
/hotelTaxTypes
Operation to change TaxTypes.
#
POST
/hotelTaxTypes
Operation to create TaxTypes.
#
GET
/hotelTaxTypes
Operation to fetch TaxTypes.
#
DELETE
/hotelTaxTypes
Operation to delete TaxTypes.
#
PUT
/hotelTaxTypes/copy
Operation to copy TaxTypes.
#
PUT
/hotelVouchersConfig/copy
Operation to copy Vouchers Config.
#
GET
/hotels/{hotelId}/compAuthorizers
Operation to fetch CompAuthorizers.
#
POST
/hotels/{hotelId}/compAuthorizers/search
Operation to fetch CompAuthorizers.
#
GET
/hotels/{hotelId}/compBucket/redemption
Operation to fetch Comp Bucket Redemption Codes.
#
POST
/hotels/{hotelId}/compBucket/redemption
Operation to create Comp Bucket Redemption Codes.
#
GET
/hotels/{hotelId}/compBucket/redemption/{redemptionCode}
Operation to fetch Comp Bucket Redemption Codes.
#
PUT
/hotels/{hotelId}/compBucket/redemption/{redemptionCode}
Operation to change Comp Bucket Redemption Codes.
#
DELETE
/hotels/{hotelId}/compBucket/redemption/{redemptionCode}
Operation to remove Comp Bucket Redemption Codes.
#
GET
/hotels/{hotelId}/compTypes
Operation to Fetch Comp Types.
#
GET
/hotels/{hotelId}/customCharges
Operation to fetch Custom Charge Codes.
#
POST
/hotels/{hotelId}/customCharges
Operation to create Custom Charge Codes.
#
GET
/hotels/{hotelId}/customCharges/configuration/{configurationId}
Operation to fetch Custom Charge Codes.
#
PUT
/hotels/{hotelId}/customCharges/configuration/{configurationId}
Operation to change Custom Charge Codes.
#
DELETE
/hotels/{hotelId}/customCharges/configuration/{configurationId}
Operation to remove Custom Charge Codes.
#
POST
/hotels/{hotelId}/customCharges/exemptions
Operation to create Custom Charge Exemptions Config.
#
GET
/hotels/{hotelId}/customCharges/exemptions/{configurationId}
Operation to fetch Custom Charge Exemptions Config.
#
PUT
/hotels/{hotelId}/customCharges/exemptions/{configurationId}
Operation to change Custom Charge Exemptions Config.
#
DELETE
/hotels/{hotelId}/customCharges/exemptions/{configurationId}
Operation to remove Custom Charge Exemptions Config.
#
GET
/hotels/{hotelId}/customNumbers
Operation to fetch custom number config.
#
POST
/hotels/{hotelId}/customNumbers
Operation to create custom number config.
#
GET
/hotels/{hotelId}/customNumbers/configuration/{configurationId}
Operation to fetch custom number config.
#
PUT
/hotels/{hotelId}/customNumbers/configuration/{configurationId}
Operation to change custom number config.
#
DELETE
/hotels/{hotelId}/customNumbers/configuration/{configurationId}
Operation to remove custom number config.
#
GET
/hotels/{hotelId}/exchangeRates
Operation to fetch ExchangeRates.
#
GET
/hotels/{hotelId}/exchangeRates/{currencyCode}
Operation to fetch FuturePastExchangeRates.
#
GET
/hotels/{hotelId}/fiscalCommands
Get Fiscal Commands
#
PUT
/hotels/{hotelId}/fiscalCommands
Change configuration fiscal commands
#
GET
/hotels/{hotelId}/fiscalPartners
Get fiscal partners
#
POST
/hotels/{hotelId}/fiscalPartners
Create fiscal partners
#
DELETE
/hotels/{hotelId}/fiscalPartners
Delete configuration fiscal partners
#
PUT
/hotels/{hotelId}/fiscalPartners
Change configuration fiscal partners
#
DELETE
/hotels/{hotelId}/folios/{folioType}/legends/{legendCode}
Operation to remove folio type legend mappings config.
#
GET
/hotels/{hotelId}/generates
Operation to fetch GenerateTaxTypes.
#
POST
/hotels/{hotelId}/template/customNumbers
Operation to create a new template custom number configuration.
#
GET
/hotels/{hotelId}/template/customNumbers/configuration/{configurationId}
Operation to fetch template custom number configuration.
#
PUT
/hotels/{hotelId}/template/customNumbers/configuration/{configurationId}
Operation to change template custom number configuration.
#
DELETE
/hotels/{hotelId}/template/customNumbers/configuration/{configurationId}
Operation to remove template custom number configuration.
#
GET
/hotels/{hotelId}/termCodes/{termCode}/folioCopyLegend
Operation to fetch FolioCopyLegend.
#
GET
/hotels/{hotelId}/transactionCodeAccessRoles
Operation to fetch TransactionCodeAccessRoles.
#
GET
/hotels/{hotelId}/transactionCodes/{transactionCode}/chargeSimulations
Operation to CalculatePosting.
#
GET
/hotels/{hotelId}/transactionCodes/{transactionCode}/hotelTransactionCode
Operation to fetch TransactionCode.
#
DELETE
/hotels/{hotelId}/transactionCodes/{transactionCode}/transactionCodes
Operation to delete TransactionCodes.
#
PUT
/hotels/{hotelId}/transactionDiscounts/{transactionDiscountCode}
Operation to change TransactionDiscounts.
#
DELETE
/hotels/{hotelId}/transactionDiscounts/{transactionDiscountCode}
Operation to delete TransactionDiscounts.
#
GET
/hotels/{hotelId}/transactionGroupCode/{transactionGroupCode}/transactionGroup
Operation to fetch TransactionGroup.
#
GET
/hotels/{hotelId}/transactionSubGroupCodes/{transactionSubGroupCode}/transactionGroupCodes/{transactionGroupCode}/transactionSubGroup
Operation to fetch TransactionGroup.
#
GET
/hotels/{hotelId}/vouchers
Get Vouchers
#
DELETE
/hotels/{hotelId}/vouchers
Operation to remove Vouchers.
#
PUT
/hotels/{hotelId}/vouchers
Operation to change a voucher.
#
POST
/hotels/{hotelId}/vouchers
Operation to create Vouchers.
#
POST
/hotels/{sourceHotelId}/customCharges/exemptions/copy
Operation to copy Custom Charge Exemptions Config.
#
PUT
/hotels/{sourceHotelId}/fiscalFolioParameters/copy
Operation to copy FiscalFolioParameters.
#
PUT
/noShowPostingRules
Operation to change NoShowPostingRules.
#
POST
/noShowPostingRules
Operation to create NoShowPostingRules.
#
GET
/noShowPostingRules
Operation to fetch NoShowPostingRules.
#
DELETE
/noShowPostingRules
Operation to delete NoShowPostingRules.
#
PUT
/numberDescriptions
Operation to change NumberDescriptions.
#
GET
/numberDescriptions
Operation to fetch NumberDescriptions.
#
PUT
/operaControlSequences
Operation to change OperaControlSequences.
#
GET
/operaControlSequences
Operation to fetch OperaControlSequences.
#
PUT
/packageArrangementCodes
Operation to change PackageArrangementCodes.
#
POST
/packageArrangementCodes
Operation to create PackageArrangementCodes.
#
GET
/packageArrangementCodes
Operation to fetch PackageArrangementCodes.
#
DELETE
/packageArrangementCodes
Operation to delete PackageArrangementCodes.
#
PUT
/packageArrangementCodes/copy
Operation to copy PackageArrangementCodes.
#
PUT
/paymentMethods
Operation to delete TransactionArrangementCodes.
#
PUT
/revenueBucketCodes
Operation to change RevenueBucketCodes.
#
POST
/revenueBucketCodes
Operation to create RevenueBucketCodes.
#
GET
/revenueBucketCodes
Operation to fetch RevenueBucketCodes.
#
DELETE
/revenueBucketCodes
Operation to delete RevenueBucketCodes.
#
PUT
/revenueBucketCodes/copy
Operation to copy RevenueBucketCodes.
#
PUT
/revenueBucketTypes
Operation to change RevenueBucketTypes.
#
POST
/revenueBucketTypes
Operation to create RevenueBucketTypes.
#
GET
/revenueBucketTypes
Operation to fetch RevenueBucketTypes.
#
DELETE
/revenueBucketTypes
Operation to delete RevenueBucketTypes.
#
PUT
/revenueBucketTypes/copy
Operation to copy RevenueBucketTypes.
#
PUT
/revenueTypeMapping
Operation to change RevenueTypeMapping.
#
POST
/revenueTypeMapping
Operation to create RevenueTypeMapping.
#
GET
/revenueTypeMapping
Operation to fetch RevenueTypeMapping.
#
DELETE
/revenueTypeMapping
Operation to delete RevenueTypeMapping.
#
PUT
/revenueTypeMapping/copy
Operation to copy RevenueTypeMapping.
#
PUT
/roomTypeBasedChargeRanges
Operation to change Room Type Based Charge Ranges.
#
POST
/roomTypeBasedChargeRanges
Operation to create Room Type Based Charge Ranges.
#
GET
/roomTypeBasedChargeRanges
Operation to fetch Room Type Based Charge Ranges.
#
DELETE
/roomTypeBasedChargeRanges
Operation to delete Room Type Based Charge Ranges.
#
PUT
/routingInstructions
Operation to change RoutingInstructions.
#
POST
/routingInstructions
Operation to create RoutingInstructions.
#
GET
/routingInstructions
Operation to fetch RoutingInstructions.
#
DELETE
/routingInstructions
Operation to delete RoutingInstructions.
#
PUT
/routingInstructions/copy
Operation to copy RoutingInstructions.
#
GET
/services/cashieringConfig/status
Operation to ping.
#
PUT
/taxBrackets
Operation to change TaxBrackets.
#
POST
/taxBrackets
Operation to create TaxBrackets.
#
GET
/taxBrackets
Operation to fetch TaxBrackets.
#
DELETE
/taxBrackets
Operation to delete TaxBrackets.
#
PUT
/taxBrackets/copy
Operation to copy TaxBrackets.
#
GET
/template/customNumbers
Operation to fetch template custom number configuration.
#
PUT
/template/customNumbers
Operation to change template custom number configuration.
#
DELETE
/template/customNumbers
Operation to remove template custom number configuration.
#
POST
/template/customNumbers
Operation to create a new template custom number configuration.
#
PUT
/templateTransactionCodes
Operation to change TemplateTransactionCodes.
#
POST
/templateTransactionCodes
Operation to create TemplateTransactionCodes.
#
GET
/templateTransactionCodes
Operation to fetch TemplateTransactionCodes.
#
DELETE
/templateTransactionCodes
Operation to delete TemplateTransactionCodes.
#
PUT
/templateTransactionGroups
Operation to change TemplateTransactionGroups.
#
POST
/templateTransactionGroups
Operation to create TemplateTransactionGroups.
#
GET
/templateTransactionGroups
Operation to fetch TemplateTransactionGroups.
#
DELETE
/templateTransactionGroups
Operation to delete TemplateTransactionGroups.
#
PUT
/templateTransactionSubGroups
Operation to change TemplateTransactionSubgroups.
#
POST
/templateTransactionSubGroups
Operation to create TemplateTransactionSubgroups.
#
GET
/templateTransactionSubGroups
Operation to fetch TemplateTransactionSubgroups.
#
DELETE
/templateTransactionSubGroups
Operation to delete TemplateTransactionSubgroups.
#
GET
/transactionArrangementCodes
Operation to fetch TransactionArrangementCodes.
#
PUT
/transactionCodeAccessRoles/set
Operation to set TransactionCodeAccessRoles.
#
PUT
/transactionCodeOwnership
Operation to change TransactionCodeOwnership.
#
PUT
/transactionCodes
Operation to change TransactionCodes.
#
POST
/transactionCodes
Operation to create TransactionCodes.
#
GET
/transactionCodes
Operation to fetch TransactionCodes.
#
PUT
/transactionCodes/copy
Operation to copy TransactionCodes.
#
POST
/transactionDiscounts
Operation to create TransactionDiscounts.
#
GET
/transactionDiscounts
Operation to fetch TransactionDiscounts.
#
PUT
/transactionDiscounts/copy
Operation to copy TransactionDiscounts.
#
PUT
/transactionDiversionRules
Operation to change TransactionDiversionRules.
#
POST
/transactionDiversionRules
Operation to create TransactionDiversionRules.
#
GET
/transactionDiversionRules
Operation to fetch TransactionDiversionRules.
#
PUT
/transactionDiversionRules/remove
Operation to delete TransactionDiversionRules.
#
PUT
/transactionGenerates
Operation to delete TransactionGenerates.
#
PUT
/transactionGroups
Operation to change TransactionGroups.
#
POST
/transactionGroups
Operation to create TransactionGroups.
#
GET
/transactionGroups
Operation to fetch TransactionGroups.
#
DELETE
/transactionGroups
Operation to delete TransactionGroups.
#
PUT
/transactionGroups/copy
Operation to copy TransactionGroups.
#
PUT
/transactionSubGroups
Operation to change TransactionSubgroups.
#
POST
/transactionSubGroups
Operation to create TransactionSubgroups.
#
GET
/transactionSubGroups
Operation to fetch TransactionSubgroups.
#
DELETE
/transactionSubGroups
Operation to delete TransactionSubgroups.
#
PUT
/transactionSubGroups/copy
Operation to copy TransactionSubgroups.
#
PUT
/upsert/authorizationConfigRule
Operation to create/change AuthorizationConfigRule.
#
PUT
/upsert/authorizerGroups
Operation to create/change AuthorizerGroups.
#
PUT
/upsert/cashiers
Operation to create/change CashiersDetails.
#
PUT
/upsert/collectingAgentTaxes
Operation to create/change CollectingAgentTaxes.
#
PUT
/upsert/compTypes
Operation to Create/Change Comp Types.
#
PUT
/upsert/currencyExchangeServiceTaxes
create/change ExchangeServiceTaxes.
#
Documentation
Specifications
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.
All 92 tools →
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/oracle-hospitality-cashieringconfig-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no email required.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: OPERA Cloud Front Desk Configuration Cashiering Config API
description: APIs to cater for Front Desk Configuration in OPERA Cloud. Here you can find operations to get, post, put and delete front desk codes such as commission codes, transaction groups, codes & subgroups, articles, payment methods and credit card types.<br /><br />Compatible with OPERA Cloud release 26.2.0.0.<br /><br /><p>This document and all content within is available under the Universal Permissive License v 1.0 (https://oss.oracle.com/licenses/upl). Copyright (c) 2020,2023 Oracle and/or its affiliates.</p><br /><br /> Compatible with OPERA Cloud release 20.99.99.99.<br /><br /><p> This document and all content within is available under the Universal Permissive License v 1.0 (https://oss.oracle.com/licenses/upl). Copyright (c) 2020, 2026 Oracle and/or its affiliates.</p>
version: 26.2.0.0
termsOfService: https://www.oracle.com/legal/terms.html
contact:
email: hospitality_apis_ww_grp@oracle.com
license:
name: UPL
url: https://opensource.org/licenses/upl
servers:
- url: /fof/config/v1
tags:
- name: CashieringConfig
description: Cashiering configurations affect the control and management of financial transactions at your property. You can configure cashiering components for articles for sale, cancellation handling, deposits, folios, settlements, exchange rates, payment methods and so on.
paths:
/articles:
put:
summary: Operation to change Articles.
description: Operation to change articles. <p><strong>OperationId:</strong>putArticles</p>
operationId: putArticles
parameters:
- $ref: '#/components/parameters/authKey'
- $ref: '#/components/parameters/externalData'
- $ref: '#/components/parameters/x-app-key'
- $ref: '#/components/parameters/x-request-id'
- $ref: '#/components/parameters/x-originating-application'
- $ref: '#/components/parameters/x-hotelid'
- $ref: '#/components/parameters/x-externalsystem'
- $ref: '#/components/parameters/Accept-Language'
responses:
'200':
headers:
Content-Language:
description: Audience language
x-example: en-GB
schema:
type: string
pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
Location:
description: Location of newly created resource
schema:
type: string
description: Response Body.
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/status'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'413':
$ref: '#/components/responses/413'
'414':
$ref: '#/components/responses/414'
'415':
$ref: '#/components/responses/415'
'500':
$ref: '#/components/responses/500'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
tags:
- CashieringConfig
requestBody:
content:
application/json;charset=UTF-8:
schema:
allOf:
- $ref: '#/components/schemas/articles'
description: Request to change articles.
required: true
post:
summary: Operation to create Articles.
description: Operation to create articles. <p><strong>OperationId:</strong>postArticles</p>
operationId: postArticles
parameters:
- $ref: '#/components/parameters/authKey'
- $ref: '#/components/parameters/externalData'
- $ref: '#/components/parameters/x-app-key'
- $ref: '#/components/parameters/x-request-id'
- $ref: '#/components/parameters/x-originating-application'
- $ref: '#/components/parameters/x-hotelid'
- $ref: '#/components/parameters/x-externalsystem'
- $ref: '#/components/parameters/Accept-Language'
responses:
'201':
headers:
Content-Language:
description: Audience language
x-example: en-GB
schema:
type: string
pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
Location:
description: Location of newly created resource
schema:
type: string
description: HATEOAS links which help the consumer to navigate to resources
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/status'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'413':
$ref: '#/components/responses/413'
'414':
$ref: '#/components/responses/414'
'415':
$ref: '#/components/responses/415'
'500':
$ref: '#/components/responses/500'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
tags:
- CashieringConfig
requestBody:
content:
application/json;charset=UTF-8:
schema:
allOf:
- $ref: '#/components/schemas/articles'
description: Request to create articles.
required: true
get:
summary: Operation to fetch Articles.
description: Use this API to return articles for one or multiple hotels based on search criteria such as hotelIds, transactionCodes, articleCodes, etc.One transaction code can sometimes serve as an umbrella for multiple articles, which can be posted using that transaction code. For example, a single mini bar food transaction code might cover potato chips, crackers, peanuts, pretzels, and so on. <p><strong>OperationId:</strong>getArticles</p>
operationId: getArticles
parameters:
- name: hotelIds
in: query
required: true
style: form
explode: true
schema:
type: array
items:
type: string
maxItems: 4000
- name: transactionCodes
in: query
required: false
style: form
explode: true
schema:
type: array
items:
type: string
maxItems: 4000
- name: articleCodes
in: query
required: false
style: form
explode: true
schema:
type: array
items:
type: string
maxItems: 4000
- name: universalProductCode
in: query
required: false
description: Unique Universal product code search criteria.
schema:
type: string
- name: includeInactive
in: query
x-example: 'false'
required: false
description: Indicator that tells whether to include inactive articles in search results.
schema:
type: boolean
- $ref: '#/components/parameters/authKey'
- $ref: '#/components/parameters/externalData'
- $ref: '#/components/parameters/x-app-key'
- $ref: '#/components/parameters/x-request-id'
- $ref: '#/components/parameters/x-originating-application'
- $ref: '#/components/parameters/x-hotelid'
- $ref: '#/components/parameters/x-externalsystem'
- $ref: '#/components/parameters/Accept-Language'
responses:
'200':
headers:
Content-Language:
description: Audience language
x-example: en-GB
schema:
type: string
pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
description: Response for fetching articles.
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/articlesInfo'
'204':
description: Articles not found.
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'413':
$ref: '#/components/responses/413'
'414':
$ref: '#/components/responses/414'
'415':
$ref: '#/components/responses/415'
'500':
$ref: '#/components/responses/500'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
tags:
- CashieringConfig
delete:
summary: Operation to delete Articles.
description: Operation to remove articles. <p><strong>OperationId:</strong>deleteArticles</p>
operationId: deleteArticles
parameters:
- name: hotelId
in: query
required: true
description: Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.
schema:
type: string
- name: articleCodes
in: query
description: Unique code of the article.
required: true
style: form
explode: true
schema:
type: array
items:
type: string
- name: articleHotelId
in: query
description: Hotel code to which the article belongs.
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: inactive
in: query
description: Indicates whether the article is inactive or not.
x-example:
- 'false'
required: false
style: form
explode: true
schema:
type: array
items:
type: boolean
- name: orderSequence
in: query
description: Display Order sequence.
required: false
style: form
explode: true
schema:
type: array
items:
type: number
- name: description
in: query
description: Description of the article.
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: transactionCode
in: query
description: Transaction code to which the article belongs.
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: amount
in: query
required: false
description: A monetary amount.
schema:
type: number
- name: currencyCode
in: query
required: false
description: Provides a currency code to reflect the currency in which an amount may be expressed.
schema:
type: string
- name: availableForPostIt
in: query
required: false
description: Indicates whether the article is available for post it.
schema:
type: boolean
- name: color
in: query
required: false
description: Color configuration type. This color configuration provides a visual category of entities.
schema:
type: string
enum:
- Red
- DarkRed
- Green
- DarkGreen
- LightGreen
- Orange
- White
- Yellow
- DarkYellow
- Purple
- Brown
- Gray
- Aqua
- Chocolate
- Blue
- LightBlue
- DarkBlue
- Cyan
- DarkCyan
- Magenta
- DarkMagenta
- Black
uniqueItems: true
- name: universalProductCode
in: query
description: Unique Universal product code of the article.
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- $ref: '#/components/parameters/authKey'
- $ref: '#/components/parameters/externalData'
- $ref: '#/components/parameters/x-app-key'
- $ref: '#/components/parameters/x-request-id'
- $ref: '#/components/parameters/x-originating-application'
- $ref: '#/components/parameters/x-hotelid'
- $ref: '#/components/parameters/x-externalsystem'
- $ref: '#/components/parameters/Accept-Language'
responses:
'200':
headers:
Content-Language:
description: Audience language
x-example: en-GB
schema:
type: string
pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
Location:
description: Location of newly created resource
schema:
type: string
description: HATEOAS links which help the consumer to navigate to resources
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/status'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'413':
$ref: '#/components/responses/413'
'414':
$ref: '#/components/responses/414'
'415':
$ref: '#/components/responses/415'
'500':
$ref: '#/components/responses/500'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
tags:
- CashieringConfig
/authorizationConfigRule:
put:
summary: Operation to change AuthorizationConfigRule.
description: ' <p><strong>OperationId:</strong>putAuthorizationConfigRule</p>'
operationId: putAuthorizationConfigRule
parameters:
- $ref: '#/components/parameters/authKey'
- $ref: '#/components/parameters/externalData'
- $ref: '#/components/parameters/x-app-key'
- $ref: '#/components/parameters/x-request-id'
- $ref: '#/components/parameters/x-originating-application'
- $ref: '#/components/parameters/x-hotelid'
- $ref: '#/components/parameters/x-externalsystem'
- $ref: '#/components/parameters/Accept-Language'
responses:
'200':
headers:
Content-Language:
description: Audience language
x-example: en-GB
schema:
type: string
pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
Location:
description: Location of newly created resource
schema:
type: string
description: Response Body.
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/status'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'413':
$ref: '#/components/responses/413'
'414':
$ref: '#/components/responses/414'
'415':
$ref: '#/components/responses/415'
'500':
$ref: '#/components/responses/500'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
tags:
- CashieringConfig
requestBody:
content:
application/json;charset=UTF-8:
schema:
allOf:
- $ref: '#/components/schemas/authorizationConfigRules'
description: Request object to change authorization rule.
required: true
post:
summary: Operation to create AuthorizationConfigRule.
description: ' <p><strong>OperationId:</strong>postAuthorizationConfigRule</p>'
operationId: postAuthorizationConfigRule
parameters:
- $ref: '#/components/parameters/authKey'
- $ref: '#/components/parameters/externalData'
- $ref: '#/components/parameters/x-app-key'
- $ref: '#/components/parameters/x-request-id'
- $ref: '#/components/parameters/x-originating-application'
- $ref: '#/components/parameters/x-hotelid'
- $ref: '#/components/parameters/x-externalsystem'
- $ref: '#/components/parameters/Accept-Language'
responses:
'201':
headers:
Content-Language:
description: Audience language
x-example: en-GB
schema:
type: string
pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
Location:
description: Location of newly created resource
schema:
type: string
description: HATEOAS links which help the consumer to navigate to resources
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/status'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'413':
$ref: '#/components/responses/413'
'414':
$ref: '#/components/responses/414'
'415':
$ref: '#/components/responses/415'
'500':
$ref: '#/components/responses/500'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
tags:
- CashieringConfig
requestBody:
content:
application/json;charset=UTF-8:
schema:
allOf:
- $ref: '#/components/schemas/authorizationConfigRules'
description: Request object to create new authorization rule for given hotel code.
required: true
delete:
summary: Operation to delete AuthorizationConfigRule.
description: ' <p><strong>OperationId:</strong>deleteAuthorizationConfigRule</p>'
operationId: deleteAuthorizationConfigRule
parameters:
- name: hotelId
in: query
description: Property associated with authorization rule
required: true
style: form
explode: true
schema:
type: array
items:
type: string
- name: roomType
in: query
description: Authorization rule Room type.
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: roomClassHotelId
in: query
required: false
schema:
type: string
- name: roomClassCode
in: query
required: false
schema:
type: string
- name: sourceCodeHotelId
in: query
required: false
schema:
type: string
- name: sourceCode
in: query
required: false
schema:
type: string
- name: rateCategory
in: query
required: false
description: Rate category Code.
schema:
type: string
- name: rateCode
in: query
description: Rate code associated to this rule.
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: guaranteeCode
in: query
description: Guarantee code associated to this rule.
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- $ref: '#/components/parameters/authKey'
- $ref: '#/components/parameters/externalData'
- $ref: '#/components/parameters/x-app-key'
- $ref: '#/components/parameters/x-request-id'
- $ref: '#/components/parameters/x-originating-application'
- $ref: '#/components/parameters/x-hotelid'
- $ref: '#/components/parameters/x-externalsystem'
- $ref: '#/components/parameters/Accept-Language'
responses:
'200':
headers:
Content-Language:
description: Audience language
x-example: en-GB
schema:
type: string
pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
Location:
description: Location of newly created resource
schema:
type: string
description: HATEOAS links which help the consumer to navigate to resources
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/status'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'413':
$ref: '#/components/responses/413'
'414':
$ref: '#/components/responses/414'
'415':
$ref: '#/components/responses/415'
'500':
$ref: '#/components/responses/500'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
tags:
- CashieringConfig
/authorizationConfigRules:
get:
summary: Operation to fetch AuthorizationConfigRules.
description: ' <p><strong>OperationId:</strong>getAuthorizationConfigRules</p>'
operationId: getAuthorizationConfigRules
parameters:
- name: hotelId
in: query
required: false
description: Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.
schema:
type: string
- $ref: '#/components/parameters/authKey'
- $ref: '#/components/parameters/externalData'
- $ref: '#/components/parameters/x-app-key'
- $ref: '#/components/parameters/x-request-id'
- $ref: '#/components/parameters/x-originating-application'
- $ref: '#/components/parameters/x-hotelid'
- $ref: '#/components/parameters/x-externalsystem'
- $ref: '#/components/parameters/Accept-Language'
responses:
'200':
headers:
Content-Language:
description: Audience language
x-example: en-GB
schema:
type: string
pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
description: Response object for FetchAuthorizationConfigRules.
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/authorizationConfigRulesInfo'
'204':
description: AuthorizationConfigRules not found.
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'413':
$ref: '#/components/responses/413'
'414':
$ref: '#/components/responses/414'
'415':
$ref: '#/components/responses/415'
'500':
$ref: '#/components/responses/500'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
tags:
- CashieringConfig
/authorizerGroups:
put:
summary: Operation to change AuthorizerGroups.
description: Operation to change Authorizer Groups. <p><strong>OperationId:</strong>putAuthorizerGroups</p>
operationId: putAuthorizerGroups
parameters:
- $ref: '#/components/parameters/authKey'
- $ref: '#/components/parameters/externalData'
- $ref: '#/components/parameters/x-app-key'
- $ref: '#/components/parameters/x-request-id'
- $ref: '#/components/parameters/x-originating-application'
- $ref: '#/components/parameters/x-hotelid'
- $ref: '#/components/parameters/x-externalsystem'
- $ref: '#/components/parameters/Accept-Language'
responses:
'200':
headers:
Content-Language:
description: Audience language
x-example: en-GB
schema:
type: string
pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
Location:
description: Location of newly created resource
schema:
type: string
description: Response Body.
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/status'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'413':
$ref: '#/components/responses/413'
'414':
$ref: '#/components/responses/414'
'415':
$ref: '#/components/responses/415'
'500':
$ref: '#/components/responses/500'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
tags:
- CashieringConfig
requestBody:
content:
application/json;charset=UTF-8:
schema:
allOf:
- $ref: '#/components/schemas/authorizerGroupsToChange'
description: Request object for changing existing Authorizer Group Configuration.
required: true
post:
summary: Operation to create AuthorizerGroups.
description: Operation to create Authorizer Groups. <p><strong>OperationId:</strong>postAuthorizerGroups</p>
operationId: postAuthorizerGroups
parameters:
- $ref: '#/components/parameters/authKey'
- $ref: '#/components/parameters/externalData'
- $ref: '#/components/parameters/x-app-key'
- $ref: '#/components/parameters/x-request-id'
- $ref: '#/components/parameters/x-originating-application'
- $ref: '#/components/parameters/x-hotelid'
- $ref: '#/components/parameters/x-externalsystem'
- $ref: '#/components/parameters/Accept-Language'
responses:
'201':
headers:
Content-Language:
description: Audience language
x-example: en-GB
schema:
type: string
pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
Location:
description: Location of newly created resource
schema:
type: string
description: HATEOAS links which help the consumer to navigate to resources
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/status'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'413':
$ref: '#/components/responses/413'
'414':
$ref: '#/components/responses/414'
'415':
$ref: '#/components/responses/415'
'500':
$ref: '#/components/responses/500'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
tags:
- CashieringConfig
requestBody:
content:
application/json;charset=UTF-8:
schema:
allOf:
- $ref: '#/components/schemas/authorizerGroups'
description: Request object for creating new Authorizer Group Configuration.
required: true
get:
summary: Operation to fetch AuthorizerGroups.
description: Operation to fetch Authorizer Groups. <p><strong>OperationId:</strong>getAuthorizerGroups</p>
operationId: getAuthorizerGroups
parameters:
- name: hotelIds
in: query
required: true
style: form
explode: true
schema:
type: array
items:
type: string
maxItems: 4000
- name: authorizerGroupsCodes
in: query
description: Codes to be searched.
required: false
style: form
explode: true
schema:
type: array
items:
type: string
maxItems: 4000
- name: wildCard
in: query
required: false
description: Wildcard search on the code.
schema:
type: string
- $ref: '#/components/parameters/authKey'
- $ref: '#/components/parameters/externalData'
- $ref: '#/components/parameters/x-app-key'
- $ref: '#/components/parameters/x-request-id'
- $ref: '#/components/parameters/x-originating-application'
- $ref: '#/components/parameters/x-hotelid'
- $ref: '#/components/parameters/x-externalsystem'
- $ref: '#/components/parameters/Accept-Language'
responses:
'200':
headers:
Content-Language:
description: Audience language
x-example: en-GB
schema:
type: string
pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
description: Response object for fetching Authorizer Groups.
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/authorizerGroups'
'204':
description: AuthorizerGroups not found.
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'413':
$ref: '#/components/responses/413'
'414':
$ref: '#/components/responses/414'
'415':
$ref: '#/components/responses/415'
'500':
$ref: '#/components/responses/500'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
tags:
- CashieringConfig
delete:
summary: Operation to delete AuthorizerGroups.
description: Operation to remove Authorizer Groups. <p><strong>OperationId:</strong>deleteAuthorizerGroups</p>
operationId: deleteAuthorizerGroups
parameters:
- name: authorizerGroup
in: query
required: false
description: Configuration code.
schema:
type: string
- name: hotelId
in: query
# --- truncated at 32 KB (1071 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle-hospitality/refs/heads/main/openapi/oracle-hospitality-cashieringconfig-api-openapi.yml