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.
Oracle Hospitality Cashiering Config API is one of 154 APIs that Oracle Hospitality publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include CashieringConfig. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 270 operations across 138 paths, and defines 560 schemas. It is described by OpenAPI 3.2.0, at version 26.2.0.0.
Requests are made against a single base URL, /fof/config/v1.
270 operations
138 paths
560 schemas
42 DELETE72 GET48 POST108 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 270
Across 138 paths, the API surfaces 270 operations — 42 DELETE, 72 GET, 48 POST, 108 PUT. Each is listed below with its method, path, parameters, and response codes.
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.
Schemas 560
The contract defines 560 schemas that model the data the API accepts and returns. The most detailed are aRInvoiceType (54 properties), reservationInfoType (52 properties), folioTypeConfigType (38 properties), stayInfoType (36 properties). Each schema is shown below with its type and property counts.
reservationQueueInformationType
object
Information regarding the Date, Duration and Priority of the reservation on Queue for Check in.
6 properties
searchCashiersRequest
object
6 properties
1 required
resAccompanyGuestInfoType
object
5 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
packageArrangementCodeType
object
Generic Type to specify unique/primary id for the code. mostly used for Hotel level configuration codes removal request.
8 properties
folioCopyLegends
object
3 properties
entityType
string
Indicates the rule is based on Minutes associated with the charge.
folioTypeLegendMappingConfigStatus
object
Response Body.
2 properties
revenueBucketTypesCopy
object
3 properties
folioStatusType
string
The Folio Status Example: DEPOSIT folio, VOID folio or the default OK folio status.
colorType
string
Color configuration type. This color configuration provides a visual category of entities.
pointsType
object
The Redeem Points contains the number of points required to book a room type.
2 properties
trxCodeAmountsType
object
Transaction Code's default amount details.
4 properties
customChargePostingRhythmType
object
Posting rhythm details.
5 properties
paymentCardType
object
Contains credit card information.
7 properties
authorizerGroupsToChange
object
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
packageArrangementCodesType
array
Details for package arrangement codes.
folioTypesConfig
object
3 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
indicatorType
object
Lamp indicator Type.
2 properties
fixedChargesType
array
Holds fixed charge detail.
paymentMethods
object
3 properties
expenseArrangementCodes
object
3 properties
addressInfoType
object
Provides address information.
3 properties
fiscalPayloadType
string
warningsType
array
Used in conjunction with the Success element to define a business error.
trxCodeUsageType
object
Details about the element on which the transaction code is being used.
2 properties
gUINumberRule
object
GUI Number rule
8 properties
expenseArrangementCodeType
object
Generic Type to specify unique/primary id for the code. mostly used for Hotel level configuration codes removal request.
7 properties
cardNumberTypeType
string
Simple type for indicating if credit card number is tokenized.
fiscalPartnerType
object
Fiscal partner Type
8 properties
customChargesType
array
Details for Custom Charges Codes.
compTypesDetails
object
Response object for fetching Comp Types.
3 properties
currencyAmountType
object
A monetary value expressed with a currency code.
2 properties
trxCodeUsagesType
array
Element on which the transaction code is being used.
monthlyCustomVarianceInfoType
object
Value Variance information for a CUSTOM code for a month.
2 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…
customChargeExemptionConfigType
object
Provides information about Exemptions.
9 properties
templateTransactionSubgroupIDsType
array
List of template transaction subgroup IDs
customNumberConfigurationType
object
Custom number configuration details.
10 properties
generateAdjustmentTypeType
string
Generates calculation bucket/group. Percentage generates are calculated against amount in one of the the calculation bucket.
budgetForecastTransactionInfoBaseType
object
Budget Forecast information for budget Transaction codes.
2 properties
transactionDiscountsCopy
object
1 property
cyclePeriodType
string
Signifies Calendar Period
aRAccountType
object
Accounts Receivabales Account details type.
33 properties
hotelInterfaceType
object
8 properties
cardProcessingType
string
authorizationConfigRulesInfo
object
3 properties
cashierType
object
Cashiers Information.
14 properties
controlSequenceCodeType
string
Indicates control sequences used for bills. Eg. CREDITBILL, FATTURA etc.
aRPaymentsType
array
A collection of AR Payments.
fiscalYearType
object
Fiscal Year Type
8 properties
aRYearViewInfoType
object
Information regarding Year View balances for an account.
2 properties
generateCalcRuleType
object
Defines the Calculation Rule for the generate.
10 properties
transactionGroupType
object
Transaction Group configuration information.
5 properties
housekeepingTaskCodeType
object
Information related to a Task Code. Task Codes are used to generate task sheets in Rooms Management.
7 properties
folioCopyLegendInfoType
object
3 properties
resAccompanyGuestListType
array
Collection of accompany guests
generatesSetupType
object
Defines the Generates Setup and its Calculation Rules.
2 properties
resSharedGuestListType
array
Collection of shared guest reservations.
taxTypesType
array
Holds Tax Type details.
facilityTaskType
object
Information regarding facility task on a reservation.
3 properties
codeDescriptionType
object
This contains a generic code and description information.
2 properties
fiscalResponseType
object
Provides information which is used for fiscal response processing.
2 properties
budgetForecastMarketInfoType
object
Budget Forecast information for budget segment codes.
2 properties
cardPaymentTrxSetupType
object
Card Payment Transaction Code configuration details.
5 properties
sourceCodeInfoType
object
4 properties
surnameType
string
Family name, last name.
authorizationConfigRulesType
array
List of AuthorizationRuleType.
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…
hotelTransactionCodesType
array
Transaction Code configuration details.
cashiersType
array
Details about a cashier.
exceptionDetailType
object
Complex type that contains error details for a REST call.
9 properties
2 required
aRYearViewType
object
Year information for an Year View.
3 properties
searchMatchType
object
Search match indicating attribute and the matching value.
2 properties
hotelTransactionSubgroupType
object
Transaction Subgroup configuration Information.
11 properties
fiscalPartnerCodeListType
array
foreignCurrencyType
object
Provides information about the Foreign Currency Code.
9 properties
compTypesType
array
List of Comp Types.
cardValidationRuleTypeType
string
Defines rules to be used for card validation.
groupArrangementCodesCopy
object
3 properties
trxOwnershipType
string
Protected by the Property level
templateTransactionSubgroupIDType
object
Information that uniquely identifies template transaction subgroups
2 properties
folioCopyLegendsType
array
Details about folio copy legends.
transactionGroupsCopy
object
3 properties
currencyExchangeServiceTaxType
object
Currency exchange service tax identification details
9 properties
budgetInfoDeleteType
string
Daily information.
hotelTransactionCodeType
object
Transaction Code configuration details.
20 properties
revenueBucketTypes
object
3 properties
generateLevelType
string
Defines the level from which the generates was created.
traceType
object
16 properties
compAuthorizerHeaderType
object
Detail information related to comp authorizers.
3 properties
operaVersionNumberType
string
Current Opera Version Number
currencyExchangeServiceTaxesType
array
List of currency exchange service taxes
budgetForecastCateringInfoBaseType
object
Budget Forecast information for budget Catering codes.
3 properties
postingBucket
object
Holds the amount that will be stored in each bucket after posting.
3 properties
addressType
object
Provides address information.
19 properties
noShowPostingRuleEditType
object
Provides information about No Show Posting Rule Configuration.
6 properties
revenueTypeMappingType
object
Type used for Revenue Type mapping.
11 properties
changeFiscalCommands
object
Request object to edit Fiscal Commands.
2 properties
fiscalPartnersType
array
Details of Fiscal Partners.
expenseArrangementCodesType
array
Details for expense arrangement code along with associated transaction codes.
countryNameType
object
Code for a country or a nationality.
2 properties
fiscalPeriodType
object
Fiscal Period Type
9 properties
revenueBucketCodesType
array
Details for Revenue Bucket codes along with associated transaction codes.
errorInstance
object
Complex type that contains error instance details for a REST call.
7 properties
2 required
templateTransactionGroups
object
3 properties
fiscalFolioParameters
object
3 properties
copyRevenueTypeMappingListType
object
Type used for Revenue Type mapping.
15 properties
resExpectedTimesType
object
Holds the Arrival and Departure Time Information
2 properties
dateRangeType
object
Date Range with Start and End dates.
2 properties
aRAccountStatusType
object
Type for the Account Status. Status can be restricted and a message/description added to the Account.
3 properties
adjustmentCodes
object
3 properties
monthlyCateringInfoType
object
Holds monthly Catering summary information
3 properties
billingPrivilegesType
object
This stores the information for Bed Tax Reporting. Mainly used in Maldives.
13 properties
taxTypeGenerateScheduleType
object
Defines the Calculation Rule for the Tax Type for a specific date schedule
2 properties
templateTransactionCodeType
object
Transaction Code configuration details.
18 properties
taxBracketAmountType
object
Details used for storing information about a tax bracket amount.
3 properties
reservationTaxTypeInfo
object
Provides information about the Tax Type.
9 properties
revenueBucketCodesCopy
object
3 properties
budgetForecastToDelete
object
3 properties
hotelTransactionGroupType
object
Transaction Group configuration information.
8 properties
currencyHandlingType
string
Simple Type for Posting Limit Types.
groupArrangementCodes
object
3 properties
customNumberConfigurationAreaType
string
Receipt
revenueNightsInfoType
object
Revenue information for a segment code. Holds total and monthly revenue information.
3 properties
deleteSegmentCodeBudgetInformationType
object
Holds segment and segment code information to delete.
7 properties
authorizerGroupType
object
A representation of the information contained by a Authorizer Group.
6 properties
paymentMethodsCopy
object
3 properties
formattedTextTextType
object
Provides text and indicates whether it is formatted or not.
2 properties
transactionCodeTypeType
string
Other Charges Transaction.
aRAgingInfoType
object
Information regarding the aging balances for an account.
2 properties
operaVersion
object
Response for Ping operation.
3 properties
revenueTypeMappingList
object
3 properties
numberDescriptions
object
3 properties
fiscalFolioParametersCopy
object
Request object for copying Fiscal Folio Parameters to other hotel code(s).
4 properties
authorizationRuleType
object
Configured rule for computing the amount to authorize.
3 properties
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…
taxBracketType
object
This gives information for uniquely identifying a tax bracket detail.
5 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…
gLMappingType
object
Gl mapping for transaction codes specific to hotels like Hilton.
9 properties
guestHousekeepingServiceRequestType
string
Possible values for the Guest Service Status.
bucketTypeType
string
Fiscal Bucket Type.
copyFiscalFolioParametersType
object
Copy instructions for Fiscal Folio Parameters.
2 properties
createFiscalPartners
object
Request object to create Fiscal Partners
2 properties
compTypeType
object
Information representation of Comp Type.
4 properties
cycleFiscalPeriodsType
array
List of Cycle Fiscal Periods.
customVarianceInfoType
array
Monthly Value Variance information.
articlesInfo
object
3 properties
folioTypeLegendMappingsConfigType
array
Details about folio type legened mapping.
percentageGenerateType
object
Defines percentage rule for generates.
3 properties
dailyPlanCodesType
array
Details for daily plan code along with associated transaction codes.
reservationInfoType
object
The Reservation class contains the current reservation being created or altered.
52 properties
cashSurchargeRanges
object
3 properties
fiscalPeriodsEdit
object
3 properties
customNumberConfigDetails
object
Response object for fetching custom number configurations.
3 properties
cateringOnlyType
string
For Catering and Event.
customChargeExemptionsConfig
object
Response object for fetching Custom Charge Exemptions.
3 properties
cardPaymentProcessingType
string
Manual Processing.
resCashieringType
object
Cashiering Information for the reservation.
14 properties
roomTypeBasedChargeRngs
object
Defines Room Type Based Charge Range response type.
3 properties
adjustmentCodesType
array
Holds Adjustment Code details.
compAuthorizerType
object
Information related to comp authorizers.
16 properties
fiscalYearsType
array
List of Fiscal Years.
compTypesStatus
object
Response Body.
2 properties
templateTransactionCodes
object
3 properties
transactionGroups
object
3 properties
reservationDepositType
object
Reservation Deposit Type.
7 properties
monthlyRevenueNightsInfoType
object
Holds monthly revenue summary information
3 properties
reservationPaymentMethodType
object
7 properties
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
cashiers
object
3 properties
postingLimitType
string
Simple Type for Posting Limit Types.
folioTextsType
array
This stores the description for the type of tax calculation especially with tax exemption, etc.
transactionDiversionRules
object
3 properties
flatAmtGenerateType
object
Defines Flat Amount rule for generates.
1 property
copyRevenueTypeMappingCriteriaType
array
Provides Revenue Type Mapping details that needs to be copied.
paymentMethodUsageType
object
This provides information about the various usage options permitted for the given payment method.
8 properties
segmentNameType
string
Forecast.
telephoneInfoType
object
Information on a telephone number for the customer.
3 properties
foreignCurrencies
object
3 properties
transactionDiversionRuleType
object
A Transaction Diversion Rule Type
15 properties
configCopyRevenueBucketCodeType
object
Copy instructions for copying Revenue Bucket Codes to hotel code(s)
2 properties
generatePostingRuleType
object
Advance Generates posting rules.
2 properties
timeSpanDaysOfWeekType
object
Container for Time span with days of week.
8 properties
aRAccountRefType
object
AR account Info.
8 properties
customChargePostingRhythmTypeOption
string
Defined values for posting rhythm LOV.
paymentMethodsType
array
Holds the various types of payment methods.
cardUsageRulesType
object
Provides information on the various authorization options for a given card type .
8 properties
copyConfigurationCodeType
object
Information needed to copy configuration code from one property to the other.
3 properties
gUINumberPeriodType
string
Period set November-December
waitlistResType
object
Information regarding why reservation is being /has been waitlisted.
6 properties
revenueBucketCodes
object
3 properties
hotelNoShowPostingRuleType
object
Provides information about No Show Posting Rule Configuration.
5 properties
cashierId
number
The Cashier ID of the Cashier who is currently processing the transaction(s).
customChargeType
object
This gives detailed information about Custom Charges.
15 properties
transactionSubgroupsCopy
object
3 properties
templateTransactionSubgroups
object
3 properties
transactionArrangementCodesType
array
Contains transaction codes along with associated arrangement codes.
generatesInfoType
object
Defines Generates Info.
1 property
creditLimitType
object
2 properties
revenueBucketTypesType
array
Holds Revenue Bucket Type details.
authorizationConfigRuleType
object
Authorization configuration Rule Type.Authorization Rules specify the rule (or rules) that the property uses for credit card authorizations
14 properties
fiscalFolioParameterType
object
Provides information about the Fiscal Folio Parameter.
7 properties
taxTypeCalcRuleType
object
Defines the Calculation Rule for the generate.
5 properties
status
object
Response Body.
2 properties
taxTypes
object
3 properties
folioArrangementCodeType
object
Generic Type to specify unique/primary id for the code. mostly used for Hotel level configuration codes removal request.
8 properties
fiscalFolioParametersType
array
Holds Fiscal Folio Parameter details.
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
transactionCodes
object
3 properties
customCodeTotalInformationType
object
Budget Forecast information for Custom segment.
6 properties
taxTypesCopy
object
3 properties
controlSequencesType
array
List of Control Sequence details
transactionInfoType
object
Revenue information for a TRANSACTION segment code. Holds total and monthly revenue information.
2 properties
budgetForecastRateInfoBaseType
object
Budget Forecast information for budget segment codes.
3 properties
authorizerTrxLimitsType
array
Set of Transaction Limit configured for the Authorizer Group.
postingAmountType
object
2 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
revenueBucketTypeType
object
Provides information about Revenue Bucket Types.
6 properties
marketCodeInformationBaseType
object
Budget Forecast information for budget segment code.
4 properties
generateCalcBucketType
string
Generates calculation bucket/group. Percentage generates are calculated against amount in one of the the calculation bucket.
fixedChargeScheduleType
object
Holds schedule of fixed charge.
5 properties
monthlyCateringVarianceInfoType
object
Variance information for a catering segment code for a month.
3 properties
copyCustomChargeExemptionConfigType
object
Information needed to copy Custom Charge Exemption from one property to the other.
3 properties
folioTypesConfigType
array
Information details of the Folio Type Names.
managedByOptions
string
Describes of the Configuration is Managed by Enterprise or Property.
surchargeType
object
Surcharge information regarding the payment configuration.
2 properties
cashieringTransactionTypeType
string
Wrapper Transaction Type.
fiscalCommandsType
array
List of FiscalCommands.
cateringCodeInformationType
object
Budget Forecast information for Catering segment code.
9 properties
generateInfoType
object
Defines Generates Info
1 property
trxInfoType
object
Transaction codes info.
10 properties
groupArrangementCodeType
object
Generic Type to specify unique/primary id for the code. mostly used for Hotel level configuration codes removal request.
8 properties
resPeriodicFolioType
object
Information regarding periodic folios set on the reservation.
3 properties
folioTypeLegendMappingConfigToBeChanged
object
Request object to edit folio type legend mapping information.
3 properties
resAttachedProfileListType
array
noShowPostingRulesEditType
array
Contains new rules along with associated old rules to edit.
paymentMethodType
object
Provides information about the payment methods. CreditCardCode and CreditCardType help to determine if EFTs are allowed.
11 properties
deleteSegmentCodeInfoType
object
Holds segment code information to delete.
7 properties
resGuestExternalInfoType
object
Specifies Company or Travel Agent profile using IATA or Corp. No.
2 properties
trxCodeAccessRolesType
array
List of Roles having access to set of transaction codes
transactionAdjustmentType
object
Combination of Adjustment Reason Code and Transaction Adjustment Code.
2 properties
givenNameType
string
Given name, first name or names
foreignCurrenciesType
array
List of the Foreign Currencies to be configured or fetched
aRAgingType
object
Aging information for an Aging Bucket.
6 properties
advanceCheckInType
object
Information relating to Reservation's Advance Checked In state and Expected Time of Return
3 properties
paymentTrxSetupType
object
Payment Transaction Code setup details.
6 properties
resRevenueBalanceType
object
Revenue and Balance Amount summary for the reservation.
9 properties
calculatePostingResult
object
List of charges that will be posted against the transaction code based from the test criteria.
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
customChargeRuleTypeOption
string
The Custom Charge is only posted for the maximum number of nights of the stay.
facilityCodeType
object
Facility Housekeeping Code, its description and quantity.
3 properties
compBucketRedemptionConfigDetails
object
Response object for fetching Comp Bucket Redemption Codes configurations.
3 properties
cashierTypeType
string
The types of cashier.
noShowPostingRules
object
3 properties
trxCodeClassificationType
object
Transaction Code Classification details.
5 properties
budgetForecastRateInfoType
object
Budget Forecast information for budget segment codes.
2 properties
budgetForecastCateringInfoType
object
Budget Forecast information for budget Catering codes.
2 properties
configRoutingInstructionsType
array
This type holds a collection of routing instructions.
paymentTrxCodeTypeType
string
Other Payment Type Transaction.
paymentTrxUsageType
object
Payment Transaction Code usage details.
6 properties
folioTypeLegendMappingConfigCriteria
object
Request object to create folio type legend mapping information.
3 properties
paymentMethodValidationRuleType
object
Payment method card validation rules.
5 properties
bedTaxReportingType
object
This stores the information for Bed Tax Reporting. Mainly used in Maldives.
5 properties
folioTypeLegendMappingsConfigDetails
object
Response object for fetch folio type legend mapping.
3 properties
taxTypeGenerateType
object
Defines the Calculation Rules for the Tax Type
3 properties
monthNoType
string
December.
copyTransactionCodesType
object
Collection of transaction codes to be copied within same hotel
3 properties
rateCodeInformationType
object
Budget Forecast information for budget segment code.
8 properties
interfaceRightsStatusType
object
4 properties
traceTimeInfoType
object
4 properties
resGuestInfoType
object
Specifies Company or Travel Agent profile using IATA or Corp. No.
30 properties
reservationFolioWindowType
object
Folio window view which holds the set of folios for a reservation.
4 properties
defaultPaymentMethodRule
object
3 properties
hotelTrxCodesAccessType
object
Transaction Codes associated with particular Hotel
2 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
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
gUINumberRulesDetails
object
3 properties
taxBrackets
object
3 properties
templateTransactionGroupsType
array
Template transaction groups.
numberDescriptionsType
array
Individual number and description.
authTransactionCodesType
array
List of Transaction codes info.
reservationInterfaceStatusType
object
Hotel Interface Type for a reservation and status of the various services
3 properties
taxCodeSeqType
integer
Primary Key Sequence.
addressSearchType
object
Address Details such as city, state, country, postal code etc.
6 properties
transactionSubgroupType
object
Transaction Subgroup configuration Information.
8 properties
commissionPayoutToType
string
rateCategoryType
object
This type represents the rate category type.
2 properties
calculatePostingCharge
object
Corresponds to each charge that will be posted against the transaction code based from the test criteria.
9 properties
compTrxInfoType
object
Transaction codes info.
2 properties
packageArrangementCodes
object
3 properties
routingInstructions
object
3 properties
adjustmentCodeType
object
Provides information about Adjustment Codes.
8 properties
cardTypeType
string
This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method.
cardRangeType
object
Card number start and end range.
2 properties
futurePastExchangeRates
array
Collection of exchange rates and their information.
exchangeRateType
object
Exchange rate configuration type.
11 properties
reservationFolioWindowsType
array
Collection of reservation folio windows.
taxTypesGenerateType
array
Defines the Calculation Rule for the Tax Type for a specific date schedule
cashierNumber
object
3 properties
monthlyTransactionInfoType
object
Holds monthly Revenue summary information
2 properties
cardRangesType
array
Card number start and end range.
resAccessRestrictionType
string
Indicates any Updates/Changes on the reservation as well as Reservation Cancellation are not allowed.
transactionArrangementCodes
object
3 properties
commentInfoType
object
Comment related to the profile/reservation.
8 properties
reservationIdList
array
Unique Id that references an object uniquely in the system.
budgetForecastInformationBaseType
object
Holds budget forecast information for included segment types.
7 properties
hotelConsumableInventoryItemType
object
9 properties
4 required
customNumberTemplateConfigurationType
object
Custom number configuration details.
9 properties
queueTextInfoType
object
Information regarding the message sent to guest.
2 properties
thresholdDetailsType
object
Type for the threshold elements.
5 properties
hotelTransactionGenerates
object
3 properties
folioArrangementCodes
object
3 properties
budgetForecastTransactionInfoType
object
Budget Forecast information for budget Transaction codes.
2 properties
folioPrintQueues
object
3 properties
aRAccountShortInfoType
object
Accounts Receivabales Account details type charged for batched posting.
4 properties
customNumberTemplateConfigurationListType
array
Details about template custom number configuration.
hotelTransactionCode
object
3 properties
budgetForecastInformationType
object
Holds budget forecast information for included segment types.
5 properties
templateTransactionCodesType
array
Template transaction code configuration details.
cashierInfoType
object
Cashier information. Contains Id and Name details of the cashier.
2 properties
reservationTurndownInfoType
object
Turndown information for a reservation
2 properties
folioCopyLegend
object
3 properties
copyTransactionDiscountsType
object
Copy instructions for transaction discount codes.
2 properties
generateType
object
Defines the Generate and its Calculation Rules
6 properties
resProfileTypeType
string
postingRuleType
string
Simple Type for Posting Rule Types.
budgetForecastCustomInfoBaseType
object
Budget Forecast information for budget Custom codes.
2 properties
codeListType
array
hotelTransactionSubgroups
object
3 properties
routingInstructionsCopy
object
4 properties
fiscalPeriodsEditType
array
List of Fiscal Periods.
roomTypeBasedChargeRangesType
object
Provides information about Room Type Based Charge Ranges.
8 properties
budgetForecastInformationBase
object
3 properties
transactionCodeAccessRoles
object
3 properties
customChargeExemptionsConfigType
array
Holds Exemption details.
fiscalPartnersDetails
object
Response object for fetching Fiscal Partners.
2 properties
customValueInfoType
object
Value information for a CUSTOM segment code. Holds total and monthly Value information.
2 properties
compAuthorizerDetailType
object
Detail information related to comp authorizers.
6 properties
compAuthorizersType
array
Information associated for an authorizer.
fiscalPartnerCodeType
string
Used for fiscal partner codes. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.
compBucketRedemptionConfig
object
Request object for creating new Comp Bucket Redemption Codes configurations.
3 properties
commentType
object
An indication of a new paragraph for a sub-section of a formatted text message.
19 properties
hotelTransactionSubgroup
object
3 properties
folioArrangementCodesType
array
Details for folio arrangement code along with associated transaction codes.
functionArgumentType
object
This type provided details of a function argument and the value it holds.
5 properties
hotelTransactionSubgroupsType
array
Hotel's Transaction Subgroup configuration.
taxTypesGenerate
object
3 properties
aRBalanceType
object
Balance information for AR.
3 properties
customNumberConfigurationListType
array
Details about custom number configuration.
profileInfoType
object
Provides information about attached profiles to the block.
5 properties
articlePostItType
object
Post it information of an article.
2 properties
nameTypeType
string
membershipInfoType
object
The Membership object identifies the frequent customer reward program.
8 properties
expenseArrangementCodesCopy
object
3 properties
paymentMethodTransactionInfoType
object
Provides information about the transactions including the transaction code, group, subgroup and the posting amount.
7 properties
transactionDiscountType
string
The type on which the transaction discount is based. e.g MembershipType , MembershipLevel
payeeInfoType
object
Payee information.
7 properties
blockIdList
array
Unique Id that references an object uniquely in the system.
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
collectingAgentTaxType
object
Type which holds Collecting Agent Taxes primary details.
11 properties
resMobileNotificationsType
object
Contains the status of Room Ready and Key Ready messages.
5 properties
sourceOfSaleType
object
Point of Sale of reservation. Identifies the entity/channel who made the reservation.
2 properties
roomClassCodeInfoType
object
Code of the room class type.
3 properties
calculatePointsType
string
Defines when the points are to be calculated.
budgetForecastMarketInfoBaseType
object
Budget Forecast information for budget segment codes.
3 properties
templateTransactionSubgroupsType
array
Template transaction subgroup configurations.
cashiersDetails
object
9 properties
fiscalYears
object
3 properties
changeFiscalPartners
object
Request object to edit Fiscal Partners.
2 properties
statusTypes
string
Defines status in terms of time.
revenueTypeMapping
object
3 properties
currencyExchangeServiceTaxes
object
3 properties
guestLastStayInfoType
object
Contains last stay related details of the guest.
4 properties
vouchersConfigCopy
object
3 properties
emailInfoType
object
Information on an email for the customer.
3 properties
hotelTransactionCodes
object
3 properties
budgetForecastInformation
object
3 properties
warningType
object
Used when a message has been successfully processed to report any warnings or business errors that occurred.
10 properties
facilityCodesType
array
List of the facility codes.
customNumberType
string
Custom number
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
articlesType
array
Holds collection of articles.
collectingAgentTaxes
object
3 properties
resCompAccountingType
object
Information regarding comp accounting on the reservation.
3 properties
translationTextType2000
object
Contains Multiple translated texts and language codes.
2 properties
yearTypeType
string
Defined Values for Fiscal Year Type.
generatesType
array
Defines the Generate and its Calculation Rules.
customNumberConfiguration
object
Request object to create custom number configuration.
3 properties
amountOrPercentage
string
Adjustment Code calculation type based on details.
folioReportsType
array
Information details of the Folio Reports associated with Folio Type Name.
authorizerGroupsType
array
Authorizer Group
searchCompAuthorizersRequest
object
11 properties
resAttachedProfileType
object
3 properties
consumableItemType
object
1 property
transactionGroup
object
3 properties
voucherType
object
Voucher details.
8 properties
customCodeInformationBaseType
object
Budget Forecast information for Custom segment code.
4 properties
taxTypeType
object
Provides information about the Tax Type.
9 properties
copyConfigurationCodesType
array
Information needed to copy configuration code from one property to the other.
exportMappingLinkedCodeType
object
Details of linked code.
8 properties
transactionDiscountsAttributeType
object
2 properties
translationsTextType
array
Language code for the translation.
cycleFiscalPeriodType
object
Fiscal Year Cycle Period creation type.
5 properties
monthlyRevenueNightsVarianceInfoType
object
Revenue Variance information for a segment code for a month.
3 properties
groupArrangementCodesType
array
Details for group arrangement code along with associated transaction codes.
folioTypeConfigType
object
Information detail for uniquely identifying a Folio Type Name.
38 properties
externalReferencesType
array
This type contains unique information of external reference.
doNotPostGenerateType
object
Existance of this type indicates that the generate will not be effective. This is mainly used on Tax Type based generates rule.
fixedChargeDetailType
object
Fixed charge amount could be specified by flat fee or be a percentage of the rate amount.
7 properties
translationTextType4000
object
Contains Multiple translated texts and language codes.
2 properties
aRInvoiceType
object
Details of an AR Invoice.
54 properties
transactionCodeTotalsInformationType
object
Budget Forecast totals information for Transaction segment.
6 properties
folioPrintQueueType
object
Folio Print queue identification details
7 properties
templateCustomNumberConfig
object
Request object to create a new template custom number configuration.
3 properties
authorizerGroupsCriteriaType
object
Criteria to change authorizer group.
2 properties
transactionArrangementCodeType
object
This has arrangement codes association details for a transaction code.
5 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.
aRInvoiceCategory
string
marketCodeInformationType
object
Budget Forecast information for budget segment code.
8 properties
cashSurchargeRangeType
object
Cash Surcharge identification details
6 properties
hotelTransactionGeneratesSetupType
object
Defines the Generates Setup and its Calculation Rules.
7 properties
transactionCodeOwnership
object
3 properties
hotelNoShowPostingRulesType
array
Holds No Show Posting Rules Configuration details.
calculatedPosting
object
3 properties
profileIdList
array
Unique Id that references an object uniquely in the system.
consumableInventoryItemGroupType
string
The item group of consumable inventory.
authorizationConfigRules
object
3 properties
reservationAllowedActionType
string
Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation.
links
array
templateCustomNumberConfigDetails
object
Response object for fetching template custom number configurations.
3 properties
monthlyTransactionVarianceInfoType
object
Revenue Variance information for a segment code for a month.
2 properties
resSharedGuestInfoType
object
Contains information regarding the share reservation.
4 properties
customChargeRangeType
object
The lower and upper range value for which the corresponding price is posted as a custom charge.
3 properties
adjustmentReasonCodeType
string
Defines values for Adjustment reason codes. e.g. ADJ for adjustment, COR for correction, DEL for deletion.
folioArrangementCodesCopy
object
3 properties
collectingAgentTaxesType
object
Type which holds collection of Agent Tax details
2 properties
namePrefixType
string
Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.)
scopeType
string
Minimum required and complimentary values are applicable Per Stay.
communicationStatusType
string
Enum to denote the Status of Readiness messages sent to Guest Devices.
resPaymentCardType
object
Information on a credit card for the customer.
19 properties
folioCopyLegendType
object
Search criteria to fetch folio copy legends information.
6 properties
numberCodeType
string
Used for Number specific codes for OPERA tables. Possible values of this pattern are 1, 10, 17, THOUSAND, BILLION, etc.
resHousekeepingType
object
Holds housekeeping turndown service information for the room.
7 properties
exchangeRates
object
3 properties
indicatorsType
array
Collection of lamp indicators.
hotelTransactionGroupsType
array
Hotel's Transaction Group configuration.
taxBracketAmountsType
array
Details used for storing information about a tax bracket amount.
authorizerGroups
object
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
telephoneType
object
Information on a telephone number for the customer.
12 properties
packageArrangementCodesCopy
object
3 properties
transactionDiversionRuleLevelType
string
Reservation level.
uDFGenerateType
object
Defines UDF rule for generates.
3 properties
transactionDiscountCodeType
string
The code type on which the transaction discount is based.
transactionDiversionRulesType
array
Collection of Transaction Diversion Rule List
cardOptionType
object
Switch card options.
3 properties
articles
object
Request to change articles.
4 properties
fiscalCommandType
object
Fiscal Command details.
5 properties
instanceLink
object
Metadata describing link description objects that MAY appear in the JSON instance representation.
7 properties
transactionCodesCopy
object
3 properties
noShowPostingRuleType
object
Provides information about No Show Posting Rule Configuration.
3 properties
transactionVarianceInfoType
array
Monthly Revenue Variance information.
traceResolveType
object
2 properties
generateCalculationBucketsType
object
Defines the buckets the generated amount can be added to.
3 properties
authorizerInfoType
object
Authorizer Information
5 properties
trxSetupType
object
Transaction Code setup details.
20 properties
resCommunicationType
object
Communication details for a reservation.
2 properties
dailyPlanCodes
object
3 properties
gUINumberRules
array
List of GUI number rules
paymentMethodsInfo
object
9 properties
customChargesConfig
object
Request object for creating new Custom Charges.
3 properties
taxBracketsType
array
Details used for storing information about a tax bracket.
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
applicationUserType
object
Information to uniquely identify an application user
2 properties
basicEmailType
string
Email address
marketCodeTotalInformationType
object
Budget Forecast information for segment.
6 properties
aRInvoicesType
array
A collection of AR Invoices.
customChargeRuleTypeType
object
The rule types for custom charge.
2 properties
customCodeInformationType
object
Budget Forecast information for Custom segment code.
8 properties
numberDescriptionType
object
Indicates type definition for Numbers.
3 properties
customChargesConfigDetails
object
Response object for fetching Custom Charges.
3 properties
articleInfoType
object
Information regarding an article.
10 properties
folioTypeProfileAttributes
string
Profile is not configured with Tax Id.
noShowPostingRulesEdit
object
3 properties
compAuthorizers
object
9 properties
cateringVarianceInfoType
array
Monthly Variance information.
transactionCodeInformationType
object
Budget Forecast information for Transaction segment code.
9 properties
authBillingInstructionsType
array
Set of Billing Instruction codes.
currencyLimitType
object
Type used for Currency Limits.
3 properties
compAuthorizer
object
3 properties
folioPrintQueuesType
array
List of folio print queues
resGuaranteeType
object
Validations type record returned after Validations are done.
3 properties
operaControlSequences
object
3 properties
phoneNumberType
string
Phone number
trxCodeAccessRoleType
object
Role having access to set of transaction codes
4 properties
membershipTypeLevelType
object
2 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…
hotelInterfaceStatusType
string
Status of the Hotel Interface either STOPPED or RUNNING.
cateringCodeInformationBaseType
object
Budget Forecast information for Catering segment code.
5 properties
depositTypeType
string
Represents the Folio Deposit Type.
customChargeExemptionsConfigCopy
object
3 properties
compTypesToBeChanged
object
Request object for changing Comp Types.
3 properties
fiscalPeriodEditType
object
Values of the old primary key.
4 properties
transactionCodeInformationBaseType
object
Budget Forecast information for Transaction segment code.
5 properties
revenueBucketCodeType
object
This gives detailed information about a trx code arrangement.
9 properties
cateringInfoType
object
Revenue and Covers information for a catering segment code. Holds total and monthly information.
3 properties
emailType
object
Information on an email for the customer.
11 properties
budgetForecastCustomInfoType
object
Budget Forecast information for budget Custom codes.
2 properties
customChargeExemptionsConfigToBeCreated
object
2 properties
fiscalCommandsDetails
object
Response object for fetching Fiscal Commands.
2 properties
revenueTypeMappingListType
array
Collection of multiple Revenue type mapping codes.
compTypesCriteria
object
Request object for creating CompTypes.
3 properties
adjustmentCodesCopy
object
3 properties
revenueTypeMappingCopy
object
Request object for Copying Revenue Type Mapping.
3 properties
fixedChargeType
object
Holds fixed charge information.
8 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.
trxCodesInfoType
array
List of Transaction codes info.
bucketRedemptionCodesType
array
Details for Bucket Redemption codes along with associated transaction codes.
rateCodeInformationBaseType
object
Budget Forecast information for budget segment code.
4 properties
authorizerTrxLimitType
object
A representation of the information of Transaction Limit.
5 properties
reservationAllowedActionsType
array
Allowed action.
dailyPlanCodeType
object
Generic Type to specify unique/primary id for the code. mostly used for Hotel level configuration codes removal request.
8 properties
vIPType
object
The supplier's ranking of the customer.
2 properties
currencyExchangeType
string
E-certificate conversion.
transactionDiscount
object
3 properties
searchMatchesType
array
List of Generic Name-Value-Pair Parameters used for super search matches.
exchangeRatesDetails
object
3 properties
revenueNightsVarianceInfoType
array
Monthly Revenue Variance information.
copyTransactionSubgroupsType
object
Copy information required to copy transaction subgroup type
2 properties
vouchersDetails
object
Object for Voucher Info.
3 properties
marketCodeInfoType
object
4 properties
resPreConfiguredRoutingInstrType
object
Instruction to attach Pre-Configured Routing Instructions to a Reservation.
4 properties
monthlyValueInfoType
object
Holds monthly value summary information
2 properties
folioTypeLegendMappingConfigType
object
Folio type legened mapping information.
5 properties
bucketRedemptionCodeType
object
This gives detailed information about redemption code.
5 properties
functionArgumentsType
array
Collection of function arguments and their corresponding values.
cateringTotalsInformationType
object
Budget Forecast totals information for Catering segment.
6 properties
transactionDiscounts
object
3 properties
aRPaymentType
object
Details of an AR Payment.
18 properties
reservationBlockType
object
Key information about the block for a reservation.
3 properties
fixedChargeFrequencyType
string
Yearly.
transactionDiscountRuleType
string
The rule type on which the transaction discount is based.
fiscalPeriods
object
4 properties
anonymizationStatusType
string
Guest has been anonymized.
fiscalPeriodsType
array
List of Fiscal Periods.
rateCodeTotalInformationType
object
Budget Forecast information for segment.
6 properties
taxBracketsCopy
object
3 properties
customChargeExemptionsConfigToBeChanged
object
2 properties
roleLevelType
string
hotelTransactionDiscountType
object
Provides information about Transaction Discount Configuration.
14 properties
6 required
externalReferenceType
object
This type contains unique information of external reference.
3 properties
folioCodeDescriptionType
object
This contains a folio code and description information.
2 properties
fiscalPeriodsInfo
object
3 properties
anonymizationType
object
Provides information about guest's anonymization status.
2 properties
hotelInterfaceTypeType
string
XML Posting Interface
controlSequenceType
object
Provides information about the OPERA Control Sequence
7 properties
changeTransactionCodeOwnershipType
object
Change Transaction Code Ownership configuration details.
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 RnA Activities GraphQL API
OPERA Cloud RnA ARAccountsReceivable GraphQL API
OPERA Cloud RnA ARAgingReport GraphQL API
OPERA Cloud RnA ARLedger GraphQL API
OPERA Cloud RnA BookingReservationExtended GraphQL API
OPERA Cloud RnA BookingsBlockProductionChanges GraphQL API
OPERA Cloud RnA BookingsBlockStatusChanges GraphQL API
OPERA Cloud RnA BookingsBlock GraphQL API
OPERA Cloud RnA BookingsReservation GraphQL API
OPERA Cloud RnA CateringEventForecast GraphQL API
OPERA Cloud RnA CateringEventPostings GraphQL API
OPERA Cloud RnA CateringEventStatusChanges GraphQL API
#CashieringConfig
Where this information came from
This is an independent, third-party profile of Oracle Hospitality Cashiering Config 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.