openapi: 3.2.0 info: title: Oracle Hospitality Cashiering API version: 26.2.0.0 contact: email: hospitality_apis_ww_grp@oracle.com license: name: UPL url: https://opensource.org/licenses/upl termsOfService: https://www.oracle.com/legal/terms.html description: 'Operations tagged Cashiering across 3 of this provider''s published API definitions: oracle-hospitality-property-outbound-cshoutbound.json, oracle-hospitality-property-v1-csh.json, oracle-hospitality-property-v1-cshasync.json. Each path carries the servers of the definition it was published in.' servers: - url: /csh/v1 - url: /csh/async/v1 tags: - name: Cashiering description: Cashiering module provides APIs to service front desk billing requirements, as well as any requirements related to a reservation's folio. You can retrieve a guest folio, post billing charges to guest folio, add routing instructions to a reservation, view authorization history, all the way through to checking the guest out using the postCheckOut API. paths: /hotels/{hotelId}/memberships/{membershipId}/compRedemptions: get: summary: Operation to get complimentary redemptions for a guest having PTS Membership Type description: You can use this API to get complimentary redemptions for a guest having PTS Membership Type

OperationId:getCompRedemptions

operationId: getCompRedemptions parameters: - name: membershipId in: path required: true description: Membership number of the guest in the reservation schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel 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/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 type for Complimentary Redemptions retrieval. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/fetchCompRedemptionsRS' '204': description: CompRedemptions 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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/memberships/{membershipId}/compRedemptionAuthorizations: put: summary: Operation to authorize complimentary redemptions for a guest having PTS Membership Type description: You can use this API to authorize complimentary redemptions for a guest having PTS Membership Type

OperationId:authorizeCompRedemptions

operationId: authorizeCompRedemptions parameters: - name: membershipId in: path required: true description: Membership number of the guest in the reservation schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel 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/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 type of Complimentary Redemptions authorization. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/authorizeCompRedemptionsRS' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/authorizeCompRedemptionsRQ' description: Request type for Complimentary Redemptions authorization. required: true servers: - url: /csh/v1 /hotels/{hotelId}/memberships/{membershipId}/compRedemptionPostings: post: summary: Operation to post complimentary redemptions for a guest having PTS Membership Type description: You can use this API to post complimentary redemptions for a guest having PTS Membership Type

OperationId:postCompRedemptions

operationId: postCompRedemptions parameters: - name: membershipId in: path required: true description: Membership number of the guest in the reservation schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel 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/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 type for Complimentary Redemptions posting. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/postCompRedemptionsRS' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/postCompRedemptionsRQ' description: Request type of Complimentary Redemptions posting. required: true servers: - url: /csh/v1 /hotels/{hotelId}/memberships/{membershipId}/compRedemptionReversals: post: summary: Operation to reverse complimentary redemptions for a guest having PTS Membership Type description: You can use this API to reverse complimentary redemptions for a guest having PTS Membership Type

OperationId:reverseCompRedemptions

operationId: reverseCompRedemptions parameters: - name: membershipId in: path required: true description: Membership number of the guest in the reservation schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel 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/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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/reverseCompRedemptionsRQ' description: Request type of Complimentary Redemptions reversal. required: true servers: - url: /csh/v1 /hotels/{hotelId}/asyncCompPostingsApproval: put: summary: Operation to request for submitting bulk comp postings for vendor approval. description: The API will only submit the request to the vendor and does not wait for the response and it is an asynchronous API. Also, the caller of the API will get an HTTP 200 response code.

OperationId:asyncApproveCompPostings

operationId: asyncApproveCompPostings parameters: - name: hotelId in: path required: true description: Unique ID of the hotel 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/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 bulk submit comp transactions request. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/sendBulkCompTransactionsStatus' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/bulkCompTransactionsCriteriaType' description: Request object to submit comp transactions request in bulk to gaming system. required: true servers: - url: /csh/v1 /hotels/{hotelId}/compPostingsApproval: put: summary: Operation to request for comp postings approval. description: You can use this API to submit Comp Transactions.

OperationId:approveCompPostings

operationId: approveCompPostings parameters: - name: hotelId in: path required: true description: Unique ID of the hotel 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/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 submit comp transactions request. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/sendCompTransactionsStatus' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/compTransactionsCriteriaType' description: Request object to submit comp transactions request to gaming system required: true servers: - url: /csh/v1 /hotels/{hotelId}/compPostingsReversal: put: summary: Operation to request for comp postings reversal. description: You can use this API to reverse Comp Transactions.

OperationId:reverseCompPostings

operationId: reverseCompPostings 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/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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/compTransactionsCriteriaType' description: Request object for comp postings reversal to be sent to the gaming system. required: true servers: - url: /csh/v1 /cashierReportPostings: get: summary: Get Cashier Report Postings description: You can use this API to get Cashier Report postings.

OperationId:getCashierReportPostings

This API allows a time span of 30 days.

operationId: getCashierReportPostings parameters: - name: hotelId in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - 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 - name: requestType in: query required: false description: Shift drop report created when cashier closure is completed. It is an integral part of closure report and is not to be printed or accessed by itself. schema: type: string enum: - Cash - Check - ForeignCurrency - CreditCard - Miscellaneous - ArSettlements - DepositTransfers - Shiftdrop uniqueItems: true - name: closureNo in: query required: false description: The Cashier Shift Number. schema: type: number - name: cashierId in: query required: false description: The Cashier ID of the Cashier who is currently processing the transaction(s). schema: type: number - name: shiftDropLocationCode in: query required: false description: Cashier closure shift drop location code. schema: type: string - name: bagNumberForOthers in: query required: false description: Cashier closure shift drop others payment method type bag number. schema: type: string - name: bagNumberForCash in: query required: false description: Cashier closure shift drop cash payment method type bag number. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 the Cashier report transactions. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/cashierReportPostingsInfo' '204': description: CashierReportPostings 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: - Cashiering servers: - url: /csh/v1 /cashiers/{cashierId}/closure: put: summary: Close Cashier description: You can use this API to change Cashier Closure.

OperationId:putCashier

operationId: putCashier parameters: - name: cashierId in: path required: true description: Unique ID of the cashier. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/cashierClosure' description: Request to close cashier's shift. required: true servers: - url: /csh/v1 /cashiers/{cashierId}/locks: get: summary: Acquire Cashier Locks description: You can use this API to Acquire Cashier Locks.

OperationId:getCashierLock

operationId: getCashierLock parameters: - name: cashierId in: path required: true description: Unique ID of the cashier. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 the Cashier Lock request. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/acquiredCashierLock' '204': description: CashierLock 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: - Cashiering delete: summary: Break Cashier Lock description: You can use this API to Break Cashier Lock.

OperationId:breakCashierLock

operationId: breakCashierLock parameters: - name: cashierId in: path required: true description: Unique ID of the cashier. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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: - Cashiering servers: - url: /csh/v1 /cashiers/{cashierId}/transactions: get: summary: Get Cashier Transactions description: You can use this API to get Cashier Transactions.

OperationId:getCashierTransactions

operationId: getCashierTransactions parameters: - name: cashierId in: path required: true description: Unique ID of the cashier. schema: type: string maxLength: 2000 minLength: 1 - name: closureNo in: query required: false description: The Cashier Shift Number. schema: type: number - name: shiftDropLocationCode in: query required: false description: Cashier closure shift drop location code. schema: type: string - name: bagNumberForOthers in: query required: false description: Cashier closure shift drop others payment method type bag number. schema: type: string - name: bagNumberForCash in: query required: false description: Cashier closure shift drop cash payment method type bag number. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 the fetch cashier's shift transactions. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/cashierTransactionsDetails' '204': description: CashierTransactions 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: - Cashiering servers: - url: /csh/v1 /cashiersLock/{lockId}: delete: summary: Release Cashier Lock description: You can use this API to Release Cashier Lock.

OperationId:releaseCashierLock

operationId: releaseCashierLock parameters: - name: lockId in: path required: true description: Unique ID of the lock. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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: - Cashiering servers: - url: /csh/v1 /compAccountingJournal: get: summary: Get Comp Accounting Journal description: You can use this API to get Comp Accounting Journal.

This API is deprecated. Please use getCompPostingJournal instead

OperationId:getCompAccountingJournal

The maximum allowable limit for this API is 50.

This API allows a time span of 30 days.

operationId: getCompAccountingJournal deprecated: true parameters: - 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: 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 - name: filterTransactionCode in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: hotelId in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: filterRoomNumber in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: id in: query description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. required: false style: form explode: true schema: type: array items: type: string - name: idContext in: query description: Used to identify the source of the identifier (e.g., IATA, ABTA). required: false style: form explode: true schema: type: array items: type: string - name: type in: query description: A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT). required: false style: form explode: true schema: type: array items: type: string - name: approvalCode in: query required: false description: Filters the results for approval code. schema: type: string - name: code in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: authorizerNameCode in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: referenceNumberWildCard in: query required: false description: Filters the results for reference number. schema: type: string - name: supplementWildCard in: query required: false description: Filter the results for supplement. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 the Complimentary Posting Journal. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/compAccountingJournal' '204': description: CompAccountingJournal 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: - Cashiering servers: - url: /csh/v1 /fbaReimbursements: post: summary: Create FBA Reimbursement description: You can use this API to create FBA Reimbursement.

OperationId:postFBAReimbursement

operationId: postFBAReimbursement parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/fbaReimbursementCriteria' description: PostFBAReimbursement operation posts reimbursement against the selected certificate records. required: true servers: - url: /csh/v1 /fbaSettlements: post: summary: Create FBA Settlement description: You can use this API to create FBA Settlement.

OperationId:postFBASettlement

operationId: postFBASettlement parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/fbaReimbursementCriteria' description: PostFBASettlement operation posts settlement against the selected certificate records. required: true servers: - url: /csh/v1 /foreignCurrency: put: summary: Calculate Foreign Currency description: This API will allow you to Calculate Foreign Currency exchange.

OperationId:calculateForeignCurrency

operationId: calculateForeignCurrency parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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: Information regarding charges in batch result for each reservation. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/calculatedForeignCurrency' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/foreignCurrencyCriteria' description: Operation to calculate foreign currency exchange. required: true servers: - url: /csh/v1 /foreignCurrencyExchange: post: summary: Create Foreign Currency Exchange description: You can use this API to Create Foreign Currency Exchange.

OperationId:postForeignCurrencyExchange

operationId: postForeignCurrencyExchange parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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: Response of the posting foreign currency exchange transaction. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/foreignCurrencyExchangeTransaction' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/foreignCurrencyExchange' description: A set of posting transactions that need to be posted with regards to exchange. required: true servers: - url: /csh/v1 /hotels/{hotelId}/advanceFolio/batchJobs: post: summary: Create Batch Advance Folio description: You can use this API to create Batch Advance Folio.

OperationId:postAdvanceFolio

operationId: postAdvanceFolio 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_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/batchAdvanceFolio' description: Request for submitting batch advance folio. required: true servers: - url: /csh/v1 /hotels/{hotelId}/articlesSale: post: summary: Create Articles Sale description: You can use this API to create Articles Sale.

OperationId:postArticlesSale

operationId: postArticlesSale 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_2' - $ref: '#/components/parameters/x-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: Details of the folio created. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/articlesSale' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/articlesSaleCriteria' description: Request to post a set of charges, payments and generate a bill for a PasserBy or for the Post-It functionality . A PasserBy is someone who is not staying at the Property. A PasserBy transaction requires a Profile in Opera for whom the the folio is being created. required: true servers: - url: /csh/v1 /hotels/{hotelId}/authorizers/credits: get: summary: Get Authorizers Credit Info description: You can use this API to get Authorizers Credit Info.

OperationId:getAuthorizersCreditInfo

operationId: getAuthorizersCreditInfo parameters: - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - 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 - name: code in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: includeCreditDetails in: query required: false description: This flag will notify the service if the Credit details will also be returned or not. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 credit information of Comp Accounting Authorizers. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/authorizersCreditInfo' '204': description: AuthorizersCreditInfo 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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/autoCheckoutReservations/batchJobs: post: summary: 'Create Auto Checkout Reservation Batch ' description: You can use this API to create Auto Checkout Reservation Batch.

OperationId:postAutoCheckoutReservations

operationId: postAutoCheckoutReservations 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_2' - $ref: '#/components/parameters/x-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: Response for batch auto check out. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/batchAutoCheckoutDetails' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/batchAutoCheckoutReservation' description: Request type for batch auto checkout. required: true servers: - url: /csh/v1 /hotels/{hotelId}/autoSettlements/batchJobs: post: summary: Create Batch Auto Settlement description: You can use this API to create Batch Auto Settlement.

OperationId:postBatchAutoSettlement

operationId: postBatchAutoSettlement 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_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/batchAutoSettlementCriteria' description: Request type for batch auto settlement. required: true servers: - url: /csh/v1 /hotels/{hotelId}/batchDeposits: post: summary: Create batch deposits description: You can use this API to create batch deposits.

OperationId:postBatchDeposit

operationId: postBatchDeposit 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_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/batchDeposit' description: Request for submitting batch deposit for reservations. required: true servers: - url: /csh/v1 /hotels/{hotelId}/bedTax: get: summary: Get bed tax information description: You can use this API to Retrieve bed tax information for a property.

OperationId:getBedTaxInfo

operationId: getBedTaxInfo parameters: - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: arrival in: query required: false description: Arrival Date of the reservation schema: type: string format: date - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 bed transaction info content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/bedTaxInfo' '204': description: BedTaxInfo 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: - Cashiering post: summary: Create bed tax information description: You can use this API to create new bed tax information for a property.

OperationId:postBedTaxInfo

operationId: postBedTaxInfo 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_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/bedTaxCriteria' description: Request type for create bed transaction info required: true servers: - url: /csh/v1 /hotels/{hotelId}/bedTax/{taxRegistraitionNo}: put: summary: Change bed tax information description: You can use this API to Update bed tax information for a property.

OperationId:putBedTaxInfo

operationId: putBedTaxInfo deprecated: true parameters: - name: taxRegistraitionNo in: path required: true description: Unique number of the tax registration. schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/bedTaxCriteria' description: Request type for change bed transaction info required: true delete: summary: Delete bed tax information description: You can use this API to delete bed tax information for a property.

OperationId:removeBedTaxInfo

operationId: removeBedTaxInfo deprecated: true parameters: - name: taxRegistraitionNo in: path required: true description: Unique number of the tax registration. schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/billingCharges: put: summary: Change Billing Charges description: You can use this API to change Billing Charges.

OperationId:putBillingCharges

operationId: putBillingCharges 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_2' - $ref: '#/components/parameters/x-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/putBillingChargesStatus' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/putBillingCharges' description: Request to edit multiple billing charge information. required: true servers: - url: /csh/v1 /hotels/{hotelId}/bulkCCSettlements/{batchId}/status: get: summary: Get Batch CC Settlements Status description: You can use this API to get Batch CC Settlements Status.

OperationId:getBatchCCSettlementsStatus

operationId: getBatchCCSettlementsStatus parameters: - name: batchId in: path required: true description: Unique ID of the batch schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: id in: query description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. required: false style: form explode: true schema: type: array items: type: string - name: idContext in: query description: Used to identify the source of the identifier (e.g., IATA, ABTA). required: false style: form explode: true schema: type: array items: type: string - name: type in: query description: A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT). 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_2' - $ref: '#/components/parameters/x-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 credit card settlements status. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ccBatchSettlementsStatus' '204': description: BatchCCSettlementsStatus 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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/bulkPrepaidCards: post: summary: Create multiple Prepaid Cards description: You can use this API to create multiple Prepaid Cards.

OperationId:postBulkPrepaidCards

operationId: postBulkPrepaidCards 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_2' - $ref: '#/components/parameters/x-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/bulkPrepaidCardsType' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/bulkPrepaidCardCriteria' description: Request type for bulk prepaid card creation process required: true servers: - url: /csh/v1 /hotels/{hotelId}/cashiers/{cashierId}/closure: get: summary: Get Cashier Closure description: You can use this API to get Cashier Closure.

OperationId:getCashierClosure

operationId: getCashierClosure parameters: - name: cashierId in: path required: true description: Unique ID of the cashier. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: cashierLockHandle in: query required: false description: The Cashier Lock Handle to pass along with operation which required cashier to be locked. schema: type: number - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 the fetch Cashier Closure information. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/cashierClosureDetails' '204': description: CashierClosure 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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/cashiers/{cashierId}/closureReports: get: summary: Get Cashier Closure Reports List description: You can use this API to get Cashier Closure Reports List.

OperationId:getCashierClosureReportsList

operationId: getCashierClosureReportsList parameters: - name: cashierId in: path required: true description: Unique ID of the cashier. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: closureNo in: query required: false description: The Cashier Shift Number. schema: type: number - name: shiftDropLocationCode in: query required: false description: Cashier closure shift drop location code. schema: type: string - name: bagNumberForOthers in: query required: false description: Cashier closure shift drop others payment method type bag number. schema: type: string - name: bagNumberForCash in: query required: false description: Cashier closure shift drop cash payment method type bag number. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 whether a particular report is applicable or not based on payment posting type. When no postings for a particular payment type is found, that report is marked as not applicable in the closure report. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/cashierClosureReportsList' '204': description: CashierClosureReportsList 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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/cashiers/{cashierId}/folioTaxPayments: put: summary: Change folio tax payments description: You can use this API to change folio tax payments.

OperationId:reverseFolioTaxPayment

operationId: reverseFolioTaxPayment parameters: - name: cashierId in: path required: true description: Unique ID of the cashier. schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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 for the reverse Thailand Tax Payment Tax record request. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/folioTaxPaymentReversal' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/transactionReversal' description: Request to reverse a Payment Tax record for Thailand Tax requirement. required: true servers: - url: /csh/v1 /hotels/{hotelId}/cashierslock/{lockId}: put: summary: Extend Cashier Lock description: You can use this API to Extend cashiers lock.

OperationId:putCashierLock

operationId: putCashierLock parameters: - name: lockId in: path required: true description: Unique ID of the lock. schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: This response will indicate whether or not the extension was successful. This operation may return errors when the lock being requested to be extended no longer exists. This can happen when the lock has already expired and cleaned up. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/extendedCashierLock' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/cashierLockCriteriaToExtend' description: Operation for extending the lifetime of a lock on a cashier. required: true servers: - url: /csh/v1 /hotels/{hotelId}/cashsurcharge: get: summary: Get Cash Surcharge Information description: You can use this API to get the Cash Surcharge Information.

OperationId:getCashSurchargeInfo

operationId: getCashSurchargeInfo parameters: - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: cashierId in: query required: false description: The Cashier ID of the Cashier who is currently processing the transaction(s). schema: type: number - name: folioView in: query required: false schema: type: integer - name: paymentMethod in: query required: false schema: type: string - name: trxAmount in: query required: false description: Amount on which the Cash Surcharge has to be applied. 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 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 to the request to fetch Cash Surcharge information for a Cash/Cheque Payment method. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/cashSurchargeDetails' '204': description: CashSurchargeInfo 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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/ccSettlement: post: summary: Create CreditCard Settlement description: You can use this API to create cc Settlement.

OperationId:postCCSettlement

operationId: postCCSettlement 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_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/ccSettlementCriteria' description: Request object to change credit card settlement information. required: true servers: - url: /csh/v1 /hotels/{hotelId}/ccSettlements/batchJobs: post: summary: Create Batch CC Settlements description: You can use this API to create Batch CC Settlements.

OperationId:postBatchCCSettlements

operationId: postBatchCCSettlements 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_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/ccBatchSettlementsProcessCriteria' description: Request to process batch settlements required: true servers: - url: /csh/v1 /hotels/{hotelId}/check/{checkNumber}: get: summary: Get check details description: You can use this API to get check details.

OperationId:getCheckDetails

operationId: getCheckDetails parameters: - name: checkNumber in: path required: true description: Unique number of the check schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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 to Fetch the check details for a given posting posted through the POS. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/checkDetails' '204': description: CheckDetails 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: - Cashiering post: summary: Post Guest Check Details description: This operation is to add guest check details for posted check transactions.

OperationId:postGuestCheckDetails

operationId: postGuestCheckDetails parameters: - name: checkNumber in: path required: true description: Unique number of the check schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/guestCheckDetails' description: Request to process a guest check detail. required: true put: summary: Update Guest Check Details description: This operation is to update guest check details for posted check transactions.

OperationId:putGuestCheckDetails

operationId: putGuestCheckDetails parameters: - name: checkNumber in: path required: true description: Unique number of the check schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/changeGuestCheckDetails' description: Request to update the guest check detail. required: true servers: - url: /csh/v1 /hotels/{hotelId}/check/{checkNumber}/charges: delete: summary: Delete Billing Check Charges description: You can use this API to delete (void) Billing Check Charges.

OperationId:voidBillingCheckCharges

operationId: voidBillingCheckCharges parameters: - name: checkNumber in: path required: true description: Unique number of the check. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: revenueDate in: query required: false description: The date against which void (reverse) charges are posted. schema: type: string format: date - 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: reservationId 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: reservationIdContext in: query required: false description: Used to identify the source of the identifier (e.g., IATA, ABTA). schema: type: string - name: reservationIdType in: query required: false description: A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT). schema: type: string - name: checkId 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: checkIdContext in: query required: false description: Used to identify the source of the identifier (e.g., IATA, ABTA). schema: type: string - name: checkIdType in: query required: false description: A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT). schema: type: string - name: cashierId in: query required: false description: Cashier Id of the Cashier. schema: type: number - name: postingRemark in: query required: false description: Text describing any applicable detail of the posting. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/closureList: get: summary: Get Cashier Closure Information description: You can use this API to get Cashier Closure Information.

OperationId:getCashierClosureInfo

operationId: getCashierClosureInfo parameters: - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: closureNo in: query required: false description: The Cashier Shift Number. schema: type: number - name: cashierId in: query required: false description: The Cashier ID of the Cashier who is currently processing the transaction(s). schema: type: number - name: shiftDropLocationCode in: query required: false description: Cashier closure shift drop location code. schema: type: string - name: bagNumberForOthers in: query required: false description: Cashier closure shift drop others payment method type bag number. schema: type: string - name: bagNumberForCash in: query required: false description: Cashier closure shift drop cash payment method type bag number. schema: type: string - name: closureBusinessDate in: query required: false description: Business Date of cashier closure. schema: type: string format: date - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 to the request to get financial details for a Posting Activity. This will return the before and after values for the transactions which were changed. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/cashierClosureInformation' '204': description: CashierClosureInfo 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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/compAccountingJournal: get: summary: Get Comp Accounting Journal description: You can use this API to get Comp Accounting Journal.

OperationId:getCompPostingJournal

The maximum allowable limit for this API is 50.

This API allows a time span of 30 days.

operationId: getCompPostingJournal parameters: - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - 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: 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 - name: filterTransactionCode in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: filterRoomNumber in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: id in: query description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. required: false style: form explode: true schema: type: array items: type: string - name: idContext in: query description: Used to identify the source of the identifier (e.g., IATA, ABTA). required: false style: form explode: true schema: type: array items: type: string - name: type in: query description: A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT). required: false style: form explode: true schema: type: array items: type: string - name: approvalCode in: query required: false description: Filters the results for approval code. schema: type: string - name: code in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: authorizerNameCode in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: referenceNumberWildCard in: query required: false description: Filters the results for reference number. schema: type: string - name: supplementWildCard in: query required: false description: Filter the results for supplement. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 the Complimentary Posting Journal. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/compAccountingJournal' '204': description: CompAccountingJournal 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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/compRoutingInstructions: get: summary: Get Comp Routing Instructions description: You can use this API to get Comp Routing Instructions.

OperationId:getCompRoutingInstructions

This API allows a time span of 30 days.

operationId: getCompRoutingInstructions deprecated: true parameters: - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: end in: query required: false description: The ending value of the date range. schema: type: string format: date - name: start in: query required: false description: The starting value of the date range. schema: type: string format: date - name: nameWildcard in: query required: false description: Family name or last name of the guest schema: type: string - name: firstNameWildCard in: query required: false description: Given name or first name of the guest. schema: type: string - name: roomNumberCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: id in: query description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. required: false style: form explode: true schema: type: array items: type: string - name: idContext in: query description: Used to identify the source of the identifier (e.g., IATA, ABTA). required: false style: form explode: true schema: type: array items: type: string - name: type in: query description: A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT). required: false style: form explode: true schema: type: array items: type: string - name: membershipId in: query required: false description: Membership Card number. schema: type: string - name: code in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: resStatusCode in: query description: This reservation is in checked in status and the business date is past departure date. This could occur when ORS and PMS are in same environment. required: false style: form explode: true schema: type: array items: type: string enum: - Reserved - Requested - NoShow - Cancelled - InHouse - CheckedOut - Waitlisted - DueIn - DueOut - Walkin - PendingCheckout uniqueItems: true - name: compRoutingStatuses in: query description: Status which indicates that the Request of Comp Routing was declined required: false style: form explode: true schema: type: array items: type: string enum: - Request - Comp - Declined uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 containing comp routing instructions for a reservation . content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/compRoutingInstructions' '204': description: CompRoutingInstructions 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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/compRoutingInstructions/searches: post: summary: Get Comp Routing Instructions description: You can use this API to get Comp Routing Instructions.

OperationId:searchCompRoutingInstructions

This API allows a time span of 30 days.

operationId: searchCompRoutingInstructions 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_2' - $ref: '#/components/parameters/x-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 containing comp routing instructions for a reservation . content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/compRoutingInstructions' '204': description: CompRoutingInstructions 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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/searchCompRoutingInstructionsRequest' description: searchCompRoutingInstructions Request servers: - url: /csh/v1 /hotels/{hotelId}/compTrxAuthorizers: get: summary: Get Comp Trx Authorizers description: You can use this API to get Comp Trx Authorizers.

OperationId:getCompTrxAuthorizers

operationId: getCompTrxAuthorizers parameters: - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: cashierId in: query required: false description: The Cashier ID of the Cashier who is currently processing the transaction(s). schema: type: number - name: id in: query description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. required: false style: form explode: true schema: type: array items: type: string - name: idContext in: query description: Used to identify the source of the identifier (e.g., IATA, ABTA). required: false style: form explode: true schema: type: array items: type: string - name: type in: query description: A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT). required: false style: form explode: true schema: type: array items: type: string - name: targetFolioWindowNo in: query required: false description: Folio Window Number to where transactions will be transfered. schema: type: integer - name: uniqueIdId in: query description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. required: false style: form explode: true schema: type: array items: type: string - name: uniqueIdIdContext in: query description: Used to identify the source of the identifier (e.g., IATA, ABTA). required: false style: form explode: true schema: type: array items: type: string - name: uniqueIdType in: query description: A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT). required: false style: form explode: true schema: type: array items: type: string - name: transaction in: query description: List of transactions to be transfered. required: false style: form explode: true schema: type: array items: type: number maxItems: 4000 - name: authorizerIdId 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: authorizerIdIdContext in: query required: false description: Used to identify the source of the identifier (e.g., IATA, ABTA). schema: type: string - name: authorizerIdType in: query required: false description: A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT). schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 comp authorizers operation. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/compTrxAuthorizers' '204': description: CompTrxAuthorizers 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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/covers: get: summary: Get transaction covers description: You can use this API to get Trx Covers.

OperationId:getTransactionCovers

operationId: getTransactionCovers parameters: - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: coversDate in: query required: true schema: type: string format: date - name: transactionCode in: query required: false description: Transaction Code to search. 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_2' - $ref: '#/components/parameters/x-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 when searching for trx covers. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/coversInfo' '204': description: PostCovers 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: - Cashiering put: summary: Change Transaction Covers description: You can use this API to change Trx Covers.

OperationId:changeTransactionCovers

operationId: changeTransactionCovers 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_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/coversInfo' description: To change the trx cover for the given date and transaction code. required: true servers: - url: /csh/v1 /hotels/{hotelId}/creditBill: post: summary: Create Credit Bill description: You can use this API to create Credit Bill.

OperationId:postCreditBill

operationId: postCreditBill 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_2' - $ref: '#/components/parameters/x-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: Response for the request to create a Credit Folio. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/postedCreditBill' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/creditBillCriteria' description: Request to post a Credit Folio for an existing Folio. Credit Bill Functionality parameter is required. required: true servers: - url: /csh/v1 /hotels/{hotelId}/creditBill/action/validate: put: summary: Validate Credit Bill description: You can use this API to validate credit Bill.

OperationId:validateCreditBill

operationId: validateCreditBill 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_2' - $ref: '#/components/parameters/x-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 to the request to check if a Folio is valid for Credit Bill. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/validatedCreditBill' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/creditBillCriteria' description: Request to check if a Folio is valid for Credit Bill. required: true servers: - url: /csh/v1 /hotels/{hotelId}/creditLimitsOveragePayments: get: summary: Get Credit Limits Overage Payments description: You can use this API to get Credit Limits Overage Payments.

OperationId:getCreditLimitOveragePayments

operationId: getCreditLimitOveragePayments parameters: - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: guestNameWildCard in: query required: false description: Guest name associated with the transaction. schema: type: string - name: roomNumberWildCard in: query required: false description: Room number associated with the transaction. schema: type: string - name: code 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_2' - $ref: '#/components/parameters/x-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 Credit Limit Overage Payments request content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/creditLimitOveragePaymentsInfo' '204': description: CreditLimitOveragePayments 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: - Cashiering post: summary: Create Credit Limit Overage Payments description: You can use this API to create Credit Limit Overage Payments.

OperationId:postCreditLimitOveragePayments

operationId: postCreditLimitOveragePayments 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_2' - $ref: '#/components/parameters/x-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: Response for Submit Credit Limit Overage Payments request content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/creditLimitOveragePaymentsDetails' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/creditLimitOveragePayments' description: Request to start the Credit Limit Overage process for the reservations with a folio window balance equal or higher to the credit limit set for the credit card payment method of that folio window. required: true servers: - url: /csh/v1 /hotels/{hotelId}/creditcardTransaction/logs: post: summary: Register Vault Transaction description: You can use this API to create vault transaction.

OperationId:registerVaultTransaction

operationId: registerVaultTransaction 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_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/vaultTransaction' description: Request to register the vault HTTP transaction. required: true servers: - url: /csh/v1 /hotels/{hotelId}/creditcardsurcharge: get: summary: Get CC Surcharge Information description: You can use this API to get CC Surcharge Information.

OperationId:getCCSurchargeInfo

operationId: getCCSurchargeInfo parameters: - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: cashierId in: query required: false description: The Cashier ID of the Cashier who is currently processing the transaction(s). schema: type: number - name: description in: query required: false schema: type: string - name: folioView in: query required: false schema: type: integer - name: paymentMethod in: query required: false schema: type: string - name: track2Data in: query required: false description: Track2 data for the card which would be sent to the CC vendor as part of the authorization. schema: type: string - name: attachCreditCardToProfile in: query required: false description: Attach the credit card to profile. schema: type: boolean - name: cardHolderName in: query required: false schema: type: string - name: cardNumber in: query required: false schema: type: string - name: cardNumberLast4Digits in: query required: false schema: type: string - name: cardNumberMasked in: query required: false schema: type: string - name: cardOrToken in: query required: false description: Simple type for indicating if credit card number is tokenized. schema: type: string enum: - CardNumber - Token uniqueItems: true - name: cardType in: query required: false description: This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method. schema: type: string enum: - Ab - Am - Ax - Cb - Dc - Ds - Dt - Ec - Er - Jc - Jl - Mc - Nb - So - St - Sw - Va - Xy - Zz - Cp - Cu uniqueItems: true - name: expirationDate in: query required: false description: Expiration date of the credit card schema: type: string format: date - name: expirationDateExpired in: query required: false schema: type: boolean - name: expirationDateMasked in: query required: false description: Masked Expiration date of the credit card schema: type: string - name: processing in: query required: false schema: type: string enum: - Eft - Manual uniqueItems: true - name: swiped in: query required: false schema: type: boolean - name: userDefinedCardType in: query required: false description: Indicates the user defined credit card type if credit card type from a defined list is not provided schema: type: string - name: id 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: 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. Refer to OpenTravel Code List Unique ID Type (UIT). schema: 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: approvalAmountNeededAmount in: query required: false description: A monetary amount. schema: type: number - name: approvalAmountNeededCurrencyCode in: query required: false description: Provides a currency code to reflect the currency in which an amount may be expressed. schema: type: string - name: balanceAmount in: query required: false description: A monetary amount. schema: type: number - name: balanceCurrencyCode in: query required: false description: Provides a currency code to reflect the currency in which an amount may be expressed. schema: type: string - name: code in: query required: false description: The authorization rule code. schema: type: integer - name: amountAmount in: query required: false description: A monetary amount. schema: type: number - name: amountCurrencyCode in: query required: false description: Provides a currency code to reflect the currency in which an amount may be expressed. schema: type: string - name: percent in: query required: false description: A percentage value if the authorization rule is percentage based. schema: type: number - name: emailFolio in: query required: false schema: type: boolean - name: uniqueIdId 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: uniqueIdIdContext in: query required: false description: Used to identify the source of the identifier (e.g., IATA, ABTA). schema: type: string - name: uniqueIdType in: query required: false description: A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT). schema: type: string - name: createDateTime in: query required: false description: Time stamp of the creation. schema: type: string format: date-time - name: creatorId in: query required: false description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation. schema: type: string - name: emailAddress in: query required: false description: Defines the e-mail address. schema: type: string - name: emailFormat in: query required: false description: Supported Email format. schema: type: string enum: - Html - Text uniqueItems: true - name: lastModifierId in: query required: false description: Identifies the last software system or person to modify a record. schema: type: string - name: lastModifyDateTime in: query required: false description: Time stamp of last modification. schema: type: string format: date-time - name: orderSequence in: query required: false description: Display Order sequence. schema: type: number - name: primaryInd in: query required: false description: When true, indicates a primary information. schema: type: boolean - name: purgeDate in: query required: false description: Date an item will be purged from a database (e.g., from a live database to an archive). schema: type: string format: date - name: emailType in: query required: false description: Defines the purpose of the e-mail address (e.g. personal, business, listserve). schema: type: string - name: typeDescription in: query required: false description: Describes the Type code schema: type: string - name: approvalCode in: query required: false description: The approval code authenticates the authorization. schema: type: string - name: originalAuthSequence in: query required: false description: Unique Authorization Sequence for the authorization and settlement. schema: type: integer - name: vendorTranId in: query required: false description: Vendor transaction id for the authorization. schema: type: string - name: alternateTransRef in: query required: false description: Alternate vendor transaction id for the authorization. schema: type: string - name: approvalAmountAmount in: query required: false description: A monetary amount. schema: type: number - name: approvalAmountCurrencyCode in: query required: false description: Provides a currency code to reflect the currency in which an amount may be expressed. schema: type: string - name: postingAmountAmount in: query required: false description: A monetary amount. schema: type: number - name: postingAmountCurrencyCode in: query required: false description: Provides a currency code to reflect the currency in which an amount may be expressed. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 to the request to fetch Credit Card Surcharge information for a Credit Card Payment. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ccSurchargeDetails' '204': description: CCSurchargeInfo 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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/depositFolio: get: summary: Get Deposit Folio description: You can use this API to get Deposit Folio.

OperationId:getDepositFolio

operationId: getDepositFolio parameters: - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: fetchInstructions in: query description: Simple type for deposit folio instructions that can be used in requests for partial operations. required: false style: form explode: true schema: type: array items: type: string enum: - ProjectedRevenue uniqueItems: true - name: id 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: policyIdId 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: blockIdId 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 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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: Deposit Posting Information for a reservation. Contains all deposit payments made for a reservation. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/reservationDepositFolios' '204': description: DepositFolio 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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/depositTransactions: get: summary: Get Deposit Folio Transaction Details description: You can use this API to get Deposit Folio Transaction Details.

OperationId:getDepositFolioTransactionDetails

operationId: getDepositFolioTransactionDetails parameters: - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: includeGenerates in: query required: false description: Flag to indicate if the automatically generated transactions, related to the main transaction number above, are also to be retrieved as part of this request. schema: type: boolean - name: transactionNo in: query description: Unique Transaction Number of the transaction(posting) for which details are required. required: false style: form explode: true schema: type: array items: type: number maxItems: 4000 - name: includeExchangeInformation in: query required: false description: Flag to indicate what currency exchange information text needs to be included in response. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 the fetch transaction details request. Detail information regarding the folio transaction will be returned content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/depositFolioTransactionDetails' '204': description: DepositFolioTransactionDetails 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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/depositfolios/action/validate: put: summary: Validate Deposit Folio description: You can use this API to validate Deposit Folio.

OperationId:validateDepositFolio

operationId: validateDepositFolio 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_2' - $ref: '#/components/parameters/x-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: Information regarding the Deposit Policy if a Deposit Folio is going to be created for this policy. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/depositedFolioValidate' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/depositFolioValidateCriteria' description: Request to validate a Deposit Folio for a reservation. required: true servers: - url: /csh/v1 /hotels/{hotelId}/externalSystems/{externalSysCode}/reservations/{reservationId}/depositPayments: post: summary: Create Deposit Payment using external reference. description: You can use this API to create Deposit Payment with external reference.

OperationId:postDepositPaymentByExtId

operationId: postDepositPaymentByExtId parameters: - name: reservationId in: path required: true description: External System's reservation ID. schema: type: string maxLength: 2000 minLength: 1 - name: externalSysCode in: path required: true description: Code to identify the external system from which the request is coming. This is the ExternalSystem ID used to exchange information between OPERA and the external system. schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: Response for the post deposit payment request. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/depositedPayment' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/depositPayment' description: Request to post a deposit payment to a reservation. required: true servers: - url: /csh/v1 /hotels/{hotelId}/financialPostings: get: summary: Get Financial Postings description: You can use this API to get Financial postings.

OperationId:getFinancialPostings

The maximum allowable limit for this API is 50.

This API allows a time span of 30 days.

operationId: getFinancialPostings parameters: - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer maximum: 4000 - 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: 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 - name: cashierId in: query required: false description: Cashier Id of the Cashier. schema: type: number - name: filterTransactionCode in: query required: false 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: filterRoomNumber in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: referenceNumberWildCard in: query required: false description: Filters the results for reference number. schema: type: string - name: checkNumberWildCard in: query required: false description: Filter the results for Cheque number's code. schema: type: string - name: supplementWildCard in: query required: false description: Filter the results for supplement. schema: type: string - name: approvalCode in: query required: false description: Filters the results for approval code. schema: type: string - name: approvalStatusCode in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: folioWindowNo in: query description: Filters the result to only include transactions in this window number. required: false style: form explode: true schema: type: array items: type: integer maxItems: 4000 - name: attachCreditCardToProfile in: query required: false description: Attach the credit card to profile. schema: type: boolean - name: cardHolderName in: query required: false schema: type: string - name: cardNumber in: query required: false schema: type: string - name: cardNumberLast4Digits in: query required: false schema: type: string - name: cardNumberMasked in: query required: false schema: type: string - name: cardOrToken in: query required: false description: Simple type for indicating if credit card number is tokenized. schema: type: string enum: - CardNumber - Token uniqueItems: true - name: cardType in: query required: false description: This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method. schema: type: string enum: - Ab - Am - Ax - Cb - Dc - Ds - Dt - Ec - Er - Jc - Jl - Mc - Nb - So - St - Sw - Va - Xy - Zz - Cp - Cu uniqueItems: true - name: expirationDate in: query required: false description: Expiration date of the credit card schema: type: string format: date - name: expirationDateExpired in: query required: false schema: type: boolean - name: expirationDateMasked in: query required: false description: Masked Expiration date of the credit card schema: type: string - name: processing in: query required: false schema: type: string enum: - Eft - Manual uniqueItems: true - name: swiped in: query required: false schema: type: boolean - name: userDefinedCardType in: query required: false description: Indicates the user defined credit card type if credit card type from a defined list is not provided schema: type: string - name: id 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: 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. Refer to OpenTravel Code List Unique ID Type (UIT). schema: 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: approvalAmountNeededAmount in: query required: false description: A monetary amount. schema: type: number - name: approvalAmountNeededCurrencyCode in: query required: false description: Provides a currency code to reflect the currency in which an amount may be expressed. schema: type: string - name: closureNo in: query required: false description: Filters the result to only display the postings that were made during the cashier closure range schema: type: integer - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 the Posting Journal. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/financialPostings' '204': description: FinancialPostings 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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/financialPostingsNetVat: get: summary: Get Financial Postings with breakdown description: You can use this API to get Financial postings with Net and Vat breakdown.

OperationId:financialPostingsNetVat

The maximum allowable limit for this API is 50.

This API allows a time span of 30 days.

operationId: getFinancialPostingsNetVat parameters: - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: reservationId in: query required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - name: folioWindowNo in: query required: true schema: type: integer - name: startDate in: query required: false schema: type: string format: date - name: endDate in: query required: false schema: type: string format: date - 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_2' - $ref: '#/components/parameters/x-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 the Posting Journal with Net and Vat breakdown. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/financialPostingsNetVat' '204': description: FinancialPostings 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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/fiscalCommands: post: summary: Create Fiscal Invoice description: You can use this API to create Fiscal Invoice.

OperationId:postFiscalCommandInvoice

operationId: postFiscalCommandInvoice 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_2' - $ref: '#/components/parameters/x-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: Response after generating a commands from Fiscal Terminals screen. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/fiscalCommandsResponseInfo' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/fiscalFolioCriteria' description: Request to generate commands and communicate with fiscal service from fiscal terminals screen.. required: true servers: - url: /csh/v1 /hotels/{hotelId}/fiscalFolioResponse: get: summary: Get the Fiscal Folio Activity for a folio description: You can use this API to get the fiscal folio activity details for a folio.

OperationId:getFiscalFolioActivity

operationId: getFiscalFolioActivity parameters: - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: folioSeqNo in: query required: false description: Folio Sequence number for a folio schema: type: integer - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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: Details of Fiscal Folio Activity made. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/folioActivityDetailsType' '204': description: FiscalFolioActivity 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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/fiscalFolioResponse/{folioSeqNo}: get: summary: Get the Fiscal Folio Activity Response details for a folio description: You can use this API to get the fiscal folio activity response details for a folio.

OperationId:getFiscalFolioActivityDetails

operationId: getFiscalFolioActivityDetails parameters: - name: folioSeqNo in: path required: true description: Unique ID of the folio schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: responseAttemptNo in: query required: false description: Number of fiscal response attempt made for the folio schema: type: integer - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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: Details of response for the Fiscal Folio Activity made. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/folioActivityResponseDetailType' '204': description: FiscalFolioActivityDetails 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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/fiscalFolios: post: summary: Create Fiscal Information Folio description: You can use this API to create Fiscal Information Folio.

OperationId:generateFiscalFolio

operationId: generateFiscalFolio 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_2' - $ref: '#/components/parameters/x-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: Provides information which is used for fiscal response processing. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/fiscalInformationFolio' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/fiscalInfoFolioCriteria' description: Request to generate fiscal Information folio. required: true servers: - url: /csh/v1 /hotels/{hotelId}/fiscalPrinting: get: summary: Get Fiscal Printing Details description: You can use this API to get Fiscal Printing Details.

OperationId:getValidateFiscalPrintingDetails

operationId: getValidateFiscalPrintingDetails parameters: - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: folioView in: query required: false description: The folio window where this settlement is applied. schema: type: integer - name: folioType in: query required: false description: Folio Type schema: type: string - name: id 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: code in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: fetchInstruction in: query description: Reservation Related information. required: false style: form explode: true schema: type: array items: type: string enum: - Paymentmethod - Profile - Foliotype - Reservation uniqueItems: true - name: profileIdId 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: fiscalServiceMode in: query description: Mode when fiscal printing is called. required: false style: form explode: true schema: type: string items: type: string enum: - CheckOut - Credit - Deposit - Invoice - PasserBy - PostIt uniqueItems: true - name: cashieringEventType in: query required: false description: Cashiering event triggered. schema: type: string enum: - CheckOut - EarlyDeparture - AdvanceBill - InterimBill - PasserBy - PostIt - CreditBill - ChargesAndPayments - Deposit - DepositRefund - AutoFolio - PrepaidCard - AutoSettlement - InformationFolio - SupplementalFolio - Void uniqueItems: true - name: balance in: query required: false description: A monetary amount schema: type: number - name: queueName in: query required: false description: Folio Queue Name schema: type: string - name: debitFolio in: query required: false description: This flag indicates if the folio to be generated is a Debit Folio. schema: type: boolean - name: simpleFolio in: query required: false description: This flag indicates if the folio to be generated is a Simple Folio. schema: type: boolean - name: manualFolioNo in: query required: false description: User provided folio number. schema: type: number - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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: Check if it will call fiscal printing or not. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/fiscalCallStatus' '204': description: ValidateFiscalPrintingDetails 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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/fiscalSupportingDocuments: get: summary: Get supporting documents details. description: This API is used to get the list of supporting documents for the reservations.

OperationId:getSupportingDocuments

The maximum allowable limit for this API is 20.

operationId: getFiscalSupportingDocuments deprecated: true parameters: - name: hotelId in: path required: true description: Unique ID of the hotel. schema: type: string maxLength: 2000 minLength: 1 - name: surname in: query required: false description: Family name, last name. schema: type: string - name: givenName in: query required: false description: Given name, first name or names. schema: type: string - name: confirmationNo in: query required: false description: Confirmation number of the reservation. schema: type: string - name: arrivalStartDate in: query required: false description: The starting value of the date range. schema: type: string format: date - name: arrivalEndDate in: query required: false description: The ending value of the date range. schema: type: string format: date - name: departureStartDate in: query required: false description: The starting value of the date range. schema: type: string format: date - name: departureEndDate in: query required: false description: The ending value of the date range. schema: type: string format: date - name: roomId in: query required: false description: Room number of the the transaction. schema: type: string - name: documentType in: query description: Supporting document type. required: false style: form explode: true schema: type: array items: type: string enum: - InformationFolio - ProformaFolio - ConfirmationLetter uniqueItems: true - name: documentNo in: query required: false description: Supporting document number. schema: type: string - name: pendingDocumentsOnly in: query required: false description: Indicator to fetch only failed supporting documents, that were not sent successfully to the fiscal partner. schema: type: boolean - name: fromCreateDateTime in: query required: false description: Time stamp of the creation. schema: type: string format: date-time - name: limit in: query required: false description: Indicates maximum number of records the API should return. Default is 50 schema: type: integer - name: offset in: query required: false description: Index of the page being requested. If the index goes out of the bounds of the total set count, no data will be returned. schema: type: integer default: 0 - name: orderBy in: query required: false style: form explode: true schema: type: array items: type: string enum: - ArrivalDate - DepartureDate - Room - DocumentUpdatedDate - name: sortOrder in: query required: false style: form explode: true schema: type: array items: type: string enum: - Asc - Desc default: - Desc uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 the supporting documents. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/fiscalSupportingDocumentsResponse' '204': description: Supporting Documents 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: - Cashiering post: summary: Operation to resend the failed supporting documents to fiscal partner. description: This API is used to resend the failed supporting documents.

OperationId:resendSupportingDocument

operationId: resendSupportingDocument 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_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/fiscalSupportingDocumentCriteria' description: Request to send supporting document. required: true servers: - url: /csh/v1 /hotels/{hotelId}/fiscalSupportingDocuments/searches: post: summary: Get supporting documents details. description: This API is used to get the list of supporting documents for the reservations.

OperationId:searchFiscalSupportingDocuments

The maximum allowable limit for this API is 20.

operationId: searchFiscalSupportingDocuments 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_2' - $ref: '#/components/parameters/x-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 the supporting documents. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/fiscalSupportingDocumentsResponse' '204': description: Supporting Documents 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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/searchFiscalSupportingDocumentsRequest' description: searchFiscalSupportingDocuments Request servers: - url: /csh/v1 /hotels/{hotelId}/folio/{folioId}/convert: put: summary: Convert Folio description: You can use this API to Convert folio.This API is deprecated. Please use putFolioType instead

OperationId:convertFolio

operationId: convertFolio deprecated: true parameters: - name: folioId in: path required: true description: Unique ID of the folio schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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 to the request to Convert Folio. Includes the new converted folio information. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/convertFolioDetails' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/convertFolioCriteria' description: Request to convert folio from a Non Fiscal Folio type to a Fiscal Folio Type. Functionality is used in Italy and is only available when the country mode is set to Italy. required: true servers: - url: /csh/v1 /hotels/{hotelId}/folio/{folioId}/customerVatFolio: post: summary: Create Customer Factura Vat Folio. description: API to create Customer Factura Vat Folio from a Rachunek Folio.

OperationId:postCustomerVatFolio

operationId: postCustomerVatFolio parameters: - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: folioId in: path required: true description: Unique ID of the folio schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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: Response for the request to create a Customer Vat Folio. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/postCustomerVatStatus' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/customerVatFolioCriteria' description: Request to create Customer Factura Vat Folio from a Rachunek Folio. required: true servers: - url: /csh/v1 /hotels/{hotelId}/folio/{folioId}/fiscalCommands: post: summary: Create Fiscal Invoice description: You can use this API to create Fiscal Invoice.

This API is deprecated. Please use postFiscalCommandInvoice instead

OperationId:postFiscalInvoice

operationId: postFiscalInvoice deprecated: true parameters: - name: folioId in: path required: true description: Unique ID of the folio. schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/fiscalFolioCriteria' description: Request to generate commands and communicate with fiscal service from fiscal terminals screen.. required: true servers: - url: /csh/v1 /hotels/{hotelId}/folioHistory: get: summary: Get folio history description: You can use this API to get folio history for a reservation.

OperationId:getFolioHistory

operationId: getFolioHistory deprecated: true parameters: - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: id 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: 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. Refer to OpenTravel Code List Unique ID Type (UIT). schema: type: string - name: aR in: query required: false description: Indicates if search includes AR Folios. schema: type: boolean - name: checkOut in: query required: false description: Indicates if search includes Check Out Folios. schema: type: boolean - name: creditBill in: query required: false description: Indicates if search includes Credit Bill Folios. schema: type: boolean - name: supplementalFolio in: query required: false description: Indicates if search includes Debit Bill Folios. schema: type: boolean - name: includeAssociatedFolios in: query required: false description: Indicates if search result includes Associated Bills and is only applied when Folio History for a particular reservation (i.e. ReservationID has a value) is requested. schema: type: boolean - name: noShow in: query required: false description: Indicates if search includes No Show Folios. schema: type: boolean - name: offlineFolio in: query required: false description: Indicates if search includes Offline Folios. schema: type: boolean - name: passerBy in: query required: false description: Indicates if search includes Passer By Folios. schema: type: boolean - name: postIt in: query required: false description: Indicates if search includes Post-It Folios. schema: type: boolean - name: videoCheckOut in: query required: false description: Indicates if search includes Video Check Out Folios. schema: type: boolean - name: folioDate in: query required: false description: The starting value of the date range. schema: type: string format: date - name: folioEndDate in: query required: false description: The ending value of the date range. schema: type: string format: date - name: reservationIdId 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: reservationIdIdContext in: query required: false description: Used to identify the source of the identifier (e.g., IATA, ABTA). schema: type: string - name: reservationIdType in: query required: false description: A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT). schema: type: string - name: room in: query required: false description: Room Number to which this record applies. schema: type: string - name: name in: query required: false description: Family name, last name or Company Name. schema: type: string - name: firstName in: query required: false description: Given name, first name or names. schema: type: string - name: creditCardNo in: query required: false description: Credit card number used. schema: type: string - name: folioNo in: query required: false description: Folio Number. schema: type: string - name: invoiceNo in: query required: false description: Invoice Number. schema: type: number - name: addresseeName in: query required: false description: Addressee Name filter. Works with the Addressee Functionality. schema: type: string - name: fiscalFolioNo in: query required: false description: Fiscal Folio Number filter. Works with the Fiscal Folio Number Functionality. schema: type: string - name: code in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: partnerFiscalFolioStatusCode in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: customNumber in: query required: false description: Custom number schema: type: string - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer default: 50 maximum: 50 - 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_2' - $ref: '#/components/parameters/x-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 the fetch Folio History. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/folioHistoryResponse' '204': description: FolioHistory 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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/folioHistory/searches: post: summary: Get folio history description: You can use this API to get folio history for a reservation.

OperationId:searchFolioHistory

operationId: searchFolioHistory 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_2' - $ref: '#/components/parameters/x-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 the fetch Folio History. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/folioHistoryResponse' '204': description: FolioHistory 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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/searchFolioHistoryRequest' description: searchFolioHistory Request servers: - url: /csh/v1 /hotels/{hotelId}/folioPrinters: get: summary: Get folio printers description: You can use this API to get folio printers.

OperationId:getFolioPrinters

operationId: getFolioPrinters parameters: - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: allFolioWindow in: query required: false description: Flag to decide if folios is to be generated for all windows in addition to the one requested with applicable postings and zero balance. If any of the windows have non-zero balance then folios are not generated for other windows. schema: type: boolean - name: correction in: query required: false description: Correction flag schema: type: boolean - name: debitFolio in: query required: false description: Indicates the type of folio to be generated schema: type: boolean - name: folioWindowNo in: query required: false schema: type: integer - name: manualFolioNo in: query required: false description: Manual Folio Number used for settlement during checkout schema: type: integer - name: cashierId in: query required: false description: The Cashier ID of the Cashier who is currently processing the transaction(s). schema: type: number - name: fiscalTerminalId in: query required: false description: Applicable for Fiscal Terminal. The ID of the terminal where the fiscal device is connected. schema: type: string - name: eventType in: query required: false description: Event being generated by a Supplemental Folio. schema: type: string enum: - CheckOut - EarlyDeparture - AdvanceBill - InterimBill - PasserBy - PostIt - CreditBill - Deposit - DepositRefund - AutoFolio - PrepaidCard - AutoSettlement - InformationFolio - SupplementalFolio uniqueItems: true - name: id 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: profileIdId 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: currencyCode in: query required: false description: Description of currency Code. schema: type: string - name: exchangeRate in: query required: false description: Description of exchange rate. schema: type: number - name: associatedBillNumber in: query required: false description: The bill number of the original bill for which the Credit Bill is being generated. schema: type: number - name: associatedBillFolioType in: query required: false description: The folio type of the original bill for which the Credit Bill is being generated. schema: type: string - name: associatedBillQueueName in: query required: false description: The folio number queue(used in certain countries) of the original bill for which the Credit Bill is being generated. schema: type: string - name: associatedBillFiscalBillNumber in: query required: false description: The Fiscal Folio Bill Number(from a Fiscal System) of the original bill for which the Credit Bill is being generated. schema: type: string - name: associatedBillGenerationDate in: query required: false description: The bill generation date of the original bill for which the Credit Bill is being generated. schema: type: string format: date - name: folioType in: query required: false description: Folio Type to be assigned to generated folio. This is a country requirement. schema: type: string - name: generateFiscalFolio in: query required: false description: Fiscal folio flag to call fiscal folio web service after folio generation. schema: type: boolean - name: queueName in: query required: false description: Folio Queue name. schema: type: string - name: folioSeqId in: query required: false description: Fiscal Folio sequence ID stored in queue table. schema: type: integer - name: fiscalFolioInstruction in: query required: false description: Action to generate Offline folio when no response is received from fiscal service. schema: type: string enum: - Retry - New - Void - Offline uniqueItems: true - name: transactionServiceType in: query required: false description: Contains transaction service type. schema: type: string - name: amount in: query required: false description: A monetary amount. schema: type: number - name: balanceCurrencyCode in: query required: false description: Provides a currency code to reflect the currency in which an amount may be expressed. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 to the request to fetch the Folio Printers applicable for a Folio, based on the content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/folioPrinters' '204': description: FolioPrinters 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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/folioTypeNames: get: summary: Get Folio Type Name description: You can use this API to get Folio Type Name.

OperationId:getFolioTypeName

operationId: getFolioTypeName parameters: - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: internalFolioWindowId in: query required: false description: The internal folio window Id for the reservation to determine the guest language details. schema: type: string - name: languageCode in: query required: false description: The Filter language code which will be used to retrieve the report name set for this language. schema: type: string - name: folioTypeName in: query required: false description: The Folio Type for which the details are requested. schema: type: string - name: folioReportGroup in: query required: false 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. schema: type: string enum: - Guest - Group - AccountsReceivables - PasserBy - PostIt - Expense - CorrectionHeader uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 the fetch Folio Type Information. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/folioTypeNameInfo' '204': description: FolioTypeName 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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/folioTypes: get: summary: Get Folio Types description: You can use this API to get Folio Types.

OperationId:getFolioTypes

operationId: getFolioTypes parameters: - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: includeCompress in: query required: false description: Folio to be use for compress bills. schema: type: boolean - name: includeCredit in: query required: false description: Folio to be use for credit bills. schema: type: boolean - name: folioType in: query required: false description: Folio Type. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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: Information regarding the Folio Types. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/folioTypesInfo' '204': description: FolioTypes 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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/folios/{folioId}/fiscal: put: summary: Process Fiscal retry description: You can use this API to process fiscal retry status.

OperationId:processFiscalRetry

operationId: processFiscalRetry parameters: - name: folioId in: path required: true description: Unique ID of the folio. schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: The response object to send back the fiscal service response to opera. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/processFiscalRetryStatus' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/processFiscalRetry' description: The request object to process fiscal retry functionality. required: true servers: - url: /csh/v1 /hotels/{hotelId}/passerBySale: post: summary: Create passer by sale description: You can use this API to create passer by sale.

OperationId:postPasserBySale

operationId: postPasserBySale 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_2' - $ref: '#/components/parameters/x-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: Details of the folio created. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/passerBySale' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/passerBySalesCriteria' description: Request to post a set of charges, payments and generate a bill for a PasserBy or for the Post-It functionality . A PasserBy is someone who is not staying at the Property. A PasserBy transaction requires a Profile in Opera for whom the the folio is being created. required: true servers: - url: /csh/v1 /hotels/{hotelId}/payees/{payeeId}/taxNumber: put: summary: Change Payee Tax Number description: You can use this API to change Payee Tax Number.

OperationId:putPayeeTaxNumber

operationId: putPayeeTaxNumber parameters: - name: payeeId in: path required: true description: Unique ID of the payee schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/payeeTaxNumber' description: Request to validate and change Payee Tax Number. required: true servers: - url: /csh/v1 /hotels/{hotelId}/policies/{policyId}/transactions/{transactionId}/deposit: put: summary: Attach Deposit Policy to Payment description: You can use this API to attach Deposit Policy to Payment.

OperationId:attachDepositPolicyToPayment

operationId: attachDepositPolicyToPayment parameters: - name: transactionId in: path required: true description: Unique ID of the transaction schema: type: string maxLength: 2000 minLength: 1 - name: policyId in: path required: true description: Unique ID of the policy schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/attachPolicyApplyCriteria' description: Request to attach an existing Deposit Policy on a reservation towards an existing deposit payment on the same reservation. required: true servers: - url: /csh/v1 /hotels/{hotelId}/postingDates/date/postingSummary: get: summary: Get Posting Summary description: You can use this API to get posting Summary.

OperationId:getPostingSummary

operationId: getPostingSummary parameters: - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: includeGenerates in: query required: false description: Configuring this flag to be TRUE will return transactions that are auto generated like taxes. schema: type: boolean - name: postingDate in: query required: false description: The date on which the charge is posted. schema: type: string format: date - name: checkPostings in: query required: false description: When set to true,the summary of only the postings using checks will be fetched. schema: type: boolean - name: postingsByExternalSystem in: query required: false description: When set to true,the summary of only the postings done by external systems will be fetched. schema: type: boolean - name: cashierId in: query required: false description: Cashier Id of the Cashier. schema: type: number - name: currency in: query required: false description: Currency in which the postings are done. If null,amounts posted in local currency will be fetched. schema: type: string - name: postingSummaryType in: query required: false description: Enumeration Type of Posting Summary Information. schema: type: string enum: - Postings - Adjustments - All uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 to fetch daily summary charges from Opera which are posted in Opera by external system. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/postingSummaryList' '204': description: PostingSummary 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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/prepaidCards: post: summary: Create Prepaid Cards description: You can use this API to create Prepaid Cards.

OperationId:postPrepaidCards

operationId: postPrepaidCards 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_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/prepaidCardCriteria' description: Request type for Prepaid card creation process required: true servers: - url: /csh/v1 /hotels/{hotelId}/prepaidCards/activate: put: summary: Operation to activate prepaid card. description: You can use this API to activate Prepaid Card.

OperationId:activatePrepaidCard

operationId: activatePrepaidCard 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_2' - $ref: '#/components/parameters/x-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/activatePrepaidCardStatus' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/activatePrepaidCard' description: Request type for activate prepaid card. required: true servers: - url: /csh/v1 /hotels/{hotelId}/prepaidCards/cancel: put: summary: Operation to cancel prepaid card transaction. description: You can use this API to cancel PrepaidCard Transaction.

OperationId:cancelPrepaidCardTransaction

operationId: cancelPrepaidCardTransaction 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_2' - $ref: '#/components/parameters/x-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/cancelPrepaidCardTransactionStatus' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/cancelPrepaidCardTransaction' description: Request type for reload prepaid card. required: true servers: - url: /csh/v1 /hotels/{hotelId}/prepaidCards/cashOut: put: summary: Operation to cash out prepaid card. description: You can use this API to cashOut Prepaid Card.

OperationId:cashOutPrepaidCard

operationId: cashOutPrepaidCard 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_2' - $ref: '#/components/parameters/x-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/cashOutPrepaidCardStatus' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/cashOutPrepaidCard' description: Request type for cashout prepaid card. required: true servers: - url: /csh/v1 /hotels/{hotelId}/prepaidCards/reload: put: summary: Operation to reload prepaid card. description: You can use this API to reload Prepaid Card.

OperationId:reloadPrepaidCard

operationId: reloadPrepaidCard 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_2' - $ref: '#/components/parameters/x-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/reloadPrepaidCardStatus' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/reloadPrepaidCard' description: Request type for reload prepaid card. required: true servers: - url: /csh/v1 /hotels/{hotelId}/profiles/{profileId}/creditCardWallet: get: summary: credit card wallet description: 'This API is used to fetch the credit card wallet from the specified hotel and profile.

OperationId: getHotelCreditCardWallet

' operationId: getHotelCreditCardWallet parameters: - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: profileId in: path required: true description: Unique ID of the profile schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 to the request to get Credit Card Wallet Information content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/creditCardWallet' '204': description: HotelCreditCardWallet 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: - Cashiering delete: summary: Delete Credit Cards from Wallet description: 'This API is used to delete credit cards from a wallet for the specified hotel and profile.

OperationId: deleteCreditCardsFromProfileWallet

' operationId: deleteCreditCardsFromProfileWallet parameters: - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: profileId in: path required: true description: Unique ID of the profile schema: type: string maxLength: 2000 minLength: 1 - name: creditCardId in: query description: List of credit card IDs to delete from the wallet required: true style: form explode: true schema: type: array items: type: number - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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: 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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/profiles/{profileId}/paymentMethods/creditCard/authorize: post: summary: Authorize Credit Card Amount by Profile description: You can use this API to authorize Credit Card Amount by Profile.

OperationId:authorizeCreditCardAmountByProfile

operationId: authorizeCreditCardAmountByProfile parameters: - name: profileId in: path required: true description: Unique ID of the profile schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: Response to the credit card authorization request. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/authorizationInfo' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/ccAuthorizationCriteria' description: Request for a credit card authorization. An authorization request will be sent to the Credit Card Vendor as part of this request. required: true servers: - url: /csh/v1 /hotels/{hotelId}/profiles/{profileId}/paymentMethods/creditCard/authorizeInstructions: post: summary: Get CC Authorization Instructions By Profile description: You can use this API to get Credit Card Authorization Instructions by Profile.

OperationId:postCCAuthorizationInstructionsByProfile

operationId: postCCAuthorizationInstructionsByProfile parameters: - name: profileId in: path required: true description: Unique ID of the profile schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: Response to the fetch authorization instructions. Based on the criteria requested, the response can contain information required to send a credit card authorization to the Vendor. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ccAuthorizationInstructions' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/ccAuthorizationInstructionsCriteria' description: Criteria for fetching CC Authorization Instructions. required: true servers: - url: /csh/v1 /hotels/{hotelId}/receiptHistory: get: summary: Get Receipt History description: You can use this API to get Receipt History.

OperationId:getReceiptHistory

This API allows a time span of 30 days.

operationId: getReceiptHistory deprecated: true parameters: - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: fromDate in: query required: false description: Receipt History Date Range(from). schema: type: string format: date - name: toDate in: query required: false description: Receipt History Date Range(to). schema: type: string format: date - name: name in: query required: false description: Family name, last name or Company Name. schema: type: string - name: firstName in: query required: false description: Given name, first name or names. schema: type: string - name: receiptTypeName in: query required: false description: Receipt Type. schema: type: string - name: taxInvoice in: query required: false description: Tax Invoice Number. schema: type: string - name: receiptNo in: query required: false description: Receipt Number. schema: type: number - name: customNumber in: query required: false description: Custom number schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 the fetch Receipt History. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/receiptHistoryResponse' '204': description: ReceiptHistory 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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/receiptHistory/searches: post: summary: Get Receipt History description: You can use this API to get Receipt History.

OperationId:searchReceiptHistory

This API allows a time span of 30 days.

operationId: searchReceiptHistory 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_2' - $ref: '#/components/parameters/x-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 the fetch Receipt History. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/receiptHistoryResponse' '204': description: ReceiptHistory 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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/searchReceiptHistoryRequest' description: searchReceiptHistory Request servers: - url: /csh/v1 /hotels/{hotelId}/reservation/{reservationId}/rateCode/{rateCode}: post: summary: Create rate codes description: You can use this API to create rate codes.

OperationId:postRateCode

operationId: postRateCode parameters: - name: rateCode in: path required: true description: The Rate Code which is to be posted on the Guest Folio. schema: type: string maxLength: 2000 minLength: 1 - name: reservationId in: path required: true description: Unique ID of the reservation. schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: Response for the operation that posts a Rate Code amount on the reservation. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/postedRateCode' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/postRateCodeCriteria' description: Operation to post a Rate Code amount to the Reservation. Based on the criteria, Products(Packages) which are included as part of the Rate Code may be posted along with the room rate amount. required: true servers: - url: /csh/v1 /hotels/{hotelId}/reservation/{reservationId}/rateCode/{rateCode}/action/validate: put: summary: Change posted rate codes description: You can use this API to change posted rate codes.

OperationId:checkPostRateCode

operationId: checkPostRateCode parameters: - name: rateCode in: path required: true description: The Rate Code which is to be posted on the Guest Folio. schema: type: string maxLength: 2000 minLength: 1 - name: reservationId in: path required: true description: Unique ID of the reservation. schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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 for the request to check if a Rate Code can be posted to a reservation . content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/checkedRateCode' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/postRateCodeCriteria' description: Request to check if a Rate Code can be posted to the room manually. This will check if the Rate Code is valid, if the Products(Packages) which are defined as part of the Rate Code can be posted or reversed. required: true servers: - url: /csh/v1 /hotels/{hotelId}/reservations/billingCharges: post: summary: Create Billing Charges in Batch description: You can use this API to create Billing Charges in Batch.

OperationId:postBillingChargesInBatch

operationId: postBillingChargesInBatch 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_2' - $ref: '#/components/parameters/x-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: Information regarding charges in batch result for each reservation. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/postedBillingChargesInBatch' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/billingChargesInBatchCriteria' description: Operation to post billing charge to list of reservations. required: true servers: - url: /csh/v1 /hotels/{hotelId}/reservations/cCSettlements: get: summary: Get batch CC Settlements description: You can use this API to get batch CC Settlements.

OperationId:getBatchCCSettlements

operationId: getBatchCCSettlements parameters: - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: offlineSettlement in: query required: false description: fetch only offline settlements. schema: type: boolean - name: transactionDate in: query required: false description: Transaction Date associated with the transaction. schema: type: string format: date - name: guestName in: query required: false description: Guest name associated with the transaction. schema: type: string - name: roomId in: query required: false description: Room number associated with the transaction. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 credit card settlements. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ccBatchSettlements' '204': description: BatchCCSettlements 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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/reservations/vouchers: get: summary: Get the list of vouchers generated from a list of reservations. description: This API is used to fetch the list of vouchers from a list of reservations.

OperationId:getReservationsVouchers

operationId: getReservationsVouchers parameters: - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: guestId in: query description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. 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_2' - $ref: '#/components/parameters/x-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 to the request to get the Reservation vouchers. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/reservationVouchersType' '204': description: Get reservation 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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/additionalTaxes: get: summary: Get additional Taxes description: You can use this API to get Additional Taxes.

OperationId:getAdditionalTaxes

operationId: getAdditionalTaxes parameters: - name: reservationId in: path required: true description: Unique ID of the reservation. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - 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. Refer to OpenTravel Code List Unique ID Type (UIT). schema: type: string - name: folioView in: query required: false description: Folio Window. schema: type: integer - name: currencyCode in: query required: false description: Currency code on which tax is to be calculated schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 containing additional tax information. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/additionalTaxesDetails' '204': description: AdditionalTaxes 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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/advancePaymentBalance: get: summary: Get advance payment balance description: You can use this API to get advance payment balance.

OperationId:getAdvancePaymentBalance

operationId: getAdvancePaymentBalance parameters: - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - 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. Refer to OpenTravel Code List Unique ID Type (UIT). schema: type: string - name: fromDate in: query required: false description: From date of reservation. schema: type: string format: date - name: numberOfNights in: query required: false description: Number of nights to calculate advance payment. schema: type: integer - name: eventType in: query required: false description: Event to which this process will be logged. schema: type: string enum: - AdvanceBill - Deposit - CheckIn uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 the advance payment balance. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/advancePaymentBalance' '204': description: AdvancePaymentBalance 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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/advanceRoomCharges: post: summary: Create advance Room Charges description: You can use this API to create advance Room Charges.

OperationId:postAdvanceRoomCharges

operationId: postAdvanceRoomCharges parameters: - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: 'Response for the generate advance folio request. Post Advance Room Charges Request can return the below error codes : FOF00065 - Reservation ID or Resort was not supplied. FOF00147 - Reservation is currently not In-House. FOF00148 - Date range requested is not valid. FOF00149 - Advance Room Charges Posting was not completed successfully as there was an Error during posting. FOF00150 - Room Charges have already been posted for the requested dates. FOF00151 - Advance Room Charges could not be completed {the error message if any}.' content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/advanceRoomChargesReservationInfo' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/advanceRoomCharges' description: Request to post the Room Charges for a reservation in advance. This request posts the Room Charges for a reservation for tonight or for many nights starting from the last posted night. This can also be used to verify if the reservation has already been charged for the full stay. Setting the Verify flag will return details regarding the last Room Charge posted date and if there are any available dates for which the room charges can be posted in advance. Room Charges cannot be posted for dates prior to the business date of the resort. To make the actual posting, the verification flag should be false. required: true delete: summary: Delete Advance Folio Transactions description: You can use this API to reverse the Advance Folio Transactions on a reservation. As part of reversal, the actual charges may not be deleted but only an offset will be posted.

OperationId:reverseAdvanceFolio

operationId: deleteAdvanceRoomCharges parameters: - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: cashierId in: query required: false description: The Cashier ID of the Cashier who is currently processing the transaction(s). schema: type: number - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/alerts: get: summary: Get Alert Notices description: You can use this API to get Alert Notices.

This API is deprecated.

OperationId:getAlerts

operationId: getAlerts deprecated: true parameters: - name: reservationId in: path required: true description: Unique OPERA reservation ID which is used to find reservation from OPERA. This ID is a primary identification of a reservation in OPERA. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: alertArea in: query required: false schema: type: string enum: - CheckIn - CheckOut - Reservation - Billing - InHouse uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 with the fetched alerts, includes global alerts. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/alertNotices' '204': description: Alerts 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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/authorizationHistory: get: summary: Get authorization history description: You can use this API to get authorization history.

OperationId:getAuthorizationHistory

operationId: getAuthorizationHistory parameters: - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - 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. Refer to OpenTravel Code List Unique ID Type (UIT). schema: type: string - name: includeAuthorizations in: query required: false description: A flag which indicates whether authorizations should be included in the returned list. schema: type: boolean - name: includePayments in: query required: false description: A flag which indicates whether payments should be included in the returned list. schema: type: boolean - name: includeRefunds in: query required: false description: A flag which indicates whether refunds should be included in the returned list. schema: type: boolean - name: includeFailures in: query required: false description: A flag which indicates whether failures should be included in the returned list. schema: type: boolean - name: folioView in: query required: false schema: type: integer - name: transactionType in: query required: false description: Currently supported transaction type categories used for credit card authorization. schema: type: string enum: - Additional - ArPayment - Batch - BatchDeposit - BatchDepositRefund - Billing - CheckIn - CheckInManualAuth - Deposit - EndOfDay - EndOfDayDeposit - Manual - Other - PasserBy - PostIt - PreCheckIn - Refund - Scheduled uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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: The result element containing a history list of credit card authorizations for a particular reservation, filtered by the requested criteria. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/authorizationHistory' '204': description: AuthorizationHistory 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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/charges: get: summary: Get Billing Charges description: You can use this API to get post Billing Charges.

OperationId:getPostBillingCharges

operationId: getPostBillingCharges parameters: - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: cashierId in: query required: false description: The Cashier ID of the Cashier who is currently processing the transaction(s). schema: type: number - name: folioWindowNo in: query required: false style: form explode: true schema: type: array items: type: integer - name: chargeCashierId in: query description: The Cashier ID of the Cashier who is currently processing the transaction(s). required: false style: form explode: true schema: type: array items: type: number - name: transactionCode in: query description: Transaction Code to post. required: false style: form explode: true schema: type: array items: type: string - name: articleCode in: query description: Article ID. 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: postingQuantity in: query description: Quantity to post to the folio. required: false style: form explode: true schema: type: array items: type: integer - name: postingReference in: query description: User-defined posting reference. required: false style: form explode: true schema: type: array items: type: string - name: postingRemark in: query description: User-defined posting remark. required: false style: form explode: true schema: type: array items: type: string - name: checkNumber in: query description: Indicates the Cheque number. required: false style: form explode: true schema: type: array items: type: string - name: arrangementCode in: query description: Corrected arrangement code from the package associated to this transaction. required: false style: form explode: true schema: type: array items: type: string - name: applyRoutingInstructions in: query description: Apply room routing when making this posting. required: false style: form explode: true schema: type: array items: type: boolean - name: usePackageAllowance in: query description: Use the applicable package allowance when making this posting. required: false style: form explode: true schema: type: array items: type: boolean - name: autoPosting in: query description: True indicates the Transaction Code is allowed to be posted automatically. required: false style: form explode: true schema: type: array items: type: boolean - name: id in: query description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. required: false style: form explode: true schema: type: array items: type: string - name: idContext in: query description: Used to identify the source of the identifier (e.g., IATA, ABTA). required: false style: form explode: true schema: type: array items: type: string - name: type in: query description: A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT). required: false style: form explode: true schema: type: array items: type: string - name: reservationIdIdContext in: query required: false description: Used to identify the source of the identifier (e.g., IATA, ABTA). schema: type: string - name: reservationIdType in: query required: false description: A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT). schema: type: string - name: option in: query description: This is the Default option. Operation checks if charges can be posted to the reservation based on the status of the reservation. required: false style: form explode: true schema: type: array items: type: string enum: - PackageAllowance - RoomRouting - PostingStatus uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 when checking or inquiring the available options for a set of billing charges. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/billingChargesStatus' '204': description: PostBillingCharges 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: - Cashiering post: summary: Post Charge to a folio description: You can use this API to post a charge to a folio window.

OperationId:postBillingCharges

operationId: postBillingCharges parameters: - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: Response notifying if the posting of a charge to a reservation was successful. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/billingChargesDetails' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/billingCharges' description: Request to post a charge on a reservation's folio. required: true servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/chargesAndPayments: post: summary: Post charges and payments on a reservation description: You can use this API to post charges and payments on a reservation.This operation can be used to enforce Payment for additional charges posted on the reservation

OperationId:postChargesAndPayments

operationId: postChargesAndPayments parameters: - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: reservationId in: path required: true description: Unique ID of the reservation. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/chargesAndPaymentsCriteria' description: Request to post charges and payments on a reservation. required: true servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/check/{checkNumber}/charges: post: summary: Pre-validate the Billing Charge description: You can use this API to validate the posting prior to posting the charge to the folio

OperationId:postBillingCheckCharges

operationId: postBillingCheckCharges parameters: - name: checkNumber in: path required: true description: Unique number of the check. schema: type: string maxLength: 2000 minLength: 1 - name: reservationId in: path required: true description: Unique ID of the reservation. schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/billingCheckChargesCriteria' description: Request object for PostBillingCheckCharges operation. required: true servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/checkOuts: post: summary: Check out a guest description: This API enables you to check out a guest reservation which is in due out status, with options to update the room's housekeeping status and set a flag to email the guests folio.

OperationId:postCheckOut

operationId: postCheckOut parameters: - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/reservation' description: Checkout request can be used to verify a reservation for checkout and do an actual checkout. In case the verificationOnly attribute is sent false, the operation will perform an actual checkout. In case the verificationOnly attribute is sent true, the operation goes through the reservation in question and verifies if it's Ok to checkout, otherwise the verification status element will provide you the verification code. The verification codes are described in the documentation of verificationOnly attribute. required: true servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/checkOuts/reinstate: put: summary: Reinstate Checked Out Reservation description: You can use this API to reinstate Checked Out Reservation.

OperationId:reinstateCheckOut

operationId: reinstateCheckOut parameters: - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/reinstateCheckedOutReservation' description: Request to reinstate checkout reservation in order to post additional transactions, etc. required: true servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/comp/folios/autoSettlements: put: summary: Operation to auto settle comp folios. description: You can use this API to auto Settle CompFolios

OperationId:autoSettleCompFolios

operationId: autoSettleCompFolios parameters: - name: reservationId in: path required: true description: Unique ID of the reservation. schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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 for auto settle comp folios. This includes collection of auto settled comp folios. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/autoSettleCompFoliosStatus' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/autoSettleCompFolios' description: Request to auto settle comp folios. OPERA will reference the 'Default Comp Payment Method' setting to settle the folio if no authorizer AR account is associated with the folio. required: true servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/compRedemptionPostings: post: summary: Operation to post complimentary bucket redemptions for a guest having PTS Membership Type description: You can use this API to post complimentary bucket redemptions for a guest having PTS Membership Type

OperationId:postCompRedemptions

operationId: postCompRedemptions parameters: - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/postCompRedemptions' description: Request type of Complimentary Bucket Redemptions posting. required: true servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/compRedemptionReversals: post: summary: Operation to reverse complimentary bucket redemptions for a guest having PTS Membership Type description: You can use this API to reverse complimentary bucket redemptions for a guest having PTS Membership Type

OperationId:reverseCompRedemptions

operationId: reverseCompRedemptions parameters: - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/reverseCompRedemptions' description: Request type of Complimentary Bucket Redemptions reversal. required: true servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/compositeDeposit: post: summary: Create Deposit Payment or Deposit Folio description: You can use this API to create either Deposit Payment or Deposit Folio.

OperationId:postCompositeDeposit

operationId: postCompositeDeposit parameters: - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: Response for the post composite deposit request. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/postedCompositeDeposit' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/compositeDepositInfo' description: Request to post a deposit payment or a deposit folio to a reservation. required: true servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/creditCardWallet: get: summary: Credit Card Wallet description: 'This API is used to fetch the credit card wallet from the specified hotel and reservation.

OperationId: getReservationCreditCardWallet

' operationId: getReservationCreditCardWallet parameters: - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - name: profileId in: query required: false description: Unique ID of the profile schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 to the request to get Credit Card Wallet Information content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/creditCardWallet' '204': description: ReservationCreditCardWallet 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: - Cashiering delete: summary: Delete Credit Cards from Wallet description: 'This API is used to delete credit cards from a wallet for the specified hotel and reservation.

OperationId: deleteCreditCardsFromReservationWallet

' operationId: deleteCreditCardsFromReservationWallet parameters: - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - name: profileId in: query required: true description: Unique ID of the profile schema: type: string maxLength: 2000 minLength: 1 - name: creditCardId in: query description: List of credit card IDs to delete from the wallet required: true style: form explode: true schema: type: array items: type: number - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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: 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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/deferredTaxesProcess: post: summary: Request to submit a job to post the deferred taxes. description: Request to submit a job to post the deferred taxes.

OperationId:postDeferredTaxesProcess

operationId: postDeferredTaxesProcess parameters: - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: Response containing the job identifier to post the deferred taxes. Returns appropriate warnings in case if deferred tax is not enabled for the hotel or deferred tax is enabled but the reservation has deferred taxes already posted or currently under process content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/deferredTaxesProcessDetails' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/deferredTaxesProcess' description: Request to submit a job to post the deferred taxes. required: true servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/deposit: post: summary: Process Reservations deposit description: You can use this API to Process reservations deposit.

OperationId:processReservationDeposit

operationId: processReservationDeposit parameters: - name: reservationId in: path required: true description: Unique ID of the reservation. schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/reservationDepositCriteria' description: Request object to process reservation deposit. required: true servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/depositCreditBill: post: summary: Deposit Credit Bill description: You can use this API to post Deposit Credit Bill.

OperationId:postDepositCreditBill

operationId: postDepositCreditBill parameters: - name: reservationId in: path required: true description: Unique ID of the reservation. schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: Response to the request for a Deposit Credit Bill for a reservation. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/postedDepositCreditBill' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/depositCreditBillCriteria' description: Request to post a Deposit Credit Bill for a reservation. required: true servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/depositFolios: post: summary: Create Deposit Folio description: You can use this API to create Deposit Folio.

OperationId:postDepositFolio

operationId: postDepositFolio parameters: - name: reservationId in: path required: true description: Unique ID of the reservation. schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: Response to the request to create a Deposit Folio for a reservation. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/postedDepositFolio' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/depositFolioCriteria' description: Request to create a Deposit Folio for a reservation. required: true servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/depositMaturity: get: summary: Get Deposit Maturity Information description: You can use this API to get Deposit Maturity Information.

OperationId:getDepositMaturityInfo

operationId: getDepositMaturityInfo parameters: - name: reservationId in: path required: true description: Unique ID of the reservation. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: cashierId in: query required: false description: The Cashier ID of the Cashier who is currently processing the transaction(s). schema: type: number - 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. Refer to OpenTravel Code List Unique ID Type (UIT). schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 deposit maturity information type. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/depositMaturityDetails' '204': description: DepositMaturityInfo 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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/depositPayments: post: summary: Create Deposit Payment description: You can use this API to create Deposit Payment.

OperationId:postDepositPayment

operationId: postDepositPayment parameters: - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: Response for the post deposit payment request. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/depositedPayment' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/depositPayment' description: Request to post a deposit payment to a reservation. required: true get: summary: Get matured deposits description: You can use this API to fetch matured deposits.

OperationId:getMaturedDeposits

operationId: getMaturedDeposits parameters: - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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 of matured deposits. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/maturedDepositsDetails' '204': description: MaturedDeposits 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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/depositTransition: put: summary: Transition Deposit to Guest Folio description: You can use this API to Transfer Deposit to Guest Folio.

OperationId:transitionDepositToGuestFolio

operationId: transitionDepositToGuestFolio parameters: - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: This element returns any automatically generated folios during Deposit Transfer. When the parameter "Auto Generate Credit Bill for Deposit upon Check In" is enabled, during deposit transfer,the credit bills are automatically generated for the deposits. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/depositTransitionStatus' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/depositToGuestFolio' description: Request to post an existing deposit on a reservation to the Guest Folio for No Show or Cancelled Reservations. Deposits remain in the deposit ledger until Checkin/Checkout. In the case of No Show or Cancelled reservations they remain in the deposit ledger until this request is done. required: true servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/earlyDeparture: put: summary: Change early Departure description: You can use this API to change early Departure.

OperationId:putForEarlyDeparture

operationId: putForEarlyDeparture parameters: - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/earlyDeparture' description: Request to change a reservation to an Early Departure. As part of this process the reservation will be changed to a Due Out status with the departure date being the current business date. Only Inhouse reservations can be changed to Early Departure. Before changing the reservation to early departure, rate restrictions on the rate code used and any allowances consumed by the guest for today will be checked. If there is a penalty applicable this can be posted to the reservation. required: true servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/earlyDeparture/verify: get: summary: Verify for early Departure description: You can use this API to verify early Departure.

OperationId:verifyForEarlyDeparture

operationId: verifyForEarlyDeparture parameters: - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: ignoreCheckOnTieredRate in: query required: false description: Indicates if check has to be done for Rate Tiers. schema: type: boolean - name: ignoreRateRestriction in: query required: false description: Indicates if Rate Restriction check should be overridden. schema: type: boolean - name: postConsumedAllowanceToGuest in: query required: false description: Indicates if any allowance consumed by the guest for today can be posted to the Guest Folio. If this cannot be done then the Early Departure cannot proceed. schema: type: boolean - name: postEarlyDeparturePenalty in: query required: false description: Indicates if the early departure penalty should be posted . schema: type: boolean - name: cashierId in: query required: false description: The Cashier ID of the Cashier who is currently processing the transaction(s). schema: type: number - name: idContext in: query description: Used to identify the source of the identifier (e.g., IATA, ABTA). required: false style: form explode: true schema: type: array items: type: string - name: type in: query description: A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT). 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_2' - $ref: '#/components/parameters/x-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 Early departure verification. Contains information regarding early departure penalty amount if applicable and any errors or warnings as to why the early departure cannot be done. Possible error codes are: FOF00152: An early departure could result in a change to the room rate, due to the reduced length of stay. FOF00153: Exchange Rates not setup for {currency code} . FOF00155: The partially consumed package(s) will be charged to the guest account. FOF00156: There is a Rate Code Restriction for {restriction information}. FOF00157: The reservation status is not valid for an early departure. FOF00158: Early Departure is not required as the reservation is already in Due Out status.' content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/earlyDepartureInfo' '204': description: verifyForEarlyDeparture 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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/eligibleBillAmount: get: summary: Get Eligible Bill Amount description: Retrieves eligible bill amount in order to post redemption on a reservation folio

OperationId:getEligibleBillAmount

operationId: getEligibleBillAmount parameters: - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - name: folioView in: query required: false description: The folio window where this settlement is applied. schema: type: integer - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 Eligible Bill Amount. This object contains details related to amount that is eligible to redeem. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/amountEligible' '204': description: EligibleBillAmount 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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/fetchStagedTransactions: get: summary: Get fetchStagedTransactions description: This API is used to fetch the staged transactions for a given reservation.

OperationId:getfetchStagedTransactions

operationId: getfetchStagedTransactions parameters: - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - 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 - name: folioWindowNo in: query required: false description: Folio Window Number of the staged transactions. schema: type: integer - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 to the request to get the Reservation's staged comp transactions. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/stagedTransactions' '204': description: fetchStagedTransactions 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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/finalCharges: post: summary: Apply final Postings description: You can use this API to apply final postings on a reservation.

OperationId:applyFinalPostings

operationId: applyFinalPostings parameters: - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/finalPostings' description: Request to apply any final charges or payments to a reservation prior to checkout. This operation should be called prior to the guest settlement which would then reflect the balance the guest has to pay. required: true servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/fiscalInfo: post: summary: Post fiscal Info description: API to generate CHECK OUT payload for a reservation operationId: postFiscalInfo parameters: - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 20 minLength: 1 - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/postFiscalInfoType' description: Request to generate CHECK OUT payload for a reservation. required: true servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/fiscalPrinting: get: summary: Get Fiscal Printing Details description: You can use this API to get Fiscal Printing Details.

This API is deprecated. Please use getValidateFiscalPrintingDetails instead

OperationId:getFiscalPrintingDetails

operationId: getFiscalPrintingDetails deprecated: true parameters: - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: folioView in: query required: false description: The folio window where this settlement is applied. schema: type: integer - name: folioType in: query required: false description: Folio Type schema: type: string - name: id 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: code in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: fetchInstruction in: query description: Reservation Related information. required: false style: form explode: true schema: type: array items: type: string enum: - Paymentmethod - Profile - Foliotype - Reservation uniqueItems: true - name: profileIdId 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 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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: Check if it will call fiscal printing or not. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/fiscalCallStatus' '204': description: FiscalPrintingDetails 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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/fixedCharges: get: summary: Get Fixed Charges description: You can use this API to get fixed Charges for a reservation.

OperationId:getFixedCharges

operationId: getFixedCharges parameters: - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - 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. Refer to OpenTravel Code List Unique ID Type (UIT). schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 that contains either the fixed charges list if fetch was successful or error(s) if not. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/fixedChargesDetails' '204': description: FixedCharges 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: - Cashiering put: summary: 'Updates Fixed Charges ' description: You can use this API to update fixed Charges for a reservation.

OperationId:updateFixedCharges

operationId: updateFixedCharges parameters: - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/fixedCharges' description: Method to update fixed charges of a reservation. required: true delete: summary: 'Delete Fixed Charges ' description: You can use this API to remove fixed Charges for a reservation.

OperationId:removeFixedCharges

operationId: removeFixedCharges parameters: - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: fixedChargeID in: query description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. 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_2' - $ref: '#/components/parameters/x-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: - Cashiering post: summary: Create Fixed Charges description: You can use this API to create a fixed Charge for a reservation.

OperationId:postFixedCharges

operationId: postFixedCharges parameters: - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/fixedCharges' description: Method to create fixed charges of a reservation. required: true servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/flexibleBenefitPostings: post: summary: Apply flexible benefit postings description: You can use this API to apply flexible benefit postings.

OperationId:applyFlexibleBenefitPostings

operationId: applyFlexibleBenefitPostings parameters: - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/flexibleBenefitPostingsCriteria' description: Apply Flexible Benefit Postings. required: true servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/folioTaxPayments: get: summary: Get folio tax payments information description: You can use this API to get folio tax payments information.

OperationId:getFolioTaxPaymentsInfo

operationId: getFolioTaxPaymentsInfo parameters: - name: reservationId in: path required: true description: Unique ID of the reservation. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: folioWindowNo in: query required: false schema: type: integer - name: cashierId in: query required: false description: The Cashier ID of the Cashier who is currently processing the transaction(s). schema: type: number - name: description in: query required: false schema: type: string - name: folioView in: query required: false schema: type: integer - name: paymentMethod in: query required: false schema: type: string - name: track2Data in: query required: false description: Track2 data for the card which would be sent to the CC vendor as part of the authorization. schema: type: string - name: attachCreditCardToProfile in: query required: false description: Attach the credit card to profile. schema: type: boolean - name: cardHolderName in: query required: false schema: type: string - name: cardNumber in: query required: false schema: type: string - name: cardNumberLast4Digits in: query required: false schema: type: string - name: cardNumberMasked in: query required: false schema: type: string - name: cardOrToken in: query required: false description: Simple type for indicating if credit card number is tokenized. schema: type: string enum: - CardNumber - Token uniqueItems: true - name: cardType in: query required: false description: This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method. schema: type: string enum: - Ab - Am - Ax - Cb - Dc - Ds - Dt - Ec - Er - Jc - Jl - Mc - Nb - So - St - Sw - Va - Xy - Zz - Cp - Cu uniqueItems: true - name: expirationDate in: query required: false description: Expiration date of the credit card schema: type: string format: date - name: expirationDateExpired in: query required: false schema: type: boolean - name: expirationDateMasked in: query required: false description: Masked Expiration date of the credit card schema: type: string - name: processing in: query required: false schema: type: string enum: - Eft - Manual uniqueItems: true - name: swiped in: query required: false schema: type: boolean - name: userDefinedCardType in: query required: false description: Indicates the user defined credit card type if credit card type from a defined list is not provided schema: type: string - name: id 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: 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. Refer to OpenTravel Code List Unique ID Type (UIT). schema: 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: approvalAmountNeededAmount in: query required: false description: A monetary amount. schema: type: number - name: approvalAmountNeededCurrencyCode in: query required: false description: Provides a currency code to reflect the currency in which an amount may be expressed. schema: type: string - name: balanceAmount in: query required: false description: A monetary amount. schema: type: number - name: balanceCurrencyCode in: query required: false description: Provides a currency code to reflect the currency in which an amount may be expressed. schema: type: string - name: code in: query required: false description: The authorization rule code. schema: type: integer - name: amountAmount in: query required: false description: A monetary amount. schema: type: number - name: amountCurrencyCode in: query required: false description: Provides a currency code to reflect the currency in which an amount may be expressed. schema: type: string - name: percent in: query required: false description: A percentage value if the authorization rule is percentage based. schema: type: number - name: emailFolio in: query required: false schema: type: boolean - name: uniqueIdId 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: uniqueIdIdContext in: query required: false description: Used to identify the source of the identifier (e.g., IATA, ABTA). schema: type: string - name: uniqueIdType in: query required: false description: A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT). schema: type: string - name: createDateTime in: query required: false description: Time stamp of the creation. schema: type: string format: date-time - name: creatorId in: query required: false description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation. schema: type: string - name: emailAddress in: query required: false description: Defines the e-mail address. schema: type: string - name: emailFormat in: query required: false description: Supported Email format. schema: type: string enum: - Html - Text uniqueItems: true - name: lastModifierId in: query required: false description: Identifies the last software system or person to modify a record. schema: type: string - name: lastModifyDateTime in: query required: false description: Time stamp of last modification. schema: type: string format: date-time - name: orderSequence in: query required: false description: Display Order sequence. schema: type: number - name: primaryInd in: query required: false description: When true, indicates a primary information. schema: type: boolean - name: purgeDate in: query required: false description: Date an item will be purged from a database (e.g., from a live database to an archive). schema: type: string format: date - name: emailType in: query required: false description: Defines the purpose of the e-mail address (e.g. personal, business, listserve). schema: type: string - name: typeDescription in: query required: false description: Describes the Type code schema: type: string - name: approvalCode in: query required: false description: The approval code authenticates the authorization. schema: type: string - name: originalAuthSequence in: query required: false description: Unique Authorization Sequence for the authorization and settlement. schema: type: integer - name: vendorTranId in: query required: false description: Vendor transaction id for the authorization. schema: type: string - name: alternateTransRef in: query required: false description: Alternate vendor transaction id for the authorization. schema: type: string - name: approvalAmountAmount in: query required: false description: A monetary amount. schema: type: number - name: approvalAmountCurrencyCode in: query required: false description: Provides a currency code to reflect the currency in which an amount may be expressed. schema: type: string - name: postingAmountAmount in: query required: false description: A monetary amount. schema: type: number - name: postingAmountCurrencyCode in: query required: false description: Provides a currency code to reflect the currency in which an amount may be expressed. schema: type: string - name: postingReference in: query required: false description: User-defined posting reference. schema: type: string - name: postingRemark in: query required: false description: User-defined posting remark. schema: type: string - name: comments in: query required: false description: User Defined Comments. Used for Deposit Payment postings. schema: type: string - name: applyCCSurcharge in: query required: false description: Flag to indicate if Credit Card Surcharge has to be applied to this payment, when the functionality for Credit Card Surcharge is available. schema: type: boolean - name: manualPaymentTaxInfoFolioWindowNo in: query required: false schema: type: integer - name: transactionCode in: query required: false description: Billing Transaction Code of the Payment. schema: type: string - name: transactionDate in: query required: false description: Transaction Date of the Payment. schema: type: string format: date - name: transactionDescription in: query required: false description: Billing Transaction Description. schema: type: string - name: transactionNo in: query required: false description: Unique Transaction Identifier. schema: type: number - name: taxInvoiceNo in: query required: false description: The Tax Invoice for this payment. schema: type: string - name: paymentType in: query required: false description: The types of Payment Tax transactions. schema: type: string enum: - Deposit - FrontOffice - CreditNote - CityLedger - AccountsReceivables - NonVat uniqueItems: true - name: manualPaymentTaxAmount in: query required: false description: A monetary amount. schema: type: number - name: manualPaymentTaxCurrencyCode in: query required: false description: Provides a currency code to reflect the currency in which an amount may be expressed. schema: type: string - name: taxableAmountAmount in: query required: false description: A monetary amount. schema: type: number - name: taxableAmountCurrencyCode in: query required: false description: Provides a currency code to reflect the currency in which an amount may be expressed. schema: type: string - name: nonTaxableAmountAmount in: query required: false description: A monetary amount. schema: type: number - name: nonTaxableAmountCurrencyCode in: query required: false description: Provides a currency code to reflect the currency in which an amount may be expressed. schema: type: string - name: availableCreditAmount in: query required: false description: A monetary amount. schema: type: number - name: availableCreditCurrencyCode in: query required: false description: Provides a currency code to reflect the currency in which an amount may be expressed. schema: type: string - name: paymentDate in: query required: false description: The Payment Invoice date schema: type: string format: date - name: taxFolioWindowNo in: query required: false style: form explode: true schema: type: array items: type: integer - name: taxTransactionCode in: query description: Billing Transaction Code of the Payment. required: false style: form explode: true schema: type: array items: type: string - name: taxTransactionDate in: query description: Transaction Date of the Payment. required: false style: form explode: true schema: type: array items: type: string format: date - name: taxTransactionDescription in: query description: Billing Transaction Description. required: false style: form explode: true schema: type: array items: type: string - name: taxTransactionNo in: query description: Unique Transaction Identifier. required: false style: form explode: true schema: type: array items: type: number - name: taxTaxInvoiceNo in: query description: The Tax Invoice for this payment. required: false style: form explode: true schema: type: array items: type: string - name: taxPaymentType in: query description: The types of Payment Tax transactions. required: false style: form explode: true schema: type: array items: type: string enum: - Deposit - FrontOffice - CreditNote - CityLedger - AccountsReceivables - NonVat uniqueItems: true - name: creditablePaymentTaxesAmount in: query required: false description: A monetary amount. schema: type: number - name: creditablePaymentTaxesCurrencyCode in: query required: false description: Provides a currency code to reflect the currency in which an amount may be expressed. schema: type: string - name: creditablePaymentTaxableAmount in: query required: false description: A monetary amount. schema: type: number - name: creditablePaymentTaxableCurrencyCode in: query required: false description: Provides a currency code to reflect the currency in which an amount may be expressed. schema: type: string - name: creditablePaymentNonTaxableAmount in: query required: false description: A monetary amount. schema: type: number - name: creditablePaymentNonTaxableCurrencyCode in: query required: false description: Provides a currency code to reflect the currency in which an amount may be expressed. schema: type: string - name: availableTaxCreditAmount in: query required: false description: A monetary amount. schema: type: number - name: availableTaxCreditCurrencyCode in: query required: false description: Provides a currency code to reflect the currency in which an amount may be expressed. schema: type: string - name: taxPaymentDate in: query description: The Payment Invoice date required: false style: form explode: true schema: type: array items: type: string format: date - name: terminalId in: query required: false description: Applicable for chip and pin. The ID of the terminal where the chip and pin device is connected and where the payment is made. schema: type: string - name: overrideInsufficientCC in: query required: false description: Flag to allow a rebate by Credit Card schema: type: boolean - name: changeDueAmount in: query required: false description: A monetary amount. schema: type: number - name: changeDueAmountCurrencyCode in: query required: false description: Provides a currency code to reflect the currency in which an amount may be expressed. schema: type: string - name: overrideARCreditLimit in: query required: false description: Flag to override account receivable credit limit schema: type: boolean - name: applyCurrencyTaxes in: query required: false description: Flag to indidcate if currency taxes need to be applied or not. For ex, in case of Chile, it depends upon nationality of the guest. schema: type: boolean - name: vATOffset in: query required: false description: Flag to indidcate if currency taxes need to be applied or not. For ex, in case of Chile, it depends upon nationality of the guest. schema: type: boolean - name: action in: query required: false description: Payment action to know from where the payment has been made. schema: type: string enum: - Billing - Settlefolio - Deposit - Compredemption - Prepaidcardredemption - Advancepayment uniqueItems: true - name: reservationIdIdContext in: query required: false description: Used to identify the source of the identifier (e.g., IATA, ABTA). schema: type: string - name: reservationIdType in: query required: false description: A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT). schema: type: string - name: profileIdId 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: profileIdIdContext in: query required: false description: Used to identify the source of the identifier (e.g., IATA, ABTA). schema: type: string - name: profileIdType in: query required: false description: A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT). schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 to the request for Payment Tax records for a reservation. Lists all the Payment Taxes for the reservation which are available. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/folioTaxPaymentsInfo' '204': description: FolioTaxPaymentsInfo 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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/folios: get: summary: Get folios description: This API is used to fetch the folios for a given reservation. A guest reservation could have 1 or more folios per reservation. Folios will only exist for a reservation once the guest has checked into the hotel.

OperationId:getFolio

This API allows a time span of 30 days.

operationId: getFolio parameters: - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: guestPayOnly in: query required: false description: Flag to return the Folio Windows information where the Reservation Guest is the Payee, i.e the Folio Window is not Routed to another Reservation or another Profile. schema: type: boolean - name: includeFolioHistory in: query required: false description: This flag will notify the service if the folio history will also be returned or not. schema: type: boolean - name: reservationBalanceOnly in: query required: false description: This flag will notify the service if the reservation summary information will be returned. If TRUE then we will only return the reservation's outstanding balance. schema: type: boolean - name: fetchInstructions in: query description: Posting details of each window. required: false style: form explode: true schema: type: array items: type: string enum: - Reservation - Windowbalances - Payment - Payee - Account - Guestpay - Notifications - Transactioncodes - Foliohistory - Totalbalance - Postings - Originalreservationinfo uniqueItems: true - name: end in: query description: The ending value of the date range. required: false style: form explode: true schema: type: array items: type: string format: date - name: folioWindowNo in: query required: false style: form explode: true schema: type: array items: type: integer - name: limit in: query description: Indicates maximum number of records a Web Service should return. required: false style: form explode: true schema: type: array items: type: integer - name: offset in: query description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. required: false style: form explode: true schema: type: array items: type: integer - name: start in: query description: The starting value of the date range. required: false style: form explode: true schema: type: array items: type: string format: date - name: summaryOnly in: query required: false description: This flag will notify the service that transactional postings will not be returned. schema: type: boolean - name: groupType in: query required: false description: Grouping by Transactin Type. schema: type: string enum: - CheckNo - TransactionDate - TransactionCode - TransactionType uniqueItems: true - name: exchangeCurrency in: query required: false description: Currency to which the Credit and Debit Amounts will be converted for each Folio. The response will have the ExchangeAmounts element with the converted amounts. The Posting Exchange Rate of the current business date will be used for the conversion schema: type: string - name: calculateCollectingAgentTaxes in: query required: false schema: type: boolean - name: vATOffset in: query required: false schema: type: boolean - name: includeDepositTaxes in: query required: false schema: type: boolean - name: simpleFolio in: query required: false description: This flag signifies that generated Folio is Normal or Simple Folio. Certain countries of the World mandate a simple folio when the invoice amount is less than defined threshold. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 to the request to get Financial Information for a Reservation content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/folio' '204': description: Folio 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: - Cashiering put: summary: Close Reservation Folio description: You can use this API to close the Reservation Folio on a reservation.

OperationId:closeReservationFolio

operationId: closeReservationFolio parameters: - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/closeFolioCriteria' description: Request to close an Open Folio Reservation. The Property should be using the Open Folio Functionality to use this operation. required: true post: summary: Generate Folios description: You can use this API to generate folios for a reservation.

OperationId:generateFolio

operationId: generateFolio parameters: - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: 'Generate Folio Response contains generated folio no and invoice number along or errors and warnings in case if folio couldn''t be generated: FOF00065 - The hotel code and/or reservation id is missing. FOF00066 - Reservation can''t be found with the supplied hotel code and reservation id. FOF00123 - Folio window has a balance and folio cannot be generated. FOF00124 - The guest''s reservation is not in a valid status for folio generation.' content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/generatedFolio' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/folioCriteria' description: Generate Folio request can be used to create a folio for checked in reservation or reservation with open folios required: true servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/memberships/{membershipId}/awardTransactions: post: summary: Post a membership award payment transaction. description: Creates a new membership award payment transaction.

OperationId:postAwardTransaction

operationId: postAwardTransaction parameters: - name: hotelId in: path required: true description: Unique ID of the hotel. schema: type: string - name: reservationId in: path required: true description: Unique ID of the reservation. schema: type: number - name: membershipId in: path required: true description: Membership number of the guest in the reservation. schema: type: number - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/awardPaymentDetails' description: Request object for creating an award transaction. required: true servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/packageAllowance/links: delete: summary: Unlink reservation package allowance description: You can use this API to unlink reservation package allowance.

OperationId:unlinkReservationPackageAllowance

operationId: unlinkReservationPackageAllowance parameters: - name: reservationId in: path required: true description: Unique ID of the reservation. schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/packageOptions: get: summary: Get Reservation Package Options description: You can use this API to get Reservation Package Options.

OperationId:getReservationPackageOptions

operationId: getReservationPackageOptions parameters: - name: reservationId in: path required: true description: Unique ID of the reservation. schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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 to fetch reservation package options. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/reservationPackageOptions' '204': description: ReservationPackageOptions 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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/paymentMethods/creditCard/authorize: post: summary: Authorize Credit Card Amount description: You can use this API to authorize Credit Card Amount by Reservation.

OperationId:authorizeCreditCardAmount

operationId: authorizeCreditCardAmount parameters: - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: Response to the credit card authorization request. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/authorizationInfo' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/ccAuthorizationCriteria' description: Request for a credit card authorization. An authorization request will be sent to the Credit Card Vendor as part of this request. required: true servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/paymentMethods/creditCard/authorize/manual: post: summary: Register Manual Authorization description: You can use this API to register Manual Authorization.

OperationId:registerManualAuthorization

operationId: registerManualAuthorization parameters: - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/ccManualAuthorizationCriteria' description: Request for registering a Manual Authorization. required: true servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/paymentMethods/creditCard/authorizeInstructions: post: summary: Get CC Authorization Instructions description: You can use this API to get Credit Card Authorization Instructions by Reservation.

OperationId:postCCAuthorizationInstructions

operationId: postCCAuthorizationInstructions parameters: - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: Response to the fetch authorization instructions. Based on the criteria requested, the response can contain information required to send a credit card authorization to the Vendor. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ccAuthorizationInstructions' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/ccAuthorizationInstructionsCriteria' description: Criteria for fetching CC Authorization Instructions. required: true servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/payments: post: summary: Create Billing Payment description: You can use this API to create Billing Payment on the folio of a Reservation.

OperationId:postBillingPayment

operationId: postBillingPayment parameters: - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: Response notifying if the posting of a payment to a reservation was successful. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/postedBillingPayment' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/billingPayment' description: Request to post a payment on a reservation's folio. required: true servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/postingActivities: get: summary: Get posting activity details description: You can use this API to get posting activity details.

OperationId:getPostingActivityDetail

operationId: getPostingActivityDetail parameters: - name: reservationId in: path required: true description: Unique ID of the reservation. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - 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. Refer to OpenTravel Code List Unique ID Type (UIT). schema: type: string - name: module in: query required: false schema: type: string - name: logDate in: query required: false schema: type: string format: date-time - name: refActionId in: query required: false schema: type: number - name: logUserId in: query required: false schema: type: integer - name: logUserName in: query required: false schema: type: string - name: machineStation in: query required: false schema: type: string - name: croCode in: query required: false schema: type: string - name: actionType in: query required: false schema: type: string - name: actionDescription in: query required: false schema: type: string - name: iPAddress in: query required: false description: The IP Address of the machine that performed the activity schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 to the request to get financial details for a Posting Activity. This will return the before and after values for the transactions which were changed. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/postingActivityDetail' '204': description: PostingActivityDetail 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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/prepaidCards/redemptions: put: summary: Operation to redeem prepaid cards. description: You can use this API to redeem Prepaid Cards

OperationId:redeemPrepaidCards

operationId: redeemPrepaidCards parameters: - name: reservationId in: path required: true description: Unique ID of the reservation. schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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 for redeem Prepaid cards request. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/redeemPrepaidCardsStatus' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/redeemPrepaidCards' description: Request type for Prepaid card redeem amount request. required: true servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/proforma: post: summary: Create proforma description: You can use this API to create proforma for a specific reservation.

OperationId:postProforma

operationId: postProforma deprecated: true parameters: - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: Response for the Create Proforma WS. After the proforma is created by this request, the Opera Proforma report should be called to generate the actual physical Proforma report. The response can have the summary of the Guests Proforma Folio, if requested. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/reservationFolioInformation' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/reservationFolio' description: Request to create a Proforma(folio) transactions for a reservation. The request generates the internal transactions required to create a Proforma report. After this request is called , the Opera Proforma report should be called so that these transactions can be used in the report. If the report is called without this request, the report will be incorrect and will not have the complete information. If the report is not used after this request, the internal transactions will be removed either by night audit or by the next request. required: true servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/proformaFolio: post: summary: Create proforma description: API to create Pro-Forma for a specific reservation for external partners.

OperationId:postProformaFolio

OperationId:postProformaFolio

operationId: postProformaFolio parameters: - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: Response for the Create Proforma WS. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/proformaFolio' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/proformaReservationFolio' description: Request to create a Pro-Forma(folio) transactions for a reservation for external partners via OHIP domain. The request generates the internal transactions required to create a Pro-Forma folio, pass it into the response and finally remove/cleanup these transactions required: true servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/revenueBuckets: get: summary: Get Reservations Revenue Bucket Totals description: You can use this API to get a reservations Revenue Bucket Totals.

OperationId:getReservationRevenueBucketTotals

operationId: getReservationRevenueBucketTotals parameters: - name: reservationId in: path required: true description: Unique ID of the reservation. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - 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. Refer to OpenTravel Code List Unique ID Type (UIT). schema: type: string - name: revenueBucketType in: query required: false description: Type if the revenue bucket. schema: type: string - name: compRevenue in: query required: false description: This flag will notify the service if the revenue is of complimentary type. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 revenue bucket totals for a reservation. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/revenueBucketTotals' '204': description: ReservationRevenueBucketTotals 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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/reverseCertificate: post: summary: Reverse certificate postings description: You can use this API to Reverse certificate postings.

OperationId:reverseCertificatePostings

operationId: reverseCertificatePostings parameters: - name: reservationId in: path required: true description: Unique ID of the reservation. schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/reverseCertificatePostingsCriteria' description: Request to reverse the certificate postings of transactions. required: true servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/routingInstructions: get: summary: Get routing instructions description: You can use this API to retrieve routing instructions for a specified reservation.

OperationId:getRoutingInstructions

The maximum allowable limit for this API is 20.

operationId: getRoutingInstructions parameters: - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: idContext in: query required: false description: Used to identify the source of the identifier (e.g., IATA, ABTA). schema: type: string - name: includeWindowRouting in: query required: false description: Include the window routing instructions to the response. schema: type: boolean - name: includeRoomRouting in: query required: false description: Include the room routing instructions in the response. schema: type: boolean - name: includeCompRouting in: query required: false description: Include the comp routing instructions in the response. schema: type: boolean - name: includeCompRoutingRequests in: query required: false description: Include the comp routing requests in the response. schema: type: boolean - name: effectiveOn in: query required: false description: If date is included then the search result should only be valid for dates which includes this date. schema: type: string format: date - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 containing routing instructions for a reservation. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/routingInstructionsDetails' '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: - Cashiering delete: summary: Delete routing instructions description: You can use this API to delete routing instructions for a specified reservation.

This API is deprecated. Please use deleteFolioRoutingInstructions or deleteRoomRoutingInstructions or deleteCompRoutingInstructions or deleteRequestRoutingInstructions instead

OperationId:deleteRoutingInstructions

operationId: deleteRoutingInstructions deprecated: true parameters: - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/routingInstructions/change: put: summary: Change routing instructions description: You can use this API to update routing instructions for a specified reservation.

OperationId:changeRoutingInstructions

operationId: changeRoutingInstructions parameters: - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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 when changing a routing instruction. It may optionally return a list of postings which are eligible for transfer as per the modified routing instruction in case of room routing instruction. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/changedRoutingInstructions' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/routingInstructionsToChange' description: Request when changing a routing instruction. required: true servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/routingInstructions/comp: delete: summary: Delete comp routing instructions description: You can use this API to delete comp routing instructions for a specified reservation.

OperationId:deleteCompRoutingInstructions

operationId: deleteCompRoutingInstructions parameters: - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: refreshFolio in: query required: false description: On a successful update, the transactions that are already posted in the guest's folio will be re-organized based on the configured instructions. schema: type: boolean - name: retrievePostingsForRoomRouting in: query required: false description: This flag indicates if postings that can be refreshed need to be part of the response when a routing instruction is created, updated or deleted. schema: type: boolean - name: folioWindowNo in: query required: false schema: type: integer - name: payeeId 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: membershipIdNo in: query required: false description: Unique Id of membership schema: type: integer - name: authorizerId 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: userId in: query required: false description: User Id of the Opera User schema: type: integer - name: userName in: query required: false description: Name of the Opera User schema: type: string - name: comments in: query required: false schema: type: string - name: daily in: query required: false description: Flag to indicate if the routing instruction is a daily instruction. schema: type: boolean - name: sunday in: query required: false schema: type: boolean - name: monday in: query required: false schema: type: boolean - name: tuesday in: query required: false schema: type: boolean - name: wednesday in: query required: false schema: type: boolean - name: thursday in: query required: false schema: type: boolean - name: friday in: query required: false schema: type: boolean - name: saturday in: query required: false schema: type: boolean - name: startDate in: query required: false schema: type: string format: date - name: endDate in: query required: false schema: type: string format: date - name: creditLimit in: query description: Allowable credit amount for this routing instruction. Null value means no limit, 0 equals zero. required: false style: form explode: true schema: type: array items: type: number - name: percentageLimit in: query description: The routing limit percentage allowed for this routing instruction. required: false style: form explode: true schema: type: array items: type: number - name: covers in: query description: Number of covers for this routing instruction. required: false style: form explode: true schema: type: array items: type: number - name: transactionCode in: query description: Unique identifier for the Transaction code. required: false style: form explode: true schema: type: array items: type: string - name: billingCode in: query description: Unique identifier for the Billing Instruction. required: false style: form explode: true schema: type: array items: type: string - name: routingInstructionsId in: query description: This is the Routing Instruction Id attached with Reservation. It is only used for internal purpose. It should not be used by external vendor or consumer. required: false style: form explode: true schema: type: array items: type: number - name: routingLinkId 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 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 when removing a routing instruction. It may optionally return a list of postings which are eligible for transfer as per the deleted routing instruction in case of room routing instruction. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/roomRoutingPostings' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/routingInstructions/create: put: summary: Create routing instructions description: You can use this API to add routing instructions to a reservation.

OperationId:putRoutingInstructions

operationId: putRoutingInstructions parameters: - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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 when creating a routing instruction. It may optionally return a list of postings which are eligible for transfer as per the new routing instruction in case of room routing instruction. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/createdRoutingInstructions' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/routingInstructions' description: Request to create a routing instruction. required: true servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/routingInstructions/folio: delete: summary: Delete Folio routing instructions description: You can use this API to delete folio routing instructions for a specified reservation.

OperationId:deleteFolioRoutingInstructions

operationId: deleteFolioRoutingInstructions parameters: - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: refreshFolio in: query required: false description: On a successful update, the transactions that are already posted in the guest's folio will be re-organized based on the configured instructions. schema: type: boolean - name: retrievePostingsForRoomRouting in: query required: false description: This flag indicates if postings that can be refreshed need to be part of the response when a routing instruction is created, updated or deleted. schema: type: boolean - name: folioWindowNo in: query required: false schema: type: integer - name: payeeId 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: daily in: query required: false description: Flag to indicate if the routing instruction is a daily instruction. schema: type: boolean - name: sunday in: query required: false schema: type: boolean - name: monday in: query required: false schema: type: boolean - name: tuesday in: query required: false schema: type: boolean - name: wednesday in: query required: false schema: type: boolean - name: thursday in: query required: false schema: type: boolean - name: friday in: query required: false schema: type: boolean - name: saturday in: query required: false schema: type: boolean - name: startDate in: query required: false schema: type: string format: date - name: endDate in: query required: false schema: type: string format: date - name: creditLimit in: query description: Allowable credit amount for this routing instruction. Null value means no limit, 0 equals zero. required: false style: form explode: true schema: type: array items: type: number - name: percentageLimit in: query description: The routing limit percentage allowed for this routing instruction. required: false style: form explode: true schema: type: array items: type: number - name: covers in: query description: Number of covers for this routing instruction. required: false style: form explode: true schema: type: array items: type: number - name: transactionCode in: query description: Unique identifier for the Transaction code. required: false style: form explode: true schema: type: array items: type: string - name: billingCode in: query description: Unique identifier for the Billing Instruction. required: false style: form explode: true schema: type: array items: type: string - name: routingInstructionsId in: query description: This is the Routing Instruction Id attached with Reservation. It is only used for internal purpose. It should not be used by external vendor or consumer. required: false style: form explode: true schema: type: array items: type: number - name: routingLinkId 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 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 when removing a routing instruction. It may optionally return a list of postings which are eligible for transfer as per the deleted routing instruction in case of room routing instruction. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/roomRoutingPostings' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/routingInstructions/request: delete: summary: Delete request routing instructions description: You can use this API to delete request routing instructions for a specified reservation.

OperationId:deleteRequestRoutingInstructions

operationId: deleteRequestRoutingInstructions parameters: - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: refreshFolio in: query required: false description: On a successful update, the transactions that are already posted in the guest's folio will be re-organized based on the configured instructions. schema: type: boolean - name: retrievePostingsForRoomRouting in: query required: false description: This flag indicates if postings that can be refreshed need to be part of the response when a routing instruction is created, updated or deleted. schema: type: boolean - name: userName in: query required: false description: Name of the Opera User schema: type: string - name: comments in: query required: false schema: type: string - name: daily in: query required: false description: Flag to indicate if the routing instruction is a daily instruction. schema: type: boolean - name: sunday in: query required: false schema: type: boolean - name: monday in: query required: false schema: type: boolean - name: tuesday in: query required: false schema: type: boolean - name: wednesday in: query required: false schema: type: boolean - name: thursday in: query required: false schema: type: boolean - name: friday in: query required: false schema: type: boolean - name: saturday in: query required: false schema: type: boolean - 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_2' - $ref: '#/components/parameters/x-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 when removing a routing instruction. It may optionally return a list of postings which are eligible for transfer as per the deleted routing instruction in case of room routing instruction. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/roomRoutingPostings' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/routingInstructions/room: delete: summary: Delete Room routing instructions description: You can use this API to delete room routing instructions for a specified reservation.

OperationId:deleteRoomRoutingInstructions

operationId: deleteRoomRoutingInstructions parameters: - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: refreshFolio in: query required: false description: On a successful update, the transactions that are already posted in the guest's folio will be re-organized based on the configured instructions. schema: type: boolean - name: retrievePostingsForRoomRouting in: query required: false description: This flag indicates if postings that can be refreshed need to be part of the response when a routing instruction is created, updated or deleted. schema: type: boolean - name: reservationNameId 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: daily in: query required: false description: Flag to indicate if the routing instruction is a daily instruction. schema: type: boolean - name: sunday in: query required: false schema: type: boolean - name: monday in: query required: false schema: type: boolean - name: tuesday in: query required: false schema: type: boolean - name: wednesday in: query required: false schema: type: boolean - name: thursday in: query required: false schema: type: boolean - name: friday in: query required: false schema: type: boolean - name: saturday in: query required: false schema: type: boolean - name: startDate in: query required: false schema: type: string format: date - name: endDate in: query required: false schema: type: string format: date - name: creditLimit in: query description: Allowable credit amount for this routing instruction. Null value means no limit, 0 equals zero. required: false style: form explode: true schema: type: array items: type: number - name: percentageLimit in: query description: The routing limit percentage allowed for this routing instruction. required: false style: form explode: true schema: type: array items: type: number - name: covers in: query description: Number of covers for this routing instruction. required: false style: form explode: true schema: type: array items: type: number - name: transactionCode in: query description: Unique identifier for the Transaction code. required: false style: form explode: true schema: type: array items: type: string - name: billingCode in: query description: Unique identifier for the Billing Instruction. required: false style: form explode: true schema: type: array items: type: string - name: routingInstructionsId in: query description: This is the Routing Instruction Id attached with Reservation. It is only used for internal purpose. It should not be used by external vendor or consumer. required: false style: form explode: true schema: type: array items: type: number - name: routingLinkId 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 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 when removing a routing instruction. It may optionally return a list of postings which are eligible for transfer as per the deleted routing instruction in case of room routing instruction. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/roomRoutingPostings' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/transactions: put: summary: Delete transactions for specific reservation on current business day description: This operation deletes transactions for the specified reservation that occurred on the current business day. Only transactions posted on the current business date are eligible. Filtering by specific transaction numbers and providing a valid deletion reason code are required. The response includes processing status and any warnings or errors. operationId: deleteReservationTransactions parameters: - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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: Results of the transaction deletion process. 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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/deleteTransactionsCriteriaType' description: Criteria for transactions to be deleted. required: true servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/transactions/{transactionId}: get: summary: Get eligibility of Deposit Refund description: You can use this API to get eligibility of Deposit Refund.

OperationId:isDepositRefundEligible

operationId: isDepositRefundEligible parameters: - name: transactionId in: path required: true description: Unique ID of the transaction schema: type: string maxLength: 2000 minLength: 1 - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - 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. Refer to OpenTravel Code List Unique ID Type (UIT). schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 the refund deposit payment. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/depositRefundEligibleCheck' '204': description: isDepositRefundEligible 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: - Cashiering put: summary: Split deposit transaction description: You can use this API to Split deposit transaction.

OperationId:splitDepositTransaction

operationId: splitDepositTransaction parameters: - name: transactionId in: path required: true description: Unique ID of the transaction schema: type: string maxLength: 2000 minLength: 1 - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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 after spliting deposit transaction. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/splitDepositTransactionStatus' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/splitDepositTransaction' description: Request to split deposit transaction for a reservation. required: true servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/transferFolioTransactions: put: summary: Transfer Folio to Window. description: You can use this API to transfer Folio to Window.

OperationId:transferFolioToWindow

operationId: transferFolioToWindow parameters: - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/folioToWindow' description: Request for transaction folio(s) to specific window required: true servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/transferTransactions: put: summary: Transfer Transaction to Window description: You can use this API to transfer Transaction to Window.

OperationId:transferTransactionToWindow

operationId: transferTransactionToWindow parameters: - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: 'Transaction Transfer Response contains errors: FOF00065 - Reservation ID or Resort was not supplied. FOF00128 - Transactions that were automatically generated cannot be transferred. FOF00129 - Transactions with Folio Numbers cannot be transferred. FOF00130 - Transactions with Invoice Numbers cannot be transferred. FOF00131 - Deposit Transactions cannot be transferred. FOF00132 - The status of the reservation is not valid for Financial Transaction transfers. FOF00133 - The Transaction number(s) are invalid. FOF00134 - Folio window not supplied. FOF00135 - List of transactions not supplied.' content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/transferTransactionToWindow' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/transactionToWindow' description: Request for transaction transfer required: true servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/voidfolios/{folioId}: put: summary: Void folio description: You can use this API to void a folio.

OperationId:voidFolio

operationId: voidFolio parameters: - name: folioId in: path required: true description: Unique ID of the folio. schema: type: string maxLength: 2000 minLength: 1 - name: reservationId in: path required: true description: Unique ID of the reservation. schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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 to the request for voiding a Guest Folio. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/voidedFolio' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/folioToVoid' description: Request to Void a Guest Folio when the Void Functionality is active. required: true servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{reservationId}/vouchers: get: summary: Get the list of vouchers generated for a reservation. description: This API is used to fetch the list of vouchers from a reservation.

OperationId:getReservationVouchers

operationId: getReservationVouchers parameters: - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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 to the request to get the Reservation vouchers. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/reservationVouchersType' '204': description: Get reservation 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: - Cashiering post: summary: Generate Reservation Vouchers description: Generate vouchers for the reservation.

OperationId:postReservationVouchers

operationId: postReservationVouchers parameters: - name: reservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{resvNameId}/compTransactionAuthorizers: get: summary: Get Comp Transaction Authorizers description: You can use this API to get Comp Transaction Authorizers.

OperationId:getCompTrxAuthorizers

operationId: getCompTransactionAuthorizers parameters: - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: resvNameId in: path description: Reservation id of the transactions to be transferrred to other window. required: true schema: type: string maxLength: 20 minLength: 1 - name: idContext in: query description: Used to identify the source of the identifier. required: false schema: type: string maxLength: 20 minLength: 1 - name: type in: query description: A reference to the type of object defined by the UniqueID element. required: false schema: type: string maxLength: 20 minLength: 1 - name: targetFolioWindowId in: query required: false description: Folio Window Number to where transactions will be transfered. schema: type: integer - name: transactionId in: query description: List of transactions that are associated to the authorizer. required: true style: form explode: true schema: type: array items: type: number maxItems: 4000 - name: authorizerId in: query required: false description: A unique identifying value assigned for authorizer. schema: type: string maxLength: 20 minLength: 1 - name: authorizerName in: query required: false description: A name of the authorizer. schema: type: string maxLength: 80 minLength: 1 - name: transactionCodeList in: query description: List of Transaction code that are associated to the authorizer. required: false 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 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 comp authorizers operation. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/compTransactionAuthorizers' '204': description: CompTransactionAuthorizers 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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{sourceReservationId}/deposit/transfers: put: summary: Change Reservation Deposit Transfer. description: You can use this API to change Reservation Deposit Transfer.

OperationId:putReservationDepositTransfer

operationId: putReservationDepositTransfer parameters: - name: sourceReservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/depositTransferCriteria' description: Request to transfer a deposit amount from one reservation to one or more reservations. required: true servers: - url: /csh/v1 /hotels/{hotelId}/reservations/{toReservationId}/transferTransaction: put: summary: Transfer Transaction to Reservation description: You can use this API to Transfer Transaction to Reservation.

OperationId:transferTransactionToReservation

operationId: transferTransactionToReservation parameters: - name: toReservationId in: path required: true description: Unique ID of the reservation schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/reservationTransaction' description: Request to transfer a transaction(s) to a reservation. In the criteria, the target Reservation Id is required for the transfer. required: true servers: - url: /csh/v1 /hotels/{hotelId}/revenue: get: summary: Get Hotel Revenue description: You can use this API to get Hotel Revenue.

OperationId:getHotelRevenue

operationId: getHotelRevenue parameters: - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: businessDate in: query required: false description: Business date. schema: type: string format: date - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 hotel room revenue for all HHonors redemption reservation. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/hotelRevenueDetails' '204': description: HotelRevenue 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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/routingInstructionCodes: get: summary: Get Billing (routing) Instruction Codes description: You can use this API to get Billing Instruction Codes.

OperationId:getBillingInstructionCodes

operationId: getBillingInstructionCodes parameters: - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: includeTransactionCodes in: query required: false description: Flag to include the search in the Transaction Codes. schema: type: boolean - name: includeBillingInstructions in: query required: false description: Flag to include the search in the Billing Instructions. schema: type: boolean - name: includeCompInstructions in: query required: false description: Flag to include the comp instructions in the available list. schema: type: boolean - name: codeWildCard in: query required: false description: Lookup string which will try to match an existing Billing and/or Transaction Codes. schema: type: string - name: descriptionWildCard in: query required: false description: Lookup string which will try to match an existing Billing and/or Transaction Code Description. schema: type: string - name: id 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: 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. Refer to OpenTravel Code List Unique ID Type (UIT). schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 containing comp routing instructions for a reservation . content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/billingInstructionCodes' '204': description: BillingInstructionCodes 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: - Cashiering servers: - url: /csh/v1 ? /hotels/{hotelId}/sourceReservations/{sourceReservationId}/destinationReservations/{destinationReservationId}/packageAllowance/links : post: summary: Link Reservation package allowance description: You can use this API to link reservation package allowance.

OperationId:linkReservationPackageAllowance

operationId: linkReservationPackageAllowance parameters: - name: destinationReservationId in: path required: true description: Unique ID of the destination reservation. schema: type: string maxLength: 2000 minLength: 1 - name: sourceReservationId in: path required: true description: Unique ID of the source reservation. schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/linkReservationPackageAllowance' description: Method to create package allowance link from a source reservation to the target reservation. required: true servers: - url: /csh/v1 /hotels/{hotelId}/sourceReservations/{sourceReservationId}/targetReservations/{targetReservationId}/roomRouting: get: summary: Get Postings For Refresh description: You can use this API to get postings For Refresh.

OperationId:getPostingsForRefresh

operationId: getPostingsForRefresh parameters: - name: targetReservationId in: path required: true description: Unique ID of the target reservation schema: type: string maxLength: 2000 minLength: 1 - name: sourceReservationId in: path required: true description: Unique ID of the source reservation schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - 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. Refer to OpenTravel Code List Unique ID Type (UIT). schema: type: string - name: targetResvNameIdContext in: query required: false description: Used to identify the source of the identifier (e.g., IATA, ABTA). schema: type: string - name: targetResvNameIdType in: query required: false description: A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT). schema: type: string - name: daily in: query required: false description: Flag to indicate if the routing instruction is a daily instruction. schema: type: boolean - name: friday in: query required: false schema: type: boolean - name: monday in: query required: false schema: type: boolean - name: saturday in: query required: false schema: type: boolean - name: sunday in: query required: false schema: type: boolean - name: thursday in: query required: false schema: type: boolean - name: tuesday in: query required: false schema: type: boolean - name: wednesday in: query required: false schema: type: boolean - name: startDate in: query required: false schema: type: string format: date - name: endDate in: query required: false schema: type: string format: date - name: transactionHotelId in: query description: Hotel context of the Transaction code. required: false style: form explode: true schema: type: array items: type: string - name: printTrxReceipt in: query description: Print receipt flag that tells whether the transaction receipt is to be printed or not. This is based on the transaction code. required: false style: form explode: true schema: type: array items: type: boolean - name: transactionCode in: query description: Unique identifier for the Transaction code. required: false style: form explode: true schema: type: array items: type: string - name: description in: query description: Transaction codes info. required: false style: form explode: true schema: type: array items: type: string - name: transactionGroup in: query description: Category of the transaction code. required: false style: form explode: true schema: type: array items: type: string - name: transactionSubGroup in: query description: Sub category of the transaction code. required: false style: form explode: true schema: type: array items: type: string - name: universalProductCode in: query description: Unique Universal product code of the transaction code. required: false style: form explode: true schema: type: array items: type: string - name: routingInstructionsId in: query description: This is the Routing Instruction Id attached with Reservation. It is only used for internal purpose. It should not be used by external vendor or consumer. required: false style: form explode: true schema: type: array items: type: number - name: articleCode in: query description: Unique code of the article. required: false 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. 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: articleDescription in: query description: Description of the article. required: false style: form explode: true schema: type: array items: type: string - name: articleTransactionCode 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: articleUniversalProductCode in: query description: Unique Universal product code of the article. required: false style: form explode: true schema: type: array items: type: string - name: billingCode in: query description: Unique identifier for the Billing Instruction. required: false style: form explode: true schema: type: array items: type: string - name: billingHotelId in: query description: Hotel context of the Billing Instruction. required: false style: form explode: true schema: type: array items: type: string - name: desc in: query description: Billing Instruction code description. required: false style: form explode: true schema: type: array items: type: string - name: billingInstructionRoutingInstructionsId in: query description: This is the Routing Instruction Id attached with Reservation. It is only used for internal purpose. It should not be used by external vendor or consumer. required: false style: form explode: true schema: type: array items: type: number - name: creditLimit in: query required: false description: Allowable credit amount for this routing instruction. Null value means no limit, 0 equals zero. schema: type: number - name: percentageLimit in: query required: false description: The routing limit percentage allowed for this routing instruction. schema: type: number - name: covers in: query required: false description: Number of covers for this routing instruction. schema: type: number - name: limitUsed in: query required: false description: Amount of Credit used for this routing instruction. schema: type: number - name: id 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: routingLinkIdIdContext in: query required: false description: Used to identify the source of the identifier (e.g., IATA, ABTA). schema: type: string - name: routingLinkIdType in: query required: false description: A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT). schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 lists the transactions that can be refreshed when a routing instruction set is refreshed. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/postingsForRefresh' '204': description: PostingsForRefresh 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: - Cashiering put: summary: Process Room Routing Refresh description: You can use this API to change Room Routing Refresh.

OperationId:processRoomRoutingRefresh

operationId: processRoomRoutingRefresh parameters: - name: targetReservationId in: path required: true description: Unique ID of the target reservation schema: type: string maxLength: 2000 minLength: 1 - name: sourceReservationId in: path required: true description: Unique ID of the source reservation schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/roomRoutingRefresh' description: The request object for processing refreshing of a routing instruction set. This operation transfers the postings to the respective reservation as per the routing instruction set which is created, edited, deleted or refreshed. required: true servers: - url: /csh/v1 /hotels/{hotelId}/storedFolios/{folioId}: get: summary: Get Stored Folio Details description: You can use this API to get Stored Folio Details.

OperationId:getStoredFolioDetails

operationId: getStoredFolioDetails parameters: - name: folioId in: path required: true description: Unique ID of the folio. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: fiscalBillNo in: query required: false description: The Fiscal Bill number of this posting schema: type: string - name: folioDate in: query required: false description: Date of Folio Generation. schema: type: string format: date - name: folioStatus in: query required: false description: 'The Folio Status Example: DEPOSIT folio, VOID folio or the default OK folio status.' schema: type: string enum: - Deposit - Void - Ok - Zero - Compress - Converted - Internal uniqueItems: true - name: folioTypeName in: query required: false description: The name of the Folio Type used for the Folio Number sequence. schema: type: string - name: internalFolioWindowID in: query required: false description: Internal window ID which is unique to the reservation. This ID can only be used for reference. schema: type: string - name: invoiceNo in: query required: false description: Invoice No after the folio is generated. Same invoice number may be referred in multiple folios schema: type: number - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 stored folio details operation content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/storedFolioDetailsInfo' '204': description: StoredFolioDetails 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: - Cashiering post: summary: Create Stored Folio Details description: You can use this API to create Stored Folio Details.

OperationId:postStoredFolioDetails

operationId: postStoredFolioDetails parameters: - name: folioId in: path required: true description: Unique ID of the folio. schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/storedFolioDetails' description: Request object to update stored folio details. required: true servers: - url: /csh/v1 /hotels/{hotelId}/supplementFolios: post: summary: Post supplemental folio description: You can use this API to post supplemental folio.

OperationId:postSupplementalFolio

operationId: postSupplementalFolio 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_2' - $ref: '#/components/parameters/x-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: Response for the request to create Supplemental Folio. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/postSupplementalFolioStatus' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/postSupplementalFolio' description: Request to post a Supplemental Folio for an existing Folio. Debit Bill ( Supplemental Folio ) Functionality parameter is required required: true servers: - url: /csh/v1 /hotels/{hotelId}/transactionCodes: get: summary: Get Transaction Codes description: You can use this API to retrieve a list of Transaction Codes configured for a property.

OperationId:getTransactionCodes

operationId: getTransactionCodes parameters: - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: event in: query required: false description: Event being generated by a Supplemental Folio. schema: type: string enum: - CheckOut - EarlyDeparture - AdvanceBill - InterimBill - PasserBy - PostIt - CreditBill - Deposit - DepositRefund - AutoFolio - PrepaidCard - AutoSettlement - InformationFolio - SupplementalFolio uniqueItems: true - name: includeArticles in: query required: false description: Flag to indicate if Article Codes are required, along with the parent Transaction Codes. schema: type: boolean default: false - name: userRoleTransactions in: query required: false description: Flag to indicate if it is allowed to manually post transaction codes. schema: type: boolean - name: manualPostAllowed in: query required: false description: Flag to include the search for Manual Post Allowed. schema: type: boolean - name: code in: query required: false description: Lookup string which will try to match an existing Transaction Codes. schema: type: string - name: description in: query required: false description: Lookup string which will try to match an existing Transaction Code Description. schema: type: string - name: wildCard in: query required: false schema: type: string - name: fiscalBillNo in: query required: false description: The Fiscal Bill number of this posting schema: type: string - name: folioDate in: query required: false description: Date of Folio Generation. schema: type: string format: date - name: folioNo in: query required: false description: Folio Number. schema: type: number - name: folioStatus in: query required: false description: 'The Folio Status Example: DEPOSIT folio, VOID folio or the default OK folio status.' schema: type: string enum: - Deposit - Void - Ok - Zero - Compress - Converted - Internal uniqueItems: true - name: folioTypeName in: query required: false description: The name of the Folio Type used for the Folio Number sequence. schema: type: string - name: internalFolioWindowID in: query required: false description: Internal window ID which is unique to the reservation. This ID can only be used for reference. schema: type: string - name: invoiceNo in: query required: false description: Invoice No after the folio is generated. Same invoice number may be referred in multiple folios schema: type: number - name: trxServiceType in: query required: false description: Goods Type Transactions. schema: type: string enum: - Services - Goods uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 that contains either the Transaction Code list if fetch was successful or error(s) if not. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/transactionCodes' '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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/transactionDetails: get: summary: Get Folio Transaction Details description: You can use this API to get Folio Transaction Details.

OperationId:getFolioTransactionDetails

operationId: getFolioTransactionDetails parameters: - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: includeGenerates in: query required: false description: Flag to indicate if the automatically generated transactions, related to the main transaction number above, are also to be retrieved as part of this request. schema: type: boolean - name: transactionNo in: query description: Unique Transaction Number of the transaction(posting) for which details are required. required: false style: form explode: true schema: type: array items: type: number maxItems: 4000 - name: includeExchangeInformation in: query required: false description: Flag to indicate what currency exchange information text needs to be included in response. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 the fetch transaction details request. Detail information regarding the folio transaction will be returned content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/folioTransactionDetails' '204': description: FolioTransactionDetails 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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/transactions: get: summary: Get Guests Transactions description: You can use this API to get Guests Transactions.

OperationId:getGuestsTransactions

This API allows a time span of 30 days.

operationId: getGuestsTransactions parameters: - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: reservationList in: query description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. required: true style: form explode: true schema: type: array items: type: string - name: includeGenerates in: query required: false description: Configuring this flag to be TRUE will return transactions that are auto generated like taxes. schema: type: boolean - name: includeTransactionsWithARInvoiceNo in: query required: false description: Configuring this flag to be TRUE will return transactions that are included in an Accounts Receivable invoice. schema: type: boolean - name: includeTransactionsWithFolioNo in: query required: false description: Configuring this flag to be TRUE will return transactions that already belongs to a folio. schema: type: boolean - name: includeTransactionsWithManualPostingOnly in: query required: false description: Configuring this flag to be TRUE will return transactions whose transaction codes have manual posting enabled, or when an adjustment code is attached to the transaction code, the adjustment code's manual posting is enabled. schema: type: boolean - name: idContext in: query description: Used to identify the source of the identifier (e.g., IATA, ABTA). required: false style: form explode: true schema: type: array items: type: string - name: type in: query description: A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT). required: false style: form explode: true schema: type: array items: type: string - name: transactionNo in: query description: Transaction number of the payment being corrected. required: false style: form explode: true schema: type: array items: type: number maxItems: 4000 - name: transactionGroup in: query description: Category of the transaction code to filter the result. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: transactionSubGroup in: query description: Sub category of the transaction code to filter the result. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: billingCode in: query description: Unique identifier for the Billing Instruction. required: false style: form explode: true schema: type: array items: type: string - name: billingHotelId in: query description: Hotel context of the Billing Instruction. required: false style: form explode: true schema: type: array items: type: string - name: desc in: query description: Billing Instruction code description. required: false style: form explode: true schema: type: array items: type: string - name: routingInstructionsId in: query description: This is the Routing Instruction Id attached with Reservation. It is only used for internal purpose. It should not be used by external vendor or consumer. required: false style: form explode: true schema: type: array items: type: number - name: trxCodeWildCard in: query required: false description: Lookup string which will try to match an existing Transaction Code/s. schema: type: string - name: trxDescriptionWildCard in: query required: false description: Lookup string which will try to match an existing Transaction Code's Description. schema: type: string - name: checkNumberWildCard in: query required: false description: Lookup string which will try to match an existing Cheque number's code. schema: type: string - name: referenceNumberWildCard in: query required: false description: Filters the results for reference number. schema: type: string - name: supplementWildCard in: query required: false description: Filter the results for supplement. schema: type: string - name: windowNo in: query description: Filters the result to only include transactions in this window number. required: false style: form explode: true schema: type: array items: type: integer maxItems: 4000 - name: cashieringTransactionType in: query description: Wrapper Transaction Type. required: false style: form explode: true schema: type: array items: type: string enum: - Revenue - Payment - Wrapper 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: cashierId in: query required: false description: Cashier Id of the Cashier. schema: type: number - name: code in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: commissionable in: query required: false description: Filters the result based on its commission property. Do not set this criteria if all transactions should be included whether or not they are commissionable. schema: type: boolean - name: serviceRecoveryAllowed in: query required: false description: Filters the result which are allow for service recovery. schema: type: boolean - name: postedTransactionType in: query description: Returns only postings without bill number. required: false style: form explode: true schema: type: array items: type: string enum: - All - Routed - Direct - Transferred - Payments - NonBilled uniqueItems: true - name: billingSummary in: query required: false description: Filters the result on transaction billing summary. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 a summary of transactions of guests. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/guestsTransactions' '204': description: GuestsTransactions 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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/transactions/adjust: put: summary: Adjust Transactions description: You can use this API to Adjust Transactions.

OperationId:adjustTransactions

operationId: adjustTransactions 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_2' - $ref: '#/components/parameters/x-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 for the adjustment of transactions request. Contains any errors or warnings. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/adjustedTransactions' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/transactionsAdjustment' description: Request to adjust a transaction. In order to adjust a transaction, a valid amount or percentage is required. A valid reason code and reason text is also required. Only negative adjustments are done. The adjust process will post a new negative transaction for the same transaction code for the current day. required: true servers: - url: /csh/v1 /hotels/{hotelId}/transactions/arInvoices/reverse: delete: summary: Reverse AR Invoice description: You can use this API to reverse an AR Invoice.

OperationId:reverseARInvoice

operationId: reverseARInvoice parameters: - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: reasonCode in: query required: false description: The reason code for the deletion. schema: type: string - name: cashierId in: query required: false description: The Cashier ID of the Cashier who is currently processing the transaction(s). schema: type: number - name: transactionCodes in: query description: The unique transaction number of this transaction. required: false style: form explode: true schema: type: array items: type: number maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/transactions/split: put: summary: Split transactions description: You can use this API to Split transactions.

OperationId:splitTransaction

operationId: splitTransaction 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_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/transactionToSplit' description: Request to split a transaction on a reservation. Splitting of transactions requires a list of transactions and a valid amount or a percentage by which the amount can be split. Based on parameters, certain transactions cannot be split. Transaction which are included in an invoice cannot be split Transactions where the generates resides elsewhere(reservation or window) cannot be split. Automatically generated transactions such as taxes, cannot be split by itself. Deposits which were part of a deposit folio cannot be split. After the split is done the transaction resides on the same folio window as the original transaction. required: true servers: - url: /csh/v1 /hotels/{hotelId}/transactions/splitAndTransfer: put: summary: Split and transfer transactions description: You can use this API to split and transfer transactions.

OperationId:splitAndTransferTransaction

operationId: splitAndTransferTransaction 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_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/transactionToSplitAndTransfer' description: Request to split a transaction on a reservation and transfer the new transaction to a different reservation or a different window on the same reservation. Splitting of transactions requires a Inhouse target reservation, a list of transactions for a Inhouse reservation and a valid amount or a percentage by which the amount can be split. Based on parameters, certain transactions cannot be split. Transaction which are included in an invoice cannot be split Transactions where the generates resides elsewhere(reservation or window) cannot be split. Automatically generated transactions such as taxes, cannot be split by itself. Deposits which were part of a deposit folio cannot be split. After the split is done the transaction is transferred to the target reservation/window. required: true servers: - url: /csh/v1 /hotels/{hotelId}/transactions/{transactionId}: get: summary: Validate Transaction Codes description: You can use this API to validate Transaction Codes.

OperationId:validateTransactionCodes

operationId: validateTransactionCodes parameters: - name: transactionId in: path required: true description: Unique ID of the transaction schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: event in: query required: false description: Event being generated by a Supplemental Folio. schema: type: string enum: - CheckOut - EarlyDeparture - AdvanceBill - InterimBill - PasserBy - PostIt - CreditBill - Deposit - DepositRefund - AutoFolio - PrepaidCard - AutoSettlement - InformationFolio - SupplementalFolio uniqueItems: true - name: fiscalBillNo in: query required: false description: The Fiscal Bill number of this posting schema: type: string - name: folioDate in: query required: false description: Date of Folio Generation. schema: type: string format: date - name: folioNo in: query required: false description: Folio Number. schema: type: number - name: folioStatus in: query required: false description: 'The Folio Status Example: DEPOSIT folio, VOID folio or the default OK folio status.' schema: type: string enum: - Deposit - Void - Ok - Zero - Compress - Converted - Internal uniqueItems: true - name: folioTypeName in: query required: false description: The name of the Folio Type used for the Folio Number sequence. schema: type: string - name: internalFolioWindowID in: query required: false description: Internal window ID which is unique to the reservation. This ID can only be used for reference. schema: type: string - name: invoiceNo in: query required: false description: Invoice No after the folio is generated. Same invoice number may be referred in multiple folios schema: type: number - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 notifying if transaction code is valid. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/validatedTransactionCode' '204': description: validateTransactionCodes 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: - Cashiering post: summary: Submit Comp Transaction description: You can use this API to submit Comp Transactions.

OperationId:postCompTransaction

operationId: postCompTransaction parameters: - name: transactionId in: path required: true description: Unique ID of the transaction. schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/compTransactionCriteria' description: Request object to submit a comp transaction to gaming system required: true servers: - url: /csh/v1 /hotels/{hotelId}/transactions/{transactionId}/charges: put: summary: Change Billing Charge description: You can use this API to change Billing Charges.

OperationId:putBillingCharge

operationId: putBillingCharge parameters: - name: transactionId in: path required: true description: Unique ID of the transaction schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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/billingChargeStatus' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/billingCharge' description: Request to edit a billing charge information. required: true servers: - url: /csh/v1 /hotels/{hotelId}/transactions/{transactionId}/compRequestStatus: get: summary: 'Get Gaming Request Status ' description: You can use this API to get Gaming Request Status Information.

OperationId:getGamingRequestStatusInfo

operationId: getGamingRequestStatusInfo parameters: - name: transactionId in: path required: true description: Unique ID of the transaction. schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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 gaming info content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/gamingRequestStatusInfo' '204': description: GamingRequestStatusInfo 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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/transactions/{transactionId}/flexibleBenefitPostings: delete: summary: Delete flexible benefit postings description: You can use this API to delete flexible benefit postings.

OperationId:reverseFlexibleBenefitPosting

operationId: reverseFlexibleBenefitPosting parameters: - name: transactionId in: path required: true description: Unique ID of the transaction schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/transactions/{transactionId}/payments: put: summary: Change Billing Payment description: This API can be used to update a posted payment with additional reference, supplement, covers, and checknumber values.

OperationId:changeBillingPayment

operationId: changeBillingPayment parameters: - name: transactionId in: path required: true description: Unique ID of the transaction schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/billingPaymentToChange' description: Request to change a payment posting. required: true servers: - url: /csh/v1 /hotels/{hotelId}/transactions/{transactionId}/policies/detach/deposit: put: summary: Detach Deposit Policy from Payment description: You can use this API to detach Deposit Policy from Payment.

OperationId:detachDepositPolicyFromPayment

operationId: detachDepositPolicyFromPayment parameters: - name: transactionId in: path required: true description: Unique ID of the transaction schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/detachPolicyApplyCriteria' description: Request to detach a deposit payment from a Deposit Policy on a reservation. required: true servers: - url: /csh/v1 /hotels/{hotelId}/transactions/{transactionId}/reversePayments: post: summary: Create reverse payments description: You can use this API to create reverse payments.

OperationId:postReversePayment

operationId: postReversePayment parameters: - name: transactionId in: path required: true description: Unique ID of the Transaction schema: type: string maxLength: 2000 minLength: 1 - 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_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/paymentReversalCriteria' description: Request for posting payment reversal. required: true servers: - url: /csh/v1 /hotels/{hotelId}/transactionsTotal: get: summary: Get Balance Information description: You can use this API to get Balance Information.

This API is deprecated.

OperationId:getBalanceInfo

operationId: getBalanceInfo deprecated: true x-alternative: /balanceInfo parameters: - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: event in: query required: false description: Event being generated by a Supplemental Folio. schema: type: string enum: - CheckOut - EarlyDeparture - AdvanceBill - InterimBill - PasserBy - PostIt - CreditBill - Deposit - DepositRefund - AutoFolio - PrepaidCard - AutoSettlement - InformationFolio - SupplementalFolio uniqueItems: true - name: id 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: 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. Refer to OpenTravel Code List Unique ID Type (UIT). schema: type: string - name: folioWindowNo in: query required: false style: form explode: true schema: type: array items: type: integer - name: cashierId in: query description: The Cashier ID of the Cashier who is currently processing the transaction(s). required: false style: form explode: true schema: type: array items: type: number - name: transactionCode in: query description: Transaction Code to post. required: false style: form explode: true schema: type: array items: type: string - name: articleCode in: query description: Article ID. required: false style: form explode: true schema: type: array items: type: string - name: amount in: query description: A monetary amount. required: false style: form explode: true schema: type: array items: type: number - name: currencyCode in: query description: Provides a currency code to reflect the currency in which an amount may be expressed. required: false style: form explode: true schema: type: array items: type: string - name: postingQuantity in: query description: Quantity to post to the folio. required: false style: form explode: true schema: type: array items: type: integer - name: postingReference in: query description: User-defined posting reference. required: false style: form explode: true schema: type: array items: type: string - name: postingRemark in: query description: User-defined posting remark. required: false style: form explode: true schema: type: array items: type: string - name: checkNumber in: query description: Indicates the Cheque number. required: false style: form explode: true schema: type: array items: type: string - name: arrangementCode in: query description: Corrected arrangement code from the package associated to this transaction. required: false style: form explode: true schema: type: array items: type: string - name: applyRoutingInstructions in: query description: Apply room routing when making this posting. required: false style: form explode: true schema: type: array items: type: boolean - name: usePackageAllowance in: query description: Use the applicable package allowance when making this posting. required: false style: form explode: true schema: type: array items: type: boolean - name: autoPosting in: query description: True indicates the Transaction Code is allowed to be posted automatically. required: false style: form explode: true schema: type: array items: type: boolean - name: uniqueIdId in: query description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. required: false style: form explode: true schema: type: array items: type: string - name: uniqueIdIdContext in: query description: Used to identify the source of the identifier (e.g., IATA, ABTA). required: false style: form explode: true schema: type: array items: type: string - name: uniqueIdType in: query description: A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT). required: false style: form explode: true schema: type: array items: type: string - name: postItNumberId 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: postItNumberIdContext in: query required: false description: Used to identify the source of the identifier (e.g., IATA, ABTA). schema: type: string - name: postItNumberType in: query required: false description: A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT). schema: type: string - name: profileIdId 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: profileIdIdContext in: query required: false description: Used to identify the source of the identifier (e.g., IATA, ABTA). schema: type: string - name: profileIdType in: query required: false description: A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT). schema: type: string - name: reservationIdId 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: reservationIdIdContext in: query required: false description: Used to identify the source of the identifier (e.g., IATA, ABTA). schema: type: string - name: reservationIdType in: query required: false description: A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT). schema: type: string - name: policyIdId 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: policyIdIdContext in: query required: false description: Used to identify the source of the identifier (e.g., IATA, ABTA). schema: type: string - name: policyIdType in: query required: false description: A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT). schema: type: string - name: fiscalBillNo in: query required: false description: The Fiscal Bill number of this posting schema: type: string - name: folioDate in: query required: false description: Date of Folio Generation. schema: type: string format: date - name: folioNo in: query required: false description: Folio Number. schema: type: number - name: folioStatus in: query required: false description: 'The Folio Status Example: DEPOSIT folio, VOID folio or the default OK folio status.' schema: type: string enum: - Deposit - Void - Ok - Zero - Compress - Converted - Internal uniqueItems: true - name: folioTypeName in: query required: false description: The name of the Folio Type used for the Folio Number sequence. schema: type: string - name: internalFolioWindowID in: query required: false description: Internal window ID which is unique to the reservation. This ID can only be used for reference. schema: type: string - name: invoiceNo in: query required: false description: Invoice No after the folio is generated. Same invoice number may be referred in multiple folios schema: type: number - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 the fetch balance request. This will contain the current balance for the criteria requested. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/balanceInfoCriteria' '204': description: BalanceInfo 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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/transferCompTransactions: post: summary: Transfer comp transactions to window description: You can use this API to transfer comp transactions to window

OperationId:transferCompTransactions

operationId: transferCompTransactions 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_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/transferCompTransactions' description: Request object of comp transactions transfer. required: true servers: - url: /csh/v1 /hotels/{hotelId}/vouchers/batchJobs: post: summary: Generate Batch Vouchers description: This api can be used to generate Batch Vouchers.

OperationId:postGenerateBatchVouchers

operationId: postGenerateBatchVouchers 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_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/batchVouchersCriteria' description: Request type for batch vouchers. required: true servers: - url: /csh/v1 /hotels/{hotelId}/zeroBalanceCheckoutReservations/batchJobs: post: summary: 'Create Zero Balance Checkout Reservation Batch ' description: You can use this API to create Zero Balance Checkout Reservation Batch.

OperationId:postZeroBalanceCheckoutReservations

operationId: postZeroBalanceCheckoutReservations 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_2' - $ref: '#/components/parameters/x-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: Response type for batch zero balance checkout content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/batchZeroBalanceCheckoutDetails' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/batchZeroBalanceCheckoutReservation' description: Request type for batch zero balance checkout required: true servers: - url: /csh/v1 /reservations/{reservationId}/postRoomAndTaxForDayUse: post: summary: Operation to post room and tax for day use. description: You can use this API to post post Room And Tax For DayUse

OperationId:postRoomAndTaxForDayUse

operationId: postRoomAndTaxForDayUse parameters: - name: reservationId in: path required: true description: Unique ID of the reservation. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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: - Cashiering requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/postRoomAndTaxForDayUse' description: Request object to calculate room and tax. required: true servers: - url: /csh/v1 /roundingDifference: get: summary: Get Rounding Difference description: You can use this API to get Rounding Difference.

OperationId:getRoundingDifference

operationId: getRoundingDifference parameters: - name: event in: query required: false description: Event being generated by a Supplemental Folio. schema: type: string enum: - CheckOut - EarlyDeparture - AdvanceBill - InterimBill - PasserBy - PostIt - CreditBill - Deposit - DepositRefund - AutoFolio - PrepaidCard - AutoSettlement - InformationFolio - SupplementalFolio uniqueItems: true - name: folioWindowNo in: query required: false schema: type: integer - name: internalFolioWindowID in: query required: false description: Internal window ID which is unique to the reservation. This ID can only be used for reference. schema: type: string - name: cashierId in: query required: false description: The Cashier ID of the Cashier who is currently processing the transaction(s). schema: type: number - name: hotelId in: query required: false description: Hotel context of the reservation. schema: type: string - name: id 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: 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: description in: query required: false schema: type: string - name: folioView in: query required: false schema: type: integer - name: paymentMethod in: query required: false schema: type: string - name: attachCreditCardToProfile in: query required: false description: Attach the credit card to profile. schema: type: boolean - name: cardHolderName in: query required: false schema: type: string - name: cardNumber in: query required: false schema: type: string - name: cardNumberLast4Digits in: query required: false schema: type: string - name: cardNumberMasked in: query required: false schema: type: string - name: cardOrToken in: query required: false description: Simple type for indicating if credit card number is tokenized. schema: type: string enum: - CardNumber - Token uniqueItems: true - name: cardType in: query required: false description: This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method. schema: type: string enum: - Ab - Am - Ax - Cb - Dc - Ds - Dt - Ec - Er - Jc - Jl - Mc - Nb - So - St - Sw - Va - Xy - Zz - Cp - Cu uniqueItems: true - name: expirationDate in: query required: false description: Expiration date of the credit card schema: type: string format: date - name: expirationDateExpired in: query required: false schema: type: boolean - name: expirationDateMasked in: query required: false description: Masked Expiration date of the credit card schema: type: string - name: processing in: query required: false schema: type: string enum: - Eft - Manual uniqueItems: true - name: swiped in: query required: false schema: type: boolean - name: userDefinedCardType in: query required: false description: Indicates the user defined credit card type if credit card type from a defined list is not provided schema: type: string - name: cardIdId 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: currentAuthorizedAmountAmount in: query required: false description: A monetary amount. schema: type: number - name: currentAuthorizedAmountCurrencyCode in: query required: false description: Provides a currency code to reflect the currency in which an amount may be expressed. schema: type: string - name: approvalAmountNeededAmount in: query required: false description: A monetary amount. schema: type: number - name: approvalAmountNeededCurrencyCode in: query required: false description: Provides a currency code to reflect the currency in which an amount may be expressed. schema: type: string - name: balanceAmount in: query required: false description: A monetary amount. schema: type: number - name: balanceCurrencyCode in: query required: false description: Provides a currency code to reflect the currency in which an amount may be expressed. schema: type: string - name: code in: query required: false description: The authorization rule code. schema: type: integer - name: amountAmount in: query required: false description: A monetary amount. schema: type: number - name: amountCurrencyCode in: query required: false description: Provides a currency code to reflect the currency in which an amount may be expressed. schema: type: string - name: percent in: query required: false description: A percentage value if the authorization rule is percentage based. schema: type: number - name: emailFolio in: query required: false schema: type: boolean - name: uniqueIdId 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: createDateTime in: query required: false description: Time stamp of the creation. schema: type: string format: date-time - name: creatorId in: query required: false description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation. schema: type: string - name: emailAddress in: query required: false description: Defines the e-mail address. schema: type: string - name: emailFormat in: query required: false description: Supported Email format. schema: type: string enum: - Html - Text uniqueItems: true - name: lastModifierId in: query required: false description: Identifies the last software system or person to modify a record. schema: type: string - name: lastModifyDateTime in: query required: false description: Time stamp of last modification. schema: type: string format: date-time - name: orderSequence in: query required: false description: Display Order sequence. schema: type: number - name: primaryInd in: query required: false description: When true, indicates a primary information. schema: type: boolean - name: purgeDate in: query required: false description: Date an item will be purged from a database (e.g., from a live database to an archive). schema: type: string format: date - name: emailType in: query required: false description: Defines the purpose of the e-mail address (e.g. personal, business, listserve). schema: type: string - name: typeDescription in: query required: false description: Describes the Type code schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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 to the request to fetch the rounding difference for a payment amount. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/roundingDifferenceAmount' '204': description: RoundingDifference 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: - Cashiering servers: - url: /csh/v1 /services/cashiering/status: get: summary: Status check of cashiering services description: You can use this API to Status check of cashiering services.

OperationId:pingCashieringService

operationId: pingCashieringService parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_2' - $ref: '#/components/parameters/x-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: pingCashieringService 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: - Cashiering servers: - url: /csh/v1 /hotels/{hotelId}/financialPostingsNetVat/{statusId}: get: summary: Get results of Financial Postings with Net and Vat breakdown. description: This API returns response for the process initiated with startFinancialPostingsAsync. You can get the value of statusId with getFinancialPostingsProcessStatusAsync API response (under header location).

OperationId:getFinancialPostingsAsync

operationId: getFinancialPostingsAsync parameters: - name: hotelId in: path required: true description: Unique ID of the hotel schema: type: string maxLength: 2000 minLength: 1 - name: statusId in: path required: true schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key_3' - $ref: '#/components/parameters/x-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 the Posting Journal. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/financialPostingsNetVat_2' '204': description: FinancialPostings not found. tags: - Cashiering servers: - url: /csh/async/v1 components: schemas: compTransactionsCriteriaType: type: object description: Contains all transactions to be submitted to the vendor properties: compPostings: description: List of transactions to be submitted to the vendor. type: array maxItems: 4000 items: $ref: '#/components/schemas/compTransactionType' sendBulkCompTransactionsStatus: type: object properties: links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' fetchCompRedemptionsRSCompRedemptionsType: type: array description: Collection of Complimentary Redemption codes and their respective Available Amount. maxItems: 4000 items: $ref: '#/components/schemas/fetchCompRedemptionsRSCompRedemptionType' compTransactionType: type: object description: Contains the transaction to be submitted to the vendor properties: amount: description: Transaction amount. $ref: '#/components/schemas/currencyAmountType' postedAmount: description: Posted amount. $ref: '#/components/schemas/currencyAmountType' debit: description: Debit amount. $ref: '#/components/schemas/currencyAmountType' credit: description: Credit amount. $ref: '#/components/schemas/currencyAmountType' name: description: Family name, last name or Company Name. type: string minLength: 0 maxLength: 80 firstName: description: Given name, first name or names. type: string minLength: 0 maxLength: 80 membershipId: description: Membership number. type: string minLength: 0 maxLength: 100 membershipType: description: Membership number. type: string minLength: 0 maxLength: 100 approvalDate: description: Approval date of the posting. type: string format: date maxLength: 8 approvalStatus: description: Approval status of the posting. type: string minLength: 0 maxLength: 20 approvalCode: description: Approval code of the posting. type: string minLength: 0 maxLength: 20 authorizerId: description: Authorizer Id. $ref: '#/components/schemas/uniqueID_Type' guestNameId: description: Guest unique identifier. $ref: '#/components/schemas/uniqueID_Type' resvNameId: description: Reservation id. $ref: '#/components/schemas/uniqueID_Type' confirmationNo: description: Confirmation number associated with the transaction. type: string minLength: 0 maxLength: 50 roomId: description: Room number associated with the transaction. type: string minLength: 0 maxLength: 20 compId: description: Comp number associated with the transaction. type: string minLength: 0 maxLength: 50 folioNo: description: Window number where the transaction is posted. type: number subGroup: description: Subgroup for the transaction. type: string minLength: 0 maxLength: 100 transactionAmount: description: Transaction amount. $ref: '#/components/schemas/currencyAmountType' transactionId: description: Transaction Number for which request is being submitted. type: number transactionCode: description: Transaction code. type: string minLength: 0 maxLength: 200 transactionDescription: description: Transaction description. type: string minLength: 0 maxLength: 2000 transactionStatus: description: Transaction status. type: string minLength: 0 maxLength: 100 transactionDate: description: Transaction date of the posting. type: string format: date maxLength: 8 userName: description: User name. type: string minLength: 0 maxLength: 80 externalUserId: description: External user id. $ref: '#/components/schemas/uniqueID_Type' cashierId: description: Numeric ID of the cashier. $ref: '#/components/schemas/cashierId' reverseCompRedemptionsRQCompRedemptionType: type: object description: Information about a Complimentary Redemption for reversal. properties: amount: description: The amount to reverse. $ref: '#/components/schemas/currencyAmountType' code: description: The associated redemption code. type: string minLength: 0 maxLength: 20 description: description: Description of the Complimentary Redemption code. type: string minLength: 0 maxLength: 2000 approvalCode: description: Approval Code of the Complimentary Redemption. type: string minLength: 0 maxLength: 20 compTransactionInfoType: type: object description: Transaction information being processed by the vendor. properties: transactionId: description: Transaction Number for which request is being submitted. type: number transactionCode: description: Transaction code. type: string minLength: 0 maxLength: 200 transactionDescription: description: Transaction description. type: string minLength: 0 maxLength: 2000 roomId: description: Room number associated with the transaction. type: string minLength: 0 maxLength: 20 confirmationNo: description: Confirmation number associated with the transaction. type: string minLength: 0 maxLength: 50 approvalDate: description: Approval date of the posting. type: string format: date maxLength: 8 approvalStatus: description: Approval status of the posting. type: string minLength: 0 maxLength: 20 approvalCode: description: Approval code of the posting. type: string minLength: 0 maxLength: 20 approvalMessage: description: Approval message of the posting coming from the vendor. type: string minLength: 0 maxLength: 200 amount: description: Transaction amount. $ref: '#/components/schemas/currencyAmountType' name: description: Family name, last name or Company Name. type: string minLength: 0 maxLength: 80 firstName: description: Given name, first name or names. type: string minLength: 0 maxLength: 80 postCompRedemptionsRS: type: object description: Response type of Complimentary Redemptions for posting. properties: compRedemptions: description: Complimentary Redemption codes and their respective Approval Code. type: object $ref: '#/components/schemas/postCompRedemptionsRSCompRedemptionsType' warnings: $ref: '#/components/schemas/warningsType' authorizeCompRedemptionsRSCompRedemptionsType: type: array description: Collection of Complimentary Redemption codes and their respective Approval Code. maxItems: 4000 items: $ref: '#/components/schemas/authorizeCompRedemptionsRSCompRedemptionType' cashierId: type: number description: The Cashier ID of the Cashier who is currently processing the transaction(s). fetchCompRedemptionsRSCompRedemptionType: type: object description: Information about a Complimentary Redemption code and its Available Amount. properties: code: description: The associated redemption code. type: string minLength: 0 maxLength: 20 description: description: Description of the Complimentary Redemption code. type: string minLength: 0 maxLength: 2000 availableAmount: description: Available Amount of the Complimentary Redemption code. $ref: '#/components/schemas/currencyAmountType' 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 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 bulkCompTransactionsCriteriaType: type: object description: Contains all transactions to be submitted to the vendor properties: compPostings: description: List of transactions to be submitted to the vendor. type: array maxItems: 4000 items: $ref: '#/components/schemas/bulkCompTransactionType' 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 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 compTransactionsInfoType: type: array description: List of comp transactions. maxItems: 4000 items: $ref: '#/components/schemas/compTransactionInfoType' sendCompTransactionsStatus: type: object properties: compPostings: description: List of transactions processed by the vendor. $ref: '#/components/schemas/compTransactionsInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' postCompRedemptionsRQ: type: object description: Request type of Complimentary Redemptions posting. properties: compRedemptions: description: Complimentary Redemptions to post as payment. $ref: '#/components/schemas/postCompRedemptionsRQCompRedemptionsType' status: type: object description: Response Body. properties: warnings: $ref: '#/components/schemas/warningsType' links: $ref: '#/components/schemas/links' authorizeCompRedemptionsRQCompRedemptionType: type: object description: Information about a Complimentary Redemption for approval. properties: amount: description: The amount to redeem when posting a payment. $ref: '#/components/schemas/currencyAmountType' code: description: The associated redemption code. type: string minLength: 0 maxLength: 20 description: description: Description of the Complimentary Redemption code. type: string minLength: 0 maxLength: 2000 availableAmount: description: Available Amount of the Complimentary Redemption code. $ref: '#/components/schemas/currencyAmountType' postCompRedemptionsRQCompRedemptionType: type: object description: Information about a Complimentary Redemption for posting. properties: amount: description: The amount to redeem when posting a payment. $ref: '#/components/schemas/currencyAmountType' code: description: The associated redemption code. type: string minLength: 0 maxLength: 20 description: description: Description of the Complimentary Redemption code. type: string minLength: 0 maxLength: 2000 availableAmount: description: Available Amount of the Complimentary Redemption code. $ref: '#/components/schemas/currencyAmountType' approvalCode: description: Approval Code of the Complimentary Redemption. type: string minLength: 0 maxLength: 20 authorizeCompRedemptionsRQ: type: object description: Request type of Complimentary Redemptions for approval. properties: compRedemptions: description: Complimentary Redemptions for approval. type: object $ref: '#/components/schemas/authorizeCompRedemptionsRQCompRedemptionsType' reverseCompRedemptionsRQ: type: object description: Request type of Complimentary Redemptions reversal. properties: compRedemptions: description: Complimentary Redemptions for reversal. $ref: '#/components/schemas/reverseCompRedemptionsRQCompRedemptionsType' reverseCompRedemptionsRQCompRedemptionsType: type: array description: Collection of Complimentary Redemptions for reversal. maxItems: 4000 items: $ref: '#/components/schemas/reverseCompRedemptionsRQCompRedemptionType' fetchCompRedemptionsRS: type: object description: Response type for retrieval of Complimentary Redemption codes and their respective Available Amount. properties: compRedemptions: description: Complimentary Redemption codes and their respective Available Amount. $ref: '#/components/schemas/fetchCompRedemptionsRSCompRedemptionsType' authorizeCompRedemptionsRS: type: object description: Response type of Complimentary Redemptions for approval. properties: compRedemptions: description: Complimentary Redemption codes and their respective Approval Code. type: object $ref: '#/components/schemas/authorizeCompRedemptionsRSCompRedemptionsType' warnings: $ref: '#/components/schemas/warningsType' warningsType: type: array description: Used in conjunction with the Success element to define a business error. maxItems: 4000 items: $ref: '#/components/schemas/warningType' authorizeCompRedemptionsRQCompRedemptionsType: type: array description: Collection of Complimentary Redemptions for approval. maxItems: 4000 items: $ref: '#/components/schemas/authorizeCompRedemptionsRQCompRedemptionType' bulkCompTransactionType: type: object description: Contains the transaction to be submitted to the vendor properties: amount: description: Transaction amount. $ref: '#/components/schemas/currencyAmountType' name: description: Family name, last name or Company Name. type: string minLength: 0 maxLength: 80 firstName: description: Given name, first name or names. type: string minLength: 0 maxLength: 80 membershipId: description: Membership number. type: string minLength: 0 maxLength: 100 membershipType: description: Membership number. type: string minLength: 0 maxLength: 100 authorizerId: description: Authorizer Id. $ref: '#/components/schemas/uniqueID_Type' guestNameId: description: Guest unique identifier. $ref: '#/components/schemas/uniqueID_Type' resvNameId: description: Reservation id. $ref: '#/components/schemas/uniqueID_Type' confirmationNo: description: Confirmation number associated with the transaction. type: string minLength: 0 maxLength: 50 roomId: description: Room number associated with the transaction. type: string minLength: 0 maxLength: 20 compId: description: Comp number associated with the transaction. type: string minLength: 0 maxLength: 50 folioNo: description: Window number where the transaction is posted. type: number subGroup: description: Subgroup for the transaction. type: string minLength: 0 maxLength: 100 transactionId: description: Transaction Number for which request is being submitted. type: number transactionCode: description: Transaction code. type: string minLength: 0 maxLength: 200 transactionDescription: description: Transaction description. type: string minLength: 0 maxLength: 2000 transactionDate: description: Transaction date of the posting. type: string format: date maxLength: 8 userName: description: User name. type: string minLength: 0 maxLength: 80 externalUserId: description: External user id. $ref: '#/components/schemas/uniqueID_Type' cashierId: description: Numeric ID of the cashier. type: number generateCompTransactions: type: array description: List of comp transactions. maxItems: 4000 items: $ref: '#/components/schemas/generateCompTransactionType' postCompRedemptionsRSCompRedemptionsType: type: array description: Collection of Complimentary Redemption codes and their respective Approval Code. maxItems: 4000 items: $ref: '#/components/schemas/postCompRedemptionsRSCompRedemptionType' postCompRedemptionsRSCompRedemptionType: type: object description: Information about a Complimentary Redemption including its approval code. properties: code: description: The associated Complimentary Redemption code. type: string minLength: 0 maxLength: 20 approvalCode: description: Approval Code of the Complimentary Redemption. type: string minLength: 0 maxLength: 20 links: type: array items: $ref: '#/components/schemas/instanceLink' generateCompTransactionType: type: object description: Contains the transaction generate to be submitted to the vendor properties: amount: description: Transaction amount. $ref: '#/components/schemas/currencyAmountType' transactionId: description: Transaction Number for which request is being submitted. type: number transactionCode: description: Transaction code. type: string minLength: 0 maxLength: 200 transactionDescription: description: Transaction description. type: string minLength: 0 maxLength: 2000 transactionDate: description: Transaction date of the posting. type: string format: date maxLength: 8 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 authorizeCompRedemptionsRSCompRedemptionType: type: object description: Information about a Complimentary Redemption including its approval code. properties: code: description: The associated Complimentary Redemption code. type: string minLength: 0 maxLength: 20 approvalCode: description: Approval Code of the Complimentary Redemption. type: string minLength: 0 maxLength: 20 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 postCompRedemptionsRQCompRedemptionsType: type: array description: Collection of Complimentary Redemptions for posting. maxItems: 4000 items: $ref: '#/components/schemas/postCompRedemptionsRQCompRedemptionType' 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 cashSurchargeAmountType: type: object description: Information regarding the Surcharge amount which will be applied to a payment. properties: hotelId: description: Property where the payment is being posted. type: string minLength: 0 maxLength: 20 cashSurchargeAmount: description: The total Surcharge amount which is to be applied to this payment. $ref: '#/components/schemas/currencyAmountType_2' cashSurchargeInfo: description: Details on the Surcharge configuration. The percentage and a threshold amount in case it is defined. $ref: '#/components/schemas/cashSurchargeInfoType' paymentMethod: description: Payment method used for the payment. $ref: '#/components/schemas/cashieringPaymentMethodType' batchZeroBalanceCheckoutDetails: type: object description: Response for batch zero balance check out. properties: processId: description: Batch process identifier. $ref: '#/components/schemas/stringLength40' resvCount: description: Zero balance Reservations count identifier. type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' cardReIssueType: type: string description: Request to re issue a new card. enum: - Pending - NotApplicable - Requested fiscalInvoiceSummaryType: type: object description: Contains information required for the generation of fiscal invoice. properties: fiscalTerminalId: type: string minLength: 0 maxLength: 50 transactionType: type: string minLength: 0 maxLength: 1 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 folioSeqNo: description: Unique sequence number. Used to identify the current folio tax record. type: number queueName: description: Folio Queue name type: string minLength: 0 maxLength: 2000 generateFiscalFolio: description: Fiscal folio flag to call fiscal Information folio web service. type: boolean maturedDepositsType: type: array description: Detailed information of matured deposits. maxItems: 4000 items: $ref: '#/components/schemas/maturedDepositType' 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' bookingTimeSpan: description: The booking time span of the reservation, only applicable when time increments are being used. $ref: '#/components/schemas/bookingTimeSpanType' expectedTimes: description: The expected arrival, return and departure times of the guest. $ref: '#/components/schemas/resExpectedTimesType' hasExtendedStayRates: description: Indicates if resertvation has a rate that is configured with a non-nightly posting interval. type: boolean 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 roomOwnershipType: description: Provides the information of the assigned reservation room is an Owner,Referral or regular room. This value is returned when Room Rotation OPERA Control is active and room number is assigned to a reservation. $ref: '#/components/schemas/reservationRoomOwnershipType' ratePlanCode: description: Rate plan code type: string minLength: 0 maxLength: 20 rateAmount: description: Rate amount $ref: '#/components/schemas/currencyAmountType_2' 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_2' 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_2' compBalance: description: Comp Balance amount $ref: '#/components/schemas/currencyAmountType_2' 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_2' 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 backToBackSequence: description: This attribute represents Back To Back Sequence of Linked Reservations(e.g. '1,2' i.e, 1 indicates Sequence Position of total count 2). This is applicable when OPERA control Back to Back Handling for Linked Reservations is active. $ref: '#/components/schemas/backToBackResSequenceType' backToBack: description: This attribute indicates if the linked reservation is marked as Back to Back or not. type: boolean backToBackGroupId: description: This attribute represents a common identifier for a subgroup of linked reservations marked as Back to Back in a group of linked reservations. type: string minLength: 0 maxLength: 80 ccManualAuthorizationCriteria: type: object description: Request for registering a Manual Authorization. properties: criteria: description: Criteria for registering the manual authorization. $ref: '#/components/schemas/cCManualAuthorizationCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' postedRateCode: type: object description: Response for the operation that posts a Rate Code amount on the reservation. properties: postings: description: The postings which were made as part of the operation. $ref: '#/components/schemas/summaryPostingsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' routingInstructionStatusType: type: string description: Routing instruction set is deleted. enum: - RoutingInstructionNew - RoutingInstructionEdited - RoutingInstructionRemoved creditLimitOveragePaymentsDetails: type: object description: Response for Submit Credit Limit Overage Payments request properties: processId: description: Batch process identifier. $ref: '#/components/schemas/stringLength40' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' policyBasisTypeType: type: string description: Full Amount. enum: - FlatAmount - Percentage - Nights - NightPercentage - FullAmount batchVouchersCriteria: type: object description: Request type for batch vouchers. properties: criteria: description: Criteria for batch vouchers. $ref: '#/components/schemas/batchVouchersType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' successType: type: object description: Returning an empty element of this type indicates the successful processing of an message. This is used in conjunction with the Warning Type to report any warnings or business errors. properties: {} 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 depositToGuestFolio: type: object description: Request to post an existing deposit on a reservation to the Guest Folio for No Show or Canceled Reservations. Deposits remain in the deposit ledger until Checkin/Checkout. In the case of No Show or Canceled reservations they remain in the deposit ledger until this request is done. properties: criteria: description: Criteria to move the deposit from the Deposit Ledger to the Guest Folio(Ledger). $ref: '#/components/schemas/postDepositToGuestFolioType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' ccAuthorizationInstructions: type: object description: Response to the fetch authorization instructions. Based on the criteria requested, the response can contain information required to send a credit card authorization to the Vendor. properties: details: $ref: '#/components/schemas/cCAuthorizationInstructionType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' 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 folioTypeValidationType: type: string description: Profile detail is not configured with Tax ID. enum: - TaxID 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 cCAuthorizationCriteriaType: type: object description: Contains the credit card criteria for authorization. properties: hotelId: description: Identifies the hotel code to authorize a credit card amount for. type: string minLength: 0 maxLength: 20 reservationId: description: Identifies the reservation to authorize a credit card amount for. $ref: '#/components/schemas/uniqueID_Type' profileId: $ref: '#/components/schemas/profileId' amount: description: The amount to authorize. $ref: '#/components/schemas/currencyAmountType_2' folioView: description: The folio window where this authorization is applied. type: integer payment: description: Details of the payment card to which the authorization is to be applied. If this card does not exist on the reservation, it will not be added to the reservation. $ref: '#/components/schemas/cashieringPaymentMethodType' terminalId: description: Applicable for chip and pin. The ID of the terminal where the chip and pin device is connected. type: string incidentalAmount: description: The incidental part of the amount to authorize. $ref: '#/components/schemas/currencyAmountType_2' evaluateApprovalAmount: description: Flag to indicate if the approval amount should be calculated before authorization. If this is true and if the amount is 0 the approval amount will be calculated based on the rules. type: boolean sourceOfAuthorization: description: Source of the authorization. $ref: '#/components/schemas/cardAuthorizationTransactionType' updateReservation: description: Update the card details on the reservations for Chip and Pin Authorizations. type: boolean ccRequestId: description: Session Id registered in the WebSocket component for asynchronous Credit Card handling. type: string minLength: 0 maxLength: 100 storeToCreditCardWallet: description: Attach the credit card to the wallet. type: boolean additionalTaxesDetails: type: object description: Response object containing additional tax information. properties: taxAmountInfo: description: Tax amount to be adjusted. $ref: '#/components/schemas/taxAmountInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' fiscalFolioCriteriaType: type: object description: Criteria for calling fiscal folio service for the generation of invoices properties: hotelId: description: Property where the folio is being generated. type: string minLength: 0 maxLength: 20 folioCommand: description: Type of fiscal folio operation. $ref: '#/components/schemas/folioCommandType' effectiveDate: description: Effective date to run fiscal command. type: string format: date maxLength: 8 folios: description: Folio details. $ref: '#/components/schemas/fiscalInvoiceSummaryType' compositeDepositCriteriaType: type: object description: Criteria for posting a deposit to a reservation. properties: hotelId: description: Property code. type: string minLength: 0 maxLength: 20 reservationId: description: Reservation for which the Deposit is required. $ref: '#/components/schemas/reservationId' paymentMethod: description: Payment method used by the Payee. $ref: '#/components/schemas/cashieringPaymentMethodType' postingAmount: description: Amount to post to the folio. $ref: '#/components/schemas/currencyAmountType_2' profileId: description: Profile Id of the Payee for this Deposit. $ref: '#/components/schemas/profileId' folioWindowNo: type: integer postingReference: description: User-defined posting reference. type: string minLength: 0 maxLength: 2000 postingRemark: description: User-defined posting remark. type: string minLength: 0 maxLength: 2000 comments: description: User Defined Comments. Used for Deposit Payment postings. type: string minLength: 0 maxLength: 2000 guaranteeCode: description: New guarantee code associated with reservation. type: string minLength: 0 maxLength: 20 overrideInventoryCheck: description: Flag to indicate if the Inventory check has to be overridden when the guarantee code of the reservation is changed. type: boolean updateReservationPaymentMethod: description: Flag to indicate if the payment method on the reservation, for Window 1, is to be updated with the payment method used for this deposit. type: boolean depositPolicyId: description: The deposit policy ID. $ref: '#/components/schemas/uniqueID_Type' simpleFolio: description: This flag signifies that generated Folio is Normal or Simple Folio. Certain countries of the World mandate a simple folio when the invoice amount is less than defined threshold. type: boolean cashierId: description: Numeric ID of the cashier. type: integer fiscalFolioInfo: description: Generate Fiscal Folio Criteria type to be used for fiscal folio generation. $ref: '#/components/schemas/fiscalServiceType' billingInstructionCodes: type: object properties: transactionCodes: description: Set of Transaction Code results. $ref: '#/components/schemas/trxCodesInfoType' billingInstructions: description: Set of Billing Instruction results. $ref: '#/components/schemas/billingInstructionsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' postingGroupType: type: object description: Transaction group information. Ever posting could represent a. Regular transaction b. Group header - has Group Id, Count, Descripton and Includes Group Memebers elements c. Group transaction - has SubGroupId element pointing to Group Header Id properties: groupId: description: Group Id. type: string minLength: 0 maxLength: 20 groupCount: description: Number of transactions in group. type: integer groupDescription: description: Group Description. type: string minLength: 0 maxLength: 2000 subGroupId: description: Indicates to which group transaction belongs. type: string minLength: 0 maxLength: 20 fiscalSupportingDocumentTypeEnum: type: string enum: - InformationFolio - ProformaFolio - ConfirmationLetter taxAmountInfoType: type: object description: Tax amount to be adjusted for the guest properties: amount: description: Amount to be adjusted for the guest. $ref: '#/components/schemas/currencyAmountType_2' receiptType: type: string description: This contains the receipt type. enum: - Payment - Deposit - Paidout - Transaction - CheckExchange - CurrencyExchangeCheck - CurrencyExchangeCash - DepositRequest - DepositRefundReceipt - Acknowledgement - ARPayment alertType: type: object properties: code: description: Code identifying the type of alert. type: string minLength: 0 maxLength: 20 global: description: Indicate whether the alert is a global that is automatically and dynamically attached to all reservations that meet the alert criteria. type: boolean area: description: The Area where the alert will be attached and shown. $ref: '#/components/schemas/alertAreaType' description: description: The alert message. type: string screenNotification: description: Notify by showing the alert on the screen type: boolean printerNotification: description: Notify by sending the message to the printer. type: boolean printerName: description: Printer used to print the alert notification. type: string reportId: description: The module id of the report. This is used to printer the alert. $ref: '#/components/schemas/uniqueID_Type' reportName: description: Report name of the report type. type: string reportDescription: description: Report description. Mainly used for as a parameter for printing the alerts. type: string minLength: 0 maxLength: 1000 guestInfo: description: Contains information regarding the guest. $ref: '#/components/schemas/alertGuestInfoType' userDefinedFields: description: Collections of user defined fields. $ref: '#/components/schemas/userDefinedFieldsType' welcomeOffer: description: Contains information regarding welcome offer. $ref: '#/components/schemas/welcomeOfferType' stopCheckInCheckOut: description: Indicates the Reservation Stop Check In/Check Out Global Alert. type: boolean 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. Refer to OpenTravel Code List Unique ID Type (UIT). 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 characterUDFsType: type: array description: Used to hold collection of user defined fields of Character/String Type. maxItems: 4000 items: $ref: '#/components/schemas/characterUDFType' 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 reservationTransaction: type: object description: Request to transfer a transaction(s) to a reservation. In the criteria, the target Reservation Id is required for the transfer. properties: criteria: description: Transaction transfer criteria. Target Reservation Id is required. $ref: '#/components/schemas/reservationTrxTransferCriteria' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' 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' 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 reservationTrxTransferCriteria: type: object description: Criteria for transaction transfer. The choice element should have the target Reservation Id. properties: hotelId: description: Property code. type: string minLength: 0 maxLength: 20 reservationIdList: description: Reservation id from where transactions will be transfered. $ref: '#/components/schemas/reservationIdList' membershipIdNo: description: Unique ID of Membership. type: integer targetFolioWindowNo: description: Folio Window Number to where transactions will be transfered. type: integer targetReservationIdList: description: Reservation Id where the transactions will be transferred. $ref: '#/components/schemas/uniqueIDListType' transactionList: description: List of transactions to be transfered. type: array maxItems: 4000 items: type: number transactionCodeList: description: List of Transaction code to be transferred. type: array maxItems: 4000 items: type: string sourceFolioWindowNo: description: Folio Window Number to where transactions were originated. type: integer authorizerId: $ref: '#/components/schemas/uniqueID_Type' cashierId: $ref: '#/components/schemas/cashierId' cardNumberTypeType: type: string description: Simple type for indicating if credit card number is tokenized. enum: - CardNumber - Token storedFolioDetails: type: object description: Request object to update stored folio details. properties: storedFolioDetails: description: Stored folio details type. $ref: '#/components/schemas/storedFolioDetailsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' folioCommandType: type: string enum: - Invoice - Info - ResendInvoice - Cancellation - EodReset - XReport - SendFiscalInvoice - ZeroInvoice - EndOfPeriod - ZeroInvoiceWithReceipt - FiscalUpdate - CheckOut hotelRevenueType: type: object description: Hotel revenue type. properties: roomRevenue: description: Total room revenue for this hotel. type: number houseRevenue: description: Total house revenue for this hotel. type: number compRevenue: description: Total comp revenue for this hotel. type: number occupiedRooms: description: Total occupied revenue for this hotel. type: number houseRooms: description: Total house rooms for this hotel. type: number compRooms: description: Total comp rooms for this hotel. type: number zeroRoomsRevenue: description: Total zero rooms revenue for this hotel. type: number currencyCode: description: The base currency code for this hotel. type: string minLength: 0 maxLength: 20 authorizersCreditInfo: type: object description: Returns credit information of Comp Accounting Authorizers. properties: authorizersCreditType: description: Comp Accounting Authorizers credit information. $ref: '#/components/schemas/authorizersCreditType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' currencyAmountType_2: 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: 20 creditCardWallet: type: object description: Response to the credit card wallet request. The wallet contains all the credit cards used in OPERA for a profile/reservation. properties: creditCardInfoList: type: array description: Contains a list of credit cards. maxItems: 4000 items: $ref: '#/components/schemas/creditCardInfo' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' folioTaxPaymentsInfo: type: object description: Response to the request for Payment Tax records for a reservation. Lists all the Payment Taxes for the reservation which are available. properties: paymentTaxInfo: $ref: '#/components/schemas/paymentTaxInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' cashierTransactionsDetails: type: object description: Response for the fetch cashier's shift transactions. properties: cashierTransactionsInfo: description: Cashier shift transactions group by transaction code and currency. $ref: '#/components/schemas/cashierTransactionsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' stagedTransactions: type: object description: Response to the request to get staged transaction information for a Reservation properties: stagedCompTransactionsInfo: description: Transaction details of staged comp transactions for the requested reservation. $ref: '#/components/schemas/stagedCompTransactionsInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' 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 prepaidCardCriteriaType: type: object description: Holds fixed charge information. properties: hotelId: description: Hotel context for the Reservations. type: string minLength: 0 maxLength: 20 reservationId: description: The unique ID of the reservation to which this record applies. $ref: '#/components/schemas/reservationId' name: description: Family name, last name or Company Name. type: string minLength: 0 maxLength: 80 firstName: description: Given name, first name or names. type: string minLength: 0 maxLength: 80 profileId: description: Card / Account holder name ID $ref: '#/components/schemas/profileId' cardNo: description: Prepaid card / account number. type: string minLength: 0 maxLength: 80 cardNumberMasked: description: Masked Prepaid card / account number. type: string minLength: 0 maxLength: 80 amount: description: Prepaid Card Amount. $ref: '#/components/schemas/currencyAmountType_2' pinCode: description: Prepaid card pin code. type: string minLength: 0 maxLength: 10 interfaceId: description: The unique ID for the Interface. $ref: '#/components/schemas/uniqueID_Type' cardDetails: description: Prepaid Card details from vendor. $ref: '#/components/schemas/prepaidCardDetailsType' 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 giftCard: description: Indicates a gift card type. type: boolean postChargeToRoom: type: boolean saleCriteria: $ref: '#/components/schemas/saleCriteriaType' vendorInterfaceID: type: number cashierId: $ref: '#/components/schemas/cashierId' batchZeroBalanceCheckoutReservation: type: object description: Request type for batch zero balance checkout. properties: criteria: description: Criteria for batch zero balance checkout. $ref: '#/components/schemas/checkoutZeroBalanceReservationType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' excludedDateType: type: object description: Specifies all the enabled dates. properties: date: description: Contains exclusion date. type: string format: date maxLength: 8 reason: description: Contains reason for exclusion. $ref: '#/components/schemas/exclusionReasonType' earlyDepartureInfoType: type: object description: Information regarding Early Departure for a reservation. Contains information regarding penalty, if any. properties: penaltyAmount: description: Amount that can be charged as Early Departure Penalty $ref: '#/components/schemas/currencyAmountType_2' penaltyDescription: description: Description of the Early Departure Penalty calculation rule. type: string minLength: 0 maxLength: 2000 cashierClosureType: type: object description: Cashier Shift Totals and Per Hotel amounts group by currency code properties: cashierInfo: description: Cashier ID and Closure No $ref: '#/components/schemas/cashierClosureNoType' summaryCurrencyAmountList: description: Currency Total Amounts for Cashier Shift. type: array maxItems: 4000 items: $ref: '#/components/schemas/cashierClosureCurrencyAmountType' hotelCurrencyAmountList: description: Currency Hotels Amounts for Cashier Shift. type: array maxItems: 4000 items: $ref: '#/components/schemas/hotelCashierClosureCurrencyAmountType' foreignCurrencyExchange: type: object description: A set of posting transactions that need to be posted with regards to exchange. properties: foreignCurrencyExchangeList: type: array items: $ref: '#/components/schemas/postForeignCurrencyExchangeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' paymentMethodSearchType: type: object description: Reservation Payment method search criteria for searching a reservation. properties: paymentMethod: description: Payment Method to search the reservation. type: string minLength: 0 maxLength: 20 creditLimitOveragePaymentsInfo: type: object description: Response for Fetch Credit Limit Overage Payments request properties: reservationOveragePayments: description: List of reservations matching the search criteria. $ref: '#/components/schemas/reservationOveragePaymentsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' depositFolioTransactionDetails: type: object description: Response for the fetch transaction details request. Detail information regarding the folio transaction will be returned properties: transactions: description: The details regarding the transaction(Posting). $ref: '#/components/schemas/depositDetailPostingsType' trxCodesInfo: description: Transaction codes information which are in response postings. $ref: '#/components/schemas/trxCodesInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' attachPolicyApplyCriteria: type: object description: Request to attach an existing Deposit Policy on a reservation towards an existing deposit payment on the same reservation. properties: criteria: description: Criteria for applying a policy to an existing deposit payment. $ref: '#/components/schemas/policyApplyCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' convertFolioDetails: type: object description: Response to the request to Convert Folio. Includes the new converted folio information. properties: folio: description: Converted Folio Information. $ref: '#/components/schemas/folioType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' folioSplitInfoType: type: object description: Containsts the folio split posting information. properties: folioSplitType: description: Contains the folio split type. $ref: '#/components/schemas/folioSplitType' revenue: description: Revenue amount of the transactions. $ref: '#/components/schemas/currencyAmountType_2' payment: description: Payment amount of the transactions. $ref: '#/components/schemas/currencyAmountType_2' balance: description: Running balance of the transactions. $ref: '#/components/schemas/currencyAmountType_2' totalPostings: description: Running total number of the transactions. type: integer transactionReversal: type: object description: Request to reverse a Payment Tax record for Thailand Tax requirement. properties: reverseCriteria: description: Criteria for reversing the Payment Tax Record. $ref: '#/components/schemas/deleteTransactionCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' applyFlexibleBenefitPostingsCriteriaType: type: object description: Criteria for retrieving one or more guest's folio transactions. properties: hotelId: description: Hotel context for the Reservations. type: string minLength: 0 maxLength: 20 reservationId: description: Reservation identifier for which Flexible Benefits will be posted. $ref: '#/components/schemas/reservationId' cashierId: $ref: '#/components/schemas/cashierId' 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 depositPostingType: type: object description: Posting details. properties: referenceTransactionNo: description: Generate transaction number for the Posting. type: number remark: description: Posting remarks. type: string minLength: 0 maxLength: 2000 reference: description: User-defined posting reference. type: string minLength: 0 maxLength: 2000 checkNo: description: Check number for the posting. type: string minLength: 0 maxLength: 2000 checkCount: description: Check number count for the posting. type: string minLength: 0 maxLength: 2000 postedAmount: description: Actual currency amount posted. $ref: '#/components/schemas/currencyAmountType_2' price: description: Indicates the unit price of the consumption. $ref: '#/components/schemas/currencyAmountType_2' quantity: description: Indicates Quantity. type: number transactionType: description: This is the transaction type which says whether it is a Consumption(C), Payment (FC) or Package (PK) and it is inherited from transaction code. $ref: '#/components/schemas/cashieringTransactionTypeType' creditAmount: description: The amount posted as credit to the ledger. $ref: '#/components/schemas/currencyAmountType_2' debitAmount: description: The amount posted as debit to the ledger. $ref: '#/components/schemas/currencyAmountType_2' articleCode: description: Information regarding the Article(Using Articles Functionality) of this transaction. type: string minLength: 0 maxLength: 20 cashierInfo: $ref: '#/components/schemas/cashierInfoType' paidOut: description: Indicates if this transaction is a paid out transaction. type: boolean arrangementCode: description: Corrected arrangement code from the package associated to this transaction. type: string minLength: 0 maxLength: 20 groupTypeInfo: description: Information related to transaction grouping. $ref: '#/components/schemas/postingGroupType' rateCode: description: Rate code associated to this transaction. type: string minLength: 0 maxLength: 20 compRedemptionCode: description: Comp redemption code assiciated to the transaction. type: string minLength: 0 maxLength: 20 updateInfo: description: Update info associated to this transaction. type: object properties: updateDate: type: string format: date maxLength: 8 updateBy: type: string fbaCertificate: description: Flag indicates that the posting is Flexible Benefits Awards Certificate type: boolean taxInvoiceNo: description: Tax invoice number generated by payment tax. type: string minLength: 0 maxLength: 20 serviceRecovery: description: Flag to indicates service recovery type: boolean compPostingsInfo: description: Comp Postings information for the folio. $ref: '#/components/schemas/compPostingsType' financialTransactionIdList: description: Collection of unique identifiers of the financial transactions. $ref: '#/components/schemas/uniqueIDListType' exchange: description: Available when the Fetch Folio Search Type requests the amounts to be converted to a currency different from the Resort currency. $ref: '#/components/schemas/exchangeAmounts' approvalCode: description: Approval code of the posting. type: string minLength: 0 maxLength: 20 approvalStatus: description: Approval status of the posting. type: string minLength: 0 maxLength: 20 stampDuty: description: Flag to identify a Stamp Duty Transaction. type: boolean customCharge: description: Flag to identify a Custom Charge. type: boolean transactionNo: description: Unique Transaction Identifier. type: number transactionDate: description: Transaction Date. type: string format: date maxLength: 8 transactionCode: description: Billing Transaction Code. type: string minLength: 0 maxLength: 200 transactionDescription: description: Billing Transaction Description. type: string minLength: 0 maxLength: 2000 transactionAmount: description: The amount of the transaction. type: number postingDate: description: Date and time of posting. type: string format: date maxLength: 8 revenueDate: description: The date on which the transaction has its revenue effect. type: string format: date maxLength: 8 receiptNo: description: The receipt number of the transaction, if there is a receipt generated. type: number roundingDifferenceTrx: description: Indicator to determine if the posting was a posting for the Rounding Difference. type: boolean commissionable: description: Indicator to determine if the transaction is commissionable. type: boolean reversePaymentTransactionNo: description: Reverse payment transaction unique identifier. type: number canAdjustInvoice: description: Indicator to determine if the transaction can be adjusted. type: boolean depositTransactionId: description: Tax Service Accounting Codes used. type: string minLength: 0 maxLength: 40 depositPolicy: description: Deposit Policy information if this payment was applied to a deposit policy. $ref: '#/components/schemas/resDepositPolicyType' comments: description: User defined comments for the deposit. type: string minLength: 0 maxLength: 2000 paymentMethod: description: Defined method of payment for this transaction. $ref: '#/components/schemas/reservationPaymentMethodType' receiptSummaryInfo: description: Information regarding receipt of the posted deposit $ref: '#/components/schemas/receiptSummaryType' folioNo: description: The Folio number of this posting, if there was a Folio already generated. type: number transferred: description: Indicates if the deposit was transferred either to a reservation or from a reservation. type: boolean folioTypeName: description: The name of the Folio Type used for the Folio Number sequence. type: string minLength: 0 maxLength: 100 ccSettleRecordExists: description: Indicates if the posting has a credit card settlement record. type: boolean cardProcessingType: type: string enum: - Eft - Manual authorizersCreditType: type: array description: List of Comp Accounting Authorizers Credits maxItems: 4000 items: $ref: '#/components/schemas/authorizerCreditType' checkDetailsType: type: object description: Holds check details information. properties: checkDate: description: Check date of the posting. type: string format: date-time checkText: description: Check text of the posting. type: string minLength: 0 maxLength: 32000 checkImage: description: Check image of the posting. type: string format: byte exchangeAmounts: type: object description: Converted values for the Exchange Currency requested. properties: debitAmount: description: The converted Guest Ledger Debit Amount. $ref: '#/components/schemas/currencyAmountType_2' creditAmount: description: The converted Guest Ledger Credit Amount. $ref: '#/components/schemas/currencyAmountType_2' transactionARInfoType: type: object description: Details of the AR account where this transaction was posted to. properties: accountNumber: description: AR Account number. type: string minLength: 0 maxLength: 20 accountName: description: The Account name where this invoice is sent. type: string minLength: 0 maxLength: 1000 invoiceNo: description: The invoice number which includes this transaction. type: number errorType: type: object description: Standard way to indicate that an error occurred during the processing of an OpenTravel message. If the message successfully processes, but there are business errors, those errors should be passed in the warning element. properties: value: type: string description: Property Value shortText: description: An abbreviated version of the error in textual format. type: string code: description: If present, this refers to a table of coded values exchanged between applications to identify errors or warnings. Refer to OpenTravel Code List Error Codes (ERR). type: string minLength: 0 maxLength: 20 docURL: description: If present, this URL refers to an online description of the error that occurred. type: string status: description: If present, recommended values are those enumerated in the OTA_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 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 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 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". Refer to OpenTravel Code List Error Warning Type (EWT). type: string minLength: 0 maxLength: 20 language: description: Language identification. type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' nodeList: description: An XPath expression that selects all the nodes whose data caused this error. Further, this expression should have an additional constraint which contains the data of the node. This will provide the offending data back to systems that cannot maintain the original message. type: string autoSettleCompFoliosStatus: type: object description: Response for auto settle comp folios. This includes collection of auto settled comp folios. properties: folios: description: Collection of auto settled comp folios. $ref: '#/components/schemas/autoSettleCompFoliosType' warnings: $ref: '#/components/schemas/warningsType' billingChargesCriteriaType: type: object description: Criteria type for posting charges. properties: hotelId: description: Property where the charges are to be posted. type: string minLength: 0 maxLength: 20 charges: description: Information regarding the charges which have to be posted. type: array maxItems: 4000 items: $ref: '#/components/schemas/chargeLongTrxCodeCriteriaType' reservationId: $ref: '#/components/schemas/reservationId' incomeAuditDate: description: Date of the Audit. This is used when postings are being created using the Income Audit functionality. type: string format: date maxLength: 8 postIt: description: Flag to indicate it is part of a PostIt Sale. type: boolean cashierId: $ref: '#/components/schemas/cashierId' welcomeOfferPosting: description: Flag to indicate that current posting is a Welcome Offer Posting. type: boolean 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 transactionType: type: object description: Transaction type. properties: transactionNo: description: Unique transaction identifier. $ref: '#/components/schemas/codeDescriptionType' transactionDate: description: Transaction date. type: string format: date maxLength: 8 transactionCode: description: Transaction code. type: string minLength: 0 maxLength: 200 transactionDescription: description: Transaction description. type: string minLength: 0 maxLength: 2000 resAccompanyGuestListType: type: array description: Collection of accompany guests maxItems: 4000 items: $ref: '#/components/schemas/resAccompanyGuestInfoType' compAccountingJournal: type: object description: Response for fetching the Complimentary Posting Journal. properties: journalPostings: description: Complimentary Journal entries of the response. $ref: '#/components/schemas/financialPostingsType' 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' cCSurchargeAmountType: type: object description: Information regarding the Surcharge amount which will be applied to a payment. properties: hotelId: description: Property where the payment is being posted. type: string minLength: 0 maxLength: 20 surchargeAmount: description: The total Surcharge amount which is to be applied to this payment. $ref: '#/components/schemas/currencyAmountType_2' surchargeInfo: description: Details on the Surcharge configuration. The percentage and a threshold amount in case it is defined. $ref: '#/components/schemas/cCSurchargeInfoType' paymentMethod: description: Payment method used for the payment. $ref: '#/components/schemas/cashieringPaymentMethodType' resSharedGuestListType: type: array description: Collection of shared guest reservations. maxItems: 4000 items: $ref: '#/components/schemas/resSharedGuestInfoType' postRateCodeCriteria: type: object description: Request to check if a Rate Code can be posted to the room manually. This will check if the Rate Code is valid, if the Products(Packages) which are defined as part of the Rate Code can be posted or reversed. properties: criteria: description: Information on the Rate Code and reservation where it should be posted. $ref: '#/components/schemas/postRateCodeCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' checkPostBillingChargesOptionsType: type: array description: TAvailable options for this consumable maxItems: 4000 items: type: object properties: consumable: $ref: '#/components/schemas/chargeCriteriaType' packageAllowance: description: Determines if the package allowance is available to be consumed. type: boolean roomRouting: description: Room routing is applicable on the requested consumable. type: object properties: roomId: type: string minLength: 0 maxLength: 20 guest: $ref: '#/components/schemas/personNameType' applicable: type: boolean depositType: type: string description: Enumeration Type of Deposit. enum: - Folios - Receipts - None benefitsType: type: array description: Basic information about membership benefit. maxItems: 4000 items: $ref: '#/components/schemas/benefitType' transactionsAdjustment: type: object description: Request to adjust a transaction. In order to adjust a transaction, a valid amount or percentage is required. A valid reason code and reason text is also required. Only negative adjustments are done. The adjust process will post a new negative transaction for the same transaction code for the current day. properties: criteria: description: Criteria for the transaction adjustment. To adjust a transaction, a valid amount or percentage and a valid reason code and text are required. $ref: '#/components/schemas/trxAdjustCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' 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 prepaidCardCriteria: type: object description: Request type for prepaid card creation/reload/redeem/removal process properties: criteria: description: Criteria for creation/reload/redeem/removal of prepaid cards. $ref: '#/components/schemas/prepaidCardCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' downgradeType: type: string description: Do not downgrade membership when the next downgrade process runs. When the downgrade process runs, the membership will be automatically set to Grace. enum: - Grace - Never - Period chargesAndPaymentsCriteria: type: object description: Request to post charges and payments on a reservation. properties: charges: description: Information regarding the charges which have to be posted. type: array maxItems: 4000 items: $ref: '#/components/schemas/chargeCriteriaType' payments: description: The payment information to be posted. type: array maxItems: 4000 items: $ref: '#/components/schemas/paymentCriteriaType' cashierId: description: The Cashier ID of the Cashier who is currently processing the transaction(s). type: number minimum: 0 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 vaultHTTPTransactionMessageType: type: object properties: hotelId: description: The hotel context of the transaction. type: string minLength: 0 maxLength: 20 escapedRequestContent: description: The HTTP request entity content. The needs to use escape characters. type: string minLength: 0 maxLength: 4000 escapedResponseContent: description: The HTTP response entity content. The needs to use escape characters. type: string minLength: 0 maxLength: 4000 hTTPTransactionDuration: description: Request and response time of the vault communication. $ref: '#/components/schemas/dateRangeType' hTTPError: description: Vault error. $ref: '#/components/schemas/errorType' authorizationApproval: description: Authorization approval record. type: object properties: profileId: description: Profile Id corresponding to the guest name. $ref: '#/components/schemas/profileId' reservationIdList: $ref: '#/components/schemas/reservationIdList' approvalAmount: description: Approved amount. $ref: '#/components/schemas/currencyAmountType_2' authorizedPaymentRecord: description: The payment record which the authorization approved. $ref: '#/components/schemas/reservationPaymentMethodType' approvalCode: description: The approval code authenticates the authorization. type: string minLength: 0 maxLength: 20 originalAuthSequence: description: Unique Authorization Sequence for the authorization and settlement. type: integer cardSwiped: type: boolean sourceOfAuthorization: description: Source of the authorization. $ref: '#/components/schemas/cardAuthorizationTransactionType' type: $ref: '#/components/schemas/vaultHTTPTransactionType' transactionToSplitAndTransfer: type: object description: Request to split a transaction on a reservation and transfer the new transaction to a different reservation or a different window on the same reservation. Splitting of transactions requires a In-house target reservation, a list of transactions for a In-house reservation and a valid amount or a percentage by which the amount can be split. Based on parameters, certain transactions cannot be split. Transaction which are included in an invoice cannot be split Transactions where the generates resides elsewhere(reservation or window) cannot be split. Automatically generated transactions such as taxes, cannot be split by itself. Deposits which were part of a deposit folio cannot be split. After the split is done the transaction is transferred to the target reservation/window. properties: criteria: description: Transaction Split and Transfer criteria. A target reservation or a target window, and an Amount or a Percentage is required along with the transactions to split. $ref: '#/components/schemas/trxSplitAndTransferCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' cashierClosureReportsType: type: array description: Information of the Cashier. maxItems: 7 items: $ref: '#/components/schemas/cashierReportType' reverseCertificatePostingsCriteria: type: object description: Request to reverse the certificate postings of transactions. properties: reverseCriteria: description: Criteria for reversing the certificate postings of transactions. $ref: '#/components/schemas/reverseCertificatePostingsCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' resvRoutingInfoType: type: object description: A routing info object can either be of type Folio OR of type Room with its corresponding object. properties: folio: description: Folio routing type. type: object properties: guestInfo: description: Guest details type: object properties: profileIdList: description: Unique identifiers for the Profile for both internal and external systems. $ref: '#/components/schemas/profileIdList' payeeInfo: $ref: '#/components/schemas/payeeInfoType' aRNumber: description: Accounts Receivable. type: string minLength: 0 maxLength: 20 instructions: description: Set of routing instructions associated to this routing type. type: array maxItems: 4000 items: $ref: '#/components/schemas/routingInstructionType' folioWindowNo: type: integer paymentMethod: type: string maxLength: 2000 room: description: Room routing type. type: object properties: roomId: description: Room number to route the instructions. type: string minLength: 0 maxLength: 20 guestNameId: description: Guest unique identifier to which the instruction will be routed. $ref: '#/components/schemas/uniqueID_Type' guestDisplayName: description: Display Name for the guest. type: string minLength: 0 maxLength: 80 reservationNameId: description: Reservation name id to which the instruction will be routed. $ref: '#/components/schemas/uniqueID_Type' instructions: description: Set of routing instructions associated to this routing type. type: array maxItems: 4000 items: $ref: '#/components/schemas/routingInstructionType' comp: description: Comp Accounting Routing Info type: object properties: compAccountingInfo: $ref: '#/components/schemas/compAccountingType' compRequestInfo: $ref: '#/components/schemas/compRoutingRequestType' payeeInfo: $ref: '#/components/schemas/payeeInfoType' instructions: description: Set of routing instructions associated to this routing type. type: array maxItems: 4000 items: $ref: '#/components/schemas/routingInstructionType' folioWindowNo: type: integer request: description: Comp Accounting Request routing type: object properties: compRequestInfo: $ref: '#/components/schemas/compRoutingRequestType' instructions: description: Set of routing instructions associated to this routing type. type: array maxItems: 4000 items: $ref: '#/components/schemas/routingInstructionType' refreshFolio: description: On a successful update, the transactions that are already posted in the guest's folio will be re-organized based on the configured instructions. type: boolean reservationInfo: description: Reservation guest details. $ref: '#/components/schemas/reservationInfoType' surnameType: type: string description: Family name, last name. minLength: 0 maxLength: 40 transferCompTransactions: type: object description: Request type for comp transactions transfer. properties: criteria: description: Comp transactions transfer criteria. type: object properties: targetFolioNo: description: Folio window number to where transactions will be transfered. type: integer transactionList: description: List of transactions to be transfered. type: array maxItems: 4000 items: type: number cashierId: $ref: '#/components/schemas/cashierId' warnings: $ref: '#/components/schemas/warningsType' depositFolioValidateCriteria: type: object description: Request to validate a Deposit Folio for a reservation. properties: criteria: description: Criteria for validating if a Deposit Folio can be created for a reservation. Deposit Folio functionality should be active. $ref: '#/components/schemas/depositFolioValidateCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' autoSettlementType: type: object properties: hotelId: description: Property code. type: string minLength: 0 maxLength: 20 reservationIdList: $ref: '#/components/schemas/uniqueIDListType' eventType: description: Event to which this process will be logged. $ref: '#/components/schemas/cashieringEventType' paymentMethods: description: Payment methods to be settled. $ref: '#/components/schemas/paymentMethodsSearchType' folioWindowsToSettle: description: Folio windows to do auto auto settlement. type: array maxItems: 8 items: type: string minLength: 0 maxLength: 20 folioWindowsToTransfer: description: Folio windows to transfer. type: array maxItems: 8 items: type: string minLength: 0 maxLength: 20 reservationCriteria: description: This is related to reservation search.If the Reservation ID list is empty then this criteria filter will be applied to the reservation. $ref: '#/components/schemas/autoFolioSettlementCriteriaType' includeCreditCardBalance: description: Dictates whether to include negative postings for auto settlement. type: boolean minimumWindowBalance: description: Indicates the minimum window balance to do auto settlement. type: integer cashierId: $ref: '#/components/schemas/cashierId' hotelRevenueDetails: type: object description: Response object for hotel room revenue for all HHonors redemption reservation. properties: hotelRevenue: description: Hotel Room Revenue type. $ref: '#/components/schemas/hotelRevenueType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' orderByEnum: type: string enum: - ArrivalDate - DepartureDate - Room - DocumentUpdatedDate deferredTaxesProcessDetails: type: object description: Response of submitting post deferred taxes for a reservation. properties: processId: description: Job process identifier. $ref: '#/components/schemas/stringLength40' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' earlyDepartureCriteriaType: type: object description: Criteria type for verifying or changing an Early Departure reservation. properties: hotelId: description: Property code. type: string minLength: 0 maxLength: 20 reservationIdList: description: Reservation id for which the early departure is to be done. $ref: '#/components/schemas/reservationIdList' ignoreRateRestriction: description: Indicates if Rate Restriction check should be overridden. type: boolean postConsumedAllowanceToGuest: description: Indicates if any allowance consumed by the guest for today can be posted to the Guest Folio. If this cannot be done then the Early Departure cannot proceed. type: boolean ignoreCheckOnTieredRate: description: Indicates if check has to be done for Rate Tiers. type: boolean postEarlyDeparturePenalty: description: Indicates if the early departure penalty should be posted . type: boolean cashierId: $ref: '#/components/schemas/cashierId' postDepositToGuestFolioType: type: object description: Criteria for transferring the Deposit Amount to the Guest Folio properties: hotelId: description: Resort for which the reservation defined. type: string minLength: 0 maxLength: 20 reservationId: description: Unique ID of a reservation. $ref: '#/components/schemas/reservationId' cashierId: $ref: '#/components/schemas/cashierId' createdRoutingInstructions: type: object description: Response when creating a routing instruction. It may optionally return a list of postings which are eligible for transfer as per the new routing instruction in case of room routing instruction. properties: postingsForRoomRouting: description: Transaction details along with the transaction code information. $ref: '#/components/schemas/postingsInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' cCSurchargeInfoType: type: object description: Credit Card Surcharge Information type. Information regarding surcharge which can be applied to a Credit Card payment. properties: percentage: description: The percentage on the payment amount which will be the Surcharge. type: number minimum: 0 maximum: 100 threshold: description: The threshold payment amount above which the Surcharge will be applied. $ref: '#/components/schemas/currencyAmountType_2' transactionCode: description: The Payment Transaction Code for which the Surcharge Applies. type: string minLength: 0 maxLength: 20 authorizationInfoType: type: object properties: approvalAmount: description: Approved amount. $ref: '#/components/schemas/currencyAmountType_2' approvalCode: description: The approval code authenticates the authorization. type: string minLength: 0 maxLength: 20 originalAuthSequence: description: Unique Authorization Sequence for the authorization and settlement. type: integer vendorTranId: description: Vendor transaction id for the authorization. type: string minLength: 0 maxLength: 20 alternateTransRef: description: Alternate vendor transaction id for the authorization. type: string minLength: 0 maxLength: 64 transactionServiceTypeType: type: object description: Containsts service type posting information. properties: serviceType: description: Contains service type code attached with transaction code. $ref: '#/components/schemas/codeDescriptionType' revenue: description: Revenue amount of the service type. $ref: '#/components/schemas/currencyAmountType_2' payment: description: Payment amount of the service type. $ref: '#/components/schemas/currencyAmountType_2' balance: description: Running balance of the service type. $ref: '#/components/schemas/currencyAmountType_2' totalPostings: description: Running total number of the service type. type: integer postedBillingChargesInBatch: type: object description: Operation response to post billing charge with list of reservations. properties: reservationBatchChargeInfoList: type: array description: Information regarding charges in batch result for each reservation. maxItems: 4000 items: $ref: '#/components/schemas/reservationChargesInBatchInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' 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 postFiscalInfoType: type: object description: FiscalInfo criteria type. properties: fiscalPayloadType: description: Fiscal Payload Type. $ref: '#/components/schemas/payloadType' stringLength32000: type: string description: Used for Character Strings, length 0 to 32000. maxLength: 32000 minLength: 0 transactionsType: type: array description: List of transaction information. maxItems: 4000 items: $ref: '#/components/schemas/transactionType' depositCreditBillCriteria: type: object description: Request to Deposit Credit Bill for a reservation. properties: criteria: description: Criteria to Deposit Credit Bill. Deposit Folio and Credit Bill functionality should be active. $ref: '#/components/schemas/depositCreditBillCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' deferredTaxesProcess: type: object description: Request for submitting post deferred taxes for a reservation. properties: criteria: description: Contains criteria to post the deferred taxes for the given reservation. $ref: '#/components/schemas/deferredTaxesCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' fiscalSupportingDocumentCriteria: type: object description: Request to send supporting document to fiscal partner. properties: criteria: description: Criteria for sending supporting document. $ref: '#/components/schemas/fiscalSupportingDocumentCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' prepaidCardTrxTypeType: type: string description: Reload transaction. enum: - Activate - Cancel - Cashout - Inquiry - Issue - Redeem - Reload exchangeRateTransactionGenerateTaxesType: type: array description: Exchange rate calculation tax information based on Transaction Code Generate. maxItems: 4000 items: $ref: '#/components/schemas/exchangeRateTransactionGenerateTaxType' uniqueIDListType: type: array description: Unique Id that references an object uniquely in the system. maxItems: 4000 items: $ref: '#/components/schemas/uniqueID_Type' fixedChargesDetails: type: object description: Response that contains either the fixed charges list if fetch was successful or error(s) if not. properties: fixedCharges: description: List of Fixed Charges. Contains information on Fixed Charges Frequency, Schedule and Charge Details. Refer to the Generic Common Types document for information on the Fixed Charges Type $ref: '#/components/schemas/fixedChargesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' searchCompRoutingInstructionsRequest: type: object properties: end: type: string format: date description: The ending value of the date range. start: type: string format: date description: The starting value of the date range. nameWildcard: type: string description: Family name or last name of the guest firstNameWildCard: type: string description: Given name or first name of the guest. roomNumberCodes: type: array maxItems: 4000 items: type: string id: type: array items: type: string 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. idContext: type: array items: type: string description: Used to identify the source of the identifier (e.g., IATA, ABTA). type: type: array items: type: string description: A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT). membershipId: type: string description: Membership Card number. code: type: array maxItems: 4000 items: type: string resStatusCode: type: array items: $ref: '#/components/schemas/reservationStatusCodeEnum' 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. compRoutingStatuses: type: array items: $ref: '#/components/schemas/compRoutingStatusEnum' description: Status which indicates that the Request of Comp Routing was declined postingsForRefresh: type: object description: Response object that lists the transactions that can be refreshed when a routing instruction set is refreshed. properties: postingsForRoomRouting: description: Transaction details along with the transaction code information. $ref: '#/components/schemas/postingsInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' operaVersionNumberType: type: string description: Current Opera Version Number minLength: 0 maxLength: 40 compRoutingStatusType: type: string description: Status which indicates that the Request of Comp Routing was declined enum: - Request - Comp - Declined reservations: type: array description: Unique identifier for a reservation. maxItems: 4000 items: $ref: '#/components/schemas/reservationId' errorsType: type: array description: An error that occurred during the processing of a message. maxItems: 99 items: $ref: '#/components/schemas/errorType' 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 depositMaturityType: type: string description: The deposit is transferred when the guest checks in. enum: - CheckIn - LastNightStay - LastDayAdvanceDeposit - None cashierClosure: type: object description: Request to close cashier's shift. properties: criteria: description: Criteria for closing cashier. $ref: '#/components/schemas/cashierClosureType' cashierLockHandle: description: The lock handle of the cashier lock. Cashier needs to be locked before this operation can be invoke. $ref: '#/components/schemas/cashierLockHandle' hotelId: description: Unique ID of the hotel $ref: '#/components/schemas/codeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' ccBatchSettlements: type: object description: Response for credit card settlements. properties: batchSettlements: description: List of credit card transaction. $ref: '#/components/schemas/cCBatchSettlementsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' fiscalResponseInfoType: type: object description: Invoice information returned from the fiscal service. properties: invoiceNo: description: Fiscal terminal invoice number returned from fiscal service. type: number fiscalResponseId: description: Uniquely identifies data sent from FLIP. type: number depositedFolioValidate: type: object description: Information regarding the Deposit Policy if a Deposit Folio is going to be created for this policy. properties: policyInfoList: type: array items: $ref: '#/components/schemas/resDepositPolicyType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' nameValueDetailType: type: object description: Detailed information returned during name value search. properties: nameValues: description: Name Value List. $ref: '#/components/schemas/nameValuesType' cashierClosureReportsList: type: object description: Returns whether a particular report is applicable or not based on payment posting type. When no postings for a particular payment type is found, that report is marked as not applicable in the closure report. properties: cashierReportList: type: array items: $ref: '#/components/schemas/cashierReportType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' cCBatchSettlementsType: type: array description: List of Settlement transaction details for credit card transaction. maxItems: 4000 items: $ref: '#/components/schemas/cCBatchSettlementType' folioShortInfoType: type: object description: This type contains information of generated folios. properties: folioNo: description: Folio No of the bill generated. type: number folioType: description: Folio type of the bill generated. type: string minLength: 0 maxLength: 200 folioView: description: The folio window where the settlement is applied. type: integer autoGenerated: description: Flag to indicate if the folio is auto generated or not. type: boolean 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 invoiceNo: description: Invoice No after the folio is generated. Same invoice number may be referred in multiple folios type: number folioDate: description: Date of Folio Generation. type: string format: date folioStatus: $ref: '#/components/schemas/folioStatusType' proformaResponseInstructionType: type: string description: Response instructions for Proforma Creation. enum: - None - FolioSummary billingChargesInBatchCriteria: type: object description: Operation to post billing charge to list of reservations. properties: criteria: description: Information regarding the Rate Code and reservation to which the rate amount should be posted. $ref: '#/components/schemas/postBillingChargesInBatchCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' folioHistoryResponse: type: object description: Response for the fetch Folio History. properties: folioHistory: description: List of Folio History. $ref: '#/components/schemas/foliosType' 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' checkoutZeroBalanceReservationType: type: object properties: hotelId: description: Property code. type: string minLength: 0 maxLength: 20 cashierId: $ref: '#/components/schemas/cashierId' 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 bulkPrepaidCardDetailsType: type: object description: Holds prepaid card information. properties: cardNo: description: Prepaid card / account number. type: string minLength: 0 maxLength: 80 cardNumberMasked: description: Masked Prepaid card / account number. type: string minLength: 0 maxLength: 80 amount: description: Prepaid Card Amount. $ref: '#/components/schemas/currencyAmountType_2' pinCode: description: Prepaid card pin code. type: string minLength: 0 maxLength: 10 cardDetails: description: Prepaid Card details from vendor. $ref: '#/components/schemas/prepaidCardDetailsType' 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 giftCard: description: Indicates a gift card type. type: boolean userDefinedFieldsType: type: object description: A common type used to hold user defined fields(UDFs). This type should be used to handle UDFs on RReservation, Profiles, etc. properties: characterUDFs: description: Collection of user defined fields of Character/String Type. $ref: '#/components/schemas/characterUDFsType' numericUDFs: description: Collection of user defined fields of Numeric Type. $ref: '#/components/schemas/numericUDFsType' dateUDFs: description: Collection of user defined fields of Date Type. $ref: '#/components/schemas/dateUDFsType' cashSurchargeDetails: type: object description: Response to the request to fetch Cash Surcharge information for a Cash/Cheque Payment method. properties: info: description: Surcharge information for the Cash/Cheque Payment method. $ref: '#/components/schemas/cashSurchargeAmountType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' 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 prepaidCardInfoType: type: object description: Detailed information about the prepaid card. properties: hotelId: description: Hotel context for the prepaid card. type: string minLength: 0 maxLength: 20 reservationId: description: The reservation name id where the transaction is associated. $ref: '#/components/schemas/uniqueID_Type' cardNo: description: Prepaid card number. type: string minLength: 0 maxLength: 80 cardNumberMasked: description: Masked Prepaid card / account number. type: string minLength: 0 maxLength: 80 interfaceId: description: The unique ID for the Interface. $ref: '#/components/schemas/uniqueID_Type' initialLoadDate: description: Initial Load Date of the prepaid card. type: string format: date maxLength: 8 issueDate: description: Issue Date of the prepaid card. type: string format: date maxLength: 8 validUntil: description: Validity of the prepaid card amount. type: string format: date maxLength: 8 expiryDate: description: Expiry Date of the prepaid card. type: string format: date maxLength: 8 initialCredit: description: Initial Credit of the prepaid card. $ref: '#/components/schemas/currencyAmountType_2' totalDebit: description: Total Debt of the prepaid card. $ref: '#/components/schemas/currencyAmountType_2' totalCredit: description: Total Credit of the prepaid card. $ref: '#/components/schemas/currencyAmountType_2' balance: description: Balance of the prepaid card. $ref: '#/components/schemas/currencyAmountType_2' availableCashoutAmount: description: Available cashout of the prepaid card. $ref: '#/components/schemas/currencyAmountType_2' reservedAmount: description: Reserved Amount of the prepaid card. $ref: '#/components/schemas/currencyAmountType_2' prepaidCardTransactions: description: List of prepaid card transactions. $ref: '#/components/schemas/prepaidCardTransactionsType' vendorTransactionsActive: description: Indicate if vendor transactions are included on the transactions list. type: boolean operaTransactionsActive: description: Indicate if opera transactions are included on the transactions list. type: boolean giftCard: description: Indicates a gift card type. type: boolean postedBillingPayment: type: object description: Response notifying if the posting of a payment to a reservation was successful. properties: postings: description: List of Postings produced by Billing Payment Request. $ref: '#/components/schemas/summaryPostingsType' trxCodesInfo: description: Transaction codes information which are in response postings. $ref: '#/components/schemas/trxCodesInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' detailPostingsType: type: array description: Details of the transaction(Posting). maxItems: 4000 items: $ref: '#/components/schemas/detailPostingType' redeemPrepaidCardsStatus: type: object description: Response for redeem Prepaid cards request. properties: prepaidCards: description: Prepaid Card details type. $ref: '#/components/schemas/prepaidCardsInfoType' warnings: $ref: '#/components/schemas/warningsType' 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 fiscalCallStatus: type: object description: Check if it will call fiscal or not. properties: isValid: description: Flag which contains if its valid or not. type: boolean folioTypeName: description: Folio Type Name. type: string links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' paymentCriteriaType: type: object properties: hotelId: description: Property code. type: string minLength: 0 maxLength: 20 paymentMethod: description: Payment method used by the payee. $ref: '#/components/schemas/cashieringPaymentMethodType' postingAmount: description: Amount to post to the folio. $ref: '#/components/schemas/currencyAmountType_2' postingReference: description: User-defined posting reference. type: string minLength: 0 maxLength: 2000 postingRemark: description: User-defined posting remark. type: string minLength: 0 maxLength: 2000 comments: description: User Defined Comments. Used for Deposit Payment postings. type: string minLength: 0 maxLength: 2000 applyCCSurcharge: description: Flag to indicate if Credit Card Surcharge has to be applied to this payment, when the functionality for Credit Card Surcharge is available. type: boolean applyCashSurcharge: description: Flag to indicate if a cash surcharge amount can be included, when the functionality for Cash Surcharge is available. type: boolean manualPaymentTaxInfo: description: The Payment Tax information for Thailand Tax functionality. The invoice number and the date will be used. $ref: '#/components/schemas/paymentTaxType' creditablePaymentTaxes: description: Used for Thailand Tax Functionality.The payment tax records that can be used for a Credit Note for this reservation. $ref: '#/components/schemas/paymentTaxesType' terminalId: description: Applicable for chip and pin. The ID of the terminal where the chip and pin device is connected and where the payment is made. type: string overrideInsufficientCC: description: Flag to allow a rebate by Credit Card type: boolean changeDueAmount: description: Amount of change given to guest. $ref: '#/components/schemas/currencyAmountType_2' compRedemptions: description: Comp redemption information used to post as payment. $ref: '#/components/schemas/compRedemptionsType' overrideARCreditLimit: description: Flag to override account receivable credit limit type: boolean applyCurrencyTaxes: description: Flag to indidcate if currency taxes need to be applied or not. For ex, in case of Chile, it depends upon nationality of the guest. type: boolean vATOffset: description: Flag to indidcate if currency taxes need to be applied or not. For ex, in case of Chile, it depends upon nationality of the guest. type: boolean action: description: Payment action to know from where the payment has been made. $ref: '#/components/schemas/postPaymentActionType' prepaidCardRedemptions: description: Prepaid Card redemption information used to post as payment. $ref: '#/components/schemas/prepaidCardRedemptionsType' folioWindowNo: type: integer cashierId: $ref: '#/components/schemas/cashierId' originalInvoice: description: User-defined original invoice number. type: string minLength: 0 maxLength: 40 invoiceType: description: Type of invoice specified in the originalInvoice field. type: string minLength: 0 maxLength: 10 marketCode: description: Market code type: string minLength: 0 maxLength: 20 sourceCode: description: Source of business type: string minLength: 0 maxLength: 20 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 batchAdvanceFolioType: type: object description: Contains criteria for process batch advance folio. properties: hotelId: description: Property context of the reservations. type: string minLength: 0 maxLength: 20 reservations: description: List of unique reservation identifiers having deposits to process. Reservations should come from the same property. $ref: '#/components/schemas/reservations' cashierId: description: Unique cashier identifier to process the deposit transaction. $ref: '#/components/schemas/cashierId' benefitType: type: object description: Basic information about membership benefit. properties: code: description: Benefit code associated with a membership. type: string minLength: 0 maxLength: 20 message: description: Processing message for membership benefit. type: string minLength: 0 maxLength: 4000 inactive: description: Indicates whether membership benefit is active or inactive. type: boolean 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 finalPostings: type: object description: Request to apply any final charges or payments to a reservation prior to checkout. This operation should be called prior to the guest settlement which would then reflect the balance the guest has to pay. properties: reservation: description: Check out reservation request. $ref: '#/components/schemas/checkoutReservationType' responseInstruction: description: This flag will allow the user to control the response performance. Response will return folio information based on the this flag. Possible values are None, Summary, Details $ref: '#/components/schemas/responseInstructionType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' reservationDepositFolios: type: object description: Deposit Posting Information for a reservation. Contains all deposit payments made for a reservation. properties: reservationDepositFoliosInfo: description: Collection of Reservations and their Deposit Information. Includes a list of all deposit payments and folios(if applicable). $ref: '#/components/schemas/reservationDepositFoliosInfoType' trxCodesInfo: description: Transaction codes information which are in response folio. $ref: '#/components/schemas/trxCodesInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' supplementalFolioCriteriaType: type: object description: Criteria for posting the Supplemental Folio. Includes charges and payments. properties: hotelId: description: Property where the charges are to be posted. type: string minLength: 0 maxLength: 20 charges: description: Information regarding the charges which have to be posted. $ref: '#/components/schemas/chargesCriteriaType' payments: description: The payment information to be posted. type: array maxItems: 4000 items: $ref: '#/components/schemas/paymentCriteriaType' fiscalFolioInfo: description: Generate Fiscal Folio Criteria type to be used for fiscal folio generation. $ref: '#/components/schemas/fiscalServiceType' incomeAuditDate: description: Date of the Audit. This is used when postings are being created using the Income Audit functionality. type: string format: date maxLength: 8 fiscalTerminalId: description: Applicable for Fiscal Terminal. The ID of the terminal where the fiscal device is connected. type: string folioNameValue: description: Custom Folio Name Value Informatoin to be saved type: array maxItems: 4000 items: $ref: '#/components/schemas/nameValueHeaderDetailType' trxServiceType: description: Transaction service type which the Folio is being associated. type: string minLength: 0 maxLength: 20 cashierId: $ref: '#/components/schemas/cashierId' originalFolio: description: Original Folio details. This is the folio for which a Supplemental Folio is required. $ref: '#/components/schemas/folioType' compAccountingType: 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 aRNumber: description: AR Account Number of the authorizer type: string minLength: 0 maxLength: 20 compTypeCode: description: The Comp Type for this Account. Used when using the Comp types functionality type: string minLength: 0 maxLength: 20 compVoucherNo: description: The coupon or voucher number used by the external gaming system to track postings made to this routing. type: string minLength: 0 maxLength: 30 dateRange: description: Arrival date range for comp routing $ref: '#/components/schemas/dateRangeType' membershipId: description: Membership number type: string minLength: 0 maxLength: 100 membershipIdNo: description: Unique Id of membership type: integer membershipNameOnCard: description: Name displayed on the membership card type: string minLength: 0 maxLength: 80 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 folioPrinterType: type: object description: Information about a Printer which can be used to print a Folio. properties: printerName: description: Description of the Printer type: string minLength: 0 maxLength: 2000 device: description: The Printer Device name. type: string minLength: 0 maxLength: 200 folioType: description: The Folio Type for which this printer is being used. type: string minLength: 0 maxLength: 2000 folioQueueName: description: Folio Queue name for which this printer is being used. type: string minLength: 0 maxLength: 2000 financialPostingsNetVat: type: object description: Response for fetching the Posting Journal with Net and Vat breakdown. properties: financialPostings: description: Journal entries of the response. type: array maxItems: 4000 items: $ref: '#/components/schemas/financialPostingsNetVatType' 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' folioQueueType: type: object description: List of charges that will be posted against the transaction code based from the test criteria. properties: folioType: description: Folio Type to be assigned to generated folio. This is a country requirement. type: string minLength: 0 maxLength: 100 queueName: description: Countries in Latin America that use folio queues, will need to populate the queueName parameter in the request, to have the Fiscal Bill No populated as needed. type: string minLength: 0 maxLength: 2000 generateFiscalFolio: description: Fiscal folio flag to call fiscal folio web service after folio generation. type: boolean fiscalCommandsResponseInfo: type: object description: Response after generating a commands from Fiscal Terminals screen. properties: fiscalResponseInfo: description: Command information returned from the Fiscal service. $ref: '#/components/schemas/fiscalResponseInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' articlesSaleCriteria: type: object description: Request to post a set of charges, payments and generate a bill for a PasserBy or for the Post-It functionality . A PasserBy is someone who is not staying at the Property. A PasserBy transaction requires a Profile in Opera for whom the the folio is being created. properties: criteria: description: Criteria for posting the Sale. $ref: '#/components/schemas/saleCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' deleteTransactionCriteriaType: type: object description: Criteria type for deletion of transactions. properties: hotelId: description: Property code where the reservation transaction exists. type: string minLength: 0 maxLength: 20 transactionList: description: The unique transaction number of this transaction. type: array maxItems: 4000 items: type: number reasonCode: description: The reason code for the deletion. type: string minLength: 0 maxLength: 20 cashierId: $ref: '#/components/schemas/cashierId' transactionServiceTypesType: type: array description: Details about service type postings. maxItems: 4000 items: $ref: '#/components/schemas/transactionServiceTypeType' changedRoutingInstructions: type: object description: Response when changing a routing instruction. It may optionally return a list of postings which are eligible for transfer as per the modified routing instruction in case of room routing instruction. properties: postingsForRoomRouting: description: Transaction details along with the transaction code information. $ref: '#/components/schemas/postingsInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' fbaReimbursementCriteria: type: object description: PostFBA Reimbursement/Settlement operation posts reimbursement/settlement against the selected certificate records. properties: certificateReconciliationTypes: description: Information regarding reconciliation certificate posting. $ref: '#/components/schemas/certificateReconciliationTypes' 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})*' associatedBillInfoType: type: object description: Associated Bill info. properties: associatedBillNumber: description: The bill number of the original bill for which the Credit Bill is being generated. type: number associatedBillFolioType: description: The folio type of the original bill for which the Credit Bill is being generated. type: string associatedBillQueueName: description: The folio number queue(used in certain countries) of the original bill for which the Credit Bill is being generated. type: string associatedBillFiscalBillNumber: description: The Fiscal Folio Bill Number(from a Fiscal System) of the original bill for which the Credit Bill is being generated. type: string associatedBillGenerationDate: description: The bill generation date of the original bill for which the Credit Bill is being generated. type: string format: date maxLength: 8 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' resCancellationPolicyType: type: object description: A cancellation policy attached with the reservation. properties: revenueType: description: Type of reservation. $ref: '#/components/schemas/depositCancelRevenueType' policy: description: Cancellation policy details. $ref: '#/components/schemas/resCancelPenaltyType' percentageDue: description: The percentage amount due for reservation cancellation. type: number minimum: 0 maximum: 100 comments: description: Comments attached with the reservation cancellation. type: string minLength: 0 maxLength: 2000 policyId: description: Unique ID of the Reservation Policy. $ref: '#/components/schemas/uniqueID_Type' fiscalInfoFolioCriteriaType: type: object description: Criteria for calling fiscal Info type folio service properties: hotelId: description: Property where the Folio History exists. type: string minLength: 0 maxLength: 20 folioCommand: description: Type of fiscal folio operation. $ref: '#/components/schemas/folioCommandType' folios: description: Folio History details. $ref: '#/components/schemas/folioSummaryType' passerByCriteriaType: type: object description: Criteria type for posting charges. properties: hotelId: description: Property where the charges are to be posted. type: string minLength: 0 maxLength: 20 charges: description: Information regarding the charges which have to be posted. $ref: '#/components/schemas/chargesCriteriaType' payments: description: The payment information to be posted. type: array maxItems: 4000 items: $ref: '#/components/schemas/paymentCriteriaType' fiscalFolioInfo: description: Generate Fiscal Folio Criteria type to be used for fiscal folio generation. $ref: '#/components/schemas/fiscalServiceType' incomeAuditDate: description: Date of the Audit. This is used when postings are being created using the Income Audit functionality. type: string format: date maxLength: 8 fiscalTerminalId: description: Applicable for Fiscal Terminal. The ID of the terminal where the fiscal device is connected. type: string folioNameValue: description: Custom Folio Name Value Informatoin to be saved type: array maxItems: 4000 items: $ref: '#/components/schemas/nameValueHeaderDetailType' trxServiceType: description: Transaction service type which the Folio is being associated. type: string minLength: 0 maxLength: 20 cashierId: $ref: '#/components/schemas/cashierId' profileId: description: The Profile ID of the PasserBy. If the sale is not a Post-It Sale, then a Profile ID is required. $ref: '#/components/schemas/profileId' reason: description: The Reason Code and Reason Text which is required when a folio is generated. This input is mandatory when the parameter Credit Bill Reason is active for Credit Bills $ref: '#/components/schemas/folioReasonType' simpleFolio: description: This flag signifies that the folio to be generated is Normal or Simple Folio. Certain countries of the World mandate a simple folio when the invoice amount is less than defined threshold. type: boolean payeeTaxNumber: type: object description: Request to validate and change Payee Tax Number. properties: criteria: description: Criteria to validate and change Payee Tax Number. $ref: '#/components/schemas/changePayeeTaxNumberCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' reservationOveragePaymentsType: type: object description: List of Reservation details for payment that has a folio window balance equal or higher to the credit limit set for the credit card payment method of that folio window. properties: reservationOveragePayment: description: Reservation details to initiate the Credit Limit Overage process type: array maxItems: 4000 items: $ref: '#/components/schemas/reservationOveragePaymentType' hotelId: description: Identifies the hotel code. type: string minLength: 0 maxLength: 20 cashierId: $ref: '#/components/schemas/cashierId' processReservationDepositCriteriaType: type: object description: Criteria to process reservation deposit. properties: hotelId: description: Hotel code of the reservation. type: string minLength: 0 maxLength: 20 depositProcessType: description: Deposit process type of the reservation. $ref: '#/components/schemas/depositProcessType' reservationId: description: Reservation id of the reservation $ref: '#/components/schemas/reservationId' amount: description: The Amount would be transferred to the Guest Ledger of the Psuedo Posting Room if the DepositProcessingType = Keep/Return otherwise it will be transferred to the Guest Ledger of the current reservation. $ref: '#/components/schemas/currencyAmountType_2' percentage: description: The Percentage would be transferred to the Guest Ledger of the Psuedo Posting Room if the DepositProcessingType = Keep/Return otherwise it will be transferred to the Guest Ledger of the current reservation. type: number minimum: 0 maximum: 100 cashierId: $ref: '#/components/schemas/cashierId' deleteTransactionsCriteriaType: type: object description: Criteria type for deletion of transactions. properties: transactionList: description: The unique transaction numbers to be deleted. type: array maxItems: 4000 items: type: number reasonCode: description: The reason code for the deletion. type: string minLength: 0 maxLength: 20 cashierId: type: number description: The Cashier ID of the Cashier who is currently processing the transaction(s). links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' depositCancelRevenueType: type: string description: The type to indicate what revenue is to be used for calculating deposit/cancellation amounts. enum: - Rooms - Catering - All 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_2' percent: description: A percentage value if the authorization rule is percentage based. type: number summaryPostingsType: type: array description: List of postings. maxItems: 4000 items: $ref: '#/components/schemas/summaryPostingType' bookingTimeSpanType: type: object description: The booking time span of the reservation, only applicable when time increments are being used. properties: startDateTime: type: string description: The start time of the reservation booking format: date-time endDateTime: type: string description: The end time of the reservation booking format: date-time 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 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 nameValueType: type: object description: Contains name value pair. properties: name: description: Contains unique key which represents for record field. type: string minLength: 0 maxLength: 100 value: description: Contains value for the record/column. type: string minLength: 0 maxLength: 4000 formatString: description: Contains format string for values. type: string minLength: 0 maxLength: 100 dataType: description: Contains data type for values. $ref: '#/components/schemas/nameValueDataTypeType' origin: description: Contains Origin information. $ref: '#/components/schemas/nameValueOriginType' usageInstruction: description: Contains value(s) to identify the reports to include the collected information in e.g. PFH=Print Folio Header, PFD=Print Folio Detail. $ref: '#/components/schemas/codeListType' postedCompositeDeposit: type: object description: Response for the post composite deposit request. properties: folioWindow: description: Information regarding the new Deposit Folio created. type: array items: $ref: '#/components/schemas/folioWindowType' deposits: description: Deposit payment information of the payment which was posted. $ref: '#/components/schemas/depositPostingsType' trxCodesInfo: description: Transaction codes information which are in response postings. $ref: '#/components/schemas/trxCodesInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' alertAreaType: type: string enum: - CheckIn - CheckOut - Reservation - Billing - InHouse trxPostingInfoType: 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 price: description: Default price of that transaction code. $ref: '#/components/schemas/currencyAmountType_2' minimumPrice: description: Minimum quantity needs to be posted. $ref: '#/components/schemas/currencyAmountType_2' maximumPrice: description: Maximum quantity limitation of posting. $ref: '#/components/schemas/currencyAmountType_2' reservationPolicySummaryType: type: object description: A collection of reservation deposit and cancellation policies. properties: cancellationPolicies: description: A collection of reservation cancellation policies.. $ref: '#/components/schemas/resCancellationPoliciesType' depositPolicies: description: A collection of reservation deposit policies. $ref: '#/components/schemas/resDepositPoliciesType' reservationIdList: description: A list of Ids for reservation. $ref: '#/components/schemas/uniqueIDListType' name: description: Name identifier for the reservation. type: string folioSummaryType: type: object description: Contains Folio Details including payee information and the reservation which it's attached to. properties: fiscalTerminalId: description: Applicable for Fiscal Terminal. The ID of the terminal where the fiscal device is connected. type: string payeeInfo: description: Payee information for the folio. $ref: '#/components/schemas/payeeInfoType' folioAmount: description: Folio gross amount. $ref: '#/components/schemas/currencyAmountType_2' allowConvertFolioYn: description: Flag to check Folio Conversion Allowed. type: boolean isARAttached: description: Flag to check if the folio has an AR number attached. type: boolean isFiscalFolio: description: Flag to check if the folio type is fiscal or not. type: boolean creditBillGenerated: description: Flag which indicates whether credit folio has been generated. type: boolean accountReceivablesFolio: description: Flag to check Folio generated from Acoount Receivables. type: boolean creditFolio: description: Indicates if the folio is a Credit Folio. type: boolean debitFolio: description: Indicates if the folio is a Debit Folio. type: boolean passerbyFolio: description: Indicates if the folio is a Passer By Folio. type: boolean officialBIRReceiptExists: description: Flag to indicate if an Official Receipt is generated for the folio window. Applicable only in the Philippines. type: boolean paymentTrxNo: description: Bill Payment transaction Number. type: number reservationInfo: description: ReservationID to which this record applies. type: object properties: reservationId: description: ReservationID to which this record applies. type: number room: description: Room Number to which this record applies. type: string minLength: 0 maxLength: 20 nameId: description: Guest Name ID $ref: '#/components/schemas/uniqueID_Type' guestName: description: Guest Name type: string minLength: 0 maxLength: 200 altName: description: Guest Alternate Last and First Name type: string minLength: 0 maxLength: 200 postItNo: description: Number for Post-It transactions. type: number associatedBills: description: Bill Number. type: array maxItems: 4000 items: type: string minLength: 0 maxLength: 2000 associatedBillsWithPrefix: description: Associated Bill Number with Prefix. type: array maxItems: 4000 items: type: string minLength: 0 maxLength: 2000 accountCode: description: Account Code. type: number payment: description: Payment Posting for the folio. $ref: '#/components/schemas/summaryPostingType' addresseeInfo: description: Addressee Information for the Folio. This is available when the Addressee functionality is used and and Addressee is attached to the folio. $ref: '#/components/schemas/profileInfoType' fiscalInvoicingCurrencyInfo: description: Exchange Rate information selected to be used by the Fiscal Service. $ref: '#/components/schemas/exchangeRateInfoType' anonymizedFolio: description: Indicates if this folio is linked to an anonymized Guest/Payee/Addressee. type: boolean customNumbers: description: Custom Number. type: array maxItems: 5 items: type: string minLength: 0 maxLength: 200 operaFiscalFolioStatus: description: Opera Fiscal Folio Status for the Folio. type: string partnerFiscalFolioStatus: description: Stores the fiscal folio status for the partner system. type: string trxServiceType: description: Contains service type for transaction code. type: string minLength: 0 maxLength: 20 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 revisionNo: description: Folio Revision number. type: number folioWindowNo: type: integer fiscalFolioNo: description: Bill Number returned by the Fiscal Printer. type: string minLength: 0 maxLength: 40 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 folioSeqNo: description: Unique sequence number. Used to identify the current folio tax record. type: number queueName: description: Folio Queue name. type: string minLength: 0 maxLength: 2000 generateFiscalFolio: description: Fiscal folio flag to call fiscal Information folio web service. type: boolean rachunekFolio: description: Indicates if the folio is a Rachunek Folio. type: boolean customerVatGenerated: description: Flag to indicate if a Customer Vat is generated from a Rachunek Folio. type: boolean confidential: type: boolean description: Indicate that the billing window is confidential or not. debitNote: description: Indicates if the folio is a Debit Note. type: boolean searchReceiptHistoryRequest: type: object properties: fromDate: type: string format: date description: Receipt History Date Range(from). toDate: type: string format: date description: Receipt History Date Range(to). name: type: string description: Family name, last name or Company Name. firstName: type: string description: Given name, first name or names. receiptTypeName: type: string description: Receipt Type. taxInvoice: type: string description: Tax Invoice Number. receiptNo: type: number description: Receipt Number. customNumber: type: string description: Custom number 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' 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 compPostingsType: type: object description: Collection of comp postings. properties: authorizer: description: Authorizer name of the Comp Account. type: string minLength: 0 maxLength: 200 approvalStatus: description: Approval status of the comp account. type: string minLength: 0 maxLength: 200 membershipEarningPreferenceType: type: string description: The earning preference of a membership, it depends on the type of property. eg. when the property is a airline it should be Miles, other than Points. enum: - Points - Miles processFiscalRetryStatus: type: object description: The response object to send back the fiscal service response to opera. properties: folioSeqId: description: Fiscal Folio sequence ID stored in queue table. type: integer isLastRetry: description: Indicating if it is last trial for fiscal printing. type: boolean links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' transactionToWindow: type: object description: Request for transaction transfer properties: criteria: description: Transaction transfer criteria. $ref: '#/components/schemas/trxTransferCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' ccSurchargeDetails: type: object description: Response to the request to fetch Credit Card Surcharge information for a Credit Card Payment. properties: info: description: Surcharge information for the Credit Card Payment. $ref: '#/components/schemas/cCSurchargeAmountType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' 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 depositFolioCriteriaType: type: object description: The Deposit folio posting and payments information. properties: hotelId: description: Property where the charges are to be posted. type: string minLength: 0 maxLength: 20 charges: description: Information regarding the charges which have to be posted. $ref: '#/components/schemas/chargesCriteriaType' payments: description: The payment information to be posted. type: array maxItems: 4000 items: $ref: '#/components/schemas/paymentCriteriaType' fiscalFolioInfo: description: Generate Fiscal Folio Criteria type to be used for fiscal folio generation. $ref: '#/components/schemas/fiscalServiceType' incomeAuditDate: description: Date of the Audit. This is used when postings are being created using the Income Audit functionality. type: string format: date maxLength: 8 fiscalTerminalId: description: Applicable for Fiscal Terminal. The ID of the terminal where the fiscal device is connected. type: string folioNameValue: description: Custom Folio Name Value Informatoin to be saved type: array maxItems: 4000 items: $ref: '#/components/schemas/nameValueHeaderDetailType' trxServiceType: description: Transaction service type which the Folio is being associated. type: string minLength: 0 maxLength: 20 cashierId: $ref: '#/components/schemas/cashierId' reservationId: description: Reservation for which the Deposit Folio is required. $ref: '#/components/schemas/reservationId' profileId: description: Profile Id of the Payee for this Deposit Folio. $ref: '#/components/schemas/profileId' guaranteeCode: description: New guarantee code associated with reservation. type: string minLength: 0 maxLength: 20 depositPolicyId: description: The deposit policy ID to which the Deposit Folio is being associated. $ref: '#/components/schemas/uniqueID_Type' paymentMethod: description: Payment method to update the reservation with, if the payment did not match. $ref: '#/components/schemas/reservationPaymentMethodType' simpleFolio: description: This flag signifies that generated Folio is Normal or Simple Folio. Certain countries of the World mandate a simple folio when the invoice amount is less than defined threshold. type: boolean overrideInventoryCheck: description: Flag to indicate if the Inventory check has to be overridden when the guarantee code of the reservation is changed. type: boolean manualFolioNo: description: Manual Folio Number used for deposit folio.This applies to certain country requirements. type: integer detailPostingType: type: object description: Posting information of the transaction. properties: referenceTransactionNo: description: Generate transaction number for the Posting. type: number referencePackageTransactionNo: description: Package transaction number for the Posting. type: number remark: description: Posting remarks. type: string minLength: 0 maxLength: 2000 reference: description: User-defined posting reference. type: string minLength: 0 maxLength: 2000 checkNo: description: Check number for the posting. type: string minLength: 0 maxLength: 2000 checkCount: description: Check number count for the posting. type: string minLength: 0 maxLength: 2000 postedAmount: description: Actual currency amount posted. $ref: '#/components/schemas/currencyAmountType_2' price: description: Indicates the unit price of the consumption. $ref: '#/components/schemas/currencyAmountType_2' quantity: description: Indicates Quantity. type: number transactionType: description: This is the transaction type which says whether it is a Consumption(C), Payment (FC) or Package (PK) and it is inherited from transaction code. $ref: '#/components/schemas/cashieringTransactionTypeType' holdingLedgerTransaction: description: Indicator to determine if the transaction is a holding ledger transaction. type: boolean creditAmount: description: The amount posted as credit to the ledger. $ref: '#/components/schemas/currencyAmountType_2' debitAmount: description: The amount posted as debit to the ledger. $ref: '#/components/schemas/currencyAmountType_2' articleCode: description: Information regarding the Article(Using Articles Functionality) of this transaction. type: string minLength: 0 maxLength: 20 cashierInfo: $ref: '#/components/schemas/cashierInfoType' paidOut: description: Indicates if this transaction is a paid out transaction. type: boolean arrangementCode: description: Corrected arrangement code from the package associated to this transaction. type: string minLength: 0 maxLength: 20 groupTypeInfo: description: Information related to transaction grouping. $ref: '#/components/schemas/postingGroupType' rateCode: description: Rate code associated to this transaction. type: string minLength: 0 maxLength: 20 compRedemptionCode: description: Comp redemption code assiciated to the transaction. type: string minLength: 0 maxLength: 20 updateInfo: description: Update info associated to this transaction. type: object properties: updateDate: type: string format: date maxLength: 8 updateBy: type: string fbaCertificate: description: Flag indicates that the posting is Flexible Benefits Awards Certificate type: boolean taxInvoiceNo: description: Tax invoice number generated by payment tax. type: string minLength: 0 maxLength: 20 serviceRecovery: description: Flag to indicates service recovery type: boolean compPostingsInfo: description: Comp Postings information for the folio. $ref: '#/components/schemas/compPostingsType' financialTransactionIdList: description: Collection of unique identifiers of the financial transactions. $ref: '#/components/schemas/uniqueIDListType' exchange: description: Available when the Fetch Folio Search Type requests the amounts to be converted to a currency different from the Resort currency. $ref: '#/components/schemas/exchangeAmounts' approvalCode: description: Approval code of the posting. type: string minLength: 0 maxLength: 20 approvalStatus: description: Approval status of the posting. type: string minLength: 0 maxLength: 20 stampDuty: description: Flag to identify a Stamp Duty Transaction. type: boolean customCharge: description: Flag to identify a Custom Charge. type: boolean transactionNo: description: Unique Transaction Identifier. type: number transactionDate: description: Transaction Date. type: string format: date maxLength: 8 transactionCode: description: Billing Transaction Code. type: string minLength: 0 maxLength: 200 transactionDescription: description: Billing Transaction Description. type: string minLength: 0 maxLength: 2000 transactionAmount: description: The amount of the transaction. type: number postingDate: description: Date and time of posting. type: string format: date maxLength: 8 revenueDate: description: The date on which the transaction has its revenue effect. type: string format: date maxLength: 8 receiptNo: description: The receipt number of the transaction, if there is a receipt generated. type: number roundingDifferenceTrx: description: Indicator to determine if the posting was a posting for the Rounding Difference. type: boolean commissionable: description: Indicator to determine if the transaction is commissionable. type: boolean reversePaymentTransactionNo: description: Reverse payment transaction unique identifier. type: number canAdjustInvoice: description: Indicator to determine if the transaction can be adjusted. type: boolean depositTransactionId: description: Tax Service Accounting Codes used. type: string minLength: 0 maxLength: 40 hotelId: description: Property code. type: string minLength: 0 maxLength: 20 targetHotel: description: Cross property posting hotel code. type: string minLength: 0 maxLength: 20 subPostings: description: SubPostings for the posting. $ref: '#/components/schemas/summaryPostingsType' guestInfo: description: Details of the Guest information where this transaction was posted to. type: object properties: profileId: description: Profile Id corresponding to the guest name. It is sometimes possible to have a guest name but the profile id is null. $ref: '#/components/schemas/profileId' reservationId: description: Reservation Id corresponding to the guest name. It is sometimes possible to have a room number but the reservation id is null. $ref: '#/components/schemas/reservationId' guestName: description: Guest name associated with the transaction. type: string minLength: 0 maxLength: 2000 roomId: description: Room number associated with the transaction. type: string minLength: 0 maxLength: 20 confirmationNo: description: Confirmation number associated with the transaction. type: string minLength: 0 maxLength: 50 aRInfo: description: Details of the AR account if the posting was part of an AR invoice. $ref: '#/components/schemas/transactionARInfoType' currencyExchangeInfo: description: Currency exchange information if the posting was made using a currency different from the default currency. $ref: '#/components/schemas/transactionCurrencyExchangeInfoType' adjustmentInfo: description: Details regarding the adjustment made if the current transaction was created as a result of an adjustment. $ref: '#/components/schemas/transactionAdjustmentInfoType' paymentMethod: description: Defined method of payment for this transaction. $ref: '#/components/schemas/reservationPaymentMethodType' payeeInfo: description: Payee information for the folio. $ref: '#/components/schemas/payeeInfoType' miscellaneousInfo: type: object properties: createDateTime: type: string format: date-time covers: description: POS covers type: string minLength: 0 maxLength: 10 exchangeInformation: description: Exchange Information - text presentation of the exchange operation including formula, buy rate, etc. type: string minLength: 0 maxLength: 2000 folioWindowNo: type: integer folioNo: description: The Folio number of this posting, if there was a Folio already generated. type: number folioNoWithPrefix: description: The folio number with prefix value. type: string minLength: 0 maxLength: 200 internalFolioWindowID: description: Internal Unique id for the Folio Window. type: string revisionNo: type: number folioTypeName: description: The name of the Folio Type used for the Folio Number sequence. type: string minLength: 0 maxLength: 100 fiscalBillNo: description: The Fiscal Bill number of this posting type: string minLength: 0 maxLength: 2000 deferredTax: description: Flag to indicate if the Posting is a deferred tax record. Set to true only when the posting is a deferred tax record. Set to false only when the posting is not a deferred tax record. type: boolean depositTransitionStatus: type: object description: Response Body. properties: folios: description: This element returns any automatically generated folios during check-in, based on the Fetch Instruction "AutoFolios". When the parameter "Auto Generate Credit Bill for Deposit upon Check In" is enabled, during check-in credit bills are automatically generated for the deposits. The generated credit bill details are returned so that user can preview/print the folio. For some countries like Portugal, it is mandatory to print the folio and hence this information is needed type: array maxItems: 4000 items: $ref: '#/components/schemas/folioShortInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' unAssociatedCreditBillType: type: object description: Unassociated Credit Bill Details. This input is to generate a Credit Bill without having the original folio details in OPERA properties: unAssociatedCreditBillYn: description: Flag to indicate unassociated credit bill. type: boolean associatedBillNo: description: Associated Bill entered by the user. type: string minLength: 0 maxLength: 2000 profileId: description: The Profile ID of the PasserBy. If the sale is not a Post-It Sale, then a Profile ID is required. $ref: '#/components/schemas/profileId' depositTransferCriteriaType: type: object description: Criteria type for transfer of deposit amount from one reservation to one or more reservation(s). properties: hotelId: description: Property where the reservation exists. type: string minLength: 0 maxLength: 20 reservationId: description: The unique Id of the source reservation. $ref: '#/components/schemas/reservationId' toReservations: description: The reservation id and the amount to transfer detail. type: array maxItems: 4000 items: $ref: '#/components/schemas/depositTransferToReservationType' comments: description: User Comments for the transfer operation. type: string minLength: 0 maxLength: 2000 cashierId: $ref: '#/components/schemas/cashierId' 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 reservationFolioInformation: type: object description: Response for the Create Proforma WS. After the proforma is created by this request, the Opera Proforma report should be called to generate the actual physical Proforma report. The response can have the summary of the Guests Proforma Folio, if requested. properties: reservationFolioInformation: description: This type will return a summary Proforma Folio information in the response based on the Response Instruction flag passed in request. $ref: '#/components/schemas/reservationFolioInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' hotelCashierClosureCurrencyAmountType: type: object description: Cashier Shift amounts for each Hotel group by currency code properties: currencyAmounts: description: Hotel Cash and Check Balances group by Currency Code. type: array maxItems: 4000 items: $ref: '#/components/schemas/cashierClosureCurrencyAmountType' hotelId: description: Hotel Code. type: string minLength: 0 maxLength: 20 hotelCurrencyCode: description: Hotel local currency code. type: string minLength: 3 maxLength: 3 routingInstructionType: type: object description: 'Routing limit can be one of the three: Credit Limit, Percetage Limit, Covers Limit' properties: duration: description: Duration of this instruction. type: object 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 daily: description: Flag to indicate if the routing instruction is a daily instruction. type: boolean transactionCodes: description: Set of Transaction Codes configured in this time span. $ref: '#/components/schemas/trxCodesInfoType' billingInstructions: description: Set of Billing Instructions configured in this time span. $ref: '#/components/schemas/billingInstructionsType' creditLimit: description: Allowable credit amount for this routing instruction. Null value means no limit, 0 equals zero. type: number percentageLimit: description: The routing limit percentage allowed for this routing instruction. type: number covers: description: Number of covers for this routing instruction. type: number limitUsed: description: Amount of Credit used for this routing instruction. type: number routingLinkId: description: Internal Routing Link Id identifier to which limit group the instruction belongs. $ref: '#/components/schemas/uniqueID_Type' gamingRequestStatusType: type: object description: Type that holds guest request status details. properties: hotelId: description: Hotel code corresponding to the transaction. type: string minLength: 0 maxLength: 20 statusCode: description: Status code from the External System.. type: string minLength: 0 maxLength: 200 status: description: Status of the request. type: string minLength: 0 maxLength: 50 messageId: description: Message Id from the External System. type: integer messageText: description: Message sent from the External System regarding the status of this request. type: string minLength: 0 maxLength: 2000 requestDate: description: Date the request was sent. type: string format: date maxLength: 8 reservationPaymentMethodType: type: object properties: paymentCard: $ref: '#/components/schemas/resPaymentCardType' balance: $ref: '#/components/schemas/currencyAmountType_2' 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 cashierLockCriteriaToExtend: type: object description: Operation for extending the lifetime of a lock on a cashier. properties: additionalTimeToLive: description: The number of seconds to add to the lock's validity time. type: number cashierLockHandle: description: The lock handle of the record lock we are attempting to extend. $ref: '#/components/schemas/cashierLockHandle' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' reservationFolioInfoType: type: object description: Each folio will include summary and/or detailed information. properties: reservationInfo: description: Reservation guest details. $ref: '#/components/schemas/reservationInfoType' folioWindows: description: The Folio Window information of the reservation. type: array maxItems: 4000 items: $ref: '#/components/schemas/folioWindowType' folioHistory: description: Folio History element contains all generated folios type: array maxItems: 4000 items: $ref: '#/components/schemas/folioWindowType' postStayChargeAllowed: description: Computed flag specifying that the reservation has met the criteria which allows charges to be posted after being checked-out. type: boolean preStayChargeAllowed: description: Computed flag specifying that the reservation has met the criteria which allows charges to be posted before checking-in. type: boolean autoCheckInAllowed: description: Flag specifying that the reservation can be auto check in when Auto Checkin Pseudo Room parameter is active. type: boolean postToNoShowCancelAllowed: description: Flag specifying that the reservation can post if the reservation status was No Show or Cancelled. type: boolean stampDutyExists: description: Stamp Duty posted in at least one folio window. type: boolean roomAndTaxPosted: description: Flag to check if the room and tax are already posted. type: boolean deferredTaxesPosted: description: Flag applicable only when ALLOW_DEFERRED_TAXES is ON for the resort. Set to true only when there are any unsettled transactions on any of the windows with the deferred tax entry posted. Set to false only when there are unsettled transactions on any of the windows without deferred tax entry. type: string correctionTrxExists: description: Flag indicating if a folio window contains a correction trx. A correction trx indicates a pending required fiscal action over the folio window. Applicable only in Greece. type: boolean postedCreditBill: type: object description: Response for the request to create a Credit Folio. properties: folioWindow: description: Information regarding the new Credit Folio created. type: array items: $ref: '#/components/schemas/folioWindowType' payments: description: Deposit payment information of the payment which was posted. $ref: '#/components/schemas/detailPostingsType' trxCodesInfo: description: Transaction codes information which are in response postings. $ref: '#/components/schemas/trxCodesInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' authorizerCreditDetailsType: type: array description: List of Comp Accounting Authorizers details maxItems: 4000 items: $ref: '#/components/schemas/authorizerCreditDetailType' redemptionType: type: object description: Redemption information. properties: amount: description: The amount to redeem when posting a payment. $ref: '#/components/schemas/currencyAmountType_2' code: description: The associated redemption code. type: string minLength: 0 maxLength: 20 supplement: description: Additional information regarding the redemption. type: string minLength: 0 maxLength: 2000 description: description: Description of the Complimentary Bucket Redemption. type: string minLength: 0 maxLength: 2000 transactionCode: description: Transaction code of the Complimentary Bucket Redemption. type: string minLength: 0 maxLength: 20 availableAmount: description: Available Amount of the Complimentary Bucket Redemption. $ref: '#/components/schemas/currencyAmountType_2' transactionNo: description: Transaction Number of the Complimentary Bucket Redemption. type: number approvalCode: description: Approval Code of the Complimentary Bucket Redemption. type: string minLength: 0 maxLength: 20 fiscalFolioCriteria: type: object description: Request to generate an Initial/Zero invoice from Fiscal Terminals screen. properties: criteria: description: Criteria for the creation of fiscal invoice. $ref: '#/components/schemas/fiscalFolioCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' maturedDepositType: type: object description: Matured Deposits detail. properties: transaction: description: Transaction detail of matured deposits. $ref: '#/components/schemas/transactionType' guestCreditAmount: description: Deposit amount. $ref: '#/components/schemas/currencyAmountType_2' folioView: description: The folio window where this authorization is applied. type: integer cashierInfo: description: Chashier information of user $ref: '#/components/schemas/cashierInfoType' remark: description: User defined remarks of the matured deposit. type: string minLength: 0 maxLength: 2000 reference: description: User defined reference of the matured deposit. type: string minLength: 0 maxLength: 2000 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 authorizerCreditType: 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 hotelId: description: Identifies the hotel code. type: string minLength: 0 maxLength: 20 creditLimit: description: Indicates the Credit Limit of the Authorizers. $ref: '#/components/schemas/currencyAmountType_2' actualAmount: description: Indicates the Actual Amount which has been authorized. $ref: '#/components/schemas/currencyAmountType_2' authorizerCreditDetails: description: Indicates the Comp Authorizer credit details. $ref: '#/components/schemas/authorizerCreditDetailsType' transactionDate: description: Transaction Date associated with the transaction. type: string format: date maxLength: 8 awardFolioInfo: type: object description: eligible amount that is allowed to pay with award payment properties: folioView: description: Folio Window. type: integer eligibleBill: description: Eligible Bill Amount type: number closeFolioCriteriaType: type: object properties: hotelId: type: string minLength: 0 maxLength: 20 reservationId: $ref: '#/components/schemas/reservationId' cashierId: $ref: '#/components/schemas/cashierId' postForeignCurrencyExchangeType: type: object description: Currency conversion calculation type. properties: hotelId: description: Property code where the currency is being converted. type: string minLength: 0 maxLength: 20 fromCurrencyAmount: description: Amount and code of currency that is being converted from. $ref: '#/components/schemas/currencyAmountType_2' exchangeDate: description: Date on which exchange rate was obtained. type: string format: date maxLength: 8 sell: description: Buy or Sell for calculation. type: boolean exchangeReference: description: Exchange references. type: string exchangeType: description: Type for exchange calculation. $ref: '#/components/schemas/currencyExchangeType' reservationId: description: Reservation id $ref: '#/components/schemas/reservationId' profileId: description: Profile ID of the profile to post to. $ref: '#/components/schemas/profileId' room: description: Room to which posting is to be made. type: string minLength: 0 maxLength: 20 guestName: description: Name of the guest to whom posting is done. type: string minLength: 0 maxLength: 80 passerByName: description: Name of the passer by customer to whom posting is to be done. type: string minLength: 0 maxLength: 80 cashierId: description: The Cashier who is posting. $ref: '#/components/schemas/cashierId' cashierTransactionType: type: object description: Cashier Shift Transaction Type. properties: transactionCode: description: Transaction code. type: string minLength: 0 maxLength: 20 description: description: Transaction codes description which will be populated for summary elements only. type: string minLength: 0 maxLength: 2000 amount: description: Transaction amount and currency. $ref: '#/components/schemas/currencyAmountType_2' trxCount: description: Number of same transactions during a shift. type: integer batchAutoCheckoutDetails: type: object description: Response for batch auto check out. properties: processId: description: Batch process identifier. $ref: '#/components/schemas/stringLength40' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' checkDetails: type: object description: Response object to Fetch the check details for a given posting posted through the POS. properties: checkDetailsInfo: description: Response flag whether the instructions overlaps or not. $ref: '#/components/schemas/stringLength32000' checkImageInfo: description: Response of guest check Image details in encoded format. type: string format: byte checkNumber: description: Indicates the Cheque number. $ref: '#/components/schemas/stringLength200' checkDate: description: Indicates the Cheque date. type: string format: date links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' packagePostingType: type: object description: Posting details. properties: referenceTransactionNo: description: Generate transaction number for the Posting. type: number remark: description: Posting remarks. type: string minLength: 0 maxLength: 2000 reference: description: User-defined posting reference. type: string minLength: 0 maxLength: 2000 checkNo: description: Check number for the posting. type: string minLength: 0 maxLength: 2000 checkCount: description: Check number count for the posting. type: string minLength: 0 maxLength: 2000 postedAmount: description: Actual currency amount posted. $ref: '#/components/schemas/currencyAmountType_2' price: description: Indicates the unit price of the consumption. $ref: '#/components/schemas/currencyAmountType_2' quantity: description: Indicates Quantity. type: number transactionType: description: This is the transaction type which says whether it is a Consumption(C), Payment (FC) or Package (PK) and it is inherited from transaction code. $ref: '#/components/schemas/cashieringTransactionTypeType' creditAmount: description: The amount posted as credit to the ledger. $ref: '#/components/schemas/currencyAmountType_2' debitAmount: description: The amount posted as debit to the ledger. $ref: '#/components/schemas/currencyAmountType_2' articleCode: description: Information regarding the Article(Using Articles Functionality) of this transaction. type: string minLength: 0 maxLength: 20 cashierInfo: $ref: '#/components/schemas/cashierInfoType' paidOut: description: Indicates if this transaction is a paid out transaction. type: boolean arrangementCode: description: Corrected arrangement code from the package associated to this transaction. type: string minLength: 0 maxLength: 20 groupTypeInfo: description: Information related to transaction grouping. $ref: '#/components/schemas/postingGroupType' rateCode: description: Rate code associated to this transaction. type: string minLength: 0 maxLength: 20 compRedemptionCode: description: Comp redemption code assiciated to the transaction. type: string minLength: 0 maxLength: 20 updateInfo: description: Update info associated to this transaction. type: object properties: updateDate: type: string format: date maxLength: 8 updateBy: type: string fbaCertificate: description: Flag indicates that the posting is Flexible Benefits Awards Certificate type: boolean taxInvoiceNo: description: Tax invoice number generated by payment tax. type: string minLength: 0 maxLength: 20 serviceRecovery: description: Flag to indicates service recovery type: boolean compPostingsInfo: description: Comp Postings information for the folio. $ref: '#/components/schemas/compPostingsType' financialTransactionIdList: description: Collection of unique identifiers of the financial transactions. $ref: '#/components/schemas/uniqueIDListType' exchange: description: Available when the Fetch Folio Search Type requests the amounts to be converted to a currency different from the Resort currency. $ref: '#/components/schemas/exchangeAmounts' approvalCode: description: Approval code of the posting. type: string minLength: 0 maxLength: 20 approvalStatus: description: Approval status of the posting. type: string minLength: 0 maxLength: 20 stampDuty: description: Flag to identify a Stamp Duty Transaction. type: boolean customCharge: description: Flag to identify a Custom Charge. type: boolean transactionNo: description: Unique Transaction Identifier. type: number transactionDate: description: Transaction Date. type: string format: date maxLength: 8 transactionCode: description: Billing Transaction Code. type: string minLength: 0 maxLength: 200 transactionDescription: description: Billing Transaction Description. type: string minLength: 0 maxLength: 2000 transactionAmount: description: The amount of the transaction. type: number postingDate: description: Date and time of posting. type: string format: date maxLength: 8 revenueDate: description: The date on which the transaction has its revenue effect. type: string format: date maxLength: 8 receiptNo: description: The receipt number of the transaction, if there is a receipt generated. type: number roundingDifferenceTrx: description: Indicator to determine if the posting was a posting for the Rounding Difference. type: boolean commissionable: description: Indicator to determine if the transaction is commissionable. type: boolean reversePaymentTransactionNo: description: Reverse payment transaction unique identifier. type: number canAdjustInvoice: description: Indicator to determine if the transaction can be adjusted. type: boolean depositTransactionId: description: Tax Service Accounting Codes used. type: string minLength: 0 maxLength: 40 packageAllowance: description: Package allowance. $ref: '#/components/schemas/currencyAmountType_2' overageAmount: description: Overage Amount. $ref: '#/components/schemas/currencyAmountType_2' fromRoom: description: Room number for linked reservation package allowance or consumption. type: string minLength: 0 maxLength: 20 packageCode: description: Package Code type: string minLength: 0 maxLength: 20 voidedFolio: type: object description: Response to the request for voiding a Guest Folio. properties: fiscalCreditBillFolio: description: Generated fiscal credit bill information. $ref: '#/components/schemas/folioWindowType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' depositDetailPostingsType: type: array description: List of Deposit Postings with details. maxItems: 4000 items: $ref: '#/components/schemas/depositDetailPostingType' ccSettlementCriteria: type: object description: Request object to change credit card settlement information. properties: hotelId: description: Hotel code. $ref: '#/components/schemas/codeType' creditCardSettlement: description: credit card settlement. $ref: '#/components/schemas/cCBatchSettlementType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' postCustomerVatStatus: type: object description: Response for the request to create a Customer Vat Folio. properties: folioWindow: description: Information regarding the new Customer Vat Folio created. type: array items: $ref: '#/components/schemas/folioWindowType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' 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 fiscalServiceType: type: object description: Generate Fiscal Folio Criteria type to be used for fiscal folio generation properties: fiscalTerminal: description: Applicable for Fiscal Terminal. The ID of the terminal where the fiscal device is connected. type: string minLength: 0 maxLength: 40 invoiceCurrencyCode: description: Fiscal Invoicing Currency code to be used by the Fiscal Service. type: string minLength: 0 maxLength: 20 instructions: description: Defines the action of the generate folio process. $ref: '#/components/schemas/fiscalFolioInstruction' folioQueueName: description: Folio Type , Queue name , Fiscal Flag to be used in folio generation This is a country requirement. $ref: '#/components/schemas/folioQueueType' folioSeqId: description: Fiscal Folio sequence ID stored in queue table. $ref: '#/components/schemas/uniqueID_Type' autoSettleCompFolios: type: object description: Request to auto settle comp folios. OPERA will reference the 'Default Comp Payment Method' setting to settle the folio if no authorizer AR account is associated with the folio. properties: criteria: description: Criteria to auto settle comp folios. $ref: '#/components/schemas/autoSettleCompFoliosCriteriaType' warnings: $ref: '#/components/schemas/warningsType' depositPostingsType: type: array description: A List of Deposit Payments. maxItems: 4000 items: $ref: '#/components/schemas/depositPostingType' folioWindowType: type: object description: A folio window view which holds the set of folios for a reservation. properties: revenue: description: Revenue amount of the window. $ref: '#/components/schemas/currencyAmountType_2' folioSplitInfo: description: Contains the folio split posting information. type: array maxItems: 4000 items: $ref: '#/components/schemas/folioSplitInfoType' payment: description: Payment amount of the window. $ref: '#/components/schemas/currencyAmountType_2' balance: description: Running balance of the window. $ref: '#/components/schemas/currencyAmountType_2' debitRevenue: description: Revenue debit amount of the window. $ref: '#/components/schemas/currencyAmountType_2' debitPayment: description: Payment debit amount of the window. $ref: '#/components/schemas/currencyAmountType_2' debitBalance: description: Running debit balance of the window. $ref: '#/components/schemas/currencyAmountType_2' exchange: description: Available when the Fetch Folio Search Type requests the amounts to be converted to a currency different from the Resort currency. $ref: '#/components/schemas/folioWindowExchangeAmounts' paymentMethod: description: Defined method of payment for this window. $ref: '#/components/schemas/reservationPaymentMethodType' payeeInfo: description: The window's configured payee information. $ref: '#/components/schemas/payeeInfoType' compAccountingInfo: description: Defined comp accounting configuration for this window $ref: '#/components/schemas/compAccountingType' 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 fiscalResponseType: description: Provides information which is used for fiscal response processing. $ref: '#/components/schemas/fiscalResponseType' fiscalFolioInstruction: description: Defines the action of the generate folio process. $ref: '#/components/schemas/fiscalFolioInstruction' folios: type: array maxItems: 4000 items: $ref: '#/components/schemas/folioType' vATOffsetAmount: description: VAT offset amount of the window. $ref: '#/components/schemas/currencyAmountType_2' serviceTypeInfo: description: Contains service type information associated with transaction code posted in folio window. $ref: '#/components/schemas/transactionServiceTypesType' fiscalInvoicingCurrencyInfo: description: Exchange Rate information selected to be used by the Fiscal Service. $ref: '#/components/schemas/exchangeRateInfoType' folioWindowNo: type: integer 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 emptyFolio: description: Flag to notify if the current folio has any postings. type: boolean emptyWindow: description: Flag to notify if the entire window has any postings. type: boolean officialBIRReceiptExists: description: Flag to indicate if an Official Receipt is generated for the folio window. Applicable only in the Philippines. type: boolean simpleFolio: description: This flag signifies that generated Folio is Normal or Simple Folio. Certain countries of the World mandate a simple folio when the invoice amount is less than defined threshold. type: boolean paymentsOnly: description: Flag to indicate the window has only payment transactions type: boolean billingSummary: description: Flag to notify if the current folio return summary postings. type: boolean 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 ackBIRReceiptExists: description: Flag to indicate if an Acknowledgement Receipt is generated for the folio window. Applicable only in the Philippines. type: boolean receiptNo: description: The receipt number of the transaction, if there is a receipt generated. type: number transactionNo: description: Unique Transaction Identifier. type: number taxFolioPostingExists: description: Indicates whether a folio window has Tax Folio transaction codes or not. type: boolean confidential: type: boolean description: Flag indicating a billing window (2-8) as confidential. Applied only when Confidential Billing Window Opera Control is active. linkReservationPackageAllowance: type: object description: Method to create package allowance link from a source reservation to the target reservation. properties: hotelId: description: Property code of the source and target reservations. $ref: '#/components/schemas/codeType' linkFromReservationId: description: Reservation Id which is the source reservation for creating package link. $ref: '#/components/schemas/uniqueID_Type' linkToReservationId: description: Reservation Id which is the target reservation for creating package link. $ref: '#/components/schemas/uniqueID_Type' consumeSharedAllowances: description: If set to TRUE, the source reservation contributes its allowance(s) to the linked allowance pool and is able to draw from the allowances of the target reservation and/or any other source rooms linked to the target room. type: boolean links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' coversInfoType: type: object description: Type to provide the information related to covers based on the transaction code and date. properties: transactionCode: description: Unique transaction code. type: string minLength: 0 maxLength: 20 transactionDescription: description: Transaction description. type: string minLength: 0 maxLength: 2000 coversDate: description: Date on which needs to be searched for covers. type: string format: date revenueToday: description: Total revenue for the transaction code today type: number coversToday: description: Covers for current date i.e., Today. type: number minimum: 0 maximum: 4000 coversJournal: description: Journal of the covers posted. type: number minimum: 0 maximum: 8000 coversMtd: description: Covers posted from Month to Date. type: number minimum: 0 maximum: 16000 coversYtd: description: Covers posted from Year to Date. type: number minimum: 0 maximum: 64000 autoSettleCompFolioType: type: object description: Information about comp folio that was auto settled. properties: payeeId: description: Unique ID of payee. $ref: '#/components/schemas/uniqueID_Type' payeeName: description: Name of the payee. type: string minLength: 0 maxLength: 80 folioView: description: Comp folio window that was attempted to be auto settled. type: integer 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 folioSeqNo: description: Unique sequence number. Used to identify the current folio tax record. type: number trxSplitCriteriaType: type: object description: Criteria which should be used for Splitting a financial transaction which belongs to a reservation. properties: hotelId: description: Property code where the reservation transaction exists. type: string minLength: 0 maxLength: 20 transactionList: description: The unique transaction number of this transaction. type: array maxItems: 4000 items: type: number splitDetails: description: The criteria required for the transaction splitting. Splitting can be done either by an amount or by a percentage. Atleast one should be defined. type: object properties: amount: description: The Amount by which the transaction has to be split. $ref: '#/components/schemas/currencyAmountType_2' percentage: description: The percentage by which the transaction has to be split. type: number minimum: 0 maximum: 100 quantity: description: The quantity to split. This can be used only if the original quantity of the transaction(s) was > 1. type: integer cashierId: $ref: '#/components/schemas/cashierId' cashierTransactionsType: type: object description: Cashier Shift Totals and Per Hotel transactions group by transaction code properties: cashierInfo: description: Cashier ID and Closure No $ref: '#/components/schemas/cashierClosureNoType' summaryTransactionList: description: Summary of all transactions during Cashier Shift. type: array maxItems: 4000 items: $ref: '#/components/schemas/cashierTransactionType' hotelTransactionList: description: Hotel's transactions during Cashier Shift. type: array maxItems: 4000 items: $ref: '#/components/schemas/hotelCashierTransactionType' trxCodesInfo: description: Transaction codes information which are in response folio. $ref: '#/components/schemas/trxCodesInfoType' stagedCompTransactionsInfoType: type: array description: Transaction ID List of staged comp transactions for the reservation. maxItems: 4000 items: $ref: '#/components/schemas/uniqueIDListType' 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 prepaidCardTransactionsType: type: array description: Prepaid card transaction details. maxItems: 4000 items: $ref: '#/components/schemas/prepaidCardTransactionInfoType' depositPaymentCriteriaType: type: object description: Criteria for posting a deposit payment to a reservation. properties: hotelId: description: Property code. type: string minLength: 0 maxLength: 20 paymentMethod: description: Payment method used by the payee. $ref: '#/components/schemas/cashieringPaymentMethodType' postingAmount: description: Amount to post to the folio. $ref: '#/components/schemas/currencyAmountType_2' postingReference: description: User-defined posting reference. type: string minLength: 0 maxLength: 2000 postingRemark: description: User-defined posting remark. type: string minLength: 0 maxLength: 2000 comments: description: User Defined Comments. Used for Deposit Payment postings. type: string minLength: 0 maxLength: 2000 applyCCSurcharge: description: Flag to indicate if Credit Card Surcharge has to be applied to this payment, when the functionality for Credit Card Surcharge is available. type: boolean applyCashSurcharge: description: Flag to indicate if a cash surcharge amount can be included, when the functionality for Cash Surcharge is available. type: boolean manualPaymentTaxInfo: description: The Payment Tax information for Thailand Tax functionality. The invoice number and the date will be used. $ref: '#/components/schemas/paymentTaxType' creditablePaymentTaxes: description: Used for Thailand Tax Functionality.The payment tax records that can be used for a Credit Note for this reservation. $ref: '#/components/schemas/paymentTaxesType' terminalId: description: Applicable for chip and pin. The ID of the terminal where the chip and pin device is connected and where the payment is made. type: string overrideInsufficientCC: description: Flag to allow a rebate by Credit Card type: boolean changeDueAmount: description: Amount of change given to guest. $ref: '#/components/schemas/currencyAmountType_2' compRedemptions: description: Comp redemption information used to post as payment. $ref: '#/components/schemas/compRedemptionsType' overrideARCreditLimit: description: Flag to override account receivable credit limit type: boolean applyCurrencyTaxes: description: Flag to indidcate if currency taxes need to be applied or not. For ex, in case of Chile, it depends upon nationality of the guest. type: boolean vATOffset: description: Flag to indidcate if currency taxes need to be applied or not. For ex, in case of Chile, it depends upon nationality of the guest. type: boolean action: description: Payment action to know from where the payment has been made. $ref: '#/components/schemas/postPaymentActionType' prepaidCardRedemptions: description: Prepaid Card redemption information used to post as payment. $ref: '#/components/schemas/prepaidCardRedemptionsType' folioWindowNo: type: integer cashierId: $ref: '#/components/schemas/cashierId' reservationId: $ref: '#/components/schemas/reservationId' guaranteeCode: description: New guarantee code associated with reservation. type: string minLength: 0 maxLength: 20 depositPolicyId: description: The deposit policy ID. $ref: '#/components/schemas/uniqueID_Type' profileId: description: The Payee ID for the deposit. Used for some country requirements. $ref: '#/components/schemas/profileId' associatedTrxNo: description: Transaction number of the payment being deposited. type: number overrideInventoryCheck: description: Flag to indicate if the Inventory check has to be overridden when the guarantee code of the reservation is changed. type: boolean updateReservationPaymentMethod: description: Flag to indicate if the payment method on the reservation, for Window 1, is to be updated with the payment method used for this deposit. type: boolean receiptType: description: Receipt Type. $ref: '#/components/schemas/receiptType' generateFiscalPayload: description: Flag to indicate if a fiscal payload should be generated for the Payment. type: boolean fiscalTerminalId: description: Applicable for Fiscal Terminal. The ID of the terminal where the fiscal device is connected. type: string originalTransactionNo: description: The unique identifier (transaction number) of the original payment being refunded. type: number closeFolioCriteria: type: object description: Request to close an Open Folio Reservation. The Property should be using the Open Folio Functionality to use this operation. properties: criteria: description: Criteria for closing the folio. Property code and Reservation ID is required. $ref: '#/components/schemas/closeFolioCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' nameValueOriginType: type: object description: Contains origin details. properties: originName: description: Contains origin i.e. Reseravtion, Profile, Folio or FinTrx. $ref: '#/components/schemas/nameValueModuleType' destination: description: Contains destination column for Origin. type: string minLength: 0 maxLength: 200 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 folioTransferCriteriaType: type: object description: Folio(s) Transfer Criteria type to be used for folio transfer request. properties: hotelId: description: Property code. type: string minLength: 0 maxLength: 20 reservationId: description: Reservation id from where folio will be transfered. $ref: '#/components/schemas/reservationId' targetFolioWindowNo: description: Folio Window Number to where transactions will be transfered. type: integer folioList: description: List of folios to be transfered. type: array maxItems: 7 items: type: integer folioStyle: description: Folio style of the folios to be transferred. type: string minLength: 0 maxLength: 20 cashierId: $ref: '#/components/schemas/cashierId' transactionToSplit: type: object description: Request to split a transaction on a reservation. Splitting of transactions requires a list of transactions and a valid amount or a percentage by which the amount can be split. Based on parameters, certain transactions cannot be split. Transaction which are included in an invoice cannot be split Transactions where the generates resides elsewhere(reservation or window) cannot be split. Automatically generated transactions such as taxes, cannot be split by itself. Deposits which were part of a deposit folio cannot be split. After the split is done the transaction resides on the same folio window as the original transaction. properties: criteria: description: Transaction Split criteria. An Amount or a Percentage is required along with the transactions to split. $ref: '#/components/schemas/trxSplitCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' postingsInfoType: type: object description: This type is useful to hold the transaction details along the transaction code information. properties: transactions: description: The details regarding the transaction(Posting). $ref: '#/components/schemas/detailPostingsType' trxCodesInfo: description: Transaction codes information which are in response postings. $ref: '#/components/schemas/trxCodesInfoType' postBillingCheckChargesCriteriaType: type: object description: Details of the check with line item charges to post to a guest folio. properties: hotelId: description: Hotel code. type: string minLength: 0 maxLength: 20 checkNumber: description: Indicates the check number. type: string minLength: 0 maxLength: 200 revenueDate: description: The date against which charges are posted. type: string format: date maxLength: 8 reservationId: $ref: '#/components/schemas/reservationId' items: description: Line items of the check. $ref: '#/components/schemas/postBillingCheckChargesItemsCriteriaType' checkId: description: Unique identifier of this check in the partner system, applicable only if the charge is originated in a partner system. $ref: '#/components/schemas/uniqueID_Type' cashierId: description: Cashier Id of the Cashier. type: number profileRestrictions: type: object properties: reason: description: Restriction reason associated with the current profile. type: string minLength: 0 maxLength: 20 reasonDescription: description: Description of restriction reason associated with the current profile. type: string minLength: 0 maxLength: 2000 restricted: description: True indicates there are restrictions associated with the current profile. type: boolean 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 checkoutReservationType: type: object properties: hotelId: description: Property code. type: string minLength: 0 maxLength: 20 reservationIdList: $ref: '#/components/schemas/uniqueIDListType' eventType: description: Event to which this process will be logged. $ref: '#/components/schemas/cashieringEventType' checkoutInstr: $ref: '#/components/schemas/checkoutInstructionsType' mobileCheckoutFolioEmail: description: This is the email address used by the External System to email a folio. Opera will not use this as the default email address for the folio. This will be stored as a EFOLIO type email of the Guest and an applicable external folio flag will be updated on the reservation. $ref: '#/components/schemas/basicEmailType' checkoutWithOpenFolio: description: If the Property works with Open Folios and the reservation has the privileges for Post Stay Charging, this flag could be set to True which would checkout the guest without requiring the guest to settle his balances. type: boolean cashierId: $ref: '#/components/schemas/cashierId' mobileCheckout: description: This flag will be set to true if the reservation is checked out via mobility service. When the reservation is checked out through UI, this would be false. type: boolean autoCheckout: description: This flag will be set to true if the reservation is checked out via mobility service. When the reservation is checked out through UI, this would be false. type: boolean stopCheckout: description: Indicates Stop Checkout reservation Global Alert flag. type: boolean exchangeRateCalculationTaxType: type: object description: Detailed information about exchange rate calculation service tax. properties: percentageAppliedOn: description: Local currency amount the configured exchange service tax Percentage to be computed against. $ref: '#/components/schemas/currencyAmountType_2' baseAmount: description: Based Amount in local currency to be added on top of computed service tax based on Percentage. type: number percentage: description: Percentage to be multiplied to Percentage Applied On to get the service tax. type: number minServiceTax: description: Minimum service tax in local currency to be charged type: number maxServiceTax: description: Maximum service tax in local currency to be charged. type: number exchangeRateTransactionGenerateTaxes: description: Collection of exchange rate calculation tax information based on Transaction Code Generate. $ref: '#/components/schemas/exchangeRateTransactionGenerateTaxesType' transactionCodes: type: object description: Response that contains either the Transaction Code list if fetch was successful or error(s) if not. properties: trxCodes: description: List of TransactionCode. Contains information on Transaction Code, TransactionCode Description Its Group and Sub Group. $ref: '#/components/schemas/trxCodesPostingInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' calculatedForeignCurrency: type: object description: Information regarding charges in batch result for each reservation. properties: exchangeInfo: type: array items: $ref: '#/components/schemas/exchangeRateCalculationType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' voidFolioCriteriaType: type: object description: Criteria for Voiding a Folio. properties: hotelId: description: Property where the Folio exists which has to be voided. type: string minLength: 0 maxLength: 20 reservationId: description: Reservation to which the Folio belongs. $ref: '#/components/schemas/reservationId' fiscalFolioInfo: description: Generate Fiscal Folio Criteria type to be used for fiscal folio generation. $ref: '#/components/schemas/fiscalServiceType' associatedBillInfo: description: Bill Information of the original bill for which the Credit Bill is being generated . $ref: '#/components/schemas/associatedBillInfoType' 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 folioSeqNo: description: Unique sequence number. Used to identify the current folio tax record. type: number cashierId: $ref: '#/components/schemas/cashierId' fiscalCreditBillQueueName: description: Folio Queue name to generate a credit bill for fiscal service. type: string minLength: 0 maxLength: 2000 reason: description: The Reason Code and Reason Text which is required when a folio is voided. This input is mandatory when the parameter Void Bill Reason is active for Void Bills $ref: '#/components/schemas/folioReasonType' 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 cashierClosureAmountType: type: object description: Cashier Opening Balance and Shift Amounts type. properties: openingBalance: description: Cashier shift amounts type. type: number received: description: Receviced amount. type: number paidOut: description: Paid Out amount. type: number expectedShiftBalance: description: Expected Cashier shift amount. type: number actualShiftBalance: description: Actual Cashier shift amount. type: number ccAuthorizationCriteria: type: object description: Request for a credit card authorization. An authorization request will be sent to the Credit Card Vendor as part of this request. properties: criteria: description: Criteria for the credit card authorization. $ref: '#/components/schemas/cCAuthorizationCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' bedTaxCriteria: type: object description: Request type for change bed transaction info properties: bedTaxInfoType: description: bed transaction info. $ref: '#/components/schemas/bedTaxInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' customChargeQuantityType: type: object description: Contains quantity of custom charge exemptions. properties: quantity: description: Contains number of Custom Charge Exemption for a day. type: integer available: description: Indicates if Custom Charges Exemption information is editable. type: boolean guests: type: array description: List of guests. items: $ref: '#/components/schemas/customChargeGuestInfoType' packagePostingsType: type: array description: List of package postings. maxItems: 4000 items: $ref: '#/components/schemas/packagePostingType' reverseCertificatePostingsCriteriaType: type: object description: Criteria type for reversing certificate postings of transactions. properties: hotelId: description: Property code where the reservation transaction exists. type: string minLength: 0 maxLength: 20 reservationNameId: description: Reservation name id to which reverse certificate postings to be done. $ref: '#/components/schemas/uniqueID_Type' transactionList: description: The unique transaction number of this transaction. type: array maxItems: 4000 items: type: number reasonCode: description: The reason code for the deletion. type: string minLength: 0 maxLength: 20 cashierId: $ref: '#/components/schemas/cashierId' folioTypeNameInfoType: type: object description: Details of a Folio Type configuration. properties: hotelId: description: Property where the Folio Type exists. type: string minLength: 0 maxLength: 20 folioTypeName: description: The Folio Type. type: string minLength: 0 maxLength: 100 folioReportName: description: The report name which should be used as the Folio for printing. type: string minLength: 0 maxLength: 100 folioReportModuleId: description: The internal report ID of the Folio report which is to be used. $ref: '#/components/schemas/uniqueID_Type' folioLanguageCode: description: The Language Code for which the folio is effective. type: string minLength: 0 maxLength: 20 postingActivityDetailType: type: object description: Details of a Posting transaction change. properties: hotelId: type: string minLength: 0 maxLength: 20 reservationId: $ref: '#/components/schemas/reservationId' activity: description: Information of the Activity that changed the Posting transaction. $ref: '#/components/schemas/activityLogType' oldInfo: description: The original information prior to the change. $ref: '#/components/schemas/summaryPostingsType' newInfo: description: The new information after the change. $ref: '#/components/schemas/summaryPostingsType' cashieringTransactionTypeType: type: string description: Wrapper Transaction Type. enum: - Revenue - Payment - Wrapper earlyDeparture: type: object description: Request to change a reservation to an Early Departure. As part of this process the reservation will be changed to a Due Out status with the departure date being the current business date. Only Inhouse reservations can be changed to Early Departure. Before changing the reservation to early departure, rate restrictions on the rate code used and any allowances consumed by the guest for today will be checked. If there is a penalty applicable this can be posted to the reservation. properties: criteria: description: Criteria for changing a reservation to an early departure. As part of the criteria, flags can be sent to ignore any check on rate code restrictions, Tiered rate changes, post allowance consumed to guest account and post the early departure penalty if applicable, can be used to indicate the user preferences. $ref: '#/components/schemas/earlyDepartureCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' chargeCriteriaType: type: object description: Criteria information for posting a charge. properties: transactionCode: description: Transaction Code to post. type: string minLength: 0 maxLength: 20 articleCode: description: Article ID. type: string minLength: 0 maxLength: 20 price: description: Amount to post to the folio. $ref: '#/components/schemas/currencyAmountType_2' postingQuantity: description: Quantity to post to the folio. type: integer postingReference: description: User-defined posting reference. type: string minLength: 0 maxLength: 2000 postingRemark: description: User-defined posting remark. type: string minLength: 0 maxLength: 2000 checkNumber: description: Indicates the Cheque number. type: string minLength: 0 maxLength: 200 arrangementCode: description: Corrected arrangement code from the package associated to this transaction. type: string minLength: 0 maxLength: 20 applyRoutingInstructions: description: Apply room routing when making this posting. type: boolean incrementConsumableInvQty: description: When an article is posted with a negative quantity, this attribute can be used to indicate if we want to increase Quantity In Stock value for that consumable inventory item. type: boolean usePackageAllowance: description: Use the applicable package allowance when making this posting. type: boolean autoPosting: description: True indicates the Transaction Code is allowed to be posted automatically. type: boolean financialTransactionIdList: description: Collection of unique identifiers of the financial transactions. $ref: '#/components/schemas/uniqueIDListType' folioWindowNo: type: integer cashierId: $ref: '#/components/schemas/cashierId' covers: description: POS covers.Api will only accept numeric values for Covers and if decimal values are passed will be ignored and rounded type: string minLength: 0 maxLength: 10 marketCode: description: Market code type: string minLength: 0 maxLength: 20 sourceCode: description: Source of business type: string minLength: 0 maxLength: 20 paymentTax: type: string description: The types of Payment Tax transactions. enum: - Deposit - FrontOffice - CreditNote - CityLedger - AccountsReceivables - NonVat 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' otaTaxType: description: Open Travel Alliance(OTA) tax type for the given transaction code. type: string minLength: 0 maxLength: 20 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 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 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 billingChargesDetails: type: object description: Response notifying if the posting of a charge to a reservation was successful. properties: postings: description: List of Postings produced by Billing Charge Request. $ref: '#/components/schemas/summaryPostingsType' trxCodesInfo: description: Transaction codes information which are in response postings. $ref: '#/components/schemas/trxCodesInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' changeChargeCriteriaType: type: object properties: hotelId: description: Property code. type: string minLength: 0 maxLength: 20 transactionNo: description: Transaction number of the posting being corrected. type: number price: description: Corrected charge price. $ref: '#/components/schemas/currencyAmountType_2' quantity: description: Corrected posting quantity. type: integer reference: description: Corrected user-defined posting reference. type: string minLength: 0 maxLength: 2000 remark: description: Corrected user-defined posting remark. type: string minLength: 0 maxLength: 2000 checkNumber: description: Corrected Cheque number. type: string minLength: 0 maxLength: 200 revenueDate: description: Corrected Revenue Date. type: string format: date maxLength: 8 covers: description: POS covers type: string minLength: 0 maxLength: 10 arrangementCode: description: Corrected arrangement code from the package associated to this transaction. type: string minLength: 0 maxLength: 20 approvalCode: description: Approval code of the posting. type: string minLength: 0 maxLength: 20 approvalStatus: description: Approval status of the posting. type: string minLength: 0 maxLength: 20 approvalDate: description: Approval date of the posting. type: string format: date maxLength: 8 message: description: External message coming from the vendor that explains the status of transaction. type: string minLength: 0 maxLength: 200 cashierId: $ref: '#/components/schemas/cashierId' batchDeposit: type: object description: Request for submitting batch deposit for reservations. properties: batchDeposit: description: Information regarding the reservations for batch deposit processing. $ref: '#/components/schemas/batchDepositType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' roomRoutingPostings: type: object properties: postingsForRoomRouting: description: Transaction details along with the transaction code information. $ref: '#/components/schemas/postingsInfoType' warnings: $ref: '#/components/schemas/warningsType' 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 resAttachedProfileListType: type: array maxItems: 4000 items: $ref: '#/components/schemas/resAttachedProfileType' 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' postBillingCheckChargesItemCriteriaType: type: object description: Line item of check to post. properties: transactionCode: description: Transaction code to use for the posting. type: string minLength: 0 maxLength: 20 price: description: Amount to post. $ref: '#/components/schemas/currencyAmountType_2' postingRemark: description: Text describing any applicable detail of the posting. type: string minLength: 0 maxLength: 2000 generatePostingType: type: object description: Financial posting with their breakup properties: amount: description: Gross amount. $ref: '#/components/schemas/currencyAmountType_2' transactionNo: description: Transaction Number for which request is being submitted. type: number referenceTransactionNo: description: Generate transaction number for the Posting. type: number transactionCode: description: Unique identifier for the Transaction code. type: string minLength: 0 maxLength: 20 transactionDate: description: Transaction Date. type: string format: date maxLength: 8 folioSplitType: type: string description: Indicates the type of folio to be created on the window. enum: - TAXTRX - REVTRX advanceRoomChargesReservationInfo: type: object description: 'Response for the generate advance folio request. Post Advance Room Charges Request can return the below error codes : FOF00065 - Reservation ID or Resort was not supplied. FOF00147 - Reservation is currently not In-House. FOF00148 - Date range requested is not valid. FOF00149 - Advance Room Charges Posting was not completed successfully as there was an Error during posting. FOF00150 - Room Charges have already been posted for the requested dates. FOF00151 - Advance Room Charges could not be completed {the error message if any}.' properties: reservationInfo: description: Reservation id for which the advance bill information is requested. $ref: '#/components/schemas/advanceRoomChargesInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' paymentReversalCriteria: type: object description: Request for posting payment reversal. properties: payment: description: Information regarding the payment transaction to be reversed. $ref: '#/components/schemas/paymentReversalType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' givenNameType: type: string description: Given name, first name or names minLength: 0 maxLength: 40 prepaidCardsInfoType: type: array description: Prepaid card info object. maxItems: 4000 items: $ref: '#/components/schemas/prepaidCardInfoType' searchFiscalSupportingDocumentsRequest: type: object properties: surname: type: string description: Family name, last name. givenName: type: string description: Given name, first name or names. confirmationNo: type: string description: Confirmation number of the reservation. arrivalStartDate: type: string format: date description: The starting value of the date range. arrivalEndDate: type: string format: date description: The ending value of the date range. departureStartDate: type: string format: date description: The starting value of the date range. departureEndDate: type: string format: date description: The ending value of the date range. roomId: type: string description: Room number of the the transaction. documentType: type: array items: $ref: '#/components/schemas/fiscalSupportingDocumentTypeEnum' description: Supporting document type. documentNo: type: string description: Supporting document number. pendingDocumentsOnly: type: boolean description: Indicator to fetch only failed supporting documents, that were not sent successfully to the fiscal partner. fromCreateDateTime: type: string format: date-time description: Time stamp of the creation. limit: type: integer description: Indicates maximum number of records the API should return. Default is 50 offset: type: integer description: Index of the page being requested. If the index goes out of the bounds of the total set count, no data will be returned. default: 0 orderBy: type: array items: $ref: '#/components/schemas/orderByEnum' sortOrder: type: array items: $ref: '#/components/schemas/sortOrderEnum' default: - Desc fixedCharges: type: object description: Method to update fixed charges of a reservation. properties: hotelId: description: Hotel code of the reservation. $ref: '#/components/schemas/codeType' reservationId: description: Reservation Id for which the fixed charges need to be updated. $ref: '#/components/schemas/uniqueID_Type' fixedCharges: description: List of the fixed charges that should be updated. $ref: '#/components/schemas/fixedChargesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' 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 roomRoutingRefreshCriteriaType: type: object description: Criteria for refreshing the routing instruction set. properties: hotelId: description: Property code where the routing instruction set exists. type: string minLength: 0 maxLength: 20 resvNameId: description: Source reservation id of the routing instruction set. $ref: '#/components/schemas/uniqueID_Type' targetResvNameId: description: Target reservation id of the routing instruction set. $ref: '#/components/schemas/uniqueID_Type' originalTargetResvNameId: description: Old reservation id of the routing instruction set after it is edited. $ref: '#/components/schemas/uniqueID_Type' status: description: List of transaction number for which the details are required. $ref: '#/components/schemas/routingInstructionStatusType' fromBothResvs: description: Flag to indicate whether to fetch transaction from both reservations. type: boolean transactions: description: Unique Transaction Number of the transaction(posting) which need to be transferred. type: array maxItems: 4000 items: type: number instructions: description: Set of routing instructions associated to this routing type. $ref: '#/components/schemas/routingInstructionType' checkoutInstructionsType: type: object properties: roomStatus: description: Housekeeping Status to be assigned to the room after checkout. type: string minLength: 0 maxLength: 40 scheduleOn: description: Date and time for scheduled check out which could be performed when SCHEDULED CHECKOUT is active. Room status will be assigned according to SCHEDULED CHECKOUT ROOM STATUS parameter value. type: string format: date-time guestPreferredCurrency: description: Currency Code which the Guest preferred to use and to be stored on the reservation of the Guest. type: string minLength: 0 maxLength: 20 ignoreWarnings: description: Dictates whether to ignore warnings before check out. type: boolean 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_2' totalPayment: description: Total payment received for the reservation. $ref: '#/components/schemas/currencyAmountType_2' roomRevenue: description: Room Revenue generated by the reservation. $ref: '#/components/schemas/currencyAmountType_2' foodAndBevRevenue: description: Food and Beverage Revenue generated by the reservation. $ref: '#/components/schemas/currencyAmountType_2' otherRevenue: description: Other Revenue generated by the reservation. $ref: '#/components/schemas/currencyAmountType_2' nonRevenue: description: Total Non Revenue posted on the reservation. $ref: '#/components/schemas/currencyAmountType_2' totalRevenue: description: Total Revenue generated by the reservation. $ref: '#/components/schemas/currencyAmountType_2' balance: description: Balance amount on the reservation. $ref: '#/components/schemas/currencyAmountType_2' compBalance: description: Comp Balance amount $ref: '#/components/schemas/currencyAmountType_2' originalReservationInfo: type: object description: Original Reservation Information properties: originalRoomNumber: description: Room number of the original reservation the posting was made to. type: string minLength: 0 maxLength: 20 originalGuestFirstName: description: First name of the guest of the original reservation the posting was made to. type: string minLength: 0 maxLength: 80 originalGuestLastName: description: Last name of the guest of the original reservation the posting was made to. type: string minLength: 0 maxLength: 80 originalReservationId: description: Reservation id of the original reservation the posting was made to. type: string minLength: 0 maxLength: 80 originalConfirmationNumber: description: Confirmation Number of the original reservation the posting was made to. type: string minLength: 0 maxLength: 50 customChargeExemptionDateType: type: object description: Contains Custom Charge Exemption information for a day. properties: date: description: Contains Custom Charge Exemption date. type: string format: date maxLength: 8 quantity: description: Contains number of Custom Charge Exemption for a day. type: integer guests: type: array description: List of guests. items: $ref: '#/components/schemas/customChargeGuestInfoType' supportingDocumentType: type: object description: Supporting document details. properties: hotelId: description: Unique ID of the hotel type: string documentDate: description: Supporting document creation date. type: string format: date maxLength: 8 documentNo: description: Supporting document number. type: integer documentType: description: Supporting document type. $ref: '#/components/schemas/fiscalSupportingDocumentType' documentCategory: description: Supporting document category. $ref: '#/components/schemas/fiscalSupportingDocumentCategory' fiscalStatus: description: OPERA Fiscal status. type: string roomId: description: Room number of the reservation. type: string minLength: 0 maxLength: 20 confirmationNo: description: Confirmation number of the reservation. type: string minLength: 0 maxLength: 50 fullName: description: String representation of the full name type: string createDateTime: description: Time stamp of the creation. type: string format: date-time lastModifyDateTime: description: Time stamp of last modification. type: string format: date-time resvNameId: description: Reservation Name ID. type: string profileId: description: Unique ID of the profile. type: string profileType: description: Type of profile such as Guest, Agent, Company, Group, Source, Employee, Hotel, Vendor or Contact. $ref: '#/components/schemas/nameTypeType' reportModuleId: description: The internal report ID of the Folio report which is to be used. type: string documentRefId: description: The internal reference ID of the document type. type: string authorizerCreditDetailType: type: object description: Information about the Authorizer Credit detail properties: creditLimit: description: Indicates the Credit Limit of the Authorizers. $ref: '#/components/schemas/currencyAmountType_2' actualAmount: description: Indicates the Actual Amount which has been authorized. $ref: '#/components/schemas/currencyAmountType_2' billingInstruction: description: Indicates the Routing Instructions for which Authorization was done. type: string minLength: 0 maxLength: 2000 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 redeemPrepaidCards: type: object description: Request type for Prepaid card redeem amount request properties: criteria: description: Criteria for Prepaid card redeem request. $ref: '#/components/schemas/redeemPrepaidCardCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' amountEligible: description: List of eligible bill amounts for each folio. type: object properties: amountEligibleInfo: type: array description: Retrieves eligible amount details in order to post redemption on a reservation folio

OperationId: getEligibleBillAmount

maxItems: 4000 items: $ref: '#/components/schemas/awardFolioInfo' cashierReportPostingsInfo: type: object description: Response for fetching the Cashier report transactions. properties: postings: description: Transaction entries of the response. $ref: '#/components/schemas/detailPostingsType' transactionCodes: description: Set of Transaction Code results. $ref: '#/components/schemas/trxCodesInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' exclusionReasonType: type: string description: Custom Charge has already been Processed for this date within the reservation stay. enum: - NotConfigured - CustomChargeProcessed cashSurchargeInfoType: type: object description: Cash Surcharge Information type. Information regarding surcharge which can be applied to a payment. properties: percentage: description: The percentage on the payment amount which will be the Surcharge. type: number minimum: 0 maximum: 100 surchargeFlatAmount: description: The flat payment amount whoch will be the surcharge. $ref: '#/components/schemas/currencyAmountType_2' transactionCode: description: The Payment Transaction Code for which the Surcharge Applies. type: string minLength: 0 maxLength: 20 paymentMethod: description: The Payment Method for which the surcharge is applied. type: string minLength: 0 maxLength: 20 folioView: type: integer customerVatFolioCriteriaType: type: object description: Criteria for creating Customer Factura Vat Folio. properties: hotelId: description: Hotel code where this folio was generated type: string minLength: 0 maxLength: 20 fiscalFolioInfo: description: Generate Fiscal Folio Criteria type to be used for fiscal folio generation. $ref: '#/components/schemas/fiscalServiceType' originalFolio: description: Original Folio details. This is the folio for which a Customer Factura Vat is required. $ref: '#/components/schemas/folioType' cashierInfo: description: Cashier information of user $ref: '#/components/schemas/cashierInfoType' prepaidCardRedemptionType: type: object description: Redemption information. properties: cardNo: description: Prepaid card number. type: string minLength: 0 maxLength: 80 pin: description: Prepaid card number. type: string minLength: 0 maxLength: 80 interfaceId: description: The unique ID of the Interface. $ref: '#/components/schemas/uniqueID_Type' amount: description: The amount to redeem when posting a payment. $ref: '#/components/schemas/currencyAmountType_2' transactionCode: description: The associated redemption transaction code. type: string minLength: 0 maxLength: 20 reference: description: Additional information regarding the redemption. type: string minLength: 0 maxLength: 2000 postingActivityDetail: type: object description: Response to the request to get financial details for a Posting Activity. This will return the before and after values for the transactions which were changed. properties: details: description: The details of the changes made during the activity. $ref: '#/components/schemas/postingActivityDetailType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' searchFolioHistoryRequest: type: object properties: id: type: string 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. idContext: type: string description: Used to identify the source of the identifier (e.g., IATA, ABTA). type: type: string description: A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT). aR: type: boolean description: Indicates if search includes AR Folios. checkOut: type: boolean description: Indicates if search includes Check Out Folios. creditBill: type: boolean description: Indicates if search includes Credit Bill Folios. supplementalFolio: type: boolean description: Indicates if search includes Debit Bill Folios. includeAssociatedFolios: type: boolean description: Indicates if search result includes Associated Bills and is only applied when Folio History for a particular reservation (i.e. ReservationID has a value) is requested. noShow: type: boolean description: Indicates if search includes No Show Folios. offlineFolio: type: boolean description: Indicates if search includes Offline Folios. passerBy: type: boolean description: Indicates if search includes Passer By Folios. postIt: type: boolean description: Indicates if search includes Post-It Folios. videoCheckOut: type: boolean description: Indicates if search includes Video Check Out Folios. folioDate: type: string format: date description: The starting value of the date range. folioEndDate: type: string format: date description: The ending value of the date range. reservationIdId: type: string 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. reservationIdIdContext: type: string description: Used to identify the source of the identifier (e.g., IATA, ABTA). reservationIdType: type: string description: A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT). room: type: string description: Room Number to which this record applies. name: type: string description: Family name, last name or Company Name. firstName: type: string description: Given name, first name or names. creditCardNo: type: string description: Credit card number used. folioNo: type: string description: Folio Number. invoiceNo: type: number description: Invoice Number. addresseeName: type: string description: Addressee Name filter. Works with the Addressee Functionality. fiscalFolioNo: type: string description: Fiscal Folio Number filter. Works with the Fiscal Folio Number Functionality. code: type: array maxItems: 4000 items: type: string partnerFiscalFolioStatusCode: type: array maxItems: 4000 items: type: string customNumber: type: string description: Custom number 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 putBillingChargesStatus: type: object description: Response Body. properties: links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' deferredTaxesCriteriaType: type: object description: Contains criteria to post the deferred taxes for the given reservation. properties: hotelId: description: Property context of the reservations. type: string minLength: 0 maxLength: 20 reservationId: description: Unique identifier of a reservation. $ref: '#/components/schemas/reservationId' cashierId: description: Unique cashier identifier. $ref: '#/components/schemas/cashierId' refreshAlways: description: Configuring this flag to be TRUE will make the postDeferredTax job to be submitted always. type: boolean 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 fiscalFolioInstruction: type: string description: Action to generate Offline folio when no response is received from fiscal service. enum: - Retry - New - Void - Offline vaultTransaction: type: object description: Request to register the vault HTTP transaction. properties: httpTransactionMessage: $ref: '#/components/schemas/vaultHTTPTransactionMessageType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' linkedAllowanceReservationsInfoType: type: object description: List of reservation with linked package allowances. properties: hotelId: description: The resort code. type: string minLength: 0 maxLength: 20 sourceReservations: description: List of Package Allowance Source reservations. type: array maxItems: 4000 items: $ref: '#/components/schemas/linkedAllowanceReservationInfoType' targetReservation: description: Package Allowance Target reservation. $ref: '#/components/schemas/linkedAllowanceReservationInfoType' paymentReversalType: type: object description: Information regarding the payment transaction to be reversed. properties: hotelId: description: Hotel context of the transaction. type: string minLength: 0 maxLength: 20 transactionNo: description: Unique identifier of the transaction to be reversed. type: number reasonCode: description: The reason code for payment reversal. type: string minLength: 0 maxLength: 20 cashierId: $ref: '#/components/schemas/cashierId' cashierClosureDetails: type: object description: Response for the fetch Cashier Closure information. properties: cashierClosureInfo: description: Cashier shift amounts group by resort and currency. $ref: '#/components/schemas/cashierClosureType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' cashierClosureCurrencyAmountType: type: object description: Cashier Shift Currency Amount type - cash ,check ,credit and others elements. properties: cash: description: Cash amounts for the currency. $ref: '#/components/schemas/cashierClosureAmountType' check: description: Check amounts for the currency. $ref: '#/components/schemas/cashierClosureAmountType' creditCard: description: Credit card amounts for the currency. $ref: '#/components/schemas/cashierClosureAmountType' others: description: Other amounts for the currency. $ref: '#/components/schemas/cashierClosureAmountType' currencyCode: description: The Currency Code. type: string minLength: 3 maxLength: 3 storedFolioDetailsType: type: object description: Stored Folio Details type.Folio can be printed/viewed without re-generation. properties: folioReportURL: description: Folio Report URL. type: string minLength: 0 maxLength: 32000 hotelId: description: Hotel code. type: string minLength: 0 maxLength: 20 storedFolioId: description: ID of the Stored Folio. $ref: '#/components/schemas/uniqueID_Type' storedFolioFileName: description: Name of the Stored Folio file. type: string minLength: 0 maxLength: 2000 reportStatus: description: Report status. Report status can be Success $ref: '#/components/schemas/statusType' statusType: type: string description: Status of the batch process. enum: - Success - Error - Running - Stopped - Warning - Failed - Started - CompletedWithLogs compRoutingRequestType: type: object description: Type for the details of a Comp Routing Request properties: requestedBy: description: User who requested the Comp Routing $ref: '#/components/schemas/userInfoType' comments: type: string minLength: 0 maxLength: 2000 declinedBy: description: User information of user who declined comp routing request $ref: '#/components/schemas/userInfoType' status: description: Comp routing status $ref: '#/components/schemas/compRoutingStatusType' bedTaxInfo: type: object description: Response for bed transaction info properties: bedTaxInfoTypes: description: Criteria for bed transaction info. $ref: '#/components/schemas/bedTaxInfoTypes' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' excludedDatesType: type: array description: Contains list of dates which are valid for custom charge exemptions. maxItems: 4000 items: $ref: '#/components/schemas/excludedDateType' 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 exchangeRateInfoType: type: object description: Exchange rate information of a currency. properties: exchangeRate: description: Description of exchange rate. type: number currencyCode: description: Description of currency Code. type: string minLength: 0 maxLength: 20 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_2' paymentMethod: description: Payment Method Type type: string minLength: 0 maxLength: 20 folioWindowNo: type: integer advanceRoomChargesInfoType: type: object properties: availablePostingDates: description: The Time Span for which the Advance Room Charges can be done. $ref: '#/components/schemas/timeSpanType' reservation: description: Reservation id for which the advance bill information is requested. $ref: '#/components/schemas/reservationInfoType' generatedForEntireStay: description: Indicates if the advance folio has been generated for the entire stay. type: boolean lastRoomAndTaxPostedDate: description: Indicates the date of the stay until which the advance bill has been generated . type: string format: date maxLength: 8 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. Refer to OpenTravel Code List Unique ID Type (UIT). 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. Refer to OpenTravel Code List Unique ID Type (UIT). 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 convertFolioType: type: object description: Criteria for Converting Folio. properties: hotelId: description: Hotel code where this folio was generated at. type: string minLength: 0 maxLength: 20 folioNo: description: Folio number of the Folio which is going to be converted. type: number folioTypeName: description: 'Folio Type of the folio(Example: Ricevuta, Fattura).' type: string minLength: 0 maxLength: 100 folioDate: description: Date of folio generation. type: string format: date maxLength: 8 cashierId: $ref: '#/components/schemas/cashierId' customNameValueConfigType: type: string description: Italian Lottery Number. enum: - ItalianFattura - Folio - FinancialTransaction - TaiwanInvoice - SaudiCustomerType - ItalianLotteryNumber createProformaCriteriaType: type: object description: Criteria for creating Proforma transactions for a reservation. These transactions will be used by the Opera Proforma Report. properties: hotelId: description: Property code. type: string minLength: 0 maxLength: 20 reservationIdList: description: Reservation id for which the Proforma has to be created. $ref: '#/components/schemas/reservationIdList' responseInstruction: description: Response instructions for the Proforma transactions creation. Possible values are None or Folio Summary. A Summary of the Proforma Folio can be returned, if requested. $ref: '#/components/schemas/proformaResponseInstructionType' advancePaymentBalance: type: object description: Response for the advance payment balance. properties: paymentBalance: description: Advance payment balance. $ref: '#/components/schemas/currencyAmountType_2' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' cashOutPrepaidCardStatus: type: object properties: links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' 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' billingInstructionsType: type: array description: Set of Billing Instruction codes. maxItems: 4000 items: $ref: '#/components/schemas/billingInstructionType' batchAutoSettlementCriteria: type: object description: Request type for batch auto settlement. properties: criteria: description: Criteria for batch auto settlement. $ref: '#/components/schemas/autoSettlementType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' exchangeRateTransactionGenerateTaxType: type: object description: Tax information based on Transaction Code Generate. properties: code: description: Transaction Code Generate description. type: string minLength: 0 maxLength: 20 description: description: Transaction Code Generate description. type: string taxAmount: description: Tax amount based on Transaction Code Generate configuration. $ref: '#/components/schemas/currencyAmountType_2' 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 depositPolicyType: type: object description: Used to define the deposit policy, guarantees policy, and/or accepted forms of payment. properties: amountPercent: description: Payment expressed as a fixed amount, or a percentage of/or room nights. $ref: '#/components/schemas/policyAmountPercentType' deadline: description: Payment deadline, absolute or relative. $ref: '#/components/schemas/policyDeadlineType' description: description: Text description of the Payment in a given language. type: string minLength: 0 maxLength: 2000 depositReceiptNo: description: Receipt number associated with the deposit policy type: integer transactionDate: description: Transaction Date associated with the deposit policy type: string format: date maxLength: 8 depositReqReversed: description: Flag to indicate if deposit policy is reversed type: boolean formattedRule: description: Formatted Text Rule of the deposit policy. type: string minLength: 0 maxLength: 2000 typeOfCharges: description: Defines if the deposit amount is calculated based on Room Charges, Catering Charges or both $ref: '#/components/schemas/depositCancelRevenueType' policyCode: description: Deposit Policy Code type: string minLength: 0 maxLength: 20 manual: description: Flag to indicate if the cancellation policy is manual. type: boolean commissionPayoutToType: type: string enum: - TravelAgent - Source - TravelAgentSource - None folioActivityDetailsType: type: object description: Fiscal Folio Activity information properties: folioActivityDetailInfo: type: array description: Details of Fiscal Folio Activity made. maxItems: 4000 items: $ref: '#/components/schemas/folioActivityDetailType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' childAgesType: type: array description: Age of a child in years. maxItems: 4000 items: $ref: '#/components/schemas/childAgeType' projectedRevenueType: type: object description: Information about projected catering and room revenue for the reservation. properties: projectedRoomRevenue: description: Projected room revenue for the reservation $ref: '#/components/schemas/currencyAmountType_2' projectedCateringRevenue: description: Projected catering revenue for the reservation. $ref: '#/components/schemas/currencyAmountType_2' roomNights: description: Number of room nights for the reservation. type: integer advanceRoomCharges: type: object description: Request to post the Room Charges for a reservation in advance. This request posts the Room Charges for a reservation for tonight or for many nights starting from the last posted night. This can also be used to verify if the reservation has already been charged for the full stay. Setting the Verify flag will return details regarding the last Room Charge posted date and if there are any available dates for which the room charges can be posted in advance. Room Charges cannot be posted for dates prior to the business date of the resort. To make the actual posting, the verification flag should be false. properties: criteria: description: Criteria for creating the advance folio. Includes information regarding the reservation(s) for which the advance bill is to be generated and the nights for which the postings have to be created. $ref: '#/components/schemas/advanceRoomChargesCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' postingBreakdownType: type: object description: Details of a financial posting's breakdown. properties: grossAmount: description: Gross amount of posting. $ref: '#/components/schemas/currencyAmountType_2' netAmount: description: Net amount of posting. $ref: '#/components/schemas/currencyAmountType_2' taxes: type: array description: Taxes breakout associated to postings maxItems: 4000 items: $ref: '#/components/schemas/generatePostingType' routingInstructions: type: object description: Request to create a routing instruction. properties: criteria: description: Reservation routing criteria defining the routing information to be created. $ref: '#/components/schemas/resvRoutingCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' compRoutingStatusEnum: type: string enum: - Request - Comp - Declined nameValueBaseSearchType: type: object description: Contains name value information search criteria. properties: hotelId: description: Specifies the hotel code. type: string minLength: 0 maxLength: 20 moduleName: description: Contains model name i.e. Reservation, Profile, Folio or FinTrx. $ref: '#/components/schemas/nameValueModuleType' nameValueType: description: Contains name value type value i.e. AFTER_SETTLEMENT, BEFORE_SETTLEMENT, RESERVATION, etc. $ref: '#/components/schemas/nameValueTypeType' sequence: description: Indicates configuration sequence number. $ref: '#/components/schemas/uniqueID_Type' configName: description: Custom Name value Config Name. $ref: '#/components/schemas/customNameValueConfigType' 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 backToBackResSequenceType: type: object description: Type object represents Back To Back Sequence Position and Total Count of Linked Back To Back Reservations ordered by consecutive Stay Dates. properties: position: description: Indicates the Sequence position of Back to Back Reservation. type: integer totalCount: description: Indicates the total count of Back To Back Reservations in the group of Linked Reservations. type: integer creditBillCriteriaType: type: object description: Criteria for posting the Credit Bill. Includes charges and payments. properties: hotelId: description: Property where the charges are to be posted. type: string minLength: 0 maxLength: 20 charges: description: Information regarding the charges which have to be posted. $ref: '#/components/schemas/chargesCriteriaType' payments: description: The payment information to be posted. type: array maxItems: 4000 items: $ref: '#/components/schemas/paymentCriteriaType' fiscalFolioInfo: description: Generate Fiscal Folio Criteria type to be used for fiscal folio generation. $ref: '#/components/schemas/fiscalServiceType' incomeAuditDate: description: Date of the Audit. This is used when postings are being created using the Income Audit functionality. type: string format: date maxLength: 8 fiscalTerminalId: description: Applicable for Fiscal Terminal. The ID of the terminal where the fiscal device is connected. type: string folioNameValue: description: Custom Folio Name Value Informatoin to be saved type: array maxItems: 4000 items: $ref: '#/components/schemas/nameValueHeaderDetailType' trxServiceType: description: Transaction service type which the Folio is being associated. type: string minLength: 0 maxLength: 20 cashierId: $ref: '#/components/schemas/cashierId' originalFolio: description: Original Folio details. This is the folio for which a Credit Bill is required. $ref: '#/components/schemas/folioType' fullCredit: description: Flag can be used when a Credit Bill is to be created for full set of transactions in the Original Bill. type: boolean reason: description: The Reason Code and Reason Text which is required when a folio is generated. This input is mandatory when the parameter Credit Bill Reason is active for Credit Bills $ref: '#/components/schemas/folioReasonType' unAssociatedCreditBill: description: Unassociated Credit Bill Details. This input is to generate a Credit Bill without having the original folio details in OPERA $ref: '#/components/schemas/unAssociatedCreditBillType' bulkPrepaidCardCriteria: type: object description: Request type for bulk prepaid card creation/reload/redeem/removal process properties: criteria: description: Criteria for creation/reload/redeem/removal of bulk prepaid cards. $ref: '#/components/schemas/bulkPrepaidCardCriteriaType' cardDetails: type: array description: List of card-specific details for creation/reload/redeem/removal of bulk prepaid cards. maxItems: 10 items: $ref: '#/components/schemas/bulkPrepaidCardDetailsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' ccBatchSettlementsStatus: type: object description: Response for credit card settlements status. properties: batchSettlementsStatus: description: List of credit card transaction. $ref: '#/components/schemas/cCBatchSettlementsStatusType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' fiscalSupportingDocumentType: type: string description: Fiscal Supporting Document Type enum: - InformationFolio - ProformaFolio - ConfirmationLetter reservationFolioWindowsType: type: array description: Collection of reservation folio windows. maxItems: 4000 items: $ref: '#/components/schemas/reservationFolioWindowType' prepaidCardTransactionType: type: object description: Prepaid Card transaction. properties: transactionType: description: Transaction type enumeration. $ref: '#/components/schemas/prepaidCardTrxTypeType' transactionDate: description: Transaction number of the Prepaid card transaction. type: string format: date maxLength: 8 transactionNo: description: Transaction number of the Prepaid card transaction. type: number amount: description: Prepaid Card Amount. $ref: '#/components/schemas/currencyAmountType_2' 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 activatePrepaidCardStatus: type: object properties: links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' cashOutPrepaidCard: type: object description: Request type for cashout prepaid card. properties: criteria: description: Prepaid card criteria type used to perform manage operation on the card. type: object properties: hotelId: description: Hotel code. type: string minLength: 0 maxLength: 20 cardNo: description: Prepaid card number. type: string minLength: 0 maxLength: 80 interfaceId: description: The unique ID for the Interface. $ref: '#/components/schemas/uniqueID_Type' profileId: description: The guest name id associated to the card. $ref: '#/components/schemas/uniqueID_Type' reservationId: description: The reservation name id where the transaction is associated. $ref: '#/components/schemas/uniqueID_Type' pin: description: PIN code associated for the prepaid card. type: string minLength: 0 maxLength: 80 amount: description: Prepaid card transaction amount. $ref: '#/components/schemas/currencyAmountType_2' cashierId: $ref: '#/components/schemas/cashierId' postChargeToRoom: description: Indicate that charges will be posted to the room. type: boolean saleCriteria: description: Represent the sale criteria. $ref: '#/components/schemas/saleCriteriaType' warnings: $ref: '#/components/schemas/warningsType' resAccessRestrictionType: type: string description: Indicates any Updates/Changes on the reservation as well as Reservation Cancellation are not allowed. enum: - Change - Cancel - ChangeOrCancel billingCharges: type: object description: Request to post a charge on a reservation's folio. properties: criteria: description: Criteria for the charge information to be posted. $ref: '#/components/schemas/billingChargesCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' nameValuesType: type: array description: List of name value pairs. maxItems: 4000 items: $ref: '#/components/schemas/nameValueType' 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' depositDetailPostingType: type: object description: Posting information of the transaction . properties: referenceTransactionNo: description: Generate transaction number for the Posting. type: number remark: description: Posting remarks. type: string minLength: 0 maxLength: 2000 reference: description: User-defined posting reference. type: string minLength: 0 maxLength: 2000 checkNo: description: Check number for the posting. type: string minLength: 0 maxLength: 2000 checkCount: description: Check number count for the posting. type: string minLength: 0 maxLength: 2000 postedAmount: description: Actual currency amount posted. $ref: '#/components/schemas/currencyAmountType_2' price: description: Indicates the unit price of the consumption. $ref: '#/components/schemas/currencyAmountType_2' quantity: description: Indicates Quantity. type: number transactionType: description: This is the transaction type which says whether it is a Consumption(C), Payment (FC) or Package (PK) and it is inherited from transaction code. $ref: '#/components/schemas/cashieringTransactionTypeType' creditAmount: description: The amount posted as credit to the ledger. $ref: '#/components/schemas/currencyAmountType_2' debitAmount: description: The amount posted as debit to the ledger. $ref: '#/components/schemas/currencyAmountType_2' articleCode: description: Information regarding the Article(Using Articles Functionality) of this transaction. type: string minLength: 0 maxLength: 20 cashierInfo: $ref: '#/components/schemas/cashierInfoType' paidOut: description: Indicates if this transaction is a paid out transaction. type: boolean arrangementCode: description: Corrected arrangement code from the package associated to this transaction. type: string minLength: 0 maxLength: 20 groupTypeInfo: description: Information related to transaction grouping. $ref: '#/components/schemas/postingGroupType' rateCode: description: Rate code associated to this transaction. type: string minLength: 0 maxLength: 20 compRedemptionCode: description: Comp redemption code assiciated to the transaction. type: string minLength: 0 maxLength: 20 updateInfo: description: Update info associated to this transaction. type: object properties: updateDate: type: string format: date maxLength: 8 updateBy: type: string fbaCertificate: description: Flag indicates that the posting is Flexible Benefits Awards Certificate type: boolean taxInvoiceNo: description: Tax invoice number generated by payment tax. type: string minLength: 0 maxLength: 20 serviceRecovery: description: Flag to indicates service recovery type: boolean compPostingsInfo: description: Comp Postings information for the folio. $ref: '#/components/schemas/compPostingsType' financialTransactionIdList: description: Collection of unique identifiers of the financial transactions. $ref: '#/components/schemas/uniqueIDListType' exchange: description: Available when the Fetch Folio Search Type requests the amounts to be converted to a currency different from the Resort currency. $ref: '#/components/schemas/exchangeAmounts' approvalCode: description: Approval code of the posting. type: string minLength: 0 maxLength: 20 approvalStatus: description: Approval status of the posting. type: string minLength: 0 maxLength: 20 stampDuty: description: Flag to identify a Stamp Duty Transaction. type: boolean customCharge: description: Flag to identify a Custom Charge. type: boolean transactionNo: description: Unique Transaction Identifier. type: number transactionDate: description: Transaction Date. type: string format: date maxLength: 8 transactionCode: description: Billing Transaction Code. type: string minLength: 0 maxLength: 200 transactionDescription: description: Billing Transaction Description. type: string minLength: 0 maxLength: 2000 transactionAmount: description: The amount of the transaction. type: number postingDate: description: Date and time of posting. type: string format: date maxLength: 8 revenueDate: description: The date on which the transaction has its revenue effect. type: string format: date maxLength: 8 receiptNo: description: The receipt number of the transaction, if there is a receipt generated. type: number roundingDifferenceTrx: description: Indicator to determine if the posting was a posting for the Rounding Difference. type: boolean commissionable: description: Indicator to determine if the transaction is commissionable. type: boolean reversePaymentTransactionNo: description: Reverse payment transaction unique identifier. type: number canAdjustInvoice: description: Indicator to determine if the transaction can be adjusted. type: boolean depositTransactionId: description: Tax Service Accounting Codes used. type: string minLength: 0 maxLength: 40 depositPolicy: description: Deposit Policy information if this payment was applied to a deposit policy. $ref: '#/components/schemas/resDepositPolicyType' comments: description: User defined comments for the deposit. type: string minLength: 0 maxLength: 2000 paymentMethod: description: Defined method of payment for this transaction. $ref: '#/components/schemas/reservationPaymentMethodType' receiptSummaryInfo: description: Information regarding receipt of the posted deposit $ref: '#/components/schemas/receiptSummaryType' folioNo: description: The Folio number of this posting, if there was a Folio already generated. type: number transferred: description: Indicates if the deposit was transferred either to a reservation or from a reservation. type: boolean folioTypeName: description: The name of the Folio Type used for the Folio Number sequence. type: string minLength: 0 maxLength: 100 subPostings: description: SubPostings for the posting. $ref: '#/components/schemas/summaryPostingsType' currencyExchangeInfo: description: Currency exchange information if the posting was made using a currency different from the default currency. $ref: '#/components/schemas/transactionCurrencyExchangeInfoType' miscellaneousInfo: type: object properties: createDateTime: type: string format: date maxLength: 8 paidOut: type: boolean internalFolioWindowID: description: Internal Unique id for the Folio Window. type: string adjustedTransactions: type: object description: Response for the adjustment of transactions request. Contains any errors or warnings. properties: serviceRecoveryAdjustments: description: List of service recovery adjustment.This will only return if Adjust is service recovery type. $ref: '#/components/schemas/summaryPostingsType' trxCodesInfo: description: Transaction codes information which are in response postings. $ref: '#/components/schemas/trxCodesInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' proformaReservationFolio: type: object description: Request to create a Pro-Forma(folio) transactions for a reservation. The request generates the internal transactions required to create a Pro-Forma folio, pass it into the response and finally remove/cleanup these transactions. properties: criteria: description: Criteria to create a Proforma for a reservation. $ref: '#/components/schemas/createProformaFolioCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' foreignCurrencyCriteria: type: object description: Operation to calculate foreign currency exchange. properties: exchange: description: A set of currencies that need to be converted. type: array items: $ref: '#/components/schemas/exchangeRateCalculationType' addExchangeCommission: description: Flag to add exchange commission in order to recalculate payment amount in billing. type: boolean includeExchangeInformation: description: Flag to include exchange information text in response. type: boolean links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' nameValueHeaderDetailType: type: object description: Name value details collected before Folio Settlement properties: nameValueHeader: description: Name Value Header Information $ref: '#/components/schemas/nameValueBaseSearchType' nameValueDetails: description: Name Value Detail Information $ref: '#/components/schemas/nameValueDetailType' routingInfoType: type: object description: A routing info object can either be of type Folio OR of type Room with its corresponding object. properties: folio: description: Folio routing type. type: object properties: guestInfo: description: Guest details type: object properties: profileIdList: description: Unique identifiers for the Profile for both internal and external systems. $ref: '#/components/schemas/profileIdList' payeeInfo: $ref: '#/components/schemas/payeeInfoType' aRNumber: description: Accounts Receivable. type: string minLength: 0 maxLength: 20 instructions: description: Set of routing instructions associated to this routing type. type: array maxItems: 4000 items: $ref: '#/components/schemas/routingInstructionType' folioWindowNo: type: integer paymentMethod: type: string maxLength: 2000 room: description: Room routing type. type: object properties: roomId: description: Room number to route the instructions. type: string minLength: 0 maxLength: 20 guestNameId: description: Guest unique identifier to which the instruction will be routed. $ref: '#/components/schemas/uniqueID_Type' guestDisplayName: description: Display Name for the guest. type: string minLength: 0 maxLength: 80 reservationNameId: description: Reservation name id to which the instruction will be routed. $ref: '#/components/schemas/uniqueID_Type' instructions: description: Set of routing instructions associated to this routing type. type: array maxItems: 4000 items: $ref: '#/components/schemas/routingInstructionType' comp: description: Comp Accounting Routing Info type: object properties: compAccountingInfo: $ref: '#/components/schemas/compAccountingType' compRequestInfo: $ref: '#/components/schemas/compRoutingRequestType' payeeInfo: $ref: '#/components/schemas/payeeInfoType' instructions: description: Set of routing instructions associated to this routing type. type: array maxItems: 4000 items: $ref: '#/components/schemas/routingInstructionType' folioWindowNo: type: integer request: description: Comp Accounting Request routing type: object properties: compRequestInfo: $ref: '#/components/schemas/compRoutingRequestType' instructions: description: Set of routing instructions associated to this routing type. type: array maxItems: 4000 items: $ref: '#/components/schemas/routingInstructionType' refreshFolio: description: On a successful update, the transactions that are already posted in the guest's folio will be re-organized based on the configured instructions. type: boolean createProformaFolioCriteriaType: type: object description: Criteria for creating Pro-Forma transactions for a reservation. These transactions will be used by the Opera Proforma Report. properties: proformaResponseInstruction: description: Response instructions for the Pro-Forma transactions creation. Possible values are None or Folio Summary. A Summary of the Proforma Folio can be returned, if requested. $ref: '#/components/schemas/proformaFolioResponseInstructionType' bulkPrepaidCardCriteriaType: type: object description: Holds fixed charge information. properties: hotelId: description: Hotel context for the Reservations. type: string minLength: 0 maxLength: 20 reservationId: description: The unique ID of the reservation to which this record applies. $ref: '#/components/schemas/reservationId' name: description: Family name, last name or Company Name. type: string minLength: 0 maxLength: 80 firstName: description: Given name, first name or names. type: string minLength: 0 maxLength: 80 profileId: description: Card / Account holder name ID $ref: '#/components/schemas/profileId' interfaceId: description: The unique ID for the Interface. $ref: '#/components/schemas/uniqueID_Type' 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 postChargeToRoom: type: boolean saleCriteria: $ref: '#/components/schemas/saleCriteriaType' vendorInterfaceID: type: number cashierId: type: number giftCard: description: Indicates a gift card type. type: boolean alertsType: type: array description: List of alerts. maxItems: 4000 items: $ref: '#/components/schemas/alertType' 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 billingInstructionType: type: object description: Configured Billing Instruction which represents a set of Transaction Codes. properties: desc: description: Billing Instruction code description. type: string minLength: 0 maxLength: 2000 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 billingCode: description: Unique identifier for the Billing Instruction. type: string minLength: 0 maxLength: 20 hotelId: description: Hotel context of the Billing Instruction. type: string minLength: 0 maxLength: 20 adjustmentDetailsType: type: object description: Details regarding adjustments of transactions. Adjustment of transactions requires a amount/percentage and the adjustment reason. properties: amount: description: The Amount by which the transaction has to be adjusted. $ref: '#/components/schemas/currencyAmountType_2' percentage: description: The percentage by which the transaction has to be adjusted. type: number minimum: 0 maximum: 100 reasonCode: description: The reason code for the adjustment. type: string minLength: 0 maxLength: 20 reasonDescription: description: The reason text for the adjustment. type: string minLength: 0 maxLength: 2000 department: description: The department name or ID with which the adjustment is associated. type: string minLength: 0 maxLength: 20 generatedFolio: type: object description: 'Generate Folio Response contains generated folio no and invoice number along or errors and warnings in case if folio couldn''t be generated: FOF00065 - The hotel code and/or reservation id is missing. FOF00066 - Reservation cant be found with the supplied hotel code and reservation id. FOF00123 - Folio window has a balance and folio cannot be generated. FOF00124 - The guest''s reservation is not in a valid status for folio generation.' properties: folioWindows: description: Window count will be hotel based configurable. type: array items: $ref: '#/components/schemas/folioWindowType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' folioWindowExchangeAmounts: type: object description: Converted folio windows values for the Exchange Currency requested. properties: revenue: description: The converted Folio Window Revenue Amount. $ref: '#/components/schemas/currencyAmountType_2' payment: description: The converted Folio Window Payment Amount. $ref: '#/components/schemas/currencyAmountType_2' balance: description: The converted Folio Window Total Amount. $ref: '#/components/schemas/currencyAmountType_2' childBucketsType: type: object description: Defines children counts with Age Qualifying Group(Child Bucket) classification. properties: bucket1Count: description: Number of children classified under the first Age Qualifying Group(Child Bucket#1). type: integer bucket2Count: description: Number of children classified under the second Age Qualifying Group(Child Bucket#2). type: integer bucket3Count: description: Number of children classified under the third Age Qualifying Group(Child Bucket#3). type: integer bucket4Count: description: Number of children classified under the fourth Age Qualifying Group(Child Bucket#4). type: integer bucket5Count: description: Number of children classified under the fifth Age Qualifying Group(Child Bucket#5). type: integer 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' stringLength100: type: string description: Used for Character Strings, length 0 to 100. maxLength: 100 minLength: 0 vIPStatusType: type: object description: VIP status of the customer. properties: value: type: string description: Used for Character Strings, length 0 to 2000. minLength: 0 maxLength: 2000 code: description: VIP status of the customer. type: string minLength: 0 maxLength: 20 saleCriteriaType: type: object description: Criteria type for posting charges. properties: hotelId: description: Property where the charges are to be posted. type: string minLength: 0 maxLength: 20 charges: description: Information regarding the charges which have to be posted. $ref: '#/components/schemas/chargesCriteriaType' payments: description: The payment information to be posted. type: array maxItems: 4000 items: $ref: '#/components/schemas/paymentCriteriaType' fiscalFolioInfo: description: Generate Fiscal Folio Criteria type to be used for fiscal folio generation. $ref: '#/components/schemas/fiscalServiceType' incomeAuditDate: description: Date of the Audit. This is used when postings are being created using the Income Audit functionality. type: string format: date maxLength: 8 fiscalTerminalId: description: Applicable for Fiscal Terminal. The ID of the terminal where the fiscal device is connected. type: string folioNameValue: description: Custom Folio Name Value Informatoin to be saved type: array maxItems: 4000 items: $ref: '#/components/schemas/nameValueHeaderDetailType' trxServiceType: description: Transaction service type which the Folio is being associated. type: string minLength: 0 maxLength: 20 cashierId: $ref: '#/components/schemas/cashierId' reason: description: The Reason Code and Reason Text which is required when a folio is generated. This input is mandatory when the parameter Credit Bill Reason is active for Credit Bills $ref: '#/components/schemas/folioReasonType' simpleFolio: description: This flag signifies that the folio to be generated is Normal or Simple Folio. Certain countries of the World mandate a simple folio when the invoice amount is less than defined threshold. type: boolean 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' depositMaturityDetails: type: object description: Response object for deposit maturity information type. properties: depositMaturityInfo: description: Deposit Maturity Information type . $ref: '#/components/schemas/depositMaturityInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' activatePrepaidCard: type: object description: Request type for activate prepaid card. properties: criteria: description: Prepaid card criteria type used to perform manage operation on the card. type: object properties: hotelId: description: Hotel code. type: string minLength: 0 maxLength: 20 cardNo: description: Prepaid card number. type: string minLength: 0 maxLength: 80 interfaceId: description: The unique ID for the Interface. $ref: '#/components/schemas/uniqueID_Type' profileId: description: The guest name id associated to the card. $ref: '#/components/schemas/uniqueID_Type' reservationId: description: The reservation name id where the transaction is associated. $ref: '#/components/schemas/uniqueID_Type' pin: description: PIN code associated for the prepaid card. type: string minLength: 0 maxLength: 80 amount: description: Prepaid card transaction amount. $ref: '#/components/schemas/currencyAmountType_2' cashierId: $ref: '#/components/schemas/cashierId' postChargeToRoom: description: Indicate that charges will be posted to the room. type: boolean saleCriteria: description: Represent the sale criteria. $ref: '#/components/schemas/saleCriteriaType' giftCard: description: Indicates a gift card type. type: boolean warnings: $ref: '#/components/schemas/warningsType' compRedemptionsType: type: array description: Information regarding Complimentary Bucket Redemption object. maxItems: 4000 items: $ref: '#/components/schemas/redemptionType' postRateCodeCriteriaType: type: object description: Criteria type for posting a Rate Code amount to a guest folio. properties: hotelId: description: Hotel context for the Reservation. type: string minLength: 0 maxLength: 20 reservationId: description: Reservation e $ref: '#/components/schemas/reservationId' rateCode: description: The Rate Code which is to be posted on the Guest Folio. type: string minLength: 0 maxLength: 20 price: description: Price of the Rate Code. $ref: '#/components/schemas/currencyAmountType_2' quantity: description: Posting quantity. type: integer guestCounts: description: Holds the guest counts(adults or children) for posting the Rate Code to the reservation. $ref: '#/components/schemas/guestCountsType' remark: description: Posting remarks. type: string minLength: 0 maxLength: 2000 reference: description: User-defined posting reference. type: string minLength: 0 maxLength: 2000 checkNo: description: Check number for the posting. type: string minLength: 0 maxLength: 2000 nights: description: Number of nights to post the Rate Code for. Used for Comp Accounting. type: integer arrangementCode: description: Corrected arrangement code from the package associated to this transaction. type: string minLength: 0 maxLength: 20 adjustmentCode: description: Adjustment code to be used for the manual posting of rate code. type: string minLength: 0 maxLength: 20 revenueDate: description: Revenue Date or the business date of the posting. type: string format: date maxLength: 8 parentTrxNo: description: The linked transaction number for this Posting of Rate Code. type: number postProducts: description: Flag to indicate if Products(Packages) which are part of the Rate Code should be posted as part of this operation. If products are not required, the entire amount will be posted towards the room element of the Rate Code. type: boolean folioWindowNo: type: integer cashierId: description: The Cashier who is posting. $ref: '#/components/schemas/cashierId' folioActivityResponseDetailsType: type: object description: Details of response for the Fiscal Folio Activity made. properties: businessDate: description: Business Date. type: string format: date maxLength: 8 responseType: description: 'Type of the response, possible values: ERROR, WARNING, RESPONSE.' type: string responseName: description: Name of the response element. type: string responseValue: description: Value of the response element. type: string responseAttemptNo: description: Number of fiscal response attempt made for the folio type: integer folioType: type: object description: Represents a single page in a reservation's ledger which will contain transactions and payee information. properties: payeeInfo: description: Payee information for the folio. $ref: '#/components/schemas/payeeInfoType' postings: description: Postings for the folio view. $ref: '#/components/schemas/summaryPostingsType' folioAmount: description: Folio gross amount. $ref: '#/components/schemas/currencyAmountType_2' allowConvertFolioYn: description: Flag to check Folio Conversion Allowed. type: boolean 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 revisionNo: description: Folio Revison number. type: number 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 folioSeqNo: description: Unique sequence number. Used to identify the current folio tax record. type: number depositCreditBillCriteriaType: type: object description: The Deposit Credit Bill information. properties: hotelId: description: Property where the deposit is created. type: string minLength: 0 maxLength: 20 payments: description: The payment information to be posted. type: array maxItems: 4000 items: $ref: '#/components/schemas/paymentCriteriaType' cashierId: type: number description: The Cashier ID of the Cashier who is currently processing the transaction(s). reservationId: description: Reservation for which the Deposit Folio is created. $ref: '#/components/schemas/reservationId' paymentMethod: description: Payment method to update the reservation with, if the payment did not match. $ref: '#/components/schemas/reservationPaymentMethodType' originalFolio: description: Original Folio details. This is the folio for which a Credit Bill is required. $ref: '#/components/schemas/folioType' voidFolioModes: type: string description: Different modes to perform void folio. enum: - Invoice - InfoFolio - CreditFolio - DepositFolio - PostIt - PasserBy - VoidFolio - SupplementalFolio - SendFiscalFolio - ResendFolio resProfileTypeType: type: string enum: - Guest - Company - Group - TravelAgent - Source - ReservationContact - BillingContact - Addressee advanceRoomChargesCriteriaType: type: object description: Type to set the criteria for generation of advance folios. This will post the room and tax transactions for the nights requested. properties: hotelId: description: Property code. type: string minLength: 0 maxLength: 20 reservationIdList: description: Reservation id for which the advance bill will be generated. $ref: '#/components/schemas/reservationIdList' postForEntireStay: description: Indicates if the posting of room charges have to be done for the entire stay. type: boolean endDateToCharge: description: Indicates the last date until which the Advance Room Charges have to be posted. type: string format: date maxLength: 8 verifyOnly: description: 'Flag to indicate if only a verification is required. This checks if advance bills have been generated for this reservation and returns the last date in the response. Setting this flag to true, will return the information for the below elements in the response: AvailablePostingDates, GeneratedForEntireStay, LastRoomAndTaxPostedDate and the Reservation Information. No posting will be done. In order for the actual posting to occur this flag should be false.' type: boolean cashierId: $ref: '#/components/schemas/cashierId' eventType: description: Event to which this process will be logged. $ref: '#/components/schemas/cashieringEventType' codeListType: type: array maxItems: 4000 items: type: string minLength: 0 maxLength: 20 reservationVouchersType: type: object description: Vouchers information of a reservation. properties: vouchers: description: List of vouchers associated with the reservation. type: array maxItems: 2000 items: $ref: '#/components/schemas/reservationVoucherType' policyApplyCriteriaType: type: object description: Criteria for Attaching or Detaching a Deposit Policy towards a Deposit payment. properties: hotelId: description: Property where the deposit exists. type: string minLength: 0 maxLength: 20 policyId: description: Deposit Policy Id of the policy which would be attached to the payment. $ref: '#/components/schemas/uniqueID_Type' transactionNo: description: The transaction number of the payment to which the Deposit policy is being attached or detached. type: number customChargeExemptionsType: type: array description: List of Custom Charge Exemptions. maxItems: 4000 items: $ref: '#/components/schemas/customChargeExemptionType' customChargeExemptionType: type: object description: Contains custom charges exemption information. properties: customChargesExemption: description: Contains exemption code and description. $ref: '#/components/schemas/codeDescriptionType' customChargeQuantity: description: Contains exemption quantity for the stay. When this value is configured, daily exemption quantities are not permitted. $ref: '#/components/schemas/customChargeQuantityType' customChargeDates: description: Contains exemption detail information for each date. $ref: '#/components/schemas/customChargeExemptionDatesType' excludedDates: description: Contains list of dates which are not valid for custom charge exemptions. $ref: '#/components/schemas/excludedDatesType' percentage: description: Exemption Percentage type: number minimum: 0 maximum: 100 propertyExemption: description: Flag specifying if custom charge exemptions is property level or not. type: boolean billingCharge: type: object description: Request to edit a billing charge information. properties: criteria: description: Criteria for the charge information to be edited. $ref: '#/components/schemas/changeChargeCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' financialPostingsType: type: object description: Collection of Reservations and their information. properties: postings: $ref: '#/components/schemas/detailPostingsType' transactionCodes: description: Set of Transaction Codes configured in this time span. $ref: '#/components/schemas/trxCodesInfoType' totalDebit: description: Indicates the Total Sum of Journal Debits. $ref: '#/components/schemas/currencyAmountType_2' totalCredit: description: Indicates the Total Sum of Journal Credits. $ref: '#/components/schemas/currencyAmountType_2' overallTotal: description: Indicates the Total Sum of Journal entries in a page. $ref: '#/components/schemas/currencyAmountType_2' totalForAllPages: description: Indicates the Total Sum of all Journal entries in all pages. $ref: '#/components/schemas/currencyAmountType_2' totalEntriesCount: description: Indicates the number of journal entries. type: integer guestCheckDetails: type: object description: Request to process a guest check detail. properties: reservationId: description: Reservation Id for which the details need to be posted. $ref: '#/components/schemas/reservationId' checkDetails: description: Check details that needs to be posted. $ref: '#/components/schemas/checkDetailsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' coversInfo: type: object description: Response that contains either the Transaction Code list with Covers info if fetch was successful or error(s) if not. properties: coversInfo: description: List of TransactionCode. Contains information on Transaction Code with Covers Info. type: array maxItems: 4000 items: $ref: '#/components/schemas/coversInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' flexibleBenefitPostingsCriteria: type: object description: Apply Flexible Benefit Postings. properties: applyFlexibleBenefitCriteria: description: Criteria for reversing a Flexible Benefit Posting. $ref: '#/components/schemas/applyFlexibleBenefitPostingsCriteriaType' 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 compRoutingInstructions: type: object description: Response object containing comp routing instructions for a reservation . properties: resvRoutingInstructions: description: Set of Routing Instructions. $ref: '#/components/schemas/resvRoutingInfoListType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' reservationFolio: type: object description: Request to create a Proforma(folio) transactions for a reservation. The request generates the internal transactions required to create a Proforma report. After this request is called , the Opera Proforma report should be called so that these transactions can be used in the report. If the report is called without this request, the report will be incorrect and will not have the complete information. If the report is not used after this request, the internal transactions will be removed either by night audit or by the next request. properties: criteria: description: Criteria to create a Proforma for a reservation. $ref: '#/components/schemas/createProformaCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' 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' resDepositPolicyType: type: object description: A deposit policy attached with the reservation. properties: revenueType: description: Type of reservation. $ref: '#/components/schemas/depositCancelRevenueType' policy: description: Reservation deposit policy details. $ref: '#/components/schemas/depositPolicyType' comments: description: Comments attached with a deposit. type: string minLength: 0 maxLength: 2000 amountPaid: description: Total amount paid against the reservation deposit. $ref: '#/components/schemas/currencyAmountType_2' amountDue: description: Total amount due against the reservation deposit. $ref: '#/components/schemas/currencyAmountType_2' policyId: description: Unique ID of the Reservation Policy. $ref: '#/components/schemas/uniqueID_Type' 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 totalAmountRedeemed: description: Total amount that was redeemed so far through points. type: number expireDate: description: Indicates the end date of membership. type: string format: date nameOnCard: description: Name to be displayed on the membership card. type: string inactive: description: Indicates whether membership is active or inactive. type: boolean primaryMembership: description: Boolean indicator set to True indicates membership is a Primary Membership. type: boolean 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 reservationDepositCriteria: type: object description: Request object to process reservation deposit. properties: criteria: description: Criteria to process deposit reservation. $ref: '#/components/schemas/processReservationDepositCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' passerBySale: type: object description: Details of the folio created. properties: folioWindowDetails: type: array items: $ref: '#/components/schemas/folioWindowType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' chargeLongTrxCodeCriteriaType: type: object description: Criteria information for posting a charge. properties: transactionCode: description: Transaction Code to post. type: string minLength: 0 maxLength: 80 articleCode: description: Article ID. type: string minLength: 0 maxLength: 20 price: description: Amount to post to the folio. $ref: '#/components/schemas/currencyAmountType_2' postingQuantity: description: Quantity to post to the folio. type: integer postingReference: description: User-defined posting reference. type: string minLength: 0 maxLength: 2000 postingRemark: description: User-defined posting remark. type: string minLength: 0 maxLength: 2000 checkNumber: description: Indicates the Cheque number. type: string minLength: 0 maxLength: 200 arrangementCode: description: Corrected arrangement code from the package associated to this transaction. type: string minLength: 0 maxLength: 20 applyRoutingInstructions: description: Apply room routing when making this posting. type: boolean incrementConsumableInvQty: description: When an article is posted with a negative quantity, this attribute can be used to indicate if we want to increase Quantity In Stock value for that consumable inventory item. type: boolean usePackageAllowance: description: Use the applicable package allowance when making this posting. type: boolean autoPosting: description: True indicates the Transaction Code is allowed to be posted automatically. type: boolean financialTransactionIdList: description: Collection of unique identifiers of the financial transactions. $ref: '#/components/schemas/uniqueIDListType' folioWindowNo: type: integer cashierId: type: number covers: description: POS covers.Api will only accept numeric values for Covers and if decimal values are passed will be ignored and rounded type: string minLength: 0 maxLength: 10 billingPaymentToChange: type: object description: Request to change a payment posting. properties: criteria: description: Criteria for the payment information to be edited. $ref: '#/components/schemas/changePaymentCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' 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 payeeInternalFolio: description: Flag considered during folio settlement, to select the corresponding Folio Type when the value is true. Only used in Poland country mode. type: boolean blockIdList: type: array description: Unique Id that references an object uniquely in the system. maxItems: 4000 items: $ref: '#/components/schemas/uniqueID_Type' nameValueDataTypeType: type: string enum: - String - Number - Date - Datetime - Time - Integer guestsTransactions: type: object description: Lists a summary of transactions of guests. properties: reservationFolioInformation: description: Folio details for the requested reservation/s. type: array items: $ref: '#/components/schemas/reservationFolioInfoType' trxCodesInfo: description: Transaction codes information which are in response folio. $ref: '#/components/schemas/trxCodesInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' authorizationHistoryType: type: object description: Information on a single credit card authorization transaction. properties: businessDate: description: The corresponding business date for this record. type: string format: date maxLength: 8 transactionType: $ref: '#/components/schemas/cardAuthorizationTransactionType' approvalAmount: description: Amount sent for authorization for this transaction. $ref: '#/components/schemas/currencyAmountType_2' cardPaymentInformation: description: Payment Card information that was sent for authorization type: object properties: paymentCard: $ref: '#/components/schemas/resPaymentCardType' balance: $ref: '#/components/schemas/currencyAmountType_2' 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 status: description: Contains he authorization status indicator - either Successful for Failed. type: object properties: successful: description: An indicator that the authorization was successful. type: object properties: approvalCode: description: Approval code sent by the credit card company on a successful authorization. type: string minLength: 0 maxLength: 20 failed: description: An indicator that the authorization failed. type: object properties: reason: description: The reason for the authorization failure. type: string minLength: 0 maxLength: 2000 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 type: description: History type can only be either Settlement or Authorization or Payment or Refunds. type: string enum: - Settlement - Authorization - Payment - Refunds 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 reservationStatusCodeEnum: type: string enum: - Reserved - Requested - NoShow - Cancelled - InHouse - CheckedOut - Waitlisted - DueIn - DueOut - Walkin - PendingCheckout membershipType: type: object description: Detailed information of the memberships. properties: comment: description: Additional comments regarding to the membership. $ref: '#/components/schemas/paragraphType' newMembershipNumber: description: Card Number of the membership. type: string nameOnCard: description: Name to be displayed on the membership card. type: string programDescription: description: Description of the membership program. type: string membershipLevel: description: Indicates the membership level. type: string membershipLevelDescription: description: Indicates the membership level description. type: string minLength: 0 maxLength: 200 membershipClass: description: Indicates the membership class. type: string earningPreference: description: Earning preference to the membership. $ref: '#/components/schemas/membershipEarningPreferenceType' inactive: description: Indicates whether membership is active or inactive. type: boolean benefits: description: benefits for the membership. $ref: '#/components/schemas/benefitsType' tierAdministration: description: Defines the degree of participation for this membership in the tier management portion of the program. $ref: '#/components/schemas/tierAdministrationType' downgrade: description: Defines how downgrading will be handled for this membership. $ref: '#/components/schemas/downgradeType' reIssueNewCard: description: The status of issuing new membership card to the member. $ref: '#/components/schemas/cardReIssueType' excludeFromBatch: description: True if you want to exclude the member from the Membership Fulfillment extract,the member's actions will not be included in the fulfillment extract until this value set to false. type: boolean upgradeDescription: description: Indicates Upgrade information which includes member's next tier level, requirements for the next upgrade. type: string minLength: 0 maxLength: 32000 downgradeDescription: description: Indicates information regarding the member's possible downgrades. type: string minLength: 0 maxLength: 32000 rating: description: Value Rating Type Description for this membership. type: string membershipEnrollmentCode: description: Indicates how the guest enrolled in the program. type: string minLength: 0 maxLength: 20 memberStatus: description: Indicates where the guest is in the membership enrollment process. type: string minLength: 0 maxLength: 20 currentPoints: description: Profile MemberShip Points. type: number pointsLabel: description: Label used to refer to points for this membership type type: string minLength: 0 maxLength: 20 enrollmentSource: description: Source from where the enrollment is done. type: string minLength: 0 maxLength: 20 enrollmentResort: description: Resort/CRO where enrollment is done. type: string minLength: 0 maxLength: 20 preferredCard: description: Preferred Card. type: boolean membershipId: description: Card Number of the membership. type: string membershipType: description: Type of membership. type: string primaryMembershipYn: description: Indicator if Membership is a Primary Membership. type: string minLength: 0 maxLength: 1 primaryMembership: description: Boolean indicator set to True implies membership is a Primary Membership. type: boolean membershipIdNo: description: Membership ID Number. type: integer playerRanking: description: Ranking assigned to the Player Profile by the Gaming system. type: integer centralSetup: description: Indicates how the award points for this membership type will be managed. type: boolean signupDate: description: Indicates when the member signed up for the loyalty program. type: string format: date maxLength: 8 effectiveDate: description: Indicates the starting date. type: string format: date maxLength: 8 expireDate: description: Indicates the ending date. type: string format: date maxLength: 8 expireDateExclusiveIndicator: description: When true, indicates that the ExpireDate is the first day after the applicable period (e.g. when expire date is Oct 15 the last date of the period is Oct 14). 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 transactionAdjustmentInfoType: type: object description: Adjustment details of the transaction, if the transaction was created as part of an adjustment. properties: reason: description: Reason for the adjustment. type: string minLength: 0 maxLength: 2000 departmentCode: description: Department code for service recovery type: string minLength: 0 maxLength: 20 code: description: Adjustment code used. type: string minLength: 0 maxLength: 20 linkedAllowanceReservationInfoType: type: object description: Linked Allowance Reservation Information. properties: reservationId: description: Reservation name id which package allowances are linked. $ref: '#/components/schemas/reservationId' confirmationNo: description: Reservation confirmation number. type: string guestNameId: description: Guest name unique identifier. $ref: '#/components/schemas/uniqueID_Type' guestDisplayName: description: Display Name for the guest. type: string minLength: 0 maxLength: 80 roomId: description: Guest Room number. type: string minLength: 0 maxLength: 20 consumeSharedAllowances: description: Indicates that guest is allowed to consumed shared allowances from others. type: boolean fiscalSupportingDocumentCategory: description: Supporting document category. type: string enum: - Financial - Reservation welcomeOfferType: type: object properties: status: description: Determines the status of the welcome offer. type: string minLength: 0 maxLength: 20 type: description: Determines the welcome offer option selected while availing the welcome offer. $ref: '#/components/schemas/welcomeOfferOptionsType' cashieringPaymentMethodType: type: object properties: paymentCard: $ref: '#/components/schemas/resPaymentCardType' balance: $ref: '#/components/schemas/currencyAmountType_2' 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 authorizationApproval: description: Authorization approval record. $ref: '#/components/schemas/authorizationInfoType' track2Data: description: Track2 data for the card which would be sent to the CC vendor as part of the authorization. type: string minLength: 0 maxLength: 200 authorizationInfo: type: object description: Response to the credit card authorization request. properties: authInfo: description: Information regarding the authorization done. $ref: '#/components/schemas/authorizationInfoType' payment: description: Details of the payment card to which the authorization was applied. The payment details would be returned in the case of Chip and Pin cards. For non chip and pin cards, only the authorization will be returned. $ref: '#/components/schemas/cashieringPaymentMethodType' 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_2' totalStay: description: The total number of previous stay of the guest. type: integer maturedDepositsDetails: type: object description: Response of matured deposits. properties: maturedDeposits: description: Collection of matured deposits. $ref: '#/components/schemas/maturedDepositsType' 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 cCManualAuthorizationCriteriaType: type: object description: Type for registering a manual authorization. properties: hotelId: description: Hotel context for the Reservations. type: string minLength: 0 maxLength: 20 reservationIdList: description: Reservation id for the guest whose deposit payment information is being requested. $ref: '#/components/schemas/reservationIdList' amount: description: The amount to authorize. $ref: '#/components/schemas/currencyAmountType_2' manualApprovalCode: description: Approval code is required when making a Manual Authorization. type: string minLength: 0 maxLength: 20 folioView: description: The folio window where this authorization is applied. type: integer creditCardInfo: type: object description: Information on a credit card for the customer. properties: cardNumberMasked: type: string minLength: 10 maxLength: 80 cardNumberLast4Digits: type: string minLength: 0 maxLength: 80 expirationDateString: description: Expiration date in string representation. type: string minLength: 0 maxLength: 20 expirationDateMasked: description: Masked Expiration date of the credit card type: string minLength: 0 maxLength: 20 cardHolderName: type: string minLength: 0 maxLength: 200 cardType: description: Indicates the type of credit card from a defined list $ref: '#/components/schemas/cardTypeType' cardId: description: credit card id $ref: '#/components/schemas/uniqueID_Type' facilityCodesType: type: array description: List of the facility codes. maxItems: 4000 items: $ref: '#/components/schemas/facilityCodeType' postingSummaryList: type: object description: Response object to fetch daily summary charges from Opera which are posted in Opera by external system. properties: postingSummaries: description: List of Summary of total postings in Opera. $ref: '#/components/schemas/postingSummaryListType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' nameValueTypeType: type: string enum: - ReservationOptions - AfterSettlement - BeforeSettlement - AfterPayment - ProfileOptions sortOrderEnum: type: string enum: - Asc - Desc roundingDifferenceAmountType: type: object description: Information regarding the rounding difference which can be applied to the payment amount, based on the payment method. properties: hotelId: description: Property where the payment is being posted. type: string minLength: 0 maxLength: 20 amount: description: The amount for which the rounding is to be applied. $ref: '#/components/schemas/currencyAmountType_2' roundingDifference: description: The rounding difference amount. $ref: '#/components/schemas/currencyAmountType_2' personNameTypeType: type: string description: Person's name in an external system. enum: - Primary - Alternate - Incognito - External - Phonetic welcomeOfferOptionsType: type: string description: None of the Welcome Offer option is selected. enum: - BonusPoints - Ecoupons - Items - PostIt - NotSelected postedDepositCreditBill: type: object description: Response to the request to Deposit Credit Bill for a reservation. properties: folioWindow: description: Information regarding the Deposit Credit Bill. type: array items: $ref: '#/components/schemas/folioWindowType' payments: description: Deposit Credit payment information of the payment which was posted. $ref: '#/components/schemas/detailPostingsType' trxCodesInfo: description: Transaction codes information which are in response postings. $ref: '#/components/schemas/trxCodesInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' dateUDFsType: type: array description: Used to hold collection of user defined fields of Date Type. maxItems: 4000 items: $ref: '#/components/schemas/dateUDFType' 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 dateUDFType: type: object description: Used to hold user defined field of Date Type. properties: name: description: Used to hold user defined field of Date Type. It is highly recommended to use UDFD01, UDFD02,...UDFN20 (Total 20) as Date UDF names(commonly used on Reservation, Profile etc.). Name is not restricted using enumeration, to provide flexibility of different name usage if required. type: string minLength: 0 maxLength: 20 value: description: Value of user defined field. type: string format: date maxLength: 8 alternateName: description: Label of user defined field used by vendors or customers. type: string minLength: 0 maxLength: 2000 postSupplementalFolioStatus: type: object description: Response for the request to create Supplemental Folio. properties: folioWindow: description: Information regarding the new Supplemental Folio created. type: array maxItems: 4000 items: $ref: '#/components/schemas/folioWindowType' payments: description: Deposit payment information of the payment which was posted. $ref: '#/components/schemas/detailPostingsType' trxCodesInfo: description: Transaction codes information which are in response postings. $ref: '#/components/schemas/trxCodesInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' cCBatchSettlementsStatusType: type: object description: List of CCBatchSettlementStatusType type properties: cCBatchSettlementsStatus: type: array maxItems: 4000 items: $ref: '#/components/schemas/cCBatchSettlementStatusType' hotelId: description: Hotel Code type: string minLength: 0 maxLength: 20 batchId: description: Batch Id for identify status of job. type: string folioActivityResponseDetailType: type: object description: Fiscal Folio Activity Details Information properties: folioActivityResponseDetailsInfo: type: array description: Details of response for the Fiscal Folio Activity made. maxItems: 4000 items: $ref: '#/components/schemas/folioActivityResponseDetailsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' creditBillCriteria: type: object description: Request to post a Credit Folio for an existing Folio. Credit Bill Functionality parameter is required. properties: criteria: description: Criteria for creating the Credit Folio. This should include all charges and payments for the Credit Folio. $ref: '#/components/schemas/creditBillCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' 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' profileRestrictions: description: Detailed information on restrictions associated with the profile. $ref: '#/components/schemas/profileRestrictions' compositeDepositInfo: type: object description: Request to post a deposit payment or a deposit folio to a reservation. properties: criteria: description: Criteria for the deposit payment or deposit folio information to be posted. $ref: '#/components/schemas/compositeDepositCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' fiscalSupportingDocumentCriteriaType: type: object description: Criteria for sending supporting document to fiscal partner. properties: hotelId: description: Unique ID of the hotel type: string documentNo: description: Supporting document number. type: integer documentType: description: Supporting document type. $ref: '#/components/schemas/fiscalSupportingDocumentType' 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 receiptHistoryResponse: type: object description: Response for the fetch Receipt History. properties: receiptHistory: description: List of Receipt History. $ref: '#/components/schemas/receiptsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' articlesSale: type: object description: Details of the folio created. properties: folioWindowDetails: type: array items: $ref: '#/components/schemas/folioWindowType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' cCBatchSettlementsProcessType: type: object description: Type for starting settlements job process. properties: hotelId: description: Hotel code of the reservation. type: string minLength: 0 maxLength: 20 settlementIdList: description: List of selected settlements id. $ref: '#/components/schemas/uniqueIDListType' batchId: description: Batch Id for identify status of job. type: string routingInstructionsDetails: type: object description: Response object containing routing instructions for a reservation. properties: routingInstructions: description: Set of Routing Instructions. $ref: '#/components/schemas/routingInfoListType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' changeGuestCheckDetails: type: object description: Request to update a guest check detail. properties: reservationId: description: Reservation Id for which the details need to be posted. $ref: '#/components/schemas/reservationId' checkDetails: description: Check details that needs to be updated. $ref: '#/components/schemas/changeCheckDetailsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' compTransactionAuthorizers: type: object description: Response object for fetch comp authorizers operation. properties: authorizerInfo: description: List of authorizers eligible to perform the transfer. type: array items: $ref: '#/components/schemas/authorizerInfoType' 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' 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_2' 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 resvRoutingInfoListType: type: array description: A comp routing info object maxItems: 4000 items: $ref: '#/components/schemas/resvRoutingInfoType' bulkPrepaidCardsType: type: object description: Response for posting bulk prepaid cards. properties: activatedCards: type: array description: List of card-specific details for prepaid cards that were successfully activated. maxItems: 10 items: $ref: '#/components/schemas/bulkPrepaidCardDetailsType' unsuccessfulCards: type: array description: List of prepaid cards that were not activated with response information. maxItems: 10 items: $ref: '#/components/schemas/bulkPrepaidCardsStatusType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' splitDepositTransactionStatus: type: object description: Response after spliting deposit transaction. properties: transactions: description: Collection of transactions. $ref: '#/components/schemas/transactionsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' folioTypesInfoType: type: object description: Folio Types details. properties: folioType: description: Folio Type. type: string minLength: 0 maxLength: 20 fiscal: description: Fiscal Folio indicator. type: boolean compress: description: Indicates folio to be use for compress bills. type: boolean credit: description: Indicates folio type can be used for Credit bills. type: boolean sendFiscalFolio: description: Adding this flag at folio type level would decide to send fiscal folio (generate payload) or not. type: boolean 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 ccAuthorizationInstructionsCriteria: type: object description: Fetch credit card authorization instructions. properties: criteria: description: Criteria for fetching credit card authorization instructions. $ref: '#/components/schemas/ccAuthorizationInstructionsCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' autoSettleCompFoliosType: type: array description: Information about comp folio that was auto settled. maxItems: 4000 items: $ref: '#/components/schemas/autoSettleCompFolioType' cCBatchSettlementType: type: object description: Credit card transaction detail for batch settlement properties: settlementId: description: CC Settlement id associated with the CC settlement transaction. $ref: '#/components/schemas/uniqueID_Type' settlementAmount: description: Settlement amount associated with the CC settlement transaction. $ref: '#/components/schemas/currencyAmountType_2' guestName: description: Guest name associated with the CC settlement transaction. type: string minLength: 0 maxLength: 2000 roomId: description: Room number associated with the CC settlement transaction. type: string minLength: 0 maxLength: 20 windowNo: description: Window number associated with the CC settlement transaction. type: integer paymentMethod: description: Identifies the payment method to validate the credit card number against. $ref: '#/components/schemas/reservationPaymentMethodType' reservationId: description: Unique Id for the reservation $ref: '#/components/schemas/reservationId' approvalCode: description: The approval code authenticates the authorization. type: string minLength: 0 maxLength: 20 folioNo: description: Folio number of transaction type: number transactionDate: description: Transaction Date of the credit card transaction. type: string format: date maxLength: 8 responseInstructionType: type: string description: Response types used in the Apply Final Postings request. Based on the request the folio summary , folio details or no details will be returned in the response. enum: - None - Summary - Details folioTransactionDetails: type: object description: Response for the fetch transaction details request. Detail information regarding the folio transaction will be returned properties: transactions: description: The details regarding the transaction(Posting). $ref: '#/components/schemas/detailPostingsType' trxCodesInfo: description: Transaction codes information which are in response postings. $ref: '#/components/schemas/trxCodesInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' roomRoutingRefresh: type: object description: The request object for processing refreshing of a routing instruction set. This operation transfers the postings to the respective reservation as per the routing instruction set which is created, edited, deleted or refreshed. properties: roomRoutingRefreshCriteria: description: Criteria to process room routing refresh. $ref: '#/components/schemas/roomRoutingRefreshCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' reinstateCheckedOutReservation: type: object description: Request to reinstate checkout reservation in order to post additional transactions, etc. properties: hotelId: description: Hotel code. $ref: '#/components/schemas/codeType' reservationId: description: Identifies the reservation to reinstate.. $ref: '#/components/schemas/reservationId' notifyInterfaces: description: Indicates whether interfaces should be notified. type: boolean overrideFlag: description: Indicate whether user wants to reinstate even if some other guest already checked in into same room. type: boolean cashierId: $ref: '#/components/schemas/cashierId' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' cashierClosureInformation: type: object description: Response to the request to get financial details for a Posting Activity. This will return the before and after values for the transactions which were changed. properties: cashierClosureInfo: description: The details of the changes made during the activity. $ref: '#/components/schemas/cashierClosureInfoTypes' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' postingSummaryType: type: object description: summary of the postings by external system. properties: totalPostings: description: Total count of postings. type: integer totalAmount: description: Total Amount Posted. $ref: '#/components/schemas/currencyAmountType_2' totalCheckCount: description: Total count of checks posted. type: integer convertFolioCriteria: type: object description: Request to convert folio from a Non Fiscal Folio type to a Fiscal Folio Type. Functionality is used in Italy and is only available when the country mode is set to Italy. properties: criteria: description: Criteria to Convert a Folio from a Non Fiscal Type to a Fiscal Type. $ref: '#/components/schemas/convertFolioType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' reservationDepositFolioInfoType: type: object description: Detailed information of a reservation and its deposit payment posting information. properties: totalAmountDue: description: Total Deposit Amount which is due for this reservation. $ref: '#/components/schemas/currencyAmountType_2' reservationInfo: description: Reservation guest details. $ref: '#/components/schemas/reservationInfoType' deposits: description: Window count will be hotel based configurable. $ref: '#/components/schemas/depositPostingsType' totalAmountTransferrable: description: Total Deposit Amount that can be transferred to another Reservation. $ref: '#/components/schemas/currencyAmountType_2' projectedRevenue: description: Projected revenue for the reservation. $ref: '#/components/schemas/projectedRevenueType' policySummaryInfo: description: Summary information for the Deposit and Cancellation Policies on the reservation. $ref: '#/components/schemas/reservationPolicySummaryType' depositType: description: The Reservation's Deposit Status Type. This can indicate if the Reservation is only allowed to create Folios for Deposits or Receipts for Deposits or by Default Any. Used when Deposit Folio Functionality is ON. $ref: '#/components/schemas/depositType' depositMaturityType: description: The Reservation's Deposit Status Type. When preference is set to Check In, the deposit is transferred when the guest checks in. When the preference is set to Last Night Stay, then the deposit is transferred during the last nights night audit. For example, if the departure date for a reservation is July 14th, then the deposit would be posted during the night audit for July 13th. $ref: '#/components/schemas/depositMaturityType' advanceFolioGenerated: type: boolean description: Flag to indicate if an Advance Folio is already generated. certificateReconciliationTypes: type: array description: List of CertificateReconciliationType criteria maxItems: 4000 items: $ref: '#/components/schemas/certificateReconciliationType' compTransactionCriteria: type: object description: Request object to submit a comp transaction to gaming system properties: hotelId: description: Hotel code. $ref: '#/components/schemas/codeType' trxNo: description: Transaction Number for which request is being submitted. type: number 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' routingInfoListType: type: array description: A routing info object can either be of type Folio OR of type Room with its corresponding instructions. maxItems: 4000 items: $ref: '#/components/schemas/routingInfoType' customerVatFolioCriteria: type: object description: Request to create Customer Factura Vat Folio from a Rachunek Folio. properties: criteria: description: Criteria to create Customer Factura Vat Folio from a Rachunek Folio. $ref: '#/components/schemas/customerVatFolioCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' prepaidCardDetailsType: type: object description: Prepaid Card Details. properties: initialLoadDate: description: Holds fixed charge detail. type: string format: date maxLength: 8 activateDate: description: Holds fixed charge detail. type: string format: date maxLength: 8 initialCreditTotal: description: Holds fixed charge detail. $ref: '#/components/schemas/currencyAmountType_2' creditTotal: description: Holds fixed charge detail. $ref: '#/components/schemas/currencyAmountType_2' debitTotal: description: Holds fixed charge detail. $ref: '#/components/schemas/currencyAmountType_2' reservedTotal: description: Holds fixed charge detail. $ref: '#/components/schemas/currencyAmountType_2' balanceTotal: description: Holds fixed charge detail. $ref: '#/components/schemas/currencyAmountType_2' validUntilDate: description: Holds fixed charge detail. type: string format: date maxLength: 8 expiredDate: description: Holds fixed charge detail. type: string format: date maxLength: 8 transactions: description: Holds fixed charge detail. type: array maxItems: 4000 items: $ref: '#/components/schemas/prepaidCardTransactionType' 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 - HouseKeeping - EnrollToPrimaryMembership - EnrollInProgress passerBySalesCriteria: type: object description: Request to post a set of charges, payments and generate a bill for a PasserBy or for the Post-It functionality . A PasserBy is someone who is not staying at the Property. A PasserBy transaction requires a Profile in Opera for whom the the folio is being created. properties: criteria: description: Criteria for posting the Sale. $ref: '#/components/schemas/passerByCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' reservationPackageOptions: type: object description: Response to fetch reservation package options. properties: packagePostings: description: List of Packages postings. $ref: '#/components/schemas/packagePostingsType' trxCodesInfo: description: Transaction codes information which are in response postings. $ref: '#/components/schemas/trxCodesInfoType' linkedAllowanceReservationsInfo: description: List of reservations with linked package allowances $ref: '#/components/schemas/linkedAllowanceReservationsInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' depositFolioValidateCriteriaType: type: object description: Criteria for posting a Deposit Folio. properties: hotelId: description: Property where the reservation exists. type: string minLength: 0 maxLength: 20 reservationId: description: Reservation for which the Deposit Folio is required. $ref: '#/components/schemas/reservationId' profileId: description: Profile Id of the Payee for this Deposit Folio. $ref: '#/components/schemas/profileId' depositPolicyId: description: The deposit policy ID for which the Deposit Folio is being created. $ref: '#/components/schemas/uniqueID_Type' cashierId: $ref: '#/components/schemas/cashierId' batchDepositType: type: object description: Contains criteria for batch deposit for reservations. properties: hotelId: description: Property context of the reservations. type: string minLength: 0 maxLength: 20 reservations: description: List of unique reservation identifiers having deposits to process. Reservations should come from the same property. $ref: '#/components/schemas/reservations' cashierId: description: Unique cashier identifier to process the deposit transaction. $ref: '#/components/schemas/cashierId' 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 batchVouchersType: type: object properties: reservations: description: List of unique reservation identifiers having deposits to process. Reservations should come from the same property. $ref: '#/components/schemas/reservations' folioTypeNameInfo: type: object description: Response for the fetch Folio Type Information. properties: details: description: Information regarding the Folio Type. $ref: '#/components/schemas/folioTypeNameInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' numericUDFType: type: object description: Used to hold user defined field of Numeric Type. It is highly recommended to use UDFN01, UDFN02,...UDFN40 (Total 40) as Numeric UDF names(commonly used on Reservation, Profile etc.). Name is not restricted using enumeration, to provide flexibility of different name usage if required. properties: name: description: Name of user defined field. type: string minLength: 0 maxLength: 20 value: description: Value of user defined field. type: number alternateName: description: Label of user defined field used by vendors or customers. type: string minLength: 0 maxLength: 2000 folioPrinters: type: object description: Response to the request to fetch the Folio Printers applicable for a Folio, based on the properties: printers: description: List of Printers which are applicable for this Folio. $ref: '#/components/schemas/folioPrintersType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' customChargeGuestInfoType: 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 profileId: description: Unique profile identifier. $ref: '#/components/schemas/profileId' namePrefixType: type: string description: Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.) minLength: 0 maxLength: 40 ccBatchSettlementsProcessCriteria: type: object description: Request to process batch settlements properties: criteria: description: Selected settlements which will process $ref: '#/components/schemas/cCBatchSettlementsProcessType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' proformaFolioResponseInstructionType: type: string description: Response instructions for Proforma Folio Creation. enum: - Summary - Details personNameType: type: object description: This provides name information for a person. properties: namePrefix: description: Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.) type: string minLength: 0 maxLength: 40 givenName: description: 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 surname: description: Family name, last name. May also be used for full name if the sending system does not have the ability to separate a full name into its parts, e.g. the surname element may be used to pass the full 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: 40 nameTitle: description: Degree or honors (e.g., Ph.D., M.D.) type: string minLength: 0 maxLength: 80 nameTitleSuffix: description: Title Suffix. Must be populated if ADVANCED_TITLE is on. type: integer envelopeGreeting: description: Envelope Greeting of the profile type: string salutation: description: Salutation of the profile type: string nameType: description: Type of name of the individual, such as former, nickname, alternate or alias name. $ref: '#/components/schemas/personNameTypeType' language: description: Language identification. type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' externalSystem: description: When name type is external, indicates the external system the name belongs to. type: string minLength: 0 maxLength: 40 fBAStatusType: type: string description: Flexible benefit award has been reimbursed. enum: - Ordered - Attached - Posted - Settled - Reimbursed paymentMethodsSearchType: type: array description: Defines the payment method to search reservations. maxItems: 4000 items: $ref: '#/components/schemas/paymentMethodSearchType' communicationStatusType: type: string description: Enum to denote the Status of Readiness messages sent to Guest Devices. enum: - Pending - Completed - Failed - Sent - Received - Cancelled - PendingAvailability validatedTransactionCode: type: object description: Response notifying if transaction code is valid. properties: hotelId: description: Hotel context where the Transaction Code will be validated. $ref: '#/components/schemas/codeType' trxCode: description: Transaction Code. $ref: '#/components/schemas/codeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' fiscalSupportingDocumentsResponse: type: object description: Response for the supporting documents. properties: supportingDocuments: description: List of supporting documents. type: array maxItems: 4000 items: $ref: '#/components/schemas/supportingDocumentType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: description: Index of the page being requested. If the index goes out of the bounds of the total set count, no data will be returned. type: integer limit: description: Indicates maximum number of records the API 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' billingChargeStatus: type: object description: Response Body. properties: links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' folioTaxPaymentReversal: type: object description: Response for the reverse Thailand Tax Payment Tax record request. properties: postings: description: List of Postings produced by Reverse Payment Tax Request. $ref: '#/components/schemas/summaryPostingsType' trxCodesInfo: description: Transaction codes information which are in response postings. $ref: '#/components/schemas/trxCodesInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' depositRefundEligibleCheck: type: object description: Response for the refund deposit payment. properties: isDepositRefundValid: description: Is reservation valid for deposit refund. type: boolean links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' proformaFolio: type: object description: Response for the Create Proforma WS. The proforma is created by this request, passed into the response and finally the proforma transactions are removed. properties: reservationFolioInformation: description: This type will return a detailed Proforma Folio information in the response. $ref: '#/components/schemas/reservationFolioInfoType' trxCodesInfo: description: Transaction codes information which are in response postings. $ref: '#/components/schemas/trxCodesInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' 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_2' approvalAmountNeeded: $ref: '#/components/schemas/currencyAmountType_2' 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 storeToCreditCardWallet: description: Indicate whether the credit card will be stored to the credit card wallet or not. type: boolean cancelPrepaidCardTransactionStatus: type: object properties: links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' ccAuthorizationInstructionsCriteriaType: type: object description: Contains the credit card criteria for fetching authorization instructions. properties: hotelId: description: Identifies the hotel code to authorize a credit card amount for. type: string minLength: 0 maxLength: 20 reservationId: description: Reservation id of the reservation $ref: '#/components/schemas/reservationId' profileId: description: Profile Id of the Payee for this Deposit. $ref: '#/components/schemas/profileId' cardId: description: credit card id $ref: '#/components/schemas/uniqueID_Type' cardHolderName: type: string minLength: 0 maxLength: 200 cardNumber: type: string minLength: 0 maxLength: 80 cardNumberMasked: type: string minLength: 0 maxLength: 80 cardType: description: Indicates the type of credit card from a defined list $ref: '#/components/schemas/cardTypeType' 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 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 expirationDate: description: Expiration date of the credit card type: string format: date maxLength: 8 amount: description: The amount to authorize. type: number evaluateApprovalAmount: description: Flag to indicate if the approval amount should be calculated before authorization. If this is true and if the amount is 0 the approval amount will be calculated based on the rules. type: boolean folioView: description: The folio window where this authorization is applied. type: integer paymentFolioView: description: The folio window where this authorization is applied. type: integer paymentMethod: type: string minLength: 0 maxLength: 20 sourceOfAuthorization: description: Source of the authorization. $ref: '#/components/schemas/cardAuthorizationTransactionType' storeToCreditCardWallet: description: Attach the credit card to the wallet. type: boolean track2Data: description: Track2 data for the card which would be sent to the CC vendor as part of the authorization. type: string minLength: 0 maxLength: 200 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 depositProcessType: type: string description: The Deposit is transferred to an internal account for returned deposits to be handled by the property. Users can select to keep all (not exceeding total), a portion of, or none of the deposit. enum: - Keep - Return - Mature financialPostingsNetVatType: type: object description: Financial Postings with their Net and Vat breakup properties: posting: description: Details of the primary posting. $ref: '#/components/schemas/detailPostingType' postingBreakdown: description: Details of posting's breakdown. $ref: '#/components/schemas/postingBreakdownType' summaryPostingType: type: object description: Posting details. properties: referenceTransactionNo: description: Generate transaction number for the Posting. type: number remark: description: Posting remarks. type: string minLength: 0 maxLength: 2000 reference: description: User-defined posting reference. type: string minLength: 0 maxLength: 2000 checkNo: description: Check number for the posting. type: string minLength: 0 maxLength: 2000 checkCount: description: Check number count for the posting. type: string minLength: 0 maxLength: 2000 postedAmount: description: Actual currency amount posted. $ref: '#/components/schemas/currencyAmountType_2' price: description: Indicates the unit price of the consumption. $ref: '#/components/schemas/currencyAmountType_2' quantity: description: Indicates Quantity. type: number transactionType: description: This is the transaction type which says whether it is a Consumption(C), Payment (FC) or Package (PK) and it is inherited from transaction code. $ref: '#/components/schemas/cashieringTransactionTypeType' creditAmount: description: The amount posted as credit to the ledger. $ref: '#/components/schemas/currencyAmountType_2' debitAmount: description: The amount posted as debit to the ledger. $ref: '#/components/schemas/currencyAmountType_2' articleCode: description: Information regarding the Article(Using Articles Functionality) of this transaction. type: string minLength: 0 maxLength: 20 cashierInfo: $ref: '#/components/schemas/cashierInfoType' paidOut: description: Indicates if this transaction is a paid out transaction. type: boolean arrangementCode: description: Corrected arrangement code from the package associated to this transaction. type: string minLength: 0 maxLength: 20 groupTypeInfo: description: Information related to transaction grouping. $ref: '#/components/schemas/postingGroupType' rateCode: description: Rate code associated to this transaction. type: string minLength: 0 maxLength: 20 compRedemptionCode: description: Comp redemption code assiciated to the transaction. type: string minLength: 0 maxLength: 20 updateInfo: description: Update info associated to this transaction. type: object properties: updateDate: type: string format: date maxLength: 8 updateBy: type: string fbaCertificate: description: Flag indicates that the posting is Flexible Benefits Awards Certificate type: boolean taxInvoiceNo: description: Tax invoice number generated by payment tax. type: string minLength: 0 maxLength: 20 serviceRecovery: description: Flag to indicates service recovery type: boolean compPostingsInfo: description: Comp Postings information for the folio. $ref: '#/components/schemas/compPostingsType' financialTransactionIdList: description: Collection of unique identifiers of the financial transactions. $ref: '#/components/schemas/uniqueIDListType' exchange: description: Available when the Fetch Folio Search Type requests the amounts to be converted to a currency different from the Resort currency. $ref: '#/components/schemas/exchangeAmounts' approvalCode: description: Approval code of the posting. type: string minLength: 0 maxLength: 20 approvalStatus: description: Approval status of the posting. type: string minLength: 0 maxLength: 20 stampDuty: description: Flag to identify a Stamp Duty Transaction. type: boolean customCharge: description: Flag to identify a Custom Charge. type: boolean transactionNo: description: Unique Transaction Identifier. type: number transactionDate: description: Transaction Date. type: string format: date maxLength: 8 transactionCode: description: Billing Transaction Code. type: string minLength: 0 maxLength: 200 transactionDescription: description: Billing Transaction Description. type: string minLength: 0 maxLength: 2000 transactionAmount: description: The amount of the transaction. type: number postingDate: description: Date and time of posting. type: string format: date maxLength: 8 postingTime: description: Time of posting. $ref: '#/components/schemas/postingTimeType' revenueDate: description: The date on which the transaction has its revenue effect. type: string format: date maxLength: 8 receiptNo: description: The receipt number of the transaction, if there is a receipt generated. type: number officialBIRReceiptExists: description: Flag to indicate if an Official Receipt is generated for the folio window. Applicable only in the Philippines. type: boolean roundingDifferenceTrx: description: Indicator to determine if the posting was a posting for the Rounding Difference. type: boolean commissionable: description: Indicator to determine if the transaction is commissionable. type: boolean reversePaymentTransactionNo: description: Reverse payment transaction unique identifier. type: number canAdjustInvoice: description: Indicator to determine if the transaction can be adjusted. type: boolean depositTransactionId: description: Tax Service Accounting Codes used. type: string minLength: 0 maxLength: 40 groupByCount: description: When some SummaryPostingsGroupBy element is send as request ,then this element will represent how many transactions rolled up into this Summary Posting Type. type: number folioWindowNo: description: The Folio Window number of this posting. type: integer deferredTax: description: Flag to indicate if the Posting is a deferred tax record. Set to true only when the posting is a deferred tax record. Set to false only when the posting is not a deferred tax record. type: boolean awardTransaction: description: Indicator to determine if the posting's transaction code is related to a payment award. type: boolean covers: description: POS covers type: string minLength: 0 maxLength: 10 proformaFlag: description: This flag indicates if it is a proforma posted transaction. type: string minLength: 0 maxLength: 20 creditCardId: description: ' A unique identifier used to represent and distinguish an individual credit card within the application.' type: number ccSettleRecordExists: description: Indicates if the posting has a credit card settlement record. type: boolean originalReservationInformation: description: Original Reservation Information. $ref: '#/components/schemas/originalReservationInfo' holdingLedgerTransaction: description: Indicator to determine if the transaction is a holding ledger transaction. type: boolean 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' exchangeRateCalculationType: type: object description: Currency conversion calculation type. properties: hotelId: description: Property code where the currency is being converted. type: string minLength: 0 maxLength: 20 fromCurrencyAmount: description: Amount and code of currency that is being converted from. $ref: '#/components/schemas/currencyAmountType_2' exchangeDate: description: Date on which exchange rate was obtained. type: string format: date maxLength: 8 sell: description: Buy or Sell for calculation. type: boolean exchangeReference: description: Exchange references. type: string exchangeType: description: Type for exchange calculation. $ref: '#/components/schemas/currencyExchangeType' toCurrencyAmount: description: Amount and code of currency that is being converted to. $ref: '#/components/schemas/currencyAmountType_2' date: description: Date on which the exchange is to take place. type: string format: date maxLength: 8 buyCommission: description: Buy commission for the foreign currency. type: number roundingAmount: description: Amount by which the exchange was rounded. type: number calculatedAmount: description: Pure calculated amount. type: number exchangeRate: description: Exchange Rate. type: number euroExchangeRate: description: Exchange rate against Euro. type: number euroAmount: description: Amount in Euro for the exchange. type: number serviceTax: description: Tax amount which is applicable for this transaction, when using the Exchange Service Tax functionality. $ref: '#/components/schemas/currencyAmountType_2' exchangeInformation: description: Exchange Information - text presentation of the exchange operation including formula, buy rate, etc. type: string minLength: 0 maxLength: 2000 exchangeRateCalculationTax: description: Detailed information about exchange rate calculation service tax. $ref: '#/components/schemas/exchangeRateCalculationTaxType' detachPolicyApplyCriteria: type: object description: Request to detach a deposit payment from a Deposit Policy on a reservation. properties: criteria: description: Criteria for unlinking a Deposit Policy from an existing deposit payment. $ref: '#/components/schemas/policyApplyCriteriaType' 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' paymentTaxType: type: object description: Information regarding payments made which have Payment Tax. properties: taxInvoiceNo: description: The Tax Invoice for this payment. type: string minLength: 0 maxLength: 20 paymentType: description: The Type of Payment transaction. $ref: '#/components/schemas/paymentTax' amount: description: The payment amount/ $ref: '#/components/schemas/currencyAmountType_2' taxableAmount: description: The amount that is taxable. $ref: '#/components/schemas/currencyAmountType_2' nonTaxableAmount: description: Documentation goes here $ref: '#/components/schemas/currencyAmountType_2' availableCredit: description: The amount that is not taxable. $ref: '#/components/schemas/currencyAmountType_2' paymentDate: description: The Payment Invoice date type: string format: date maxLength: 8 transactionNo: description: Unique Transaction Identifier. type: number transactionDate: description: Transaction Date of the Payment. type: string format: date maxLength: 8 transactionCode: description: Billing Transaction Code of the Payment. type: string minLength: 0 maxLength: 200 transactionDescription: description: Billing Transaction Description. type: string minLength: 0 maxLength: 2000 folioWindowNo: type: integer folio: type: object description: Response to the request to get Financial Information for a Reservation properties: reservationFolioInformation: description: Financial details for the requested reservation. $ref: '#/components/schemas/reservationFolioInfoType' trxCodesInfo: description: Transaction codes information which are in response folio information. $ref: '#/components/schemas/trxCodesInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' batchAutoCheckoutReservation: type: object description: Request type for batch auto checkout. properties: criteria: description: Criteria for batch auto checkout. $ref: '#/components/schemas/checkoutReservationType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' cashieringEventType: type: string description: Event being generated by a Supplemental Folio. enum: - CheckOut - EarlyDeparture - AdvanceBill - InterimBill - PasserBy - PostIt - CreditBill - ChargesAndPayments - Deposit - DepositRefund - AutoFolio - PrepaidCard - AutoSettlement - InformationFolio - SupplementalFolio - ProformaFolio - DebitNote foreignCurrencyExchangeTransactionType: type: object description: Details about posting and generated folio on currency exchange. properties: posting: description: Details of the primary posting. $ref: '#/components/schemas/summaryPostingType' folio: description: Details of the generated folio. $ref: '#/components/schemas/folioType' receiptsType: type: array description: Receipt History details. maxItems: 4000 items: $ref: '#/components/schemas/receiptSummaryType' revenueBucketTotalsType: type: array description: List of revenue bucket total details maxItems: 4000 items: $ref: '#/components/schemas/revenueBucketTotalType' changePayeeTaxNumberCriteriaType: type: object description: Criteria to validate and change payee tax number. properties: hotelId: description: Property code. type: string minLength: 0 maxLength: 20 payeeId: description: Opera name id of the payee. $ref: '#/components/schemas/uniqueID_Type' taxNumber: description: Payee Tax Number. type: string minLength: 0 maxLength: 40 ignoreWarnings: description: Flag to ignore warnings while updating a payee folio tax number. type: boolean cashierId: $ref: '#/components/schemas/cashierId' depositPayment: type: object description: Request to post a deposit payment to a reservation. properties: criteria: description: Criteria for the deposit payment information to be posted. $ref: '#/components/schemas/depositPaymentCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' 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 depositFolioCriteria: type: object description: Request to create a Deposit Folio for a reservation. properties: criteria: description: Criteria for creating a Deposit Folio. Deposit Folio functionality should be active. $ref: '#/components/schemas/depositFolioCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' autoSettleCompFoliosCriteriaType: type: object description: Criteria to auto settle comp folios of a reservation. properties: hotelId: description: Hotel code of the folios to be auto settled. type: string minLength: 0 maxLength: 20 reservationId: description: Reservation Unique ID of the folios to be auto settled. $ref: '#/components/schemas/reservationId' eventType: description: Event to which this process will be logged. Possible values are CheckOut, InterimBill, AdvanceBill. $ref: '#/components/schemas/cashieringEventType' cashierId: description: Numeric ID of the cashier. type: number postedDepositFolio: type: object description: Response to the request to create a Deposit Folio for a reservation. properties: folioWindow: description: Information regarding the new Deposit Folio created. type: array items: $ref: '#/components/schemas/folioWindowType' deposits: description: Deposit payment information of the payment which was posted. $ref: '#/components/schemas/depositPostingsType' trxCodesInfo: description: Transaction codes information which are in response postings. $ref: '#/components/schemas/trxCodesInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' trxTransferCriteriaType: type: object description: Transactions can be transferred to either a FolioWindow Number of the same reservation or to another Inhouse Reservation. properties: hotelId: description: Property code. type: string minLength: 0 maxLength: 20 reservationIdList: description: Reservation id from where transactions will be transfered. $ref: '#/components/schemas/reservationIdList' membershipIdNo: description: Unique ID of Membership. type: integer targetFolioWindowNo: description: Folio Window Number to where transactions will be transfered. type: integer targetReservationIdList: description: Reservation Id where the transactions will be transferred. $ref: '#/components/schemas/uniqueIDListType' transactionList: description: List of transactions to be transfered. type: array maxItems: 4000 items: type: number transactionCodeList: description: List of Transaction code to be transferred. type: array maxItems: 4000 items: type: string sourceFolioWindowNo: description: Folio Window Number to where transactions were originated. type: integer authorizerId: $ref: '#/components/schemas/uniqueID_Type' cashierId: $ref: '#/components/schemas/cashierId' reservation: type: object description: Checkout request can be used to verify a reservation for checkout and do an actual checkout. In case the verificationOnly attribute is sent false, the operation will perform an actual checkout. In case the verificationOnly attribute is sent true, the operation goes through the reservation in question and verifies if it's Ok to checkout, otherwise the verification status element will provide you the verification code. The verification codes are described in the documentation of verificationOnly attribute. properties: reservation: description: Check in reservation request. $ref: '#/components/schemas/checkoutReservationType' verificationOnly: description: 'VerificationOnly "true" validates the hotel code and reservation id supplied in the request. VerificationOnly "false" validates and then check-out the guest using the request details. Following codes might be returned during the verification: FOF00065 - The hotel code and/or reservation id is missing. FOF00066 - Reservation can''t be found with the supplied hotel code and reservation id. FOF00107 - The guest''s departure is not scheduled for today. Check-out not possible. FOF00109 - The guest''s reservation is not in a valid status for check-out. FOF00108 - The guest has a balance. Check-out not possible.' type: boolean links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' cashierClosureInfoType: type: object description: Cashier closure Information. properties: cashierClosureNo: description: Criteria for the cashier closure id and the closure number $ref: '#/components/schemas/cashierClosureNoType' hotelId: description: Property this record belongs to. type: string minLength: 0 maxLength: 20 cashierTitle: description: Cashier title of the cashier. type: string minLength: 0 maxLength: 2000 cashierUser: description: Cashier user name. type: string minLength: 0 maxLength: 2000 openDate: description: Date and time cashier was opened. type: string format: date maxLength: 8 closeDate: description: Date and time cashier was closed. type: string format: date maxLength: 8 closureBusinessDate: description: Business date cashier was closed. type: string format: date maxLength: 8 reportsList: description: Returns whether a particular report is applicable or not based on payment posting type. When no postings for a particular payment type is found, that report is marked as not applicable in the closure report. $ref: '#/components/schemas/cashierClosureReportsType' reverseCompRedemptions: type: object description: Request type of complimentary bucket redemptions reversal. properties: criteria: description: Criteria to reverse complimentary bucket redemptions request. type: object properties: membershipId: description: Membership number. type: string minLength: 0 maxLength: 100 compRedemptions: description: Complimentary bucket redemptions to post as negative payment. $ref: '#/components/schemas/compRedemptionsType' cashierId: description: Numeric ID of the cashier. $ref: '#/components/schemas/cashierId' folioView: description: Folio Window. type: integer warnings: $ref: '#/components/schemas/warningsType' nameValueModuleType: type: string enum: - Reservation - Folio - Profile - Fintrix cancelPrepaidCardTransaction: type: object description: Request type for cancel prepaid card transaction. properties: criteria: description: Prepaid card criteria type used to perform manage operation on the card. type: object properties: hotelId: description: Hotel code. type: string minLength: 0 maxLength: 20 cardNo: description: Prepaid card number. type: string minLength: 0 maxLength: 80 interfaceId: description: The unique ID for the Interface. $ref: '#/components/schemas/uniqueID_Type' profileId: description: The guest name id associated to the card. $ref: '#/components/schemas/uniqueID_Type' reservationId: description: The reservation name id where the transaction is associated. $ref: '#/components/schemas/uniqueID_Type' pin: description: PIN code associated for the prepaid card. type: string minLength: 0 maxLength: 80 amount: description: Prepaid card transaction amount. $ref: '#/components/schemas/currencyAmountType_2' cashierId: $ref: '#/components/schemas/cashierId' vendorTransactionNo: description: The vendor transaction number associated with prepaid card transaction. $ref: '#/components/schemas/stringLength100' transactionNo: description: The opera transaction number associated with prepaid card transaction. type: integer transactionTye: description: The transaction type of a given transaction. $ref: '#/components/schemas/prepaidCardTrxTypeType' postChargeToRoom: description: Indicate that charges will be posted to the room. type: boolean saleCriteria: description: Represent the sale criteria. $ref: '#/components/schemas/saleCriteriaType' warnings: $ref: '#/components/schemas/warningsType' billingChargesType: type: object description: Criteria for the charge information list to be edited. properties: billingCharges: description: Request to edit a billing charge information type: array maxItems: 2000 items: $ref: '#/components/schemas/billingChargeType' hotelId: type: string minLength: 0 maxLength: 20 tierAdministrationType: type: string description: Do not upgrade membership. The membership may be downgraded. enum: - Disabled - NoUpgrade reloadPrepaidCardStatus: type: object properties: links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' alertGuestInfoType: type: object properties: guestName: description: Guest Name. type: string minLength: 0 maxLength: 200 membership: description: Membership information of the guest. $ref: '#/components/schemas/membershipType' vipStatus: description: VIP status of the guest. $ref: '#/components/schemas/vIPStatusType' lastHotelCode: description: Hotel code of the last stay location of the guest. type: string minLength: 0 maxLength: 20 lastStayDate: description: Last stay date at the property. type: string format: date maxLength: 8 totalStay: description: Holds total number of days that the guest have stayed in the property. type: integer comments: description: Additional alert information regarding the membership of the guest. type: string preference: description: Additional alert information regarding the guest. type: string preference2: description: Additional mandatory alert information regarding the guest preferences. type: string guestPreferredLanguage: description: Holds the language preferred by the guest. $ref: '#/components/schemas/languageType' totalBrandStay: description: Holds total number of days that the guest have stayed in the properties for the same brand. type: integer birthDate: description: Indicates the date of birth as indicated in the document, in ISO 8601 prescribed format. type: string format: date maxLength: 8 birthDateMasked: description: Indicates the date of birth as masked. type: string foreignCurrencyExchangeTransaction: type: object description: Response of the posting foreign currency exchange transaction. properties: transaction: description: Details of posting and generated folio. $ref: '#/components/schemas/foreignCurrencyExchangeTransactionType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' postingSummaryListType: type: array description: Summary of the postings by external system. maxItems: 4000 items: $ref: '#/components/schemas/postingSummaryType' billingPayment: type: object description: Request to post a payment on a reservation's folio. properties: criteria: description: Criteria for the payment information to be posted. type: object properties: hotelId: description: Property code. type: string minLength: 0 maxLength: 20 paymentMethod: description: Payment method used by the payee. $ref: '#/components/schemas/cashieringPaymentMethodType' postingAmount: description: Amount to post to the folio. $ref: '#/components/schemas/currencyAmountType_2' postingReference: description: User-defined posting reference. type: string minLength: 0 maxLength: 2000 postingRemark: description: User-defined posting remark. type: string minLength: 0 maxLength: 2000 comments: description: User Defined Comments. Used for Deposit Payment postings. type: string minLength: 0 maxLength: 2000 applyCCSurcharge: description: Flag to indicate if Credit Card Surcharge has to be applied to this payment, when the functionality for Credit Card Surcharge is available. type: boolean applyCashSurcharge: description: Flag to indicate if a cash surcharge amount can be included, when the functionality for Cash Surcharge is available. type: boolean manualPaymentTaxInfo: description: The Payment Tax information for Thailand Tax functionality. The invoice number and the date will be used. $ref: '#/components/schemas/paymentTaxType' creditablePaymentTaxes: description: Used for Thailand Tax Functionality.The payment tax records that can be used for a Credit Note for this reservation. $ref: '#/components/schemas/paymentTaxesType' terminalId: description: Applicable for chip and pin. The ID of the terminal where the chip and pin device is connected and where the payment is made. type: string maxLength: 2000 overrideInsufficientCC: description: Flag to allow a rebate by Credit Card type: boolean changeDueAmount: description: Amount of change given to guest. $ref: '#/components/schemas/currencyAmountType_2' overrideARCreditLimit: description: Flag to override account receivable credit limit type: boolean applyCurrencyTaxes: description: Flag to indicate if currency taxes need to be applied or not. For ex, in case of Chile, it depends upon nationality of the guest. type: boolean vATOffset: description: Flag to indicate if currency taxes need to be applied or not. For ex, in case of Chile, it depends upon nationality of the guest. type: boolean action: description: Payment action to know from where the payment has been made. $ref: '#/components/schemas/postPaymentActionType' folioWindowNo: type: integer cashierId: $ref: '#/components/schemas/cashierId' reservationId: $ref: '#/components/schemas/reservationId' generateFiscalPayload: description: Flag to indicate if a fiscal payload should be generated for the Payment. type: boolean fiscalTerminalId: description: Applicable for Fiscal Terminal. The ID of the terminal where the fiscal device is connected. type: string originalInvoice: description: User-defined original invoice number. type: string minLength: 0 maxLength: 40 invoiceType: description: Type of invoice specified in the originalInvoice field. type: string minLength: 0 maxLength: 10 originalTransactionNo: description: The unique identifier (transaction number) of the original payment being refunded. type: number advanceDeposit: description: Flag to indicate if the advance bill is being posted from deposits prior to check-in type: boolean links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' prepaidCardTransactionInfoType: type: object description: Prepaid Card Transactions properties: amount: description: Prepaid card transaction amount. $ref: '#/components/schemas/currencyAmountType_2' type: description: Prepaid card transaction type. $ref: '#/components/schemas/prepaidCardTrxTypeType' date: description: Prepaid card transaction date. type: string format: date maxLength: 8 transactionNo: description: Opera transaction number. type: integer vendorTransactionNo: description: Vendor transaction number. type: string minLength: 0 maxLength: 100 profileId: description: The guest name id associated to the card. $ref: '#/components/schemas/uniqueID_Type' source: description: Prepaid card transaction source. $ref: '#/components/schemas/prepaidCardTransactionSourceType' cancellable: description: Indicate if the transaction is cancellable or not. type: boolean fiscalRetryType: type: object description: Generate Fiscal Folio Retry Criteria type to be used for fiscal folio generation properties: hotelId: description: Hotel where the transaction belongs. type: string minLength: 0 maxLength: 20 folioSeqId: description: Fiscal Folio sequence ID stored in queue table. type: integer voidFolioModes: description: Different modes to perform void folio. $ref: '#/components/schemas/voidFolioModes' fiscalFolioInstruction: description: Defines the action of the retrival process. $ref: '#/components/schemas/fiscalFolioInstruction' receiptSummaryType: type: object description: Contains Receipt Details. properties: payeeInfo: description: Payee information for the Receipt. $ref: '#/components/schemas/payeeInfoType' receiptAmount: description: Receipt gross amount. $ref: '#/components/schemas/currencyAmountType_2' customNumbers: description: Custom Number. type: array maxItems: 5 items: type: string minLength: 0 maxLength: 200 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 receiptNo: description: Receipt Number. type: number receiptTypeDescription: description: Receipt Type Description. type: string minLength: 0 maxLength: 4000 transactionNo: description: Transaction Number. type: string minLength: 0 maxLength: 20 receiptType: description: Receipt Type. $ref: '#/components/schemas/receiptType' taxInvoice: description: Tax Invoice Number of the Receipt. type: string minLength: 0 maxLength: 40 billingChargesStatus: type: object description: Response when checking or inquiring the available options for a set of billing charges. properties: options: description: Set of consumables and the available options for each one. $ref: '#/components/schemas/checkPostBillingChargesOptionsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' financialPostings: type: object description: Response for fetching the Posting Journal. properties: journalPostings: description: Journal entries of the response. $ref: '#/components/schemas/financialPostingsType' 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' splitDepositTransaction: type: object description: Request to split deposit transaction for a reservation. properties: depositTransaction: description: Deposit transaction info to split. $ref: '#/components/schemas/depositTransactionType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' bedTaxInfoType: type: object description: Bed Trx Info type properties: hotelId: description: Property associated with bed tax type: string minLength: 0 maxLength: 20 taxRegistrationNo: description: Tax Registration Number type: integer taxArrivaldate: description: Arrival Date with time of the reservation type: string format: date maxLength: 8 arrivalCarrierCode: description: Arrival Carrier code of the mode of transportation (Airline No. or Railway No., etc.) type: string minLength: 0 maxLength: 20 taxDepartureDate: description: Departure Date with time of the reservation type: string format: date maxLength: 8 departureCarrierCode: description: Departure Carrier code of the mode of transportation (Airline No. or Railway No., etc.) type: string minLength: 0 maxLength: 20 guestName: description: Guest name associated with the transaction. type: string minLength: 0 maxLength: 200 reservationNameId: description: Reservation name id. $ref: '#/components/schemas/uniqueID_Type' guestNameId: description: Guest Name id. $ref: '#/components/schemas/uniqueID_Type' arrival: description: Arrival Date of the reservation type: string format: date maxLength: 8 departure: description: Departure Date with time of the reservation type: string format: date maxLength: 8 visaNumber: description: Visa Number type: string minLength: 0 maxLength: 40 visaIssueDate: description: Issue date of the Visa type: string format: date maxLength: 8 visaExpirationDate: description: Expiration date of visa type: string format: date maxLength: 8 taxNoOfStays: description: Total number of tax stays at the property type: integer profession: description: Profession of the guest type: string minLength: 0 maxLength: 80 passPortStr: description: Passport number type: string minLength: 0 maxLength: 80 passport: description: Passport number type: string minLength: 0 maxLength: 40 nationality: description: Nationality of the guest type: string minLength: 0 maxLength: 20 guestAge: description: Age of the guest type: integer country: description: Country of the guest type: string minLength: 0 maxLength: 20 remark: description: User-defined remark. type: string minLength: 0 maxLength: 200 folioTypesInfo: type: object description: Information regarding the Folio Types. properties: folioInfo: type: array items: $ref: '#/components/schemas/folioTypesInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' chargesCriteriaType: type: array description: Collection of Charges to be posted. maxItems: 4000 items: $ref: '#/components/schemas/chargeCriteriaType' 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 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 cCBatchSettlementStatusType: type: object description: Provides status information for credit card settlements . properties: settlementStatus: description: Status of credit card settlements. type: string settlementId: description: List of selected settlements id. $ref: '#/components/schemas/uniqueID_Type' reason: description: Batch Id for identify status of job. type: string minLength: 0 maxLength: 2000 trxSplitAndTransferCriteriaType: type: object description: Type to define the criteria for Splitting and Transferring the new transaction. properties: hotelId: description: Property code where the reservation transaction exists. type: string minLength: 0 maxLength: 20 transactionList: description: The unique transaction number of this transaction. type: array maxItems: 4000 items: type: number splitDetails: description: The criteria required for the transaction splitting. Splitting can be done either by an amount or by a percentage. Atleast one should be defined. type: object properties: amount: description: The Amount by which the transaction has to be split. $ref: '#/components/schemas/currencyAmountType_2' percentage: description: The percentage by which the transaction has to be split. type: number minimum: 0 maximum: 100 quantity: description: The quantity to split. This can be used only if the original quantity of the transaction(s) was > 1. type: integer cashierId: $ref: '#/components/schemas/cashierId' targetReservationIdList: description: Reservation Id where the new transactions will be transferred after the split. $ref: '#/components/schemas/uniqueIDListType' targetFolioWindowNo: description: Folio Window Number to where the new transactions , after split, will be transfered. type: integer postCompRedemptions: type: object description: Request type of complimentary bucket redemptions posting. properties: criteria: description: Criteria to post complimentary bucket redemptions request. type: object properties: membershipId: description: Membership number. type: string minLength: 0 maxLength: 100 compRedemptions: description: Complimentary bucket redemptions to post as payment. $ref: '#/components/schemas/compRedemptionsType' cashierId: description: Numeric ID of the cashier. $ref: '#/components/schemas/cashierId' folioView: description: Folio Window. type: integer warnings: $ref: '#/components/schemas/warningsType' resDepositPoliciesType: type: array description: A list of deposit policies attached with the reservation. maxItems: 4000 items: $ref: '#/components/schemas/resDepositPolicyType' folioActivityDetailType: type: object description: Details of Fiscal Folio Activity made. properties: fiscalBillNo: description: Fiscal Bill Number returned from Fiscal Program. type: string billNo: description: Bill Number. type: string folioType: description: Folio Type. type: string queueName: description: Queue Name. type: string billGenerationDate: description: Bill Generation Date. type: string status: description: Return Status from Fiscal Program Application (Fiscal Printer). type: string partnerFiscalFolioStatus: description: Fiscal folio status for the partner system. type: string responseAttemptNo: description: Number of fiscal response attempts made for the folio type: integer messageText: description: Return Message from Fiscal Printing Program. type: string changeCheckDetailsType: type: object description: Holds check details information. properties: checkText: description: Check text of the posting. type: string minLength: 0 maxLength: 32000 checkImage: description: Check image of the posting. type: string format: byte postingTimeType: type: object description: Time of posting. properties: time: description: Time of posting. type: string format: date-time timezone: description: Timezone associated with posting time. type: string reservationChargesInBatchInfoType: type: object description: Result of charges in batch for each reservation. properties: reservationId: $ref: '#/components/schemas/reservationId' arrivalDate: description: Arrival date of the reservation. type: string format: date-time departureDate: description: Departure date of the reservation. type: string format: date-time guestName: description: Guest name associated to the reservation. type: string minLength: 0 maxLength: 200 roomId: description: Room number associated to the reservation. type: string minLength: 0 maxLength: 20 postingAllowed: description: Indicator that tells whether posting is allowed for the reservation type: boolean success: $ref: '#/components/schemas/successType' warnings: $ref: '#/components/schemas/warningsType' errors: $ref: '#/components/schemas/errorsType' awardPaymentDetails: type: object description: Request object for fetching a membership transaction. properties: awardType: type: string description: Type of award that is used to redeem points. voucherNo: type: string description: Voucher number of redeemed award. redeemAmount: description: The value of amount or points that is being redeemed. type: integer pointsRequired: description: The number of points that are redeemed for this award. type: number folioView: description: Folio Window. type: integer billAmount: description: A monetary amount representing the outstanding balance. type: number links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' balanceInfoCriteria: type: object description: Response for the fetch balance request. This will contain the current balance for the criteria requested. properties: balance: description: The total balance for the set of charges. $ref: '#/components/schemas/currencyAmountType_2' postings: description: List of Postings produced for the set of charges. $ref: '#/components/schemas/summaryPostingsType' trxCodesInfo: description: Transaction codes information which are in response postings. $ref: '#/components/schemas/trxCodesInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' basicEmailType: type: string description: Email address minLength: 0 maxLength: 2000 acquiredCashierLock: type: object description: Response for the Cashier Lock request. properties: acquiredCashierLock: description: This contains the lock information for the cashier. $ref: '#/components/schemas/operaRecordLock' existingCashierLock: description: This will contain information about the cashier lock that is currently held by another user. $ref: '#/components/schemas/operaRecordLock' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' operaLockRecordType: type: string enum: - Reservation - Cashier routingInstructionsToChange: type: object description: Request when changing a routing instruction. properties: criteria: description: Transactions and scheduled instructions included in this routing element will be replaced with the new element. type: object properties: folio: description: Folio routing type. type: object properties: guestInfo: description: Guest details type: object properties: profileIdList: description: Unique identifiers for the Profile for both internal and external systems. $ref: '#/components/schemas/profileIdList' payeeInfo: $ref: '#/components/schemas/payeeInfoType' aRNumber: description: Accounts Receivable. type: string minLength: 0 maxLength: 20 instructions: description: Set of routing instructions associated to this routing type. type: array items: $ref: '#/components/schemas/routingInstructionType' paymentMethod: type: string maxLength: 2000 folioWindowNo: type: integer room: description: Room routing type. type: object properties: roomNumber: description: Room number to route the instructions. type: string minLength: 0 maxLength: 20 guestNameId: description: Guest unique identifier to which the instruction will be routed. $ref: '#/components/schemas/uniqueID_Type' guestDisplayName: description: Display Name for the guest. type: string minLength: 0 maxLength: 80 reservationNameId: description: Reservation name id to which the instruction will be routed. $ref: '#/components/schemas/uniqueID_Type' instructions: description: Set of routing instructions associated to this routing type. type: array items: $ref: '#/components/schemas/routingInstructionType' comp: description: Comp Accounting Routing Info type: object properties: compAccountingInfo: $ref: '#/components/schemas/compAccountingType' compRequestInfo: $ref: '#/components/schemas/compRoutingRequestType' payeeInfo: $ref: '#/components/schemas/payeeInfoType' instructions: description: Set of routing instructions associated to this routing type. type: array items: $ref: '#/components/schemas/routingInstructionType' folioWindowNo: type: integer request: description: Comp Accounting Request routing type: object properties: compRequestInfo: $ref: '#/components/schemas/compRoutingRequestType' instructions: description: Set of routing instructions associated to this routing type. type: array items: $ref: '#/components/schemas/routingInstructionType' hotelId: description: Hotel context of the reservation. type: string minLength: 0 maxLength: 20 reservationId: description: Unique ID of a reservation. $ref: '#/components/schemas/reservationId' refreshFolio: description: On a successful update, the transactions that are already posted in the guest's folio will be re-organized based on the configured instructions. type: boolean retrievePostingsForRoomRouting: description: This flag indicates if postings that can be refreshed need to be part of the response when a routing instruction is created, updated or deleted. type: boolean newRoutingInfo: description: Transactions and schedule instructions which will replace the base element. $ref: '#/components/schemas/routingInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' cardAuthorizationTransactionType: type: string description: Currently supported transaction type categories used for credit card authorization. enum: - Additional - ArPayment - Batch - BatchDeposit - BatchDepositRefund - Billing - CheckIn - CheckInManualAuth - Deposit - EndOfDay - EndOfDayDeposit - Manual - Other - PasserBy - PostIt - PreCheckIn - Refund - Scheduled operaRecordLock: type: object description: This type contains information about a record lock. properties: lockHandle: description: This is the identifier of the lock. This will be null when the requesting user does not own the lock. type: number recordType: description: This is the record type of the locked record. $ref: '#/components/schemas/operaLockRecordType' recordId: description: This is the id of the locked record. type: string createdBy: description: This is the user name of the current owner of the locked record. type: string createdOn: description: This is the time when the record was locked. type: string format: date maxLength: 8 timeToLive: description: This is the validity of the lock in seconds. type: number expiresOn: description: This is the estimated expiry time of the lock. type: string format: date maxLength: 8 internal: description: Notification flag to specify if the lock is based on an Internal Opera9 lock versus an External lock. type: boolean articleInfoType: type: object description: Information regarding an article. properties: description: description: Description of the article. type: string minLength: 0 maxLength: 2000 quantityInStock: description: Quantity in stock of the article type: integer minimum: -999999 maximum: 999999 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_2' 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 gamingRequestStatusInfo: type: object description: Response object for fetch gaming info properties: statusInfo: description: details of the guest request provided by the external system $ref: '#/components/schemas/gamingRequestStatusInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' earlyDepartureInfo: type: object description: 'Response for Early departure verification. Contains information regarding early departure penalty amount if applicable and any errors or warnings as to why the early departure cannot be done. Possible error codes are: FOF00152: An early departure could result in a change to the room rate, due to the reduced length of stay. FOF00153: Exchange Rates not setup for {currency code} . FOF00155: The partially consumed package(s) will be charged to the guest account. FOF00156: There is a Rate Code Restriction for {restriction information}. FOF00157: The reservation status is not valid for an early departure. FOF00158: Early Departure is not required as the reservation is already in Due Out status.' properties: earlyDepartureDetails: description: Information for the Early Departure. Has details regarding the Early Departure penalty if applicable for the property and reservation. $ref: '#/components/schemas/earlyDepartureInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' policyAmountPercentType: type: object description: Defines the percentage basis for calculating the fee amount or the amount. properties: basisType: description: Provides the basis for how the amount of the guarantee is calculated. $ref: '#/components/schemas/policyBasisTypeType' nights: description: The number of nights of the hotel stay that are used to calculate the fee amount. type: integer percent: description: The percentage used to calculate the amount. type: number minimum: 0 maximum: 100 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 hotelCashierTransactionType: type: object description: Cashier Shift amounts for each Hotel group by currency code properties: transactions: description: Hotel's transaction in cashier shift. type: array maxItems: 4000 items: $ref: '#/components/schemas/cashierTransactionType' hotelId: description: Hotel Code. type: string minLength: 0 maxLength: 20 extendedCashierLock: type: object description: This response will indicate whether or not the extension was successful. This operation may return errors when the lock being requested to be extended no longer exists. This can happen when the lock has already expired and cleaned up. properties: cashierLock: description: This contains the updated lock information for the cashier. The time to live will contain the updated lifetime of the lock. $ref: '#/components/schemas/operaRecordLock' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' folioPrintersType: type: object description: List of Folio Printers. properties: folioTypeName: description: Name of the Folio Type. type: string minLength: 0 maxLength: 200 printer: description: Folio Printer Information. type: array maxItems: 4000 items: $ref: '#/components/schemas/folioPrinterType' roundingDifferenceAmount: type: object description: Response to the request to fetch the rounding difference for a payment amount. properties: roundingDifference: description: The information regarding the rounding difference. $ref: '#/components/schemas/roundingDifferenceAmountType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' postPaymentActionType: type: string description: Advance Payment Action. enum: - Billing - Settlefolio - Deposit - Compredemption - Prepaidcardredemption - Advancepayment numericUDFsType: type: array description: Used to hold collection of user defined fields of Numeric Type. maxItems: 4000 items: $ref: '#/components/schemas/numericUDFType' reservationDepositFoliosInfoType: type: array description: Detailed information of a reservation and its deposit payment posting information. maxItems: 4000 items: $ref: '#/components/schemas/reservationDepositFolioInfoType' cashierLockHandle: type: number description: The Cashier Lock Handle to pass along with operation which required cashier to be locked. revenueBucketTotalType: type: object description: reservation revenue bucket total information. properties: revenueBucketCode: description: Holds Revenue Bucket Type details. $ref: '#/components/schemas/revenueBucketCodeType' totalAmount: description: Total amount related to the bucket. $ref: '#/components/schemas/currencyAmountType_2' offsetUnitType: type: string description: Indicates deadline offset unit type. enum: - Year - Month - Day - Hour revenueBucketTotals: type: object description: Response object for revenue bucket totals for a reservation. properties: revenueBucketsInfo: description: List of revenue bucket totals. $ref: '#/components/schemas/revenueBucketTotalsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' activityLogType: type: object properties: hotelId: type: string minLength: 0 maxLength: 20 module: type: string logDate: type: string format: date-time refActionId: type: number logUserId: type: integer logUserName: type: string machineStation: type: string croCode: type: string minLength: 0 maxLength: 20 actionType: type: string minLength: 0 maxLength: 100 actionDescription: type: string minLength: 0 maxLength: 2000 iPAddress: description: The IP Address of the machine that performed the activity type: string minLength: 0 maxLength: 2000 depositTransferCriteria: type: object description: Request to transfer a deposit amount from one reservation to one or more reservations. properties: criteria: description: Criteria for the deposit transfer between reservations. $ref: '#/components/schemas/depositTransferCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' depositTransferToReservationType: type: object description: Deposit Transfer detail for the target reservation. properties: reservationId: description: The unique ID of the reservation to which the deposit has to be transferred. $ref: '#/components/schemas/reservationId' transferAmount: description: The deposit amount which has to be transferred to this reservation. $ref: '#/components/schemas/currencyAmountType_2' cashierId: $ref: '#/components/schemas/cashierId' changePaymentCriteriaType: type: object properties: hotelId: description: Property code. type: string minLength: 0 maxLength: 20 transactionNo: description: Transaction number of the payment being corrected. type: number reference: description: Corrected user-defined posting reference. type: string minLength: 0 maxLength: 2000 remark: description: Corrected user-defined posting remark. type: string minLength: 0 maxLength: 2000 checkNumber: description: Corrected Cheque number. type: string minLength: 0 maxLength: 200 covers: description: POS covers type: string minLength: 0 maxLength: 10 depositTransactionId: description: Tax Service Accounting Codes used. type: string minLength: 0 maxLength: 40 cashierId: $ref: '#/components/schemas/cashierId' 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 phoneNumberType: type: string description: Phone number minLength: 0 maxLength: 40 hotelInterfaceStatusType: type: string description: Status of the Hotel Interface either STOPPED or RUNNING. enum: - Stopped - Running - Waiting - StopInitiated - StartInitiated - RebootInitiated - Other prepaidCardTransactionSourceType: type: string description: Vendor transaction source type. enum: - Opera - Vendor cashierClosureNoType: type: object description: Type used in cashier closure to specify a cashier's shift. properties: shiftDropLocationCode: description: Cashier closure shift drop location code. type: string minLength: 0 maxLength: 20 bagNumberForOthers: description: Cashier closure shift drop others payment method type bag number. type: string minLength: 0 maxLength: 15 bagNumberForCash: description: Cashier closure shift drop cash payment method type bag number. type: string minLength: 0 maxLength: 15 cashierId: description: The Cashier ID of the Cashier. $ref: '#/components/schemas/cashierId' closureNo: description: The Cashier Shift Number. type: number reservationOveragePaymentType: type: object description: Details of the reservation with the folio balance equal or higher to the credit limit properties: reservationId: description: Reservation id of the reservation $ref: '#/components/schemas/reservationId' guestName: description: Guest name of the listed reservation. type: string minLength: 0 maxLength: 2000 roomId: description: Room number on the reservation. type: string minLength: 0 maxLength: 20 windowNo: description: Window number associated where the balance is equal or higher to the credit limit on the method of payment. type: integer cardType: description: Identifies the credit card type. $ref: '#/components/schemas/cardTypeType' userDefinedCardType: description: Identifies the user defined credit card type if credit card type from a defined list is not provided. type: string minLength: 0 maxLength: 2 creditCardNo: description: Credit Card number / token (mask based on PCI compliance). type: string minLength: 0 maxLength: 80 cardExpirationDate: description: Expiration date of the credit card (mask based on PCI compliance) type: string minLength: 0 maxLength: 20 creditCardId: description: credit card id $ref: '#/components/schemas/uniqueID_Type' creditCardLimit: description: Credit Limit set for the credit card payment method. $ref: '#/components/schemas/currencyAmountType_2' balance: description: Amount that will be charge to the payment method in the folio window. $ref: '#/components/schemas/currencyAmountType_2' paymentMethod: description: Defines the unique identifier for this payment method. type: string minLength: 0 maxLength: 20 billingChargeType: type: object properties: transactionNo: description: Transaction number of the posting being corrected. type: number price: description: Corrected charge price. $ref: '#/components/schemas/currencyAmountType_2' quantity: description: Corrected posting quantity. type: integer reference: description: Corrected user-defined posting reference. type: string minLength: 0 maxLength: 2000 remark: description: Corrected user-defined posting remark. type: string minLength: 0 maxLength: 2000 checkNumber: description: Corrected Cheque number. type: string minLength: 0 maxLength: 200 revenueDate: description: Corrected Revenue Date. type: string format: date maxLength: 8 covers: description: POS covers. type: string minLength: 0 maxLength: 10 arrangementCode: description: Corrected arrangement code from the package associated to this transaction. type: string minLength: 0 maxLength: 20 approvalCode: description: Approval code of the posting. type: string minLength: 0 maxLength: 20 approvalStatus: description: Approval status of the posting. type: string minLength: 0 maxLength: 20 approvalDate: description: Approval date of the posting. type: string format: date maxLength: 8 cashierId: $ref: '#/components/schemas/cashierId' processFiscalRetry: type: object description: The request object to process fiscal retry functionality. properties: criteria: description: Criteria to call the fiscal service again. $ref: '#/components/schemas/fiscalRetryType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' redeemPrepaidCardCriteriaType: type: object description: Criteria for Prepaid card redeem request. properties: hotelId: description: Hotel code. type: string minLength: 0 maxLength: 20 reservationId: description: Reservation id of the reservation $ref: '#/components/schemas/reservationId' prepaidCardRedemptions: description: Prepaid Card redemption information used to post as payment. $ref: '#/components/schemas/prepaidCardRedemptionsType' cashierId: description: Numeric ID of the cashier. $ref: '#/components/schemas/cashierId' folioView: description: Folio Window. type: integer depositTransactionType: type: object description: Deposit transaction of a reservation. properties: hotelId: description: Property code where the reservation transaction exists. type: string minLength: 0 maxLength: 20 reservationId: description: Reservation id of the reservation $ref: '#/components/schemas/uniqueID_Type' transactionNo: description: The unique transaction number associated with transaction group. type: number splitAmount: description: The amount by which the deposit transaction has to be split. $ref: '#/components/schemas/currencyAmountType_2' originalAmount: description: The original deposited amount. $ref: '#/components/schemas/currencyAmountType_2' stringLength40: type: string description: Used for Character Strings, length 0 to 40. maxLength: 40 minLength: 0 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' depositMaturityInfoType: type: object description: Deposit maturity information type. properties: depositMaturityType: description: The Reservation's Deposit Status Type. When preference is set to Check In, the deposit is transferred when the guest checks in. When the preference is set to Last Night Stay,then the deposit is transferred during the last nights night audit. For example, if the departure date for a reservation is July 14th, then the deposit would be posted during the night audit for July 13th. $ref: '#/components/schemas/depositMaturityType' totalAmountTransferrable: description: Total Deposit Amount that can be transferred to another Reservation. $ref: '#/components/schemas/currencyAmountType_2' totalAmountDue: description: Total Deposit Amount which is due for this reservation. $ref: '#/components/schemas/currencyAmountType_2' transferTransactionToWindow: type: object description: Response Body. properties: transactions: description: Generated transaction number on destination window. type: array maxItems: 4000 items: type: number links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' autoFolioSettlementCriteriaType: type: object properties: folioSettlementTypes: description: Comma-delimited list of Folio Settlement Type codes. type: string defaultDays: description: Use the Number of Days For Settlement, defined for the Reservation. type: boolean daysSinceLastAutoSettled: description: Days since the last auto folio settlement. type: integer minimum: 1 maximum: 365 dateSinceLastAutoSettled: description: Date since the last auto folio settlement. type: string format: date maxLength: 8 generateFolioCriteriaType: type: object description: Generate Folio Criteria type to be used for folio generation request properties: folioNameValue: description: Custom Folio Name Value Information to be saved type: array maxItems: 4000 items: $ref: '#/components/schemas/nameValueHeaderDetailType' fiscalTerminalId: description: Applicable for Fiscal Terminal. The ID of the terminal where the fiscal device is connected. type: string hotelId: description: Property code. type: string minLength: 0 maxLength: 20 eventType: description: Event to which this process will be logged. $ref: '#/components/schemas/cashieringEventType' reservationId: description: Reservation identifier that will be used as the context of the available options. $ref: '#/components/schemas/reservationId' profileId: description: Profile Id corresponding to the guest name. $ref: '#/components/schemas/profileId' fiscalInvoicingCurrencyInfo: description: Exchange Rate information selected to be used by the Fiscal Service. $ref: '#/components/schemas/exchangeRateInfoType' associatedBillInfo: description: Bill Information of the original bill for which the Credit Bill is being generated . $ref: '#/components/schemas/associatedBillInfoType' folioQueue: description: Folio Type , Queue name , Fiscal Flag to be used in folio generation This is a country requirement. $ref: '#/components/schemas/folioQueueType' folioSeqId: description: Fiscal Folio sequence ID stored in queue table. type: integer fiscalFolioInstruction: description: Defines the action of the generate folio process. $ref: '#/components/schemas/fiscalFolioInstruction' folioTypeValidation: description: Override Instruction for the Folio Type $ref: '#/components/schemas/folioTypeValidationType' transactions: description: list of transaction. $ref: '#/components/schemas/transactionsType' transactionServiceType: description: Contains transaction service type. type: string minLength: 0 maxLength: 20 balance: description: Balance of a Reservation for this property. $ref: '#/components/schemas/currencyAmountType_2' folioWindowNo: type: integer allFolioWindow: description: Flag to decide if folios is to be generated for all windows in addition to the one requested with applicable postings and zero balance. If any of the windows have non-zero balance then folios are not generated for other windows. type: boolean correction: description: Correction flag type: boolean debitFolio: description: Indicates the type of folio to be generated type: boolean manualFolioNo: description: Manual Folio Number used for settlement during checkout type: integer cashierId: $ref: '#/components/schemas/cashierId' simpleFolio: description: This flag signifies that generated Folio is Normal or Simple Folio. Certain countries of the World mandate a simple folio when the invoice amount is less than defined threshold. type: boolean reason: description: The Reason Code and Reason Text which is required when a folio is generated. This input is mandatory when the parameter Credit Bill Reason is active for Credit Bills $ref: '#/components/schemas/folioReasonType' guestCountsType: type: object description: A collection of GuestCount by age group. properties: childAges: description: Defines Children's Ages. Number of children ages mentioned may mot match with children counts. $ref: '#/components/schemas/childAgesType' childBuckets: description: Defines children counts with Age Qualifying Group(Child Bucket#1) classification. $ref: '#/components/schemas/childBucketsType' adults: description: Defines the number of Adults. type: integer children: description: Defines the number of Children. type: integer 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 folioToWindow: type: object description: Request for transaction folio(s) to specific window properties: criteria: description: Folio(s) transfer criteria. $ref: '#/components/schemas/folioTransferCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' postRateCodeCheckType: type: object description: The response type for Checks done before Posting a Rate Code amount to a reservation. properties: rateCodeHasProducts: description: Indicates that the Rate Code has Products(Packages) for the user to determine if they should be posted. type: boolean canPostProducts: description: Indicates that the Products(Packages) which are included in the Rate Code cannot be posted as part of this transaction. This could be the case where the reservation is an Open Folio or has Post Stay. type: boolean canReverseProducts: description: Indicates that the Products(Packages) which are included in the Rate Code cannot be reversed as part of this transaction. This could be the case when the reservation has consumed the allowance already and is now trying to reverse the Rate Code by using a negative quantity. type: boolean postBillingCheckChargesItemsCriteriaType: type: array description: Line items of the check. maxItems: 4000 items: $ref: '#/components/schemas/postBillingCheckChargesItemCriteriaType' cCAuthorizationInstructionType: type: object description: Contains the details to use for a credit card authorization. properties: currentApprovalAmount: description: The current amount to authorize as part of this transaction. $ref: '#/components/schemas/currencyAmountType_2' totalApprovalAmount: description: The total amount authorized(including the current amount). $ref: '#/components/schemas/currencyAmountType_2' incidentalAmount: description: The incidental amount. $ref: '#/components/schemas/currencyAmountType_2' authorizationSetup: description: Indicates the Credit Card EFT payment method authorization rules setup. type: object properties: checkIn: description: Indicates if authorization at Check In is allowed for this payment method. False will indicate that no authorization will be done at Check In for this payment method. type: boolean stay: description: Indicates if authorization during the stay of the guest is allowed for this payment method. False will indicate that no authorization will be done during the stay and prior to settlements for this payment method. The settlement request will be sent without an authorization request. type: boolean deposit: description: Indicates if authorization at Deposit is allowed for this payment method. False will indicate that no authorization will be done at the time of deposit payments, for this payment method. The settlement request will be sent without an authorization request. type: boolean payOnly: description: Indicates if this payment method is setup as a PayOnly, which does not require authorization to be done prior to settlement. The special settlement handling will take care of both Authorization and Settlement together. type: boolean reservationDetail: description: Reservation Details required for the authorization. The details returned are Hotel Code, Reservation Id, Guest Name, Arrival Date, Departure Date, Create Date,Room , Reservation Balance and Payment Information. $ref: '#/components/schemas/reservationInfoType' paymentMethodInfo: $ref: '#/components/schemas/reservationPaymentMethodType' sequenceNumber: description: Unique sequence for this authorization. type: string minLength: 0 maxLength: 200 transactionType: description: Transaction type of the authorization(INIT or SUPP). type: string minLength: 0 maxLength: 40 originalAuthSequence: description: Unique Authorization Sequence for the authorization and settlement. type: integer usageType: description: Usage type used. type: string minLength: 0 maxLength: 20 vendorTranId: description: Vendor transaction id for the authorization. type: string minLength: 0 maxLength: 20 alternateTransRef: description: Alternate vendor transaction id for the authorization. type: string minLength: 0 maxLength: 64 initialAuthorizationRequired: description: Flag to indicate if initial authorization required. type: boolean businessDate: description: The current date of the Property. type: string format: date maxLength: 8 alertNotices: type: object description: Response with the fetched alerts, includes global alerts. properties: alerts: description: The Alert information returned as per the request. $ref: '#/components/schemas/alertsType' comments: description: List of Notes for the Guest related to the reservation. type: array items: $ref: '#/components/schemas/commentInfoType' 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. Refer to OpenTravel Code List Unique ID Type (UIT). 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 gamingRequestStatusInfoType: type: array description: List of guest request status details. maxItems: 4000 items: $ref: '#/components/schemas/gamingRequestStatusType' compTrxAuthorizers: type: object description: Response object for fetch comp authorizers operation. properties: authorizerInfo: description: List of authorizers eligible to perform the transfer. type: array items: $ref: '#/components/schemas/authorizerInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' customChargeExemptionDatesType: type: array description: Contains List of Custom Charge Exemption information for a day. maxItems: 4000 items: $ref: '#/components/schemas/customChargeExemptionDateType' paymentTaxInfoType: type: object description: Type for Package Tax Information for Thailand Tax functionality. properties: hotelId: description: Hotel context for the Reservation. type: string minLength: 0 maxLength: 20 reservationId: description: Reservation id for which the Payment Tax information is used. $ref: '#/components/schemas/reservationId' taxes: description: The payment tax records for this reservation. $ref: '#/components/schemas/paymentTaxesType' resvRoutingCriteriaType: type: object description: A routing info object can either be of type Folio OR of type Room with its corresponding object. properties: folio: description: Folio routing type. type: object properties: guestInfo: description: Guest details type: object properties: profileIdList: description: Unique identifiers for the Profile for both internal and external systems. $ref: '#/components/schemas/profileIdList' payeeInfo: $ref: '#/components/schemas/payeeInfoType' aRNumber: description: Accounts Receivable. type: string minLength: 0 maxLength: 20 instructions: description: Set of routing instructions associated to this routing type. type: array maxItems: 4000 items: $ref: '#/components/schemas/routingInstructionType' folioWindowNo: type: integer paymentMethod: type: string maxLength: 2000 room: description: Room routing type. type: object properties: roomId: description: Room number to route the instructions. type: string minLength: 0 maxLength: 20 guestNameId: description: Guest unique identifier to which the instruction will be routed. $ref: '#/components/schemas/uniqueID_Type' guestDisplayName: description: Display Name for the guest. type: string minLength: 0 maxLength: 80 reservationNameId: description: Reservation name id to which the instruction will be routed. $ref: '#/components/schemas/uniqueID_Type' instructions: description: Set of routing instructions associated to this routing type. type: array maxItems: 4000 items: $ref: '#/components/schemas/routingInstructionType' comp: description: Comp Accounting Routing Info type: object properties: compAccountingInfo: $ref: '#/components/schemas/compAccountingType' compRequestInfo: $ref: '#/components/schemas/compRoutingRequestType' payeeInfo: $ref: '#/components/schemas/payeeInfoType' instructions: description: Set of routing instructions associated to this routing type. type: array maxItems: 4000 items: $ref: '#/components/schemas/routingInstructionType' folioWindowNo: type: integer request: description: Comp Accounting Request routing type: object properties: compRequestInfo: $ref: '#/components/schemas/compRoutingRequestType' instructions: description: Set of routing instructions associated to this routing type. type: array maxItems: 4000 items: $ref: '#/components/schemas/routingInstructionType' refreshFolio: description: On a successful update, the transactions that are already posted in the guest's folio will be re-organized based on the configured instructions. type: boolean hotelId: description: Hotel context of the reservation. type: string minLength: 0 maxLength: 20 reservationId: description: Unique ID of a reservation. $ref: '#/components/schemas/reservationId' retrievePostingsForRoomRouting: description: This flag indicates if postings that can be refreshed need to be part of the response when a routing instruction is created, updated or deleted. type: boolean certificateReconciliationType: type: object description: FBA ( Flexible Benefits Awards ) related fields. properties: status: description: Possible FBA statuses. $ref: '#/components/schemas/fBAStatusType' monetaryValue: description: Award's FBA monetary values. type: number amount: description: Award's FBA amount. type: number postedAmount: description: Award's FBA posted amount. type: number reimbursedAmount: description: Award's FBA reimbursed amount. type: number postingDateTime: description: Date and time of the FBA posting. type: string format: date maxLength: 8 postingBusinessDate: description: Business date of the FBA posting. type: string format: date maxLength: 8 settlementDateTime: description: Date and time of the FBA settlement. type: string format: date maxLength: 8 settlementBusinessDate: description: Business date of the FBA settlement. type: string format: date maxLength: 8 reimbursementDateTime: description: Date and time of the FBA reimbursement. type: string format: date maxLength: 8 reimbursementBusinessDate: description: Business date of the FBA reimbursement. type: string format: date maxLength: 8 fbaBillGenDate: description: Business date of the FBA bill generation. type: string format: date maxLength: 8 currencyCode: description: The code specifying a monetary unit. Use ISO 4217, three alpha code. type: string minLength: 0 maxLength: 20 currencySymbol: description: The symbol for the currency, e.g, for currencyCode USD the symbol is $. type: string minLength: 0 maxLength: 10 decimalPlaces: description: Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard "minor unit". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces="2" to represent $85). type: integer flexibleBenefitAward: description: Indicates if this certificate is a Flexible Benefit Award certificate. type: boolean posted: description: Indicates whether FBA has been posted. type: boolean settled: description: Indicates whether FBA has been settled. type: boolean reimbursed: description: Indicates whether FBA has been reimbursed. type: boolean resettleAllowed: description: Marks if the certificate is eligible for resettlement type: boolean reimburseAllowed: description: Marks if the certificate is eligible for reimbursement. type: boolean orphanCertificate: description: Indicates whether the certificate is Orphan or not. type: boolean hotelId: description: Hotel context for the selected certificate. type: string minLength: 0 maxLength: 20 reservationId: description: Reservation name id to which the the certificate belongs to. $ref: '#/components/schemas/reservationId' fBAStatus: description: Possible FBA statuses. $ref: '#/components/schemas/fBAStatusType' certificateNumber: description: The number for the given certificate. type: string minLength: 0 maxLength: 20 trxCodesInfoType: type: array description: List of Transaction codes info. maxItems: 4000 items: $ref: '#/components/schemas/trxInfoType' folioToVoid: type: object description: Request to Void a Guest Folio when the Void Functionality is active. properties: criteria: description: Criteria for Voiding a Guest Folio. $ref: '#/components/schemas/voidFolioCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' folioReasonType: type: object description: Type for Folio Reason and Text. properties: code: description: The Folio Reason Code.Currently Applicable only for Credit Bills. type: string minLength: 0 maxLength: 20 text: description: The Folio Reason Text.Currently Applicable only for Credit Bills. type: string minLength: 0 maxLength: 2000 resCancelPenaltyType: type: object description: The CancelPenalty class defines the cancellation policy of the hotel facility. properties: deadline: description: Cancellation deadline, absolute or relative. $ref: '#/components/schemas/policyDeadlineType' amountPercent: description: Cancellation fee expressed as a fixed amount, or percentage of/or room nights. $ref: '#/components/schemas/policyAmountPercentType' penaltyDescription: description: Text description of the Penalty in a given language. type: string minLength: 0 maxLength: 2000 offsetUnit: $ref: '#/components/schemas/offsetUnitType' formattedRule: description: Formatted Text Rule of the Cancellation Penalty. type: string minLength: 0 maxLength: 2000 policyCode: description: Policy Code. type: string minLength: 0 maxLength: 20 manual: description: Flag to indicate if the cancellation policy is manual. type: boolean nonRefundable: description: Indicates if the amount is refundable if booking is canceled. type: boolean effective: description: Indicator if Cancellation Penalty is currently applicable or not. type: boolean reservationAllowedActionsType: type: array description: Allowed action. maxItems: 11 items: $ref: '#/components/schemas/reservationAllowedActionType' batchAdvanceFolio: type: object description: Request for submitting batch advance folio. properties: batchAdvanceFolio: description: Information regarding the reservations for batch advance folio processing. $ref: '#/components/schemas/batchAdvanceFolioType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' putBillingCharges: type: object description: Request to edit a billing charge information. properties: criteria: description: Criteria for the charge information to be edited. $ref: '#/components/schemas/billingChargesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' 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 searchMatchesType: type: array description: List of Generic Name-Value-Pair Parameters used for super search matches. maxItems: 4000 items: $ref: '#/components/schemas/searchMatchType' cashierClosureInfoTypes: type: array description: Information of the Cashier. maxItems: 4000 items: $ref: '#/components/schemas/cashierClosureInfoType' postBillingChargesInBatchCriteriaType: type: object description: Criteria type for posting charges. properties: hotelId: description: Property where the charges are to be posted. type: string minLength: 0 maxLength: 20 charges: description: Information regarding the charges which have to be posted. $ref: '#/components/schemas/chargesCriteriaType' reservations: $ref: '#/components/schemas/reservations' currencyExchangeType: type: string description: E-certificate conversion. enum: - Cash - Settlement - Posting - Check - TACommission - Membership - Certificate reservationVoucherType: type: object description: Reservation voucher detail. properties: amount: description: The amount value of the voucher. $ref: '#/components/schemas/currencyAmountType_2' status: description: Reflect the current status of the voucher. type: string enum: - Print - Reprint - New - Void voucherNo: description: Voucher no of the voucher type: number voucherDate: description: Date of the voucher type: string format: date maxLength: 10 reservationId: description: Reservation identifier that will be used as the context of the available options. $ref: '#/components/schemas/reservationId' trxCodesPostingInfoType: type: array description: List of TransactionCodes maxItems: 4000 items: $ref: '#/components/schemas/trxPostingInfoType' postRoomAndTaxForDayUse: type: object properties: reservationId: description: Reservation Id for which room and tax is to be posted. $ref: '#/components/schemas/uniqueID_Type' cashierId: description: The Cashier ID of the Cashier who is currently processing the transaction(s). $ref: '#/components/schemas/cashierId' warnings: $ref: '#/components/schemas/warningsType' stringLength200: type: string description: Used for Character Strings, length 0 to 200. maxLength: 200 minLength: 0 languageType: type: string minLength: 0 maxLength: 40 billingCheckChargesCriteria: type: object description: Request object for PostBillingCheckCharges operation. properties: check: description: Details of the check to be posted. $ref: '#/components/schemas/postBillingCheckChargesCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' paymentTaxesType: type: array description: Payment Tax record. maxItems: 4000 items: $ref: '#/components/schemas/paymentTaxType' 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 userInfoType: type: object description: Opera User Information properties: userId: description: User Id of the Opera User type: integer userName: description: Name of the Opera User type: string minLength: 0 maxLength: 40 reloadPrepaidCard: type: object description: Request type for reload prepaid card. properties: criteria: description: Prepaid card criteria type used to perform manage operation on the card. type: object properties: hotelId: description: Hotel code. type: string minLength: 0 maxLength: 20 cardNo: description: Prepaid card number. type: string minLength: 0 maxLength: 80 interfaceId: description: The unique ID for the Interface. $ref: '#/components/schemas/uniqueID_Type' profileId: description: The guest name id associated to the card. $ref: '#/components/schemas/uniqueID_Type' reservationId: description: The reservation name id where the transaction is associated. $ref: '#/components/schemas/uniqueID_Type' pin: description: PIN code associated for the prepaid card. type: string minLength: 0 maxLength: 80 amount: description: Prepaid card transaction amount. $ref: '#/components/schemas/currencyAmountType_2' cashierId: $ref: '#/components/schemas/cashierId' postChargeToRoom: description: Indicate that charges will be posted to the room. type: boolean saleCriteria: description: Represent the sale criteria. $ref: '#/components/schemas/saleCriteriaType' giftCard: description: Indicates a gift card type. type: boolean warnings: $ref: '#/components/schemas/warningsType' postSupplementalFolio: type: object description: Request to post a Supplemental Folio for an existing Folio. Debit Bill ( Supplemental Folio ) Functionality parameter is required properties: criteria: description: Criteria for creating the Supplemental Folio. This should include all charges and payments for the Supplemental Folio. $ref: '#/components/schemas/supplementalFolioCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' depositedPayment: type: object description: Response for the post deposit payment request. properties: deposits: description: Deposit payment information of the payment which was posted. $ref: '#/components/schemas/depositPostingsType' trxCodesInfo: description: Transaction codes information which are in response postings. $ref: '#/components/schemas/trxCodesInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' checkedRateCode: type: object description: Response for the request to check if a Rate Code can be posted to a reservation . properties: checks: description: Includes flags to indicate if Products(Packages) are included in the Rate Code and if Products(Packages) can be posted or reversed. $ref: '#/components/schemas/postRateCodeCheckType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' fiscalInfoFolioCriteria: type: object description: Request to generate fiscal Information folio. properties: criteria: description: Criteria for generating fiscal folio information. $ref: '#/components/schemas/fiscalInfoFolioCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' creditLimitOveragePayments: type: object description: Request to start the Credit Limit Overage process for the reservations with a folio window balance equal or higher to the credit limit set for the credit card payment method of that folio window. properties: criteria: description: Criteria for submitting the payments request for a reservation to start the Credit Limit Overage process. $ref: '#/components/schemas/reservationOveragePaymentsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' bulkPrepaidCardsStatusType: type: object description: Provides status information for bulk Prepaid Cards. properties: recordNumber: description: A unique identifying value assigned to the card. type: integer minLength: 0 maxLength: 80 responseCode: description: Status of prepaid card. type: string minLength: 0 maxLength: 2000 responseText: description: Status of prepaid card. type: string minLength: 0 maxLength: 2000 cashierReportType: type: string description: Shift drop report created when cashier closure is completed. It is an integral part of closure report and is not to be printed or accessed by itself. enum: - Cash - Check - ForeignCurrency - CreditCard - Miscellaneous - ArSettlements - DepositTransfers - Shiftdrop 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 trxAdjustCriteriaType: type: object properties: hotelId: description: Property code where the reservation transaction exists. type: string minLength: 0 maxLength: 20 reservationId: description: Unique identifier of the reservation. $ref: '#/components/schemas/reservationId' transactionList: description: The unique transaction number of this transaction. type: array maxItems: 4000 items: type: number details: description: The criteria required for the transaction adjustment. Adjustments can be done either by an amount or by a percentage. Atleast one should be defined. $ref: '#/components/schemas/adjustmentDetailsType' incomeAuditDate: description: Date of the Audit. This is used when postings are being created using the Income Audit functionality. type: string format: date maxLength: 8 aRAccountNo: description: The AR Account Number for the Account. type: string minLength: 0 maxLength: 20 aRInvoiceNo: description: The AR Invoice Number for the Account. type: number customChargeExemptionDetails: description: List of Custom Charge Exemptions. $ref: '#/components/schemas/customChargeExemptionsType' cashierId: $ref: '#/components/schemas/cashierId' resCancellationPoliciesType: type: array description: A list of reservation cancellation policies. maxItems: 4000 items: $ref: '#/components/schemas/resCancellationPolicyType' anonymizationStatusType: type: string description: Guest has been anonymized. enum: - Requested - Anonymized characterUDFType: type: object description: Used to hold user defined field of Character/String Type. properties: name: description: Used to hold user defined field of Character Type. It is highly recommended to use UDFC01, UDFC02,...UDFC40 (Total 40) as Character/String UDF names(commonly used on Reservation, Profile etc.). Name is not restricted using enumeration, to provide flexibility of different name usage if required. type: string minLength: 0 maxLength: 20 value: description: Value of user defined field. type: string minLength: 0 maxLength: 2000 alternateName: description: Label of user defined field used by vendors or customers. type: string minLength: 0 maxLength: 2000 policyDeadlineType: type: object description: Cancellation deadline, absolute or relative. properties: absoluteDeadline: description: Defines the absolute deadline. Either this or the offset attributes may be used. type: string format: date-time offsetFromArrival: description: The number of days before arrival that allows cancellation without penalties. type: integer offsetDropTime: description: Time on offset day the cancellation penalties applies. type: string format: date-time offsetFromBookingDate: description: The number of days after booking deposit must be paid. type: integer storedFolioDetailsInfo: type: object description: Response object for fetch stored folio details operation properties: storedFolioDetails: description: details of the Stored Folio $ref: '#/components/schemas/storedFolioDetailsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' fiscalInformationFolio: type: object description: Response Body. properties: fiscalResponseList: type: array description: Provides information which is used for fiscal response processing. maxItems: 4000 items: $ref: '#/components/schemas/fiscalResponseType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' childAgeType: type: object description: Defines Child's Age. properties: age: description: Age of a child in years. type: integer payloadType: description: Fiscal Payload Type. type: string enum: - CheckOut - FolioGeneration prepaidCardRedemptionsType: type: array description: A prepaid redemption info object to be used for posting a payment. maxItems: 1000 items: $ref: '#/components/schemas/prepaidCardRedemptionType' foliosType: type: array description: Folio History details. maxItems: 4000 items: $ref: '#/components/schemas/folioSummaryType' bedTaxInfoTypes: type: array description: List of Bed Tax info. maxItems: 4000 items: $ref: '#/components/schemas/bedTaxInfoType' validatedCreditBill: type: object description: Response to the request to check if a Folio is valid for Credit Bill. properties: folio: description: Contains Folio Details including payee information and the reservation which it's attached to. type: object properties: fiscalTerminalId: description: Applicable for Fiscal Terminal. The ID of the terminal where the fiscal device is connected. type: string maxLength: 2000 payeeInfo: description: Payee information for the folio. $ref: '#/components/schemas/payeeInfoType' folioAmount: description: Folio gross amount. $ref: '#/components/schemas/currencyAmountType_2' allowConvertFolioYn: description: Flag to check Folio Conversion Allowed. type: boolean accountReceivablesFolio: description: Flag to check Folio generated from Acoount Receivables. type: boolean paymentTrxNo: description: Bill Payment transaction Number. type: number reservationInfo: description: ReservationID to which this record applies. type: object properties: reservationId: description: ReservationID to which this record applies. type: number room: description: Room Number to which this record applies. type: string minLength: 0 maxLength: 20 nameId: description: Guest Name ID $ref: '#/components/schemas/uniqueID_Type' guestName: description: Guest Name type: string minLength: 0 maxLength: 200 altName: description: Guest Alternate Last and First Name type: string minLength: 0 maxLength: 200 postItNo: description: Number for Post-It transactions. type: number associatedBills: description: Bill Number. type: array items: type: string accountCode: description: Account Code. type: number payment: description: Payment Posting for the folio. $ref: '#/components/schemas/summaryPostingType' addresseeInfo: description: Addressee Information for the Folio. This is available when the Addressee functionality is used and and Addressee is attached to the folio. $ref: '#/components/schemas/profileInfoType' fiscalInvoicingCurrencyInfo: description: Exchange Rate information selected to be used by the Fiscal Service. $ref: '#/components/schemas/exchangeRateInfoType' anonymizedFolio: description: Indicates if this folio is linked to an anonymized Guest/Payee/Addressee. type: boolean start: description: The starting value of the date range. type: string format: date end: description: The ending value of the date range. type: string format: date revisionNo: description: Folio Revision number. type: number folioWindowNo: type: integer fiscalFolioNo: description: Bill Number returned by the Fiscal Printer. type: string minLength: 0 maxLength: 40 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: 40 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 folioStatus: $ref: '#/components/schemas/folioStatusType' queueName: description: Folio Queue name. type: string minLength: 0 maxLength: 2000 generateFiscalFolio: description: Fiscal folio flag to call fiscal Information folio web service. type: boolean creditableAmount: description: If the Property checks on the gross amount of the Original Folio,then this will be the remaining amount on the Original Folio that can be credited. $ref: '#/components/schemas/currencyAmountType_2' creditBillGenerated: description: A flag which indicates whether credit folio has been generated. type: boolean hasDepositTransfer: description: A flag which indicates whether selected folio has deposit transfer or not. type: boolean links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' folioCriteria: type: object description: Generate Folio request can be used to create a folio for checked in reservation or reservation with open folios properties: criteria: description: Property code of the reservation. $ref: '#/components/schemas/generateFolioCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' authorizationHistory: type: object description: The result element containing a history list of credit card authorizations for a particular reservation, filtered by the requested criteria. properties: folioHistory: description: The collection of credit card history records. type: array items: $ref: '#/components/schemas/authorizationHistoryType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' paragraphType: 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 vaultHTTPTransactionType: type: string enum: - CCUniqueID - CCNumber - FolioAuthorization transactionCurrencyExchangeInfoType: type: object description: Details of the Exchange Information for this transaction, if the posting was made in a currency different from the default currency. properties: description: description: Description or reference for this exchange. type: string minLength: 0 maxLength: 200 exchangeRate: description: The Buying rate used for this transaction. $ref: '#/components/schemas/currencyAmountType_2' currencyAmount: description: The foreign currency amount posted for this transaction. $ref: '#/components/schemas/currencyAmountType_2' amount: description: The converted default currency amount $ref: '#/components/schemas/currencyAmountType_2' commissionPercent: description: Percentage for commission used for the currency conversion. type: number code: description: Foreign Currency Code of the currency which was used to post this transaction. type: string minLength: 0 maxLength: 20 exchangeDate: description: The date when this exchange rate was set. type: string format: date maxLength: 8 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 reservationRoomOwnershipType: type: string description: Indicates if the assigned reservation room is an Owner/Referral or Regular room. enum: - Owner - Referral - Regular postingBreakdownType_2: type: object description: Details of a financial posting's breakdown. properties: grossAmount: description: Gross amount of posting. $ref: '#/components/schemas/currencyAmountType_3' netAmount: description: Net amount of posting. $ref: '#/components/schemas/currencyAmountType_3' taxes: type: array description: Taxes breakout associated to postings maxItems: 4000 items: $ref: '#/components/schemas/generatePostingType_2' detailPostingType_2: type: object description: Posting information of the transaction. properties: referenceTransactionNo: description: Generate transaction number for the Posting. type: number referencePackageTransactionNo: description: Package transaction number for the Posting. type: number remark: description: Posting remarks. type: string minLength: 0 maxLength: 2000 reference: description: User-defined posting reference. type: string minLength: 0 maxLength: 2000 checkNo: description: Check number for the posting. type: string minLength: 0 maxLength: 2000 checkCount: description: Check number count for the posting. type: string minLength: 0 maxLength: 2000 postedAmount: description: Actual currency amount posted. $ref: '#/components/schemas/currencyAmountType_3' price: description: Indicates the unit price of the consumption. $ref: '#/components/schemas/currencyAmountType_3' quantity: description: Indicates Quantity. type: number transactionType: description: This is the transaction type which says whether it is a Consumption(C), Payment (FC) or Package (PK) and it is inherited from transaction code. $ref: '#/components/schemas/cashieringTransactionTypeType' creditAmount: description: The amount posted as credit to the ledger. $ref: '#/components/schemas/currencyAmountType_3' debitAmount: description: The amount posted as debit to the ledger. $ref: '#/components/schemas/currencyAmountType_3' articleCode: description: Information regarding the Article(Using Articles Functionality) of this transaction. type: string minLength: 0 maxLength: 20 cashierInfo: $ref: '#/components/schemas/cashierInfoType' paidOut: description: Indicates if this transaction is a paid out transaction. type: boolean arrangementCode: description: Corrected arrangement code from the package associated to this transaction. type: string minLength: 0 maxLength: 20 groupTypeInfo: description: Information related to transaction grouping. $ref: '#/components/schemas/postingGroupType' rateCode: description: Rate code associated to this transaction. type: string minLength: 0 maxLength: 20 compRedemptionCode: description: Comp redemption code assiciated to the transaction. type: string minLength: 0 maxLength: 20 updateInfo: description: Update info associated to this transaction. type: object properties: updateDate: type: string format: date maxLength: 8 updateBy: type: string fbaCertificate: description: Flag indicates that the posting is Flexible Benefits Awards Certificate type: boolean taxInvoiceNo: description: Tax invoice number generated by payment tax. type: string minLength: 0 maxLength: 20 serviceRecovery: description: Flag to indicates service recovery type: boolean compPostingsInfo: description: Comp Postings information for the folio. $ref: '#/components/schemas/compPostingsType' financialTransactionIdList: description: Collection of unique identifiers of the financial transactions. $ref: '#/components/schemas/uniqueIDListType' exchange: description: Available when the Fetch Folio Search Type requests the amounts to be converted to a currency different from the Resort currency. $ref: '#/components/schemas/exchangeAmounts_2' approvalCode: description: Approval code of the posting. type: string minLength: 0 maxLength: 20 approvalStatus: description: Approval status of the posting. type: string minLength: 0 maxLength: 20 stampDuty: description: Flag to identify a Stamp Duty Transaction. type: boolean customCharge: description: Flag to identify a Custom Charge. type: boolean transactionNo: description: Unique Transaction Identifier. type: number transactionDate: description: Transaction Date. type: string format: date maxLength: 8 transactionCode: description: Billing Transaction Code. type: string minLength: 0 maxLength: 200 transactionDescription: description: Billing Transaction Description. type: string minLength: 0 maxLength: 2000 transactionAmount: description: The amount of the transaction. type: number postingDate: description: Date and time of posting. type: string format: date maxLength: 8 revenueDate: description: The date on which the transaction has its revenue effect. type: string format: date maxLength: 8 receiptNo: description: The receipt number of the transaction, if there is a receipt generated. type: number roundingDifferenceTrx: description: Indicator to determine if the posting was a posting for the Rounding Difference. type: boolean commissionable: description: Indicator to determine if the transaction is commissionable. type: boolean reversePaymentTransactionNo: description: Reverse payment transaction unique identifier. type: number canAdjustInvoice: description: Indicator to determine if the transaction can be adjusted. type: boolean depositTransactionId: description: Tax Service Accounting Codes used. type: string minLength: 0 maxLength: 40 hotelId: description: Property code. type: string minLength: 0 maxLength: 20 targetHotel: description: Cross property posting hotel code. type: string minLength: 0 maxLength: 20 subPostings: description: SubPostings for the posting. $ref: '#/components/schemas/summaryPostingsType' guestInfo: description: Details of the Guest information where this transaction was posted to. type: object properties: profileId: description: Profile Id corresponding to the guest name. It is sometimes possible to have a guest name but the profile id is null. $ref: '#/components/schemas/profileId' reservationId: description: Reservation Id corresponding to the guest name. It is sometimes possible to have a room number but the reservation id is null. $ref: '#/components/schemas/reservationId' guestName: description: Guest name associated with the transaction. type: string minLength: 0 maxLength: 2000 roomId: description: Room number associated with the transaction. type: string minLength: 0 maxLength: 20 confirmationNo: description: Confirmation number associated with the transaction. type: string minLength: 0 maxLength: 50 aRInfo: description: Details of the AR account if the posting was part of an AR invoice. $ref: '#/components/schemas/transactionARInfoType' currencyExchangeInfo: description: Currency exchange information if the posting was made using a currency different from the default currency. $ref: '#/components/schemas/transactionCurrencyExchangeInfoType_2' adjustmentInfo: description: Details regarding the adjustment made if the current transaction was created as a result of an adjustment. $ref: '#/components/schemas/transactionAdjustmentInfoType' paymentMethod: description: Defined method of payment for this transaction. $ref: '#/components/schemas/reservationPaymentMethodType_2' payeeInfo: description: Payee information for the folio. $ref: '#/components/schemas/payeeInfoType' miscellaneousInfo: type: object properties: createDateTime: type: string format: date-time covers: description: POS covers type: string minLength: 0 maxLength: 10 exchangeInformation: description: Exchange Information - text presentation of the exchange operation including formula, buy rate, etc. type: string minLength: 0 maxLength: 2000 folioWindowNo: type: integer folioNo: description: The Folio number of this posting, if there was a Folio already generated. type: number folioNoWithPrefix: description: The folio number with prefix value. type: string minLength: 0 maxLength: 200 internalFolioWindowID: description: Internal Unique id for the Folio Window. type: string revisionNo: type: number folioTypeName: description: The name of the Folio Type used for the Folio Number sequence. type: string minLength: 0 maxLength: 100 fiscalBillNo: description: The Fiscal Bill number of this posting type: string minLength: 0 maxLength: 2000 deferredTax: description: Flag to indicate if the Posting is a deferred tax record. Set to true only when the posting is a deferred tax record. Set to false only when the posting is not a deferred tax record. type: boolean generatePostingType_2: type: object description: Financial posting with their breakup properties: amount: description: Gross amount. $ref: '#/components/schemas/currencyAmountType_3' transactionNo: description: Transaction Number for which request is being submitted. type: number referenceTransactionNo: description: Generate transaction number for the Posting. type: number transactionCode: description: Unique identifier for the Transaction code. type: string minLength: 0 maxLength: 20 transactionDate: description: Transaction Date. type: string format: date maxLength: 8 resPaymentCardType_2: 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_3' approvalAmountNeeded: $ref: '#/components/schemas/currencyAmountType_3' 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 storeToCreditCardWallet: description: Indicate whether the credit card will be stored to the credit card wallet or not. type: boolean exchangeAmounts_2: type: object description: Converted values for the Exchange Currency requested. properties: debitAmount: description: The converted Guest Ledger Debit Amount. $ref: '#/components/schemas/currencyAmountType_3' creditAmount: description: The converted Guest Ledger Credit Amount. $ref: '#/components/schemas/currencyAmountType_3' summaryPostingType_2: type: object description: Posting details. properties: referenceTransactionNo: description: Generate transaction number for the Posting. type: number remark: description: Posting remarks. type: string minLength: 0 maxLength: 2000 reference: description: User-defined posting reference. type: string minLength: 0 maxLength: 2000 checkNo: description: Check number for the posting. type: string minLength: 0 maxLength: 2000 checkCount: description: Check number count for the posting. type: string minLength: 0 maxLength: 2000 postedAmount: description: Actual currency amount posted. $ref: '#/components/schemas/currencyAmountType_3' price: description: Indicates the unit price of the consumption. $ref: '#/components/schemas/currencyAmountType_3' quantity: description: Indicates Quantity. type: number transactionType: description: This is the transaction type which says whether it is a Consumption(C), Payment (FC) or Package (PK) and it is inherited from transaction code. $ref: '#/components/schemas/cashieringTransactionTypeType' creditAmount: description: The amount posted as credit to the ledger. $ref: '#/components/schemas/currencyAmountType_3' debitAmount: description: The amount posted as debit to the ledger. $ref: '#/components/schemas/currencyAmountType_3' articleCode: description: Information regarding the Article(Using Articles Functionality) of this transaction. type: string minLength: 0 maxLength: 20 cashierInfo: $ref: '#/components/schemas/cashierInfoType' paidOut: description: Indicates if this transaction is a paid out transaction. type: boolean arrangementCode: description: Corrected arrangement code from the package associated to this transaction. type: string minLength: 0 maxLength: 20 groupTypeInfo: description: Information related to transaction grouping. $ref: '#/components/schemas/postingGroupType' rateCode: description: Rate code associated to this transaction. type: string minLength: 0 maxLength: 20 compRedemptionCode: description: Comp redemption code assiciated to the transaction. type: string minLength: 0 maxLength: 20 updateInfo: description: Update info associated to this transaction. type: object properties: updateDate: type: string format: date maxLength: 8 updateBy: type: string fbaCertificate: description: Flag indicates that the posting is Flexible Benefits Awards Certificate type: boolean taxInvoiceNo: description: Tax invoice number generated by payment tax. type: string minLength: 0 maxLength: 20 serviceRecovery: description: Flag to indicates service recovery type: boolean compPostingsInfo: description: Comp Postings information for the folio. $ref: '#/components/schemas/compPostingsType' financialTransactionIdList: description: Collection of unique identifiers of the financial transactions. $ref: '#/components/schemas/uniqueIDListType' exchange: description: Available when the Fetch Folio Search Type requests the amounts to be converted to a currency different from the Resort currency. $ref: '#/components/schemas/exchangeAmounts_2' approvalCode: description: Approval code of the posting. type: string minLength: 0 maxLength: 20 approvalStatus: description: Approval status of the posting. type: string minLength: 0 maxLength: 20 stampDuty: description: Flag to identify a Stamp Duty Transaction. type: boolean customCharge: description: Flag to identify a Custom Charge. type: boolean transactionNo: description: Unique Transaction Identifier. type: number transactionDate: description: Transaction Date. type: string format: date maxLength: 8 transactionCode: description: Billing Transaction Code. type: string minLength: 0 maxLength: 200 transactionDescription: description: Billing Transaction Description. type: string minLength: 0 maxLength: 2000 transactionAmount: description: The amount of the transaction. type: number postingDate: description: Date and time of posting. type: string format: date maxLength: 8 postingTime: description: Time of posting. $ref: '#/components/schemas/postingTimeType' revenueDate: description: The date on which the transaction has its revenue effect. type: string format: date maxLength: 8 receiptNo: description: The receipt number of the transaction, if there is a receipt generated. type: number officialBIRReceiptExists: description: Flag to indicate if an Official Receipt is generated for the folio window. Applicable only in the Philippines. type: boolean roundingDifferenceTrx: description: Indicator to determine if the posting was a posting for the Rounding Difference. type: boolean commissionable: description: Indicator to determine if the transaction is commissionable. type: boolean reversePaymentTransactionNo: description: Reverse payment transaction unique identifier. type: number canAdjustInvoice: description: Indicator to determine if the transaction can be adjusted. type: boolean depositTransactionId: description: Tax Service Accounting Codes used. type: string minLength: 0 maxLength: 40 groupByCount: description: When some SummaryPostingsGroupBy element is send as request ,then this element will represent how many transactions rolled up into this Summary Posting Type. type: number folioWindowNo: description: The Folio Window number of this posting. type: integer deferredTax: description: Flag to indicate if the Posting is a deferred tax record. Set to true only when the posting is a deferred tax record. Set to false only when the posting is not a deferred tax record. type: boolean awardTransaction: description: Indicator to determine if the posting's transaction code is related to a payment award. type: boolean covers: description: POS covers type: string minLength: 0 maxLength: 10 proformaFlag: description: This flag indicates if it is a proforma posted transaction. type: string minLength: 0 maxLength: 20 reservationPaymentMethodType_2: type: object properties: paymentCard: $ref: '#/components/schemas/resPaymentCardType_2' balance: $ref: '#/components/schemas/currencyAmountType_3' authorizationRule: $ref: '#/components/schemas/authorizationRuleType_2' 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 financialPostingsNetVat_2: type: object description: Response for fetching the Posting Journal with Net and Vat breakdown. properties: financialPostings: description: Journal entries of the response. type: array maxItems: 4000 items: $ref: '#/components/schemas/financialPostingsNetVatType' totalPages: description: Evaluated total page count based on the requested max fetch count. 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 links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' authorizationRuleType_2: 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_3' percent: description: A percentage value if the authorization rule is percentage based. type: number transactionCurrencyExchangeInfoType_2: type: object description: Details of the Exchange Information for this transaction, if the posting was made in a currency different from the default currency. properties: description: description: Description or reference for this exchange. type: string minLength: 0 maxLength: 200 exchangeRate: description: The Buying rate used for this transaction. $ref: '#/components/schemas/currencyAmountType_3' currencyAmount: description: The foreign currency amount posted for this transaction. $ref: '#/components/schemas/currencyAmountType_3' amount: description: The converted default currency amount $ref: '#/components/schemas/currencyAmountType_3' commissionPercent: description: Percentage for commission used for the currency conversion. type: number code: description: Foreign Currency Code of the currency which was used to post this transaction. type: string minLength: 0 maxLength: 20 exchangeDate: description: The date when this exchange rate was set. type: string format: date maxLength: 8 currencyAmountType_3: 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: 20 responses: '406': description: Not acceptable. '414': description: Request URI Too Large '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/exceptionDetailType' '403': description: Forbidden '413': description: Request Entity Too Large '415': description: Unsupported Media Type '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/exceptionDetailType' '502': description: Bad Gateway '500': description: System Error content: application/json: schema: $ref: '#/components/schemas/exceptionDetailType' '503': description: Service Unavailable '401': description: Unauthorized '405': description: Method not allowed parameters: x-app-key: name: x-app-key description: Client or Partner 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}$ authKey: name: authorization description: Bearer token that needs to be passed which is generated post user authentication in: header required: true schema: type: string 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 Accept-Language: name: Accept-Language description: Language code in: header schema: type: string 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} 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 x-app-key_2: 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-app-key_3: 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}$ externalDocs: description: Find out more about Oracle Hospitality url: https://docs.oracle.com/en/industries/hospitality/integration_platforms.html x-refined-from: - oracle-hospitality-property-outbound-cshoutbound.json - oracle-hospitality-property-v1-csh.json - oracle-hospitality-property-v1-cshasync.json