OPERA Cloud Front Desk Configuration API
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. Compatible with OPERA Cloud release 26.2.0.0. 363 operation(s) documented; base path /fof/config/v1. Harvested verbatim from Oracle's public hospitality-api-docs repository (Swagger 2.0, release 26.2.0.0).
OPERA Cloud Front Desk Configuration API is one of 135 APIs that Oracle Hospitality publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include AccountsReceivablesConfig, CashieringConfig, Credit Card, CommissionConfig, and EndOfDayConfig. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 363 operations across 192 paths, organized into 7 resource areas, and defines 726 schemas. It is described by OpenAPI 2.0, at version 26.2.0.0.
363 operations
192 paths
726 schemas
59 DELETE104 GET68 POST132 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 363
Across 192 paths, the API surfaces 363 operations — 59 DELETE, 104 GET, 68 POST, 132 PUT. They span 7 resource areas: AccountsReceivablesConfig, CashieringConfig, CreditCard, ChainConfig, CommissionConfig, HotelConfig, EndOfDayConfig. Each is listed below with its method, path, parameters, and response codes.
AccountsReceivablesConfig 10
The Accounts Receivables Config module offers the capability of creating, managing, and retrieving of Accounts Receivables configuration.
PUT
/accountTypes
Operation to modify AR Account Types.
POST
/accountTypes
Operation to create AR Account Types.
DELETE
/accountTypes
Operation to remove AR Account types.
GET
/flaggedReasons
Operation to fetch AR flagged reasons.
PUT
/flaggedReasons
Operation to change AR flagged reasons.
POST
/flaggedReasons
Operation to create AR flagged reasons.
DELETE
/flaggedReasons
Operation to remove AR flagged reasons.
GET
/hotels/{hotelId}/ARAccountTypes
Operation to fetch AR account types.
GET
/services/accountsReceivables/status
Operation to ping.
PUT
/upsert/accountTypes
Operation to modify/create AR Account Types.
CashieringConfig 270
Cashiering configurations affect the control and management of financial transactions at your property. You can configure cashiering components for articles for sale, cancellation…
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/cashiersdeprecated
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}/compAuthorizersdeprecated
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}deprecated
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}deprecated
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}deprecated
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}deprecated
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}/exchangeRatesdeprecated
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/customNumbersdeprecated
Operation to create a new template custom number configuration.
GET
/hotels/{hotelId}/template/customNumbers/configuration/{configurationId}deprecated
Operation to fetch template custom number configuration.
PUT
/hotels/{hotelId}/template/customNumbers/configuration/{configurationId}deprecated
Operation to change template custom number configuration.
DELETE
/hotels/{hotelId}/template/customNumbers/configuration/{configurationId}deprecated
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/copydeprecated
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.
PUT
/upsert/fiscalFolioParameters
Operation to create/change FiscalFolioParameters.
PUT
/upsert/fiscalPeriods
Operation to create/change FiscalPeriods.
PUT
/upsert/fiscalYears
Operation to create/change FiscalYears.
PUT
/upsert/folioCopyLegends
Operation to create/change FolioCopyLegends.
PUT
/upsert/folioPrintQueues
Operation to create/change FolioPrintQueues.
PUT
/upsert/folioTypeLegendMappings
Operation to create/change folio type legend mappings config.
PUT
/upsert/folioTypesConfig
Operation to create/change FolioTypesConfig.
PUT
/upsert/guiNumberRules
Operation to create/change GUINumberRules.
PUT
/upsert/hotels/{hotelId}/compBucket/redemption/{redemptionCode}
Operation to Create/Change Comp Bucket Redemption Codes.
PUT
/upsert/hotels/{hotelId}/consumableInventory
Operation to create/change Consumable Inventory.
PUT
/upsert/hotels/{hotelId}/customNumbers/configuration/{configurationId}
Operation to create/change custom number config.
PUT
/upsert/hotels/{hotelId}/transactionDiscounts/{transactionDiscountCode}
Operation to create/change TransactionDiscounts.
PUT
/upsert/hotels/{hotelId}/vouchers
Operation to Create/change a voucher.
PUT
/upsert/noShowPostingRules
Operation to create/change NoShowPostingRules.
PUT
/upsert/numberDescriptions
Operation to create/change NumberDescriptions.
PUT
/upsert/packageArrangementCodes
Operation to create/change PackageArrangementCodes.
PUT
/upsert/revenueBucketCodes
Operation to create/change RevenueBucketCodes.
PUT
/upsert/revenueTypeMapping
Operation to create/change RevenueTypeMapping.
PUT
/upsert/routingInstructions
Operation to create/change RoutingInstructions.
PUT
/upsert/transactionDiversionRules
Operation to create/change TransactionDiversionRules.
CreditCard 16
The Credit Card Internal Service contains operations used internally by OPERA Cloud.
GET
/authorizationRule
Operation to fetch AuthorizationRule.
GET
/cardReaderDelimiters
Operation to fetch CardReaderDelimiters.
GET
/creditCardInfo
Operation to fetch CreditCardInfo.
GET
/creditCardTypes/validate
Operation to validate CreditCardType.
GET
/creditCards/decode
Operation to Decode Card.
GET
/creditCards/readerDevices
Operation to fetch CreditCardReaderDevices.
POST
/creditCards/vaultedId
Operation to fetch CreditCardUniqueId.
PUT
/hotels/{hotelId}/interfaces/{interfaceLogoId}/customData
Operation to update hotel interface custom data.
GET
/hotels/{hotelId}/interfaces/{interfaceLogoId}/customData
Operation to fetch hotel interface custom data.
GET
/prepaidCarddeprecated
Operation to fetch Prepaid Card.
POST
/prepaidCard/search
Operation to fetch Prepaid Card.
GET
/prepaidCardBalancedeprecated
Operation to fetch prepaid card balance.
POST
/prepaidCardBalance/search
Operation to fetch prepaid card balance.
GET
/prepaidCards
Operation to fetch PrepaidCards.
PUT
/secureApplicationSettings
Operation to change AR SecureApplicationSettings.
GET
/services/creditCard/status
Operation to ping.
ChainConfig 36
These APIs will allow you to configure front office related configuration related to Administration.
GET
/autoFolioSettlementTypes
Get Auto Folio Settlement Types
POST
/autoFolioSettlementTypes
Create Auto Folio Settlement Types
PUT
/autoFolioSettlementTypes/{code}
Change Auto Folio Settlement Types
DELETE
/autoFolioSettlementTypes/{code}
Delete Auto Folio Settlement Types
GET
/cashierShifts/dropLocations
Get Template Cashier Shift Drop Locations
POST
/cashierShifts/dropLocations
Create Template Cashier Shift Drop Locations
PUT
/cashierShifts/dropLocations/{dropLocationId}
Change Template Cashier Shift Drop Locations
DELETE
/cashierShifts/dropLocations/{dropLocationId}
Delete Template Cashier Shift Drop Locations
GET
/contractBillingInstructions
Get Contract Billing Instructions
POST
/contractBillingInstructions
Create Contract Billing Instructions
PUT
/contractBillingInstructions/{contractBillingInstructionsId}
Change Contract Billing Instructions
DELETE
/contractBillingInstructions/{contractBillingInstructionsId}
Delete Contract Billing Instructions
GET
/customTaxTypes
Get Custom Tax Types
POST
/customTaxTypes
Create Custom Tax Types
PUT
/customTaxTypes/{taxTypeCode}
Change Custom Tax Types
DELETE
/customTaxTypes/{taxTypeCode}
Delete Custom Tax Types
GET
/fiscalGuestTypes
Get Fiscal Guest Types
POST
/fiscalGuestTypes
Create Fiscal Guest Types
PUT
/fiscalGuestTypes/{fiscalGuestTypeCode}
Change Fiscal Guest Types
DELETE
/fiscalGuestTypes/{fiscalGuestTypeCode}
Delete Fiscal Guest Types
GET
/fiscalRegions
Get Fiscal Regions
POST
/fiscalRegions
Create Fiscal Regions
PUT
/fiscalRegions/{regionCode}
Change Fiscal Regions
DELETE
/fiscalRegions/{regionCode}
Delete Fiscal Regions
GET
/hotels/{hotelId}/cashierShifts/dropLocations
Get Cashier Shift Drop Locations
POST
/hotels/{hotelId}/cashierShifts/dropLocations
Create Cashier Shift Drop Locations
PUT
/hotels/{hotelId}/cashierShifts/dropLocations/{dropLocationId}
Change Cashier Shift Drop Locations
DELETE
/hotels/{hotelId}/cashierShifts/dropLocations/{dropLocationId}
Delete Cashier Shift Drop Locations
GET
/taxCategories
Get Tax Category Codes
POST
/taxCategories
Create Tax Category Codes
PUT
/taxCategories/{taxCategoryCode}
Change Tax Category Codes
DELETE
/taxCategories/{taxCategoryCode}
Delete Tax Category Codes
GET
/taxOffices
Get Tax Offices
POST
/taxOffices
Create Tax Offices
PUT
/taxOffices/{taxOfficeId}
Change Tax Offices
DELETE
/taxOffices/{taxOfficeId}
Delete Tax Offices
CommissionConfig 15
These Commission APIs allow you to get, update, and remove commissions on an Account Receivable (AR) profile in OPERA Cloud.
GET
/commissionCodes
Operation to fetch commission codes.
PUT
/commissionCodes
Operation to change commission codes.
POST
/commissionCodes
Operation to create commission codes.
DELETE
/commissionCodes
Operation to remove commission codes.
GET
/configBankAccounts
Operation to fetch config bank accounts.
PUT
/configBankAccounts
Operation to change config bank accounts.
DELETE
/configBankAccounts
Operation to remove config bank accounts.
POST
/configBankAccounts
Operation to create config bank accounts.
GET
/hotels/{hotelId}/commissionCode/{commissionCode}
Operation to fetch commission code.
GET
/services/commissionConfig/status
Operation to ping.
GET
/stopProcessingReasons
Operation to fetch stop processing reasons.
PUT
/stopProcessingReasons
Operation to change stop processing reasons.
POST
/stopProcessingReasons
Operation to create stop processing reasons.
DELETE
/stopProcessingReasons
Operation to remove stop processing reasons.
PUT
/upsert/configBankAccounts
Operation to create/change config bank accounts.
HotelConfig 15
These APIs will allow you to configure front office related configuration related to Administration.
GET
/hotels/{hotelId}/trackItActions
Get Track it Actions
POST
/hotels/{hotelId}/trackItActions
Create Track it Actions
PUT
/hotels/{hotelId}/trackItActions/{actionCode}
Change Track it Actions
DELETE
/hotels/{hotelId}/trackItActions/{actionCode}
Delete Track it Actions
GET
/hotels/{hotelId}/trackItLocations
Get Track it Locations
POST
/hotels/{hotelId}/trackItLocations
Create Track it Locations
PUT
/hotels/{hotelId}/trackItLocations/{locationCode}
Change Track it Locations
DELETE
/hotels/{hotelId}/trackItLocations/{locationCode}
Delete Track it Locations
GET
/hotels/{hotelId}/trackItTypes
Get Track it Types
POST
/hotels/{hotelId}/trackItTypes
Create Track it Types
PUT
/hotels/{hotelId}/trackItTypes/{typeCode}
Change Track it Types
DELETE
/hotels/{hotelId}/trackItTypes/{typeCode}
Delete Track it Types
PUT
/hotels/{sourceHotelId}/trackItActions/copy
Copy Track it Actions
PUT
/hotels/{sourceHotelId}/trackItLocations/copy
Copy Track it Locations
PUT
/hotels/{sourceHotelId}/trackItTypes/copy
Copy Track it Types
EndOfDayConfig 1
The EndOfDay Configuration module offers the capability of creating, managing, and retrieving a properties End of Day configuration.
GET
/services/endOfDayConfig/status
Operation to ping.
Schemas 726
The contract defines 726 schemas that model the data the API accepts and returns. The most detailed are aRInvoiceType (54 properties), reservationInfoType (52 properties), generalInfoType (43 properties), folioTypeConfigType (38 properties). Each schema is shown below with its type and property counts.
arAccountTypes
object
Request object for changing account types.
3 properties
aRAccountTypesType
array
Holds collection of account types
aRAccountTypeType
object
Information which uniquely identifies account type
12 properties
statementType
string
The Types of Statements that can be used on an Account Type.
aRPrintPreferenceType
string
Preference type when separate folios has to be included in the statement
aRFinanceChargeType
object
Finance charges will allow user to post a flat amount or percentage finance charge based on user-defined cycle.
5 properties
aRReminderCycleType
object
When reminder letters needs to be generated. user can choose from End of month or Day cycle
2 properties
aREndOfMonthCycleType
object
Reminder letters will be generated at the end of each month if user specifies this element
2 properties
aRDaysCycleType
array
Reminder letters will be generated based on the number of days for which the account has had an outstanding balance
aRDaysReminderCycleType
object
Custom reminder cycles determine which to generated statements for the account with outstanding balances
3 properties
uniqueID_Type
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
2 properties
links
array
instanceLink
object
Metadata describing link description objects that MAY appear in the JSON instance representation.
7 properties
warningsType
array
Used in conjunction with the Success element to define a business error.
warningType
object
Used when a message has been successfully processed to report any warnings or business errors that occurred.
10 properties
status
object
Response Body.
2 properties
exceptionDetailType
object
Complex type that contains error details for a REST call.
9 properties
2 required
errorInstance
object
Complex type that contains error instance details for a REST call.
7 properties
2 required
articles
object
Request to change articles.
4 properties
codeType
string
Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.
articlesType
array
Holds collection of articles.
articleInfoType
object
Information regarding an article.
10 properties
currencyAmountType
object
A monetary value expressed with a currency code.
2 properties
articlePostItType
object
Post it information of an article.
2 properties
colorType
string
Color configuration type. This color configuration provides a visual category of entities.
articlesInfo
object
3 properties
authorizationConfigRules
object
3 properties
authorizationConfigRulesType
array
List of AuthorizationRuleType.
authorizationConfigRuleType
object
Authorization configuration Rule Type.Authorization Rules specify the rule (or rules) that the property uses for credit card authorizations
14 properties
roomClassCodeInfoType
object
Code of the room class type.
3 properties
sourceCodeInfoType
object
4 properties
rateCategoryType
object
This type represents the rate category type.
2 properties
authorizationConfigRulesInfo
object
3 properties
authorizationRule
object
3 properties
authorizationRuleType
object
Configured rule for computing the amount to authorize.
3 properties
authorizerGroupsToChange
object
3 properties
authorizerGroupsCriteriaType
object
Criteria to change authorizer group.
2 properties
authorizerGroupsType
array
Authorizer Group
authorizerGroupType
object
A representation of the information contained by a Authorizer Group.
6 properties
authorizerTrxLimitsType
array
Set of Transaction Limit configured for the Authorizer Group.
authorizerTrxLimitType
object
A representation of the information of Transaction Limit.
5 properties
authTransactionCodesType
array
List of Transaction codes info.
codeDescriptionType
object
This contains a generic code and description information.
2 properties
authBillingInstructionsType
array
Set of Billing Instruction codes.
authorizerGroups
object
3 properties
autoFolioSettlementTypesDetails
object
Response object for fetching Auto Folio Settlement Types.
3 properties
autoFolioSettlementTypesType
array
List of Auto Folio Settlement Types.
autoFolioSettlementTypeType
object
Contains Common Master configuration detail.
4 properties
translationTextType2000
object
Contains Multiple translated texts and language codes.
2 properties
translationsTextType
array
Language code for the translation.
autoFolioSettlementTypesCriteria
object
Request object for creating Auto Folio Settlement Types.
3 properties
autoFolioSettlementTypesToBeChanged
object
Request object for changing Auto Folio Settlement Types.
3 properties
budgetForecastToDelete
object
3 properties
deleteSegmentCodeBudgetInformationType
object
Holds segment and segment code information to delete.
7 properties
deleteSegmentCodeInfoType
object
Holds segment code information to delete.
7 properties
codeListType
array
segmentNameType
string
Forecast.
budgetInfoDeleteType
string
Daily information.
monthNoType
string
December.
budgetForecastInformation
object
3 properties
budgetForecastInformationType
object
Holds budget forecast information for included segment types.
5 properties
budgetForecastMarketInfoType
object
Budget Forecast information for budget segment codes.
2 properties
marketCodeInformationType
object
Budget Forecast information for budget segment code.
8 properties
revenueNightsInfoType
object
Revenue information for a segment code. Holds total and monthly revenue information.
3 properties
monthlyRevenueNightsInfoType
object
Holds monthly revenue summary information
3 properties
revenueNightsVarianceInfoType
array
Monthly Revenue Variance information.
monthlyRevenueNightsVarianceInfoType
object
Revenue Variance information for a segment code for a month.
3 properties
marketCodeTotalInformationType
object
Budget Forecast information for segment.
6 properties
budgetForecastRateInfoType
object
Budget Forecast information for budget segment codes.
2 properties
rateCodeInformationType
object
Budget Forecast information for budget segment code.
8 properties
rateCodeTotalInformationType
object
Budget Forecast information for segment.
6 properties
budgetForecastCustomInfoType
object
Budget Forecast information for budget Custom codes.
2 properties
customCodeInformationType
object
Budget Forecast information for Custom segment code.
8 properties
customValueInfoType
object
Value information for a CUSTOM segment code. Holds total and monthly Value information.
2 properties
monthlyValueInfoType
object
Holds monthly value summary information
2 properties
customVarianceInfoType
array
Monthly Value Variance information.
monthlyCustomVarianceInfoType
object
Value Variance information for a CUSTOM code for a month.
2 properties
customCodeTotalInformationType
object
Budget Forecast information for Custom segment.
6 properties
budgetForecastTransactionInfoType
object
Budget Forecast information for budget Transaction codes.
2 properties
transactionCodeInformationType
object
Budget Forecast information for Transaction segment code.
9 properties
transactionInfoType
object
Revenue information for a TRANSACTION segment code. Holds total and monthly revenue information.
2 properties
monthlyTransactionInfoType
object
Holds monthly Revenue summary information
2 properties
transactionVarianceInfoType
array
Monthly Revenue Variance information.
monthlyTransactionVarianceInfoType
object
Revenue Variance information for a segment code for a month.
2 properties
transactionCodeTotalsInformationType
object
Budget Forecast totals information for Transaction segment.
6 properties
budgetForecastCateringInfoType
object
Budget Forecast information for budget Catering codes.
2 properties
cateringCodeInformationType
object
Budget Forecast information for Catering segment code.
9 properties
cateringInfoType
object
Revenue and Covers information for a catering segment code. Holds total and monthly information.
3 properties
monthlyCateringInfoType
object
Holds monthly Catering summary information
3 properties
cateringVarianceInfoType
array
Monthly Variance information.
monthlyCateringVarianceInfoType
object
Variance information for a catering segment code for a month.
3 properties
cateringTotalsInformationType
object
Budget Forecast totals information for Catering segment.
6 properties
budgetForecastInformationBase
object
3 properties
budgetForecastInformationBaseType
object
Holds budget forecast information for included segment types.
7 properties
budgetForecastMarketInfoBaseType
object
Budget Forecast information for budget segment codes.
3 properties
marketCodeInformationBaseType
object
Budget Forecast information for budget segment code.
4 properties
budgetForecastRateInfoBaseType
object
Budget Forecast information for budget segment codes.
3 properties
rateCodeInformationBaseType
object
Budget Forecast information for budget segment code.
4 properties
budgetForecastCustomInfoBaseType
object
Budget Forecast information for budget Custom codes.
2 properties
customCodeInformationBaseType
object
Budget Forecast information for Custom segment code.
4 properties
budgetForecastTransactionInfoBaseType
object
Budget Forecast information for budget Transaction codes.
2 properties
transactionCodeInformationBaseType
object
Budget Forecast information for Transaction segment code.
5 properties
budgetForecastCateringInfoBaseType
object
Budget Forecast information for budget Catering codes.
3 properties
cateringCodeInformationBaseType
object
Budget Forecast information for Catering segment code.
5 properties
cardReaderDelimiters
object
3 properties
cardReaderDelimitersType
object
Configured delimiters for parsing a card track data based on a particular card reader device.
16 properties
cashiersDetails
object
9 properties
cashiersType
array
Details about a cashier.
cashierType
object
Cashiers Information.
14 properties
cashierTypeType
string
The types of cashier.
templateCashierShiftDropLocationsDetails
object
Response object for fetching Template Cashier Shift Drop Locations.
3 properties
templateCashierShiftDropLocationsType
array
List of Template Cashier Shift Drop Locations.
templateCashierShiftDropLocationType
object
Contains Common Master configuration detail.
4 properties
templateCashierShiftDropLocationsCriteria
object
Request object for creating Template Cashier Shift Drop Locations.
3 properties
templateCashierShiftDropLocationsToBeChanged
object
Request object for changing Template Cashier Shift Drop Locations.
3 properties
cashiers
object
3 properties
cashierNumber
object
3 properties
cashierId
number
The Cashier ID of the Cashier who is currently processing the transaction(s).
collectingAgentTaxes
object
3 properties
collectingAgentTaxesType
object
Type which holds collection of Agent Tax details
2 properties
collectingAgentTaxType
object
Type which holds Collecting Agent Taxes primary details.
11 properties
taxCodeSeqType
integer
Primary Key Sequence.
commissionCodesSummary
object
Response object for fetching commission codes.
3 properties
commissionCodesSummaryType
array
Commission code details.
commissionCodeSummaryInfoType
object
Commission codes summary details.
9 properties
commissionBasedOnType
string
Commission based on Revenue.
commissionCodes
object
Request object to update commission codes.
3 properties
commissionCodesType
array
Commission code details object.
commissionCodeInfoType
object
Commission code info.
9 properties
commissionCodeHoldStatusType
object
Commission Code Hold Status type
3 properties
commissionPaidDetailsType
object
Commission paid details.
5 properties
commissionCalculationType
object
Commission calculation type based on details.
2 properties
revenueBasedCommissionType
array
Revenue based commission details.
commissionCodeTransactionType
object
Revenue based commission details.
4 properties
reservationBasedCommissionType
object
Reservation based commission details.
1 property
compAuthorizer
object
3 properties
compAuthorizerType
object
Information related to comp authorizers.
16 properties
aRAccountType
object
Accounts Receivabales Account details type.
33 properties
profileId
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
6 properties
addressInfoType
object
Provides address information.
3 properties
addressType
object
Provides address information.
19 properties
countryNameType
object
Code for a country or a nationality.
2 properties
emailInfoType
object
Information on an email for the customer.
3 properties
emailType
object
Information on an email for the customer.
11 properties
telephoneInfoType
object
Information on a telephone number for the customer.
3 properties
telephoneType
object
Information on a telephone number for the customer.
12 properties
commentInfoType
object
Comment related to the profile/reservation.
8 properties
commentType
object
An indication of a new paragraph for a sub-section of a formatted text message.
19 properties
formattedTextTextType
object
Provides text and indicates whether it is formatted or not.
2 properties
traceType
object
16 properties
traceTimeInfoType
object
4 properties
dateTimeSpanType
object
Allows for a choice in description of the amount of time spanned by this type. EndDate specifies a specific date, while Duration provides a measure of time to…
2 properties
reservationId
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
6 properties
traceResolveType
object
2 properties
fixedChargesType
array
Holds fixed charge detail.
fixedChargeType
object
Holds fixed charge information.
8 properties
fixedChargeScheduleType
object
Holds schedule of fixed charge.
5 properties
fixedChargeFrequencyType
string
Yearly.
fixedChargeDetailType
object
Fixed charge amount could be specified by flat fee or be a percentage of the rate amount.
7 properties
indicatorsType
array
Collection of lamp indicators.
indicatorType
object
Lamp indicator Type.
2 properties
aRAgingInfoType
object
Information regarding the aging balances for an account.
2 properties
aRBalanceType
object
Balance information for AR.
3 properties
aRAgingType
object
Aging information for an Aging Bucket.
6 properties
dateRangeType
object
Date Range with Start and End dates.
2 properties
aRYearViewInfoType
object
Information regarding Year View balances for an account.
2 properties
aRYearViewType
object
Year information for an Year View.
3 properties
aRInvoicesType
array
A collection of AR Invoices.
aRInvoiceType
object
Details of an AR Invoice.
54 properties
marketCodeInfoType
object
4 properties
reservationInfoType
object
The Reservation class contains the current reservation being created or altered.
52 properties
reservationIdList
array
Unique Id that references an object uniquely in the system.
externalReferencesType
array
This type contains unique information of external reference.
externalReferenceType
object
This type contains unique information of external reference.
3 properties
stayInfoType
object
Details on the Room Stay including Guest Counts, Time Span of this Room Stay, pointers to Res Guests, guest Memberships, Comments and Special Requests pertaini…
36 properties
timeSpanType
object
Allows for a choice in description of the amount of time spanned by this type. EndDate specifies a specific date, while Duration provides a measure of time to…
3 properties
resExpectedTimesType
object
Holds the Arrival and Departure Time Information
2 properties
pointsType
object
The Redeem Points contains the number of points required to book a room type.
2 properties
reservationBlockType
object
Key information about the block for a reservation.
3 properties
blockIdList
array
Unique Id that references an object uniquely in the system.
resGuaranteeType
object
Validations type record returned after Validations are done.
3 properties
promotionType
object
Type to specify a rate promotion. Usually attached to a reservation to indicate a specific promotion is applied to the reservation.
3 properties
guestHousekeepingServiceRequestType
string
Possible values for the Guest Service Status.
resGuestInfoType
object
Specifies Company or Travel Agent profile using IATA or Corp. No.
30 properties
membershipInfoType
object
The Membership object identifies the frequent customer reward program.
8 properties
namePrefixType
string
Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.)
givenNameType
string
Given name, first name or names
surnameType
string
Family name, last name.
phoneNumberType
string
Phone number
basicEmailType
string
Email address
vIPType
object
The supplier's ranking of the customer.
2 properties
addressSearchType
object
Address Details such as city, state, country, postal code etc.
6 properties
anonymizationType
object
Provides information about guest's anonymization status.
2 properties
anonymizationStatusType
string
Guest has been anonymized.
resAccompanyGuestListType
array
Collection of accompany guests
resAccompanyGuestInfoType
object
5 properties
profileIdList
array
Unique Id that references an object uniquely in the system.
resGuestExternalInfoType
object
Specifies Company or Travel Agent profile using IATA or Corp. No.
2 properties
guestLastStayInfoType
object
Contains last stay related details of the guest.
4 properties
nameTypeType
string
resSharedGuestListType
array
Collection of shared guest reservations.
resSharedGuestInfoType
object
Contains information regarding the share reservation.
4 properties
resAttachedProfileListType
array
resAttachedProfileType
object
3 properties
resProfileTypeType
string
reservationPaymentMethodType
object
7 properties
resPaymentCardType
object
Information on a credit card for the customer.
19 properties
cardTypeType
string
This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method.
cardProcessingType
string
cardNumberTypeType
string
Simple type for indicating if credit card number is tokenized.
reservationFolioWindowsType
array
Collection of reservation folio windows.
reservationFolioWindowType
object
Folio window view which holds the set of folios for a reservation.
4 properties
payeeInfoType
object
Payee information.
7 properties
aRAccountShortInfoType
object
Accounts Receivabales Account details type charged for batched posting.
4 properties
aRAccountStatusType
object
Type for the Account Status. Status can be restricted and a message/description added to the Account.
3 properties
housekeepingRoomStatusType
string
Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOf…
searchMatchesType
array
List of Generic Name-Value-Pair Parameters used for super search matches.
searchMatchType
object
Search match indicating attribute and the matching value.
2 properties
sourceOfSaleType
object
Point of Sale of reservation. Identifies the entity/channel who made the reservation.
2 properties
waitlistResType
object
Information regarding why reservation is being /has been waitlisted.
6 properties
reservationQueueInformationType
object
Information regarding the Date, Duration and Priority of the reservation on Queue for Check in.
6 properties
queueTextInfoType
object
Information regarding the message sent to guest.
2 properties
resHousekeepingType
object
Holds housekeeping turndown service information for the room.
7 properties
facilityTaskType
object
Information regarding facility task on a reservation.
3 properties
housekeepingTaskCodeType
object
Information related to a Task Code. Task Codes are used to generate task sheets in Rooms Management.
7 properties
facilityCodesType
array
List of the facility codes.
facilityCodeType
object
Facility Housekeeping Code, its description and quantity.
3 properties
resCashieringType
object
Cashiering Information for the reservation.
14 properties
resRevenueBalanceType
object
Revenue and Balance Amount summary for the reservation.
9 properties
billingPrivilegesType
object
This stores the information for Bed Tax Reporting. Mainly used in Maldives.
13 properties
reservationTaxTypeInfo
object
Provides information about the Tax Type.
9 properties
bedTaxReportingType
object
This stores the information for Bed Tax Reporting. Mainly used in Maldives.
5 properties
folioTextsType
array
This stores the description for the type of tax calculation especially with tax exemption, etc.
resPeriodicFolioType
object
Information regarding periodic folios set on the reservation.
3 properties
resCompAccountingType
object
Information regarding comp accounting on the reservation.
3 properties
resPreConfiguredRoutingInstrType
object
Instruction to attach Pre-Configured Routing Instructions to a Reservation.
4 properties
authorizerInfoType
object
Authorizer Information
5 properties
taxTypeType
object
Provides information about the Tax Type.
9 properties
reservationDepositType
object
Reservation Deposit Type.
7 properties
reservationAllowedActionsType
array
Allowed action.
reservationAllowedActionType
string
Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation.
reservationInterfaceStatusType
object
Hotel Interface Type for a reservation and status of the various services
3 properties
hotelInterfaceType
object
8 properties
hotelInterfaceTypeType
string
XML Posting Interface
hotelInterfaceStatusType
string
Status of the Hotel Interface either STOPPED or RUNNING.
interfaceRightsStatusType
object
4 properties
reservationTurndownInfoType
object
Turndown information for a reservation
2 properties
turndownStatusType
string
Simple type for turndown status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Required, Not Required and Complet…
resMobileNotificationsType
object
Contains the status of Room Ready and Key Ready messages.
5 properties
communicationStatusType
string
Enum to denote the Status of Readiness messages sent to Guest Devices.
resCommunicationType
object
Communication details for a reservation.
2 properties
advanceCheckInType
object
Information relating to Reservation's Advance Checked In state and Expected Time of Return
3 properties
pMS_ResStatusType
string
This reservation is in checked in status and the business date is past departure date. This could occur when ORS and PMS are in same environment.
resAccessRestrictionType
string
Indicates any Updates/Changes on the reservation as well as Reservation Cancellation are not allowed.
commissionPayoutToType
string
cashierInfoType
object
Cashier information. Contains Id and Name details of the cashier.
2 properties
trxInfoType
object
Transaction codes info.
10 properties
profileInfoType
object
Provides information about attached profiles to the block.
5 properties
customNumberType
string
Custom number
fiscalResponseType
object
Provides information which is used for fiscal response processing.
2 properties
folioStatusType
string
The Folio Status Example: DEPOSIT folio, VOID folio or the default OK folio status.
aRInvoiceCategory
string
aRPaymentsType
array
A collection of AR Payments.
aRPaymentType
object
Details of an AR Payment.
18 properties
compAuthorizerHeaderType
object
Detail information related to comp authorizers.
3 properties
compAuthorizerDetailType
object
Detail information related to comp authorizers.
6 properties
compTypesCriteria
object
Request object for creating CompTypes.
3 properties
compTypesType
array
List of Comp Types.
compTypeType
object
Information representation of Comp Type.
4 properties
compTypesToBeChanged
object
Request object for changing Comp Types.
3 properties
compTypesStatus
object
Response Body.
2 properties
bankAccountsInfo
object
Response for fetching Bank Accounts
3 properties
configBankAccountsType
array
List of bank accounts.
configBankAccountType
object
Indentifier for a Bank Account.
25 properties
commissionConfigPaymentMethodType
string
This value of the enum is used for Payment methods
bankAccounts
object
Request object to edit Bank Accounts
5 properties
contractBillingInstructionsDetails
object
Response object for fetching Contract Billing Instructions.
3 properties
contractBillingInstructionsType
array
List of Contract Billing Instructions.
contractBillingInstructionType
object
Contains Common Master configuration detail.
5 properties
contractBillingInstructionsCriteria
object
Request object for creating Contract Billing Instructions.
3 properties
contractBillingInstructionsToBeChanged
object
Request object for changing Contract Billing Instructions.
3 properties
creditCardInfo
object
3 properties
creditCardTypeValidationStatus
object
4 properties
decodedCard
object
3 properties
creditCardReaderDevices
object
3 properties
listOfDevicesType
array
creditCardReaderDevicesType
object
Supported credit card reader devices.
4 properties
creditCardUniqueIdRQ
object
Request for fetching credit card unique id.
2 properties
creditCardUniqueIdType
object
Information about the credit card unique id.
10 properties
creditCardServiceActionType
string
Instruction to call direct vendor service.
creditCardUniqueId
object
3 properties
creditCardUniqueIdInfoType
object
Information about the credit card unique id.
13 properties
currencyExchangeServiceTaxes
object
3 properties
currencyExchangeServiceTaxesType
array
List of currency exchange service taxes
currencyExchangeServiceTaxType
object
Currency exchange service tax identification details
9 properties
customChargeExemptionsConfig
object
Response object for fetching Custom Charge Exemptions.
3 properties
customChargeExemptionsConfigType
array
Holds Exemption details.
customChargeExemptionConfigType
object
Provides information about Exemptions.
9 properties
customTaxTypesDetails
object
Response object for fetching Custom Tax Types.
3 properties
customTaxTypesType
array
List of Custom Tax Types.
customTaxTypeType
object
Contains Common Master configuration detail.
4 properties
customTaxTypesCriteria
object
Request object for creating Custom Tax Types.
3 properties
customTaxTypesToBeChanged
object
Request object for changing Custom Tax Types.
3 properties
dailyPlanCodes
object
3 properties
dailyPlanCodesType
array
Details for daily plan code along with associated transaction codes.
dailyPlanCodeType
object
Generic Type to specify unique/primary id for the code. mostly used for Hotel level configuration codes removal request.
8 properties
defaultPaymentMethodRule
object
3 properties
paymentMethodValidationRuleType
object
Payment method card validation rules.
5 properties
cardRangesType
array
Card number start and end range.
cardRangeType
object
Card number start and end range.
2 properties
cardValidationRuleTypeType
string
Defines rules to be used for card validation.
exchangeRatesDetails
object
3 properties
exchangeRateType
object
Exchange rate configuration type.
11 properties
currencyExchangeType
string
E-certificate conversion.
statusTypes
string
Defines status in terms of time.
exchangeRates
object
3 properties
expenseArrangementCodes
object
3 properties
expenseArrangementCodesType
array
Details for expense arrangement code along with associated transaction codes.
expenseArrangementCodeType
object
Generic Type to specify unique/primary id for the code. mostly used for Hotel level configuration codes removal request.
7 properties
expenseArrangementCodesCopy
object
3 properties
copyConfigurationCodeType
object
Information needed to copy configuration code from one property to the other.
3 properties
fiscalFolioParameters
object
3 properties
fiscalFolioParametersType
array
Holds Fiscal Folio Parameter details.
fiscalFolioParameterType
object
Provides information about the Fiscal Folio Parameter.
7 properties
fiscalGuestTypesDetails
object
Response object for fetching Fiscal Guest Types.
3 properties
fiscalGuestTypesType
array
List of Fiscal Guest Types.
fiscalGuestTypeType
object
Contains Common Master configuration detail.
4 properties
fiscalGuestTypesCriteria
object
Request object for creating Fiscal Guest Types.
3 properties
fiscalGuestTypesToBeChanged
object
Request object for changing Fiscal Guest Types.
3 properties
fiscalPeriodsEdit
object
3 properties
fiscalPeriodsEditType
array
List of Fiscal Periods.
fiscalPeriodEditType
object
Values of the old primary key.
4 properties
fiscalPeriodType
object
Fiscal Period Type
9 properties
yearTypeType
string
Defined Values for Fiscal Year Type.
fiscalPeriods
object
4 properties
fiscalPeriodsType
array
List of Fiscal Periods.
cycleFiscalPeriodsType
array
List of Cycle Fiscal Periods.
cycleFiscalPeriodType
object
Fiscal Year Cycle Period creation type.
5 properties
cyclePeriodType
string
Signifies Calendar Period
fiscalPeriodsInfo
object
3 properties
fiscalRegionsDetails
object
Response object for fetching Fiscal Regions.
3 properties
fiscalRegionsType
array
List of Fiscal Regions.
fiscalRegionType
object
Contains Common Master configuration detail.
4 properties
fiscalRegionsCriteria
object
Request object for creating Fiscal Regions.
3 properties
fiscalRegionsToBeChanged
object
Request object for changing Fiscal Regions.
3 properties
fiscalYears
object
3 properties
fiscalYearsType
array
List of Fiscal Years.
fiscalYearType
object
Fiscal Year Type
8 properties
arFlaggedReasons
object
Response for fetching Flagged Reasons.
3 properties
aRFlaggedReasonsType
array
List of the Flagged Reason to be configured or fetched
aRFlaggedReasonType
object
Details for AR Flagged Reason.
5 properties
folioArrangementCodes
object
3 properties
folioArrangementCodesType
array
Details for folio arrangement code along with associated transaction codes.
folioArrangementCodeType
object
Generic Type to specify unique/primary id for the code. mostly used for Hotel level configuration codes removal request.
8 properties
folioArrangementCodesCopy
object
3 properties
folioCopyLegend
object
3 properties
folioCopyLegendType
object
Search criteria to fetch folio copy legends information.
6 properties
folioCopyLegends
object
3 properties
folioCopyLegendsType
array
Details about folio copy legends.
folioPrintQueues
object
3 properties
folioPrintQueuesType
array
List of folio print queues
folioPrintQueueType
object
Folio Print queue identification details
7 properties
folioTypeLegendMappingsConfigDetails
object
Response object for fetch folio type legend mapping.
3 properties
folioTypeLegendMappingsConfigType
array
Details about folio type legened mapping.
folioTypeLegendMappingConfigType
object
Folio type legened mapping information.
5 properties
folioTypeLegendMappingConfigCriteria
object
Request object to create folio type legend mapping information.
3 properties
folioTypeLegendMappingConfigToBeChanged
object
Request object to edit folio type legend mapping information.
3 properties
folioTypeLegendMappingConfigStatus
object
Response Body.
2 properties
folioTypesConfig
object
3 properties
folioTypesConfigType
array
Information details of the Folio Type Names.
folioTypeConfigType
object
Information detail for uniquely identifying a Folio Type Name.
38 properties
folioReportsType
array
Information details of the Folio Reports associated with Folio Type Name.
folioReportType
object
Folio Report associated with the Folio Type Name. Includes Name Of the folio report,the Group for Folio Type Name belongs to and the Language Code for which th…
3 properties
folioReportGroupType
string
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 f…
folioTypeProfileAttributes
string
Profile is not configured with Tax Id.
foreignCurrencies
object
3 properties
foreignCurrenciesType
array
List of the Foreign Currencies to be configured or fetched
foreignCurrencyType
object
Provides information about the Foreign Currency Code.
9 properties
currencyLimitType
object
Type used for Currency Limits.
3 properties
postingLimitType
string
Simple Type for Posting Limit Types.
currencyHandlingType
string
Simple Type for Posting Limit Types.
hotelTransactionGenerates
object
3 properties
hotelTransactionGeneratesSetupType
object
Defines the Generates Setup and its Calculation Rules.
7 properties
generateCalculationBucketsType
object
Defines the buckets the generated amount can be added to.
3 properties
generatesType
array
Defines the Generate and its Calculation Rules.
generateType
object
Defines the Generate and its Calculation Rules
6 properties
generateCalcRuleType
object
Defines the Calculation Rule for the generate.
10 properties
percentageGenerateType
object
Defines percentage rule for generates.
3 properties
generateCalcBucketType
string
Generates calculation bucket/group. Percentage generates are calculated against amount in one of the the calculation bucket.
flatAmtGenerateType
object
Defines Flat Amount rule for generates.
1 property
functionArgumentsType
array
Collection of function arguments and their corresponding values.
functionArgumentType
object
This type provided details of a function argument and the value it holds.
5 properties
taxTypesGenerateType
array
Defines the Calculation Rule for the Tax Type for a specific date schedule
taxTypeGenerateType
object
Defines the Calculation Rules for the Tax Type
3 properties
taxTypeGenerateScheduleType
object
Defines the Calculation Rule for the Tax Type for a specific date schedule
2 properties
taxTypeCalcRuleType
object
Defines the Calculation Rule for the generate.
5 properties
uDFGenerateType
object
Defines UDF rule for generates.
3 properties
doNotPostGenerateType
object
Existance of this type indicates that the generate will not be effective. This is mainly used on Tax Type based generates rule.
generateRoundingMethodType
string
This type is only available for properties with zero decimals. If a property is using decimal points, this type will not be available. The rounding methods whi…
generatePostingRuleType
object
Advance Generates posting rules.
2 properties
generateAdjustmentTypeType
string
Generates calculation bucket/group. Percentage generates are calculated against amount in one of the the calculation bucket.
generateLevelType
string
Defines the level from which the generates was created.
groupArrangementCodes
object
3 properties
groupArrangementCodesType
array
Details for group arrangement code along with associated transaction codes.
groupArrangementCodeType
object
Generic Type to specify unique/primary id for the code. mostly used for Hotel level configuration codes removal request.
8 properties
groupArrangementCodesCopy
object
3 properties
gUINumberRulesDetails
object
3 properties
gUINumberRules
array
List of GUI number rules
gUINumberRule
object
GUI Number rule
8 properties
gUINumberPeriodType
string
Period set November-December
adjustmentCodes
object
3 properties
adjustmentCodesType
array
Holds Adjustment Code details.
adjustmentCodeType
object
Provides information about Adjustment Codes.
8 properties
adjustmentReasonCodeType
string
Defines values for Adjustment reason codes. e.g. ADJ for adjustment, COR for correction, DEL for deletion.
amountOrPercentage
string
Adjustment Code calculation type based on details.
adjustmentCodesCopy
object
3 properties
paymentMethods
object
3 properties
paymentMethodsType
array
Holds the various types of payment methods.
paymentMethodType
object
Provides information about the payment methods. CreditCardCode and CreditCardType help to determine if EFTs are allowed.
11 properties
paymentCardType
object
Contains credit card information.
7 properties
cardUsageRulesType
object
Provides information on the various authorization options for a given card type .
8 properties
cardOptionType
object
Switch card options.
3 properties
paymentMethodTransactionInfoType
object
Provides information about the transactions including the transaction code, group, subgroup and the posting amount.
7 properties
postingAmountType
object
2 properties
surchargeType
object
Surcharge information regarding the payment configuration.
2 properties
paymentMethodUsageType
object
This provides information about the various usage options permitted for the given payment method.
8 properties
creditLimitType
object
2 properties
calculatePointsType
string
Defines when the points are to be calculated.
paymentMethodsInfo
object
9 properties
paymentMethodsCopy
object
3 properties
taxTypes
object
3 properties
taxTypesType
array
Holds Tax Type details.
taxTypesCopy
object
3 properties
cashierShiftDropLocationsDetails
object
Response object for fetching Cashier Shift Drop Locations.
3 properties
cashierShiftDropLocationsType
array
List of Cashier Shift Drop Locations.
cashierShiftDropLocationType
object
Contains Common Master configuration detail.
5 properties
cashierShiftDropLocationsCriteria
object
Request object for creating Cashier Shift Drop Locations.
3 properties
cashierShiftDropLocationsToBeChanged
object
Request object for changing Cashier Shift Drop Locations.
3 properties
commissionCodeDetail
object
Response object for fetching commission code details.
3 properties
commissionCodeDetailType
object
Commission code detail.
1 property
compAuthorizers
object
9 properties
compAuthorizersType
array
Information associated for an authorizer.
compBucketRedemptionConfigDetails
object
Response object for fetching Comp Bucket Redemption Codes configurations.
3 properties
bucketRedemptionCodesType
array
Details for Bucket Redemption codes along with associated transaction codes.
bucketRedemptionCodeType
object
This gives detailed information about redemption code.
5 properties
compTrxInfoType
object
Transaction codes info.
2 properties
compBucketRedemptionConfig
object
Request object for creating new Comp Bucket Redemption Codes configurations.
3 properties
compTypesDetails
object
Response object for fetching Comp Types.
3 properties
customChargesConfigDetails
object
Response object for fetching Custom Charges.
3 properties
customChargesType
array
Details for Custom Charges Codes.
customChargeType
object
This gives detailed information about Custom Charges.
15 properties
customChargeRuleTypeType
object
The rule types for custom charge.
2 properties
customChargeRuleTypeOption
string
The Custom Charge is only posted for the maximum number of nights of the stay.
customChargesConfig
object
Request object for creating new Custom Charges.
3 properties
customChargeExemptionsConfigToBeCreated
object
2 properties
customChargeExemptionsConfigToBeChanged
object
2 properties
customNumberConfigDetails
object
Response object for fetching custom number configurations.
3 properties
customNumberConfigurationListType
array
Details about custom number configuration.
customNumberConfigurationType
object
Custom number configuration details.
10 properties
customNumberConfigurationAreaType
string
Receipt
customNumberConfiguration
object
Request object to create custom number configuration.
3 properties
futurePastExchangeRates
array
Collection of exchange rates and their information.
fiscalCommandsDetails
object
Response object for fetching Fiscal Commands.
2 properties
fiscalCommandsType
array
List of FiscalCommands.
fiscalCommandType
object
Fiscal Command details.
5 properties
fiscalPartnerCodeListType
array
fiscalPartnerCodeType
string
Used for fiscal partner codes. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.
changeFiscalCommands
object
Request object to edit Fiscal Commands.
2 properties
fiscalPartnersDetails
object
Response object for fetching Fiscal Partners.
2 properties
fiscalPartnersType
array
Details of Fiscal Partners.
fiscalPartnerType
object
Fiscal partner Type
8 properties
createFiscalPartners
object
Request object to create Fiscal Partners
2 properties
changeFiscalPartners
object
Request object to edit Fiscal Partners.
2 properties
taxTypesGenerate
object
3 properties
hotelInterfaceDetail
object
Request object for changing Hotel Interface Data.
3 properties
hotelInterfaceDetailType
object
12 properties
interfacePrimaryInfoType
object
10 properties
interfaceAdditionalInfoType
object
24 properties
ifcMenuTypeType
string
Data Card System
telephoneChargeType
string
Auto Choose
generalInfoType
object
43 properties
sVTransactionType
string
Status of the Hotel Interface either STOPPED or RUNNING.
interfaceCommunicationInfoType
object
2 properties
tCPConfigType
object
2 properties
serialPortConfigType
object
5 properties
translationType
object
8 properties
interfaceControlCfgType
object
5 properties
interfaceControlArticleType
object
6 properties
interfaceControlSpecType
object
7 properties
interfaceControlLangType
object
5 properties
classOfServiceType
object
9 properties
definedNameFormatType
object
5 properties
importRoomsType
object
6 properties
workstationSetupType
array
List of workstations of a hotel interface.
interfaceWorkstationType
object
8 properties
postingInfoType
object
13 properties
maskDialNumberType
string
Mask the dialled digits as per the room configuration.
interfaceCustomDataInfoType
object
This type holds the custom data of a hotel interface.
3 properties
interfaceCustomDataDetailsType
array
Collection of custom data details of a hotel interface.
interfaceCustomDataDetailType
object
This gives information of custom detail of a hotel interface.
2 properties
interfaceExportDataInfoType
object
This type holds the export data of a hotel interface.
2 properties
interfaceExportDataDetailsType
array
Collection of export data details of a hotel interface.
interfaceExportDataDetailType
object
This gives information of export detail of a hotel interface.
6 properties
transactionCodeInfoType
object
10 properties
postingAccountType
object
8 properties
itemizerType
object
4 properties
transactionCodeDetailType
object
13 properties
itemizerShortInfoType
object
3 properties
templateCustomNumberConfig
object
Request object to create a new template custom number configuration.
3 properties
customNumberTemplateConfigurationType
object
Custom number configuration details.
9 properties
templateCustomNumberConfigDetails
object
Response object for fetching template custom number configurations.
3 properties
customNumberTemplateConfigurationListType
array
Details about template custom number configuration.
trackItActionsDetails
object
Response object for fetching Track it Actions.
3 properties
trackItActionsConfigType
array
Track It Action Collection element.
trackItActionConfigType
object
Track It Action Information Type.
8 properties
trackItGroupType
object
4 properties
trackItActionStatusType
string
Defined Values for Status of the Track it Action.
trackItActionsCriteria
object
Request object for creating new Track it Actions.
3 properties
trackItActionsToBeChanged
object
Request object for changing existing Track it Actions.
3 properties
trackItLocationsDetails
object
Response object for fetching Track it Locations.
3 properties
trackItLocationsConfigType
array
Track It Locations Collection element.
trackItLocationConfigType
object
Track It Location Information Type.
7 properties
trackItLocationsCriteria
object
Request object for creating new Track it Locations.
3 properties
trackItLocationsToBeChanged
object
Request object for changing existing Track it Locations.
3 properties
trackItTypesDetails
object
Response object for fetching Track it Types.
3 properties
trackItTypesConfigType
array
Track It Type Collection element.
trackItTypeConfigType
object
Track It Type Information Type.
10 properties
trackItTypesCriteria
object
Request object for creating new Track it Types.
3 properties
trackItTypesToBeChanged
object
Request object for changing existing Track it Types.
3 properties
transactionCodeAccessRoles
object
3 properties
trxCodeAccessRolesType
array
List of Roles having access to set of transaction codes
trxCodeAccessRoleType
object
Role having access to set of transaction codes
4 properties
hotelTrxCodesAccessType
object
Transaction Codes associated with particular Hotel
2 properties
roleLevelType
string
calculatedPosting
object
3 properties
calculatePostingResult
object
List of charges that will be posted against the transaction code based from the test criteria.
2 properties
calculatePostingCharge
object
Corresponds to each charge that will be posted against the transaction code based from the test criteria.
9 properties
postingBucket
object
Holds the amount that will be stored in each bucket after posting.
3 properties
hotelTransactionCode
object
3 properties
hotelConsumableInventoryItemType
object
9 properties
4 required
consumableInventoryItemGroupType
string
The item group of consumable inventory.
hotelTransactionCodeType
object
Transaction Code configuration details.
20 properties
trxCodeClassificationType
object
Transaction Code Classification details.
5 properties
cashieringTransactionTypeType
string
Wrapper Transaction Type.
transactionCodeTypeType
string
Other Charges Transaction.
paymentTrxSetupType
object
Payment Transaction Code setup details.
6 properties
paymentTrxUsageType
object
Payment Transaction Code usage details.
6 properties
cardPaymentTrxSetupType
object
Card Payment Transaction Code configuration details.
5 properties
cardPaymentProcessingType
string
Manual Processing.
aRAccountRefType
object
AR account Info.
8 properties
paymentTrxCodeTypeType
string
Other Payment Type Transaction.
trxSetupType
object
Transaction Code setup details.
20 properties
depositTypeType
string
Represents the Folio Deposit Type.
trxOwnershipType
string
Protected by the Property level
transactionAdjustmentType
object
Combination of Adjustment Reason Code and Transaction Adjustment Code.
2 properties
trxCodeAmountsType
object
Transaction Code's default amount details.
4 properties
generatesSetupType
object
Defines the Generates Setup and its Calculation Rules.
2 properties
gLMappingType
object
Gl mapping for transaction codes specific to hotels like Hilton.
9 properties
exportMappingLinkedCodeType
object
Details of linked code.
8 properties
transactionGroup
object
3 properties
hotelTransactionGroupType
object
Transaction Group configuration information.
8 properties
hotelTransactionSubgroup
object
3 properties
hotelTransactionSubgroupType
object
Transaction Subgroup configuration Information.
11 properties
customChargeExemptionsConfigCopy
object
3 properties
copyCustomChargeExemptionConfigType
object
Information needed to copy Custom Charge Exemption from one property to the other.
3 properties
fiscalFolioParametersCopy
object
Request object for copying Fiscal Folio Parameters to other hotel code(s).
4 properties
copyFiscalFolioParametersType
object
Copy instructions for Fiscal Folio Parameters.
2 properties
copyFiscalFolioParametersInfoType
object
The type gives details of the source Fiscal Folio Parameter to be copied along with information of the target where the Fiscal Folio Parameter is being copied.…
3 properties
genericHotelCodeCodeType
object
Generic Type to specify unique/primary id for the code. mostly used for Hotel level configuration codes removal request.
2 properties
copyTrackItActions
object
3 properties
copyTrackItLocations
object
3 properties
copyTrackItTypes
object
3 properties
noShowPostingRulesEdit
object
3 properties
noShowPostingRulesEditType
array
Contains new rules along with associated old rules to edit.
noShowPostingRuleEditType
object
Provides information about No Show Posting Rule Configuration.
6 properties
postingRuleType
string
Simple Type for Posting Rule Types.
noShowPostingRuleType
object
Provides information about No Show Posting Rule Configuration.
3 properties
noShowPostingRules
object
3 properties
hotelNoShowPostingRulesType
array
Holds No Show Posting Rules Configuration details.
hotelNoShowPostingRuleType
object
Provides information about No Show Posting Rule Configuration.
5 properties
numberDescriptions
object
3 properties
numberDescriptionsType
array
Individual number and description.
numberDescriptionType
object
Indicates type definition for Numbers.
3 properties
numberCodeType
string
Used for Number specific codes for OPERA tables. Possible values of this pattern are 1, 10, 17, THOUSAND, BILLION, etc.
translationTextType4000
object
Contains Multiple translated texts and language codes.
2 properties
operaControlSequences
object
3 properties
controlSequencesType
array
List of Control Sequence details
controlSequenceType
object
Provides information about the OPERA Control Sequence
7 properties
controlSequenceCodeType
string
Indicates control sequences used for bills. Eg. CREDITBILL, FATTURA etc.
packageArrangementCodes
object
3 properties
packageArrangementCodesType
array
Details for package arrangement codes.
packageArrangementCodeType
object
Generic Type to specify unique/primary id for the code. mostly used for Hotel level configuration codes removal request.
8 properties
packageArrangementCodesCopy
object
3 properties
prepaidCardDetails
object
Response for fetch Prepaid card operation
3 properties
prepaidCardInfoType
object
Detailed information about the prepaid card.
18 properties
prepaidCardTransactionsType
array
Prepaid card transaction details.
prepaidCardTransactionInfoType
object
Prepaid Card Transactions
8 properties
prepaidCardTrxTypeType
string
Reload transaction.
prepaidCardTransactionSourceType
string
Vendor transaction source type.
prepaidCardBalanceDetails
object
Response for fetch Prepaid card balance operation
3 properties
prepaidCards
object
3 properties
prepaidCardsType
array
Holds fixed charge detail.
prepaidCardType
object
Holds fixed charge information.
17 properties
prepaidCardDetailsType
object
Prepaid Card Details.
10 properties
prepaidCardTransactionType
object
Prepaid Card transaction.
9 properties
revenueBucketCodes
object
3 properties
revenueBucketCodesType
array
Details for Revenue Bucket codes along with associated transaction codes.
revenueBucketCodeType
object
This gives detailed information about a trx code arrangement.
9 properties
trxCodesInfoType
array
List of Transaction codes info.
bucketTypeType
string
Fiscal Bucket Type.
revenueBucketCodesCopy
object
3 properties
configCopyRevenueBucketCodeType
object
Copy instructions for copying Revenue Bucket Codes to hotel code(s)
2 properties
revenueBucketTypes
object
3 properties
revenueBucketTypesType
array
Holds Revenue Bucket Type details.
revenueBucketTypeType
object
Provides information about Revenue Bucket Types.
6 properties
revenueBucketTypesCopy
object
3 properties
revenueTypeMapping
object
3 properties
revenueTypeMappingType
object
Type used for Revenue Type mapping.
11 properties
cateringOnlyType
string
For Catering and Event.
revenueTypeMappingList
object
3 properties
revenueTypeMappingListType
array
Collection of multiple Revenue type mapping codes.
revenueTypeMappingCopy
object
Request object for Copying Revenue Type Mapping.
3 properties
copyRevenueTypeMappingCriteriaType
array
Provides Revenue Type Mapping details that needs to be copied.
copyRevenueTypeMappingListType
object
Type used for Revenue Type mapping.
15 properties
routingInstructions
object
3 properties
configRoutingInstructionsType
array
This type holds a collection of routing instructions.
configRoutingInstructionType
object
Routing limit can be one of the three: Covers, Limit, Percent. It is not mandatory to set value of either. This field is available when the CashieringRouting L…
12 properties
timeSpanDaysOfWeekType
object
Container for Time span with days of week.
8 properties
routingInstructionsCopy
object
4 properties
applicationSecureSetting
object
3 properties
applicationSecureSettingType
object
Internal settings that is mainly used to get a secure information on the type.
4 properties
applicationSettingLevelType
string
stopProcessingReasons
object
Response object for fetching Stop Processing Reason.
3 properties
stopProcessingReasonsType
array
List of the Stop Processing Reasons to be configured or fetched
stopProcessingReasonType
object
Details for Stop Processing Reason.
4 properties
taxBrackets
object
3 properties
taxBracketsType
array
Details used for storing information about a tax bracket.
taxBracketType
object
This gives information for uniquely identifying a tax bracket detail.
5 properties
taxBracketAmountsType
array
Details used for storing information about a tax bracket amount.
taxBracketAmountType
object
Details used for storing information about a tax bracket amount.
3 properties
taxBracketsCopy
object
3 properties
copyConfigurationCodesType
array
Information needed to copy configuration code from one property to the other.
taxCategoryCodesDetails
object
Response object for fetching Tax Category Codes.
3 properties
taxCategoryCodesType
array
List of Tax Category Codes.
taxCategoryCodeType
object
Contains Common Master configuration detail.
4 properties
taxCategoryCodesCriteria
object
Request object for creating Tax Category Codes.
3 properties
taxCategoryCodesToBeChanged
object
Request object for changing Tax Category Codes.
3 properties
taxOfficesDetails
object
Response object for fetching Tax Offices.
3 properties
taxOfficesType
array
List of Tax Offices.
taxOfficeType
object
Contains Common Master configuration detail.
4 properties
taxOfficesCriteria
object
Request object for creating Tax Offices.
3 properties
taxOfficesToBeChanged
object
Request object for changing Tax Offices.
3 properties
templateTransactionCodes
object
3 properties
templateTransactionCodesType
array
Template transaction code configuration details.
templateTransactionCodeType
object
Transaction Code configuration details.
18 properties
templateTransactionGroups
object
3 properties
templateTransactionGroupsType
array
Template transaction groups.
transactionGroupType
object
Transaction Group configuration information.
5 properties
templateTransactionSubgroups
object
3 properties
templateTransactionSubgroupsType
array
Template transaction subgroup configurations.
transactionSubgroupType
object
Transaction Subgroup configuration Information.
8 properties
transactionArrangementCodes
object
3 properties
transactionArrangementCodesType
array
Contains transaction codes along with associated arrangement codes.
transactionArrangementCodeType
object
This has arrangement codes association details for a transaction code.
5 properties
transactionCodeOwnership
object
3 properties
changeTransactionCodeOwnershipType
object
Change Transaction Code Ownership configuration details.
3 properties
hotelTransactionCodes
object
3 properties
hotelTransactionCodesType
array
Transaction Code configuration details.
transactionCodes
object
3 properties
trxCodeUsagesType
array
Element on which the transaction code is being used.
trxCodeUsageType
object
Details about the element on which the transaction code is being used.
2 properties
transactionCodesCopy
object
3 properties
copyTransactionCodesType
object
Collection of transaction codes to be copied within same hotel
3 properties
copyTransactionCodeType
object
The type gives details of the source transaction code to be copied. Details also include the new code and description with which the transaction code will be c…
2 properties
transactionDiversionRules
object
3 properties
transactionDiversionRulesType
array
Collection of Transaction Diversion Rule List
transactionDiversionRuleType
object
A Transaction Diversion Rule Type
15 properties
membershipTypeLevelType
object
2 properties
transactionDiversionRuleLevelType
string
Reservation level.
thresholdDetailsType
object
Type for the threshold elements.
5 properties
entityType
string
Indicates the rule is based on Minutes associated with the charge.
scopeType
string
Minimum required and complimentary values are applicable Per Stay.
transactionDiversionRuleTypeType
string
The rule type on which the Transaction Diversion Rule is based. If a reservation has any of the following code, Transaction Diversion rule gets active for that…
transactionGroups
object
3 properties
hotelTransactionGroupsType
array
Hotel's Transaction Group configuration.
transactionGroupsCopy
object
3 properties
hotelTransactionSubgroups
object
3 properties
hotelTransactionSubgroupsType
array
Hotel's Transaction Subgroup configuration.
transactionSubgroupsCopy
object
3 properties
copyTransactionSubgroupsType
object
Copy information required to copy transaction subgroup type
2 properties
templateTransactionSubgroupIDsType
array
List of template transaction subgroup IDs
templateTransactionSubgroupIDType
object
Information that uniquely identifies template transaction subgroups
2 properties
fiscalPayloadType
string
transactionDiscounts
object
3 properties
transactionDiscount
object
3 properties
hotelTransactionDiscountType
object
Provides information about Transaction Discount Configuration.
14 properties
6 required
transactionDiscountRuleType
string
The rule type on which the transaction discount is based.
transactionDiscountsAttributeType
object
2 properties
transactionDiscountType
string
The type on which the transaction discount is based. e.g MembershipType , MembershipLevel
transactionDiscountCodeType
string
The code type on which the transaction discount is based.
applicationUserType
object
Information to uniquely identify an application user
2 properties
generatesInfoType
object
Defines Generates Info.
1 property
generateInfoType
object
Defines Generates Info
1 property
vouchersDetails
object
Object for Voucher Info.
3 properties
voucherType
object
Voucher details.
8 properties
vouchersConfigCopy
object
3 properties
customChargePostingRhythmType
object
Posting rhythm details.
5 properties
customChargePostingRhythmTypeOption
string
Defined values for posting rhythm LOV.
customChargeRangeType
object
The lower and upper range value for which the corresponding price is posted as a custom charge.
3 properties
folioCodeDescriptionType
object
This contains a folio code and description information.
2 properties
managedByOptions
string
Describes of the Configuration is Managed by Enterprise or Property.
roomTypeBasedChargeRngs
object
Defines Room Type Based Charge Range response type.
3 properties
roomTypeBasedChargeRangesType
object
Provides information about Room Type Based Charge Ranges.
8 properties
operaVersionNumberType
string
Current Opera Version Number
operaVersion
object
Response for Ping operation.
3 properties
folioCopyLegendInfoType
object
3 properties
transactionDiscountsCopy
object
1 property
copyTransactionDiscountsType
object
Copy instructions for transaction discount codes.
2 properties
copyTransactionDiscountsInfoType
object
The type gives details of the source transaction discount code to be copied along with information of the target where the transaction discount code is being c…
3 properties
consumableItemType
object
1 property
searchPrepaidCardBalanceRequest
object
7 properties
2 required
searchPrepaidCardRequest
object
7 properties
2 required
searchCompAuthorizersRequest
object
11 properties
searchCashiersRequest
object
6 properties
1 required
cashSurchargeRangeType
object
Cash Surcharge identification details
6 properties
cashSurchargeRanges
object
3 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Oracle Hospitality 12
Other APIs Oracle Hospitality publishes across the network.
OPERA Cloud Distribution ARI Publication
OPERA Cloud Distribution Outbound Lookup
OPERA Cloud Distribution Content Notification
OPERA Cloud Distribution Book
OPERA Cloud Distribution Content
OPERA Cloud Distribution Property Controls
OPERA Cloud Distribution Reservation Service
OPERA Cloud Distribution Authentication API
OPERA Cloud Distribution Onboarding
OPERA Cloud Distribution Reservation Notification
OPERA Cloud Distribution Shop
Nor1 Integrated Upsell API
#AccountsReceivablesConfig#CashieringConfig#Credit Card#CommissionConfig#EndOfDayConfig#ChainConfig#HotelConfig#Property Management
Where this information came from
This is an independent, third-party profile of OPERA Cloud Front Desk Configuration API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.