openapi: 3.2.0 info: title: OPERA Cloud Front Desk Configuration Cashiering Config API description: APIs to cater for Front Desk Configuration in OPERA Cloud. Here you can find operations to get, post, put and delete front desk codes such as commission codes, transaction groups, codes & subgroups, articles, payment methods and credit card types.

Compatible with OPERA Cloud release 26.2.0.0.

This document and all content within is available under the Universal Permissive License v 1.0 (https://oss.oracle.com/licenses/upl). Copyright (c) 2020,2023 Oracle and/or its affiliates.



Compatible with OPERA Cloud release 20.99.99.99.

This document and all content within is available under the Universal Permissive License v 1.0 (https://oss.oracle.com/licenses/upl). Copyright (c) 2020, 2026 Oracle and/or its affiliates.

version: 26.2.0.0 termsOfService: https://www.oracle.com/legal/terms.html contact: email: hospitality_apis_ww_grp@oracle.com license: name: UPL url: https://opensource.org/licenses/upl servers: - url: /fof/config/v1 tags: - name: CashieringConfig description: Cashiering configurations affect the control and management of financial transactions at your property. You can configure cashiering components for articles for sale, cancellation handling, deposits, folios, settlements, exchange rates, payment methods and so on. paths: /articles: put: summary: Operation to change Articles. description: Operation to change articles.

OperationId:putArticles

operationId: putArticles parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/articles' description: Request to change articles. required: true post: summary: Operation to create Articles. description: Operation to create articles.

OperationId:postArticles

operationId: postArticles parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/articles' description: Request to create articles. required: true get: summary: Operation to fetch Articles. description: Use this API to return articles for one or multiple hotels based on search criteria such as hotelIds, transactionCodes, articleCodes, etc.One transaction code can sometimes serve as an umbrella for multiple articles, which can be posted using that transaction code. For example, a single mini bar food transaction code might cover potato chips, crackers, peanuts, pretzels, and so on.

OperationId:getArticles

operationId: getArticles parameters: - name: hotelIds in: query required: true style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: transactionCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: articleCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: universalProductCode in: query required: false description: Unique Universal product code search criteria. schema: type: string - name: includeInactive in: query x-example: 'false' required: false description: Indicator that tells whether to include inactive articles in search results. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response for fetching articles. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/articlesInfo' '204': description: Articles not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig delete: summary: Operation to delete Articles. description: Operation to remove articles.

OperationId:deleteArticles

operationId: deleteArticles parameters: - name: hotelId in: query required: true description: Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X. schema: type: string - name: articleCodes in: query description: Unique code of the article. required: true style: form explode: true schema: type: array items: type: string - name: articleHotelId in: query description: Hotel code to which the article belongs. required: false style: form explode: true schema: type: array items: type: string - name: inactive in: query description: Indicates whether the article is inactive or not. x-example: - 'false' required: false style: form explode: true schema: type: array items: type: boolean - name: orderSequence in: query description: Display Order sequence. required: false style: form explode: true schema: type: array items: type: number - name: description in: query description: Description of the article. required: false style: form explode: true schema: type: array items: type: string - name: transactionCode in: query description: Transaction code to which the article belongs. required: false style: form explode: true schema: type: array items: type: string - name: amount in: query required: false description: A monetary amount. schema: type: number - name: currencyCode in: query required: false description: Provides a currency code to reflect the currency in which an amount may be expressed. schema: type: string - name: availableForPostIt in: query required: false description: Indicates whether the article is available for post it. schema: type: boolean - name: color in: query required: false description: Color configuration type. This color configuration provides a visual category of entities. schema: type: string enum: - Red - DarkRed - Green - DarkGreen - LightGreen - Orange - White - Yellow - DarkYellow - Purple - Brown - Gray - Aqua - Chocolate - Blue - LightBlue - DarkBlue - Cyan - DarkCyan - Magenta - DarkMagenta - Black uniqueItems: true - name: universalProductCode in: query description: Unique Universal product code of the article. required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /authorizationConfigRule: put: summary: Operation to change AuthorizationConfigRule. description: '

OperationId:putAuthorizationConfigRule

' operationId: putAuthorizationConfigRule parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/authorizationConfigRules' description: Request object to change authorization rule. required: true post: summary: Operation to create AuthorizationConfigRule. description: '

OperationId:postAuthorizationConfigRule

' operationId: postAuthorizationConfigRule parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/authorizationConfigRules' description: Request object to create new authorization rule for given hotel code. required: true delete: summary: Operation to delete AuthorizationConfigRule. description: '

OperationId:deleteAuthorizationConfigRule

' operationId: deleteAuthorizationConfigRule parameters: - name: hotelId in: query description: Property associated with authorization rule required: true style: form explode: true schema: type: array items: type: string - name: roomType in: query description: Authorization rule Room type. required: false style: form explode: true schema: type: array items: type: string - name: roomClassHotelId in: query required: false schema: type: string - name: roomClassCode in: query required: false schema: type: string - name: sourceCodeHotelId in: query required: false schema: type: string - name: sourceCode in: query required: false schema: type: string - name: rateCategory in: query required: false description: Rate category Code. schema: type: string - name: rateCode in: query description: Rate code associated to this rule. required: false style: form explode: true schema: type: array items: type: string - name: guaranteeCode in: query description: Guarantee code associated to this rule. required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /authorizationConfigRules: get: summary: Operation to fetch AuthorizationConfigRules. description: '

OperationId:getAuthorizationConfigRules

' operationId: getAuthorizationConfigRules parameters: - name: hotelId in: query required: false description: Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for FetchAuthorizationConfigRules. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/authorizationConfigRulesInfo' '204': description: AuthorizationConfigRules not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /authorizerGroups: put: summary: Operation to change AuthorizerGroups. description: Operation to change Authorizer Groups.

OperationId:putAuthorizerGroups

operationId: putAuthorizerGroups parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/authorizerGroupsToChange' description: Request object for changing existing Authorizer Group Configuration. required: true post: summary: Operation to create AuthorizerGroups. description: Operation to create Authorizer Groups.

OperationId:postAuthorizerGroups

operationId: postAuthorizerGroups parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/authorizerGroups' description: Request object for creating new Authorizer Group Configuration. required: true get: summary: Operation to fetch AuthorizerGroups. description: Operation to fetch Authorizer Groups.

OperationId:getAuthorizerGroups

operationId: getAuthorizerGroups parameters: - name: hotelIds in: query required: true style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: authorizerGroupsCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Authorizer Groups. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/authorizerGroups' '204': description: AuthorizerGroups not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig delete: summary: Operation to delete AuthorizerGroups. description: Operation to remove Authorizer Groups.

OperationId:deleteAuthorizerGroups

operationId: deleteAuthorizerGroups parameters: - name: authorizerGroup in: query required: false description: Configuration code. schema: type: string - name: hotelId in: query required: false description: Hotel where the code is configured. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /budgetForecast: put: summary: Operation to delete BudgetForecast. description: Operation to Delete Budget Forecast information.

OperationId:deleteBudgetForecast

operationId: deleteBudgetForecast parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/budgetForecastToDelete' description: Request to load the Budget or Forecast information. required: true get: summary: Operation to fetch BudgetForecast. description: Operation to fetch Budget Forecast information.

OperationId:getBudgetForecast

operationId: getBudgetForecast parameters: - name: hotelId in: query required: false description: Opera Hotel code for the Fetch Revenue information. schema: type: string - name: year in: query required: false description: Year of revenue to be fetched. schema: type: string - name: marketSegmentNights in: query required: false description: Flag to indicate if nights information has to be included. schema: type: boolean - name: marketSegmentRevenue in: query required: false description: Flag to indicate if revenue information has to be included. schema: type: boolean - name: marketSegmentABVariance in: query x-example: 'false' required: false description: Flag to include ABVariance revenue/nights information. schema: type: boolean - name: marketSegmentAFVariance in: query x-example: 'false' required: false description: Flag to include AFVariance revenue/nights information. schema: type: boolean - name: marketSegmentActual in: query x-example: 'false' required: false description: Flag to include Actual revenue/nights information. schema: type: boolean - name: marketSegmentBudget in: query x-example: 'false' required: false description: Flag to include Budget revenue/nights information. schema: type: boolean - name: marketSegmentFBVariance in: query x-example: 'false' required: false description: Flag to include FBVariance revenue/nights information. schema: type: boolean - name: marketSegmentForecast in: query x-example: 'false' required: false description: Flag to include Forecast revenue/nights information. schema: type: boolean - name: marketSegmentMarketCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: rateSegmentNights in: query required: false description: Flag to indicate if nights information has to be included. schema: type: boolean - name: rateSegmentRevenue in: query required: false description: Flag to indicate if revenue information has to be included. schema: type: boolean - name: rateSegmentABVariance in: query x-example: 'false' required: false description: Flag to include ABVariance revenue/nights information. schema: type: boolean - name: rateSegmentAFVariance in: query x-example: 'false' required: false description: Flag to include AFVariance revenue/nights information. schema: type: boolean - name: rateSegmentActual in: query x-example: 'false' required: false description: Flag to include Actual revenue/nights information. schema: type: boolean - name: rateSegmentBudget in: query x-example: 'false' required: false description: Flag to include Budget revenue/nights information. schema: type: boolean - name: rateSegmentFBVariance in: query x-example: 'false' required: false description: Flag to include FBVariance revenue/nights information. schema: type: boolean - name: rateSegmentForecast in: query x-example: 'false' required: false description: Flag to include Forecast revenue/nights information. schema: type: boolean - name: rateSegmentRateCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: customSegmentCustomValue in: query required: false description: Flag to indicate if Value information has to be fetched. schema: type: boolean - name: customSegmentABVariance in: query x-example: 'false' required: false description: Flag to include ABVariance revenue/nights information. schema: type: boolean - name: customSegmentAFVariance in: query x-example: 'false' required: false description: Flag to include AFVariance revenue/nights information. schema: type: boolean - name: customSegmentActual in: query x-example: 'false' required: false description: Flag to include Actual revenue/nights information. schema: type: boolean - name: customSegmentBudget in: query x-example: 'false' required: false description: Flag to include Budget revenue/nights information. schema: type: boolean - name: customSegmentFBVariance in: query x-example: 'false' required: false description: Flag to include FBVariance revenue/nights information. schema: type: boolean - name: customSegmentForecast in: query x-example: 'false' required: false description: Flag to include Forecast revenue/nights information. schema: type: boolean - name: customSegmentCustomCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: transactionSegmentRevenue in: query required: false description: Flag to indicate if revenue information has to be fetched. schema: type: boolean - name: transactionSegmentABVariance in: query x-example: 'false' required: false description: Flag to include ABVariance revenue/nights information. schema: type: boolean - name: transactionSegmentAFVariance in: query x-example: 'false' required: false description: Flag to include AFVariance revenue/nights information. schema: type: boolean - name: transactionSegmentActual in: query x-example: 'false' required: false description: Flag to include Actual revenue/nights information. schema: type: boolean - name: transactionSegmentBudget in: query x-example: 'false' required: false description: Flag to include Budget revenue/nights information. schema: type: boolean - name: transactionSegmentFBVariance in: query x-example: 'false' required: false description: Flag to include FBVariance revenue/nights information. schema: type: boolean - name: transactionSegmentForecast in: query x-example: 'false' required: false description: Flag to include Forecast revenue/nights information. schema: type: boolean - name: transactionSegmentTransactionCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: transactionSegmentTransactionCodeGrp in: query required: false description: Transaction code group of segment code. schema: type: string - name: cateringSegmentCovers in: query required: false description: Flag to indicate if Covers information has to be included. schema: type: boolean - name: cateringSegmentRevenue in: query required: false description: Flag to indicate if revenue information has to be included. schema: type: boolean - name: cateringSegmentABVariance in: query x-example: 'false' required: false description: Flag to include ABVariance revenue/nights information. schema: type: boolean - name: cateringSegmentAFVariance in: query x-example: 'false' required: false description: Flag to include AFVariance revenue/nights information. schema: type: boolean - name: cateringSegmentActual in: query x-example: 'false' required: false description: Flag to include Actual revenue/nights information. schema: type: boolean - name: cateringSegmentBudget in: query x-example: 'false' required: false description: Flag to include Budget revenue/nights information. schema: type: boolean - name: cateringSegmentFBVariance in: query x-example: 'false' required: false description: Flag to include FBVariance revenue/nights information. schema: type: boolean - name: cateringSegmentForecast in: query x-example: 'false' required: false description: Flag to include Forecast revenue/nights information. schema: type: boolean - name: cateringSegmentCateringCodeGrp in: query required: false description: Catering code group of segment code. schema: type: string - name: cateringSegmentCateringCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response for Budget forecast information. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/budgetForecastInformation' '204': description: BudForecast not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /budgetForecast/set: put: summary: Operation to set BudgetForecast. description: Operation to add/update Budget Forecast information.

OperationId:setBudgetForecast

operationId: setBudgetForecast parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/budgetForecastInformationBase' description: Request to load the Budget or Forecast information. required: true /cashSurchargeRange: put: summary: Operation to change the Cash Surcharge Range. description: Operation to change Cash the Surcharge Range.

OperationId:putCashSurchargeRange

operationId: putCashSurchargeRange parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/cashSurchargeRanges' description: Request object for changing a Cash Surchage Range required: true post: summary: Operation to create a Cash Surcharge Range. description: Operation to create a Cash Surcharge Range.

OperationId:postCashSurchargeRange

operationId: postCashSurchargeRange parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/cashSurchargeRanges' description: Request object for creating a new Cash Surcharge Range. required: true get: summary: Operation to fetch Cash Surcharge Ranges. description: Operation to fetch Cash Surcharge Ranges.

OperationId:getCashSurchargeRange

operationId: getCashSurchargeRange parameters: - name: hotelIds in: query required: true style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: codes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response for fetch the Cash Surcharge Ranges content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/cashSurchargeRanges' '204': description: Cash Surcharge Range not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig delete: summary: Operation to delete the Cash Surcharge Range. description: Operation to remove the Cash Surcharge Ranges.

OperationId:deleteCashSurchargeRange

operationId: deleteCashSurchargeRange parameters: - name: hotelId in: query description: Property associated with Cash Surcharge Range required: true style: form explode: true schema: type: array items: type: string - name: cashSurchargeType in: query description: Cash Surchage Range type required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /cashierDetails/cashiers: get: summary: Operation to fetch Cashiers. description: Use this API to return Chashier information based on search criteria such as cashierIDs, limit, name.

OperationId:getCashiers

The maximum allowable limit for this API is 20.

operationId: getCashiers deprecated: true parameters: - name: cashierIDs in: query description: Numberic code for cashier ID. x-example: - '54' required: true style: form explode: true schema: type: array items: type: number maxItems: 4000 - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: offset in: query required: false description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. schema: type: integer default: 0 - name: name in: query required: false description: Partial name of a cashier. schema: type: string - name: includeInactive in: query x-example: 'false' required: false description: Indicator that tells whether to include inactive cashiers in search results. schema: type: boolean - name: appUser in: query required: false description: Name of the application user associated with the cashier id schema: type: string maxLength: 250 minLength: 0 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching information regarding Cashiers. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/cashiersDetails' '204': description: Cashiers not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /cashierDetails/cashiers/search: post: summary: Operation to fetch Cashiers. description: Use this API to return Chashier information based on search criteria such as cashierIDs, limit, name.

OperationId:searchCashiers

The maximum allowable limit for this API is 20.

operationId: searchCashiers parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching information regarding Cashiers. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/cashiersDetails' '204': description: Cashiers not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/searchCashiersRequest' description: Request body for search cashiers required: true /cashiers: put: summary: Operation to change CashiersDetails. description: This Operation to Change a Cashier.

OperationId:putCashiers

operationId: putCashiers parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/cashiers' description: Request objects for modifying cashiers required: true post: summary: Operation to create Cashiers. description: Operation to Create Cashier.

OperationId:postCashiers

operationId: postCashiers parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/cashiers' description: Request object for creating cashiers. required: true /cashiers/nextAvailable: get: summary: Operation to fetch AvailableCashierNumber. description: The operation returns a next available Cashier Number to be used while creating a new Cashier.

OperationId:getAvailableCashierNumber

operationId: getAvailableCashierNumber parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object that returns next available cashier number. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/cashierNumber' '204': description: AvailableCashierNumber not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /collectingAgentTaxes: put: summary: Operation to change CollectingAgentTaxes. description: Operation to change Collecting Agent Taxes.

OperationId:putCollectingAgentTaxes

operationId: putCollectingAgentTaxes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/collectingAgentTaxes' description: Request object to change Collecting Agent Taxes. required: true post: summary: Operation to create CollectingAgentTaxes. description: Operation to create Collecting Agent Taxes.

OperationId:postCollectingAgentTaxes

operationId: postCollectingAgentTaxes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/collectingAgentTaxes' description: Request object to create Collecting Agent Taxes. required: true get: summary: Operation to fetch CollectingAgentTaxes. description: Operation to fetch Collecting Agent Taxes.

OperationId:getCollectingAgentTaxes

operationId: getCollectingAgentTaxes parameters: - name: hotelId in: query required: false description: It represents Hotel Code schema: type: string - name: taxCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: taxType description: Parameter to fetch Collecting Agent Taxes based on tax types which are marked Collecting Agent. The list of tax types is fetched using getTaxTypes operation. in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 40 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetch Collecting Agent Taxes request. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/collectingAgentTaxes' '204': description: CollectingAgentTaxes not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig delete: summary: Operation to delete CollectingAgentTaxes. description: Operation to remove Collecting Agent Taxes.

OperationId:deleteCollectingAgentTaxes

operationId: deleteCollectingAgentTaxes parameters: - name: hotelId in: query description: It represents Hotel code required: true style: form explode: true schema: type: array items: type: string - name: taxCode in: query description: Primary Key Sequence. required: false style: form explode: true schema: type: array items: type: integer minimum: 1 maximum: 5 - name: taxTypeCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /compAuthorizers/set: put: summary: Operation to set CompAuthorizer. description: Operation to Set Comp Authorizer.

OperationId:setCompAuthorizer

operationId: setCompAuthorizer parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/compAuthorizer' description: Retrieve a summary of transactions for a guest or a set of guests. required: true /compTypes: post: summary: Operation to Create Comp Types description: Operation to Create Comp Types

OperationId:postCompTypes

operationId: postCompTypes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/compTypesCriteria' description: Request object for creating CompTypes. required: true put: summary: Operation to Change Comp Types. description: Operation to Change Comp Types.

OperationId:changeCompTypes

operationId: changeCompTypes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/compTypesStatus' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/compTypesToBeChanged' description: Request object for changing Comp Types. required: true /compTypes/codes/{compTypesCode}: delete: summary: Operation to Remove Comp Types. description: Operation to Remove Comp Types.

OperationId:removeCompTypes

operationId: removeCompTypes parameters: - name: compTypesCode in: path required: true description: Comp Types Code to be deleted. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /currencyExchangeServiceTaxes: put: summary: Operation to change ExchangeServiceTaxes. description: Operation to change currency exchange service taxes.

OperationId:putCurrencyExchangeServiceTaxes

operationId: putCurrencyExchangeServiceTaxes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/currencyExchangeServiceTaxes' description: Request object for changing currency exchange service taxes required: true post: summary: Operation to create CurrencyExchangeServiceTaxes. description: Operation to create currency exchange service taxes.

OperationId:postCurrencyExchangeServiceTaxes

operationId: postCurrencyExchangeServiceTaxes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/currencyExchangeServiceTaxes' description: Request object for creating new currency exchange service taxes required: true get: summary: Operation to fetch CurrencyExchangeServiceTaxes. description: Operation to fetch currency exchange service taxes.

OperationId:getCurrencyExchangeServiceTaxes

operationId: getCurrencyExchangeServiceTaxes parameters: - name: hotelIds in: query required: true style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: codes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response for fetch currency exchange service taxes content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/currencyExchangeServiceTaxes' '204': description: CurrencyExchangeServiceTaxes not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig delete: summary: Operation to delete CurrencyExchangeServiceTaxes. description: Operation to remove currency exchange service taxes.

OperationId:deleteCurrencyExchangeServiceTaxes

operationId: deleteCurrencyExchangeServiceTaxes parameters: - name: hotelId in: query description: Property associated with currency exchange service tax required: true style: form explode: true schema: type: array items: type: string - name: currencyExchangeServiceTaxCode in: query description: Currency exchange service tax code required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /customCharges/exemptions: get: summary: Operation to fetch Custom Charge Exemptions Config. description: You can use this API to fetch Custom Charge Exemptions Config.

OperationId:getCustomChargeExemptions

operationId: getCustomChargeExemptions parameters: - name: hotelId in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: configurationId in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: includeInactive in: query required: false description: Indicator that tells whether to include inactive articles in search results. schema: type: boolean default: 'false' - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Custom Charge Exemptions. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/customChargeExemptionsConfig' '204': description: CustomChargeExemptions not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /dailyPlanCodes: put: summary: Operation to change DailyPlanCodes. description: '

OperationId:putDailyPlanCodes

' operationId: putDailyPlanCodes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/dailyPlanCodes' description: Request object for changing daily plan codes. required: true get: summary: Operation to fetch DailyPlanCodes. description: '

OperationId:getDailyPlanCodes

' operationId: getDailyPlanCodes parameters: - name: hotelIds in: query required: true style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: includeTransactionCodes in: query x-example: 'false' required: false description: A flag that determines whether or not to fetch associated transaction codes. Fetches only the arrangement codes when this flag is true. schema: type: boolean - name: arrangementCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching daily plan codes. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/dailyPlanCodes' '204': description: DailyPlanCodes not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /defaultPaymentMethodRules: get: summary: Operation to fetch DefaultPaymentMethodRule. description: Operation to fetch payment method rule.

OperationId:getDefaultPaymentMethodRule

The maximum allowable limit for this API is 50.

operationId: getDefaultPaymentMethodRule parameters: - name: hotelIds in: query required: true style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: transactionCodes in: query required: true style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: paymentMethods in: query required: true style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: offset in: query required: false description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. schema: type: integer default: 0 - name: fetchInstructions in: query description: Simple Type for payment method fetch instruction. x-example: - CardRanges required: false style: form explode: true schema: type: array items: type: string enum: - CardRanges uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response for fetching default payment method rule. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/defaultPaymentMethodRule' '204': description: DefaultPaymentMethodRule not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /exchangeRates: get: summary: Operation to fetch ExchangeRates. description: You can use this API to retrieve exchange rate information for a hotel. You can search by hotel, Currency Code and exchange types. Results can include past, current and future exchange rate information for a currency.

OperationId:getExchangeRatesInfo

operationId: getExchangeRatesInfo parameters: - name: hotelId in: query required: false description: Property where exchange rate is set. schema: type: string - name: exchangeTypes in: query description: E-certificate conversion. required: false style: form explode: true schema: type: array items: type: string enum: - Cash - Settlement - Posting - Check - TACommission - Membership - Certificate uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Collection of exchange rates and their information. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/exchangeRatesDetails' '204': description: ExchangeRatesInfo not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig put: summary: Operation to delete ExchangeRates. description: Operation to Delete Exchange Rates.

OperationId:deleteExchangeRates

operationId: deleteExchangeRates parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/exchangeRates' description: Exchange Rates to be Set. required: true /exchangeRates/set: put: summary: Operation to set ExchangeRates. description: The operation sets exchange rates.

OperationId:setExchangeRates

operationId: setExchangeRates parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/exchangeRates' description: Exchange Rates to be Set. required: true /expenseArrangementCodes: put: summary: Operation to change ExpenseArrangementCodes. description: '

OperationId:putExpenseArrangementCodes

' operationId: putExpenseArrangementCodes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/expenseArrangementCodes' description: Request object for changing expense arrangement codes. required: true post: summary: Operation to create ExpenseArrangementCodes. description: '

OperationId:postExpenseArrangementCodes

' operationId: postExpenseArrangementCodes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/expenseArrangementCodes' description: Request object for creating new expense arrangement codes. required: true get: summary: Operation to fetch ExpenseArrangementCodes. description: '

OperationId:getExpenseArrangementCodes

' operationId: getExpenseArrangementCodes parameters: - name: hotelIds in: query required: true style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: includeTransactionCodes in: query x-example: 'false' required: false description: A flag that determines whether or not to fetch associated transaction codes. Fetches only the arrangement codes when this flag is true. schema: type: boolean - name: arrangementCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching expense arrangement codes. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/expenseArrangementCodes' '204': description: ExpenseArrangementCodes not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig delete: summary: Operation to delete ExpenseArrangementCodes. description: '

OperationId:deleteExpenseArrangementCodes

' operationId: deleteExpenseArrangementCodes parameters: - name: hotelId in: query description: Hotel where the code is configured. required: true style: form explode: true schema: type: array items: type: string - name: code in: query description: Configuration code. required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /expenseArrangementCodes/copy: put: summary: Operation to copy ExpenseArrangementCodes. description: '

OperationId:copyExpenseArrangementCodes

' operationId: copyExpenseArrangementCodes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/expenseArrangementCodesCopy' description: List of the expense arrangement codes to be copied. required: true /fiscalFolioParameters: put: summary: Operation to change FiscalFolioParameters. description: Operation to change Fiscal Folio Parameters.

OperationId:putFiscalFolioParameters

operationId: putFiscalFolioParameters parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/fiscalFolioParameters' description: Request object for changing existing Fiscal Folio Parameter Configurations. required: true get: summary: Operation to fetch FiscalFolioParameters. description: Operation to fetch Fiscal Folio Parameters.

OperationId:getFiscalFolioParameters

operationId: getFiscalFolioParameters parameters: - name: hotelIds in: query required: true style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: code in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: codes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: internal in: query x-example: 'false' required: false description: Indicates whether the Fiscal Folio Parameter is user created or from seed data. Set this true to see the standard Fiscal Folio Parameters that are seeded along with the manually created Fiscal Folio Parameters. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Fiscal Folio Parameter configurations. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/fiscalFolioParameters' '204': description: FiscalFolioParameters not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig delete: summary: Operation to delete FiscalFolioParameters. description: Operation to remove Fiscal Folio Parameters.

OperationId:deleteFiscalFolioParameters

operationId: deleteFiscalFolioParameters parameters: - name: hotelId in: query description: Code of the Hotel. required: false style: form explode: true schema: type: array items: type: string - name: partner in: query description: Fiscal folio parameter associated with Partner. required: false style: form explode: true schema: type: array items: type: string - name: code in: query description: Code of the Fiscal Folio Parameter. required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /fiscalPeriods: put: summary: Operation to change FiscalPeriods. description: Operation to change Fiscal Periods.

OperationId:putFiscalPeriods

operationId: putFiscalPeriods parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/fiscalPeriodsEdit' description: Request object to edit Fiscal Periods required: true post: summary: Operation to create FiscalPeriods. description: Operation to create Fiscal Periods.

OperationId:postFiscalPeriods

operationId: postFiscalPeriods parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/fiscalPeriods' description: Request object to create Fiscal Periods required: true get: summary: Operation to fetch FiscalPeriods. description: Operation to fetch Fiscal Periods.

OperationId:getFiscalPeriods

operationId: getFiscalPeriods parameters: - name: hotelId in: query required: true description: Resort for which the Period is defined. schema: type: string - name: year in: query required: false description: Year to search for. schema: type: number - name: periodType in: query required: false description: Defined Values for Fiscal Year Type. schema: type: string enum: - Calendar - Fiscal uniqueItems: true - name: period in: query required: false description: Period to search. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response for fetching Fiscal Periods content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/fiscalPeriodsInfo' '204': description: FiscalPeriods not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig delete: summary: Operation to delete FiscalPeriods. description: Operation to remove Fiscal Periods.

OperationId:deleteFiscalPeriods

operationId: deleteFiscalPeriods parameters: - name: hotelId in: query description: Resort for which the Period is defined. required: true style: form explode: true schema: type: array items: type: string - name: yearId in: query description: Id of the Year. required: false style: form explode: true schema: type: array items: type: number - name: startDate in: query description: Start Date of the Period required: false style: form explode: true schema: type: array items: type: string format: date - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /fiscalYears: put: summary: Operation to change FiscalYears. description: Operation to change Fiscal Years.

OperationId:putFiscalYears

operationId: putFiscalYears parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/fiscalYears' description: Request object to edit Fiscal Years required: true post: summary: Operation to create FiscalYears. description: Operation to create Fiscal Years.

OperationId:postFiscalYears

operationId: postFiscalYears parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/fiscalYears' description: Request object to create Fiscal Years required: true get: summary: Operation to fetch FiscalYears. description: Operation to fetch Fiscal Years.

OperationId:getFiscalYears

operationId: getFiscalYears parameters: - name: hotelId in: query required: true description: Search all years for this Resort. schema: type: string - name: year in: query required: false description: Year to Search. schema: type: number - name: yearType in: query required: false description: Defined Values for Fiscal Year Type. schema: type: string enum: - Calendar - Fiscal uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response for fetching Fiscal Years content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/fiscalYears' '204': description: FiscalYears not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig delete: summary: Operation to delete FiscalYears. description: Operation to remove Fiscal Years.

OperationId:deleteFiscalYears

operationId: deleteFiscalYears parameters: - name: hotelId in: query description: Resort for which the Year is defined. required: true style: form explode: true schema: type: array items: type: string - name: yearId in: query description: Unique id of the Year. required: false style: form explode: true schema: type: array items: type: number - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /folioArrangementCodes: put: summary: Operation to change FolioArrangementCodes. description: '

OperationId:putFolioArrangementCodes

' operationId: putFolioArrangementCodes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/folioArrangementCodes' description: Request object for changing folio arrangement codes. required: true post: summary: Operation to create FolioArrangementCodes. description: '

OperationId:postFolioArrangementCodes

' operationId: postFolioArrangementCodes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/folioArrangementCodes' description: Request object for creating new folio arrangement codes. required: true get: summary: Operation to fetch FolioArrangementCodes. description: '

OperationId:getFolioArrangementCodes

' operationId: getFolioArrangementCodes parameters: - name: hotelIds in: query required: true style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: includeTransactionCodes in: query x-example: 'false' required: false description: A flag that determines whether or not to fetch associated transaction codes. Fetches only the arrangement codes when this flag is true. schema: type: boolean - name: arrangementCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching folio arrangement codes. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/folioArrangementCodes' '204': description: FolioArrangementCodes not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig delete: summary: Operation to delete FolioArrangementCodes. description: '

OperationId:deleteFolioArrangementCodes

' operationId: deleteFolioArrangementCodes parameters: - name: hotelId in: query description: Hotel where the code is configured. required: true style: form explode: true schema: type: array items: type: string - name: code in: query description: Configuration code. required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /folioArrangementCodes/copy: put: summary: Operation to copy FolioArrangementCodes. description: '

OperationId:copyFolioArrangementCodes

' operationId: copyFolioArrangementCodes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/folioArrangementCodesCopy' description: List of folio arrangement codes to be copied. required: true /folioCopyLegends: put: summary: Operation to change FolioCopyLegends. description: Operation to change folio copy legends information

OperationId:putFolioCopyLegends

operationId: putFolioCopyLegends parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/folioCopyLegend' description: Request object to edit description of folio copy legends required: true get: summary: Operation to fetch FolioCopyLegends. description: Operation to fetch folio copy legends.

OperationId:getFolioCopyLegends

operationId: getFolioCopyLegends parameters: - name: codes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: languageCode in: query required: false description: Language code to be searched. schema: type: string - name: hotelId in: query required: false description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetch folio copy legend content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/folioCopyLegends' '204': description: FolioCopyLegends not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /folioPrintQueues: put: summary: Operation to change FolioPrintQueues. description: Operation to change folio print queues.

OperationId:putFolioPrintQueues

operationId: putFolioPrintQueues parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/folioPrintQueues' description: Request object for changing folio print queues required: true post: summary: Operation to create FolioPrintQueues. description: Operation to create folio print queues.

OperationId:postFolioPrintQueues

operationId: postFolioPrintQueues parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/folioPrintQueues' description: Request object for creating new folio print queues required: true get: summary: Operation to fetch FolioPrintQueues. description: Operation to folio fetch print queues.

OperationId:getFolioPrintQueues

operationId: getFolioPrintQueues parameters: - name: hotelId in: query required: true description: Property to be searched for schema: type: string - name: fetchInactive in: query x-example: 'false' required: false description: Determines whether to fetch inactive records or not. schema: type: boolean - name: queueName in: query required: false description: Queue name to be searched for schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response for fetch folio print queues content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/folioPrintQueues' '204': description: FolioPrintQueues not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig delete: summary: Operation to delete FolioPrintQueues. description: Operation to remove folio print queues.

OperationId:deleteFolioPrintQueues

operationId: deleteFolioPrintQueues parameters: - name: hotelId in: query description: Property associated with folio print queue required: true style: form explode: true schema: type: array items: type: string - name: queueName in: query description: Folio print queue name required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /folioTypeLegendMappings: get: summary: Operation to fetch folio type legend mappings config. description: Operation to fetch folio type legend mappings config.

OperationId:getFolioTypeLegendMappingsConfig

operationId: getFolioTypeLegendMappingsConfig parameters: - name: hotelId in: query required: true description: Property associated with folio type legend mapping schema: type: string - name: legendCode in: query required: true description: Legend code to which folio types attached. schema: type: string - name: folioType in: query required: false description: Folio type to be searched. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetch folio type legend mapping. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/folioTypeLegendMappingsConfigDetails' '204': description: FolioTypeLegendMappingsConfig not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig post: summary: Operation to create folio type legend mappings config. description: Operation to create folio type legend mappings config.

OperationId:postFolioTypeLegendMappingConfig

operationId: postFolioTypeLegendMappingConfig parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/folioTypeLegendMappingConfigCriteria' description: Request object to create folio type legend mapping information. required: true put: summary: Operation to change folio type legend mappings config. description: Operation to change folio type legend mappings config.

OperationId:changeFolioTypeLegendMappingConfig

operationId: changeFolioTypeLegendMappingConfig parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/folioTypeLegendMappingConfigStatus' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/folioTypeLegendMappingConfigToBeChanged' description: Request object to edit folio type legend mapping information. required: true /folioTypesConfig: put: summary: Operation to change FolioTypesConfig. description: Operation to change Folio Type Names.

OperationId:putFolioTypesConfig

operationId: putFolioTypesConfig parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/folioTypesConfig' description: Request object to change Folio Type Names. required: true post: summary: Operation to create FolioTypesConfig. description: Operation to Create Folio Type Names.

OperationId:postFolioTypesConfig

operationId: postFolioTypesConfig parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/folioTypesConfig' description: Request object to create Folio Type Name. required: true get: summary: Operation to fetch FolioTypesConfig. description: Operation to fetch Folio Type Names.

OperationId:getFolioTypesConfig

operationId: getFolioTypesConfig parameters: - name: hotelId in: query required: true description: Folio Type Names belong to Hotels. schema: type: string - name: folioTypeNamesCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: taxTypeCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Folio Type Names. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/folioTypesConfig' '204': description: FolioTypesConfig not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig delete: summary: Operation to delete FolioTypesConfig. description: Operation to remove Folio Type Names.

OperationId:deleteFolioTypesConfig

operationId: deleteFolioTypesConfig parameters: - name: hotelId in: query description: Hotel where the code is configured. required: true style: form explode: true schema: type: array items: type: string - name: code in: query description: Configuration code. required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /foreignCurrencies: put: summary: Operation to change ForeignCurrencies. description: Operation to change Foreign Currencies.

OperationId:putForeignCurrencies

operationId: putForeignCurrencies parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/foreignCurrencies' description: Request object to edit Foreign Currencies required: true post: summary: Operation to create ForeignCurrencies. description: Operation to create Foreign Currencies.

OperationId:postForeignCurrencies

operationId: postForeignCurrencies parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/foreignCurrencies' description: Request object to create Foreign Currencies required: true get: summary: Operation to fetch ForeignCurrencies. description: Operation to fetch Foreign Currencies.

OperationId:getForeignCurrencies

operationId: getForeignCurrencies parameters: - name: currencies in: query description: Codes to be searched. x-example: - USD required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: description in: query required: false description: Description text set to the search criteria schema: type: string - name: includeInactive in: query x-example: 'false' required: false description: Inactive flag used to include/exclude inactive foreign currencies from the search result schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response for fetching Foreign Currencies content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/foreignCurrencies' '204': description: ForeignCurrencies not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig delete: summary: Operation to delete ForeignCurrencies. description: Operation to remove Foreign Currencies.

OperationId:deleteForeignCurrencies

operationId: deleteForeignCurrencies parameters: - name: currencyCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /generates: put: summary: Operation to change TransactionGenerates. description: Use this API to update transaction generates for a specific hotel. Generates are rules used to calculate and post additional charges, such as service charges and taxes, when a particular sales charge transaction code is posted to guest, package or AR ledgers.

OperationId:putTransactionGenerates

operationId: putTransactionGenerates parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/hotelTransactionGenerates' description: Request to change transaction generates. required: true post: summary: Operation to create TransactionGenerates. description: Use this API to create transaction generates for a specific hotel. Generates are rules used to calculate and post additional charges, such as service charges and taxes, when a particular sales charge transaction code is posted to guest, package or AR ledgers.

OperationId:postTransactionGenerates

operationId: postTransactionGenerates parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/generatesInfoType' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/hotelTransactionGenerates' description: Request to create transaction generates. required: true /globalExchangeRates: get: summary: Operation to fetch GlobalExchangeRates. description: You can use this API to retrieve global exchange rate information for a chain. You can search by Currency Code and exchange types. Results can include past, current and future exchange rate information for a currency.

OperationId:getGlobalExchangeRatesInfo

operationId: getGlobalExchangeRatesInfo parameters: - name: exchangeTypes in: query description: E-certificate conversion. required: false style: form explode: true schema: type: array items: type: string enum: - Membership - Posting uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Collection of global exchange rates and their information. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/exchangeRatesDetails' '204': description: GlobalExchangeRatesInfo not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig put: summary: Operation to delete GlobalExchangeRates. description: Operation to Delete Global Exchange Rates.

OperationId:deleteGlobalExchangeRates

operationId: deleteGlobalExchangeRates parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/exchangeRates' description: Global Exchange Rates to be Set. required: true /globalExchangeRates/set: put: summary: Operation to set GlobalExchangeRates. description: The operation sets global exchange rates.

OperationId:setGlobalExchangeRates

operationId: setGlobalExchangeRates parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/exchangeRates' description: Exchange Rates to be Set. required: true /groupArrangementCodes: put: summary: Operation to change GroupArrangementCodes. description: '

OperationId:putGroupArrangementCodes

' operationId: putGroupArrangementCodes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/groupArrangementCodes' description: Request object for changing group arrangement codes. required: true post: summary: Operation to create GroupArrangementCodes. description: '

OperationId:postGroupArrangementCodes

' operationId: postGroupArrangementCodes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/groupArrangementCodes' description: Request object for creating new group arrangement codes. required: true get: summary: Operation to create GroupArrangementCodes. description: '

OperationId:getGroupArrangementCodes

' operationId: getGroupArrangementCodes parameters: - name: hotelIds in: query required: true style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: includeTransactionCodes in: query x-example: 'false' required: false description: A flag that determines whether or not to fetch associated transaction codes. Fetches only the arrangement codes when this flag is true. schema: type: boolean - name: arrangementCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching group arrangement codes. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/groupArrangementCodes' '204': description: GroupArrangementCodes not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig delete: summary: Operation to delete GroupArrangementCodes. description: '

OperationId:deleteGroupArrangementCodes

' operationId: deleteGroupArrangementCodes parameters: - name: code in: query description: Configuration code. required: false style: form explode: true schema: type: array items: type: string - name: hotelId in: query description: Hotel where the code is configured. required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /groupArrangementCodes/copy: put: summary: Operation to copy GroupArrangementCodes. description: '

OperationId:copyGroupArrangementCodes

' operationId: copyGroupArrangementCodes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/groupArrangementCodesCopy' description: List of the group arrangement codes to be copied. required: true /guiNumberRules: put: summary: Operation to change GUINumberRules. description: Operation to change GUI Number rules

OperationId:putGUINumberRules

operationId: putGUINumberRules parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/gUINumberRulesDetails' description: Request object to edit GUI number rules. required: true get: summary: Operation to fetch GUINumberRules. description: Operation to fetch GUI Number rules

OperationId:getGUINumberRules

operationId: getGUINumberRules parameters: - name: hotelIds in: query description: Hotel code. required: true style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetch GUI number rules content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/gUINumberRulesDetails' '204': description: GUINumberRules not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /hotelAdjustmentCodes: put: summary: Operation to change AdjustmentCodes. description: Operation to change Adjustment Codes.

OperationId:putAdjustmentCodes

operationId: putAdjustmentCodes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/adjustmentCodes' description: Request object for changing existing Adjustment Code Configurations. required: true post: summary: Operation to create AdjustmentCodes. description: Operation to create Adjustment Codes.

OperationId:postAdjustmentCodes

operationId: postAdjustmentCodes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/adjustmentCodes' description: Request object for creating new Adjustment Code Configurations. required: true get: summary: Operation to fetch AdjustmentCodes. description: Operation to fetch Adjustment Codes.

OperationId:getAdjustmentCodes

operationId: getAdjustmentCodes parameters: - name: hotelIds in: query required: true style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: adjustmentCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Adjustment Code configurations. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/adjustmentCodes' '204': description: AdjustmentCodes not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig delete: summary: Operation to delete AdjustmentCodes. description: Operation to remove Adjustment Codes.

OperationId:deleteAdjustmentCodes

operationId: deleteAdjustmentCodes parameters: - name: adjustmentCode in: query required: false description: Configuration code. schema: type: string - name: hotelId in: query required: false description: Hotel where the code is configured. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /hotelAdjustmentCodes/copy: put: summary: Operation to copy AdjustmentCodes. description: Operation to copy Adjustment Codes.

OperationId:copyAdjustmentCodes

operationId: copyAdjustmentCodes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/adjustmentCodesCopy' description: List of the Adjustment Codes to be copied. required: true /hotelPaymentMethods: put: summary: Operation to change PaymentMethods. description: Operation to change payment methods.

OperationId:putPaymentMethods

operationId: putPaymentMethods parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/paymentMethods' description: Request to change payment methods. required: true post: summary: Operation to create PaymentMethods. description: Operation to create payment methods.

OperationId:postPaymentMethods

operationId: postPaymentMethods parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/paymentMethods' description: Request to create payment methods. required: true get: summary: Operation to fetch PaymentMethods. description: Operation to fetch payment methods.

OperationId:getPaymentMethods

operationId: getPaymentMethods parameters: - name: hotelIds in: query required: true style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: offset in: query required: false description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. schema: type: integer default: 0 - name: transactionCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: paymentMethods in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: fetchInstructions in: query description: Simple Type for payment method fetch instruction. x-example: - CardRanges required: false style: form explode: true schema: type: array items: type: string enum: - CardRanges uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response for fetching payment methods. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/paymentMethodsInfo' '204': description: PaymentMethods not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /hotelPaymentMethods/copy: put: summary: Operation to copy PaymentMethods. description: Operation to copy payment methods.

OperationId:copyPaymentMethods

operationId: copyPaymentMethods parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/paymentMethodsCopy' description: List of payment methods to be copied. required: true /hotelTaxTypes: put: summary: Operation to change TaxTypes. description: Operation to change Tax Types.

OperationId:putTaxTypes

operationId: putTaxTypes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/taxTypes' description: Request object for changing existing Tax Type Configurations. required: true post: summary: Operation to create TaxTypes. description: Operation to create Tax Types.

OperationId:postTaxTypes

operationId: postTaxTypes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/taxTypes' description: Request object for creating new Tax Type Configurations. required: true get: summary: Operation to fetch TaxTypes. description: Operation to fetch Tax Types.

OperationId:getTaxTypes

operationId: getTaxTypes parameters: - name: hotelIds in: query required: true style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: taxTypeCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Tax Type configurations. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/taxTypes' '204': description: TaxTypes not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig delete: summary: Operation to delete TaxTypes. description: Operation to remove Tax Types.

OperationId:deleteTaxTypes

operationId: deleteTaxTypes parameters: - name: taxTypeCode in: query description: Configuration code. required: true style: form explode: true schema: type: array items: type: string - name: hotelId in: query description: Hotel where the code is configured. required: true style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /hotelTaxTypes/copy: put: summary: Operation to copy TaxTypes. description: Operation to copy Tax Types.

OperationId:copyTaxTypes

operationId: copyTaxTypes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/taxTypesCopy' description: List of the Tax Types to be copied. required: true /hotelVouchersConfig/copy: put: summary: Operation to copy Vouchers Config. description: Operation to copy Vouchers Config.

OperationId:copyVouchersConfig

operationId: copyVouchersConfig parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/vouchersConfigCopy' description: List of the Membership Type of Vouchers Config to be copied. required: true /hotels/{hotelId}/compAuthorizers: get: summary: Operation to fetch CompAuthorizers. description: Operation to fetch Authorizer Groups.

OperationId:getCompAuthorizers

operationId: getCompAuthorizers deprecated: true parameters: - name: hotelId in: path required: true description: Unique ID of the hotel in OPERA schema: type: string maxLength: 2000 minLength: 1 - name: includeCompAuthorizerDetails in: query x-example: 'false' required: false description: Configuring this flag to be TRUE will return the details of the comp authorizers. schema: type: boolean - name: includeInactiveAuthorizers in: query x-example: 'false' required: false description: Configuring this flag to be TRUE will return also the inactive authorizers. schema: type: boolean - name: includeTerminatedAuthorizers in: query x-example: 'false' required: false description: Configuring this flag to be TRUE will return the terminated authorizers. schema: type: boolean - name: authorizer in: query required: false description: User ID for the authorizer. schema: type: string - name: firstName in: query required: false description: First name for the authorizer. schema: type: string - name: lastName in: query required: false description: Last name for the authorizer. schema: type: string - name: externalUserId in: query required: false description: External Id for the authorizer. schema: type: string - name: authorizerId in: query required: false description: Id for the authorizer. schema: type: string - name: authorizerName in: query required: false description: Name for the authorizer. schema: type: string - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: offset in: query required: false description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. schema: type: integer default: 0 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Returns all information about the comp authorizers. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/compAuthorizers' '204': description: CompAuthorizers not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /hotels/{hotelId}/compAuthorizers/search: post: summary: Operation to fetch CompAuthorizers. description: Operation to fetch Authorizer Groups.

OperationId:searchCompAuthorizers

operationId: searchCompAuthorizers parameters: - name: hotelId in: path required: true description: Unique ID of the hotel in OPERA schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Returns all information about the comp authorizers. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/compAuthorizers' '204': description: CompAuthorizers not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/searchCompAuthorizersRequest' description: Request body for search comp authorizers /hotels/{hotelId}/compBucket/redemption: get: summary: Operation to fetch Comp Bucket Redemption Codes. description: You can use this API to fetch Comp Bucket Redemption Codes.

OperationId:getCompBucketRedemptionCodes

operationId: getCompBucketRedemptionCodes parameters: - name: hotelId in: path required: true description: Unique ID of the hotel in OPERA schema: type: string maxLength: 2000 minLength: 1 - name: hotelIds in: query description: Hotel code. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: redemptionCode in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Comp Bucket Redemption Codes configurations. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/compBucketRedemptionConfigDetails' '204': description: CompBucketRedemptionCodes not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig post: summary: Operation to create Comp Bucket Redemption Codes. description: Operation to create Comp Bucket Redemption Codes.

OperationId:postCompBucketRedemptionConfig

operationId: postCompBucketRedemptionConfig parameters: - name: hotelId in: path required: true description: Unique ID of the hotel in OPERA schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/compBucketRedemptionConfig' description: Request object for creating new Comp Bucket Redemption Codes configurations. required: true /hotels/{hotelId}/compBucket/redemption/{redemptionCode}: get: summary: Operation to fetch Comp Bucket Redemption Codes. description: You can use this API to fetch Comp Bucket Redemption Codes.

This API is deprecated. Please use getCompBucketRedemptionCodes instead

OperationId:getCompBucketRedemptionConfig

operationId: getCompBucketRedemptionConfig deprecated: true parameters: - name: redemptionCode in: path required: true description: Bucket Redemption Code schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel in OPERA schema: type: string maxLength: 2000 minLength: 1 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Comp Bucket Redemption Codes configurations. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/compBucketRedemptionConfigDetails' '204': description: CompBucketRedemptionConfig not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig put: summary: Operation to change Comp Bucket Redemption Codes. description: Operation to change Comp Bucket Redemption Codes.

OperationId:putCompBucketRedemptionConfig

operationId: putCompBucketRedemptionConfig parameters: - name: redemptionCode in: path required: true description: Bucket Redemption Code schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel in OPERA schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/compBucketRedemptionConfig' description: Request object for changing existing Comp Bucket Redemption Codes configurations. required: true delete: summary: Operation to remove Comp Bucket Redemption Codes. description: Operation to remove Comp Bucket Redemption Codes.

OperationId:deleteCompBucketRedemptionConfig

operationId: deleteCompBucketRedemptionConfig parameters: - name: redemptionCode in: path required: true description: Bucket Redemption Code schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel in OPERA schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /hotels/{hotelId}/compTypes: get: summary: Operation to Fetch Comp Types. description: Operation to Fetch Comp TYpes.

OperationId:getCompTypes

operationId: getCompTypes parameters: - name: hotelId in: path required: true description: Unique ID of the source hotel in OPERA schema: type: string maxLength: 2000 minLength: 1 - name: compTypeCode in: query required: false description: Code is used to identify the CompType. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Comp Types. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/compTypesDetails' '204': description: CompTypes not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /hotels/{hotelId}/customCharges: get: summary: Operation to fetch Custom Charge Codes. description: You can use this API to fetch Custom Charge Codes.

OperationId:getCustomChargeCodes

operationId: getCustomChargeCodes parameters: - name: hotelId in: path required: true description: Unique ID of the hotel in OPERA schema: type: string maxLength: 2000 minLength: 1 - name: hotelIds in: query description: Hotel code. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: configurationId in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: includeInactive in: query required: false description: Indicator that tells whether to include inactive articles in search results. schema: type: boolean - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Custom Charges. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/customChargesConfigDetails' '204': description: CustomChargeCodes not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig post: summary: Operation to create Custom Charge Codes. description: Operation to create Custom Charge Codes.

OperationId:postCustomChargesConfig

operationId: postCustomChargesConfig parameters: - name: hotelId in: path required: true description: Unique ID of the hotel in OPERA schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/customChargesConfig' description: Request object for creating new Custom Charges. required: true /hotels/{hotelId}/customCharges/configuration/{configurationId}: get: summary: Operation to fetch Custom Charge Codes. description: You can use this API to fetch Custom Charge Codes.

This API is deprecated. Please use getCustomChargeCodes instead

OperationId:getCustomChargesConfig

operationId: getCustomChargesConfig deprecated: true parameters: - name: configurationId in: path required: true description: Unique ID of the configuration schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel in OPERA schema: type: string maxLength: 2000 minLength: 1 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Custom Charges. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/customChargesConfigDetails' '204': description: CustomChargesConfig not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig put: summary: Operation to change Custom Charge Codes. description: Operation to change Custom ChargeCodes.

OperationId:putCustomChargesConfig

operationId: putCustomChargesConfig parameters: - name: configurationId in: path required: true description: Unique ID of the configuration schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel in OPERA schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/customChargesConfig' description: Request object for changing existing Custom Charges. required: true delete: summary: Operation to remove Custom Charge Codes. description: Operation to remove Custom Charge Codes.

OperationId:deleteCustomChargesConfig

operationId: deleteCustomChargesConfig parameters: - name: configurationId in: path required: true description: Unique ID of the configuration schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel in OPERA schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /hotels/{hotelId}/customCharges/exemptions: post: summary: Operation to create Custom Charge Exemptions Config. description: Operation to create Custom Charge Exemptions Config.

OperationId:postCustomChargeExemptionsConfig

operationId: postCustomChargeExemptionsConfig parameters: - name: hotelId in: path required: true description: Unique ID of the hotel in OPERA schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/customChargeExemptionsConfigToBeCreated' description: New one or more Custom Charge Exemptions to be created. required: true /hotels/{hotelId}/customCharges/exemptions/{configurationId}: get: summary: Operation to fetch Custom Charge Exemptions Config. description: You can use this API to fetch Custom Charge Exemptions Config.

This API is deprecated. Please use getCustomChargeExemptions instead

OperationId:getCustomChargeExemptionsConfig

operationId: getCustomChargeExemptionsConfig deprecated: true parameters: - name: configurationId in: path required: true description: Unique ID of the configuration schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel in OPERA schema: type: string maxLength: 2000 minLength: 1 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: includeInactive in: query required: false description: Indicator that tells whether to include inactive articles in search results. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Custom Charge Exemptions. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/customChargeExemptionsConfig' '204': description: CustomChargeExemptionsConfig not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig put: summary: Operation to change Custom Charge Exemptions Config. description: Operation to change Custom Charge Exemptions Config.

OperationId:putCustomChargeExemptionsConfig

operationId: putCustomChargeExemptionsConfig parameters: - name: configurationId in: path required: true description: Unique ID of the configuration schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel in OPERA schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/customChargeExemptionsConfigToBeChanged' description: Existing Custom Charge Exemptions to be changed. required: true delete: summary: Operation to remove Custom Charge Exemptions Config. description: Operation to remove Custom Charge Exemptions Config.

OperationId:deleteCustomChargeExemptionsConfig

operationId: deleteCustomChargeExemptionsConfig parameters: - name: configurationId in: path required: true description: Unique ID of the configuration schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel in OPERA schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /hotels/{hotelId}/customNumbers: get: summary: Operation to fetch custom number config. description: You can use this API to fetch custom number config.

OperationId:getCustomNumbers

operationId: getCustomNumbers parameters: - name: hotelId in: path required: true description: Unique ID of the hotel in OPERA schema: type: string maxLength: 2000 minLength: 1 - name: hotelIds in: query description: Hotel code. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: includeInactive in: query required: false description: Indicator that tells whether to return the inactive custom number configuration in search results. schema: type: boolean - name: configurationId in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: description in: query required: false description: The description of the custom number configuration code. schema: type: string - name: area in: query required: false description: Receipt schema: type: string enum: - Folio - Receipt uniqueItems: true - name: startDate in: query required: false schema: type: string format: date - name: endDate in: query required: false schema: type: string format: date - name: duration in: query required: false schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching custom number configurations. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/customNumberConfigDetails' '204': description: CustomNumbers not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig post: summary: Operation to create custom number config. description: '

OperationId:postCustomNumberConfig

' operationId: postCustomNumberConfig parameters: - name: hotelId in: path required: true description: Unique ID of the hotel in OPERA schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/customNumberConfiguration' description: Request object to create custom number configuration. required: true /hotels/{hotelId}/customNumbers/configuration/{configurationId}: get: summary: Operation to fetch custom number config. description: You can use this API to fetch custom number config.

This API is deprecated. Please use getCustomNumbers instead

OperationId:getCustomNumberConfig

operationId: getCustomNumberConfig deprecated: true parameters: - name: configurationId in: path required: true description: Unique ID of the configuration schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel in OPERA schema: type: string maxLength: 2000 minLength: 1 - name: includeInactive in: query required: false description: Indicator that tells whether to return the inactive custom number configuration in search results. schema: type: boolean - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: description in: query required: false description: The description of the custom number configuration code. schema: type: string - name: area in: query required: false description: Receipt schema: type: string enum: - Folio - Receipt uniqueItems: true - name: startDate in: query required: false schema: type: string format: date - name: endDate in: query required: false schema: type: string format: date - name: duration in: query required: false schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching custom number configurations. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/customNumberConfigDetails' '204': description: CustomNumberConfig not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig put: summary: Operation to change custom number config. description: '

OperationId:putCustomNumberConfig

' operationId: putCustomNumberConfig parameters: - name: configurationId in: path required: true description: Unique ID of the configuration schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel in OPERA schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response object to change custom number configuration. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/customNumberConfiguration' description: Request object to change custom number configuration. required: true delete: summary: Operation to remove custom number config. description: '

OperationId:deleteCustomNumberConfig

' operationId: deleteCustomNumberConfig parameters: - name: configurationId in: path required: true description: Unique ID of the configuration schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel in OPERA schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /hotels/{hotelId}/exchangeRates: get: summary: Operation to fetch ExchangeRates. description: You can use this API to retrieve exchange rate information for a hotel. You can search by hotel, Currency Code and exchange types. Results can include past, current and future exchange rate information for a currency.

This API is deprecated. Please use getExchangeRatesInfo instead

OperationId:getExchangeRates

operationId: getExchangeRates deprecated: true parameters: - name: hotelId in: path required: true description: Unique ID of the hotel in OPERA schema: type: string maxLength: 2000 minLength: 1 - name: exchangeTypes in: query description: E-certificate conversion. required: false style: form explode: true schema: type: array items: type: string enum: - Cash - Settlement - Posting - Check - TACommission - Membership - Certificate uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Collection of exchange rates and their information. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/exchangeRatesDetails' '204': description: ExchangeRates not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /hotels/{hotelId}/exchangeRates/{currencyCode}: get: summary: Operation to fetch FuturePastExchangeRates. description: Operation to Fetch Future Past Exchange Rates.

OperationId:getFuturePastExchangeRates

This API allows a time span of 30 days.

operationId: getFuturePastExchangeRates parameters: - name: currencyCode in: path required: true description: Currency Code in OPERA schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel in OPERA schema: type: string maxLength: 2000 minLength: 1 - name: exchangeTypes in: query x-example: Cash required: true description: E-certificate conversion. schema: type: string enum: - Cash - Settlement - Posting - Check - TACommission - Membership - Certificate uniqueItems: true - name: dateRangeStart in: query required: false schema: type: string format: date - name: dateRangeEnd in: query required: false schema: type: string format: date - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Collection of exchange rates and their information. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/futurePastExchangeRates' '204': description: FuturePastExchangeRates not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /hotels/{hotelId}/fiscalCommands: get: summary: Get Fiscal Commands description: Use this API to get fiscal commands.

OperationId:getFiscalCommands

operationId: getFiscalCommands parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: includeInactive in: query required: false description: Inactive flag used to include/exclude inactive transaction codes from the search result schema: type: boolean - name: code in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: partnerCode in: query description: Used for fiscal partner codes. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X. required: false style: form explode: true schema: type: array items: type: string - name: operationType in: query required: false description: List of Fiscal Operations supported. schema: type: string enum: - FiscalCommand - Operation uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Lists available Fiscal Operations. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/fiscalCommandsDetails' '204': description: FiscalCommands not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig put: summary: Change configuration fiscal commands description: Use this API to update configuration fiscal commands.

OperationId:changeFiscalCommands

operationId: changeFiscalCommands parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/changeFiscalCommands' description: Request to update existing Fiscal Command. required: true /hotels/{hotelId}/fiscalPartners: get: summary: Get fiscal partners description: Use this API to get fiscal partners.

OperationId:getFiscalPartners

operationId: getFiscalPartners parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: hotelIds in: query description: Hotel code. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: partnerCode in: query description: Used for fiscal partner codes. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X. required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetch Fiscal Partners Config. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/fiscalPartnersDetails' '204': description: FiscalPartners not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig post: summary: Create fiscal partners description: Use this API to create fiscal partners.

OperationId:postFiscalPartners

operationId: postFiscalPartners parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/createFiscalPartners' description: Request object to create Fiscal Partners. required: true delete: summary: Delete configuration fiscal partners description: Use this API to delete configuration fiscal partners.

OperationId:removeFiscalPartners

operationId: removeFiscalPartners parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: partnerCode in: query description: Used for fiscal partner codes. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X. required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig put: summary: Change configuration fiscal partners description: Use this API to update configuration fiscal partners.

OperationId:changeFiscalPartners

operationId: changeFiscalPartners parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/changeFiscalPartners' description: Request object to change Fiscal Partners. required: true /hotels/{hotelId}/folios/{folioType}/legends/{legendCode}: delete: summary: Operation to remove folio type legend mappings config. description: Operation to remove folio type legend mappings config.

OperationId:removeFolioTypeLegendMappingConfig

operationId: removeFolioTypeLegendMappingConfig parameters: - name: legendCode in: path required: true description: Legend Code schema: type: string maxLength: 2000 minLength: 1 - name: folioType in: path required: true description: Folio Type schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the source hotel in OPERA schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /hotels/{hotelId}/generates: get: summary: Operation to fetch GenerateTaxTypes. description: Operation to fetch tax types.

OperationId:getGenerateTaxTypes

operationId: getGenerateTaxTypes parameters: - name: hotelId in: path required: true description: Unique ID of the hotel in OPERA schema: type: string maxLength: 2000 minLength: 1 - name: transactionCode in: query required: false description: Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response for fetching tax types. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/taxTypesGenerate' '204': description: GenerateTaxTypes not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /hotels/{hotelId}/template/customNumbers: post: summary: Operation to create a new template custom number configuration. description: You can use this API to create a new template custom number configuration.

This API is deprecated. Please use postTemplateCustomNumber instead

OperationId:postTemplateCustomNumberConfig

operationId: postTemplateCustomNumberConfig deprecated: true parameters: - name: hotelId in: path required: true description: Unique ID of the hotel in OPERA schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateCustomNumberConfig' description: Request object to create a new template custom number configuration. required: true /hotels/{hotelId}/template/customNumbers/configuration/{configurationId}: get: summary: Operation to fetch template custom number configuration. description: You can use this API to fetch template custom number configuration.

This API is deprecated. Please use getTemplateCustomNumbers instead

OperationId:getTemplateCustomNumberConfig

operationId: getTemplateCustomNumberConfig deprecated: true parameters: - name: configurationId in: path required: true description: Unique ID of the configuration schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel in OPERA schema: type: string maxLength: 2000 minLength: 1 - name: includeInactive in: query required: false description: Indicator that tells whether to return the inactive custom number configuration in search results. schema: type: boolean - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: startDate in: query required: false schema: type: string format: date - name: endDate in: query required: false schema: type: string format: date - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching template custom number configurations. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/templateCustomNumberConfigDetails' '204': description: TemplateCustomNumberConfig not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig put: summary: Operation to change template custom number configuration. description: You can use this API to change template custom number configuration.

This API is deprecated. Please use putTemplateCustomNumber instead

OperationId:putTemplateCustomNumberConfig

operationId: putTemplateCustomNumberConfig deprecated: true parameters: - name: configurationId in: path required: true description: Unique ID of the configuration schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel in OPERA schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response object to change template custom number configuration. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateCustomNumberConfig' description: Request object to change template custom number configuration. required: true delete: summary: Operation to remove template custom number configuration. description: You can use this API to remove template custom number configuration.

This API is deprecated. Please use deleteTemplateCustomNumber instead

OperationId:deleteTemplateCustomNumberConfig

operationId: deleteTemplateCustomNumberConfig deprecated: true parameters: - name: configurationId in: path required: true description: Unique ID of the configuration schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel in OPERA schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /hotels/{hotelId}/termCodes/{termCode}/folioCopyLegend: get: summary: Operation to fetch FolioCopyLegend. description: Operation to fetch for detailed folio copy legend.

OperationId:getFolioCopyLegend

operationId: getFolioCopyLegend parameters: - name: hotelId in: path required: true description: Unique ID of the hotel in OPERA schema: type: string maxLength: 2000 minLength: 1 - name: termCode in: path required: true description: Term code to be searched. schema: type: string maxLength: 20 minLength: 1 - name: languageCode in: query required: false description: Language code to be searched. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching detailed folio copy legend. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/folioCopyLegendInfoType' '204': description: Folio copy legend not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /hotels/{hotelId}/transactionCodeAccessRoles: get: summary: Operation to fetch TransactionCodeAccessRoles. description: Operation to Fetch Transaction Code Access Roles.

OperationId:getTransactionCodeAccessRoles

operationId: getTransactionCodeAccessRoles parameters: - name: hotelId in: path required: true description: Unique ID of the hotel in OPERA schema: type: string maxLength: 2000 minLength: 1 - name: roleCode in: query required: false description: Codes schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for information regarding Transaction Code Access Role content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/transactionCodeAccessRoles' '204': description: TransactionCodeAccessRoles not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /hotels/{hotelId}/transactionCodes/{transactionCode}/chargeSimulations: get: summary: Operation to CalculatePosting. description: Operation to test posting amount.

OperationId:calculatePosting

operationId: calculatePosting parameters: - name: transactionCode in: path required: true description: Transaction Code in OPERA schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel in OPERA schema: type: string maxLength: 2000 minLength: 1 - name: postingAmount in: query x-example: '299' required: false description: Base amount to test for posting. schema: type: number - name: taxType in: query required: false description: Specify this criteria if calculation is based on the tax type. schema: type: string - name: guestBalance in: query x-example: '299' required: false description: Specify this criteria if calculation is based on the guest balance. schema: type: number - name: roomType in: query x-example: STD required: false description: Specify this criteria if calculation is based on room type. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response for testing posting amount. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/calculatedPosting' '204': description: calculatePosting not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /hotels/{hotelId}/transactionCodes/{transactionCode}/hotelTransactionCode: get: summary: Operation to fetch TransactionCode. description: Operation to fetch for detailed transaction code.

OperationId:getTransactionCode

operationId: getTransactionCode parameters: - name: transactionCode in: path required: true description: Transaction Code in OPERA schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel in OPERA schema: type: string maxLength: 2000 minLength: 1 - name: fetchInstructions in: query description: Simple type for transaction code instructions that can be used for partial operations. x-example: - Header required: false style: form explode: true schema: type: array items: type: string enum: - Header - Generates - Glmapping - AssociatedTrxCodes - MappingCodes uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching detailed transaction code. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/hotelTransactionCode' '204': description: TransactionCode not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /hotels/{hotelId}/transactionCodes/{transactionCode}/transactionCodes: delete: summary: Operation to delete TransactionCodes. description: Operation to remove transaction codes.

OperationId:deleteTransactionCodes

operationId: deleteTransactionCodes parameters: - name: transactionCode in: path required: true description: Transaction Code in OPERA schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel in OPERA schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /hotels/{hotelId}/transactionDiscounts/{transactionDiscountCode}: put: summary: Operation to change TransactionDiscounts. description: Operation to change Transaction Discounts.

OperationId:putTransactionDiscounts

operationId: putTransactionDiscounts parameters: - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: transactionDiscountCode in: path required: true description: Unique code for transaction discount schema: type: string maxLength: 20 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Additional warnings about the operation. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/transactionDiscount' description: Request object for changing a Transaction Discount Configuration. required: true delete: summary: Operation to delete TransactionDiscounts. description: Operation to remove Transaction Discounts.

OperationId:deleteTransactionDiscounts

operationId: deleteTransactionDiscounts parameters: - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: transactionDiscountCode in: path required: true description: Unique code for transaction discount schema: type: string maxLength: 20 minLength: 1 responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /hotels/{hotelId}/transactionGroupCode/{transactionGroupCode}/transactionGroup: get: summary: Operation to fetch TransactionGroup. description: Operation to fetch detailed transaction group.

OperationId:getTransactionGroup

operationId: getTransactionGroup parameters: - name: transactionGroupCode in: path required: true description: Transaction Group Code in OPERA schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel in OPERA schema: type: string maxLength: 2000 minLength: 1 - name: fetchInstructions in: query description: Simple type for transaction group instructions that can be used for partial operations. x-example: - Header required: false style: form explode: true schema: type: array items: type: string enum: - Header - Generates uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching detailed transaction group configuration. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/transactionGroup' '204': description: TransactionGroup not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig ? /hotels/{hotelId}/transactionSubGroupCodes/{transactionSubGroupCode}/transactionGroupCodes/{transactionGroupCode}/transactionSubGroup : get: summary: Operation to fetch TransactionGroup. description: Operation to fetch detailed transaction sub group.

OperationId:getTransactionSubgroup

operationId: getTransactionSubgroup parameters: - name: transactionGroupCode in: path required: true description: Transaction Group Code in OPERA schema: type: string maxLength: 2000 minLength: 1 - name: transactionSubGroupCode in: path required: true description: Transaction SubGroup Code in OPERA schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel in OPERA schema: type: string maxLength: 2000 minLength: 1 - name: fetchInstructions in: query description: Simple type for transaction sub group instructions that can be used for partial operations. x-example: - Header required: false style: form explode: true schema: type: array items: type: string enum: - Header - Generates uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching detailed transaction subgroup configuration. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/hotelTransactionSubgroup' '204': description: TransactionSubgroup not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /hotels/{hotelId}/vouchers: get: summary: Get Vouchers description: Use this API to get Vouchers.

OperationId:getVouchers

operationId: getVouchers parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: membershipTypes in: query description: Membership Types set to the search criteria required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: membershipLevels in: query description: Membership Levels set to the search criteria required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: startDate in: query required: false description: Start date of the voucher schema: type: string format: date - name: endDate in: query required: false description: End date of the voucher schema: type: string format: date - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Vouchers. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/vouchersDetails' '204': description: Vouchers not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig delete: summary: Operation to remove Vouchers. description: '

OperationId:deleteVouchers

' operationId: deleteVouchers parameters: - name: hotelId in: path required: true description: Unique ID of the hotel in OPERA schema: type: string maxLength: 2000 minLength: 1 - name: voucherId in: query description: Unique internal ID of the voucher required: true schema: type: integer - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig put: summary: Operation to change a voucher. description:

OperationId:putVouchers

operationId: putVouchers parameters: - name: hotelId in: path required: true description: Unique ID of the hotel in OPERA schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/vouchersDetails' description: Request to change voucher. required: true post: summary: Operation to create Vouchers. description:

OperationId:postVouchers

operationId: postVouchers parameters: - name: hotelId in: path required: true description: Unique ID of the hotel in OPERA schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/vouchersDetails' description: Request to create a voucher. required: true /hotels/{sourceHotelId}/customCharges/exemptions/copy: post: summary: Operation to copy Custom Charge Exemptions Config. description: Operation to copy Custom Charge Exemptions Config.

OperationId:copyCustomChargeExemptionsConfig

operationId: copyCustomChargeExemptionsConfig parameters: - name: sourceHotelId in: path required: true description: Unique ID of the hotel in OPERA schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/customChargeExemptionsConfigCopy' description: List of the Custom Charge Exemptions to be copied. required: true /hotels/{sourceHotelId}/fiscalFolioParameters/copy: put: summary: Operation to copy FiscalFolioParameters. description: Operation to copy Fiscal Folio Parameters.

OperationId:copyFiscalFolioParameters

operationId: copyFiscalFolioParameters deprecated: true parameters: - name: sourceHotelId in: path required: true description: Unique ID of the source hotel in OPERA schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/fiscalFolioParametersCopy' description: Request object for copying Fiscal Folio Parameters to other hotel code(s). required: true /noShowPostingRules: put: summary: Operation to change NoShowPostingRules. description: Operation to change No Show Posting Rules.

OperationId:putNoShowPostingRules

operationId: putNoShowPostingRules parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/noShowPostingRulesEdit' description: Request object for changing existing No Show Posting Rule Configurations. required: true post: summary: Operation to create NoShowPostingRules. description: Operation to create No Show Posting Rules.

OperationId:postNoShowPostingRules

operationId: postNoShowPostingRules parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/noShowPostingRules' description: Request object for creating new No Show Posting Rule Configuration. required: true get: summary: Operation to fetch NoShowPostingRules. description: Operation to fetch No Show Posting Rules.

OperationId:getNoShowPostingRules

operationId: getNoShowPostingRules parameters: - name: hotelIds in: query required: true style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: sourceCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching No Show Posting Rule Configurations. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/noShowPostingRules' '204': description: NoShowPostingRules not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig delete: summary: Operation to delete NoShowPostingRules. description: Operation to remove No Show Posting Rules.

OperationId:deleteNoShowPostingRules

operationId: deleteNoShowPostingRules parameters: - name: hotelId in: query description: Indicates for which hotel this posting rule apply to. required: true style: form explode: true schema: type: array items: type: string - name: reservationType in: query description: Type of the reservation. required: false style: form explode: true schema: type: array items: type: string - name: sourceCode in: query description: Source code of the reservation. required: false style: form explode: true schema: type: array items: type: string - name: postingRule in: query description: Simple Type for Posting Rule Types. required: false style: form explode: true schema: type: array items: type: string enum: - AllNights - DepositOnly - FirstNight uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /numberDescriptions: put: summary: Operation to change NumberDescriptions. description: The operation is to change the description corresponding to a number.

OperationId:putNumberDescriptions

operationId: putNumberDescriptions parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/numberDescriptions' description: Request object to edit description of numbers required: true get: summary: Operation to fetch NumberDescriptions. description: The operation accepts code and/or descriptions for numbers as search criteria in fetch request and returns numbers, descriptions that match the criteria.

OperationId:getNumberDescriptions

operationId: getNumberDescriptions parameters: - name: numberCodes in: query description: Used for Number specific codes for OPERA tables. Possible values of this pattern are 1, 10, 17, THOUSAND, BILLION, etc. required: false style: form explode: true schema: type: array items: type: string - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: description in: query required: false description: Description text set to the search criteria schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response for fetching Numbers and Descriptions content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/numberDescriptions' '204': description: NumberDescriptions not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /operaControlSequences: put: summary: Operation to change OperaControlSequences. description: Operation to change Opera Document Sequences.

OperationId:putOperaControlSequences

operationId: putOperaControlSequences parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/operaControlSequences' description: Request objects for updating Opera Control Sequences required: true get: summary: Operation to fetch OperaControlSequences. description: Operation to fetch Opera Document Sequences.

OperationId:getOperaControlSequences

operationId: getOperaControlSequences parameters: - name: hotelId in: query required: true description: Hotel code of fetch criteria schema: type: string - name: countryCode in: query required: false description: Country Code of fetch criteria schema: type: string - name: code in: query description: Configuration code. required: false style: form explode: true schema: type: array items: type: string - name: HotelCode in: query description: Hotel where the code is configured. required: false style: form explode: true schema: type: array items: type: string - name: fetchInstruction in: query description: Simple type for opera sequence instructions that can be used for partial operations. required: false style: form explode: true schema: type: array items: type: string enum: - BillFolioTypes - ArInvoice - SequenceNumbers - ARPayment uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object of Opera Control Sequence. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/operaControlSequences' '204': description: OperaControlSequences not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /packageArrangementCodes: put: summary: Operation to change PackageArrangementCodes. description: '

OperationId:putPackageArrangementCodes

' operationId: putPackageArrangementCodes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/packageArrangementCodes' description: Request object for changing package arrangement codes. required: true post: summary: Operation to create PackageArrangementCodes. description: '

OperationId:postPackageArrangementCodes

' operationId: postPackageArrangementCodes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/packageArrangementCodes' description: Request object for creating new package arrangement codes. required: true get: summary: Operation to fetch PackageArrangementCodes. description: '

OperationId:getPackageArrangementCodes

' operationId: getPackageArrangementCodes parameters: - name: hotelIds in: query required: true style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: arrangementCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: includeInactive in: query x-example: 'false' required: false description: A flag that determines whether to fetch active records or inactive records schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching package arrangement codes. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/packageArrangementCodes' '204': description: PackageArrangementCodes not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig delete: summary: Operation to delete PackageArrangementCodes. description: '

OperationId:deletePackageArrangementCodes

' operationId: deletePackageArrangementCodes parameters: - name: hotelId in: query description: Hotel where the code is configured. required: true style: form explode: true schema: type: array items: type: string - name: code in: query description: Configuration code. required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /packageArrangementCodes/copy: put: summary: Operation to copy PackageArrangementCodes. description: '

OperationId:copyPackageArrangementCodes

' operationId: copyPackageArrangementCodes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/packageArrangementCodesCopy' description: List of the package arrangement codes to be copied. required: true /paymentMethods: put: summary: Operation to delete TransactionArrangementCodes. description: Operation to remove payment methods.

OperationId:removePaymentMethods

operationId: removePaymentMethods parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/paymentMethods' description: Request to remove payment methods. required: true /revenueBucketCodes: put: summary: Operation to change RevenueBucketCodes. description: Operation to change Revenue Bucket Codes.

OperationId:putRevenueBucketCodes

operationId: putRevenueBucketCodes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/revenueBucketCodes' description: Request object for changing existing Revenue Bucket Codes Configurations. required: true post: summary: Operation to create RevenueBucketCodes. description: Operation to create Revenue Bucket Codes.

OperationId:postRevenueBucketCodes

operationId: postRevenueBucketCodes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/revenueBucketCodes' description: Request object for creating new Revenue Bucket Codes Configurations. required: true get: summary: Operation to fetch RevenueBucketCodes. description: Operation to fetch Revenue Bucket Codes.

OperationId:getRevenueBucketCodes

operationId: getRevenueBucketCodes parameters: - name: hotelIds in: query required: true style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: trxCodeArrangementCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: trxCodeArrangementType in: query required: false description: Fiscal Bucket Type. schema: type: string enum: - Default - Fiscal uniqueItems: true - name: code in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: revenueBucketTypesWildCard in: query required: false description: Wildcard search on the code. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Revenue Bucket Codes configurations. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/revenueBucketCodes' '204': description: RevenueBucketCodes not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig delete: summary: Operation to delete RevenueBucketCodes. description: Operation to remove Revenue Bucket Codes.

OperationId:deleteRevenueBucketCodes

operationId: deleteRevenueBucketCodes parameters: - name: hotelId in: query description: Hotel where the code is configured. required: true style: form explode: true schema: type: array items: type: string - name: code in: query description: Configuration code. required: false style: form explode: true schema: type: array items: type: string - name: revenueBucketType in: query description: Revenue Export Bucket Type required: false style: form explode: true schema: type: array items: type: string - name: bucketType in: query required: false description: Flag to identify Fiscal related bucket types. style: form explode: true schema: type: array items: type: string enum: - Default - Fiscal uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /revenueBucketCodes/copy: put: summary: Operation to copy RevenueBucketCodes. description: Operation to copy Revenue Bucket Codes.

OperationId:copyRevenueBucketCodes

operationId: copyRevenueBucketCodes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/revenueBucketCodesCopy' description: Request object for copying one or more Revenue Bucket Codes configurations from one source property to one or more target properties. required: true /revenueBucketTypes: put: summary: Operation to change RevenueBucketTypes. description: Operation to change Revenue Bucket Types.

OperationId:putRevenueBucketTypes

operationId: putRevenueBucketTypes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/revenueBucketTypes' description: Request object for changing existing Revenue Bucket Types Configurations. required: true post: summary: Operation to create RevenueBucketTypes. description: Operation to create Revenue Bucket Types.

OperationId:postRevenueBucketTypes

operationId: postRevenueBucketTypes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/revenueBucketTypes' description: Request object for creating new Revenue Bucket Types Configurations. required: true get: summary: Operation to fetch RevenueBucketTypes. description: Operation to fetch Revenue Bucket Types.

OperationId:getRevenueBucketTypes

operationId: getRevenueBucketTypes parameters: - name: hotelIds in: query required: true style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: revenueBucketTypeCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: bucketType in: query required: false description: Fiscal Bucket Type. schema: type: string enum: - Default - Fiscal uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Revenue Bucket Types configurations. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/revenueBucketTypes' '204': description: RevenueBucketTypes not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig delete: summary: Operation to delete RevenueBucketTypes. description: Operation to remove Revenue Bucket Types.

OperationId:deleteRevenueBucketTypes

operationId: deleteRevenueBucketTypes parameters: - name: hotelId in: query description: Hotel where the code is configured. required: true style: form explode: true schema: type: array items: type: string - name: code in: query description: Configuration code. required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /revenueBucketTypes/copy: put: summary: Operation to copy RevenueBucketTypes. description: Operation to copy Revenue Bucket Types.

OperationId:copyRevenueBucketTypes

operationId: copyRevenueBucketTypes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/revenueBucketTypesCopy' description: List of the Revenue Bucket Types to be copied. required: true /revenueTypeMapping: put: summary: Operation to change RevenueTypeMapping. description: '

OperationId:putRevenueTypeMapping

' operationId: putRevenueTypeMapping parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response object to change Revenue Type Mapping configurations. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/revenueTypeMapping' description: Request object to change Revenue Type Mapping configurations. required: true post: summary: Operation to create RevenueTypeMapping. description: Use this API to create revenue type mapping for a specific hotel. Revenue Type Mapping configuration is used when generating the proforma invoice and in Event Posting and enables the calculation of postings configured in the mapping and on the actual transaction code.

OperationId:postRevenueTypeMapping

operationId: postRevenueTypeMapping parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/revenueTypeMapping' description: Request object to create Revenue Type Mapping configurations. required: true get: summary: Operation to fetch RevenueTypeMapping. description: '

OperationId:getRevenueTypeMapping

' operationId: getRevenueTypeMapping parameters: - name: hotelIds in: query description: Hotel code. required: true style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: eventTypeCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: revenueTypeCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: transactionCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: spaceCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Revenue Type Mapping configurations. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/revenueTypeMappingList' '204': description: RevenueTypeMapping not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig delete: summary: Operation to delete RevenueTypeMapping. description: '

OperationId:deleteRevenueTypeMapping

' operationId: deleteRevenueTypeMapping parameters: - name: hotelId in: query required: true description: Hotel Code to which the Revenue Type Mapping belongs to. schema: type: string - name: revenueTypeMappingID in: query required: false description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. schema: type: string - name: idExtension in: query required: false description: Additional identifying value assigned by the creating system. schema: type: integer - name: idContext in: query required: false description: Used to identify the source of the identifier (e.g., IATA, ABTA). schema: type: string - name: type in: query required: false description: A reference to the type of object defined by the UniqueID element. schema: type: string - name: revenueType in: query required: false description: Provides information about the Revenue Type. schema: type: string - name: eventType in: query required: false description: Provides information about the Event Type. schema: type: string - name: space in: query required: false description: Provides information about the Space/Location for the Revenue Type. schema: type: string - name: transactionCode in: query required: false description: Transaction code for the Revenue Type. schema: type: string - name: cateringOnly in: query required: false description: For Catering and Event. schema: type: string enum: - 'Yes' - 'No' - Both uniqueItems: true - name: serviceCharge in: query required: false description: Service Charge for the Revenue Type. schema: type: number maximum: 100 minimum: 0 - name: serviceChargeTrxCode in: query required: false description: Service Charge for the Revenue Type. schema: type: string - name: serviceChargeCalulationMethod in: query required: false description: Service Charge for the Revenue Type. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /revenueTypeMapping/copy: put: summary: Operation to copy RevenueTypeMapping. description: '

OperationId:copyRevenueTypeMapping

' operationId: copyRevenueTypeMapping parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/revenueTypeMappingCopy' description: Request object for Copying Revenue Type Mapping. required: true /roomTypeBasedChargeRanges: put: summary: Operation to change Room Type Based Charge Ranges. description: Operation to change Room Type Based Charge Ranges.

OperationId:putRoomTypeBasedChargeRanges

operationId: putRoomTypeBasedChargeRanges parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/roomTypeBasedChargeRngs' description: Request to change Room Type Based Charge Ranges. required: true post: summary: Operation to create Room Type Based Charge Ranges. description: Operation to create Room Type Based Charge Ranges.

OperationId:postRoomTypeBasedChargeRanges

operationId: postRoomTypeBasedChargeRanges parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/roomTypeBasedChargeRngs' description: Request to create Room Type Based Charge Ranges. required: true get: summary: Operation to fetch Room Type Based Charge Ranges. description: Use this API to return Room Type Based Charge Ranges for a hotels based on search criteria such as hotelId, transactionCode, generateTrxCode, RoomTypeGroup.

OperationId:getRoomTypeBasedChargeRanges

operationId: getRoomTypeBasedChargeRanges parameters: - name: hotelId in: query required: true description: Unique ID of the source hotel in OPERA schema: type: string maxLength: 2000 minLength: 1 - name: transactionCode in: query required: true description: Transaction code schema: type: string maxLength: 20 minLength: 1 - name: generateTrxCode in: query required: true description: Generate of the Main Transaction code schema: type: string maxLength: 20 minLength: 1 - name: roomTypeGroup in: query required: true description: Room Type Group Code schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response for fetching Room Type Based Charge Ranges. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/roomTypeBasedChargeRngs' '204': description: Room Type Based Charge Ranges not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig delete: summary: Operation to delete Room Type Based Charge Ranges. description: Operation to remove Room Type Based Charge Ranges.

OperationId:deleteRoomTypebasedchargeranges

operationId: deleteRoomTypebasedchargeranges parameters: - name: hotelId in: query required: true description: Unique ID of the source hotel in OPERA. schema: type: string maxLength: 2000 minLength: 1 - name: transactionNo in: query required: true description: Transaction number, Unique Identifier of the record. schema: type: number - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /routingInstructions: put: summary: Operation to change RoutingInstructions. description: Operation to change routing instructions.

OperationId:putRoutingInstructions

operationId: putRoutingInstructions parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/routingInstructions' description: Request when changing a routing instruction. required: true post: summary: Operation to create RoutingInstructions. description: Operation to create routing instructions.

OperationId:postRoutingInstructions

operationId: postRoutingInstructions parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/routingInstructions' description: Request to create a routing instruction. required: true get: summary: Operation to fetch RoutingInstructions. description: Use this API to return routing instructions based on search criteria such as hotelId, trxCodeArrangementCode, wildCard. Routing instructions are used to route specific charges to different destinations.

OperationId:getRoutingInstructions

The maximum allowable limit for this API is 20.

operationId: getRoutingInstructions parameters: - name: hotelId in: query required: true schema: type: array items: type: string maxItems: 4000 - name: trxCodeArrangementCode in: query required: false description: Codes to be searched. schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: compAccounting in: query required: false description: Determines if this is a comp routing code or a routing code. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching routing instructions. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/routingInstructions' '204': description: RoutingInstructions not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig delete: summary: Operation to delete RoutingInstructions. description: Operation to remove routing instructions.

OperationId:deleteRoutingInstructions

operationId: deleteRoutingInstructions parameters: - name: hotelId in: query required: true description: Hotel where the code is configured. schema: type: string - name: code in: query required: false description: Configuration code. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /routingInstructions/copy: put: summary: Operation to copy RoutingInstructions. description: Operation to copy routing instructions.

OperationId:copyRoutingInstructions

operationId: copyRoutingInstructions parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/routingInstructionsCopy' description: List of the routing instructions to be copied to hotel code(s). required: true /services/cashieringConfig/status: get: summary: Operation to ping. description: '

OperationId:pingCashieringConfigService

' operationId: pingCashieringConfigService parameters: - name: operaPingInput in: query required: false description: Opera Ping request input type schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response for Ping operation. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/operaVersion' '204': description: pingCashieringConfigService not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /taxBrackets: put: summary: Operation to change TaxBrackets. description: Operation to change Tax Brackets. This function only be available when the parameter "Tax Bracket Calculation" is on.

OperationId:putTaxBrackets

operationId: putTaxBrackets parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/taxBrackets' description: Request object for changing tax brackets. required: true post: summary: Operation to create TaxBrackets. description: Operation to Create Tax Brackets. This function only be available when the parameter "Tax Bracket Calculation" is on.

OperationId:postTaxBrackets

operationId: postTaxBrackets parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/taxBrackets' description: Request object for creating tax brackets. required: true get: summary: Operation to fetch TaxBrackets. description: Operation to fetch Tax Brackets. This function only be available when the parameter "Tax Bracket Calculation" is on.

OperationId:getTaxBrackets

operationId: getTaxBrackets parameters: - name: hotelIds in: query required: true style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: taxPercentagesCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching details about tax brackets. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/taxBrackets' '204': description: TaxBrackets not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig delete: summary: Operation to delete TaxBrackets. description: Operation to remove Tax Brackets. This function only be available when the parameter "Tax Bracket Calculation" is on.

OperationId:deleteTaxBrackets

operationId: deleteTaxBrackets parameters: - name: hotelId in: query description: Hotel Code where tax bracket belongs to. required: true style: form explode: true schema: type: array items: type: string - name: taxPercentage in: query description: Tax Percentage for which this Tax Bracket applies. required: false style: form explode: true schema: type: array items: type: number - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /taxBrackets/copy: put: summary: Operation to copy TaxBrackets. description: Operation to copy Tax Brackets. This function only be available when the parameter "Tax Bracket Calculation" is on.

OperationId:copyTaxBrackets

operationId: copyTaxBrackets parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/taxBracketsCopy' description: Request object for copying tax brackets. required: true /template/customNumbers: get: summary: Operation to fetch template custom number configuration. description: You can use this API to fetch template custom number configuration.

OperationId:getTemplateCustomNumbers

operationId: getTemplateCustomNumbers parameters: - name: includeInactive in: query required: false description: Indicator that tells whether to return the inactive custom number configuration in search results. schema: type: boolean - name: configurationId in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: startDate in: query required: false schema: type: string format: date - name: endDate in: query required: false schema: type: string format: date - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching template custom number configurations. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/templateCustomNumberConfigDetails' '204': description: TemplateCustomNumbers not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig put: summary: Operation to change template custom number configuration. description: You can use this API to change template custom number configuration.

OperationId:putTemplateCustomNumber

operationId: putTemplateCustomNumber parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response object to change template custom number configuration. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateCustomNumberConfig' description: Request object to change template custom number configuration. required: true delete: summary: Operation to remove template custom number configuration. description: You can use this API to remove template custom number configuration.

OperationId:deleteTemplateCustomNumber

operationId: deleteTemplateCustomNumber parameters: - name: configurationId in: query required: false description: Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig post: summary: Operation to create a new template custom number configuration. description: You can use this API to create a new template custom number configuration.

OperationId:postTemplateCustomNumber

operationId: postTemplateCustomNumber parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateCustomNumberConfig' description: Request object to create a new template custom number configuration. required: true /templateTransactionCodes: put: summary: Operation to change TemplateTransactionCodes. description: Operation to change template transaction codes.

OperationId:putTemplateTransactionCodes

operationId: putTemplateTransactionCodes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateTransactionCodes' description: Request object for changing existing template transaction codes configuration. required: true post: summary: Operation to create TemplateTransactionCodes. description: Operation to create template transaction codes.

OperationId:postTemplateTransactionCodes

operationId: postTemplateTransactionCodes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateTransactionCodes' description: Request object for creating new template transaction codes configuration. required: true get: summary: Operation to fetch TemplateTransactionCodes. description: Use this API to return template transaction codes summaries based on search criteria such as transactionGroupCodes, transactionSubgroupsCodes, transactionCodes, wildCard, etc..

OperationId:getTemplateTransactionCodes

operationId: getTemplateTransactionCodes parameters: - name: compTransactionCodes in: query x-example: 'false' required: false description: Flag to indicate whether comp accounting transaction codes are being requested. If true, only comp accounting transaction codes will be returned. If false, only standard transaction codes will be returned. schema: type: boolean - name: includeInactive in: query x-example: 'false' required: false description: Inactive flag used to include/exclude inactive transaction codes from the search result schema: type: boolean - name: transactionGroupCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: transactionSubgroupsCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: transactionCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: description in: query required: false description: Description of the Transaction code. schema: type: string - name: brandCode in: query required: false description: Property associated with the corporate information brand code in the search criteria schema: type: string - name: universalProductCode in: query required: false description: Unique Universal product code search criteria. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching template transaction codes summary. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/templateTransactionCodes' '204': description: TemplateTransactionCodes not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig delete: summary: Operation to delete TemplateTransactionCodes. description: Operation to remove template transaction codes.

OperationId:deleteTemplateTransactionCodes

operationId: deleteTemplateTransactionCodes parameters: - name: transactionCodes in: query required: true style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /templateTransactionGroups: put: summary: Operation to change TemplateTransactionGroups. description: Operation to change existing template transaction group.

OperationId:putTemplateTransactionGroups

operationId: putTemplateTransactionGroups parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateTransactionGroups' description: Request object to changing Template Transaction Groups Configuration. required: true post: summary: Operation to create TemplateTransactionGroups. description: Operation to create new template transaction group.

OperationId:postTemplateTransactionGroups

operationId: postTemplateTransactionGroups parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateTransactionGroups' description: Request object for creating new Template Transaction Groups Configuration. required: true get: summary: Operation to fetch TemplateTransactionGroups. description: Operation to fetch template transaction group.

OperationId:getTemplateTransactionGroups

operationId: getTemplateTransactionGroups parameters: - name: transactionGroupCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: transactionGroupType in: query required: false description: Wrapper Transaction Type. schema: type: string enum: - Revenue - Payment - Wrapper uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetch template transaction groups content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/templateTransactionGroups' '204': description: TemplateTransactionGroups not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig delete: summary: Operation to delete TemplateTransactionGroups. description: Operation to remove existing template transaction group.

OperationId:deleteTemplateTransactionGroups

operationId: deleteTemplateTransactionGroups parameters: - name: templateTransactionCodes in: query required: true style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /templateTransactionSubGroups: put: summary: Operation to change TemplateTransactionSubgroups. description: Operation to change template transaction subgroups

OperationId:putTemplateTransactionSubgroups

operationId: putTemplateTransactionSubgroups parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateTransactionSubgroups' description: Request object for changing existing template transaction subgroups configuration. required: true post: summary: Operation to create TemplateTransactionSubgroups. description: Operation to create template transaction subgroups

OperationId:postTemplateTransactionSubgroups

operationId: postTemplateTransactionSubgroups parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateTransactionSubgroups' description: Request object for creating new template transaction subgroups configuration. required: true get: summary: Operation to fetch TemplateTransactionSubgroups. description: Operation to fetch template transaction subgroups

OperationId:getTemplateTransactionSubgroups

operationId: getTemplateTransactionSubgroups parameters: - name: transactionGroupCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: transactionSubgroupsCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetch template transaction subgroups configuration. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/templateTransactionSubgroups' '204': description: TemplateTransactionSubgroups not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig delete: summary: Operation to delete TemplateTransactionSubgroups. description: Operation to remove template transaction subgroups

OperationId:deleteTemplateTransactionSubgroups

operationId: deleteTemplateTransactionSubgroups parameters: - name: subgroup in: query description: Template transaction subgroup configuration code required: false style: form explode: true schema: type: array items: type: string - name: group in: query description: Template transaction group configuration code required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /transactionArrangementCodes: get: summary: Operation to fetch TransactionArrangementCodes. description: '

OperationId:getTransactionArrangementCodes

' operationId: getTransactionArrangementCodes parameters: - name: hotelId in: query required: true description: Hotel code for which the transaction codes belong to. schema: type: string - name: transactionCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching transaction codes with associated arrangement codes. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/transactionArrangementCodes' '204': description: TransactionArrangementCodes not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /transactionCodeAccessRoles/set: put: summary: Operation to set TransactionCodeAccessRoles. description: Operation to Set Transaction Code Access Roles.

OperationId:setTransactionCodeAccessRoles

operationId: setTransactionCodeAccessRoles parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/transactionCodeAccessRoles' description: Request object for Setting a Transaction Code Access Roles required: true /transactionCodeOwnership: put: summary: Operation to change TransactionCodeOwnership. description: Operation to change ownership of transaction code.

OperationId:putTransactionCodeOwnership

operationId: putTransactionCodeOwnership parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/transactionCodeOwnership' description: Request object for changing ownership of selected transaction codes operation. required: true /transactionCodes: put: summary: Operation to change TransactionCodes. description: Operation to change transaction codes.

OperationId:putTransactionCodes

operationId: putTransactionCodes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response object for changing existing Transaction Codes Configuration. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/transactionCodes' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/hotelTransactionCodes' description: Request object for changing existing Transaction Codes Configuration. required: true post: summary: Operation to create TransactionCodes. description: Use this API to create transaction codes for a specific hotel.

OperationId:postTransactionCodes

operationId: postTransactionCodes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/hotelTransactionCodes' description: Request object for creating new Transaction Codes Configuration. required: true get: summary: Operation to fetch TransactionCodes. description: Use this API to return transaction codes based on search criteria such as hotelIds, transactionGroupCodes, transactionSubgroupsCodes, transactionCodes, description, etc..

OperationId:getTransactionCodes

operationId: getTransactionCodes parameters: - name: hotelIds in: query required: true style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: compTransactionCodes in: query x-example: 'false' required: false description: Flag to indicate whether comp accounting transaction codes are being requested. If true, only comp accounting transaction codes will be returned. If false, only standard transaction codes will be returned. schema: type: boolean - name: includeInactive in: query x-example: 'false' required: false description: Inactive flag used to include/exclude inactive transaction codes from the search result schema: type: boolean - name: earnMembershipPoints in: query x-example: 'false' required: false description: This flag indicates that the transaction is eligible to earn points (guest can earn points on the revenue posted to this transaction code) schema: type: boolean - name: transactionGroupCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: transactionSubgroupsCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: transactionCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: description in: query required: false description: Description of the Transaction code. schema: type: string - name: brandCode in: query required: false description: Property associated with the corporate information brand code in the search criteria schema: type: string - name: universalProductCode in: query required: false description: Unique Universal product code search criteria. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching hotel's transaction codes summary. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/hotelTransactionCodes' '204': description: TransactionCodes not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /transactionCodes/copy: put: summary: Operation to copy TransactionCodes. description: Operation to copy transaction codes.

OperationId:copyTransactionCodes

operationId: copyTransactionCodes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/transactionCodesCopy' description: Request object for copying transaction codes in the configuration. required: true /transactionDiscounts: post: summary: Operation to create TransactionDiscounts. description: Use this API to create transaction discounts for a specific hotel.

OperationId:postTransactionDiscounts

operationId: postTransactionDiscounts parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/transactionDiscount' description: Request object for creating new Transaction Discount Configuration. required: true get: summary: Operation to fetch TransactionDiscounts. description: Operation to fetch Transaction Discounts.

OperationId:getTransactionDiscounts

operationId: getTransactionDiscounts parameters: - name: hotelIds in: query required: true style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: transactionDiscountCodes in: query description: Discount codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: description in: query required: false description: Description text set to the search criteria schema: type: string maxLength: 2000 - name: ruleType in: query required: false description: The rule type on which the transaction discount is based. schema: type: string enum: - Membership uniqueItems: true - name: membershipTypes in: query description: Membership Types set to the search criteria required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: membershipLevels in: query description: Membership Levels set to the search criteria required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: fetchInstructions in: query description: When this fetch instruction is passed, the details of article codes and transaction codes attached to the transaction discount are fetched. required: false style: form explode: true schema: type: array items: type: string enum: - IncludeCodes uniqueItems: true - name: includeInactive in: query x-example: 'false' required: false description: Indicator that tells whether to include inactive transaction discounts in search results. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Transaction Discount Configurations. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/transactionDiscounts' '204': description: No transaction discounts found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /transactionDiscounts/copy: put: summary: Operation to copy TransactionDiscounts. description: Operation to copy Transaction Discounts.

OperationId:copyTransactionDiscounts

operationId: copyTransactionDiscounts parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Additional warnings about the operation. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/transactionDiscountsCopy' description: Request object for copying a Transaction Discount Configuration. required: true /transactionDiversionRules: put: summary: Operation to change TransactionDiversionRules. description: Operation to change Transaction Diversion Rules.

OperationId:putTransactionDiversionRules

operationId: putTransactionDiversionRules parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/transactionDiversionRules' description: Request object for modifying an existing Transaction Diversion Rule required: true post: summary: Operation to create TransactionDiversionRules. description: Operation to create Transaction Diversion Rules.

OperationId:postTransactionDiversionRules

operationId: postTransactionDiversionRules parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/transactionDiversionRules' description: Request object for creating a Transaction Diversion Rule required: true get: summary: Operation to fetch TransactionDiversionRules. description: Operation to fetch Transaction Diversion Rules.

OperationId:getTransactionDiversionRules

operationId: getTransactionDiversionRules parameters: - name: hotelIds in: query required: true style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: ruleCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: type in: query required: false description: 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 reservation schema: type: string enum: - Vip - Membership uniqueItems: true - name: description in: query required: false description: User defined message for the Transaction Diversion Rule. schema: type: string - name: level in: query required: false description: Reservation level. schema: type: string enum: - Property - Reservation uniqueItems: true - name: membershipTypeCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: membershipTypeLevels in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: vipCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for information regarding Transaction Diversion Rule content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/transactionDiversionRules' '204': description: TransactionDiversionRules not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /transactionDiversionRules/remove: put: summary: Operation to delete TransactionDiversionRules. description: Operation to remove Transaction Diversion Rules.

OperationId:removeTransactionDiversionRules

operationId: removeTransactionDiversionRules parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/transactionDiversionRules' description: Request object for deleting an existing Transaction Diversion Rule required: true /transactionGenerates: put: summary: Operation to delete TransactionGenerates. description: Operation to remove transaction generates.

OperationId:removeTransactionGenerates

operationId: removeTransactionGenerates parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/hotelTransactionGenerates' description: Request to remove transaction generates. required: true /transactionGroups: put: summary: Operation to change TransactionGroups. description: Operation to change transaction groups.

OperationId:putTransactionGroups

operationId: putTransactionGroups parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/transactionGroups' description: Request object for changing existing Transaction Groups Configuration. required: true post: summary: Operation to create TransactionGroups. description: Operation to create transaction groups.

OperationId:postTransactionGroups

operationId: postTransactionGroups parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/transactionGroups' description: Request object for creating new Transaction Groups Configuration. required: true get: summary: Operation to fetch TransactionGroups. description: Operation to fetch transaction groups.

OperationId:getTransactionGroups

operationId: getTransactionGroups parameters: - name: hotelIds in: query required: true style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: transactionGroupCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: transactionGroupType in: query required: false description: Wrapper Transaction Type. schema: type: string enum: - Revenue - Payment - Wrapper uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Transaction Groups Configuration. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/transactionGroups' '204': description: TransactionGroups not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig delete: summary: Operation to delete TransactionGroups. description: Operation to remove transaction groups.

OperationId:deleteTransactionGroups

operationId: deleteTransactionGroups parameters: - name: code in: query description: Configuration code. required: false style: form explode: true schema: type: array items: type: string - name: hotelId in: query description: Hotel where the code is configured. required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /transactionGroups/copy: put: summary: Operation to copy TransactionGroups. description: Operation to copy transaction groups.

OperationId:copyTransactionGroups

operationId: copyTransactionGroups parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/transactionGroupsCopy' description: List of the transaction groups to be copied. required: true /transactionSubGroups: put: summary: Operation to change TransactionSubgroups. description: Operation to change transaction sub groups.

OperationId:putTransactionSubgroups

operationId: putTransactionSubgroups parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/hotelTransactionSubgroups' description: Request object for changing existing Transaction Subgroups Configuration. required: true post: summary: Operation to create TransactionSubgroups. description: Operation to create transaction sub groups.

OperationId:postTransactionSubgroups

operationId: postTransactionSubgroups parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/hotelTransactionSubgroups' description: Request object for creating new Transaction Subgroups Configuration. required: true get: summary: Operation to fetch TransactionSubgroups. description: Operation to fetch transaction sub groups.

OperationId:getTransactionSubgroups

operationId: getTransactionSubgroups parameters: - name: hotelIds in: query required: true style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: transactionGroupCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: transactionSubgroupsCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Transaction Subgroups Configuration. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/hotelTransactionSubgroups' '204': description: TransactionSubgroups not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig delete: summary: Operation to delete TransactionSubgroups. description: Operation to remove transaction sub groups.

OperationId:deleteTransactionSubgroups

operationId: deleteTransactionSubgroups parameters: - name: subgroup in: query description: Template transaction subgroup configuration code required: false style: form explode: true schema: type: array items: type: string - name: group in: query description: Template transaction group configuration code required: false style: form explode: true schema: type: array items: type: string - name: hotelId in: query description: Hotel code where the transaction subgroup is configured. required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig /transactionSubGroups/copy: put: summary: Operation to copy TransactionSubgroups. description: Operation to copy transaction subgroups

OperationId:copyTransactionSubgroups

operationId: copyTransactionSubgroups parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/transactionSubgroupsCopy' description: Request object to copy transaction subgroups to the properties specified. required: true /upsert/authorizationConfigRule: put: summary: Operation to create/change AuthorizationConfigRule. description: '

OperationId:putUpsertAuthorizationConfigRule

' operationId: putUpsertAuthorizationConfigRule parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/authorizationConfigRules' description: Request object to change authorization rule. required: true /upsert/authorizerGroups: put: summary: Operation to create/change AuthorizerGroups. description: Operation to create/change Authorizer Groups.

OperationId:putUpsertAuthorizerGroups

operationId: putUpsertAuthorizerGroups parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/authorizerGroupsToChange' description: Request object for changing existing Authorizer Group Configuration. required: true /upsert/cashiers: put: summary: Operation to create/change CashiersDetails. description: This Operation to create/Change a Cashier.

OperationId:putUpsertCashiers

operationId: putUpsertCashiers parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/cashiers' description: Request objects for modifying cashiers required: true /upsert/collectingAgentTaxes: put: summary: Operation to create/change CollectingAgentTaxes. description: Operation to create/change Collecting Agent Taxes.

OperationId:putUpsertCollectingAgentTaxes

operationId: putUpsertCollectingAgentTaxes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/collectingAgentTaxes' description: Request object to change Collecting Agent Taxes. required: true /upsert/compTypes: put: summary: Operation to Create/Change Comp Types. description: Operation to Create/Change Comp Types.

OperationId:changeUpsertCompTypes

operationId: changeUpsertCompTypes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/compTypesStatus' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/compTypesToBeChanged' description: Request object for changing Comp Types. required: true /upsert/currencyExchangeServiceTaxes: put: summary: create/change ExchangeServiceTaxes. description: Operation to create/change currency exchange service taxes.

OperationId:putUpsertCurrencyExchangeServiceTaxes

operationId: putUpsertCurrencyExchangeServiceTaxes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/currencyExchangeServiceTaxes' description: Request object for changing currency exchange service taxes required: true /upsert/fiscalFolioParameters: put: summary: Operation to create/change FiscalFolioParameters. description: Operation to create/change Fiscal Folio Parameters.

OperationId:putUpsertFiscalFolioParameters

operationId: putUpsertFiscalFolioParameters parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/fiscalFolioParameters' description: Request object for changing existing Fiscal Folio Parameter Configurations. required: true /upsert/fiscalPeriods: put: summary: Operation to create/change FiscalPeriods. description: Operation to create/change Fiscal Periods.

OperationId:putUpsertFiscalPeriods

operationId: putUpsertFiscalPeriods parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/fiscalPeriodsEdit' description: Request object to edit Fiscal Periods required: true /upsert/fiscalYears: put: summary: Operation to create/change FiscalYears. description: Operation to create/change Fiscal Years.

OperationId:putUpsertFiscalYears

operationId: putUpsertFiscalYears parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/fiscalYears' description: Request object to edit Fiscal Years required: true /upsert/folioCopyLegends: put: summary: Operation to create/change FolioCopyLegends. description: Operation to create/change folio copy legends information

OperationId:putUpsertFolioCopyLegends

operationId: putUpsertFolioCopyLegends parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/folioCopyLegend' description: Request object to edit description of folio copy legends required: true /upsert/folioPrintQueues: put: summary: Operation to create/change FolioPrintQueues. description: Operation to create/change folio print queues.

OperationId:putUpsertFolioPrintQueues

operationId: putUpsertFolioPrintQueues parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/folioPrintQueues' description: Request object for changing folio print queues required: true /upsert/folioTypeLegendMappings: put: summary: Operation to create/change folio type legend mappings config. description: Operation to create/change folio type legend mappings config.

OperationId:changeUpsertFolioTypeLegendMappingConfig

operationId: changeUpsertFolioTypeLegendMappingConfig parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/folioTypeLegendMappingConfigStatus' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/folioTypeLegendMappingConfigToBeChanged' description: Request object to edit folio type legend mapping information. required: true /upsert/folioTypesConfig: put: summary: Operation to create/change FolioTypesConfig. description: Operation to create/change Folio Type Names.

OperationId:putUpsertFolioTypesConfig

operationId: putUpsertFolioTypesConfig parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/folioTypesConfig' description: Request object to change Folio Type Names. required: true /upsert/guiNumberRules: put: summary: Operation to create/change GUINumberRules. description: Operation to create/change GUI Number rules

OperationId:putGputUpsertGUINumberRulesUINumberRules

operationId: putUpsertGUINumberRules parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/gUINumberRulesDetails' description: Request object to edit GUI number rules. required: true /upsert/hotels/{hotelId}/compBucket/redemption/{redemptionCode}: put: summary: Operation to Create/Change Comp Bucket Redemption Codes. description: Operation to create/change Comp Bucket Redemption Codes.

OperationId:putUpsertCompBucketRedemptionConfig

operationId: putUpsertCompBucketRedemptionConfig parameters: - name: redemptionCode in: path required: true description: Bucket Redemption Code schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel in OPERA schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/compBucketRedemptionConfig' description: Request object for changing existing Comp Bucket Redemption Codes configurations. required: true /upsert/hotels/{hotelId}/consumableInventory: put: summary: Operation to create/change Consumable Inventory. description: Operation to create/change Consumable Inventory.

OperationId:putUpsertConsumableInventory

operationId: putUpsertConsumableInventory parameters: - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Additional warnings about the operation. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/consumableItemType' description: Request object for changing a Consumable Inventory Configuration. required: true /upsert/hotels/{hotelId}/customNumbers/configuration/{configurationId}: put: summary: Operation to create/change custom number config. description: '

OperationId:putUpsertCustomNumberConfig

' operationId: putUpsertCustomNumberConfig parameters: - name: configurationId in: path required: true description: Unique ID of the configuration schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel in OPERA schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response object to change custom number configuration. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/customNumberConfiguration' description: Request object to change custom number configuration. required: true /upsert/hotels/{hotelId}/transactionDiscounts/{transactionDiscountCode}: put: summary: Operation to create/change TransactionDiscounts. description: Operation to create/change Transaction Discounts.

OperationId:putUpsertTransactionDiscounts

operationId: putUpsertTransactionDiscounts parameters: - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: transactionDiscountCode in: path required: true description: Unique code for transaction discount schema: type: string maxLength: 20 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Additional warnings about the operation. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/transactionDiscount' description: Request object for changing a Transaction Discount Configuration. required: true /upsert/hotels/{hotelId}/vouchers: put: summary: Operation to Create/change a voucher. description:

OperationId:putUpsertVouchers

operationId: putUpsertVouchers parameters: - name: hotelId in: path required: true description: Unique ID of the hotel in OPERA schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/vouchersDetails' description: Request to change voucher. required: true /upsert/noShowPostingRules: put: summary: Operation to create/change NoShowPostingRules. description: Operation to create/change No Show Posting Rules.

OperationId:putUpsertNoShowPostingRules

operationId: putUpsertNoShowPostingRules parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/noShowPostingRulesEdit' description: Request object for changing existing No Show Posting Rule Configurations. required: true /upsert/numberDescriptions: put: summary: Operation to create/change NumberDescriptions. description: The operation is to create/change the description corresponding to a number.

OperationId:putUpsertNumberDescriptions

operationId: putUpsertNumberDescriptions parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/numberDescriptions' description: Request object to edit description of numbers required: true /upsert/packageArrangementCodes: put: summary: Operation to create/change PackageArrangementCodes. description: '

OperationId:putUpsertPackageArrangementCodes

' operationId: putUpsertPackageArrangementCodes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/packageArrangementCodes' description: Request object for changing package arrangement codes. required: true /upsert/revenueBucketCodes: put: summary: Operation to create/change RevenueBucketCodes. description: Operation to create/change Revenue Bucket Codes.

OperationId:putUpsertRevenueBucketCodes

operationId: putUpsertRevenueBucketCodes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/revenueBucketCodes' description: Request object for changing existing Revenue Bucket Codes Configurations. required: true /upsert/revenueTypeMapping: put: summary: Operation to create/change RevenueTypeMapping. description: '

OperationId:putUpsertRevenueTypeMapping

' operationId: putUpsertRevenueTypeMapping parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response object to change Revenue Type Mapping configurations. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/revenueTypeMapping' description: Request object to change Revenue Type Mapping configurations. required: true /upsert/routingInstructions: put: summary: Operation to create/change RoutingInstructions. description: Operation to create/change routing instructions.

OperationId:putUpsertRoutingInstructions

operationId: putUpsertRoutingInstructions parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/routingInstructions' description: Request when changing a routing instruction. required: true /upsert/transactionDiversionRules: put: summary: Operation to create/change TransactionDiversionRules. description: Operation to create/change Transaction Diversion Rules.

OperationId:putUpsertTransactionDiversionRules

operationId: putUpsertTransactionDiversionRules parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - CashieringConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/transactionDiversionRules' description: Request object for modifying an existing Transaction Diversion Rule required: true components: schemas: reservationQueueInformationType: type: object description: Information regarding the Date, Duration and Priority of the reservation on Queue for Check in. properties: timeSpan: description: 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 add to the StartDate to yield end date. type: object properties: startDate: type: string format: date maxLength: 8 endDate: type: string format: date maxLength: 8 duration: type: string durationInSeconds: description: The total duration, in seconds, the reservation is on Queue. type: integer guestTextInfo: description: Information for the message sent to the user $ref: '#/components/schemas/queueTextInfoType' priority: description: The Queue Priority given to this reservation. type: integer averageQueueTimeToCheckIn: description: The average time, in seconds, a reservation was on queue prior to Check-In. type: integer averageQueueTimeCurrentReservations: description: The average time, in seconds, of the reservations currently in queue. type: integer queueDate: description: The Business date on which the reservation was due to arrive and is currently placed on Queue for Check In. type: string format: date maxLength: 8 searchCashiersRequest: type: object properties: cashierIDs: type: array items: type: number maxItems: 4000 description: Numberic code for cashier ID. x-example: - 54 limit: type: integer description: Indicates maximum number of records a Web Service should return. offset: type: integer description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. default: 0 name: type: string description: Partial name of a cashier. includeInactive: type: boolean description: Indicator that tells whether to include inactive cashiers in search results. x-example: false appUser: type: string description: Name of the application user associated with the cashier id minLength: 0 maxLength: 250 required: - cashierIDs resAccompanyGuestInfoType: type: object properties: firstName: description: Given name, first name or names type: string lastName: description: Family name, last name. type: string fullName: description: String representation of the full name type: string registrationCardNo: description: Unique identifier of the police registration card number. type: string minLength: 0 maxLength: 40 profileIdList: description: Unique identifiers for the Profile for both internal and external systems. In case of Travel Agent the IATA code and in case of Company can be any form of identifier as id. $ref: '#/components/schemas/profileIdList' stayInfoType: type: object description: Details on the Room Stay including Guest Counts, Time Span of this Room Stay, pointers to Res Guests, guest Memberships, Comments and Special Requests pertaining to this particular Room Stay and finally financial information related to the Room Stay, including Guarantee, Deposit and Payment and Cancellation Penalties. properties: arrivalDate: type: string format: date departureDate: type: string format: date originalTimeSpan: description: The Original Time Span covers the Room Stay dates of the original reservation. $ref: '#/components/schemas/timeSpanType' expectedTimes: description: The expected arrival, return and departure times of the guest. $ref: '#/components/schemas/resExpectedTimesType' adultCount: description: A collection of Guest Counts associated with Room Stay. type: integer childCount: description: A collection of Child Counts associated with Room Stay. type: integer roomClass: description: Room class code type: string minLength: 0 maxLength: 20 roomType: description: Room type code type: string minLength: 0 maxLength: 20 componentRoomType: description: True indicates room type is a component type. type: boolean numberOfRooms: description: Room Id type: integer roomId: description: Room Id type: string minLength: 0 maxLength: 20 ratePlanCode: description: Rate plan code type: string minLength: 0 maxLength: 20 rateAmount: description: Rate amount $ref: '#/components/schemas/currencyAmountType' points: description: The Points contains the number of points used to book a particular room type. $ref: '#/components/schemas/pointsType' rateSuppressed: description: Whether this rate should be suppressed from view type: boolean reservationBlock: description: Key information about the block for this reservation. $ref: '#/components/schemas/reservationBlockType' bookingChannelCode: description: Booking channel code type: string minLength: 0 maxLength: 20 linkCode: description: Party code type: string maxLength: 2000 fixedRate: description: True if the rate is a fixed rate, otherwise false type: boolean totalAmount: description: The total amount charged for the Room Stay including additional occupant amounts and fees. If TaxInclusive is set to True, then taxes are included in the total amount. $ref: '#/components/schemas/currencyAmountType' guarantee: description: The guarantee information associated to the Room Stay. A maximum of 5 occurances are available for use depending on the context. $ref: '#/components/schemas/resGuaranteeType' promotion: description: Promotion Codes $ref: '#/components/schemas/promotionType' marketCode: description: Market code type: string minLength: 0 maxLength: 20 marketDescription: description: Description of Market code type: string minLength: 0 maxLength: 4000 sourceCode: description: Source of business type: string minLength: 0 maxLength: 20 sourceCodeDescription: description: Description of the source of business. type: string minLength: 0 maxLength: 4000 balance: description: Balance amount $ref: '#/components/schemas/currencyAmountType' compBalance: description: Comp Balance amount $ref: '#/components/schemas/currencyAmountType' roomTypeCharged: description: Room type code that was charged type: string minLength: 0 maxLength: 20 depositPayments: description: A collection of deposit and/or payments for the Room Stay. $ref: '#/components/schemas/currencyAmountType' guestServiceStatus: description: Service Status of In House guest like DND or MUP $ref: '#/components/schemas/guestHousekeepingServiceRequestType' scheduledCheckoutTime: description: Indicates that this reservation is scheduled for automated check out. type: string format: date roomNumberLocked: description: When true, indicates a room number cannot be changed. When false, indicates a room number may be changed. type: boolean pseudoRoom: description: True indicates as pseudo room type. This is usually used for a posting master reservation. type: boolean assignedByAI: description: Represents the room was assigned by AI Room Assignment. type: boolean upgradedByAI: description: Represents the room was assigned by AI Room Assignment. type: boolean packageArrangementCodeType: type: object description: Generic Type to specify unique/primary id for the code. mostly used for Hotel level configuration codes removal request. properties: hotelId: description: Hotel where the code is configured. type: string minLength: 0 maxLength: 20 code: description: Configuration code. type: string minLength: 0 maxLength: 20 arrangementId: description: Primay key of arrangement codes type: number description: description: Description of the Folio Group Code. $ref: '#/components/schemas/translationTextType2000' taxTypeCode: description: information about the tax type code linked to the folio arrangment Code. type: string revenue: description: specify whether the arrangement postings are classed as revenue. type: boolean inactive: description: Represents whether the package arrangement code is inactive or not type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' folioCopyLegends: type: object properties: legends: $ref: '#/components/schemas/folioCopyLegendsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' entityType: type: string description: Indicates the rule is based on Minutes associated with the charge. enum: - ThresholdCount - ThresholdQuantity - ThresholdMinutes folioTypeLegendMappingConfigStatus: type: object description: Response Body. properties: links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' revenueBucketTypesCopy: type: object properties: revenueBucketTypes: type: array description: List of the Revenue Bucket Types to be copied. items: $ref: '#/components/schemas/copyConfigurationCodeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' folioStatusType: type: string description: 'The Folio Status Example: DEPOSIT folio, VOID folio or the default OK folio status.' enum: - Deposit - Void - Ok - Zero - Compress - Converted - Internal colorType: type: string description: Color configuration type. This color configuration provides a visual category of entities. enum: - Red - DarkRed - Green - DarkGreen - LightGreen - Orange - White - Yellow - DarkYellow - Purple - Brown - Gray - Aqua - Chocolate - Blue - LightBlue - DarkBlue - Cyan - DarkCyan - Magenta - DarkMagenta - Black pointsType: type: object description: The Redeem Points contains the number of points required to book a room type. properties: awardsType: description: Awards type for the award type rate code. type: string points: description: No of points required to book this Room Stay. type: integer trxCodeAmountsType: type: object description: Transaction Code's default amount details. properties: defaultPrice: description: Default price of the Transaction Code. type: number minAmount: description: Minimum amount to be posted on this Transaction Code. type: number maxAmount: description: Maximum Amount to be posted on this Transaction Code. type: number currency: description: Default currency code for the amounts. type: string minLength: 0 maxLength: 20 customChargePostingRhythmType: type: object description: Posting rhythm details. properties: type: description: Posting rhythm types for custom charges. $ref: '#/components/schemas/customChargePostingRhythmTypeOption' startOnNight: description: Starting night of the reservation for which the custom charge will be posted. This is applicable when the posting rhythm 'Post On Every X Nights Starting Y Night' is selected. type: integer maximum: 9999 postEveryXNights: description: The custom charge will be posted for every X night, where X is the frequency of nights. This is applicable when the posting rhythm 'Post On Every X Nights Starting Y Night' is selected. type: integer maximum: 9999 startOnNightPrice: description: The amount for which the custom charge will be posted to the reservation, starting on the night defined by 'Start On Night'. This is applicable when the posting rhythm 'Post On Every X Nights Starting Y Night' is selected. type: integer maxNights: description: The maximum number of nights for which the custom charge posted to the reservation. This is applicable when the posting rhythm 'Post Every Night For X Nights' is selected. type: integer maximum: 9999 paymentCardType: type: object description: Contains credit card information. properties: cardUsageRules: description: Contains valid usages of the card. $ref: '#/components/schemas/cardUsageRulesType' validation: description: Contains rules to validate card information. $ref: '#/components/schemas/paymentMethodValidationRuleType' merchantNumber: description: The merchant number to use when settling or transmitting credit card information. type: string minLength: 0 maxLength: 20 option: description: Switch card options. $ref: '#/components/schemas/cardOptionType' cardType: description: Internal code of credit card type. $ref: '#/components/schemas/cardTypeType' userDefinedCardType: description: User defined credit card type if credit card type from a defined list is not provided. type: string minLength: 0 maxLength: 2 processing: description: This contains information on whether EFT is enabled. A value of 'C' indicates EFT is enabled and 'M' indicates manual authorization is available for this payment card type. $ref: '#/components/schemas/cardProcessingType' authorizerGroupsToChange: type: object properties: criteria: description: Authorizer Groups Configuration to be changed. $ref: '#/components/schemas/authorizerGroupsCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' genericHotelCodeCodeType: type: object description: Generic Type to specify unique/primary id for the code. mostly used for Hotel level configuration codes removal request. properties: hotelId: description: Hotel where the code is configured. type: string minLength: 0 maxLength: 20 code: description: Configuration code. type: string minLength: 0 maxLength: 20 packageArrangementCodesType: type: array description: Details for package arrangement codes. maxItems: 4000 items: $ref: '#/components/schemas/packageArrangementCodeType' folioTypesConfig: type: object properties: folioTypes: description: Collection of Folio Type Name details. $ref: '#/components/schemas/folioTypesConfigType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' timeSpanType: type: object description: 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 add to the StartDate to yield end date. properties: startDate: type: string format: date maxLength: 8 endDate: type: string format: date maxLength: 8 duration: type: string indicatorType: type: object description: Lamp indicator Type. properties: indicatorName: description: Name of the indicator. type: string minLength: 0 maxLength: 80 count: description: Indicates number of occurrences of the indicator. type: integer fixedChargesType: type: array description: Holds fixed charge detail. maxItems: 4000 items: $ref: '#/components/schemas/fixedChargeType' paymentMethods: type: object properties: paymentMethods: description: Collection of payment methods. $ref: '#/components/schemas/paymentMethodsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' expenseArrangementCodes: type: object properties: expenseArrangementCodes: description: Collection of expense arrangement codes. $ref: '#/components/schemas/expenseArrangementCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' addressInfoType: type: object description: Provides address information. properties: address: description: Address details for the profile. $ref: '#/components/schemas/addressType' id: description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. type: string minLength: 0 maxLength: 80 type: description: A reference to the type of object defined by the UniqueID element. type: string minLength: 0 maxLength: 40 fiscalPayloadType: type: string enum: - CheckOut - FolioGeneration - PostPayment warningsType: type: array description: Used in conjunction with the Success element to define a business error. maxItems: 4000 items: $ref: '#/components/schemas/warningType' trxCodeUsageType: type: object description: Details about the element on which the transaction code is being used. properties: usageName: description: Name of the element type on which the transaction code is being used. type: string minLength: 0 maxLength: 100 usageDetail: description: Specific codes of the element type on which the transaction code is being used. type: string minLength: 0 maxLength: 2000 gUINumberRule: type: object description: GUI Number rule properties: hotelId: description: Property associated with GUI number type: string minLength: 0 maxLength: 20 period: description: Period associated with GUI number, each Period defined by two month sets example JANUARY/FEBRUARY $ref: '#/components/schemas/gUINumberPeriodType' periodCode: description: Period code associated with period type: string minLength: 0 maxLength: 20 prefix: description: Prefix associated with GUI number. type: string minLength: 0 maxLength: 100 beginNo: description: BeginNo associated with GUI number type: integer endNo: description: EndNo associated with GUI number type: integer currentFiscalBillNo: description: CurrentFiscalBillNo associated with GUI number type: integer managedBy: $ref: '#/components/schemas/managedByOptions' expenseArrangementCodeType: type: object description: Generic Type to specify unique/primary id for the code. mostly used for Hotel level configuration codes removal request. properties: hotelId: description: Hotel where the code is configured. type: string minLength: 0 maxLength: 20 code: description: Configuration code. type: string minLength: 0 maxLength: 20 arrangementId: description: Primay key of arrangement codes type: number description: description: Description of the Folio Group Code. $ref: '#/components/schemas/translationTextType2000' taxTypeCode: description: information about the tax type code linked to the folio arrangment Code. type: string revenue: description: specify whether the arrangement postings are classed as revenue. type: boolean transactionCodes: description: Transaction codes that are associated to the folio grouping codes. $ref: '#/components/schemas/codeListType' cardNumberTypeType: type: string description: Simple type for indicating if credit card number is tokenized. enum: - CardNumber - Token fiscalPartnerType: type: object description: Fiscal partner Type properties: hotelId: description: Property code. type: string minLength: 0 maxLength: 20 partnerCode: description: Fiscal Partner Code. $ref: '#/components/schemas/fiscalPartnerCodeType' priority: description: Priority order for processing. type: integer paymentTypes: description: Payment types associated with Fiscal Partner. $ref: '#/components/schemas/codeListType' payloadPaymentTypes: description: Payment types associated with the Fiscal Partner for payment payload generation. $ref: '#/components/schemas/codeListType' fiscalFolioProfile: description: Payment types associated with Fiscal Partner. type: string minLength: 0 maxLength: 1 fiscalPayloadTypes: type: array description: Types of payload supported by the Fiscal Partner. uniqueItems: true items: $ref: '#/components/schemas/fiscalPayloadType' folioRequired: description: Indicates if the folio PDF is required by the partner or not. type: boolean customChargesType: type: array description: Details for Custom Charges Codes. maxItems: 4000 items: $ref: '#/components/schemas/customChargeType' compTypesDetails: type: object description: Response object for fetching Comp Types. properties: compTypes: description: Collection of Comp Types. $ref: '#/components/schemas/compTypesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' currencyAmountType: type: object description: A monetary value expressed with a currency code. properties: amount: description: A monetary amount. type: number currencyCode: description: Provides a currency code to reflect the currency in which an amount may be expressed. type: string minLength: 3 maxLength: 3 trxCodeUsagesType: type: array description: Element on which the transaction code is being used. maxItems: 4000 items: $ref: '#/components/schemas/trxCodeUsageType' monthlyCustomVarianceInfoType: type: object description: Value Variance information for a CUSTOM code for a month. properties: month: description: Month number type: integer variance: description: Variance for a month. type: number housekeepingRoomStatusType: type: string description: Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService. enum: - Clean - Dirty - Pickup - Inspected - OutOfOrder - OutOfService customChargeExemptionConfigType: type: object description: Provides information about Exemptions. properties: hotelId: description: Code of the Hotel. type: string minLength: 0 maxLength: 20 exemption: description: Exemption type: string minLength: 0 maxLength: 20 description: description: Exemption Desciption type: string minLength: 0 maxLength: 200 percentage: description: Exemption Percentage type: number minimum: 0 maximum: 100 startDate: description: Date when this Exemption will be effective type: string format: date maxLength: 8 endDate: description: Date till the Exemption will be effective. type: string format: date maxLength: 8 inactiveDate: description: Date when this Exemption is Inactive type: string format: date maxLength: 8 includeInactive: description: Indicator that tells whether to include inactive Custom Charge Ememptions. type: boolean propertyExemption: description: Flag specifying if custom charge exemptions is property level or not. type: boolean templateTransactionSubgroupIDsType: type: array description: List of template transaction subgroup IDs maxItems: 4000 items: $ref: '#/components/schemas/templateTransactionSubgroupIDType' customNumberConfigurationType: type: object description: Custom number configuration details. properties: code: description: Custom number configuration code. type: string minLength: 0 maxLength: 20 description: description: The description of the custom number configuration code. type: string minLength: 0 maxLength: 2000 area: description: The area where this custom number will be used. $ref: '#/components/schemas/customNumberConfigurationAreaType' formula: description: The formula to generate the custom number. type: string minLength: 0 maxLength: 2000 condition: description: The condition to be met to generate and apply the custom number. type: string minLength: 0 maxLength: 2000 timeSpan: description: The begin and end date of the custom number configuration. $ref: '#/components/schemas/timeSpanType' inActive: description: Indicator that tells whether the configuration is active or not. type: boolean orderSequence: description: Display Order sequence. type: number hotelId: description: Hotel context for the custom number configuration. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' generateAdjustmentTypeType: type: string description: Generates calculation bucket/group. Percentage generates are calculated against amount in one of the the calculation bucket. enum: - DuringEndOfDay - PromptAtCheckOut - NoAdjustment budgetForecastTransactionInfoBaseType: type: object description: Budget Forecast information for budget Transaction codes. properties: transactionCodeInformation: description: Budget Forecast information for Transaction segment code . type: array maxItems: 4000 items: $ref: '#/components/schemas/transactionCodeInformationBaseType' revenue: description: Flag to indicate if revenue information has to be included. type: boolean transactionDiscountsCopy: type: object properties: transactionDiscountCopy: type: array description: List of the transaction discount codes to be copied to other hotel code(s). items: $ref: '#/components/schemas/copyTransactionDiscountsType' cyclePeriodType: type: string description: Signifies Calendar Period enum: - FourWeeks - FourFourFiveWeeks - FourFiveFourWeeks - FiveFourFourWeeks - CalendarMonth aRAccountType: type: object description: Accounts Receivabales Account details type. properties: hotelId: description: Property where the AR Account exists. type: string minLength: 0 maxLength: 20 accountName: description: Name of the AR Account. type: string minLength: 0 maxLength: 200 accountId: description: The unique ID for the Account. $ref: '#/components/schemas/uniqueID_Type' accountNo: description: The Account Number for the Account. type: string minLength: 0 maxLength: 20 profileId: description: Internal Profile ID for the AR Account. $ref: '#/components/schemas/profileId' balance: description: Open Balance of the Account for this property. $ref: '#/components/schemas/currencyAmountType' creditLimit: description: The maximum credit allowed for the Account. $ref: '#/components/schemas/currencyAmountType' contactName: description: The person to contact for this Account. type: string minLength: 0 maxLength: 200 paymentDueDays: description: Number of days on which person can make payment. type: string minLength: 0 maxLength: 20 monthEndCalcYN: description: Month End Calculation. type: boolean address: description: Address information for the address which is attached to this AR Account. $ref: '#/components/schemas/addressInfoType' email: description: Email information for the Account. This is the Email that is attached to this AR Account. $ref: '#/components/schemas/emailInfoType' telephones: description: The Telephone and Fax details attached to the Account. type: array maxItems: 4000 items: $ref: '#/components/schemas/telephoneInfoType' lastReminderInfo: description: Report History Type used as based type for Remiders and Statements History types. type: object properties: reportName: description: Report Name. type: string minLength: 0 maxLength: 2000 reportFileName: description: Report file name when exists to allow report re-printing. type: string minLength: 0 maxLength: 2000 dateSent: description: The Reminder Letter name which is to be used for this Reminder based on the setup on the Account Type. type: string format: date maxLength: 8 age: description: The minimum age(days) of the invoices to be included in the Reminder type: integer historyExists: description: Indicates that reminders history exists. type: boolean lastStatementInfo: description: Report History Type used as based type for Remiders and Statements History types. type: object properties: reportName: description: Report Name. type: string minLength: 0 maxLength: 2000 reportFileName: description: Report file name when exists to allow report re-printing. type: string minLength: 0 maxLength: 2000 dateSent: description: The Reminder Letter name which is to be used for this Reminder based on the setup on the Account Type. type: string format: date maxLength: 8 statementNo: description: When using Statement Numbering, a unique number is associated to the Statement. type: integer historyExists: description: Indicates that statement history exists. type: boolean notes: description: The Note details attached to the Account. type: array maxItems: 4000 items: $ref: '#/components/schemas/commentInfoType' traces: description: The Trace details attached to the Account. type: array maxItems: 4000 items: $ref: '#/components/schemas/traceType' fixedCharges: description: Fixed charges attached to this AR Account. $ref: '#/components/schemas/fixedChargesType' accountIndicators: description: Indicators of additional information attached to the Account. $ref: '#/components/schemas/indicatorsType' agingInfo: description: The Aging balance information for this account, by Aging Buckets. $ref: '#/components/schemas/aRAgingInfoType' yearViewInfo: description: The Year View balance information for this account. $ref: '#/components/schemas/aRYearViewInfoType' invoices: description: List of all Invoices. $ref: '#/components/schemas/aRInvoicesType' payments: description: List of all Payments made. $ref: '#/components/schemas/aRPaymentsType' summary: description: The Summary Information of the Invoices for the Account. $ref: '#/components/schemas/aRBalanceType' status: description: The status of the account. $ref: '#/components/schemas/aRAccountStatusType' batchStatement: description: Include In Batch Statement type: boolean printFoliosWithStatement: description: Indicates if associated folios should be printed by default with the statement. type: boolean emailStatementsReminders: description: Indicates if the Account has opted to send the statements and reminders to the Account email address by default. type: boolean searchMatches: description: Super Search matching terms. $ref: '#/components/schemas/searchMatchesType' primary: description: Indicates if this Account is the Primary Account for this Guest/Company. type: boolean type: description: The type of Account. type: string minLength: 0 maxLength: 20 accountTypeDescription: description: The description of the Account Type. type: string minLength: 0 maxLength: 2000 permanent: description: Indicates if this is a Permanent Account. Permanent Accounts cannot be deleted. type: boolean hotelInterfaceType: type: object properties: interfaceId: description: Unique DB internal number of a Hotel Interface record. $ref: '#/components/schemas/uniqueID_Type' hotelId: description: Hotel Code type: string minLength: 0 maxLength: 20 interfaceName: description: Name of the Hotel Interface type: string minLength: 0 maxLength: 40 interfaceType: description: Three letter code for each interface that identifies the interface. $ref: '#/components/schemas/hotelInterfaceTypeType' logo: description: Hotel Interface Logo. On the database, this is also referred as DBF Logo. This is a three letter code followed by an underscore(_). This tells us which DBF files and log files with the prefix that IFC7 is going to create. type: string minLength: 0 maxLength: 20 machineName: description: Unique machine name of the running IFC. type: string minLength: 0 maxLength: 80 status: description: The current status of the IFC. $ref: '#/components/schemas/hotelInterfaceStatusType' activeFlag: description: Indicator if the Hotel Interface is active or not. This is different from the Interface Status, which is either STOPPED or RUNNING. type: boolean cardProcessingType: type: string enum: - Eft - Manual authorizationConfigRulesInfo: type: object properties: authorizationConfigRulesType: description: List of authorization configuration rule type. $ref: '#/components/schemas/authorizationConfigRulesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' cashierType: type: object description: Cashiers Information. properties: cashierId: description: Numeric code for cashier ID. type: number currencyCode: description: The currency code used by the hotel that the cashier belongs to. type: string minLength: 0 maxLength: 20 name: description: Name assigned to the cashier. type: string minLength: 0 maxLength: 2000 reservedResort: description: Resort where cashier ID can be used to log in. type: string minLength: 0 maxLength: 20 attachedUser: description: User(s) assigned to the cashier. type: string minLength: 0 maxLength: 40 cashierType: description: Cashier / Interface Cashier / LDAP Template options are provided. $ref: '#/components/schemas/cashierTypeType' startingAmount: description: The Starting Amount in the Cashier drawer. type: number floatOverShort: description: Selected if the cashier is allowed to drop below or above the required drop amount. type: boolean usageInfo: description: Information about how the cashier is used. type: object properties: maximumDailyUses: description: The Maximum Daily Uses for the cashier. type: integer history: description: Statistics about the use of the cashier. type: object properties: lastOpened: description: The date that the cashier last opened. type: string format: date maxLength: 8 timesOpened: description: The number of times the cashier has opened their account today. type: integer kiosk: description: Indicator that this cashier is the one to be used by Kiosk Partner to carry out postings and payments for the guest. type: boolean inactive: description: Indicator that tells whether the cashier is active or not. type: boolean open: description: Indicator that tells whether the cashier is open or not. type: boolean appUsers: description: List of application users associated with the cashier type: array maxItems: 4000 items: $ref: '#/components/schemas/applicationUserType' managedBy: $ref: '#/components/schemas/managedByOptions' controlSequenceCodeType: type: string description: Indicates control sequences used for bills. Eg. CREDIT_BILL, FATTURA etc. enum: - AcknowledgeReceipt - Statement - Folio - OfficialReceipt - Bill - ARInvoice - SupportingDocument - TaxRegNo - InternalPOSAccount - InternalPOSAccountCredit - ARPayment - FiscalProformaFolio - FiscalInformationFolio aRPaymentsType: type: array description: A collection of AR Payments. maxItems: 4000 items: $ref: '#/components/schemas/aRPaymentType' fiscalYearType: type: object properties: hotelId: description: Resort for which the Year is defined. type: string minLength: 0 maxLength: 20 yearId: description: Unique id of the Year. type: number year: description: Number of the Year. type: number description: description: Description of the Year. type: string minLength: 0 maxLength: 100 yearType: description: Type of the Year. $ref: '#/components/schemas/yearTypeType' startDate: description: Start Date of the Year. type: string format: date maxLength: 8 endDate: description: End Date of the Year. type: string format: date maxLength: 8 managedBy: $ref: '#/components/schemas/managedByOptions' description: Fiscal Year Type aRYearViewInfoType: type: object description: Information regarding Year View balances for an account. properties: totalOutstanding: description: The total debit and credit balance of the account. $ref: '#/components/schemas/aRBalanceType' yearView: description: The debit and credit balance per account. type: array maxItems: 4000 items: $ref: '#/components/schemas/aRYearViewType' generateCalcRuleType: type: object description: Defines the Calculation Rule for the generate. properties: percentage: description: Defines percentage rule for generates. $ref: '#/components/schemas/percentageGenerateType' flatAmount: description: Defines Flat Amount rule for generates. $ref: '#/components/schemas/flatAmtGenerateType' uDF: description: Defines User Defined Function to calculate generates. type: string minLength: 0 maxLength: 2000 uDFFunctionName: description: The function name of the User Defined Function used to calculate generates. type: string minLength: 0 maxLength: 2000 uDFFunctionArguments: description: The function argument name-value combination accepted by the User Defined Function. $ref: '#/components/schemas/functionArgumentsType' taxTypeBased: description: Defines TaxType Based Generat Calculation. $ref: '#/components/schemas/taxTypesGenerateType' roundingMethod: description: Defines the rounding method to be used. $ref: '#/components/schemas/generateRoundingMethodType' posting: description: Advance Generates posting rules, this is only applicable when Advance Generates parameter is active. $ref: '#/components/schemas/generatePostingRuleType' startDate: description: Date when this schedule will be effective. type: string format: date maxLength: 8 endDate: description: Date until when this schedule will be effective. type: string format: date maxLength: 8 transactionGroupType: type: object description: Transaction Group configuration information. properties: description: description: Description of the Transaction Group. type: string minLength: 0 maxLength: 2000 sequence: description: Display sequence for the code type. type: integer code: description: Transaction Group Configuration Code. type: string minLength: 0 maxLength: 20 type: description: Transaction type to which the corresponding transaction group belongs. $ref: '#/components/schemas/cashieringTransactionTypeType' managedBy: $ref: '#/components/schemas/managedByOptions' housekeepingTaskCodeType: type: object description: Information related to a Task Code. Task Codes are used to generate task sheets in Rooms Management. properties: description: description: Description of the Task Code. type: string minLength: 0 maxLength: 80 instructions: description: Instructions for this Task Code. type: string minLength: 0 maxLength: 2000 facilityDepartureTask: description: Indicates if this task code is the default departure task for Facility Tasks. This requires type: boolean linenChange: description: Indicates if a linen change is necessary. type: boolean hotelId: description: Property where this task code is configured. type: string minLength: 0 maxLength: 20 code: description: The Code for the task. type: string minLength: 0 maxLength: 20 sequence: description: Ordering sequence for display. type: integer folioCopyLegendInfoType: type: object properties: folioCopyLegendInfo: description: Detailed folio copy legend information $ref: '#/components/schemas/folioCopyLegendType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' resAccompanyGuestListType: type: array description: Collection of accompany guests maxItems: 4000 items: $ref: '#/components/schemas/resAccompanyGuestInfoType' generatesSetupType: type: object description: Defines the Generates Setup and its Calculation Rules. properties: addBaseAmtTo: description: Defines the buckets the base or posting amount will be added to. $ref: '#/components/schemas/generateCalculationBucketsType' generates: description: Defines the Generates and its Calculation Rules. $ref: '#/components/schemas/generatesType' resSharedGuestListType: type: array description: Collection of shared guest reservations. maxItems: 4000 items: $ref: '#/components/schemas/resSharedGuestInfoType' taxTypesType: type: array description: Holds Tax Type details. maxItems: 4000 items: $ref: '#/components/schemas/taxTypeType' facilityTaskType: type: object description: Information regarding facility task on a reservation. properties: task: description: The Task Code. $ref: '#/components/schemas/housekeepingTaskCodeType' supplies: description: Supplies associated with the task. $ref: '#/components/schemas/facilityCodesType' date: description: The Date on which the task is applicable. type: string format: date maxLength: 8 codeDescriptionType: type: object description: This contains a generic code and description information. properties: code: description: Code. type: string minLength: 0 maxLength: 20 description: description: description. type: string minLength: 0 maxLength: 2000 fiscalResponseType: type: object description: Provides information which is used for fiscal response processing. properties: folioSeqId: description: Fiscal Folio sequence ID stored in queue table. type: integer retryFiscalPrinting: description: Flag to do the retrieval process of fiscal printing or not. type: boolean budgetForecastMarketInfoType: type: object description: Budget Forecast information for budget segment codes. properties: marketCodeInformation: description: Budget Forecast information for segment. type: array maxItems: 4000 items: $ref: '#/components/schemas/marketCodeInformationType' marketCodeTotalInformation: description: Budget Forecast totals information for segment. $ref: '#/components/schemas/marketCodeTotalInformationType' cardPaymentTrxSetupType: type: object description: Card Payment Transaction Code configuration details. properties: processingType: description: Type of processing for the payment. $ref: '#/components/schemas/cardPaymentProcessingType' accountReceivable: description: AR account information to route the payments. $ref: '#/components/schemas/aRAccountRefType' commission: description: Commission percentage on the payment. type: number minimum: 0 maximum: 100 displayCode: description: Display code of the payment Transaction Code. type: string minLength: 0 maxLength: 8 interfaceCode: description: Card Payment's internal interface code. type: string minLength: 0 maxLength: 20 sourceCodeInfoType: type: object properties: sourceCode: type: string minLength: 0 maxLength: 20 hotelId: type: string minLength: 0 maxLength: 20 sourceGroup: type: string minLength: 0 maxLength: 20 description: type: string minLength: 0 maxLength: 2000 surnameType: type: string description: Family name, last name. minLength: 0 maxLength: 40 authorizationConfigRulesType: type: array description: List of AuthorizationRuleType. maxItems: 4000 items: $ref: '#/components/schemas/authorizationConfigRuleType' generateRoundingMethodType: type: string description: '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 which can be specified are: UP, DOWN or NONE.' enum: - Up - Down - None hotelTransactionCodesType: type: array description: Transaction Code configuration details. maxItems: 4000 items: $ref: '#/components/schemas/hotelTransactionCodeType' cashiersType: type: array description: Details about a cashier. maxItems: 4000 items: $ref: '#/components/schemas/cashierType' exceptionDetailType: title: Error Detail description: Complex type that contains error details for a REST call. type: object properties: type: type: string description: Absolute URI [RFC3986] that identifies the problem type. When dereferenced, it SHOULD provide a human-readable summary of the problem (for example, using HTML). title: type: string description: Short, human-readable summary of the problem. The summary SHOULD NOT change for subsequent occurrences of the problem, except for purposes of localization. status: type: integer description: HTTP status code for this occurrence of the problem, set by the origin server. detail: type: string description: Human-readable description specific to this occurrence of the problem. instance: type: string description: Absolute URI that identifies the specific occurrence of the problem. It may or may not provide additional information if dereferenced. o:errorCode: type: string description: Application error code, which is different from HTTP error code. o:errorPath: type: string description: Path to the problem at the resource or property level. o:errorDetails: description: Details of the error message, consisting of a hierarchical tree structure. type: array items: $ref: '#/components/schemas/errorInstance' links: $ref: '#/components/schemas/links' required: - type - title aRYearViewType: type: object description: Year information for an Year View. properties: dateRange: description: The period start and end date. $ref: '#/components/schemas/dateRangeType' balanceInfo: description: The balance amounts for this date range. Contains the Debit Balance, Credit Balance and the Total Balance. $ref: '#/components/schemas/aRBalanceType' runningTotal: description: The running total balance for the date range. $ref: '#/components/schemas/currencyAmountType' searchMatchType: type: object description: Search match indicating attribute and the matching value. properties: attribute: description: Search match attribute. type: string minLength: 0 maxLength: 2000 value: description: Search match value. type: string minLength: 0 maxLength: 2000 hotelTransactionSubgroupType: type: object description: Transaction Subgroup configuration Information. properties: description: description: Description of the Transaction Subgroup. type: string minLength: 0 maxLength: 2000 sequence: description: Display sequence for the code type. type: integer groupDescription: description: Description of the Transaction Group. type: string minLength: 0 maxLength: 2000 code: description: Transaction Subroup Configuration Code. type: string minLength: 0 maxLength: 20 group: description: Transaction Group Configuration Code. type: string minLength: 0 maxLength: 20 newGroup: description: Use this attribute to update the existing group during change operation. type: string minLength: 0 maxLength: 20 type: description: Transaction type to which the corresponding transaction group belongs. This is an information only attribute. $ref: '#/components/schemas/cashieringTransactionTypeType' generatesSetup: description: Transaction subgroup's generates setup. $ref: '#/components/schemas/generatesSetupType' generatesAvailable: description: Flag to determine whether generates are available or not type: boolean hotelId: description: Hotel Code where the Transaction Subgroup is configured. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' fiscalPartnerCodeListType: type: array maxItems: 4000 items: $ref: '#/components/schemas/fiscalPartnerCodeType' foreignCurrencyType: type: object description: Provides information about the Foreign Currency Code. properties: currencyCode: description: Code of the Foreign Currency type: string minLength: 0 maxLength: 20 description: description: Description of the Foreign Currency Code type: string minLength: 0 maxLength: 80 decimals: description: Number of Decimal places defined for the Foreign Currency Code type: integer symbol: description: Symbol defined for the Currency type: string minLength: 0 maxLength: 10 sellCurrency: description: Indicates if the Currency is available for selling type: boolean inactive: description: Indicates if the Foreign Currency Code is inactive type: boolean displaySequence: description: Display Sequence type: number currencyLimits: description: Provides information about various limits on the Currency Code type: array maxItems: 6 items: $ref: '#/components/schemas/currencyLimitType' managedBy: $ref: '#/components/schemas/managedByOptions' compTypesType: type: array description: List of Comp Types. maxItems: 4000 items: $ref: '#/components/schemas/compTypeType' cardValidationRuleTypeType: type: string description: Defines rules to be used for card validation. enum: - Mod7 - Mod10 - Udef - Novalid groupArrangementCodesCopy: type: object properties: groupArrangementCode: type: array description: List of the group arrangement codes to be copied. items: $ref: '#/components/schemas/copyConfigurationCodeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' trxOwnershipType: type: string description: Protected by the Property level enum: - Corporate - Property templateTransactionSubgroupIDType: type: object description: Information that uniquely identifies template transaction subgroups properties: subgroup: description: Template transaction subgroup configuration code type: string minLength: 0 maxLength: 20 group: description: Template transaction group configuration code type: string minLength: 0 maxLength: 20 folioCopyLegendsType: type: array description: Details about folio copy legends. maxItems: 4000 items: $ref: '#/components/schemas/folioCopyLegendType' transactionGroupsCopy: type: object properties: transactionGroups: type: array description: List of the transaction groups to be copied. items: $ref: '#/components/schemas/copyConfigurationCodeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' currencyExchangeServiceTaxType: type: object description: Currency exchange service tax identification details properties: hotel: description: Property associated with currency exchange service tax type: string minLength: 0 maxLength: 20 code: description: Currency exchange service tax code type: string minLength: 0 maxLength: 20 amountFrom: description: Starting value of exchange equivalent range type: number amountTo: description: End value of exchange equivalent range type: number percentage: description: Percentage of local currency type: number minServiceTax: description: Minimum service tax to be collected type: number maxServiceTax: description: Maximimum service tax to be collected type: number baseAmount: description: Base tax basis of local currency. This is normally configured to the resulting tax basis of the previous tax slab range. type: number managedBy: $ref: '#/components/schemas/managedByOptions' budgetInfoDeleteType: type: string description: Daily information. enum: - Monthly - Daily hotelTransactionCodeType: type: object description: Transaction Code configuration details. properties: classification: description: Transaction Code classification details. $ref: '#/components/schemas/trxCodeClassificationType' description: description: Transaction Code descriptions. $ref: '#/components/schemas/translationTextType2000' paymentSetup: description: Payment Transaction Code configuration details. $ref: '#/components/schemas/paymentTrxSetupType' trxSetup: description: Transaction code setup/config details. $ref: '#/components/schemas/trxSetupType' adjustmentCode: description: Transaction code to be used to make adjustments on the posting made using this transaction code. type: string minLength: 0 maxLength: 20 otaTaxType: description: Open Travel Alliance(OTA) tax type for the given transaction code. type: string minLength: 0 maxLength: 20 transactionAdjustments: description: Combination of Adjustment Reason Code and Transaction Adjustment Code. type: array maxItems: 4000 items: $ref: '#/components/schemas/transactionAdjustmentType' serviceRecoveryAdjustmentCode: description: Transaction code to be used to make service recovery adjustments on the posting made using this transaction code. type: string minLength: 0 maxLength: 20 amounts: description: Default Amounts for the Transaction Codes. $ref: '#/components/schemas/trxCodeAmountsType' generatesSetup: description: Transaction code's generates setup. $ref: '#/components/schemas/generatesSetupType' gLMapping: description: Gl mapping for transaction codes specific to hotels like Hilton. $ref: '#/components/schemas/gLMappingType' associatedTransactionCodes: description: Code and description of the standard transaction code associated to this comp transaction code. type: array maxItems: 4000 items: $ref: '#/components/schemas/codeDescriptionType' allowServiceRecovery: description: Flag to identify if this transaction code already used as service recovery adjustment code. type: boolean universalProductCode: description: Unique Universal product code of the article. type: string minLength: 0 maxLength: 20 mappingCodes: description: Mapping code and value attached to Transaction Code. type: array maxItems: 4000 items: $ref: '#/components/schemas/exportMappingLinkedCodeType' code: description: Unique Transaction Code. type: string minLength: 0 maxLength: 20 compTransaction: description: If true indicates this transaction codes is for Comp Accounting. type: boolean printTrxReceipt: type: boolean hotelId: description: Hotel's Transaction Code configuration detail. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' revenueBucketTypes: type: object properties: revenueBucketTypes: description: Collection of Revenue Bucket Types configurations. $ref: '#/components/schemas/revenueBucketTypesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' generateLevelType: type: string description: Defines the level from which the generates was created. enum: - Group - SubGroup - TransactionCode traceType: type: object properties: timeInfo: description: Date of the trace. $ref: '#/components/schemas/traceTimeInfoType' reservationId: description: Reservation ID of the reservation for which the traces are to be retrieved. $ref: '#/components/schemas/reservationId' departmentId: description: Indicates the Department code. type: string minLength: 0 maxLength: 20 traceText: description: The information this trace contains. type: string resolveInfo: description: Information regarding the status of the trace $ref: '#/components/schemas/traceResolveType' url: description: URL that identifies the location associated with the record identified by the UniqueID. type: string type: description: A reference to the type of object defined by the UniqueID element. type: string minLength: 0 maxLength: 20 instance: description: The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated. type: string minLength: 0 maxLength: 80 idContext: description: Used to identify the source of the identifier (e.g., IATA, ABTA). type: string minLength: 0 maxLength: 80 id: description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. type: string minLength: 0 maxLength: 80 idExtension: description: Additional identifying value assigned by the creating system. type: integer createDateTime: description: Time stamp of the creation. type: string format: date-time creatorId: description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation. type: string minLength: 0 maxLength: 200 lastModifyDateTime: description: Time stamp of last modification. type: string format: date-time lastModifierId: description: Identifies the last software system or person to modify a record. type: string minLength: 0 maxLength: 200 purgeDate: description: Date an item will be purged from a database (e.g., from a live database to an archive). type: string format: date maxLength: 8 compAuthorizerHeaderType: type: object description: Detail information related to comp authorizers. properties: creditLimit: description: Credit limit associated for the authorizer. type: integer occurenceLimit: description: Credit limit already used up for the authorizer. type: integer compAuthorizerDetails: description: Comp authorizer details information. type: array maxItems: 4000 items: $ref: '#/components/schemas/compAuthorizerDetailType' operaVersionNumberType: type: string description: Current Opera Version Number minLength: 0 maxLength: 40 currencyExchangeServiceTaxesType: type: array description: List of currency exchange service taxes maxItems: 4000 items: $ref: '#/components/schemas/currencyExchangeServiceTaxType' budgetForecastCateringInfoBaseType: type: object description: Budget Forecast information for budget Catering codes. properties: cateringCodeInformation: description: Budget Forecast information for Catering segment code . type: array maxItems: 4000 items: $ref: '#/components/schemas/cateringCodeInformationBaseType' revenue: description: Flag to indicate if revenue information has to be included. type: boolean covers: description: Flag to indicate if covers information has to be included. type: boolean postingBucket: type: object description: Holds the amount that will be stored in each bucket after posting. properties: bucket1: description: Holds amount for sub-total 1. type: number bucket2: description: Holds amount for sub-total 2. type: number bucket3: description: Holds amount for sub-total 3. type: number addressType: type: object description: Provides address information. properties: isValidated: description: Indicator to define if the Address is validated by the Address Validation System. type: boolean addressLine: description: When the address is unformatted (FormattedInd="false") these lines will contain free form address details. When the address is formatted and street number and street name must be sent independently, the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence. type: array maxItems: 4 items: type: string minLength: 0 maxLength: 80 cityName: description: City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address). type: string minLength: 0 maxLength: 40 postalCode: description: Post Office Code number. type: string minLength: 0 maxLength: 15 cityExtension: description: Post Office City Extension Code number. City Extension mainly used for UK addresses. type: string minLength: 0 maxLength: 20 county: description: County or District Name (e.g., Fairfax). This is read only. type: string minLength: 0 maxLength: 20 state: description: State or Province name (e.g., Texas). type: string minLength: 0 maxLength: 20 country: description: Country name (e.g., Ireland). $ref: '#/components/schemas/countryNameType' language: description: Language identification. type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' type: description: Defines the type of address (e.g. home, business, other). type: string minLength: 0 maxLength: 20 typeDescription: description: Describes the type code type: string primaryInd: description: When true, indicates a primary information. type: boolean updateReservations: description: Indicates whether to update the reservations or not. If true and the address is primary, then all associated active reservations will be updated with the new primary address. type: boolean barCode: description: The postal barcode for the address. type: string minLength: 0 maxLength: 100 createDateTime: description: Time stamp of the creation. type: string format: date-time creatorId: description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation. type: string minLength: 0 maxLength: 200 lastModifyDateTime: description: Time stamp of last modification. type: string format: date-time lastModifierId: description: Identifies the last software system or person to modify a record. type: string minLength: 0 maxLength: 200 purgeDate: description: Date an item will be purged from a database (e.g., from a live database to an archive). type: string format: date maxLength: 8 noShowPostingRuleEditType: type: object description: Provides information about No Show Posting Rule Configuration. properties: reservationType: description: Type of the reservation. type: string minLength: 0 maxLength: 20 sourceCode: description: Source code of the reservation. type: string minLength: 0 maxLength: 20 postingRule: description: Posting Rule to be selected. $ref: '#/components/schemas/postingRuleType' hotelId: description: Indicates for which hotel this posting rule apply to. type: string minLength: 0 maxLength: 20 newRule: description: New rule values for reservation type, source code and posting rule. $ref: '#/components/schemas/noShowPostingRuleType' managedBy: $ref: '#/components/schemas/managedByOptions' revenueTypeMappingType: type: object description: Type used for Revenue Type mapping. properties: revenueTypeMappingId: description: Unique Identifier for Revenue Type Mapping. $ref: '#/components/schemas/uniqueID_Type' hotelId: description: Hotel Code to which the Revenue Type Mapping belongs to. type: string minLength: 0 maxLength: 20 revenueType: description: Provides information about the Revenue Type. type: string minLength: 0 maxLength: 20 eventType: description: Provides information about the Event Type. type: string minLength: 0 maxLength: 20 space: description: Provides information about the Space/Location for the Revenue Type. type: string minLength: 0 maxLength: 20 transactionCode: description: Transaction code for the Revenue Type. type: string minLength: 0 maxLength: 20 cateringOnly: description: Flag to indicate if the Revenue Type is used for catering or event only. $ref: '#/components/schemas/cateringOnlyType' serviceCharge: description: Service Charge for the Revenue Type. type: number minimum: 0 maximum: 100 serviceChargeTrxCode: description: Service Charge for the Revenue Type. type: string minLength: 0 maxLength: 20 serviceChargeCalulationMethod: description: Service Charge for the Revenue Type. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' changeFiscalCommands: type: object description: Request object to edit Fiscal Commands. properties: fiscalPartners: description: Change existing Fiscal Commands. $ref: '#/components/schemas/fiscalCommandsType' warnings: $ref: '#/components/schemas/warningsType' fiscalPartnersType: type: array description: Details of Fiscal Partners. maxItems: 4000 items: $ref: '#/components/schemas/fiscalPartnerType' expenseArrangementCodesType: type: array description: Details for expense arrangement code along with associated transaction codes. maxItems: 4000 items: $ref: '#/components/schemas/expenseArrangementCodeType' countryNameType: type: object description: Code for a country or a nationality. properties: value: type: string description: Used for Character Strings, length 0 to 200. minLength: 0 maxLength: 200 code: description: Code for a country or a nationality. type: string minLength: 0 maxLength: 20 fiscalPeriodType: type: object properties: hotelId: description: Resort for which the Period is defined. type: string minLength: 0 maxLength: 20 yearId: description: Id of the Year. type: number startDate: description: Start Date of the Period type: string format: date maxLength: 8 year: description: Year for the current Period. type: number code: description: Code of the current Period. type: string minLength: 0 maxLength: 20 description: description: Description of the Period. type: string minLength: 0 maxLength: 100 periodType: description: Type of the Period. $ref: '#/components/schemas/yearTypeType' endDate: description: End Date of the Period. type: string format: date maxLength: 8 managedBy: $ref: '#/components/schemas/managedByOptions' description: Fiscal Period Type revenueBucketCodesType: type: array description: Details for Revenue Bucket codes along with associated transaction codes. maxItems: 4000 items: $ref: '#/components/schemas/revenueBucketCodeType' errorInstance: title: Error Instance Details description: Complex type that contains error instance details for a REST call. type: object properties: type: type: string description: Absolute URI [RFC3986] that identifies the problem type. When dereferenced, it SHOULD provide a human-readable summary of the problem (for example, using HTML). title: type: string description: Short, human-readable summary of the problem. The summary SHOULD NOT change for subsequent occurrences of the problem, except for purposes of localization. status: type: integer description: HTTP status code for this occurrence of the problem, set by the origin server. detail: type: string description: Human-readable description specific to this occurrence of the problem. instance: type: string description: Absolute URI that identifies the specific occurrence of the problem. It may or may not provide additional information if dereferenced. o:errorCode: type: string description: Application error code, which is different from HTTP error code. o:errorPath: type: string description: Path to the problem at the resource or property level. required: - type - title templateTransactionGroups: type: object properties: transactionGroups: description: Collection of template transaction groups. $ref: '#/components/schemas/templateTransactionGroupsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' fiscalFolioParameters: type: object properties: fiscalFolioParameters: description: Collection of Fiscal Folio Parameter configurations. $ref: '#/components/schemas/fiscalFolioParametersType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' copyRevenueTypeMappingListType: type: object description: Type used for Revenue Type mapping. properties: revenueTypeMappingId: description: Unique Identifier for Revenue Type Mapping. $ref: '#/components/schemas/uniqueID_Type' hotelId: description: Hotel Code to which the Revenue Type Mapping belongs to. type: string minLength: 0 maxLength: 20 revenueType: description: Provides information about the Revenue Type. type: string minLength: 0 maxLength: 20 eventType: description: Provides information about the Event Type. type: string minLength: 0 maxLength: 20 space: description: Provides information about the Space/Location for the Revenue Type. type: string minLength: 0 maxLength: 20 transactionCode: description: Transaction code for the Revenue Type. type: string minLength: 0 maxLength: 20 cateringOnly: description: Flag to indicate if the Revenue Type is used for catering or event only. $ref: '#/components/schemas/cateringOnlyType' serviceCharge: description: Service Charge for the Revenue Type. type: number minimum: 0 maximum: 100 serviceChargeTrxCode: description: Service Charge for the Revenue Type. type: string minLength: 0 maxLength: 20 serviceChargeCalulationMethod: description: Service Charge for the Revenue Type. type: string minLength: 0 maxLength: 20 isEventType: description: This flag will notify the service that transactional postings will not be returned. type: boolean isSpace: description: This flag will notify the service that transactional postings will not be returned. type: boolean isCateringOnly: description: This flag will notify the service that transactional postings will not be returned. type: boolean eventList: description: List of Event Types. $ref: '#/components/schemas/codeListType' spaceList: description: List of the Space/Location. $ref: '#/components/schemas/codeListType' resExpectedTimesType: type: object description: Holds the Arrival and Departure Time Information properties: reservationExpectedArrivalTime: description: Arrival Time type: string format: date-time reservationExpectedDepartureTime: description: Departure Time type: string format: date-time dateRangeType: type: object description: Date Range with Start and End dates. properties: start: description: The starting value of the date range. type: string format: date maxLength: 8 end: description: The ending value of the date range. type: string format: date maxLength: 8 aRAccountStatusType: type: object description: Type for the Account Status. Status can be restricted and a message/description added to the Account. properties: restriction: description: The Restriction Code added on the Account. This is available when the functionality for adding restriction codes is ON. type: string minLength: 0 maxLength: 20 description: description: User defined status message on the Account. type: string minLength: 0 maxLength: 2000 restricted: description: Flag to indicate if the Account is restricted. type: boolean adjustmentCodes: type: object properties: adjustmentCodes: description: Collection of Adjustment Code configurations. $ref: '#/components/schemas/adjustmentCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' monthlyCateringInfoType: type: object description: Holds monthly Catering summary information properties: month: description: Month number type: integer revenue: description: Revenue total for a month. type: number covers: description: No of Covers for a month. type: integer billingPrivilegesType: type: object description: This stores the information for Bed Tax Reporting. Mainly used in Maldives. properties: postingRestriction: description: Flag used by interface program during check in. type: boolean preStayCharging: description: Indicates if the reservation has charging privileges before arrival. type: boolean postStayCharging: description: Indicates if the reservation has charging privileges after checkout. type: boolean folioCloseDate: description: Date when folio was closed. This works with PostStayCharging flag. type: string format: date maxLength: 8 scheduledCheckout: description: Indicates if the guest is scheduled for automatic check out. type: boolean scheduledCheckoutTime: description: Time of automatic check out if guest is schedule for automatic check out. type: string format: date maxLength: 8 directBillAuthorized: description: If Direct bill is authorized this will hold User ID who authorized it. type: boolean videoCheckout: description: Indicates if the guest can do video checkout type: boolean allowAutoCheckin: description: Indicated if a new reservation should be created and automatically checked in whenever the room is checked out. Available for pseudo room types only. type: boolean autoSettlement: description: Indicates if the is a candidate for auto folio settlement. type: boolean autoSettlementType: description: The folio settlement type for auto folio settlement. type: string minLength: 0 maxLength: 40 autoSettlementFreq: description: The interval of days between each auto folio settlement. type: integer creditLimitAutoPay: description: Indicates if the reservation will be included in the Automatic Credit Limit Overages process and also be listed in the Credit Limit Overages screen results. type: boolean taxTypeGenerateScheduleType: type: object description: Defines the Calculation Rule for the Tax Type for a specific date schedule properties: rule: description: Defines percentage rule for generates. $ref: '#/components/schemas/taxTypeCalcRuleType' startDate: description: Date when this schedule will be effective. type: string format: date maxLength: 8 templateTransactionCodeType: type: object description: Transaction Code configuration details. properties: classification: description: Transaction Code classification details. $ref: '#/components/schemas/trxCodeClassificationType' description: description: Transaction Code descriptions. $ref: '#/components/schemas/translationTextType2000' paymentSetup: description: Payment Transaction Code configuration details. $ref: '#/components/schemas/paymentTrxSetupType' trxSetup: description: Transaction code setup/config details. $ref: '#/components/schemas/trxSetupType' adjustmentCode: description: Transaction code to be used to make adjustments on the posting made using this transaction code. type: string minLength: 0 maxLength: 20 otaTaxType: description: Open Travel Alliance(OTA) tax type for the given transaction code. type: string minLength: 0 maxLength: 20 transactionAdjustments: description: Combination of Adjustment Reason Code and Transaction Adjustment Code. type: array maxItems: 4000 items: $ref: '#/components/schemas/transactionAdjustmentType' serviceRecoveryAdjustmentCode: description: Transaction code to be used to make service recovery adjustments on the posting made using this transaction code. type: string minLength: 0 maxLength: 20 amounts: description: Default Amounts for the Transaction Codes. $ref: '#/components/schemas/trxCodeAmountsType' generatesSetup: description: Transaction code's generates setup. $ref: '#/components/schemas/generatesSetupType' gLMapping: description: Gl mapping for transaction codes specific to hotels like Hilton. $ref: '#/components/schemas/gLMappingType' associatedTransactionCodes: description: Code and description of the standard transaction code associated to this comp transaction code. type: array maxItems: 4000 items: $ref: '#/components/schemas/codeDescriptionType' allowServiceRecovery: description: Flag to identify if this transaction code already used as service recovery adjustment code. type: boolean universalProductCode: description: Unique Universal product code of the article. type: string minLength: 0 maxLength: 20 mappingCodes: description: Mapping code and value attached to Transaction Code. type: array maxItems: 4000 items: $ref: '#/components/schemas/exportMappingLinkedCodeType' code: description: Unique Transaction Code. type: string minLength: 0 maxLength: 20 compTransaction: description: If true indicates this transaction codes is for Comp Accounting. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' taxBracketAmountType: type: object description: Details used for storing information about a tax bracket amount. properties: startAmount: description: Bracket Start amount for this tax. If the net amount falls within the Bracket Start and End amount, the tax defined is applied as the tax amount. $ref: '#/components/schemas/currencyAmountType' endAmount: description: Bracket End amount for this tax. If the net amount falls within the Bracket Start and End amount, the tax defined is applied as the tax amount. $ref: '#/components/schemas/currencyAmountType' taxAmount: description: Tax amount which should be applied. $ref: '#/components/schemas/currencyAmountType' reservationTaxTypeInfo: type: object description: Provides information about the Tax Type. properties: hotelId: description: Code of the Hotel. type: string minLength: 0 maxLength: 20 code: description: Code of the Tax Type. type: string minLength: 0 maxLength: 20 description: description: Description of the Tax Type. type: string minLength: 0 maxLength: 2000 collectingAgentTax: description: A boolean flag for Collecting Agent Tax type: boolean printAutoAdjust: description: Print auto adjust information for this tax type on the tax exempt report. type: boolean reportExemptDays: description: Number of days after which the guest will be tax exempt. Only used for tax exempt report. type: integer reportTaxPercentage: description: Tax percentage. Only used for tax exempt report. type: number minimum: 0 maximum: 100 minimumLengthOfStay: description: Minimun Length of Stay. type: integer taxExemptNo: description: Tax exempt number on the profile. type: string minLength: 0 maxLength: 20 revenueBucketCodesCopy: type: object properties: revenueBucketCodes: description: List of the Revenue Bucket Codes to be copied to hotel code(s) $ref: '#/components/schemas/configCopyRevenueBucketCodeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' budgetForecastToDelete: type: object properties: segmentCodeInformation: description: Search criteria for budget forecast information. $ref: '#/components/schemas/deleteSegmentCodeBudgetInformationType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' hotelTransactionGroupType: type: object description: Transaction Group configuration information. properties: description: description: Description of the Transaction Group. type: string minLength: 0 maxLength: 2000 sequence: description: Display sequence for the code type. type: integer code: description: Transaction Group Configuration Code. type: string minLength: 0 maxLength: 20 type: description: Transaction type to which the corresponding transaction group belongs. $ref: '#/components/schemas/cashieringTransactionTypeType' generatesSetup: description: Transaction group's generates setup. $ref: '#/components/schemas/generatesSetupType' generatesAvailable: description: Flag to determine whether generates are available or not type: boolean hotelId: description: Hotel Code where the Transaction Group is configured. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' currencyHandlingType: type: string description: Simple Type for Posting Limit Types. enum: - Local - Foreign groupArrangementCodes: type: object properties: groupArrangementCodes: description: Collection of group arrangement codes. $ref: '#/components/schemas/groupArrangementCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' customNumberConfigurationAreaType: type: string enum: - Folio - Receipt description: Receipt revenueNightsInfoType: type: object description: Revenue information for a segment code. Holds total and monthly revenue information. properties: totalRevenue: description: Total revenue for segment code. type: number totalNights: description: Total Nights for segment code. type: number monthlyRevenueInfo: description: Revenue information for each month for segment code. type: array maxItems: 12 items: $ref: '#/components/schemas/monthlyRevenueNightsInfoType' deleteSegmentCodeBudgetInformationType: type: object description: Holds segment and segment code information to delete. properties: marketCodeInformation: description: Market Segment code information to delete. $ref: '#/components/schemas/deleteSegmentCodeInfoType' rateCodeInformation: description: Rate Segment code information to delete. $ref: '#/components/schemas/deleteSegmentCodeInfoType' customCodeInformation: description: Custom Segment code information to delete. $ref: '#/components/schemas/deleteSegmentCodeInfoType' transactionCodeInformation: description: Transaction Segment code information to delete. $ref: '#/components/schemas/deleteSegmentCodeInfoType' cateringCodeInformation: description: Catering Segment code information to delete. $ref: '#/components/schemas/deleteSegmentCodeInfoType' hotelId: description: Opera Hotel code. type: string minLength: 0 maxLength: 20 year: description: Year of revenue. type: string minLength: 0 maxLength: 20 authorizerGroupType: type: object description: A representation of the information contained by a Authorizer Group. properties: description: description: Description of the Authorizer Group. type: string minLength: 0 maxLength: 2000 rateCode: description: Rate Code of the Authorizer Group. type: string minLength: 0 maxLength: 20 transactionLimits: description: Transactions information of the Authorizer Group. $ref: '#/components/schemas/authorizerTrxLimitsType' hotelId: description: Hotel Code to which the Authorizer Group belongs to. type: string minLength: 0 maxLength: 20 code: description: Authorizer Group code. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' paymentMethodsCopy: type: object properties: paymentMethods: type: array description: List of payment methods to be copied. items: $ref: '#/components/schemas/copyConfigurationCodeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' formattedTextTextType: type: object description: Provides text and indicates whether it is formatted or not. properties: value: type: string description: Property Value language: description: Language identification. type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' transactionCodeTypeType: type: string description: Other Charges Transaction. enum: - Lodging - FoodAndBeverage - Telephone - Minibar - Tax - NonRevenue - Others aRAgingInfoType: type: object description: Information regarding the aging balances for an account. properties: totalOutstanding: description: The total debit and credit balance of the account. $ref: '#/components/schemas/aRBalanceType' aging: description: The debit and credit balance per Aging bucket. type: array maxItems: 4000 items: $ref: '#/components/schemas/aRAgingType' operaVersion: type: object description: Response for Ping operation. properties: operaVersion: description: Opera version number. $ref: '#/components/schemas/operaVersionNumberType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' revenueTypeMappingList: type: object properties: revenueTypeMappingList: description: Collection of Revenue Type mapping configurations. $ref: '#/components/schemas/revenueTypeMappingListType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' numberDescriptions: type: object properties: numberDescriptions: description: Collection of Numbers and Descriptions $ref: '#/components/schemas/numberDescriptionsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' fiscalFolioParametersCopy: type: object description: Request object for copying Fiscal Folio Parameters to other hotel code(s). properties: fiscalFolioParameters: description: List of the Fiscal Folio Parameters to be copied to other hotel code(s). type: array items: $ref: '#/components/schemas/copyFiscalFolioParametersType' fiscalFolioParameter: description: Fiscal Folio Parameter Configurations to be copied. type: array items: $ref: '#/components/schemas/genericHotelCodeCodeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' authorizationRuleType: type: object description: Configured rule for computing the amount to authorize. properties: code: description: The authorization rule code. type: integer pattern: '[0-9]{1,9}' amount: description: The amount applicable to the authorization rule. $ref: '#/components/schemas/currencyAmountType' percent: description: A percentage value if the authorization rule is percentage based. type: number transactionDiversionRuleTypeType: type: string description: 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 reservation enum: - Vip - Membership taxBracketType: type: object description: This gives information for uniquely identifying a tax bracket detail. properties: hotelId: description: Hotel Code where tax bracket belongs to. type: string minLength: 0 maxLength: 20 taxPercentage: description: Tax Percentage for which this Tax Bracket applies. type: number description: description: Description of the Tax Bracket. $ref: '#/components/schemas/translationTextType2000' threshold: description: The threshold(max) amount for which Tax Brackets are defined for this percentage. type: number taxBracketAmounts: description: List of tax bracket amount details. $ref: '#/components/schemas/taxBracketAmountsType' turndownStatusType: type: string description: Simple type for turndown status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Required, Not Required and Completed. enum: - Required - NotRequired - Compeleted gLMappingType: type: object description: Gl mapping for transaction codes specific to hotels like Hilton. properties: itemId: description: Hilton Department Group Item Id type: string minLength: 0 maxLength: 40 departmentCode: description: Hilton Department Group Code type: string minLength: 0 maxLength: 20 accountCode: description: Hilton GL Account code Description type: string minLength: 0 maxLength: 20 accountDescription: description: Hilton GL Account code Description type: string minLength: 0 maxLength: 2000 currencyCode: description: Hilton GL Account Currency Code type: string minLength: 0 maxLength: 20 statCode: description: Hilton GL Account StatCode type: string minLength: 0 maxLength: 20 productCode: description: Hilton Product Code type: string minLength: 0 maxLength: 20 chargeCode: description: Hilton GL Charge Category Code type: string minLength: 0 maxLength: 20 accountingCategory: description: Hilton Account Category Code type: string minLength: 0 maxLength: 20 guestHousekeepingServiceRequestType: type: string description: Possible values for the Guest Service Status. enum: - DoNotDisturb - MakeUpRoom - NoStatusSelected bucketTypeType: type: string description: Fiscal Bucket Type. enum: - Default - Fiscal copyFiscalFolioParametersType: type: object description: Copy instructions for Fiscal Folio Parameters. properties: sourceHotelCode: description: Source hotel code from where Fiscal Folio Parameter(s) have to be copied. type: string minLength: 0 maxLength: 20 copyFiscalFolioParametersInfo: description: Provides information about the target hotel code where the source Fiscal Folio Parameter will be copied to, what the Fiscal Folio Parameter will be named under the target hotel code and the description of the Fiscal Folio Parameter under the target hotel code. type: array maxItems: 4000 items: $ref: '#/components/schemas/copyFiscalFolioParametersInfoType' createFiscalPartners: type: object description: Request object to create Fiscal Partners properties: fiscalPeriods: description: Details of the Fiscal Periods to edit $ref: '#/components/schemas/fiscalPartnersType' warnings: $ref: '#/components/schemas/warningsType' compTypeType: type: object description: Information representation of Comp Type. properties: compTypeCode: description: Code is used to identify the CompType. type: string minLength: 0 maxLength: 20 compTypeDescription: description: Text is used to describe the CompType. type: string minLength: 0 maxLength: 2000 displayOrder: description: Comp Type record sequence number. type: number managedBy: $ref: '#/components/schemas/managedByOptions' cycleFiscalPeriodsType: type: array description: List of Cycle Fiscal Periods. maxItems: 4000 items: $ref: '#/components/schemas/cycleFiscalPeriodType' customVarianceInfoType: type: array description: Monthly Value Variance information. maxItems: 12 items: $ref: '#/components/schemas/monthlyCustomVarianceInfoType' articlesInfo: type: object properties: articles: description: Collection of articles. $ref: '#/components/schemas/articlesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' folioTypeLegendMappingsConfigType: type: array description: Details about folio type legened mapping. maxItems: 4000 items: $ref: '#/components/schemas/folioTypeLegendMappingConfigType' percentageGenerateType: type: object description: Defines percentage rule for generates. properties: amount: description: Percentage Amount. type: number minimum: -100 maximum: 100 calculatedOn: description: Calculation bucket the percentage generates are calculated against. $ref: '#/components/schemas/generateCalcBucketType' useTaxBracket: description: Determines if tax bracket calculations are to apply to generates. type: boolean dailyPlanCodesType: type: array description: Details for daily plan code along with associated transaction codes. maxItems: 4000 items: $ref: '#/components/schemas/dailyPlanCodeType' reservationInfoType: type: object description: The Reservation class contains the current reservation being created or altered. properties: reservationIdList: description: Unique identifiers for the reservation for both internal and external systems $ref: '#/components/schemas/reservationIdList' externalReferences: description: External Reference information for Reservation. $ref: '#/components/schemas/externalReferencesType' roomStay: description: Collection of room stays. $ref: '#/components/schemas/stayInfoType' reservationGuest: description: Collection of guests associated with the reservation. $ref: '#/components/schemas/resGuestInfoType' sharedGuests: description: Collection of guests who share this reservation. $ref: '#/components/schemas/resSharedGuestListType' attachedProfiles: description: List of attached profiles $ref: '#/components/schemas/resAttachedProfileListType' reservationPaymentMethod: description: Payment method used for this reservation $ref: '#/components/schemas/reservationPaymentMethodType' reservationFolioWindows: description: Collection of reservation folio windows. $ref: '#/components/schemas/reservationFolioWindowsType' specials: description: Set of reservation preferences which belongs to the Specials group. type: string minLength: 0 maxLength: 4000 lastPrivacyPromptDate: description: Last Privacy Prompt Date type: string format: date maxLength: 8 displayColor: description: Color setting of the reservation. type: string minLength: 0 maxLength: 20 reservationIndicators: description: Indicators of additional information attached to the reservation $ref: '#/components/schemas/indicatorsType' roomStatus: description: Current room status $ref: '#/components/schemas/housekeepingRoomStatusType' searchMatches: description: Super Search matching terms. $ref: '#/components/schemas/searchMatchesType' sourceOfSale: description: Point of Sale of reservation. Identifies the entity/channel who made the reservation. $ref: '#/components/schemas/sourceOfSaleType' waitlist: description: Information regarding why reservation has been/was waitlisted. This could hold information as history even if reservation is not in Waitlist status anymore. $ref: '#/components/schemas/waitlistResType' queue: description: Information about the time and duration this reservation was on Queue for Checkin. $ref: '#/components/schemas/reservationQueueInformationType' housekeeping: description: Information regarding housekeeping for this reservation. $ref: '#/components/schemas/resHousekeepingType' cashiering: description: Holds cashiering related information for the reservation. $ref: '#/components/schemas/resCashieringType' taxType: description: This stores the code for the type of tax calculation especially with tax exemption, etc. $ref: '#/components/schemas/taxTypeType' deposit: description: Holds reservation deposit information. $ref: '#/components/schemas/reservationDepositType' allowedActions: description: Collection of reservation allowed actions. $ref: '#/components/schemas/reservationAllowedActionsType' revenuesAndBalances: description: Revenues and Balances Amount summary for the reservation. $ref: '#/components/schemas/resRevenueBalanceType' hotelInterfaceStatusList: description: Collection of Hotel Interfaces and rights, this is populated only when fetching interface status for rooms. type: array maxItems: 4000 items: $ref: '#/components/schemas/reservationInterfaceStatusType' guestPreferredCurrency: description: Currency code preferred by guest. type: string minLength: 0 maxLength: 20 turndownInfo: description: Currency code preferred by guest. $ref: '#/components/schemas/reservationTurndownInfoType' mobileNotifications: description: Denotes the status of Room Ready, Key Ready messages. $ref: '#/components/schemas/resMobileNotificationsType' reservationCommunication: description: Collection of reservation communication details. $ref: '#/components/schemas/resCommunicationType' advanceCheckIn: description: Information relating to Reservation's Advance Checked In state and Expected Time of Return $ref: '#/components/schemas/advanceCheckInType' welcomeOffer: description: This flag will determine wheather the reservation is eligible for Welcome Offer or not. type: boolean cancellationInfo: description: Information regarding why reservation has been/was cancelled. type: object properties: description: type: string minLength: 0 maxLength: 2000 code: type: string minLength: 0 maxLength: 20 date: description: Date when reservation was last cancelled. type: string format: date maxLength: 8 keyCount: description: Number of keys created for the reservation. type: integer hotelId: type: string minLength: 0 maxLength: 20 hotelName: type: string minLength: 0 maxLength: 80 expectedServiceTime: type: string minLength: 0 maxLength: 20 roomStayReservation: description: Boolean True if this reservation is reserving rooms. False if it is only reserving services. type: boolean createDateTime: description: Time stamp of the creation. type: string format: date-time creatorId: description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation. type: string minLength: 0 maxLength: 200 lastModifyDateTime: description: Time stamp of last modification. type: string format: date-time lastModifierId: description: Identifies the last software system or person to modify a record. type: string minLength: 0 maxLength: 200 purgeDate: description: Date an item will be purged from a database (e.g., from a live database to an archive). type: string format: date maxLength: 8 reservationStatus: description: Indicates the status of the reservation. $ref: '#/components/schemas/pMS_ResStatusType' computedReservationStatus: description: Indicates the status of the reservation. $ref: '#/components/schemas/pMS_ResStatusType' walkInIndicator: description: When true, indicates the reservation is for a guest that walks-in without a reservation. When false, the reservation is not a walk-in. type: boolean accessRestriction: description: Indicates user restriction on the reservation based on the Access exclusion functionality such as Restriction on Changes, Cancellation or both. $ref: '#/components/schemas/resAccessRestrictionType' commissionPayoutTo: description: If not null, reservation is considered to pay out commission to either Travel Agent, Source or both. $ref: '#/components/schemas/commissionPayoutToType' paymentMethod: description: Payment Method. type: string minLength: 0 maxLength: 20 preRegistered: description: Defines if the reservation is pre-registered or not. type: boolean openFolio: description: Returns true when reservation has an open folio. type: boolean allowMobileCheckout: description: Flag containing true or false value for reservation to be eligible for self-checkout by guest using mobile device . Pass the 'true' or 'false' values when creating / modifying reservation to indicate whether a reservation is eligible for mobile checkout yes / no. Upon fetch, the current state of the flag will show true or false. type: boolean allowMobileViewFolio: description: Attribute AllowMobileViewFolio is set to true when the reservation is eligible for viewing folio using mobile device. type: boolean optedForCommunication: description: Attribute OptedForCommunication is set to true when the guest has opted for receiving communicationsl related to the reservation. type: boolean cashSurchargeRanges: type: object properties: cashSurchargeRanges: type: array description: List of Cash Surcharge Ranges maxItems: 4000 items: $ref: '#/components/schemas/cashSurchargeRangeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' fiscalPeriodsEdit: type: object properties: fiscalPeriods: description: Details of the Fiscal Periods to edit $ref: '#/components/schemas/fiscalPeriodsEditType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' customNumberConfigDetails: type: object description: Response object for fetching custom number configurations. properties: customNumberConfigurationList: description: Collection of custom number configurations. $ref: '#/components/schemas/customNumberConfigurationListType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' cateringOnlyType: type: string description: For Catering and Event. enum: - 'Yes' - 'No' - Both customChargeExemptionsConfig: type: object description: Response object for fetching Custom Charge Exemptions. properties: customChargeExemptionsConfig: description: Collection of Custom Charge Exemptions. $ref: '#/components/schemas/customChargeExemptionsConfigType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' cardPaymentProcessingType: type: string description: Manual Processing. enum: - Eft - Manual resCashieringType: type: object description: Cashiering Information for the reservation. properties: revenuesAndBalances: description: Revenues and Balances Amount summary for the reservation. $ref: '#/components/schemas/resRevenueBalanceType' billingPrivileges: description: Billing privileges set on the reservation. $ref: '#/components/schemas/billingPrivilegesType' taxType: description: This stores the code for the type of tax calculation especially with tax exemption, etc. $ref: '#/components/schemas/reservationTaxTypeInfo' bedTaxReporting: description: This stores the information for Bed Tax Reporting. Mainly used in Maldives. $ref: '#/components/schemas/bedTaxReportingType' folioTexts: description: Additional text fields to display on the folio. $ref: '#/components/schemas/folioTextsType' periodicFolio: description: Information regarding periodic folios set on the reservation. $ref: '#/components/schemas/resPeriodicFolioType' compAccounting: description: Information regarding comp accounting on the reservation. $ref: '#/components/schemas/resCompAccountingType' reservationPreConfiguredRoutingInstruction: description: Information regarding the selected preconfigured routing instruction on the reservation. $ref: '#/components/schemas/resPreConfiguredRoutingInstrType' financiallyResponsible: description: The guest from whom payment has to be recovered (direct guest). type: boolean proratedBilling: description: In case of Appartment style billing indicates whether a prorated amount should be used for an Apartment Style Billing rate. type: boolean lastRoomAndTaxPostedDate: description: Date of the last Room And Tax posting. Used primarily to know the date in case of Advance Billing. type: string format: date maxLength: 8 reverseCheckInAllowed: description: This attribute is to verify if reverse check-in is allowed for the reservation. type: boolean reverseAdvanceCheckInAllowed: description: This attribute is to verify if reverse advance check-in is allowed for the reservation. type: boolean transactionsPosted: description: Specifies whether reservation has a financial transaction associated with it. type: boolean roomTypeBasedChargeRngs: type: object description: Defines Room Type Based Charge Range response type. properties: roomTypeBasedChrgRanges: type: array description: The result element containing the requested list of Room Type Based Charge Range configuration. maxItems: 4000 items: $ref: '#/components/schemas/roomTypeBasedChargeRangesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' adjustmentCodesType: type: array description: Holds Adjustment Code details. maxItems: 4000 items: $ref: '#/components/schemas/adjustmentCodeType' compAuthorizerType: type: object description: Information related to comp authorizers. properties: hotelId: description: Property code. type: string minLength: 0 maxLength: 20 authorizerId: description: Unique id for the authorizer. $ref: '#/components/schemas/uniqueID_Type' profileId: description: Profile Id of the authorizer. $ref: '#/components/schemas/uniqueID_Type' authorizer: description: Name for the authorizer. type: string minLength: 0 maxLength: 100 authorizerDisplayName: description: Display name for the authorizer. type: string minLength: 0 maxLength: 100 lastName: description: Last name for the authorizer. type: string minLength: 0 maxLength: 100 firstName: description: First name for the authorizer. type: string minLength: 0 maxLength: 100 name: description: Full name of the authorizer. type: string minLength: 0 maxLength: 100 externalUserId: description: Unique id for the external authorizer. $ref: '#/components/schemas/uniqueID_Type' associatedUsers: description: List of associated user in comp authorization. type: array maxItems: 4000 items: $ref: '#/components/schemas/applicationUserType' totalCreditLimit: description: Credit limit associated for the authorizer. type: integer aRAccount: description: AR account for the comp authorizers. $ref: '#/components/schemas/aRAccountType' compAuthorizerHeaders: description: Comp authorizer details information. type: array maxItems: 4000 items: $ref: '#/components/schemas/compAuthorizerHeaderType' inactive: description: Indicator that tells whether the authorizer is active or not. type: boolean overrideWarning: description: Indicator that tells whether to override warnings when deactivating authorizer. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' fiscalYearsType: type: array description: List of Fiscal Years. maxItems: 4000 items: $ref: '#/components/schemas/fiscalYearType' compTypesStatus: type: object description: Response Body. properties: links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateTransactionCodes: type: object properties: transactionCodes: description: Collection of template transaction codes summary. $ref: '#/components/schemas/templateTransactionCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' transactionGroups: type: object properties: transactionGroups: description: Collection of Transaction Groups Configuration. $ref: '#/components/schemas/hotelTransactionGroupsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' reservationDepositType: type: object description: Reservation Deposit Type. properties: amountRequired: description: Deposit Amount Required. type: number amountPaid: description: Deposit Amount Paid. type: number amountOwed: description: Deposit Amount Owed. type: number dueDate: description: Deposit Due Date. type: string format: date maxLength: 8 postingDate: description: Deposit Posting Date. type: string format: date maxLength: 8 hasPaid: description: Resolves whether reservation has paid deposit. type: boolean hasOutstanding: description: Resolves whether reservation has outstanding deposit. type: boolean monthlyRevenueNightsInfoType: type: object description: Holds monthly revenue summary information properties: month: description: Month number type: integer revenue: description: Revenue total for a month. type: number roomNights: description: No of nights for a month. type: integer reservationPaymentMethodType: type: object properties: paymentCard: $ref: '#/components/schemas/resPaymentCardType' balance: $ref: '#/components/schemas/currencyAmountType' authorizationRule: $ref: '#/components/schemas/authorizationRuleType' emailFolioInfo: description: Information on an email for the customer. type: object properties: email: description: eMail deatils for the profile. $ref: '#/components/schemas/emailType' emailFolio: type: boolean id: description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. type: string minLength: 0 maxLength: 80 type: description: A reference to the type of object defined by the UniqueID element. type: string minLength: 0 maxLength: 40 paymentMethod: type: string minLength: 0 maxLength: 20 description: type: string minLength: 0 maxLength: 2000 folioView: type: integer folioReportType: type: object description: 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 the folio is effective. properties: reportName: description: Name of the .REP or .RDF file. .REP or .RDF extension is not needed. type: string minLength: 0 maxLength: 80 reportGroup: description: Report group to which the report is being added. $ref: '#/components/schemas/folioReportGroupType' language: description: Language identification. type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' cashiers: type: object properties: cashiers: description: List of cashiers to be modified. $ref: '#/components/schemas/cashiersType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' postingLimitType: type: string description: Simple Type for Posting Limit Types. enum: - Daily - Monthly - PerTransaction folioTextsType: type: array description: This stores the description for the type of tax calculation especially with tax exemption, etc. maxItems: 2 items: type: object properties: text: description: Additional text field to display on the folio. type: string minLength: 0 maxLength: 50 row: description: Row number of the additional text. type: integer transactionDiversionRules: type: object properties: diversionRules: description: Collection of Transaction Diversion Rule and their information $ref: '#/components/schemas/transactionDiversionRulesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' flatAmtGenerateType: type: object description: Defines Flat Amount rule for generates. properties: amount: description: Flat Amount of the generate. type: number copyRevenueTypeMappingCriteriaType: type: array description: Provides Revenue Type Mapping details that needs to be copied. maxItems: 4000 items: $ref: '#/components/schemas/copyRevenueTypeMappingListType' paymentMethodUsageType: type: object description: This provides information about the various usage options permitted for the given payment method. properties: billing: description: Indicates if the payment method can be used for Guest Billing type: boolean accountsReceivable: description: Indicates if this payment method can be used for Accounts Receivables. type: boolean deposit: description: Indicates if this payment method can be used for Deposit payments. type: boolean compAccounting: description: Indicates if this payment method can be used for Comp Accounting. type: boolean reservation: description: Indicates if this payment method can be used as a Reservation payment method. type: boolean posting: description: Indicates if postings can be manually added to the Reservation when this payment method is used. type: boolean cash: description: Indicates if this payment method is a Cash type payment method. type: boolean cashSurcharge: description: Indicates if a cash surcharge amount can be included when this payment method is used. type: boolean segmentNameType: type: string description: Forecast. enum: - Market - Rate - Custom - Transaction - Catering telephoneInfoType: type: object description: Information on a telephone number for the customer. properties: telephone: description: Phone details for the profile. $ref: '#/components/schemas/telephoneType' id: description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. type: string minLength: 0 maxLength: 80 type: description: A reference to the type of object defined by the UniqueID element. type: string minLength: 0 maxLength: 40 foreignCurrencies: type: object properties: foreignCurrencies: description: Collection of Foreign Currencies $ref: '#/components/schemas/foreignCurrenciesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' transactionDiversionRuleType: type: object description: A Transaction Diversion Rule Type properties: vipCode: description: VIP code to consider while applying Diversion Instruction. type: string minLength: 0 maxLength: 20 membership: description: Membership type to consider while applying Diversion Instruction. $ref: '#/components/schemas/membershipTypeLevelType' targetRoom: description: Room number to receive all the diverted transactions configured for this instruction. type: string minLength: 0 maxLength: 20 transactionCodes: description: Collection of Transaction Code List type: array maxItems: 4000 items: $ref: '#/components/schemas/codeDescriptionType' description: description: User defined message for the Transaction Diversion Rule. type: string minLength: 0 maxLength: 2000 level: description: Level of the Transaction Diversion rule that can be Property or Reservation. $ref: '#/components/schemas/transactionDiversionRuleLevelType' thresholds: description: Threshold Details related to the Transaction diversion rule. $ref: '#/components/schemas/thresholdDetailsType' type: description: Transaction Diversion Rule Types $ref: '#/components/schemas/transactionDiversionRuleTypeType' hotelId: description: Hotel code with which Transaction Diversion Rule is associated. type: string minLength: 0 maxLength: 20 code: description: Transaction Diversion Code type: string minLength: 0 maxLength: 20 displaySequence: description: User configured Sequence number. type: number inactive: description: Indicator that tells whether the transaction diversion rule is active or not. type: boolean amount: description: The amount applicable to the discount on transaction diversion rule. This would be a positive amount indicating the discount. type: number minimum: 0 percent: description: A percentage value if the discount on transaction diversion rule is percentage based. type: number minimum: 0 maximum: 100 managedBy: $ref: '#/components/schemas/managedByOptions' configCopyRevenueBucketCodeType: type: object description: Copy instructions for copying Revenue Bucket Codes to hotel code(s) properties: copyCodes: description: This holds a List of copy codes type: array maxItems: 4000 items: $ref: '#/components/schemas/copyConfigurationCodeType' revenueBucketType: description: This holds a Revenue Bucket Type type: array maxItems: 4000 items: type: string minLength: 0 maxLength: 20 generatePostingRuleType: type: object description: Advance Generates posting rules. properties: applicableDays: description: Generates are posted/applicable only for first Applicable Days of the stay. type: integer adjustmentType: description: Indicates type of adjustment procedure required, if there is a need due to the ApplicableDays setting. $ref: '#/components/schemas/generateAdjustmentTypeType' timeSpanDaysOfWeekType: type: object description: Container for Time span with days of week. properties: timeSpan: $ref: '#/components/schemas/timeSpanType' sunday: type: boolean monday: type: boolean tuesday: type: boolean wednesday: type: boolean thursday: type: boolean friday: type: boolean saturday: type: boolean aRAccountRefType: type: object description: AR account Info. properties: name: description: AR account name. type: string minLength: 0 maxLength: 200 accountNo: description: The Account Number for the Account. type: string minLength: 0 maxLength: 20 url: description: URL that identifies the location associated with the record identified by the UniqueID. type: string type: description: A reference to the type of object defined by the UniqueID element. type: string minLength: 0 maxLength: 20 instance: description: The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated. type: string minLength: 0 maxLength: 80 idContext: description: Used to identify the source of the identifier (e.g., IATA, ABTA). type: string minLength: 0 maxLength: 80 id: description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. type: string minLength: 0 maxLength: 80 idExtension: description: Additional identifying value assigned by the creating system. type: integer customChargePostingRhythmTypeOption: type: string description: Defined values for posting rhythm LOV. enum: - PostEveryNightForXNights - PostOnEveryXNightsStartingYNight paymentMethodsType: type: array description: Holds the various types of payment methods. maxItems: 4000 items: $ref: '#/components/schemas/paymentMethodType' cardUsageRulesType: type: object description: Provides information on the various authorization options for a given card type . properties: authorizationAtCheckin: description: Indicates if this payment method can be used for Authorization at check in. type: boolean authorizationDuringStay: description: Indicates if this payment method can be used for Authorization during stay. type: boolean authorizationReversal: description: Indicates if this payment method can be used for Authorization reversal can be done. type: boolean authorizationSettlementAtCheckout: description: Indicates if this payment method can be used for Authorization settlement can happen during checkout. type: boolean cVVCheck: description: Indicates if this payment method needs CVV check. type: boolean addressVerification: description: Indicates if this payment method requires an address verification. type: boolean promptAtCheckin: description: Indicates if this payment method needs a prompt during check in. type: boolean chipAndPin: description: Indicates if this payment method is a chip and pin. type: boolean copyConfigurationCodeType: type: object description: Information needed to copy configuration code from one property to the other. properties: targetHotelCode: description: Property to which configuration code type to be copied to. type: array maxItems: 4000 items: type: string minLength: 0 maxLength: 20 sourceHotelCode: description: Code that is to be copied. type: string minLength: 0 maxLength: 20 code: description: Source hotel code from which code is to be copied from. type: string minLength: 0 maxLength: 20 gUINumberPeriodType: type: string description: Period set November-December enum: - JanuaryFebruary - MarchApril - MayJune - JulyAugust - SeptemberOctober - NovemberDecember waitlistResType: type: object description: Information regarding why reservation is being /has been waitlisted. properties: reasonDescription: description: Waitlist Reason Description. type: string minLength: 0 maxLength: 2000 priorityDescription: description: Waitlist priority Description. type: string minLength: 0 maxLength: 2000 description: description: Description why the reservation is being /has been waitlisted. type: string minLength: 0 maxLength: 2000 reasonCode: description: Waitlist Reason Code. type: string minLength: 0 maxLength: 20 priorityCode: description: Waitlist Priority Code. type: string minLength: 0 maxLength: 20 telephone: description: Guest telephone number. type: string minLength: 0 maxLength: 40 revenueBucketCodes: type: object properties: revenueBucketCodes: description: Collection of Revenue Bucket Codes configurations. $ref: '#/components/schemas/revenueBucketCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' hotelNoShowPostingRuleType: type: object description: Provides information about No Show Posting Rule Configuration. properties: reservationType: description: Type of the reservation. type: string minLength: 0 maxLength: 20 sourceCode: description: Source code of the reservation. type: string minLength: 0 maxLength: 20 postingRule: description: Posting Rule to be selected. $ref: '#/components/schemas/postingRuleType' hotelId: description: Indicates for which hotel this posting rule apply to. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' cashierId: type: number description: The Cashier ID of the Cashier who is currently processing the transaction(s). customChargeType: type: object description: This gives detailed information about Custom Charges. properties: customChargeCode: description: Code is used to identify the Custom Charge. type: string minLength: 0 maxLength: 20 hotelId: description: Identifies the hotel code for which the Custom Charge code is specified. type: string minLength: 0 maxLength: 20 description: description: Description for the Custom Charge code. type: string minLength: 0 maxLength: 40 priority: description: Identifies the priority for which the Custom Charge code is specified. type: integer price: description: Identifies the price for which the Custom Charge code is specified. type: number dateRange: description: Identifies the date range for which the Custom Charge code is specified. $ref: '#/components/schemas/dateRangeType' percentage: description: The percentage of the Rate Code, which will be posted as the Custom Charge to a reservation. The value can contain up to 2 decimal places (ie 10.25%). type: number minimum: 0 maximum: 100 customChargeRuleType: description: Identifies the rule for which the Custom Charge code is specified. $ref: '#/components/schemas/customChargeRuleTypeType' customChargePostingRhythm: description: Flag to indicate if the custom charge code has a posting rhythm configured or not. type: boolean customChargePostingRhythmType: description: Identifies the posting rhythm type for the specified custom charge code. $ref: '#/components/schemas/customChargePostingRhythmType' customChargeRanges: type: array description: List of custom charge ranges. maxItems: 4000 items: $ref: '#/components/schemas/customChargeRangeType' excludeTransactionCodes: description: List of Transaction Codes to be excluded from custom charge calculation. $ref: '#/components/schemas/codeListType' excludePackageCodes: description: List of Package Codes to be excluded from custom charge calculation. $ref: '#/components/schemas/codeListType' excludePackageGroups: description: List of Package Group Codes to be excluded from custom charge calculation. $ref: '#/components/schemas/codeListType' active: description: Flag specifying if custom charge code is active or not. type: boolean transactionSubgroupsCopy: type: object properties: copyInstructions: description: List of transactions subgroups that needs to be copied to the properties specified. $ref: '#/components/schemas/copyTransactionSubgroupsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateTransactionSubgroups: type: object properties: transactionSubgroups: description: Collection of template transaction subgroups configuration. $ref: '#/components/schemas/templateTransactionSubgroupsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' transactionArrangementCodesType: type: array description: Contains transaction codes along with associated arrangement codes. maxItems: 4000 items: $ref: '#/components/schemas/transactionArrangementCodeType' generatesInfoType: type: object description: Defines Generates Info. properties: generates: type: array description: Defines Generates Info maxItems: 4000 items: $ref: '#/components/schemas/generateInfoType' creditLimitType: type: object properties: creditLimit: $ref: '#/components/schemas/currencyAmountType' percentage: type: number minimum: 0 maximum: 100 revenueBucketTypesType: type: array description: Holds Revenue Bucket Type details. maxItems: 4000 items: $ref: '#/components/schemas/revenueBucketTypeType' authorizationConfigRuleType: type: object description: Authorization configuration Rule Type.Authorization Rules specify the rule (or rules) that the property uses for credit card authorizations properties: hotelId: description: Property associated with authorization rule type: string minLength: 0 maxLength: 20 roomType: description: Authorization rule Room type. type: string minLength: 0 maxLength: 20 roomClass: description: Authorization rule room class code. $ref: '#/components/schemas/roomClassCodeInfoType' sourceCode: description: Authorization rule source code. $ref: '#/components/schemas/sourceCodeInfoType' rateCategory: description: Authorization rule Rate Category code. $ref: '#/components/schemas/rateCategoryType' rateCode: description: Rate code associated to this rule. type: string minLength: 0 maxLength: 20 guaranteeCode: description: Guarantee code associated to this rule. type: string minLength: 0 maxLength: 20 ruleNo: description: Rule Number for current authorization. type: integer ruleDescription: description: Rule Number description for current authorization. type: string minLength: 0 maxLength: 200 amount: description: Amount to be applied to all rules with an amount configured in the formula. $ref: '#/components/schemas/currencyAmountType' percentage: description: Percentage to be applied to all rules with a percentage configured in the formula. type: number minimum: 0 maximum: 100 maxDaysToAuthorize: description: A maximum of two digits to set the number of days to authorize for a credit card. If the field is left blank, authorizations will be done for the entire stay duration of the reservation type: integer ignoreDepositsYN: description: Ignore deposits paid for calculation of the amount to be authorized. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' fiscalFolioParameterType: type: object description: Provides information about the Fiscal Folio Parameter. properties: hotelId: description: Code of the Hotel. type: string minLength: 0 maxLength: 20 partner: description: Fiscal folio parameter associated with Partner. type: string minLength: 0 maxLength: 80 code: description: Code of the Fiscal Folio Parameter. type: string minLength: 0 maxLength: 80 description: description: Description of the Fiscal Folio Parameter. type: string minLength: 0 maxLength: 2000 value: description: Parameter value of the Fiscal Folio Parameter. type: string minLength: 0 maxLength: 200 internal: description: Indicates whether the Fiscal Folio Parameter is user created or from seed data. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' taxTypeCalcRuleType: type: object description: Defines the Calculation Rule for the generate. properties: percentage: description: Defines percentage rule for generates. $ref: '#/components/schemas/percentageGenerateType' flatAmount: description: Defines Flat Amount rule for generates. $ref: '#/components/schemas/flatAmtGenerateType' uDF: description: Defines User Defined Function to calculate generates. $ref: '#/components/schemas/uDFGenerateType' doNotPost: description: Existence of this element indicates that generate will not be calculated/posted. $ref: '#/components/schemas/doNotPostGenerateType' roundingMethod: description: Defines the rounding method to be used. $ref: '#/components/schemas/generateRoundingMethodType' status: type: object description: Response Body. properties: warnings: $ref: '#/components/schemas/warningsType' links: $ref: '#/components/schemas/links' taxTypes: type: object properties: taxTypes: description: Collection of Tax Type configurations. $ref: '#/components/schemas/taxTypesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' folioArrangementCodeType: type: object description: Generic Type to specify unique/primary id for the code. mostly used for Hotel level configuration codes removal request. properties: hotelId: description: Hotel where the code is configured. type: string minLength: 0 maxLength: 20 code: description: Configuration code. type: string minLength: 0 maxLength: 20 arrangementId: description: Primay key of arrangement codes type: number description: description: Description of the Folio Group Code. $ref: '#/components/schemas/translationTextType2000' taxTypeCode: description: information about the tax type code linked to the folio arrangment Code. type: string revenue: description: specify whether the arrangement postings are classed as revenue. type: boolean transactionCodes: description: Transaction codes that are associated to the folio grouping codes. $ref: '#/components/schemas/codeListType' managedBy: $ref: '#/components/schemas/managedByOptions' fiscalFolioParametersType: type: array description: Holds Fiscal Folio Parameter details. maxItems: 4000 items: $ref: '#/components/schemas/fiscalFolioParameterType' promotionType: type: object description: Type to specify a rate promotion. Usually attached to a reservation to indicate a specific promotion is applied to the reservation. properties: promotionCode: description: Promotion code associated with the rate plan. type: string minLength: 0 maxLength: 20 promotionName: description: Promotion code Name associated with the rate plan. type: string minLength: 0 maxLength: 20 couponCode: description: Promotion Coupon Code when promotion is setup to have a valid coupon code. type: string minLength: 0 maxLength: 40 transactionCodes: type: object properties: trxCodeUsages: description: Contains a list of elements on which the transaction code is used. When attempting to set a transaction code as inactive, a check is performed to make sure the transaction code is not being used before the change operation can be performed. If there are usages, the change operation will fail and this element will be populated with the associated usages for reference. $ref: '#/components/schemas/trxCodeUsagesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' customCodeTotalInformationType: type: object description: Budget Forecast information for Custom segment. properties: budgetTotalInfo: description: Budget Value information for a Custom code. $ref: '#/components/schemas/customValueInfoType' forecastTotalInfo: description: Forecast Value information for a Custom code. $ref: '#/components/schemas/customValueInfoType' actualTotalInfo: description: Actual Value information for a Custom code. $ref: '#/components/schemas/customValueInfoType' aFVarianceTotalInfo: description: Actual Forecast Value variance for a Custom code. $ref: '#/components/schemas/customVarianceInfoType' aBVarianceTotalInfo: description: Actual Budget Value variance for a Custom code. $ref: '#/components/schemas/customVarianceInfoType' fBVarianceTotalInfo: description: Forecast Budget Value variance for a Custom code. $ref: '#/components/schemas/customVarianceInfoType' taxTypesCopy: type: object properties: taxType: type: array description: List of the Tax Types to be copied. items: $ref: '#/components/schemas/copyConfigurationCodeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' controlSequencesType: type: array description: List of Control Sequence details maxItems: 4000 items: $ref: '#/components/schemas/controlSequenceType' transactionInfoType: type: object description: Revenue information for a TRANSACTION segment code. Holds total and monthly revenue information. properties: totalRevenue: description: Total Value for TRANSACTION segment code. type: number monthlyRevenueInfo: description: Value information for each month for TRANSACTION segment code. type: array maxItems: 12 items: $ref: '#/components/schemas/monthlyTransactionInfoType' budgetForecastRateInfoBaseType: type: object description: Budget Forecast information for budget segment codes. properties: rateCodeInformation: description: Budget Forecast information for budget segment code . type: array maxItems: 4000 items: $ref: '#/components/schemas/rateCodeInformationBaseType' revenue: description: Flag to indicate if revenue information has to be included. type: boolean nights: description: Flag to indicate if nights information has to be included. type: boolean authorizerTrxLimitsType: type: array description: Set of Transaction Limit configured for the Authorizer Group. maxItems: 4000 items: $ref: '#/components/schemas/authorizerTrxLimitType' postingAmountType: type: object properties: minimumAmount: $ref: '#/components/schemas/currencyAmountType' maximumAmount: $ref: '#/components/schemas/currencyAmountType' copyTransactionCodeType: type: object description: 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 copied under the same hotel code. properties: sourceTransactionCode: description: Source transaction code to be copied. type: string minLength: 0 maxLength: 20 copyAs: description: The code and description to be used for the transaction code being copied. Transaction code will be copied to the same hotel code with a different code and description. $ref: '#/components/schemas/codeDescriptionType' revenueBucketTypeType: type: object description: Provides information about Revenue Bucket Types. properties: hotelId: description: Code of the Hotel. type: string minLength: 0 maxLength: 20 code: description: Revenue Bucket Type Code type: string minLength: 0 maxLength: 20 description: description: Revenue Bucket Type Description type: string minLength: 0 maxLength: 200 bucketType: description: Flag to identify Fiscal related bucket types. $ref: '#/components/schemas/bucketTypeType' bucketTrxCodes: description: Provides ability to configure same transaction code in multiple buckets. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' marketCodeInformationBaseType: type: object description: Budget Forecast information for budget segment code. properties: marketCode: description: Segment code for which budget forecast information is fetched. type: string minLength: 0 maxLength: 20 marketCodeDescription: description: Segment code description for segment code. type: string budgetRevenueInfo: description: Budget Revenue information for a segment code. $ref: '#/components/schemas/revenueNightsInfoType' forecastRevenueInfo: description: Forecast Revenue information for a segment code. $ref: '#/components/schemas/revenueNightsInfoType' generateCalcBucketType: type: string description: Generates calculation bucket/group. Percentage generates are calculated against amount in one of the the calculation bucket. enum: - Base - Bucket1 - Bucket2 - Bucket3 fixedChargeScheduleType: type: object description: Holds schedule of fixed charge. properties: start: description: The starting value of the date range. type: string format: date maxLength: 8 end: description: The ending value of the date range. type: string format: date maxLength: 8 frequency: description: Frequency of a fixed charge. $ref: '#/components/schemas/fixedChargeFrequencyType' dayToExecute: description: Day of when to execute fixed charge. Applicable when frequency is Daily or Weekly. type: string minLength: 0 maxLength: 3 dateToExecute: description: Date of when to execute yearly fixed charge. Applicable when frequency is Yearly. type: string format: date maxLength: 8 monthlyCateringVarianceInfoType: type: object description: Variance information for a catering segment code for a month. properties: month: description: Month number type: integer revenueVariance: description: Variance for a month. type: number coversVariance: description: Variance for a month. type: number copyCustomChargeExemptionConfigType: type: object description: Information needed to copy Custom Charge Exemption from one property to the other. properties: targetHotelCode: description: Property to which Custom Charge Exemptions to be copied to. type: array maxItems: 4000 items: type: string minLength: 0 maxLength: 20 exemptionCodes: description: Custom Charge Exemption to be copied. type: array maxItems: 4000 items: type: string minLength: 0 maxLength: 20 sourceHotelCode: description: Property from which Custom Charge Exemptions to be copied from. type: string minLength: 0 maxLength: 20 folioTypesConfigType: type: array description: Information details of the Folio Type Names. maxItems: 4000 items: $ref: '#/components/schemas/folioTypeConfigType' managedByOptions: description: Describes of the Configuration is Managed by Enterprise or Property. type: string enum: - EnterpriseManaged - PropertyManaged - EnterpriseEnforced - PropertyOverridden surchargeType: type: object description: Surcharge information regarding the payment configuration. properties: minimum: description: Indicates the minimum credit card transaction amount for which the surcharge applies. $ref: '#/components/schemas/currencyAmountType' percentage: description: Indicates the percentage amount for a credit card transaction. type: number minimum: 0 maximum: 100 cashieringTransactionTypeType: type: string description: Wrapper Transaction Type. enum: - Revenue - Payment - Wrapper fiscalCommandsType: type: array description: List of FiscalCommands. maxItems: 4000 items: $ref: '#/components/schemas/fiscalCommandType' cateringCodeInformationType: type: object description: Budget Forecast information for Catering segment code. properties: cateringCode: description: Catering segment code for which budget forecast information is fetched. type: string minLength: 0 maxLength: 20 cateringCodeGrp: description: Catering code group of segment code. type: string cateringCodeDescription: description: Catering code description for segment code. type: string budgetInfo: description: Budget Revenue information for a Catering code. $ref: '#/components/schemas/cateringInfoType' forecastInfo: description: Forecast Revenue information for a Catering code. $ref: '#/components/schemas/cateringInfoType' actualInfo: description: Actual Revenue information for a Catering code. $ref: '#/components/schemas/cateringInfoType' aFVarianceInfo: description: Actual Forecast variance for a Catering code. $ref: '#/components/schemas/cateringVarianceInfoType' aBVarianceInfo: description: Actual Budget variance for a Catering code. $ref: '#/components/schemas/cateringVarianceInfoType' fBVarianceInfo: description: Forecast Budget variance for a Catering code. $ref: '#/components/schemas/cateringVarianceInfoType' generateInfoType: type: object description: Defines Generates Info properties: generateId: description: Unique ID of the Generate. $ref: '#/components/schemas/uniqueID_Type' trxInfoType: type: object description: Transaction codes info. properties: description: description: Transaction codes info. type: string minLength: 0 maxLength: 2000 transactionGroup: description: Category of the transaction code. type: string minLength: 0 maxLength: 20 transactionSubGroup: description: Sub category of the transaction code. type: string minLength: 0 maxLength: 20 universalProductCode: description: Unique Universal product code of the transaction code. type: string minLength: 0 maxLength: 20 routingInstructionsId: description: This is the Routing Instruction Id attached with Reservation. It is only used for internal purpose. It should not be used by external vendor or consumer. type: number articles: description: The List of Articles defined for this transaction code, when using the Articles functionality. type: array maxItems: 4000 items: $ref: '#/components/schemas/articleInfoType' trxServiceType: description: Contains service type for transaction code. type: string minLength: 0 maxLength: 20 transactionCode: description: Unique identifier for the Transaction code. type: string minLength: 0 maxLength: 20 hotelId: description: Hotel context of the Transaction code. type: string minLength: 0 maxLength: 20 printTrxReceipt: description: Print receipt flag that tells whether the transaction receipt is to be printed or not. This is based on the transaction code. type: boolean groupArrangementCodeType: type: object description: Generic Type to specify unique/primary id for the code. mostly used for Hotel level configuration codes removal request. properties: hotelId: description: Hotel where the code is configured. type: string minLength: 0 maxLength: 20 code: description: Configuration code. type: string minLength: 0 maxLength: 20 arrangementId: description: Primay key of arrangement codes type: number description: description: Description of the Folio Group Code. $ref: '#/components/schemas/translationTextType2000' taxTypeCode: description: information about the tax type code linked to the folio arrangment Code. type: string revenue: description: specify whether the arrangement postings are classed as revenue. type: boolean transactionCodes: description: Transaction codes that are associated to the folio grouping codes. $ref: '#/components/schemas/codeListType' managedBy: $ref: '#/components/schemas/managedByOptions' resPeriodicFolioType: type: object description: Information regarding periodic folios set on the reservation. properties: lastSettlementDate: description: Latest date when a direct bill settlement was automatically done using the "Direct Bill Batch Folios" option. type: string format: date maxLength: 8 lastFolioDate: description: Latest date when a folio was printed using the "Periodic Batch Folios" option type: string format: date maxLength: 8 frequency: description: Frequency in number of days when folios should be printed for this reservation. type: integer folioTypeLegendMappingConfigToBeChanged: type: object description: Request object to edit folio type legend mapping information. properties: criteria: description: Criteria to edit folio type legend mapping. $ref: '#/components/schemas/folioTypeLegendMappingConfigType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' resAttachedProfileListType: type: array maxItems: 4000 items: $ref: '#/components/schemas/resAttachedProfileType' noShowPostingRulesEditType: type: array description: Contains new rules along with associated old rules to edit. maxItems: 4000 items: $ref: '#/components/schemas/noShowPostingRuleEditType' paymentMethodType: type: object description: Provides information about the payment methods. CreditCardCode and CreditCardType help to determine if EFTs are allowed. properties: description: description: Description of the payment method. type: string minLength: 0 maxLength: 2000 paymentCard: description: Contains credit card information. $ref: '#/components/schemas/paymentCardType' paymentMethodTransactionInfo: description: Contains summary information of the transaction. $ref: '#/components/schemas/paymentMethodTransactionInfoType' paymentMethodUsage: description: Contains various usage options permitted for the payment method. $ref: '#/components/schemas/paymentMethodUsageType' creditLimit: description: Contains the credit limit of a transaction. $ref: '#/components/schemas/creditLimitType' hotelId: description: Property from which the payment method belongs to. type: string minLength: 0 maxLength: 20 paymentMethod: description: Defines the unique identifier for this payment method. type: string minLength: 0 maxLength: 20 calculatePoints: description: Defines when the points are to be calculated. $ref: '#/components/schemas/calculatePointsType' inactive: description: Indicates whether the payment method is inactive or not. type: boolean orderSequence: description: Display Order sequence. type: number managedBy: $ref: '#/components/schemas/managedByOptions' deleteSegmentCodeInfoType: type: object description: Holds segment code information to delete. properties: segmentCode: description: segment code to delete budget information. $ref: '#/components/schemas/codeListType' segmentCodeGroup: description: segment code group. type: string minLength: 0 maxLength: 20 segment: description: holds segment name of which segment code belongs to. $ref: '#/components/schemas/segmentNameType' deleteInformation: description: holds budget information type to delete. $ref: '#/components/schemas/budgetInfoDeleteType' budgetMonth: description: holds budget month information if daily information of a month needs to be deleted. $ref: '#/components/schemas/monthNoType' budget: description: Flag to include Budget revenue/nights information. type: boolean forecast: description: Flag to include Forecast revenue/nights information. type: boolean resGuestExternalInfoType: type: object description: Specifies Company or Travel Agent profile using IATA or Corp. No. properties: givenName: description: Given name, first name or names $ref: '#/components/schemas/givenNameType' surname: description: Family name, last name. $ref: '#/components/schemas/surnameType' trxCodeAccessRolesType: type: array description: List of Roles having access to set of transaction codes maxItems: 4000 items: $ref: '#/components/schemas/trxCodeAccessRoleType' transactionAdjustmentType: type: object description: Combination of Adjustment Reason Code and Transaction Adjustment Code. properties: adjustmentReasonCode: description: Adjustment reason Code type: string minLength: 0 maxLength: 20 adjustmentTransactionCode: description: Adjustment Transaction Code type: string minLength: 0 maxLength: 20 givenNameType: type: string description: Given name, first name or names minLength: 0 maxLength: 40 foreignCurrenciesType: type: array description: List of the Foreign Currencies to be configured or fetched maxItems: 4000 items: $ref: '#/components/schemas/foreignCurrencyType' aRAgingType: type: object description: Aging information for an Aging Bucket. properties: agingBucketRange: description: 'The bucket description in terms of days. Example : 0-31 days' type: string minLength: 0 maxLength: 20 agingDate: description: The start date and end date for this Aging bucket. $ref: '#/components/schemas/dateRangeType' balanceInfo: description: The balance amounts for this bucket. Contains the Debit Balance, Credit Balance and the Total Balance. $ref: '#/components/schemas/aRBalanceType' agingStartDay: description: 'The start number of days for this Aging bucket. Example: For the range 31-60 days, this would be 31.' type: integer agingEndDay: description: 'The end number of days for this Aging bucket. Example: For the range 31-60 days, this would be 60.' type: integer sequence: description: The sequence for display. type: integer advanceCheckInType: type: object description: Information relating to Reservation's Advance Checked In state and Expected Time of Return properties: advanceCheckedIn: description: Indicates if the reservation is marked as Advance Checked In type: boolean expectedReturnTime: description: Expected Return Time type: string format: date-time eTRComments: description: ETR Comments type: string minLength: 0 maxLength: 2000 paymentTrxSetupType: type: object description: Payment Transaction Code setup details. properties: usage: description: Payment Transaction Code usage information. $ref: '#/components/schemas/paymentTrxUsageType' card: description: Card payment setup information. $ref: '#/components/schemas/cardPaymentTrxSetupType' iRS8300Reporting: description: True indicates the Transaction Code payment will be reposted to IRS according to the rule specified by IRS. type: boolean roundingFactor: description: True indicates the Transaction Code posting will have a rounding effect. type: boolean generateTaxInvoice: description: Indicates if the Transaction Code payment will generate a Tax Invoice at the time of making a payment. Tax Invoices are used in Thailand. type: boolean paymentType: description: Type of payment this transaction code represents. $ref: '#/components/schemas/paymentTrxCodeTypeType' resRevenueBalanceType: type: object description: Revenue and Balance Amount summary for the reservation. properties: totalFixedCharge: description: Total Fixed Charges on the reservation. $ref: '#/components/schemas/currencyAmountType' totalPayment: description: Total payment received for the reservation. $ref: '#/components/schemas/currencyAmountType' roomRevenue: description: Room Revenue generated by the reservation. $ref: '#/components/schemas/currencyAmountType' foodAndBevRevenue: description: Food and Beverage Revenue generated by the reservation. $ref: '#/components/schemas/currencyAmountType' otherRevenue: description: Other Revenue generated by the reservation. $ref: '#/components/schemas/currencyAmountType' nonRevenue: description: Total Non Revenue posted on the reservation. $ref: '#/components/schemas/currencyAmountType' totalRevenue: description: Total Revenue generated by the reservation. $ref: '#/components/schemas/currencyAmountType' balance: description: Balance amount on the reservation. $ref: '#/components/schemas/currencyAmountType' compBalance: description: Comp Balance amount $ref: '#/components/schemas/currencyAmountType' calculatePostingResult: type: object description: List of charges that will be posted against the transaction code based from the test criteria. properties: charges: description: Charges that will be posted based from the criteria defined. type: array maxItems: 4000 items: $ref: '#/components/schemas/calculatePostingCharge' totalAmount: description: The full amount that would be posted. type: number copyFiscalFolioParametersInfoType: type: object description: 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. Details include source code, hotel code, description, Internal, value with which the Fiscal Folio Parameter will be copied under the target hotel code. properties: sourceCode: description: Source Fiscal Folio Parameter to be copied. type: string minLength: 0 maxLength: 80 targetHotelCode: description: Target hotel code where the Fiscal Folio Parameter will be copied to. type: string minLength: 0 maxLength: 20 copyAs: description: The code and description to be used for fiscal folio parameter being copied under the target hotel code. $ref: '#/components/schemas/codeDescriptionType' customChargeRuleTypeOption: type: string description: The Custom Charge is only posted for the maximum number of nights of the stay. enum: - Rate - RatePercWithLimit - RatePerPerson - RatePercWithLimitPerPerson facilityCodeType: type: object description: Facility Housekeeping Code, its description and quantity. properties: description: description: Facility Code. type: string minLength: 0 maxLength: 80 quantity: description: Signifies the quantity. type: integer code: description: Facility code value. type: string minLength: 0 maxLength: 20 compBucketRedemptionConfigDetails: type: object description: Response object for fetching Comp Bucket Redemption Codes configurations. properties: bucketRedemptionCodes: description: Collection of Comp Bucket Redemption Codes configurations. $ref: '#/components/schemas/bucketRedemptionCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' cashierTypeType: type: string description: The types of cashier. enum: - Cashier - InterfaceCashier - LDAPTemplate noShowPostingRules: type: object properties: noShowPostingRules: description: Collection of No Show Posting Rule Configurations. $ref: '#/components/schemas/hotelNoShowPostingRulesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' trxCodeClassificationType: type: object description: Transaction Code Classification details. properties: type: description: Transaction Type. $ref: '#/components/schemas/cashieringTransactionTypeType' transactionType: description: Transaction Code Type detail. type: object properties: code: description: Transaction Code Type. $ref: '#/components/schemas/transactionCodeTypeType' taxCode: description: Tax Code if the transaction Code if it is of type Tax. type: integer group: description: Group the transaction code belongs to.. $ref: '#/components/schemas/codeDescriptionType' subgroup: description: Subgroup the transaction code belongs to. $ref: '#/components/schemas/codeDescriptionType' fiscalTransactionType: description: Transaction code type for fiscal printing purposes. type: string minLength: 0 maxLength: 1 budgetForecastRateInfoType: type: object description: Budget Forecast information for budget segment codes. properties: rateCodeInformation: description: Budget Forecast totals information for Rate segment. type: array maxItems: 4000 items: $ref: '#/components/schemas/rateCodeInformationType' rateCodeTotalInformation: description: Budget Forecast totals information for Rate segment. $ref: '#/components/schemas/rateCodeTotalInformationType' budgetForecastCateringInfoType: type: object description: Budget Forecast information for budget Catering codes. properties: cateringCodeInformation: description: Budget Forecast totals information for Catering segment. type: array maxItems: 4000 items: $ref: '#/components/schemas/cateringCodeInformationType' cateringTotalsInformation: description: Budget Forecast totals information for Catering segment. $ref: '#/components/schemas/cateringTotalsInformationType' configRoutingInstructionsType: type: array description: This type holds a collection of routing instructions. maxItems: 4000 items: $ref: '#/components/schemas/configRoutingInstructionType' paymentTrxCodeTypeType: type: string description: Other Payment Type Transaction. enum: - Cash - Check - CreditCard - Others paymentTrxUsageType: type: object description: Payment Transaction Code usage details. properties: aR: description: True indicates the payment Transaction Code is used for AR payments. type: boolean cashier: description: Indicates whether Profiles are shared across the Hotels within the chain or not. type: boolean comp: description: True indicates the payment Transaction Code is used for Comp payments. type: boolean deposit: description: True indicates the payment Transaction Code is used for deposits. type: boolean interHotelPayment: description: True indicates the payment Transaction Code inter hotel payments. type: boolean interHotelDeposit: description: True indicates the payment Transaction Code is used for inter hotel deposits. type: boolean folioTypeLegendMappingConfigCriteria: type: object description: Request object to create folio type legend mapping information. properties: criteria: description: Criteria to create folio type legend mapping. $ref: '#/components/schemas/folioTypeLegendMappingConfigType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' paymentMethodValidationRuleType: type: object description: Payment method card validation rules. properties: length: description: Valid lengths of card number. type: string minLength: 0 maxLength: 50 prefix: description: Valid card number prefix. type: string minLength: 0 maxLength: 50 ranges: description: Collection of card number ranges. $ref: '#/components/schemas/cardRangesType' formula: description: Formula used for card validation. Only valid in case of user defined validation. type: string minLength: 0 maxLength: 2000 rule: description: Defines rules to be used for card validation. $ref: '#/components/schemas/cardValidationRuleTypeType' bedTaxReportingType: type: object description: This stores the information for Bed Tax Reporting. Mainly used in Maldives. properties: taxRegistrationNo: description: Tax Registration Number for Maldives Bed Tax Reporting. type: number visaNumber: description: Visa number used for Maldives Bed Tax Reporting type: string minLength: 0 maxLength: 40 visaIssueDate: description: Visa Issue Date used for Maldives Bed Tax Reporting. type: string format: date maxLength: 8 visaExpiryDate: description: Visa Expiration Date used for Maldives Bed Tax Reporting type: string format: date maxLength: 8 taxableDays: description: Number of days for which the Maldives tax is applicable. type: integer folioTypeLegendMappingsConfigDetails: type: object description: Response object for fetch folio type legend mapping. properties: legends: $ref: '#/components/schemas/folioTypeLegendMappingsConfigType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' taxTypeGenerateType: type: object description: Defines the Calculation Rules for the Tax Type properties: schedule: description: Defines the Calculation Rule for the Tax Type for a specific date schedule type: array maxItems: 4000 items: $ref: '#/components/schemas/taxTypeGenerateScheduleType' code: description: Code. type: string minLength: 0 maxLength: 20 description: description: description. type: string minLength: 0 maxLength: 2000 monthNoType: type: string description: December. enum: - '1' - '2' - '3' - '4' - '5' - '6' - '7' - '8' - '9' - '10' - '11' - '12' copyTransactionCodesType: type: object description: Collection of transaction codes to be copied within same hotel properties: transactionCode: description: List of transaction codes to be copied within the same hotel code. type: array maxItems: 4000 items: $ref: '#/components/schemas/copyTransactionCodeType' hotelId: description: Source hotel code from where transaction codes(s) have to be copied. The transaction codes will be copied to the same hotel code with a different code and description. type: string minLength: 0 maxLength: 20 copyGenerates: description: Indicator that tells whether the transaction code generates should be copied or not. type: boolean rateCodeInformationType: type: object description: Budget Forecast information for budget segment code. properties: rateCode: description: Segment code for which budget forecast information is fetched. type: string minLength: 0 maxLength: 20 rateCodeDescription: description: Segment code description for segment code. type: string budgetRevenueInfo: description: Budget Revenue information for a segment code. $ref: '#/components/schemas/revenueNightsInfoType' forecastRevenueInfo: description: Forecast Revenue information for a segment code. $ref: '#/components/schemas/revenueNightsInfoType' actualRevenueInfo: description: Actual Revenue information for a segment code. $ref: '#/components/schemas/revenueNightsInfoType' aFVarianceInfo: description: Actual Forecast Revenue variance for a segment code. $ref: '#/components/schemas/revenueNightsVarianceInfoType' aBVarianceInfo: description: Actual Budget Revenue variance for a segment code. $ref: '#/components/schemas/revenueNightsVarianceInfoType' fBVarianceInfo: description: Forecast Budget Revenue variance for a segment code. $ref: '#/components/schemas/revenueNightsVarianceInfoType' interfaceRightsStatusType: type: object properties: right: description: Internal code for each allowed right of a Hotel Interface record. type: integer statusCode: description: User defined code for an Interface Right. type: string minLength: 0 maxLength: 5 description: description: User defined description for an Interface Right. type: string minLength: 0 maxLength: 80 category: description: Category code of this interface right. type: string minLength: 0 maxLength: 1 traceTimeInfoType: type: object properties: dateTimeSpan: description: Time span for the trace. $ref: '#/components/schemas/dateTimeSpanType' traceOn: description: Date of the trace. type: string format: date-time traceTime: description: Time of the trace type: string minLength: 0 maxLength: 20 enteredBy: description: User that entered this trace. type: string resGuestInfoType: type: object description: Specifies Company or Travel Agent profile using IATA or Corp. No. properties: membership: description: The Membership object identifying the frequent customer reward program. $ref: '#/components/schemas/membershipInfoType' namePrefix: description: Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.) $ref: '#/components/schemas/namePrefixType' givenName: description: Given name, first name or names $ref: '#/components/schemas/givenNameType' alternateGivenName: description: Alternate given name, first name or names type: string minLength: 0 maxLength: 40 middleName: description: The middle name of the person name type: string minLength: 0 maxLength: 40 surnamePrefix: description: e.g "van der", "von", "de" type: string minLength: 0 maxLength: 20 surname: description: Family name, last name. $ref: '#/components/schemas/surnameType' alternateSurname: description: Alternate family name, last name. type: string minLength: 0 maxLength: 40 nameSuffix: description: Hold various name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.). type: string minLength: 0 maxLength: 20 nameTitle: description: Degree or honors (e.g., Ph.D., M.D.) type: string minLength: 0 maxLength: 20 fullName: description: Full display name type: string alternateFullName: description: Altername full display name type: string phoneNumber: description: Phone number $ref: '#/components/schemas/phoneNumberType' email: description: Email address $ref: '#/components/schemas/basicEmailType' birthDate: description: Date of birth type: string format: date maxLength: 8 language: description: Language identification. type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' nationality: description: Affiliation or ethnicity to a particular country. $ref: '#/components/schemas/countryNameType' vip: description: The supplier's ranking of the customer (e.g., VIP, numerical ranking). $ref: '#/components/schemas/vIPType' address: description: Address information that is attached to the reservation guest $ref: '#/components/schemas/addressSearchType' anonymization: description: Provides information about the guest's anonymization status $ref: '#/components/schemas/anonymizationType' accompanyGuests: description: List of guest names that are accompanying the reservation guest $ref: '#/components/schemas/resAccompanyGuestListType' externalInfo: description: External information about the guest associated with the reservation. $ref: '#/components/schemas/resGuestExternalInfoType' guestLastStayInfo: description: Contains information regarding the last stay of this guest. $ref: '#/components/schemas/guestLastStayInfoType' guestRestrictedCode: description: Guest profile restricted reason code type: string guestRestrictedReasonDesc: description: Guest profile restricted reason description type: string guestRestricted: description: True indicates there are restrictions associated with the current profile. type: boolean registrationCardNo: description: Unique identifier of the police registration card number. type: string minLength: 0 maxLength: 40 nameType: $ref: '#/components/schemas/nameTypeType' id: description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. type: string minLength: 0 maxLength: 80 type: description: A reference to the type of object defined by the UniqueID element. type: string minLength: 0 maxLength: 40 reservationFolioWindowType: type: object description: Folio window view which holds the set of folios for a reservation. properties: payeeInfo: description: The window's configured payee information. $ref: '#/components/schemas/payeeInfoType' balance: description: Running balance of the window. $ref: '#/components/schemas/currencyAmountType' paymentMethod: description: Payment Method Type type: string minLength: 0 maxLength: 20 folioWindowNo: type: integer defaultPaymentMethodRule: type: object properties: rule: description: Payment method default rule information. $ref: '#/components/schemas/paymentMethodValidationRuleType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' hotelTrxCodesAccessType: type: object description: Transaction Codes associated with particular Hotel properties: transactionCode: description: Transaction Code and Description. Description is for information only and is used for fetch operation. type: array maxItems: 4000 items: $ref: '#/components/schemas/codeDescriptionType' hotelId: description: Hotel Code type: string minLength: 0 maxLength: 20 profileId: type: object description: An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote). properties: url: description: URL that identifies the location associated with the record identified by the UniqueID. type: string type: description: A reference to the type of object defined by the UniqueID element. type: string minLength: 0 maxLength: 20 instance: description: The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated. type: string minLength: 0 maxLength: 80 idContext: description: Used to identify the source of the identifier (e.g., IATA, ABTA). type: string minLength: 0 maxLength: 80 id: description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. type: string minLength: 0 maxLength: 80 idExtension: description: Additional identifying value assigned by the creating system. type: integer reservationId: type: object description: An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote). properties: url: description: URL that identifies the location associated with the record identified by the UniqueID. type: string type: description: A reference to the type of object defined by the UniqueID element. type: string minLength: 0 maxLength: 20 instance: description: The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated. type: string minLength: 0 maxLength: 80 idContext: description: Used to identify the source of the identifier (e.g., IATA, ABTA). type: string minLength: 0 maxLength: 80 id: description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. type: string minLength: 0 maxLength: 80 idExtension: description: Additional identifying value assigned by the creating system. type: integer gUINumberRulesDetails: type: object properties: rules: $ref: '#/components/schemas/gUINumberRules' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' taxBrackets: type: object properties: taxBrackets: description: Collection containing information of tax brackets. $ref: '#/components/schemas/taxBracketsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' templateTransactionGroupsType: type: array description: Template transaction groups. maxItems: 4000 items: $ref: '#/components/schemas/transactionGroupType' numberDescriptionsType: type: array description: Individual number and description. maxItems: 4000 items: $ref: '#/components/schemas/numberDescriptionType' authTransactionCodesType: type: array description: List of Transaction codes info. maxItems: 4000 items: $ref: '#/components/schemas/codeDescriptionType' reservationInterfaceStatusType: type: object description: Hotel Interface Type for a reservation and status of the various services properties: roomExtension: description: Identifier for the room extension type: string minLength: 0 maxLength: 20 hotelInterface: description: Hotel interface information for the reservation $ref: '#/components/schemas/hotelInterfaceType' interfaceRights: description: Contains a list of status/rights for the various services under this interface type: array maxItems: 4000 items: $ref: '#/components/schemas/interfaceRightsStatusType' taxCodeSeqType: type: integer description: Primary Key Sequence. minimum: 1 maximum: 5 addressSearchType: type: object description: Address Details such as city, state, country, postal code etc. properties: cityName: description: City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address). type: string minLength: 0 maxLength: 40 postalCode: description: Post Office Code number. type: string minLength: 0 maxLength: 15 state: description: State or Province name (e.g., Texas). type: string minLength: 0 maxLength: 20 country: description: Country name (e.g., Ireland). $ref: '#/components/schemas/countryNameType' streetAddress: description: First Line of Street Address. For profile search it matches the first Address line. type: string minLength: 0 maxLength: 80 excludeNoCity: description: When true indicates that only profiles with city will be fetched. type: boolean transactionSubgroupType: type: object description: Transaction Subgroup configuration Information. properties: description: description: Description of the Transaction Subgroup. type: string minLength: 0 maxLength: 2000 sequence: description: Display sequence for the code type. type: integer groupDescription: description: Description of the Transaction Group. type: string minLength: 0 maxLength: 2000 code: description: Transaction Subroup Configuration Code. type: string minLength: 0 maxLength: 20 group: description: Transaction Group Configuration Code. type: string minLength: 0 maxLength: 20 newGroup: description: Use this attribute to update the existing group during change operation. type: string minLength: 0 maxLength: 20 type: description: Transaction type to which the corresponding transaction group belongs. This is an information only attribute. $ref: '#/components/schemas/cashieringTransactionTypeType' managedBy: $ref: '#/components/schemas/managedByOptions' commissionPayoutToType: type: string enum: - TravelAgent - Source - TravelAgentSource - None rateCategoryType: type: object description: This type represents the rate category type. properties: rateCategoryDetails: description: Begin date for the rate category. type: object properties: beginDate: description: Begin date for the rate category. type: string format: date maxLength: 8 endDate: description: End date for the rate category. type: string format: date maxLength: 8 description: description: Description of rate category. type: string minLength: 0 maxLength: 200 rateClass: description: Active date of the room category. type: string minLength: 0 maxLength: 20 sellSequence: description: Indicates rate category sell sequence. type: number rateCategory: description: Rate category Code. type: string minLength: 0 maxLength: 20 calculatePostingCharge: type: object description: Corresponds to each charge that will be posted against the transaction code based from the test criteria. properties: hotelId: description: Hotel code of the associated transaction code. type: string minLength: 0 maxLength: 20 transactionCode: description: The associated transaction code of the posting. type: string minLength: 0 maxLength: 20 description: description: Description of the transaction code. type: string minLength: 0 maxLength: 2000 level: description: Defines the level from which the transaction generates was created. $ref: '#/components/schemas/generateLevelType' amount: description: The amount that will be posted against the transaction code. type: number formula: description: The formula that is used to calculate the generates. type: string minLength: 0 maxLength: 2000 bucket: description: The amount that will be posted for each bucket. $ref: '#/components/schemas/postingBucket' sequence: description: The order in which the charge will be posted. The base posting will always be 0 (zero) followed by generates associated in order of which they were created. type: integer basePosting: description: Indicates whether it is the base posting. type: boolean compTrxInfoType: type: object description: Transaction codes info. properties: description: description: Transaction codes info. type: string minLength: 0 maxLength: 2000 transactionCode: description: Unique identifier for the Transaction code. type: string minLength: 0 maxLength: 20 packageArrangementCodes: type: object properties: packageArrangementCodes: description: Collection of package arrangement codes. $ref: '#/components/schemas/packageArrangementCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' routingInstructions: type: object properties: routingInstructions: description: Collection of routing instructions fetched. $ref: '#/components/schemas/configRoutingInstructionsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' adjustmentCodeType: type: object description: Provides information about Adjustment Codes. properties: hotelId: description: Code of the Hotel. type: string minLength: 0 maxLength: 20 code: description: Adjustment Reason Code type: string minLength: 0 maxLength: 20 codeType: description: Correction type. e.g. ADJ for adjustment, COR for correction, DEL for deletion. $ref: '#/components/schemas/adjustmentReasonCodeType' description: description: Adjustment Reason Description type: string minLength: 0 maxLength: 2000 amount: description: Amount or Percentage Value for Adjustment Code $ref: '#/components/schemas/currencyAmountType' bIRGuest: description: BIR Guest Type in Adjustment Codes. type: string minLength: 0 maxLength: 2000 amountOrPercentageFlag: description: Adjustment Code Calculation Type, valid values are Amount and Percentage. $ref: '#/components/schemas/amountOrPercentage' managedBy: $ref: '#/components/schemas/managedByOptions' cardTypeType: type: string description: This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method. enum: - Ab - Am - Ax - Cb - Dc - Ds - Dt - Ec - Er - Jc - Jl - Mc - Nb - So - St - Sw - Va - Xy - Zz - Cp - Cu cardRangeType: type: object description: Card number start and end range. properties: from: description: Starting range of the card. type: string minLength: 0 maxLength: 50 to: description: End range of the card. type: string minLength: 0 maxLength: 50 futurePastExchangeRates: type: array description: Collection of exchange rates and their information. maxItems: 4000 items: $ref: '#/components/schemas/exchangeRateType' exchangeRateType: type: object description: Exchange rate configuration type. properties: hotelId: description: Property where exchange rate is set. type: string minLength: 0 maxLength: 20 exchangeType: description: Type for exchange calculation. type: array maxItems: 4000 items: $ref: '#/components/schemas/currencyExchangeType' currency: description: Currency code. $ref: '#/components/schemas/codeDescriptionType' baseCurrency: description: Exchange rate base currency. $ref: '#/components/schemas/codeDescriptionType' beginDate: description: Date on which the rate is to become active. type: string format: date-time buyRate: description: Buy Rate for foreign currency. type: number buyCommission: description: Percentage of the amount that is to be a commission for the currency buy operation. type: number sellRate: description: Sell Rate for foreign currency. type: number sellCommission: description: Percentage of the amount that is to be a commission for the currency sell operation. type: number comment: description: Comments associated with the exchange rate. type: string status: description: Status past, present, or future. $ref: '#/components/schemas/statusTypes' reservationFolioWindowsType: type: array description: Collection of reservation folio windows. maxItems: 4000 items: $ref: '#/components/schemas/reservationFolioWindowType' taxTypesGenerateType: type: array description: Defines the Calculation Rule for the Tax Type for a specific date schedule maxItems: 4000 items: $ref: '#/components/schemas/taxTypeGenerateType' cashierNumber: type: object properties: cashierId: $ref: '#/components/schemas/cashierId' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' monthlyTransactionInfoType: type: object description: Holds monthly Revenue summary information properties: month: description: Month number type: integer revenue: description: Revenue information for a month. type: number cardRangesType: type: array description: Card number start and end range. maxItems: 4000 items: $ref: '#/components/schemas/cardRangeType' resAccessRestrictionType: type: string description: Indicates any Updates/Changes on the reservation as well as Reservation Cancellation are not allowed. enum: - Change - Cancel - ChangeOrCancel transactionArrangementCodes: type: object properties: transactionArrangementCodes: description: Collection of transaction code with associated arrangement codes. $ref: '#/components/schemas/transactionArrangementCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' commentInfoType: type: object description: Comment related to the profile/reservation. properties: comment: description: Comment details for the comment. It will be empty in case of delete comment. $ref: '#/components/schemas/commentType' createDateTime: description: Time stamp of the creation. type: string format: date-time creatorId: description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation. type: string minLength: 0 maxLength: 200 lastModifyDateTime: description: Time stamp of last modification. type: string format: date-time lastModifierId: description: Identifies the last software system or person to modify a record. type: string minLength: 0 maxLength: 200 purgeDate: description: Date an item will be purged from a database (e.g., from a live database to an archive). type: string format: date maxLength: 8 id: description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. type: string minLength: 0 maxLength: 80 type: description: A reference to the type of object defined by the UniqueID element. type: string minLength: 0 maxLength: 40 reservationIdList: type: array description: Unique Id that references an object uniquely in the system. maxItems: 4000 items: $ref: '#/components/schemas/uniqueID_Type' budgetForecastInformationBaseType: type: object description: Holds budget forecast information for included segment types. properties: marketSegmentInformation: description: Holds budget forecast information for MarketCode segment. $ref: '#/components/schemas/budgetForecastMarketInfoBaseType' rateSegmentInformation: description: Holds budget forecast information for RateCode segment. $ref: '#/components/schemas/budgetForecastRateInfoBaseType' customSegmentInformation: description: Holds budget forecast information for Custom Code segment. $ref: '#/components/schemas/budgetForecastCustomInfoBaseType' transactionSegmentInformation: description: Holds budget forecast information for Transaction Code segment. $ref: '#/components/schemas/budgetForecastTransactionInfoBaseType' cateringSegmentInformation: description: Holds budget forecast information for Catering Code segment. $ref: '#/components/schemas/budgetForecastCateringInfoBaseType' hotelId: description: Opera Hotel code for the Fetch Revenue information. type: string minLength: 0 maxLength: 20 year: description: Year of revenue to be fetched. type: string minLength: 4 maxLength: 4 hotelConsumableInventoryItemType: type: object properties: hotelId: description: Indicates the hotel to which the consumable inventory applies to. type: string minLength: 1 maxLength: 20 itemGroup: description: Indicates the Cosumable Inventory group $ref: '#/components/schemas/consumableInventoryItemGroupType' itemCode: description: Indicates the code on which consumable inventory is configured type: string minLength: 1 maxLength: 20 itemDescription: description: Indicates the description of the item code type: string minLength: 1 maxLength: 2000 parQuantity: description: Minimum quantity to be maintained of the consumable item type: integer minimum: 1 maximum: 999999 orderSequence: description: Display Order sequence. type: integer minimum: 1 maximum: 9999 itemId: description: Unique Id of the consumable inventory item. type: integer inactive: description: Indicates whether the consumable item is inactive or not. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' required: - hotelId - itemGroup - itemCode - parQuantity customNumberTemplateConfigurationType: type: object description: Custom number configuration details. properties: code: description: Custom number configuration code. type: string minLength: 0 maxLength: 20 description: description: The description of the custom number configuration code. type: string minLength: 0 maxLength: 2000 area: description: The area where this custom number will be used. $ref: '#/components/schemas/customNumberConfigurationAreaType' formula: description: The formula to generate the custom number. type: string minLength: 0 maxLength: 2000 condition: description: The condition to be met to generate and apply the custom number. type: string minLength: 0 maxLength: 2000 timeSpan: description: The begin and end date of the custom number configuration. $ref: '#/components/schemas/timeSpanType' inActive: description: Indicator that tells whether the configuration is active or not. type: boolean orderSequence: description: Display Order sequence. type: number managedBy: $ref: '#/components/schemas/managedByOptions' queueTextInfoType: type: object description: Information regarding the message sent to guest. properties: sentTime: description: Time the text was last sent to the user. type: string format: date-time sentBy: description: User name of the user who sent message. type: string minLength: 0 maxLength: 40 thresholdDetailsType: type: object description: Type for the threshold elements. properties: entity: description: Diversion entity type associated with the charge for the transaction diversion rule . $ref: '#/components/schemas/entityType' scope: description: Diversion scope for the transaction diversion rule. $ref: '#/components/schemas/scopeType' minRequired: description: Minimum required number of quantities, counts or minutes that must be posted. type: integer complimentary: description: The number of quantities, counts or minutes for which transaction diversion is allowed . type: integer isEditable: description: Configuring this flag to be TRUE will make the thresholds editable. type: boolean hotelTransactionGenerates: type: object properties: transactionGenerates: description: Transaction generates to be created. $ref: '#/components/schemas/hotelTransactionGeneratesSetupType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' folioArrangementCodes: type: object properties: folioArrangementCodes: description: Collection of folio arrangement codes. $ref: '#/components/schemas/folioArrangementCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' budgetForecastTransactionInfoType: type: object description: Budget Forecast information for budget Transaction codes. properties: transactionCodeInformation: description: Budget Forecast information for Transaction segment code . type: array maxItems: 4000 items: $ref: '#/components/schemas/transactionCodeInformationType' transactionCodeTotalsInformation: description: Budget Forecast information for Transaction segment code . $ref: '#/components/schemas/transactionCodeTotalsInformationType' folioPrintQueues: type: object properties: folioPrintQueues: $ref: '#/components/schemas/folioPrintQueuesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' aRAccountShortInfoType: type: object description: Accounts Receivabales Account details type charged for batched posting. properties: accountName: description: Name of the AR Account. type: string minLength: 0 maxLength: 200 accountId: description: The unique ID for the Account. $ref: '#/components/schemas/uniqueID_Type' accountNo: description: The Account Number for the Account. type: string minLength: 0 maxLength: 20 status: description: The status of the account. $ref: '#/components/schemas/aRAccountStatusType' customNumberTemplateConfigurationListType: type: array description: Details about template custom number configuration. maxItems: 4000 items: $ref: '#/components/schemas/customNumberTemplateConfigurationType' hotelTransactionCode: type: object properties: transactionCode: description: Detailed information regarding transaction code. $ref: '#/components/schemas/hotelTransactionCodeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' budgetForecastInformationType: type: object description: Holds budget forecast information for included segment types. properties: marketSegmentInformation: description: Holds budget forecast information for MarketCode segment. $ref: '#/components/schemas/budgetForecastMarketInfoType' rateSegmentInformation: description: Holds budget forecast information for RateCode segment. $ref: '#/components/schemas/budgetForecastRateInfoType' customSegmentInformation: description: Holds budget forecast information for Custom Code segment. $ref: '#/components/schemas/budgetForecastCustomInfoType' transactionSegmentInformation: description: Holds budget forecast information for Transaction Code segment. $ref: '#/components/schemas/budgetForecastTransactionInfoType' cateringSegmentInformation: description: Holds budget forecast information for Catering Code segment. $ref: '#/components/schemas/budgetForecastCateringInfoType' templateTransactionCodesType: type: array description: Template transaction code configuration details. maxItems: 4000 items: $ref: '#/components/schemas/templateTransactionCodeType' cashierInfoType: type: object description: Cashier information. Contains Id and Name details of the cashier. properties: cashierId: description: Cashier Id of the Cashier. type: number cashierName: description: Cashier Name. type: string minLength: 0 maxLength: 2000 reservationTurndownInfoType: type: object description: Turndown information for a reservation properties: allowed: description: Indicates if turndown is allowed or not type: boolean status: description: Indicates turndown status, values could be required, not required, completed $ref: '#/components/schemas/turndownStatusType' folioCopyLegend: type: object properties: criteria: description: Criteria to fetch folio copy legends description $ref: '#/components/schemas/folioCopyLegendType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' copyTransactionDiscountsType: type: object description: Copy instructions for transaction discount codes. properties: sourceHotelCode: description: Source hotel code from where transaction discount code(s) have to be copied. type: string minLength: 0 maxLength: 20 copyTransactionDiscountsInfo: description: Provides information about the target hotel code where the source transaction discount code will be copied to, what the transaction discount code will be named under the target hotel code and the description of the transaction discount code under the target hotel code. type: array maxItems: 4000 items: $ref: '#/components/schemas/copyTransactionDiscountsInfoType' generateType: type: object description: Defines the Generate and its Calculation Rules properties: generateId: description: Unique ID of the Generate. $ref: '#/components/schemas/uniqueID_Type' rule: description: Defines percentage rule for generates. $ref: '#/components/schemas/generateCalcRuleType' addGeneratedAmtTo: description: Defines the buckets the generated amount will be added to. $ref: '#/components/schemas/generateCalculationBucketsType' level: description: Defines the level from which the generates was created. $ref: '#/components/schemas/generateLevelType' code: description: Code. type: string minLength: 0 maxLength: 20 description: description: description. type: string minLength: 0 maxLength: 2000 resProfileTypeType: type: string enum: - Guest - Company - Group - TravelAgent - Source - ReservationContact - BillingContact - Addressee postingRuleType: type: string description: Simple Type for Posting Rule Types. enum: - AllNights - DepositOnly - FirstNight budgetForecastCustomInfoBaseType: type: object description: Budget Forecast information for budget Custom codes. properties: customCodeInformation: description: Budget Forecast information for Custom segment code . type: array maxItems: 4000 items: $ref: '#/components/schemas/customCodeInformationBaseType' customValue: description: Flag to indicate if values information has to be included. type: boolean codeListType: type: array maxItems: 4000 items: type: string minLength: 0 maxLength: 20 hotelTransactionSubgroups: type: object properties: transactionSubgroups: description: Collection of Transaction Subgroups Configuration. $ref: '#/components/schemas/hotelTransactionSubgroupsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' routingInstructionsCopy: type: object properties: routingInstructions: type: array description: List of the routing instructions to be copied to hotel code(s). items: $ref: '#/components/schemas/copyConfigurationCodeType' compRouting: description: Indicates whether the routing instructions to be copied are comp routing codes or not. type: boolean links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' fiscalPeriodsEditType: type: array description: List of Fiscal Periods. maxItems: 4000 items: $ref: '#/components/schemas/fiscalPeriodEditType' roomTypeBasedChargeRangesType: type: object description: Provides information about Room Type Based Charge Ranges. properties: hotelId: description: Code of the Hotel. type: string minLength: 0 maxLength: 20 transactionNo: description: Transaction number, Unique Identifier of the record. type: number transactionCode: description: Transaction code. type: string minLength: 0 maxLength: 20 generateTrxCode: description: Generate of the Main Transaction code. type: string minLength: 0 maxLength: 20 roomTypeGroup: description: Room Type Group Code. type: string minLength: 0 maxLength: 20 startDate: description: Start Date for Room Type Based Charge Range. type: string format: date endDate: description: End Date for Room Type Based Charge Range. type: string format: date amount: description: Amount of the Room Type Group Based Range. type: number budgetForecastInformationBase: type: object properties: budgetForecastInformation: description: Search criteria for budget forecast information. $ref: '#/components/schemas/budgetForecastInformationBaseType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' transactionCodeAccessRoles: type: object properties: transactionAccessRoles: description: Collection of User roles and their information $ref: '#/components/schemas/trxCodeAccessRolesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' customChargeExemptionsConfigType: type: array description: Holds Exemption details. maxItems: 4000 items: $ref: '#/components/schemas/customChargeExemptionConfigType' fiscalPartnersDetails: type: object description: Response object for fetching Fiscal Partners. properties: fiscalPartners: $ref: '#/components/schemas/fiscalPartnersType' warnings: $ref: '#/components/schemas/warningsType' customValueInfoType: type: object description: Value information for a CUSTOM segment code. Holds total and monthly Value information. properties: totalValue: description: Total Value for CUSTOM segment code. type: number monthlyValueInfo: description: Value information for each month for CUSTOM segment code. type: array maxItems: 12 items: $ref: '#/components/schemas/monthlyValueInfoType' compAuthorizerDetailType: type: object description: Detail information related to comp authorizers. properties: arrangementCode: description: Arrangement code for the detail limit. type: string minLength: 0 maxLength: 50 arrangementId: description: Arrangement id for the arrangement code. type: integer transactionCode: description: Transaction code for the detail limit. type: string minLength: 0 maxLength: 50 description: description: Description for the transaction code or the arrangement code. type: string minLength: 0 maxLength: 2000 authorizationGroup: description: Authorization group for the instruction. type: string minLength: 0 maxLength: 50 rateCode: description: Rate code for the instruction. type: string minLength: 0 maxLength: 50 compAuthorizersType: type: array description: Information associated for an authorizer. maxItems: 4000 items: $ref: '#/components/schemas/compAuthorizerType' fiscalPartnerCodeType: type: string description: Used for fiscal partner codes. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X. maxLength: 100 minLength: 0 compBucketRedemptionConfig: type: object description: Request object for creating new Comp Bucket Redemption Codes configurations. properties: bucketRedemptionCodes: description: Bucket Redemption Codes Configurations to be created. $ref: '#/components/schemas/bucketRedemptionCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' commentType: type: object description: An indication of a new paragraph for a sub-section of a formatted text message. properties: text: description: Formatted text content. $ref: '#/components/schemas/formattedTextTextType' image: description: An image for this paragraph. type: string url: description: A URL for this paragraph. type: string commentTitle: description: Specifies Comment's Title. type: string minLength: 0 maxLength: 4000 notificationLocation: description: Notification Location associated with the Note. type: string minLength: 0 maxLength: 20 type: description: Specifies type of the comment. type: string minLength: 0 maxLength: 20 typeDescription: description: Comment type Description. type: string minLength: 0 maxLength: 200 internal: description: When true, the comment may not be shown to the consumer. When false, the comment may be shown to the consumer. type: boolean confidential: description: When true, the comment may be confidential. type: boolean overrideInternal: description: When true, the note internal could be modified. type: boolean protectDescription: description: When true, the note title will be populated from the note type description and couldn't be modified. type: boolean hotelId: description: If specified comment belongs to the Hotel, otherwise it is a global comment. type: string minLength: 0 maxLength: 20 actionType: description: Specifies type of action described in the comments. type: string minLength: 0 maxLength: 20 actionDate: description: Indicates at which date an action described in the comment must be taken. type: string format: date maxLength: 8 createDateTime: description: Time stamp of the creation. type: string format: date-time creatorId: description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation. type: string minLength: 0 maxLength: 200 lastModifyDateTime: description: Time stamp of last modification. type: string format: date-time lastModifierId: description: Identifies the last software system or person to modify a record. type: string minLength: 0 maxLength: 200 purgeDate: description: Date an item will be purged from a database (e.g., from a live database to an archive). type: string format: date maxLength: 8 hotelTransactionSubgroup: type: object properties: transactionSubgroup: description: Detailed information regarding transaction subgroup. $ref: '#/components/schemas/hotelTransactionSubgroupType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' folioArrangementCodesType: type: array description: Details for folio arrangement code along with associated transaction codes. maxItems: 4000 items: $ref: '#/components/schemas/folioArrangementCodeType' functionArgumentType: type: object description: This type provided details of a function argument and the value it holds. properties: name: description: Specifies the name of the function argument. type: string minLength: 0 maxLength: 200 value: description: Specifies the value held by the function argument. type: string minLength: 0 maxLength: 200 position: description: Specifies the position of the function argument in the argument list. type: integer dataType: description: Specifies the datatype of the function argument. type: string minLength: 0 maxLength: 40 required: description: Argument of the function mandatory or not. type: boolean hotelTransactionSubgroupsType: type: array description: Hotel's Transaction Subgroup configuration. maxItems: 4000 items: $ref: '#/components/schemas/hotelTransactionSubgroupType' taxTypesGenerate: type: object properties: taxTypes: description: Tax types fetched. $ref: '#/components/schemas/taxTypesGenerateType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' aRBalanceType: type: object description: Balance information for AR. properties: debit: description: Debit Balance amount. The amount owed by the Account. $ref: '#/components/schemas/currencyAmountType' credit: description: The credit Balance amount. Any payment that is Unallocated i.e not applied against an invoice, is included in this. $ref: '#/components/schemas/currencyAmountType' total: description: The total balance i.e Debit minus Credit amounts. $ref: '#/components/schemas/currencyAmountType' customNumberConfigurationListType: type: array description: Details about custom number configuration. maxItems: 4000 items: $ref: '#/components/schemas/customNumberConfigurationType' profileInfoType: type: object description: Provides information about attached profiles to the block. properties: profileId: description: Opera ID for the profile attached to the block. $ref: '#/components/schemas/uniqueID_Type' name: description: Name for the profile attached to the block. type: string minLength: 0 maxLength: 200 city: description: City for the profile attached to the block. type: string minLength: 0 maxLength: 80 phone: description: Phone for the profile attached to the block. type: string minLength: 0 maxLength: 80 type: description: Defines the type of Linked profiles for a block. type: string minLength: 0 maxLength: 20 articlePostItType: type: object description: Post it information of an article. properties: availableForPostIt: description: Indicates whether the article is available for post it. type: boolean color: description: Color indicator which is only configurable if article is available for post it. $ref: '#/components/schemas/colorType' nameTypeType: type: string enum: - Guest - Company - Agent - Contact - Source - Group - Employee - Hotel - Purge membershipInfoType: type: object description: The Membership object identifies the frequent customer reward program. properties: membershipId: description: Membership ID (Unique ID from the memberships table). type: number programCode: description: The code or name of the membership program ('Hertz', 'AAdvantage', etc.). type: string minLength: 0 maxLength: 20 bonusCode: description: The code or name of the bonus program. BonusCode can be used to indicate the level of membership (Gold Club, Platinum member, etc.) type: string minLength: 0 maxLength: 20 membershipTypeDesc: description: The description of the ProgramCode.(Delta Previlige for code DP) type: string minLength: 0 maxLength: 2000 membershipLevelDesc: description: The description of the Bonus Code.(Platinum for code P) type: string minLength: 0 maxLength: 2000 accountId: description: The account identification number for this particular member in this particular program. type: string minLength: 0 maxLength: 50 membershipLevel: description: The code or name of the membership level and indicates the level of membership (Gold Club, Platinum member, etc.). This is same as the BonusCode. type: string minLength: 0 maxLength: 20 playerRanking: description: Ranking assigned to the Player Profile by the Gaming system. type: integer expenseArrangementCodesCopy: type: object properties: expenseArrangementCode: type: array description: List of the expense arrangement codes to be copied. items: $ref: '#/components/schemas/copyConfigurationCodeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' paymentMethodTransactionInfoType: type: object description: Provides information about the transactions including the transaction code, group, subgroup and the posting amount. properties: description: type: string minLength: 0 maxLength: 2000 postingAmount: $ref: '#/components/schemas/postingAmountType' surcharge: description: Surcharge information regarding the payment method. $ref: '#/components/schemas/surchargeType' transactionCode: type: string minLength: 0 maxLength: 20 transactionGroup: type: string minLength: 0 maxLength: 20 transactionSubGroup: type: string minLength: 0 maxLength: 20 transactionDisplay: type: string minLength: 0 maxLength: 8 transactionDiscountType: type: string description: The type on which the transaction discount is based. e.g MembershipType , MembershipLevel enum: - MembershipType - MembershipLevel payeeInfoType: type: object description: Payee information. properties: payeeId: description: Opera name id of the payee. $ref: '#/components/schemas/uniqueID_Type' payeeName: description: Name of the payee. type: string minLength: 0 maxLength: 80 payeeAddress: description: Address of the payee. $ref: '#/components/schemas/addressInfoType' payeeAddressCount: description: Payee multiple address count. type: integer payeeReferenceCurrency: description: Reference currency of the payee. type: string minLength: 0 maxLength: 20 payeeAccountInfo: description: AR account short info of the payee. $ref: '#/components/schemas/aRAccountShortInfoType' payeeTaxNumber: description: The tax number of the payee. type: string minLength: 0 maxLength: 40 blockIdList: type: array description: Unique Id that references an object uniquely in the system. maxItems: 4000 items: $ref: '#/components/schemas/uniqueID_Type' configRoutingInstructionType: type: object description: '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 Cashiering>Routing Limits application function is set to Y.' properties: description: description: Description of the trx code arrangement code. type: string minLength: 0 maxLength: 2000 transactionCodes: description: Collection of transaction codes which form the trx code arrangement. $ref: '#/components/schemas/trxCodesInfoType' code: description: Code is used to identify a trx code arrangement. type: string minLength: 0 maxLength: 20 hotelId: description: Identifies the hotel code for which the trx code arrangement is specified. type: string minLength: 0 maxLength: 20 covers: description: Number of covers for this routing instruction. Null means no value has been specified. type: number limit: description: Allowable credit amount for this routing instruction. Null means no value has been specified. type: number percent: description: The routing limit percentage allowed for this routing instruction. Null means no value has been specified. type: number daysOfWeek: description: The selected days of the week indicate the days which will be selected on the Routing Instructions screen when this routing code is chosen for the routing instructions. $ref: '#/components/schemas/timeSpanDaysOfWeekType' daily: description: Signifies whether a separate routing instruction has to be generated for each day of the stay. type: boolean inheritAuthRateCode: description: Reservation to inherit Rate Code from Authorizer. type: boolean compAccounting: description: Determines if this is a comp routing code or a routing code. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' collectingAgentTaxType: type: object description: Type which holds Collecting Agent Taxes primary details. properties: hotelId: description: It represents Hotel code type: string minLength: 0 maxLength: 20 taxCode: description: Primary Key Sequence $ref: '#/components/schemas/taxCodeSeqType' taxType: description: Tax Type for which tax is applicable. $ref: '#/components/schemas/codeListType' taxTransactionCode: description: The Transaction Code used to post the Taxes. type: string minLength: 0 maxLength: 20 percentage: description: Percentage used to calculate the Taxes type: integer triggerAmount: description: Minimum Net amount (gross minus taxes) that the folio has to reach to apply the Tax. $ref: '#/components/schemas/currencyAmountType' taxVoid: description: Indicates the Collecting Agent Tax that cannot be combined with this Tax. When this Tax is calculated then the Tax for the TaxVoid sequence will not be calculated. $ref: '#/components/schemas/taxCodeSeqType' newTaxType: description: New Tax Type for which tax is applicable. $ref: '#/components/schemas/codeListType' calculatedOnTransactionCodes: description: Collection of Transaction Codes based on which the Collecting Agent Tax will be calculated. type: array maxItems: 4000 items: $ref: '#/components/schemas/codeDescriptionType' calculatedOnArrangementCodes: description: Collection of Arrangement Codes based on which the Collecting Agent Tax will be calculated. type: array maxItems: 4000 items: $ref: '#/components/schemas/codeDescriptionType' managedBy: $ref: '#/components/schemas/managedByOptions' resMobileNotificationsType: type: object description: Contains the status of Room Ready and Key Ready messages. properties: roomReady: description: Denotes the status of Room Ready message. It can have one of the values:PENDING, COMPLETED or FAILED $ref: '#/components/schemas/communicationStatusType' keyReady: description: Denotes the status of Key Ready message. It can have one of the values:PENDING, COMPLETED or FAILED $ref: '#/components/schemas/communicationStatusType' checkoutMessageReceived: description: Indicates if the Mobile checkout message is received. type: boolean requiresAction: description: Indicates if user action is required. The action could be for sending Room Ready or Key Ready Notification. It could also be for initiating Checkout type: boolean errorMessage: description: Error message when Mobile Notification has failed. type: string sourceOfSaleType: type: object description: Point of Sale of reservation. Identifies the entity/channel who made the reservation. properties: sourceType: description: Type of entity/channel who made the reservation.. type: string minLength: 0 maxLength: 40 sourceCode: description: The entity/channel who made the reservation. type: string minLength: 0 maxLength: 20 roomClassCodeInfoType: type: object description: Code of the room class type. properties: roomClassCode: type: string minLength: 0 maxLength: 20 hotelId: type: string minLength: 0 maxLength: 20 description: type: string minLength: 0 maxLength: 2000 calculatePointsType: type: string description: Defines when the points are to be calculated. enum: - Always - Prompt - Never budgetForecastMarketInfoBaseType: type: object description: Budget Forecast information for budget segment codes. properties: marketCodeInformation: description: Budget Forecast information for budget segment code . type: array maxItems: 4000 items: $ref: '#/components/schemas/marketCodeInformationBaseType' revenue: description: Flag to indicate if revenue information is included. type: boolean nights: description: Flag to indicate if nights information is included. type: boolean templateTransactionSubgroupsType: type: array description: Template transaction subgroup configurations. maxItems: 4000 items: $ref: '#/components/schemas/transactionSubgroupType' cashiersDetails: type: object properties: cashiers: description: Lists of cashiers and their information. $ref: '#/components/schemas/cashiersType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. type: integer limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' fiscalYears: type: object properties: fiscalYears: description: Collection of Fiscal Years $ref: '#/components/schemas/fiscalYearsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' changeFiscalPartners: type: object description: Request object to edit Fiscal Partners. properties: fiscalPartners: description: Change existing Fiscal Partners. $ref: '#/components/schemas/fiscalPartnersType' warnings: $ref: '#/components/schemas/warningsType' statusTypes: type: string description: Defines status in terms of time. enum: - Future - Current - Past revenueTypeMapping: type: object properties: revenueTypeMapping: description: Revenue type mapping to be changed. $ref: '#/components/schemas/revenueTypeMappingType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' currencyExchangeServiceTaxes: type: object properties: currencyExchangeServiceTaxes: $ref: '#/components/schemas/currencyExchangeServiceTaxesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' guestLastStayInfoType: type: object description: Contains last stay related details of the guest. properties: lastStayDate: description: Guest's last stay date. type: string format: date maxLength: 8 lastStayRoom: description: Room Number where the guest stayed. type: string minLength: 0 maxLength: 20 lastStayRate: description: The Rate amount of the guest's last stay. $ref: '#/components/schemas/currencyAmountType' totalStay: description: The total number of previous stay of the guest. type: integer vouchersConfigCopy: type: object properties: membershipTypes: type: array description: List of the Membership Types of Vouchers Config to be copied. items: $ref: '#/components/schemas/copyConfigurationCodeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' emailInfoType: type: object description: Information on an email for the customer. properties: email: description: eMail deatils for the profile. $ref: '#/components/schemas/emailType' id: description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. type: string minLength: 0 maxLength: 80 type: description: A reference to the type of object defined by the UniqueID element. type: string minLength: 0 maxLength: 40 hotelTransactionCodes: type: object properties: transactionCodes: description: Collection of hotel's transaction codes summary. $ref: '#/components/schemas/hotelTransactionCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' budgetForecastInformation: type: object properties: budgetForecastInformation: description: Budget forecast information for segment codes. $ref: '#/components/schemas/budgetForecastInformationType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' warningType: type: object description: Used when a message has been successfully processed to report any warnings or business errors that occurred. properties: value: type: string description: Property Value shortText: description: An abbreviated version of the error in textual format. type: string maxLength: 2000 code: description: If present, this refers to a table of coded values exchanged between applications to identify errors or warnings. type: string minLength: 0 maxLength: 20 docURL: description: If present, this URL refers to an online description of the error that occurred. type: string maxLength: 2000 status: description: If present, recommended values are those enumerated in the ErrorRS, (NotProcessed Incomplete Complete Unknown) however, the data type is designated as string data, recognizing that trading partners may identify additional status conditions not included in the enumeration. type: string maxLength: 2000 tag: description: If present, this attribute may identify an unknown or misspelled tag that caused an error in processing. It is recommended that the Tag attribute use XPath notation to identify the location of a tag in the event that more than one tag of the same name is present in the document. Alternatively, the tag name alone can be used to identify missing data [Type=ReqFieldMissing]. type: string maxLength: 2000 recordId: description: If present, this attribute allows for batch processing and the identification of the record that failed amongst a group of records. This value may contain a concatenation of a unique failed transaction ID with specific record(s) associated with that transaction. type: string maxLength: 2000 type: description: The Warning element MUST contain the Type attribute that uses a recommended set of values to indicate the warning type. The validating XSD can expect to accept values that it has NOT been explicitly coded for and process them by using Type ="Unknown". type: string minLength: 0 maxLength: 20 language: description: Language identification. type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' rph: description: Reference Place Holder used as an index for this warning. type: string minLength: 1 maxLength: 8 facilityCodesType: type: array description: List of the facility codes. maxItems: 4000 items: $ref: '#/components/schemas/facilityCodeType' customNumberType: type: string description: Custom number minLength: 0 maxLength: 200 copyTransactionDiscountsInfoType: type: object description: 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 copied. Details include source transaction discount code to be copied, the hotel code where the transaction discount code will be copied to, the name and description with which the transaction discount code will be copied under the target hotel code. properties: sourceTransactionDiscountCode: description: Source transaction discount code to be copied. type: string minLength: 0 maxLength: 20 targetHotelCode: description: Target hotel code where the transaction discount code will be copied to. type: string minLength: 0 maxLength: 20 copyAs: description: The code and description to be used for the transaction discount code being copied under the target hotel code. $ref: '#/components/schemas/codeDescriptionType' articlesType: type: array description: Holds collection of articles. maxItems: 4000 items: $ref: '#/components/schemas/articleInfoType' collectingAgentTaxes: type: object properties: collectingAgentTaxes: description: Collection of Collecting Agent Taxes details. $ref: '#/components/schemas/collectingAgentTaxesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' resCompAccountingType: type: object description: Information regarding comp accounting on the reservation. properties: compType: description: Code used to identify the casino comp type and ranking of a guest. type: string minLength: 0 maxLength: 20 authorizer: description: ID of the employee who will act as the host for this guest. type: string minLength: 0 maxLength: 40 compPostings: description: Indicates if the Comp Billing/posting Exist type: string minLength: 0 maxLength: 5 translationTextType2000: type: object description: Contains Multiple translated texts and language codes. properties: defaultText: description: Default text with Character length from 0 to 2000. type: string minLength: 0 maxLength: 2000 translatedTexts: description: List of translated text and language codes. $ref: '#/components/schemas/translationsTextType' yearTypeType: type: string description: Defined Values for Fiscal Year Type. enum: - Calendar - Fiscal generatesType: type: array description: Defines the Generate and its Calculation Rules. maxItems: 4000 items: $ref: '#/components/schemas/generateType' customNumberConfiguration: type: object description: Request object to create custom number configuration. properties: customNumberConfiguration: description: Custom number configuration to be created. $ref: '#/components/schemas/customNumberConfigurationType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' amountOrPercentage: type: string description: Adjustment Code calculation type based on details. enum: - Amount - Percent folioReportsType: type: array description: Information details of the Folio Reports associated with Folio Type Name. maxItems: 4000 items: $ref: '#/components/schemas/folioReportType' authorizerGroupsType: type: array description: Authorizer Group maxItems: 4000 items: $ref: '#/components/schemas/authorizerGroupType' searchCompAuthorizersRequest: type: object properties: includeCompAuthorizerDetails: type: boolean description: Configuring this flag to be TRUE will return the details of the comp authorizers. x-example: false includeInactiveAuthorizers: type: boolean description: Configuring this flag to be TRUE will return also the inactive authorizers. x-example: false includeTerminatedAuthorizers: type: boolean description: Configuring this flag to be TRUE will return the terminated authorizers. x-example: false authorizer: type: string description: User ID for the authorizer. firstName: type: string description: First name for the authorizer. lastName: type: string description: Last name for the authorizer. externalUserId: type: string description: External Id for the authorizer. authorizerId: type: string description: Id for the authorizer. authorizerName: type: string description: Name for the authorizer. limit: type: integer description: Indicates maximum number of records a Web Service should return. offset: type: integer description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. default: 0 resAttachedProfileType: type: object properties: name: description: Attached profile name type: string profileIdList: description: Collection of unique profile identifiers $ref: '#/components/schemas/profileIdList' reservationProfileType: $ref: '#/components/schemas/resProfileTypeType' consumableItemType: type: object properties: consumableInventory: description: Collection of Consumable Inventory Configurations. type: object $ref: '#/components/schemas/hotelConsumableInventoryItemType' transactionGroup: type: object properties: transactionGroup: description: Detailed transaction group configuration. $ref: '#/components/schemas/hotelTransactionGroupType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' voucherType: type: object description: Voucher details. properties: voucherId: description: Unique internal ID of the voucher type: integer minLength: 0 maxLength: 20 membershipType: description: Membership type type: string minLength: 0 maxLength: 40 membershipLevel: description: Membership level type: string minLength: 0 maxLength: 40 startDate: description: Start date type: string format: date minLength: 0 maxLength: 40 endDate: description: End date type: string format: date minLength: 0 maxLength: 40 amount: description: Voucher amount type: number format: double minimum: 0 hotelId: description: Unique ID of the hotel in OPERA type: string minLength: 0 maxLength: 40 managedBy: $ref: '#/components/schemas/managedByOptions' customCodeInformationBaseType: type: object description: Budget Forecast information for Custom segment code. properties: customCode: description: Custom code for which budget forecast information is fetched. type: string minLength: 0 maxLength: 20 customCodeDescription: description: Custom code description for Custom code. type: string budgetValueInfo: description: Budget Value information for a Custom code. $ref: '#/components/schemas/customValueInfoType' forecastValueInfo: description: Forecast Value information for a Custom code. $ref: '#/components/schemas/customValueInfoType' taxTypeType: type: object description: Provides information about the Tax Type. properties: hotelId: description: Code of the Hotel. type: string minLength: 0 maxLength: 20 code: description: Code of the Tax Type. type: string minLength: 0 maxLength: 20 description: description: Description of the Tax Type. type: string minLength: 0 maxLength: 2000 collectingAgentTax: description: A boolean flag for Collecting Agent Tax type: boolean printAutoAdjust: description: Print auto adjust information for this tax type on the tax exempt report. type: boolean reportExemptDays: description: Number of days after which the guest will be tax exempt. Only used for tax exempt report. type: integer reportTaxPercentage: description: Tax percentage. Only used for tax exempt report. type: number minimum: 0 maximum: 100 minimumLengthOfStay: description: Minimun Length of Stay. type: integer managedBy: $ref: '#/components/schemas/managedByOptions' copyConfigurationCodesType: type: array description: Information needed to copy configuration code from one property to the other. maxItems: 4000 items: $ref: '#/components/schemas/copyConfigurationCodeType' exportMappingLinkedCodeType: type: object description: Details of linked code. properties: linkedCode: description: Linked code. type: string minLength: 0 maxLength: 2000 exportMappingId: description: Mapping id associated with linked code. $ref: '#/components/schemas/uniqueID_Type' exportMappingCode: description: Mapping code attached to linked code. type: string minLength: 0 maxLength: 100 defaultMappedValue: description: Default value. type: string minLength: 0 maxLength: 2000 mappedValue: description: Linked code. type: string minLength: 0 maxLength: 2000 mappingTypeDescription: description: Description of the export mapping type. type: string minLength: 0 maxLength: 2000 mappingCodeDescription: description: Description of the export mapping code. type: string minLength: 0 maxLength: 2000 lovName: description: Name of the LOV group to be used. type: string minLength: 0 maxLength: 40 transactionDiscountsAttributeType: type: object properties: transactionDiscountType: description: Holds Transaction Discounts Attribute. e.g if the discount is applied to a membership type only or if it's applied to a membership level of a membership type. $ref: '#/components/schemas/transactionDiscountType' transactionDiscountTypeValue: description: Holds the value of transaction discount type. e.g the value of the membership type can be given when transactionDiscountType is set to MembershipType type: string minLength: 1 maxLength: 200 translationsTextType: type: array description: Language code for the translation. maxItems: 4000 items: type: object properties: value: type: string description: Used for Character Strings, length 0 to 2000. minLength: 0 maxLength: 2000 language: description: Language identification. type: string minLength: 0 maxLength: 20 description: Language code for the translation. cycleFiscalPeriodType: type: object description: Fiscal Year Cycle Period creation type. properties: hotelId: description: Resort for which the Period is defined. type: string minLength: 0 maxLength: 20 yearId: description: Id of the Year. type: number periodPrefix: description: Prefix added to all period to be created type: string minLength: 0 maxLength: 3 cycle: description: Type of Cycle Period to create. $ref: '#/components/schemas/cyclePeriodType' managedBy: $ref: '#/components/schemas/managedByOptions' monthlyRevenueNightsVarianceInfoType: type: object description: Revenue Variance information for a segment code for a month. properties: month: description: Month number type: integer revenueVariance: description: Variance for a month. type: number nightsVariance: description: Variance for a month. type: number groupArrangementCodesType: type: array description: Details for group arrangement code along with associated transaction codes. maxItems: 4000 items: $ref: '#/components/schemas/groupArrangementCodeType' folioTypeConfigType: type: object description: Information detail for uniquely identifying a Folio Type Name. properties: hotelId: description: Hotel where the code is configured. type: string minLength: 0 maxLength: 20 code: description: Configuration code. type: string minLength: 0 maxLength: 40 taxType: description: Name Tax Type associated with folio type. type: string minLength: 0 maxLength: 20 guestClassification: description: Type of guest Individual, Professional, etc, used in certain countries. type: string minLength: 0 maxLength: 20 transactionServiceType: description: Identify the service type of transaction, used in certain countries. type: string minLength: 0 maxLength: 20 folioReports: description: Collection of reports associated with a Folio Type Name. $ref: '#/components/schemas/folioReportsType' associatedCreditFolioType: description: Stores the Linked Associated Credit Folio Type. type: string minLength: 0 maxLength: 100 profileAttributes: description: Determines the Folio Type based on attributes of the Payee Profile. $ref: '#/components/schemas/folioTypeProfileAttributes' fiscalFolio: description: Folio Type is fiscal or not, used in certain countries. type: boolean sendFiscalFolio: description: Adding this flag at folio type level would decide to send fiscal folio (generate payload) or not. type: boolean correctionFolio: description: Folio type is the correction or not, used in certain countries. type: boolean debitFolio: description: Folio type is a debit folio or not, used in certain countries. type: boolean depositFolio: description: Folio type is a deposit folio type or not, used in certain countries. type: boolean simpleFolio: description: Folio type is a simple folio type or not, used in certain countries. type: boolean internalFolio: description: Folio type is internal or not, used in certain countries. type: boolean aRFolio: description: Folio type is Account Receivable or not, used in certain countries. type: boolean manualFolio: description: Folio type has a manual folio type associated or not, used in certain countries. type: boolean informationFolio: description: Used only for Information and Pro-forma folios in certain countries. type: boolean useNationality: description: Folio type is used for Local national or foreigner, used in certain countries. type: boolean cityLedgerFolio: description: Folio type is used for City Ledger bills or not or not, used in certain countries. type: boolean useTaxNumber: description: Folio type is used for profiles which have a tax number or not, used in certain countries. type: boolean allowFolioCompression: description: Allowed to create compressed folio on existing folio type if user tries to compress on the folio otherwise user is not allowed to compress, used in certain countries. type: boolean compressedFolio: description: Folio type is Compressible or not, indicates that the folio which was created is a Compressed Folio based on the AllowFolioCompression flag, used in certain countries. type: boolean allowCreditFolio: description: Allowed to create credit folio on existing folio type if user gives the credit on the folio otherwise user is not allowed to give a credit, used in certain countries. type: boolean creditFolio: description: Folio type used for Credit Folio or not, indicates that the folio which was created is a Credit Folio based on the AllowCreditFolio flag , used in certain countries. type: boolean allowFolioConversion: description: Folio type used for Converting the Folios, used in certain countries. type: boolean folioUsed: description: Flag to indicate if the Folio Type has been used to create a Folio. type: boolean supplementalFolio: description: Folio type is a supplemental folio ( debit bill ) type or not, used in certain countries. type: boolean useOriginalFolioStayDetails: description: Use original folio stay details on the folio which was created using the folio type. type: boolean documentCode: description: Document code which can be defined on each folio type, which is an alphanumeric value can be used on Invoices or other documents for tax purposes. E.g. In case of Portugal, this value is combined with Folio Number for ATCUD requirements. type: string minLength: 0 maxLength: 20 taxFolio: description: To indicate if the folio type is to be used for a tax folio. Used in Greece Country. type: boolean folioTypePrefix: description: Prefix used for folio type type: string minLength: 0 maxLength: 20 folioTypeSuffix: description: Suffix used for folio type type: string minLength: 0 maxLength: 20 lastFolioNumber: description: Last folio number issued for a folio type type: number proFormaFolio: description: To indicate if the folio type is to be used for a proforma folio. type: boolean customerVatFolio: description: To indicate if the folio type is to be used for a Customer Vat folio, used in Poland. type: boolean debitNote: description: To indicate if the folio type is to be used for a Debit Note folio, used in Poland. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' externalReferencesType: type: array description: This type contains unique information of external reference. maxItems: 4000 items: $ref: '#/components/schemas/externalReferenceType' doNotPostGenerateType: type: object description: Existance of this type indicates that the generate will not be effective. This is mainly used on Tax Type based generates rule. properties: {} fixedChargeDetailType: type: object description: Fixed charge amount could be specified by flat fee or be a percentage of the rate amount. properties: transaction: description: Transaction code and description of a fixed charge. $ref: '#/components/schemas/codeDescriptionType' quantity: description: Quantity of the product. type: integer chargeAmount: description: Price of the product. $ref: '#/components/schemas/currencyAmountType' percent: description: Percentage of the rate amount. type: number minimum: 0 maximum: 100 supplement: description: Additional information regarding the fixed charge. type: string minLength: 0 maxLength: 2000 article: description: Holds related article code and description. $ref: '#/components/schemas/codeDescriptionType' roomNights: description: Holds number of comp or cash room night to allocate. type: integer translationTextType4000: type: object description: Contains Multiple translated texts and language codes. properties: defaultText: description: Default text with Character length from 0 to 4000. type: string minLength: 0 maxLength: 4000 translatedTexts: description: List of translated text and language codes. $ref: '#/components/schemas/translationsTextType' aRInvoiceType: type: object description: Details of an AR Invoice. properties: hotelId: description: Property where the invoice exists. type: string minLength: 0 maxLength: 20 reservationId: description: Reservation ID of the invoice. $ref: '#/components/schemas/reservationId' guestProfileId: description: Guest Profile ID of the invoice. $ref: '#/components/schemas/uniqueID_Type' age: description: The Aging age of the invoice type: integer guestName: description: Name of the Guest who consumed these transactions. type: string minLength: 0 maxLength: 200 originalAmount: description: Original Amount of the Invoice $ref: '#/components/schemas/currencyAmountType' amount: description: Current Amount of the Invoice. $ref: '#/components/schemas/currencyAmountType' payments: description: Total Payments made to this Invoice. $ref: '#/components/schemas/currencyAmountType' balance: description: Amount still open which has not been paid $ref: '#/components/schemas/currencyAmountType' reference: description: User-defined posting reference. type: string minLength: 0 maxLength: 2000 remark: description: User-defined posting remark. type: string minLength: 0 maxLength: 2000 adjusted: type: boolean parentInvoiceNo: type: number compressed: type: boolean compressedDate: type: string format: date maxLength: 8 transferredOut: type: boolean transferredIn: type: boolean market: description: Invoice market code. $ref: '#/components/schemas/marketCodeInfoType' roomClass: description: Invoice room class code. $ref: '#/components/schemas/roomClassCodeInfoType' source: description: Invoice source code. $ref: '#/components/schemas/sourceCodeInfoType' reservationInfo: description: Reservation guest details. $ref: '#/components/schemas/reservationInfoType' cashierInfo: description: Cashier information. Contains Id and Name details of the cashier. $ref: '#/components/schemas/cashierInfoType' transactionInfo: description: Transaction information . $ref: '#/components/schemas/trxInfoType' paymentCard: description: Payment card details. $ref: '#/components/schemas/resPaymentCardType' addresseeInfo: description: Addressee Information for the folio. This is available when the Addressee functionality is used and and Addressee is attached to the folio of the Invoice. $ref: '#/components/schemas/profileInfoType' allowPartialTransferYn: description: Flag to check partial Transfer Allowed. type: boolean printed: description: Flag to check Invoice Statement is Printed. type: boolean printedDate: description: Invoice Statement Printed Date. type: string format: date maxLength: 8 storedFolioId: description: ID of the Stored Folio. $ref: '#/components/schemas/uniqueID_Type' storedFolioName: description: Name of the Stored Folio. type: string minLength: 0 maxLength: 2000 storedDebitFolioId: description: ID of the Stored Debit Folio. $ref: '#/components/schemas/uniqueID_Type' storedDebitFolioName: description: Name of the Stored Debit Folio. type: string minLength: 0 maxLength: 2000 folioTexts: description: Additional text fields to display on the folio. $ref: '#/components/schemas/folioTextsType' customNumbers: description: Unique Custom Numbers associated with this record. type: array maxItems: 5 items: $ref: '#/components/schemas/customNumberType' fiscalResponseType: description: Provides information which is used for fiscal response processing. $ref: '#/components/schemas/fiscalResponseType' transactionNo: description: Unique Transaction Identifier of the Invoice. type: number transactionDate: description: Transaction Date of the invoice. type: string format: date maxLength: 8 status: description: Status of the invoice. type: string minLength: 0 maxLength: 20 transactionCode: description: Transaction code of the invoice. type: string minLength: 0 maxLength: 20 folioNo: description: Folio Number. type: number invoiceNo: description: Invoice No after the folio is generated. Same invoice number may be referred in multiple folios type: number fiscalBillNo: description: The Fiscal Bill number of this posting type: string minLength: 0 maxLength: 2000 folioTypeName: description: The name of the Folio Type used for the Folio Number sequence. type: string minLength: 0 maxLength: 100 internalFolioWindowID: description: Internal window ID which is unique to the reservation. This ID can only be used for reference. type: string minLength: 0 maxLength: 20 folioDate: description: Date of Folio Generation. type: string format: date maxLength: 8 folioStatus: $ref: '#/components/schemas/folioStatusType' folioNoWithPrefix: description: The folio number with prefix value. type: string minLength: 0 maxLength: 200 invoiceType: description: Invoice code of the invoice. $ref: '#/components/schemas/aRInvoiceCategory' statementNo: description: Statementno of the invoice. type: integer revenueDate: description: Revenue date ID of the invoice. type: string format: date maxLength: 8 closeDate: description: Close date of the invoice. type: string format: date maxLength: 8 postingDate: description: Posting date of the invoice. type: string format: date maxLength: 8 transferDate: description: Transfer date of the invoice. type: string format: date maxLength: 8 canBeModified: description: Flag to indicate if postings or adjustments can be made to the invoice. type: boolean transactionCodeTotalsInformationType: type: object description: Budget Forecast totals information for Transaction segment. properties: budgetTotalInfo: description: Budget revenue information for a Transaction. $ref: '#/components/schemas/transactionInfoType' forecastTotalInfo: description: Forecast revenue information for a Transaction. $ref: '#/components/schemas/transactionInfoType' actualTotalInfo: description: Actual revenue information for a Transaction. $ref: '#/components/schemas/transactionInfoType' aFVarianceTotalInfo: description: Actual Forecast revenue variance for a Transaction. $ref: '#/components/schemas/transactionVarianceInfoType' aBVarianceTotalInfo: description: Actual Budget revenue variance for a Transaction. $ref: '#/components/schemas/transactionVarianceInfoType' fBVarianceTotalInfo: description: Forecast Budget revenue variance for a Transaction. $ref: '#/components/schemas/transactionVarianceInfoType' folioPrintQueueType: type: object description: Folio Print queue identification details properties: hotelId: description: Property associated with folio print queue type: string minLength: 0 maxLength: 20 queueName: description: Folio print queue name type: string minLength: 0 maxLength: 100 billNumber: description: Last folio number type: integer fiscalBillNumber: description: Last fiscal bill number type: integer incrementalValue: description: Incremental Value type: integer inactive: description: Indicates whether the folio print queue is inactive or not. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' templateCustomNumberConfig: type: object description: Request object to create a new template custom number configuration. properties: customNumberConfiguration: description: Custom number template configuration to be created. $ref: '#/components/schemas/customNumberTemplateConfigurationType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' authorizerGroupsCriteriaType: type: object description: Criteria to change authorizer group. properties: updateAuthorizers: description: If true, updates all authorizers in the group. type: boolean authorizerGroups: description: Authorizer Groups Configuration to be changed. $ref: '#/components/schemas/authorizerGroupsType' transactionArrangementCodeType: type: object description: This has arrangement codes association details for a transaction code. properties: transactionCode: description: Transaction code type: string minLength: 0 maxLength: 20 folioArrangementCode: description: Folio arrangement code that is associated with the transaction code. type: string minLength: 0 maxLength: 20 groupArrangementCode: description: Group arrangement code that is associated with the transaction code. type: string minLength: 0 maxLength: 20 expenseArrangementCode: description: Expense arrangement code that is associated with the transaction code. type: string minLength: 0 maxLength: 20 dailyPlanCode: description: Daily plan code that is associated with the transaction code. type: string minLength: 0 maxLength: 20 pMS_ResStatusType: type: string description: This reservation is in checked in status and the business date is past departure date. This could occur when ORS and PMS are in same environment. enum: - Reserved - Requested - NoShow - Cancelled - InHouse - CheckedOut - Waitlisted - DueIn - DueOut - Walkin - PendingCheckout aRInvoiceCategory: type: string enum: - Normal - Credit - OldBalance - PasserBy marketCodeInformationType: type: object description: Budget Forecast information for budget segment code. properties: marketCode: description: Segment code for which budget forecast information is fetched. type: string minLength: 0 maxLength: 20 marketCodeDescription: description: Segment code description for segment code. type: string budgetRevenueInfo: description: Budget Revenue information for a segment code. $ref: '#/components/schemas/revenueNightsInfoType' forecastRevenueInfo: description: Forecast Revenue information for a segment code. $ref: '#/components/schemas/revenueNightsInfoType' actualRevenueInfo: description: Actual Revenue information for a segment code. $ref: '#/components/schemas/revenueNightsInfoType' aFVarianceInfo: description: Actual Forecast Revenue variance for a segment code. $ref: '#/components/schemas/revenueNightsVarianceInfoType' aBVarianceInfo: description: Actual Budget Revenue variance for a segment code. $ref: '#/components/schemas/revenueNightsVarianceInfoType' fBVarianceInfo: description: Forecast Budget Revenue variance for a segment code. $ref: '#/components/schemas/revenueNightsVarianceInfoType' cashSurchargeRangeType: type: object description: Cash Surcharge identification details properties: hotel: description: Property associated with Cash Surcharge Range type: string minLength: 0 maxLength: 20 cashSurchargeType: description: Cash Surcharge type type: string minLength: 0 maxLength: 20 amountFrom: description: Start value of Cash Surcharge range type: number amountTo: description: End value of Cash Surcharge range type: number percentage: description: Percentage of local currency type: number surchargeFlatAmt: description: Surcharge Flat amount for this range. type: number hotelTransactionGeneratesSetupType: type: object description: Defines the Generates Setup and its Calculation Rules. properties: addBaseAmtTo: description: Defines the buckets the base or posting amount will be added to. $ref: '#/components/schemas/generateCalculationBucketsType' generates: description: Defines the Generates and its Calculation Rules. $ref: '#/components/schemas/generatesType' hotelId: description: Hotel code. type: string minLength: 0 maxLength: 20 transactionCode: description: Transaction code. type: string minLength: 0 maxLength: 20 transactionGroup: description: Transaction group. type: string minLength: 0 maxLength: 20 transactionSubGroup: description: Transaction sub group. type: string minLength: 0 maxLength: 20 taxInclusive: description: True indicates that the tax is inclusive in the generate. type: boolean transactionCodeOwnership: type: object properties: transactionCodes: description: Transaction Code and ownership status information. $ref: '#/components/schemas/changeTransactionCodeOwnershipType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' hotelNoShowPostingRulesType: type: array description: Holds No Show Posting Rules Configuration details. maxItems: 4000 items: $ref: '#/components/schemas/hotelNoShowPostingRuleType' calculatedPosting: type: object properties: result: description: List of charges that will be posted against the transaction code based from the test criteria. $ref: '#/components/schemas/calculatePostingResult' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' profileIdList: type: array description: Unique Id that references an object uniquely in the system. maxItems: 4000 items: $ref: '#/components/schemas/uniqueID_Type' consumableInventoryItemGroupType: type: string description: The item group of consumable inventory. enum: - Articles authorizationConfigRules: type: object properties: authorizationConfigRulesType: description: Authorization configuration rule type. $ref: '#/components/schemas/authorizationConfigRulesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' reservationAllowedActionType: type: string description: Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation. enum: - Cancel - Move - PreCharge - PostCharge - FacilitySchedule - Upsell - PreCheckIn - PostToNoShowCancel - NoShow - NameChange - Discount - EnrollToPrimaryMembership - EnrollInProgress links: type: array items: $ref: '#/components/schemas/instanceLink' templateCustomNumberConfigDetails: type: object description: Response object for fetching template custom number configurations. properties: customNumberConfigurationList: description: Collection of template custom number configurations. $ref: '#/components/schemas/customNumberTemplateConfigurationListType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' monthlyTransactionVarianceInfoType: type: object description: Revenue Variance information for a segment code for a month. properties: month: description: Month number type: integer revenueVariance: description: Variance for a month. type: number resSharedGuestInfoType: type: object description: Contains information regarding the share reservation. properties: profileId: $ref: '#/components/schemas/profileId' firstName: description: Given name, first name or names type: string lastName: description: Family name, last name. type: string fullName: description: String representation of the full name type: string customChargeRangeType: type: object description: The lower and upper range value for which the corresponding price is posted as a custom charge. properties: rangeFrom: description: The lower range value for which the corresponding price is posted as a custom charge. type: number rangeTo: description: The upper range value for which the corresponding price is posted as a custom charge. type: number price: description: The price of the custom charge, for the given range. type: number adjustmentReasonCodeType: type: string description: Defines values for Adjustment reason codes. e.g. ADJ for adjustment, COR for correction, DEL for deletion. enum: - Adjustment - Correction - Deletion - ServiceRecovery - CreditBill - VoidBill folioArrangementCodesCopy: type: object properties: folioArrangementCode: type: array description: List of folio arrangement codes to be copied. items: $ref: '#/components/schemas/copyConfigurationCodeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' collectingAgentTaxesType: type: object description: Type which holds collection of Agent Tax details properties: collectingAgentTax: description: It represent Agent Tax details. type: array maxItems: 4000 items: $ref: '#/components/schemas/collectingAgentTaxType' overrideCollectingAgentTaxes: description: Flag that indicates if Collecting Agent Taxes check should be skipped when given Tax code already exist. type: boolean namePrefixType: type: string description: Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.) minLength: 0 maxLength: 40 scopeType: type: string description: Minimum required and complimentary values are applicable Per Stay. enum: - PerDay - PerStay communicationStatusType: type: string description: Enum to denote the Status of Readiness messages sent to Guest Devices. enum: - Pending - Completed - Failed - Sent - Received - Cancelled - PendingAvailability resPaymentCardType: type: object description: Information on a credit card for the customer. properties: cardId: description: credit card id $ref: '#/components/schemas/uniqueID_Type' currentAuthorizedAmount: $ref: '#/components/schemas/currencyAmountType' approvalAmountNeeded: $ref: '#/components/schemas/currencyAmountType' approvalCode: description: Approval code sent by the credit card company on a successful authorization. type: string minLength: 0 maxLength: 20 cardType: description: Indicates the type of credit card from a defined list $ref: '#/components/schemas/cardTypeType' userDefinedCardType: description: Indicates the user defined credit card type if credit card type from a defined list is not provided type: string minLength: 0 maxLength: 2 cardNumber: type: string minLength: 0 maxLength: 80 cardNumberMasked: type: string minLength: 0 maxLength: 80 cardNumberLast4Digits: type: string minLength: 0 maxLength: 80 expirationDate: description: Expiration date of the credit card type: string format: date maxLength: 8 expirationDateMasked: description: Masked Expiration date of the credit card type: string minLength: 0 maxLength: 20 expirationDateExpired: type: boolean cardHolderName: type: string minLength: 0 maxLength: 200 attachCreditCardToProfile: description: Attach the credit card to profile. type: boolean processing: description: This contains information on whether EFT is enabled. A value of 'C' indicates EFT is enabled and 'M' indicates manual authorization is available for this payment card type. $ref: '#/components/schemas/cardProcessingType' swiped: type: boolean cardPresent: description: Flag to determine if the credit card was swiped/manually entered , This element is only used when PAYMENT SERVICE DIRECTIVE(PSD) Opera Control is active. type: boolean cardOrToken: description: This contains information on whether credit card is tokenized (token enabled). A value of 'Token' indicates credit card is token enabled and 'CardNumber' indicates non token environment for this payment card type. $ref: '#/components/schemas/cardNumberTypeType' citId: description: Customer Initiated Transaction(CIT) Id for Credit Cards. This is only used when PAYMENT SERVICES DIRECTIVE (PSD2) Opera Control is active. type: string minLength: 0 maxLength: 30 folioCopyLegendType: type: object description: Search criteria to fetch folio copy legends information. properties: code: description: Term code to be searched. type: string minLength: 0 maxLength: 20 description: description: Term description type: string minLength: 0 maxLength: 100 languageCode: description: Language code to be searched. type: string minLength: 0 maxLength: 20 hotelId: description: Hotel where the folio copy legends code is configured. type: string minLength: 0 maxLength: 20 translatedTexts: description: List of translated text and language codes. $ref: '#/components/schemas/translationsTextType' managedBy: $ref: '#/components/schemas/managedByOptions' numberCodeType: type: string description: Used for Number specific codes for OPERA tables. Possible values of this pattern are 1, 10, 17, THOUSAND, BILLION, etc. minLength: 0 maxLength: 200 resHousekeepingType: type: object description: Holds housekeeping turndown service information for the room. properties: instructions: description: Turndown instructions for the room. type: string facilityTaskInfo: description: The facility task applicable for the current day. This will be information only and not used for any updates. $ref: '#/components/schemas/facilityTaskType' linenChange: description: Indicates if a linen change is necessary. type: boolean turndownRequested: description: Indicates whether guest wants turndown facility or not. type: boolean serviceTime: description: This is the Turndown room service time. type: string format: date maxLength: 8 expectedServiceTime: description: Expected Start Time for housekeeping task(s). type: string roomStatus: description: Current room status. Current room status is populated only if room is assigned to the reservation and reservation is due in or in house. $ref: '#/components/schemas/housekeepingRoomStatusType' exchangeRates: type: object properties: rates: type: array description: Exchange Rates to be Set. items: $ref: '#/components/schemas/exchangeRateType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' indicatorsType: type: array description: Collection of lamp indicators. maxItems: 4000 items: $ref: '#/components/schemas/indicatorType' hotelTransactionGroupsType: type: array description: Hotel's Transaction Group configuration. maxItems: 4000 items: $ref: '#/components/schemas/hotelTransactionGroupType' taxBracketAmountsType: type: array description: Details used for storing information about a tax bracket amount. maxItems: 4000 items: $ref: '#/components/schemas/taxBracketAmountType' authorizerGroups: type: object properties: authorizerGroups: description: Collection of Authorizer Groups fetched. $ref: '#/components/schemas/authorizerGroupsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' uniqueID_Type: type: object description: An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote). properties: id: description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. type: string minLength: 0 maxLength: 80 type: description: A reference to the type of object defined by the UniqueID element. type: string minLength: 0 maxLength: 40 telephoneType: type: object description: Information on a telephone number for the customer. properties: phoneTechType: description: Indicates type of technology associated with this telephone number, such as Voice, Data, Fax, Pager, Mobile, TTY, etc. type: string minLength: 0 maxLength: 20 phoneUseType: description: Describes the type of telephone number, in the context of its general use (e.g. Home, Business, Emergency Contact, Travel Arranger, Day, Evening). type: string minLength: 0 maxLength: 20 phoneUseTypeDescription: description: Description of the PhoneUseType code type: string minLength: 0 maxLength: 2000 phoneNumber: description: Telephone number assigned to a single location. type: string minLength: 0 maxLength: 40 extension: description: Extension to reach a specific party at the phone number. type: string minLength: 0 maxLength: 20 primaryInd: description: When true, indicates a primary information. type: boolean orderSequence: description: Display Order sequence. type: number createDateTime: description: Time stamp of the creation. type: string format: date-time creatorId: description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation. type: string minLength: 0 maxLength: 200 lastModifyDateTime: description: Time stamp of last modification. type: string format: date-time lastModifierId: description: Identifies the last software system or person to modify a record. type: string minLength: 0 maxLength: 200 purgeDate: description: Date an item will be purged from a database (e.g., from a live database to an archive). type: string format: date maxLength: 8 packageArrangementCodesCopy: type: object properties: packageArrangementCode: type: array description: List of the package arrangement codes to be copied. items: $ref: '#/components/schemas/copyConfigurationCodeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' transactionDiversionRuleLevelType: type: string description: Reservation level. enum: - Property - Reservation uDFGenerateType: type: object description: Defines UDF rule for generates. properties: uDF: description: Defines User Defined Function to calculate generates. type: string minLength: 0 maxLength: 2000 uDFFunctionName: description: The function name of the User Defined Function used to calculate generates. type: string minLength: 0 maxLength: 2000 uDFFunctionArguments: description: The function argument name-value combination accepted by the User Defined Function. $ref: '#/components/schemas/functionArgumentsType' transactionDiscountCodeType: type: string description: The code type on which the transaction discount is based. enum: - Article - Transaction transactionDiversionRulesType: type: array description: Collection of Transaction Diversion Rule List maxItems: 4000 items: $ref: '#/components/schemas/transactionDiversionRuleType' cardOptionType: type: object description: Switch card options. properties: requireIssueNumber: description: Indicates whether issue number is mandatory or not. type: boolean requireStartDate: description: Indicates whether start date is mandatory or not. type: boolean either: description: Indicates that either Issue Number or Start Date is sufficient. type: boolean articles: type: object description: Request to change articles. properties: hotelId: description: Hotel context for the articles. $ref: '#/components/schemas/codeType' articles: description: Collection of articles. $ref: '#/components/schemas/articlesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' fiscalCommandType: type: object description: Fiscal Command details. properties: hotelId: description: Unique code of the hotel. type: string minLength: 0 maxLength: 20 fiscalCommandCode: description: Fiscal Command. type: string minLength: 0 maxLength: 40 fiscalPartnerCodes: description: Configured Fiscal Partners of fiscal Command. $ref: '#/components/schemas/fiscalPartnerCodeListType' description: description: Fiscal Command description that is only used during a fetch. type: string minLength: 0 maxLength: 200 inactive: description: A flag that determines whether to fetch active records or inactive records. type: boolean instanceLink: type: object description: Metadata describing link description objects that MAY appear in the JSON instance representation. properties: href: description: URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the "templated" property must be set to true. type: string rel: description: Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile. type: string templated: description: Boolean flag that specifies that "href" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false. type: boolean default: false method: description: HTTP method for requesting the target of the link. type: string enum: - GET - POST - PUT - DELETE - PATCH - OPTIONS - HEAD targetSchema: description: Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource.. type: string operationId: description: The operationId of the path you can call to follow this link. This allows you to look up not only the path and method, but the description of that path and any parameters you need to supply. type: string title: description: Exact copy of the "summary" field on the linked operation. type: string transactionCodesCopy: type: object properties: transactionCodes: description: List of the transaction codes to be copied. $ref: '#/components/schemas/copyTransactionCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' noShowPostingRuleType: type: object description: Provides information about No Show Posting Rule Configuration. properties: reservationType: description: Type of the reservation. type: string minLength: 0 maxLength: 20 sourceCode: description: Source code of the reservation. type: string minLength: 0 maxLength: 20 postingRule: description: Posting Rule to be selected. $ref: '#/components/schemas/postingRuleType' transactionVarianceInfoType: type: array description: Monthly Revenue Variance information. maxItems: 12 items: $ref: '#/components/schemas/monthlyTransactionVarianceInfoType' traceResolveType: type: object properties: resolvedOn: description: Date the trace was resolved type: string format: date maxLength: 8 resolvedBy: description: User that resolved the trace type: string generateCalculationBucketsType: type: object description: Defines the buckets the generated amount can be added to. properties: bucket1: description: Generate Calculation Bucket1. type: boolean bucket2: description: Generate Calculation Bucket2. type: boolean bucket3: description: Generate Calculation Bucket3. type: boolean authorizerInfoType: type: object description: Authorizer Information properties: authorizerId: $ref: '#/components/schemas/uniqueID_Type' authorizerUserName: description: Application user name of the authorizer type: string minLength: 0 maxLength: 40 authorizerName: description: Full name of the authorizer. type: string minLength: 0 maxLength: 100 authorizerRateCode: description: Rate code of the authorizer. type: string minLength: 0 maxLength: 20 inheritAuthorizerRateCode: description: Indicates whether user has the choice to have reservation inherit rate code from the authorizer. type: boolean trxSetupType: type: object description: Transaction Code setup details. properties: generatesType: description: Short Summary information of the Chain and it's Hubs and Hotels. type: string minLength: 0 maxLength: 10 taxInclusive: description: True indicates that the tax is inclusive in the generate. type: boolean revenue: description: True indicates the Transaction Code is to be considered as revenue to the Hotel. type: boolean manualPosting: description: True indicates the Transaction Code is allowed to be posted manually. type: boolean useForPaidout: description: True indicates the Transaction Code is used for Paid outs. type: boolean redeemMembershipPoints: description: This flag indicates that the transaction is eligible to redeem points (guest can use their points to pay for transactions posted with this transaction code) type: boolean includeInDepositRule: description: True indicates the Transaction Code posting will be included in Deposit/Cencallation rule calculations. type: boolean depositPostingOnly: description: True indicates the Transaction Code is used for deposit postings only. type: boolean postingRule: description: Deposit posting associated with the transaction code. type: boolean depositType: description: Represents the type of deposit with possible values of "RECEIPT" or "FOLIO". $ref: '#/components/schemas/depositTypeType' checkNoRequired: description: True indicates the Transaction Code requires the Check Number for posting. type: boolean interHotelSales: description: True indicates the Transaction Code is used for cross posting across the hotels/. type: boolean postCovers: description: True indicates the Transaction Code is used to post covers. type: boolean nonTaxable: description: True indicates the Transaction Code is non taxable. type: boolean inactive: description: True indicates the Transaction Code is inactive. type: boolean ownershipStatus: description: Protected by the Property or Corporate level $ref: '#/components/schemas/trxOwnershipType' serviceType: description: Service Type for the transaction code. type: string minLength: 0 maxLength: 20 accountingCode: description: Accounting Code for the transaction code. type: string minLength: 0 maxLength: 40 quantityCode: description: Quantity Code for the transaction code. type: string minLength: 0 maxLength: 40 earnMembershipPoints: description: This flag indicates that the transaction is eligible to earn points (guest can earn points on the revenue posted to this transaction code) type: boolean resCommunicationType: type: object description: Communication details for a reservation. properties: telephones: description: List of Telephone Number Information type: object properties: telephoneInfo: description: Collection of Detailed information on telephone/fax for the customer. type: array maxItems: 4000 items: $ref: '#/components/schemas/telephoneInfoType' hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer emails: description: List of email address for the customer. type: object properties: emailInfo: description: Collection of Detailed information on an eMail address for the customer. type: array maxItems: 4000 items: $ref: '#/components/schemas/emailInfoType' hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer dailyPlanCodes: type: object properties: dailyPlanCodes: description: Collection of daily plan codes. $ref: '#/components/schemas/dailyPlanCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' gUINumberRules: type: array description: List of GUI number rules maxItems: 4000 items: $ref: '#/components/schemas/gUINumberRule' paymentMethodsInfo: type: object properties: paymentMethods: description: Collection of payment methods. $ref: '#/components/schemas/paymentMethodsType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. type: integer limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' customChargesConfig: type: object description: Request object for creating new Custom Charges. properties: customCharges: description: Custom Charges to be created. $ref: '#/components/schemas/customChargesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' taxBracketsType: type: array description: Details used for storing information about a tax bracket. maxItems: 4000 items: $ref: '#/components/schemas/taxBracketType' dateTimeSpanType: type: object description: 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 add to the StartDate to yield end date. properties: startDateTime: type: string format: date-time endDateTime: type: string format: date-time applicationUserType: type: object description: Information to uniquely identify an application user properties: appUser: description: Name of the application user type: string minLength: 0 maxLength: 140 appUserId: description: Unique numeric ID of the application user $ref: '#/components/schemas/uniqueID_Type' basicEmailType: type: string description: Email address minLength: 0 maxLength: 2000 marketCodeTotalInformationType: type: object description: Budget Forecast information for segment. properties: budgetTotalInfo: description: Budget Revenue information for a segment . $ref: '#/components/schemas/revenueNightsInfoType' forecastTotalInfo: description: Forecast Revenue information for a segment . $ref: '#/components/schemas/revenueNightsInfoType' actualTotalInfo: description: Actual Revenue information for a segment . $ref: '#/components/schemas/revenueNightsInfoType' aFVarianceTotalInfo: description: Actual Forecast Revenue variance for a segment . $ref: '#/components/schemas/revenueNightsVarianceInfoType' aBVarianceTotalInfo: description: Actual Budget Revenue variance for a segment . $ref: '#/components/schemas/revenueNightsVarianceInfoType' fBVarianceTotalInfo: description: Forecast Budget Revenue variance for a segment . $ref: '#/components/schemas/revenueNightsVarianceInfoType' aRInvoicesType: type: array description: A collection of AR Invoices. maxItems: 4000 items: $ref: '#/components/schemas/aRInvoiceType' customChargeRuleTypeType: type: object description: The rule types for custom charge. properties: customChargeRuleType: description: Identifies the Custom Charge rule type. $ref: '#/components/schemas/customChargeRuleTypeOption' customChargeRuleTypeValue: description: Identifies the Custom Charge rule type value. type: integer customCodeInformationType: type: object description: Budget Forecast information for Custom segment code. properties: customCode: description: Custom code for which budget forecast information is fetched. type: string minLength: 0 maxLength: 20 customCodeDescription: description: Custom code description for Custom code. type: string budgetValueInfo: description: Budget Value information for a Custom code. $ref: '#/components/schemas/customValueInfoType' forecastValueInfo: description: Forecast Value information for a Custom code. $ref: '#/components/schemas/customValueInfoType' actualValueInfo: description: Actual Value information for a Custom code. $ref: '#/components/schemas/customValueInfoType' aFVarianceInfo: description: Actual Forecast Value variance for a Custom code. $ref: '#/components/schemas/customVarianceInfoType' aBVarianceInfo: description: Actual Budget Value variance for a Custom code. $ref: '#/components/schemas/customVarianceInfoType' fBVarianceInfo: description: Forecast Budget Value variance for a Custom code. $ref: '#/components/schemas/customVarianceInfoType' numberDescriptionType: type: object description: Indicates type definition for Numbers. properties: numberCode: description: Indicates code for a number $ref: '#/components/schemas/numberCodeType' description: description: Indicates Description text for a number $ref: '#/components/schemas/translationTextType4000' managedBy: $ref: '#/components/schemas/managedByOptions' customChargesConfigDetails: type: object description: Response object for fetching Custom Charges. properties: customCharges: description: Collection of Custom Charges codes. $ref: '#/components/schemas/customChargesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' articleInfoType: type: object description: Information regarding an article. properties: description: description: Description of the article. type: string minLength: 0 maxLength: 2000 transactionCode: description: Transaction code to which the article belongs. type: string minLength: 0 maxLength: 20 price: description: Default price of the article. $ref: '#/components/schemas/currencyAmountType' postIt: description: Post it information of the article. $ref: '#/components/schemas/articlePostItType' universalProductCode: description: Unique Universal product code of the article. type: string minLength: 0 maxLength: 20 hotelId: description: Hotel code to which the article belongs. type: string minLength: 0 maxLength: 20 articleCode: description: Unique code of the article. type: string minLength: 0 maxLength: 20 inactive: description: Indicates whether the article is inactive or not. type: boolean orderSequence: description: Display Order sequence. type: number managedBy: $ref: '#/components/schemas/managedByOptions' folioTypeProfileAttributes: type: string description: Profile is not configured with Tax Id. enum: - WithoutTaxId noShowPostingRulesEdit: type: object properties: noShowPostingRules: description: No Show Posting Rule Configurations to be changed. $ref: '#/components/schemas/noShowPostingRulesEditType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' compAuthorizers: type: object properties: compAuthorizerInfo: description: Comp authorizer information. $ref: '#/components/schemas/compAuthorizersType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. type: integer limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' cateringVarianceInfoType: type: array description: Monthly Variance information. maxItems: 12 items: $ref: '#/components/schemas/monthlyCateringVarianceInfoType' transactionCodeInformationType: type: object description: Budget Forecast information for Transaction segment code. properties: transactionCode: description: Transaction code for which budget forecast information is fetched. type: string minLength: 0 maxLength: 20 transactionCodeGrp: description: Transaction code group of segment code. type: string transactionCodeDescription: description: Transaction code description for Transaction code. type: string budgetInfo: description: Budget revenue information for a Transaction code. $ref: '#/components/schemas/transactionInfoType' forecastInfo: description: Forecast revenue information for a Transaction code. $ref: '#/components/schemas/transactionInfoType' actualInfo: description: Actual revenue information for a Transaction code. $ref: '#/components/schemas/transactionInfoType' aFVarianceInfo: description: Actual Forecast revenue variance for a Transaction code. $ref: '#/components/schemas/transactionVarianceInfoType' aBVarianceInfo: description: Actual Budget revenue variance for a Transaction code. $ref: '#/components/schemas/transactionVarianceInfoType' fBVarianceInfo: description: Forecast Budget revenue variance for a Transaction code. $ref: '#/components/schemas/transactionVarianceInfoType' authBillingInstructionsType: type: array description: Set of Billing Instruction codes. maxItems: 4000 items: $ref: '#/components/schemas/codeDescriptionType' currencyLimitType: type: object description: Type used for Currency Limits. properties: postingLimit: description: Indicated the Posting Limit. $ref: '#/components/schemas/postingLimitType' currencyType: description: Indicates what type of currency it is Local/Foreign. $ref: '#/components/schemas/currencyHandlingType' amount: description: Indicates the curresponding limit for amount. type: number compAuthorizer: type: object properties: criteria: description: Criteria to fetch the check details. $ref: '#/components/schemas/compAuthorizerType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' folioPrintQueuesType: type: array description: List of folio print queues maxItems: 4000 items: $ref: '#/components/schemas/folioPrintQueueType' resGuaranteeType: type: object description: Validations type record returned after Validations are done. properties: guaranteeCode: description: Guarantee Code. type: string minLength: 0 maxLength: 20 shortDescription: description: Guarantee Code. type: string minLength: 0 maxLength: 80 onHold: description: Guarantee Code. type: boolean operaControlSequences: type: object properties: controlSequences: description: Collection of Opera Control Sequence details. $ref: '#/components/schemas/controlSequencesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' phoneNumberType: type: string description: Phone number minLength: 0 maxLength: 40 trxCodeAccessRoleType: type: object description: Role having access to set of transaction codes properties: hotel: description: Transaction Codes associated with particular Hotel type: array maxItems: 4000 items: $ref: '#/components/schemas/hotelTrxCodesAccessType' code: description: Role code type: string minLength: 0 maxLength: 80 levelCode: description: Role level code, for Chain Level code Level code will be Chain Code the role belongs to and for Hotel level role it will b the Hotel Code the role belongs to. type: string minLength: 0 maxLength: 20 level: description: Role Level type. Only Property or Chain level roles are supported by this type. $ref: '#/components/schemas/roleLevelType' membershipTypeLevelType: type: object properties: type: description: Code type for Rule Details type: string minLength: 0 maxLength: 20 level: description: Description type for Rule Details type: string minLength: 0 maxLength: 20 folioReportGroupType: type: string description: The Folio Report Group name. The folio report will be defined under each group and based on where the folio has to be printed, Opera will pick up the correct folio report name to print. enum: - Guest - Group - AccountsReceivables - PasserBy - PostIt - Expense - CorrectionHeader hotelInterfaceStatusType: type: string description: Status of the Hotel Interface either STOPPED or RUNNING. enum: - Stopped - Running - Waiting - StopInitiated - StartInitiated - RebootInitiated - Other cateringCodeInformationBaseType: type: object description: Budget Forecast information for Catering segment code. properties: cateringCode: description: Catering segment code for which budget forecast information is fetched. type: string minLength: 0 maxLength: 20 cateringCodeGrp: description: Catering code group of segment code. type: string cateringCodeDescription: description: Catering code description for segment code. type: string budgetInfo: description: Budget Revenue information for a Catering code. $ref: '#/components/schemas/cateringInfoType' forecastInfo: description: Forecast Revenue information for a Catering code. $ref: '#/components/schemas/cateringInfoType' depositTypeType: type: string description: Represents the Folio Deposit Type. enum: - Receipts - Folios customChargeExemptionsConfigCopy: type: object properties: customChargeExemptionsConfigCopy: type: array description: List of the Custom Charge Exemptions to be copied. maxItems: 4000 items: $ref: '#/components/schemas/copyCustomChargeExemptionConfigType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' compTypesToBeChanged: type: object description: Request object for changing Comp Types. properties: compTypes: description: Comp Types to be changed. $ref: '#/components/schemas/compTypesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' fiscalPeriodEditType: type: object properties: hotelId: description: Resort for which the Period is defined. type: string minLength: 0 maxLength: 20 yearId: description: Id of the Year. type: number startDate: description: Start Date of the Period type: string format: date maxLength: 8 newPeriod: description: Edited values of the fiscal period. $ref: '#/components/schemas/fiscalPeriodType' description: Values of the old primary key. transactionCodeInformationBaseType: type: object description: Budget Forecast information for Transaction segment code. properties: transactionCode: description: Transaction code for which budget forecast information is fetched. type: string minLength: 0 maxLength: 20 transactionCodeGrp: description: Transaction code group of segment code. type: string transactionCodeDescription: description: Transaction code description for Transaction code. type: string budgetInfo: description: Budget revenue information for a Transaction code. $ref: '#/components/schemas/transactionInfoType' forecastInfo: description: Forecast revenue information for a Transaction code. $ref: '#/components/schemas/transactionInfoType' revenueBucketCodeType: type: object description: This gives detailed information about a trx code arrangement. properties: description: description: Description of the trx code arrangement code. type: string minLength: 0 maxLength: 40 transactionCodes: description: Collection of transaction codes which form the trx code arrangement. $ref: '#/components/schemas/trxCodesInfoType' code: description: Code is used to identify a trx code arrangement. type: string minLength: 0 maxLength: 20 hotelId: description: Identifies the hotel code for which the trx code arrangement is specified. type: string minLength: 0 maxLength: 20 revenueBucketType: description: This holds Revenue Bucket Type type: string minLength: 0 maxLength: 20 pointsEligible: description: Bucket is eligible for membership points type: boolean bucketValue: description: Stores the default value for the arrangement code for revenue buckets in order to group transaction codes. type: string minLength: 0 maxLength: 2000 bucketType: description: Flag to identify Fiscal related bucket types. $ref: '#/components/schemas/bucketTypeType' managedBy: $ref: '#/components/schemas/managedByOptions' cateringInfoType: type: object description: Revenue and Covers information for a catering segment code. Holds total and monthly information. properties: totalRevenue: description: Total revenue for segment code. type: number totalCovers: description: Total Covers for segment code. type: number monthlyInfo: description: Catering information for each month for segment code. type: array maxItems: 12 items: $ref: '#/components/schemas/monthlyCateringInfoType' emailType: type: object description: Information on an email for the customer. properties: emailAddress: description: Defines the e-mail address. type: string minLength: 0 maxLength: 2000 type: description: Defines the purpose of the e-mail address (e.g. personal, business, listserve). type: string minLength: 0 maxLength: 20 typeDescription: description: Describes the Type code type: string minLength: 0 maxLength: 2000 emailFormat: description: Supported Email format. type: string enum: - Html - Text primaryInd: description: When true, indicates a primary information. type: boolean orderSequence: description: Display Order sequence. type: number createDateTime: description: Time stamp of the creation. type: string format: date-time creatorId: description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation. type: string minLength: 0 maxLength: 200 lastModifyDateTime: description: Time stamp of last modification. type: string format: date-time lastModifierId: description: Identifies the last software system or person to modify a record. type: string minLength: 0 maxLength: 200 purgeDate: description: Date an item will be purged from a database (e.g., from a live database to an archive). type: string format: date maxLength: 8 budgetForecastCustomInfoType: type: object description: Budget Forecast information for budget Custom codes. properties: customCodeInformation: description: Budget Forecast information for Custom segment code . type: array maxItems: 4000 items: $ref: '#/components/schemas/customCodeInformationType' customCodeTotalInformation: description: Budget Forecast information for Custom segment code . $ref: '#/components/schemas/customCodeTotalInformationType' customChargeExemptionsConfigToBeCreated: type: object properties: customChargeExemptionsConfig: type: array description: New one or more Custom Charge Exemptions to be created. maxItems: 100 items: $ref: '#/components/schemas/customChargeExemptionsConfigType' warnings: $ref: '#/components/schemas/warningsType' fiscalCommandsDetails: type: object description: Response object for fetching Fiscal Commands. properties: fiscalPartners: $ref: '#/components/schemas/fiscalCommandsType' warnings: $ref: '#/components/schemas/warningsType' revenueTypeMappingListType: type: array description: Collection of multiple Revenue type mapping codes. maxItems: 4000 items: $ref: '#/components/schemas/revenueTypeMappingType' compTypesCriteria: type: object description: Request object for creating CompTypes. properties: compTypes: description: Comp Types to be created. $ref: '#/components/schemas/compTypesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' adjustmentCodesCopy: type: object properties: adjustmentCode: type: array description: List of the Adjustment Codes to be copied. items: $ref: '#/components/schemas/copyConfigurationCodeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' revenueTypeMappingCopy: type: object description: Request object for Copying Revenue Type Mapping. properties: criteria: description: Criteria for copying Revenue Type Mapping. $ref: '#/components/schemas/copyRevenueTypeMappingCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' fixedChargeType: type: object description: Holds fixed charge information. properties: schedule: description: Holds schedule of fixed charge. $ref: '#/components/schemas/fixedChargeScheduleType' charge: description: Holds specific details of fixed charge. $ref: '#/components/schemas/fixedChargeDetailType' url: description: URL that identifies the location associated with the record identified by the UniqueID. type: string type: description: A reference to the type of object defined by the UniqueID element. type: string minLength: 0 maxLength: 20 instance: description: The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated. type: string minLength: 0 maxLength: 80 idContext: description: Used to identify the source of the identifier (e.g., IATA, ABTA). type: string minLength: 0 maxLength: 80 id: description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. type: string minLength: 0 maxLength: 80 idExtension: description: Additional identifying value assigned by the creating system. type: integer codeType: type: string description: Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X. minLength: 0 maxLength: 20 trxCodesInfoType: type: array description: List of Transaction codes info. maxItems: 4000 items: $ref: '#/components/schemas/trxInfoType' bucketRedemptionCodesType: type: array description: Details for Bucket Redemption codes along with associated transaction codes. maxItems: 4000 items: $ref: '#/components/schemas/bucketRedemptionCodeType' rateCodeInformationBaseType: type: object description: Budget Forecast information for budget segment code. properties: rateCode: description: Segment code for which budget forecast information is fetched. type: string minLength: 0 maxLength: 20 rateCodeDescription: description: Segment code description for segment code. type: string budgetRevenueInfo: description: Budget Revenue information for a segment code. $ref: '#/components/schemas/revenueNightsInfoType' forecastRevenueInfo: description: Forecast Revenue information for a segment code. $ref: '#/components/schemas/revenueNightsInfoType' authorizerTrxLimitType: type: object description: A representation of the information of Transaction Limit. properties: transactionCodes: description: Set of Transaction Codes configured for the Authorizer Group. $ref: '#/components/schemas/authTransactionCodesType' billingInstructions: description: Set of Billing Instructions configured for the Authorizer Group. $ref: '#/components/schemas/authBillingInstructionsType' groupHeaderId: description: Group Header Id for a transaction row. type: number creditLimit: description: Credit Limit for a transaction. type: number occurrenceLimit: description: Occurrence Limit for a transaction. type: number reservationAllowedActionsType: type: array description: Allowed action. maxItems: 11 items: $ref: '#/components/schemas/reservationAllowedActionType' dailyPlanCodeType: type: object description: Generic Type to specify unique/primary id for the code. mostly used for Hotel level configuration codes removal request. properties: hotelId: description: Hotel where the code is configured. type: string minLength: 0 maxLength: 20 code: description: Configuration code. type: string minLength: 0 maxLength: 20 arrangementId: description: Primay key of arrangement codes type: number description: description: Description of the Folio Group Code. $ref: '#/components/schemas/translationTextType2000' taxTypeCode: description: information about the tax type code linked to the folio arrangment Code. type: string revenue: description: specify whether the arrangement postings are classed as revenue. type: boolean transactionCodes: description: Transaction codes that are associated to the folio grouping codes. $ref: '#/components/schemas/codeListType' managedBy: $ref: '#/components/schemas/managedByOptions' vIPType: type: object description: The supplier's ranking of the customer. properties: vipCode: description: VIP Code. type: string minLength: 0 maxLength: 20 vipDescription: description: VIP Description. type: string minLength: 0 maxLength: 80 currencyExchangeType: type: string description: E-certificate conversion. enum: - Cash - Settlement - Posting - Check - TACommission - Membership - Certificate transactionDiscount: type: object properties: transactionDiscount: description: Request to create or change a Transaction Discount $ref: '#/components/schemas/hotelTransactionDiscountType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' searchMatchesType: type: array description: List of Generic Name-Value-Pair Parameters used for super search matches. maxItems: 4000 items: $ref: '#/components/schemas/searchMatchType' exchangeRatesDetails: type: object properties: rates: type: array description: Collection of exchange rates and their information. items: $ref: '#/components/schemas/exchangeRateType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' revenueNightsVarianceInfoType: type: array description: Monthly Revenue Variance information. maxItems: 12 items: $ref: '#/components/schemas/monthlyRevenueNightsVarianceInfoType' copyTransactionSubgroupsType: type: object description: Copy information required to copy transaction subgroup type properties: transactionSubgroups: description: Template transaction subgroups that needs to be copied to the properties specified. $ref: '#/components/schemas/templateTransactionSubgroupIDsType' hotels: description: List of hotels to which the template transaction subgroups needs to be copied. $ref: '#/components/schemas/codeListType' vouchersDetails: type: object description: Object for Voucher Info. properties: vouchersInfoType: type: array description: List of Vouchers. items: $ref: '#/components/schemas/voucherType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' marketCodeInfoType: type: object properties: marketCode: type: string minLength: 0 maxLength: 20 hotelId: type: string minLength: 0 maxLength: 20 marketGroup: type: string minLength: 0 maxLength: 20 description: type: string minLength: 0 maxLength: 2000 resPreConfiguredRoutingInstrType: type: object description: Instruction to attach Pre-Configured Routing Instructions to a Reservation. properties: authorizerInfo: description: The authorizer information for Promotion Code with attached Complimentary Routing $ref: '#/components/schemas/authorizerInfoType' ratePlanCode: description: Rate Code with attached Routing Instruction. type: string minLength: 0 maxLength: 20 profileType: description: Profile Type with attached Routing Instruction. $ref: '#/components/schemas/resProfileTypeType' promotionCode: description: Promotion Code with attached Complimentary Routing. type: string minLength: 0 maxLength: 20 monthlyValueInfoType: type: object description: Holds monthly value summary information properties: month: description: Month number type: integer value: description: Value information for a month. type: number folioTypeLegendMappingConfigType: type: object description: Folio type legened mapping information. properties: hotelId: description: Property associated with folio type legend mapping type: string minLength: 0 maxLength: 20 legendCode: description: Legend code to which folio types attached. type: string minLength: 0 maxLength: 20 folioType: description: Folio type attached to the legend. type: string minLength: 0 maxLength: 20 folioTypeDescription: description: Folio type description attached to the legend. type: string minLength: 0 maxLength: 200 managedBy: $ref: '#/components/schemas/managedByOptions' bucketRedemptionCodeType: type: object description: This gives detailed information about redemption code. properties: description: description: Description of the trx code arrangement code. type: string minLength: 0 maxLength: 40 compTransactionCode: description: Comp Transaction code which form the trx code arrangement. $ref: '#/components/schemas/compTrxInfoType' code: description: Code is used to identify a trx code arrangement. type: string minLength: 0 maxLength: 20 hotelId: description: Identifies the hotel code for which the trx code arrangement is specified. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' functionArgumentsType: type: array description: Collection of function arguments and their corresponding values. maxItems: 4000 items: $ref: '#/components/schemas/functionArgumentType' cateringTotalsInformationType: type: object description: Budget Forecast totals information for Catering segment. properties: budgetTotalInfo: description: Budget Revenue information for a Catering code. $ref: '#/components/schemas/cateringInfoType' forecastTotalInfo: description: Forecast Revenue information for a Catering code. $ref: '#/components/schemas/cateringInfoType' actualTotalInfo: description: Actual Revenue information for a Catering code. $ref: '#/components/schemas/cateringInfoType' aFVarianceTotalInfo: description: Actual Forecast variance for a Catering code. $ref: '#/components/schemas/cateringVarianceInfoType' aBVarianceTotalInfo: description: Actual Budget variance for a Catering code. $ref: '#/components/schemas/cateringVarianceInfoType' fBVarianceTotalInfo: description: Forecast Budget variance for a Catering code. $ref: '#/components/schemas/cateringVarianceInfoType' transactionDiscounts: type: object properties: transactionDiscounts: description: Collection of Transaction Discount Configurations. type: array maxItems: 4000 items: $ref: '#/components/schemas/hotelTransactionDiscountType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' aRPaymentType: type: object description: Details of an AR Payment. properties: age: description: The Aging age of the payment. type: integer amount: description: Amount of the Payment. $ref: '#/components/schemas/currencyAmountType' amountUsed: description: Total amount applied against an invoice. $ref: '#/components/schemas/currencyAmountType' balance: description: Amount still open which has not been applied against any invoice. $ref: '#/components/schemas/currencyAmountType' reference: description: User-defined posting reference. type: string minLength: 0 maxLength: 2000 remark: description: User-defined posting remark. type: string minLength: 0 maxLength: 2000 cashierInfo: description: Cashier information. Contains Id and Name details of the cashier. $ref: '#/components/schemas/cashierInfoType' paymentCard: description: Payment card details. $ref: '#/components/schemas/resPaymentCardType' transferredOut: type: boolean transferredIn: type: boolean hotelId: description: Property code. type: string minLength: 0 maxLength: 20 transactionNo: description: Unique Transaction Identifier of the Payment. type: number transactionDate: description: Date of the Payment. type: string format: date maxLength: 8 transactionCode: description: Transaction code of the Payment. type: string minLength: 0 maxLength: 20 postingDate: description: Posting date of the invoice. type: string format: date maxLength: 8 revenueDate: description: Revenue date ID of the invoice. type: string format: date maxLength: 8 transferDate: description: Transfer of the invoice. type: string format: date maxLength: 8 sequenceNo: description: When this PostingType is used to return the postings generated by a batch request, the sequence number is used to relate to the Request's sequence number. type: integer reservationBlockType: type: object description: Key information about the block for a reservation. properties: blockIdList: description: Collection of unique block identifiers for the reservation. $ref: '#/components/schemas/blockIdList' blockName: description: The Name of the block that is attached to the reservation. type: string minLength: 0 maxLength: 40 hotelId: description: This is the HotelCode of the Block. type: string minLength: 0 maxLength: 20 fixedChargeFrequencyType: type: string description: Yearly. enum: - O - D - W - M - Q - Y transactionDiscountRuleType: type: string description: The rule type on which the transaction discount is based. enum: - Membership fiscalPeriods: type: object properties: fiscalPeriods: description: Details of the Fiscal Periods to be created $ref: '#/components/schemas/fiscalPeriodsType' cycleFiscalPeriods: description: Details of the Cycle Fiscal Periods type: object properties: cycleFiscalPeriods: description: Details of the Cycle Fiscal Periods $ref: '#/components/schemas/cycleFiscalPeriodsType' forceDelete: description: If true all overlapping periods will be deleted. No further confirmation required. type: boolean links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' anonymizationStatusType: type: string description: Guest has been anonymized. enum: - Requested - Anonymized fiscalPeriodsType: type: array description: List of Fiscal Periods. maxItems: 4000 items: $ref: '#/components/schemas/fiscalPeriodType' rateCodeTotalInformationType: type: object description: Budget Forecast information for segment. properties: budgetTotalInfo: description: Budget Revenue information for a segment . $ref: '#/components/schemas/revenueNightsInfoType' forecastTotalInfo: description: Forecast Revenue information for a segment . $ref: '#/components/schemas/revenueNightsInfoType' actualTotalInfo: description: Actual Revenue information for a segment . $ref: '#/components/schemas/revenueNightsInfoType' aFVarianceTotalInfo: description: Actual Forecast Revenue variance for a segment . $ref: '#/components/schemas/revenueNightsVarianceInfoType' aBVarianceTotalInfo: description: Actual Budget Revenue variance for a segment . $ref: '#/components/schemas/revenueNightsVarianceInfoType' fBVarianceTotalInfo: description: Forecast Budget Revenue variance for a segment . $ref: '#/components/schemas/revenueNightsVarianceInfoType' taxBracketsCopy: type: object properties: copyInstructions: description: List of the Tax Brackets details to be copied to hotel(s). $ref: '#/components/schemas/copyConfigurationCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' customChargeExemptionsConfigToBeChanged: type: object properties: customChargeExemptionsConfig: type: array description: Existing Custom Charge Exemptions to be changed. maxItems: 100 items: $ref: '#/components/schemas/customChargeExemptionsConfigType' warnings: $ref: '#/components/schemas/warningsType' roleLevelType: type: string enum: - Global - Template - Chain - Brand - Property hotelTransactionDiscountType: type: object description: Provides information about Transaction Discount Configuration. properties: hotelId: description: Indicates for which hotel this transaction discount apply to. type: string minLength: 1 maxLength: 20 transactionDiscountCode: description: Unique code of the transaction discount. type: string minLength: 1 maxLength: 20 description: description: Description of the transaction discount. type: string minLength: 1 maxLength: 2000 ruleType: description: The rule type on which the Transaction Discount is based. $ref: '#/components/schemas/transactionDiscountRuleType' codeType: description: The rule type on which the Transaction Discount is based. $ref: '#/components/schemas/transactionDiscountCodeType' amount: description: The amount applicable to the transaction discount.This would be a positive amount indicating the discount. type: number format: double minimum: 0 percent: description: A percentage value if the transaction discount is percentage based. type: number minimum: 0 maximum: 100 inactive: description: Indicates whether the transaction discount is inactive or not. type: boolean orderSequence: description: Display Order sequence. type: number minimum: 1 transactionDiscountId: description: Unique code of the transaction discount. type: number discountAttributes: description: Holds Transaction Discounts Attributes details.If discount is applied to a membership type, only membership type details are required. If discount is applied on a membership level , membership type and membership level details are required. type: array maxItems: 2 items: $ref: '#/components/schemas/transactionDiscountsAttributeType' articleCodes: description: Collection of article codes eligible for transaction discounts. type: array maxItems: 2000 items: type: string transactionCodes: description: Collection of transaction codes eligible for transaction discounts. type: array items: type: string managedBy: $ref: '#/components/schemas/managedByOptions' required: - hotelId - transactionDiscountCode - description - ruleType - codeType - discountAttributes externalReferenceType: type: object description: This type contains unique information of external reference. properties: id: description: Unique ID of external reference. type: string minLength: 0 maxLength: 80 idExtension: description: ID extension for external reference. type: integer idContext: description: ID context for external reference. type: string minLength: 0 maxLength: 80 folioCodeDescriptionType: type: object description: This contains a folio code and description information. properties: code: description: Code. type: string minLength: 0 maxLength: 100 description: description: description. type: string minLength: 0 maxLength: 2000 fiscalPeriodsInfo: type: object properties: fiscalPeriods: description: Collection of Fiscal Periods $ref: '#/components/schemas/fiscalPeriodsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' anonymizationType: type: object description: Provides information about guest's anonymization status. properties: anonymizationStatus: description: Status of anonymization such as Requested or Anonymized. $ref: '#/components/schemas/anonymizationStatusType' anonymizationDate: description: Date and Time when the guest was anonymized. type: string format: date-time hotelInterfaceTypeType: type: string enum: - Bms - Cas - Ccw - Dls - Eft - Exp - Mak - Mbs - Msc - Pbx - Pos - Svs - Tik - Vid - Vms - Www - Xml description: XML Posting Interface controlSequenceType: type: object description: Provides information about the OPERA Control Sequence properties: hotelId: description: Control Sequence code associated with Hotel type: string minLength: 0 maxLength: 20 controlCode: description: Identifier of Opera Control Sequence $ref: '#/components/schemas/controlSequenceCodeType' folioType: description: Opera Control Sequence associated with folio $ref: '#/components/schemas/folioCodeDescriptionType' minimum: description: Minimum value of Opera Control Sequence type: number maximum: description: Maximum value of Opera Control Sequence type: number countryCode: description: Opera Control Sequence belongs to country type: string minLength: 0 maxLength: 20 sequenceValue: description: Current Sequence Value for the OPERA Sequence type: number changeTransactionCodeOwnershipType: type: object description: Change Transaction Code Ownership configuration details. properties: transactionCodes: description: List of unique Transaction Codes. $ref: '#/components/schemas/codeListType' hotelId: description: Hotel Code for which to update ownership of the Transaction codes type: string minLength: 0 maxLength: 20 ownershipStatus: description: Ownership status to which the Transaction Codes have to be changed $ref: '#/components/schemas/trxOwnershipType' responses: '406': description: Not acceptable. '503': description: Service Unavailable '413': description: Request Entity Too Large '403': description: Forbidden '500': description: System Error content: application/json: schema: $ref: '#/components/schemas/exceptionDetailType' '415': description: Unsupported Media Type '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/exceptionDetailType' '401': description: Unauthorized '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/exceptionDetailType' '405': description: Method not allowed '414': description: Request URI Too Large '502': description: Bad Gateway parameters: authKey: name: authorization description: Bearer token that needs to be passed which is generated post user authentication in: header required: true schema: type: string x-externalsystem: name: x-externalsystem description: External system code. in: header x-example: EXTERNALSYSTEMCODE schema: type: string maxLength: 40 x-hotelid: name: x-hotelid description: Mandatory parameter to identify the hotel code where the end user is logged in in: header required: true schema: type: string Accept-Language: name: Accept-Language description: Language code in: header schema: type: string x-app-key: name: x-app-key description: Client or Partner's Application Key in: header required: true schema: type: string pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$ x-request-id: name: x-request-id description: Request Id of an incoming request in: header schema: type: string pattern: ~*[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12} externalData: name: externalData description: Pass this header as true, if payload needs DVM in: header schema: type: string x-originating-application: name: x-originating-application description: Customer's Integration Application Id in: header schema: type: string externalDocs: description: Find out more about Oracle Hospitality url: https://docs.oracle.com/en/industries/hospitality/integration_platforms.html