openapi: 3.2.0
info:
  title: OPERA Cloud Customer Relationship Management Profile Statistics API
  description: APIs to cater for Customer Relationship Management (profile) functionality in OPERA Cloud.<br /><br /> There are different types of profiles in OPERA Cloud, including Guest, Company, Travel Agent, Source, Group, and Contact profile types.  A profile can store and display a wide range of information about the guest, company, travel agent etc., depending upon the type of profile.  For example, a guest profile can store the guest name, address, contact information, details on billing, membership benefits, preferences and much  more.  All profiles in OPERA when created are assigned a ProfileID.  This ID will be used throughout the CRM APIs.<br /><br /> Compatible with OPERA Cloud release 26.2.0.0.<br /><br /><p> This document and all content within is available under the Universal Permissive License v 1.0 (https://oss.oracle.com/licenses/upl). Copyright (c) 2020, 2026 Oracle and/or its affiliates.</p>
  version: 26.2.0.0
  termsOfService: https://www.oracle.com/legal/terms.html
  contact:
    email: hospitality_apis_ww_grp@oracle.com
  license:
    name: UPL
    url: https://opensource.org/licenses/upl
servers:
- url: /crm/v1
tags:
- name: ProfileStatistics
  description: These APIs will allow you to retrieve statistical data for a specified profile.
paths:
  /profileMembershipStatistics:
    get:
      summary: 'Get Membership statistics '
      description: Retrieve the summary statistics and/or the details of each of the membership transactions and its points.  You can filter by membership Type, or Membership Number. <p><strong>OperationId:</strong>getProfileMembershipStatistics</p> <p>This API allows a time span of <strong>90</strong> days.</p>
      operationId: getProfileMembershipStatistics
      parameters:
      - name: profileId
        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: membershipCardNo
        in: query
        required: true
        description: Number of the membership card.
        schema:
          type: string
      - name: membershipType
        in: query
        required: true
        description: Type of membership.
        schema:
          type: string
      - name: startDate
        in: query
        required: false
        schema:
          type: string
          format: date
      - name: endDate
        in: query
        required: false
        schema:
          type: string
          format: date
      - name: transactionDate
        in: query
        required: false
        schema:
          type: string
          format: date
      - name: hotelId
        in: query
        required: false
        description: Membership transaction belongs to which Hotel.
        schema:
          type: string
      - name: confirmationNumber
        in: query
        required: false
        description: Confirmation Number of the membership transaction.
        schema:
          type: string
      - name: limit
        in: query
        required: false
        description: Indicates maximum number of records a Web Service should return.
        schema:
          type: integer
          default: 20
      - 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: 1
      - name: duration
        in: query
        required: false
        schema:
          type: string
      - name: transactionDetail
        in: query
        required: false
        description: Flag indicating whether to fetch detailed membership points information or just a summary of the total of the points.
        schema:
          type: boolean
          default: false
      - name: reference
        in: query
        required: false
        description: User-defined reference field for the Membership Transaction Adjustment.
        schema:
          type: string
          maxLength: 20
          minLength: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response of the WS operation FetchProfileMembershipPoints. It contains the summary statistics and/or the details of each of the membership transactions and its points.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/profileMembershipStatistics'
        '204':
          description: ProfileMembershipStatistics 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:
      - ProfileStatistics
  /profileStatistics:
    get:
      summary: Get Profile Statistics
      description: This API provides summary/detail/revenue statistics information <p><strong>OperationId:</strong>getProfileStatistics</p> <p>This API allows a time span of <strong>90</strong> days.</p>
      operationId: getProfileStatistics
      parameters:
      - name: profileId
        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: hotelIds
        in: query
        description: Hotel code.
        required: true
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            maxItems: 4000
      - name: reportType
        in: query
        required: true
        description: Indicate to get revenue of Stay Records.
        schema:
          type: string
          enum:
          - Reservation
          - Revenue
          - ProfileStayRecords
          - DetailStayRecordsRevenue
          uniqueItems: true
      - name: stayFrom
        in: query
        required: false
        description: Stay from date for report
        schema:
          type: string
          format: date
      - name: stayTo
        in: query
        required: false
        description: Stay to date for report
        schema:
          type: string
          format: date
      - name: summary
        in: query
        required: false
        description: Flag to indicate whether summary/detail report is requested.
        schema:
          type: boolean
      - name: passerBy
        in: query
        required: false
        description: Flag to include passerBy records.
        schema:
          type: boolean
      - name: contactProfileRoleType
        in: query
        required: false
        description: Profile Role Type All.
        schema:
          type: string
          enum:
          - AccountContact
          - AgentContact
          - ReservationContact
          - ReservationBillingContact
          - All
          uniqueItems: true
      - name: stayRecordId
        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: stayRecordIdContext
        in: query
        required: false
        description: Used to identify the source of the identifier (e.g., IATA, ABTA).
        schema:
          type: string
      - name: stayRecordIdType
        in: query
        required: false
        description: A reference to the type of object defined by the UniqueID element.
        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.
        schema:
          type: string
      - name: currencyCode
        in: query
        required: false
        description: Indicates currency in which the stay revenue must be rendered.
        schema:
          type: string
      - name: limit
        in: query
        required: false
        description: Indicates maximum number of records a Web Service should return.
        schema:
          type: integer
          default: 20
      - 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: 1
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response object for fetching profile stay/reservation/revenue statistics. This object contains collection of summary or detail,Success,Warnings and Errors related to this operation.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/profileStatistics'
        '204':
          description: ProfileStatistics 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:
      - ProfileStatistics
  /services/profileStats/status:
    get:
      summary: Operation to check the status of ProfileStats service
      description: ' <p><strong>OperationId:</strong>pingProfileStatsService</p>'
      operationId: pingProfileStatsService
      parameters:
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response for Ping operation.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/operaVersion'
        '204':
          description: pingProfileStatsService 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:
      - ProfileStatistics
components:
  schemas:
    profileStatistics:
      type: object
      description: Response object for fetching profile stay/reservation/revenue statistics. This object contains collection of summary or detail,Success,Warnings and Errors related to this operation.
      properties:
        profileStatistic:
          description: Contains summary/detail/revenue statistics information.
          $ref: '#/components/schemas/profileStatisticsType'
        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'
    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
    guestHousekeepingServiceRequestType:
      type: string
      description: Possible values for the Guest Service Status.
      enum:
      - DoNotDisturb
      - MakeUpRoom
      - NoStatusSelected
    resAccompanyGuestInfoType:
      type: object
      properties:
        firstName:
          description: Given name, first name or names
          type: string
        lastName:
          description: Family name, last name.
          type: string
        fullName:
          description: String representation of the full name
          type: string
        registrationCardNo:
          description: Unique identifier of the police registration card number.
          type: string
          minLength: 0
          maxLength: 40
        profileIdList:
          description: Unique identifiers for the Profile for both internal and external systems. In case of Travel Agent the IATA code and in case of Company can be any form of identifier as id.
          $ref: '#/components/schemas/profileIdList'
    stayInfoType:
      type: object
      description: Details on the Room Stay including Guest Counts, Time Span of this Room Stay, pointers to Res Guests, guest Memberships, Comments and Special Requests pertaining to this particular Room Stay and finally financial information related to the Room Stay, including Guarantee, Deposit and Payment and Cancellation Penalties.
      properties:
        arrivalDate:
          type: string
          format: date
        departureDate:
          type: string
          format: date
        originalTimeSpan:
          description: The Original Time Span covers the Room Stay dates of the original reservation.
          $ref: '#/components/schemas/timeSpanType'
        expectedTimes:
          description: The expected arrival, return and departure times of the guest.
          $ref: '#/components/schemas/resExpectedTimesType'
        adultCount:
          description: A collection of Guest Counts associated with Room Stay.
          type: integer
        childCount:
          description: A collection of Child Counts associated with Room Stay.
          type: integer
        roomClass:
          description: Room class code
          type: string
          minLength: 0
          maxLength: 20
        roomType:
          description: Room type code
          type: string
          minLength: 0
          maxLength: 20
        componentRoomType:
          description: True indicates room type is a component type.
          type: boolean
        numberOfRooms:
          description: Room Id
          type: integer
        roomId:
          description: Room Id
          type: string
          minLength: 0
          maxLength: 20
        ratePlanCode:
          description: Rate plan code
          type: string
          minLength: 0
          maxLength: 20
        rateAmount:
          description: Rate amount
          $ref: '#/components/schemas/currencyAmountType'
        points:
          description: The Points contains the number of points used to book a particular room type.
          $ref: '#/components/schemas/pointsType'
        rateSuppressed:
          description: Whether this rate should be suppressed from view
          type: boolean
        reservationBlock:
          description: Key information about the block for this reservation.
          $ref: '#/components/schemas/reservationBlockType'
        bookingChannelCode:
          description: Booking channel code
          type: string
          minLength: 0
          maxLength: 20
        linkCode:
          description: Party code
          type: string
          maxLength: 2000
        fixedRate:
          description: True if the rate is a fixed rate, otherwise false
          type: boolean
        totalAmount:
          description: The total amount charged for the Room Stay including additional occupant amounts and fees. If TaxInclusive is set to True, then taxes are included in the total amount.
          $ref: '#/components/schemas/currencyAmountType'
        guarantee:
          description: The guarantee information associated to the Room Stay. A maximum of 5 occurances are available for use depending on the context.
          $ref: '#/components/schemas/resGuaranteeType'
        promotion:
          description: Promotion Codes
          $ref: '#/components/schemas/promotionType'
        marketCode:
          description: Market code
          type: string
          minLength: 0
          maxLength: 20
        marketDescription:
          description: Description of Market code
          type: string
          minLength: 0
          maxLength: 4000
        sourceCode:
          description: Source of business
          type: string
          minLength: 0
          maxLength: 20
        sourceCodeDescription:
          description: Description of the source of business.
          type: string
          minLength: 0
          maxLength: 4000
        balance:
          description: Balance amount
          $ref: '#/components/schemas/currencyAmountType'
        compBalance:
          description: Comp Balance amount
          $ref: '#/components/schemas/currencyAmountType'
        roomTypeCharged:
          description: Room type code that was charged
          type: string
          minLength: 0
          maxLength: 20
        depositPayments:
          description: A collection of deposit and/or payments for the Room Stay.
          $ref: '#/components/schemas/currencyAmountType'
        guestServiceStatus:
          description: Service Status of In House guest like DND or MUP
          $ref: '#/components/schemas/guestHousekeepingServiceRequestType'
        scheduledCheckoutTime:
          description: Indicates that this reservation is scheduled for automated check out.
          type: string
          format: date
        roomNumberLocked:
          description: When true, indicates a room number cannot be changed. When false, indicates a room number may be changed.
          type: boolean
        pseudoRoom:
          description: True indicates as pseudo room type. This is usually used for a posting master reservation.
          type: boolean
        assignedByAI:
          description: Represents the room was assigned by AI Room Assignment.
          type: boolean
        upgradedByAI:
          description: Represents the room was assigned by AI Room Assignment.
          type: boolean
    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
    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
    statisticsRevenueTypeType:
      type: object
      description: Contains Revenue information
      properties:
        revenueAmount:
          type: number
        revenueLabel:
          type: string
          minLength: 0
          maxLength: 20
    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
    stayDetailSummaryType:
      type: object
      description: Contains stay related information such as reservation nights,room nights,arrival rooms,cancel rooms,etc.
      properties:
        roomNights:
          type: integer
        arrivalRooms:
          type: integer
        cancelRooms:
          type: integer
        noShowRooms:
          type: integer
        dayUseRooms:
          type: integer
        totalBooked:
          description: Total Booked Stays/Reservations for Profile
          type: integer
        totalStays:
          description: Total Stayed Reservations for Profile
          type: integer
        stayReservation:
          $ref: '#/components/schemas/stayReservationType'
    stayReservationType:
      type: string
      description: Enumeration for stay types.
      enum:
      - Transient
      - Block
    reservationFolioWindowsType:
      type: array
      description: Collection of reservation folio windows.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/reservationFolioWindowType'
    namePrefixType:
      type: string
      description: Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.). Currently this attribute is not used for PUT and POST operations.
      minLength: 0
      maxLength: 40
    membershipTierPointsType:
      type: object
      description: Collection of the tier points.
      properties:
        revenuePoints:
          description: Sum of the base revenue and bonus revenue points.
          type: integer
        nightPoints:
          description: Sum of the base night and bonus night points.
          type: integer
        stayPoints:
          description: Sum of the base stay and bonus stay points.
          type: integer
        pointsCost:
          description: Points Cost.
          type: integer
        pointsCreditDate:
          description: Date when points were created.
          type: string
          format: date
          maxLength: 8
    membershipTransactionInfoType:
      type: object
      description: Specific details regarding the transaction.
      properties:
        transactionDate:
          description: Membership Transaction Date.
          type: string
          format: date
          maxLength: 8
        transactionType:
          description: Membership Transaction Type.
          type: string
          minLength: 0
          maxLength: 20
        stayTimeSpan:
          description: Begin and end dates of the reservation.
          $ref: '#/components/schemas/timeSpanType'
        reservationIdList:
          description: The different reservation related ids. e.g. ResvNameId, ConfirmationNo or from an unknown PMS system.
          $ref: '#/components/schemas/reservationIdList'
        stay:
          description: Total stay.
          type: integer
        nights:
          description: Total nights.
          type: integer
        hotelId:
          description: Resort of the transaction.
          type: string
          minLength: 0
          maxLength: 20
        currencyCode:
          description: Code type of the type of currency.
          type: string
          minLength: 0
          maxLength: 20
        reference:
          description: User-defined reference field for the Membership Transaction Adjustment.
          type: string
          minLength: 1
          maxLength: 20
        membershipCardNo:
          description: The card number associated with this membership transaction.
          type: string
          minLength: 0
          maxLength: 50
        membershipLevel:
          description: The membership level associated with the membership transaction.
          type: string
          minLength: 0
          maxLength: 20
        userName:
          description: User who inserted or updated the membership transaction.
          type: string
          minLength: 0
          maxLength: 256
        referredMemNameId:
          description: Name ID of the profile referred.
          type: integer
        referredDisplayName:
          description: Display Name of the profile that is going to be referred.
          type: string
    resAccessRestrictionType:
      type: string
      description: Indicates any Updates/Changes on the reservation as well as Reservation Cancellation are not allowed.
      enum:
      - Change
      - Cancel
      - ChangeOrCancel
    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
    reservationIdList:
      type: array
      description: Unique Id that references an object uniquely in the system.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/uniqueID_Type'
    communicationStatusType:
      type: string
      description: Enum to denote the Status of Readiness messages sent to Guest Devices.
      enum:
      - Pending
      - Completed
      - Failed
      - Sent
      - Received
      - Cancelled
      - PendingAvailability
    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
    revenueTransactionCodeListType:
      type: object
      description: List of revenue by transaction codes.
      properties:
        revenueTransactionCodes:
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/revenueTransactionCode'
    profileHotelStatisticsbyYearSummaryType:
      type: object
      description: Contains stay statistics summary information by year
      properties:
        stayDetail:
          type: array
          maxItems: 2
          items:
            $ref: '#/components/schemas/stayDetailSummaryType'
        netRevenue:
          type: array
          maxItems: 2
          items:
            $ref: '#/components/schemas/stayStatisticsRevenueType'
        year:
          type: string
        hotelId:
          type: string
          minLength: 0
          maxLength: 20
        netRevenueByTransactionType:
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/statisticsRevenueTypeType'
    resPaymentCardType:
      type: object
      description: Information on a credit card for the customer.
      properties:
        cardId:
          description: credit card id
          $ref: '#/components/schemas/uniqueID_Type'
        currentAuthorizedAmount:
          $ref: '#/components/schemas/currencyAmountType'
        approvalAmountNeeded:
          $ref: '#/components/schemas/currencyAmountType'
        approvalCode:
          description: Approval code sent by the credit card company on a successful authorization.
          type: string
          minLength: 0
          maxLength: 20
        cardType:
          description: Indicates the type of credit card from a defined list
          $ref: '#/components/schemas/cardTypeType'
        userDefinedCardType:
          description: Indicates the user defined credit card type if credit card type from a defined list is not provided
          type: string
          minLength: 0
          maxLength: 2
        cardNumber:
          type: string
          minLength: 0
          maxLength: 80
        cardNumberMasked:
          type: string
          minLength: 0
          maxLength: 80
        cardNumberLast4Digits:
          type: string
          minLength: 0
          maxLength: 80
        expirationDate:
          description: Expiration date of the credit card
          type: string
          format: date
          maxLength: 8
        expirationDateMasked:
          description: Masked Expiration date of the credit card
          type: string
          minLength: 0
          maxLength: 20
        expirationDateExpired:
          type: boolean
        cardHolderName:
          type: string
          minLength: 0
          maxLength: 200
        attachCreditCardToProfile:
          description: Attach the credit card to profile.
          type: boolean
        processing:
          description: This contains information on whether EFT is enabled. A value of 'C' indicates EFT is enabled and 'M' indicates manual authorization is available for this payment card type.
          $ref: '#/components/schemas/cardProcessingType'
        swiped:
          type: boolean
        cardPresent:
          description: Flag to determine if the credit card was swiped/manually entered , This element is only used when PAYMENT SERVICE DIRECTIVE(PSD) Opera Control is active.
          type: boolean
        cardOrToken:
          description: This contains information on whether credit card is tokenized (token enabled). A value of 'Token' indicates credit card is token enabled and 'CardNumber' indicates non token environment for this payment card type.
          $ref: '#/components/schemas/cardNumberTypeType'
        citId:
          description: Customer Initiated Transaction(CIT) Id for Credit Cards. This is only used when PAYMENT SERVICES DIRECTIVE (PSD2) Opera Control is active.
          type: string
          minLength: 0
          maxLength: 30
    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
    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'
    reservationPaymentMethodType:
      type: object
      properties:
        paymentCard:
          $ref: '#/components/schemas/resPaymentCardType'
        balance:
          $ref: '#/components/schemas/currencyAmountType'
        authorizationRule:
          $ref: '#/components/schemas/authorizationRuleType'
        emailFolioInfo:
          description: Information on an email for the customer.
          type: object
          properties:
            email:
              description: eMail deatils for the profile.
              $ref: '#/components/schemas/emailType'
            emailFolio:
              type: boolean
            id:
              description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
              type: string
              minLength: 0
              maxLength: 80
            type:
              description: A reference to the type of object defined by the UniqueID element.
              type: string
              minLength: 0
              maxLength: 40
        paymentMethod:
          type: string
          minLength: 0
          maxLength: 20
        description:
          type: string
          minLength: 0
          maxLength: 2000
        folioView:
          type: integer
    characterUDFsType:
      type: array
      description: Used to hold collection of user defined fields of Character/String Type.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/characterUDFType'
    indicatorsType:
      type: array
      description: Collection of lamp indicators.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/indicatorType'
    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
    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
    profileMembershipStatistics:
      type: object
      description: Response of the WS operation FetchProfileMembershipPoints. It contains the summary statistics and/or the details of each of the membership transactions and its points.
      properties:
        membershipStatistics:
          description: the summary statistics and/or the details of each of the membership transactions and its points.
          $ref: '#/components/schemas/membershipStatisticsType'
        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'
    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
    stayMembershipSummaryType:
      type: object
      description: Rendering membership type and membership card number associated to a stay.
      properties:
        membershipType:
          type: string
          minLength: 0
          maxLength: 20
        membershipCard:
          type: string
          minLength: 0
          maxLength: 20
    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
    warningsType:
      type: array
      description: Used in conjunction with the Success element to define a business error.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/warningType'
    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
    revenueStatisticsSummaryListType:
      type: array
      description: List of the detailed and yearly summarized information about the profile revenue.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/revenueStatisticsSummaryType'
    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'
    cardNumberTypeType:
      type: string
      description: Simple type for indicating if credit card number is tokenized.
      enum:
      - CardNumber
      - Token
    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
        idContext:
          description: Used to identify the source of the identifier (e.g., IATA, ABTA).
          type: string
          minLength: 0
          maxLength: 80
    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 resposible 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
        isValidated:
          description: Indicator to define if the Phone number is validated by the Phone Validation System.
          type: boolean
    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
    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
    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'
    stayMembershipSummaryListType:
      type: object
      description: Details about stay membership.
      properties:
        membershipInfo:
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/stayMembershipSummaryType'
    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
    resProfileTypeType:
      type: string
      enum:
      - Guest
      - Company
      - Group
      - TravelAgent
      - Source
      - ReservationContact
      - BillingContact
      - Addressee
    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
    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
    statisticsReportType:
      type: string
      enum:
      - Reservation
      - Revenue
      - ProfileStayRecords
      - DetailStayRecordsRevenue
      - ProfileStayRecordUdfs
      description: Indicate to get revenue of Stay Records.
    membershipStatisticsSummaryType:
      type: object
      description: Totals of the each of the points.
      properties:
        awardPoints:
          description: Total of the award points from all the transactions.
          type: integer
        tierRevenuePoints:
          description: Total of the Tier Revenue points from all the transactions.
          type: integer
        tierNightPoints:
          description: Total of the Tier Night points from all the transactions.
          type: integer
        tierStayPoints:
          description: Total of the Tier Stay points from all the transactions.
          type: integer
        pointsCost:
          description: Total of the Points Cost from all the transactions.
          type: integer
    hotelInterfaceType:
      type: object
      properties:
        interfaceId:
          description: Unique DB internal number of a Hotel Interface record.
          $ref: '#/components/schemas/uniqueID_Type'
        hotelId:
          description: Hotel Code
          type: string
          minLength: 0
          maxLength: 20
        interfaceName:
          description: Name of the Hotel Interface
          type: string
          minLength: 0
          maxLength: 40
        interfaceType:
          description: Three letter code for each interface that identifies the interface.
          $ref: '#/components/schemas/hotelInterfaceTypeType'
        logo:
          description: Hotel Interface Logo. On the database, this is also referred as DBF Logo. This is a three letter code followed by an underscore(_). This tells us which DBF files and log files with the prefix that IFC7 is going to create.
          type: string
          minLength: 0
          maxLength: 20
        machineName:
          description: Unique machine name of the running IFC.
          type: string
          minLength: 0
          maxLength: 80
        status:
          description: The current status of the IFC.
          $ref: '#/components/schemas/hotelInterfaceStatusType'
        activeFlag:
          description: Indicator if the Hotel Interface is active or not. This is different from the Interface Status, which is either STOPPED or RUNNING.
          type: boolean
    cardProcessingType:
      type: string
      enum:
      - Eft
      - Manual
    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
    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
    revenueBucketListType:
      type: object
      description: Details about revenue summary.
      properties:
        bucket:
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/revenueBucketType'
    revenueStatisticsDetailType:
      type: object
      description: The different statistics from the revenue of a profile.
      properties:
        stayTimeSpan:
          description: The stay time span of the reservation.
          $ref: '#/components/schemas/timeSpanType'
        guestName:
          description: Name Of The Guest.
          type: string
          minLength: 0
          maxLength: 200
        profileIdList:
          description: Id of the guest profile in the reservation.
          $ref: '#/components/schemas/profileIdList'
        reservationIdList:
          description: Id of the reservation.
          $ref: '#/components/schemas/reservationIdList'
        revenueType:
          description: Revenue Type for Stay.
          type: string
          minLength: 0
          maxLength: 20
        revenueBuckets:
          description: The different revenue buckets of a profile.
          $ref: '#/components/schemas/revenueBucketListType'
        centralRevenue:
          description: Central Revenue Type for Stay.
          type: number
        localRevenue:
          description: Local Revenue Type for Stay.
          type: number
        hotelId:
          description: Hotel of the reservation.
          type: string
          minLength: 0
          maxLength: 20
    stayStatisticsDetailListType:
      type: array
      description: Collection of stay statistics detail information
      maxItems: 4000
      items:
        $ref: '#/components/schemas/stayStatisticsDetailType'
    nameTypeType:
      type: string
      enum:
      - Guest
      - Company
      - Agent
      - Contact
      - Source
      - Group
      - Employee
      - Hotel
      - Purge
    membershipInfoType:
      type: object
      description: The Membership object identifies the frequent customer reward program.
      properties:
        membershipId:
          description: Membership ID (Unique ID from the memberships table).
          type: number
        programCode:
          description: The code or name of the membership program ('Hertz', 'AAdvantage', etc.).
          type: string
          minLength: 0
          maxLength: 20
        bonusCode:
          description: The code or name of the bonus program. BonusCode can be used to indicate the level of membership (Gold Club, Platinum member, etc.)
          type: string
          minLength: 0
          maxLength: 20
        membershipTypeDesc:
          description: The description of the ProgramCode.(Delta Previlige for code DP)
          type: string
          minLength: 0
          maxLength: 2000
        membershipLevelDesc:
          description: The description of the Bonus Code.(Platinum for code P)
          type: string
          minLength: 0
          maxLength: 2000
        accountId:
          description: The account identification number for this particular member in this particular program.
          type: string
          minLength: 0
          maxLength: 50
        membershipLevel:
          description: The code or name of the membership level and indicates the level of membership (Gold Club, Platinum member, etc.). This is same as the BonusCode.
          type: string
          minLength: 0
          maxLength: 20
        playerRanking:
          description: Ranking assigned to the Player Profile by the Gaming system.
          type: integer
    profileStatisticsType:
      type: object
      description: Contains summary/detail/Revenue statistics information for Profile.
      properties:
        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'
        stayStatisticsSummaryList:
          description: List of summary profile stay statistics.
          $ref: '#/components/schemas/statisticsSummaryListType'
        stayStatisticsDetailList:
          description: List of detailed profile stay statistics.
          $ref: '#/components/schemas/stayStatisticsDetailListType'
        revenueStatisticsSummaryList:
          description: List of summary profile revenue statistics.
          $ref: '#/components/schemas/revenueStatisticsSummaryListType'
        stayMembershipSummaryList:
          description: List of summary profile membership statistics.
          $ref: '#/components/schemas/stayMembershipSummaryListType'
        reportType:
          description: Contains the statistical report(Reservation, Revenue, Stay Records) type.
          $ref: '#/components/schemas/statisticsReportType'
    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
    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
    resAccompanyGuestListType:
      type: array
      description: Collection of accompany guests
      maxItems: 4000
      items:
        $ref: '#/components/schemas/resAccompanyGuestInfoType'
    blockIdList:
      type: array
      description: Unique Id that references an object uniquely in the system.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/uniqueID_Type'
    basicEmailType:
      type: string
      description: Email address
      minLength: 0
      maxLength: 2000
    resSharedGuestListType:
      type: array
      description: Collection of shared guest reservations.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/resSharedGuestInfoType'
    revenueBucketType:
      type: object
      description: The different revenue buckets of a profile.
      properties:
        code:
          description: Code of revenue type.
          type: string
          minLength: 0
          maxLength: 40
        description:
          description: Description of revenue type.
          type: string
          minLength: 0
          maxLength: 100
        value:
          description: Value of revenue.
          type: number
    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
    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
    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
    membershipTransactionSummaryType:
      type: object
      description: Details regarding a transaction of a profile membership.
      properties:
        transactionInfo:
          description: Transaction type fields.
          $ref: '#/components/schemas/membershipTransactionInfoType'
        pointsCalculated:
          description: Flag to indicate if points are calculated.
          type: boolean
        awardPoints:
          description: Award Points.
          type: integer
        tierPoints:
          description: Collection of tier points.
          $ref: '#/components/schemas/membershipTierPointsType'
        userName:
          description: User who inserted or updated the record.
          type: string
          minLength: 0
          maxLength: 200
        url:
          description: URL that identifies the location associated with the record identified by the UniqueID.
          type: string
        type:
          description: A reference to the type of object defined by the UniqueID element.
          type: string
          minLength: 0
          maxLength: 20
        instance:
          description: The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.
          type: string
          minLength: 0
          maxLength: 80
        idContext:
          description: Used to identify the source of the identifier (e.g., IATA, ABTA).
          type: string
          minLength: 0
          maxLength: 80
        id:
          description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
          type: string
          minLength: 0
          maxLength: 80
        idExtension:
          description: Additional identifying value assigned by the creating system.
          type: integer
    stayStatisticsDetailType:
      type: object
      description: Contains stay statistics detail information
      properties:
        stayDetail:
          $ref: '#/components/schemas/stayDetailType'
        revenue:
          $ref: '#/components/schemas/stayStatisticsRevenueType'
        year:
          type: string
        hotelId:
          type: string
          minLength: 0
          maxLength: 20
    surnameType:
      type: string
      description: Family name, last name.
      minLength: 0
      maxLength: 80
    guestLastStayInfoType:
      type: object
      description: Contains last stay related details of the guest.
      properties:
        lastStayDate:
          description: Guest's last stay date.
          type: string
          format: date
          maxLength: 8
        lastStayRoom:
          description: Room Number where the guest stayed.
          type: string
          minLength: 0
          maxLength: 20
        lastStayRate:
          description: The Rate amount of the guest's last stay.
          $ref: '#/components/schemas/currencyAmountType'
        totalStay:
          description: The total number of previous stay of the guest.
          type: integer
    revenueTransactionCode:
      type: object
      description: Revenue by transaction codes.
      properties:
        transactionDate:
          description: Transaction date.
          type: string
          format: date
          maxLength: 8
        transactionCode:
          description: Transaction code.
          type: string
          minLength: 0
          maxLength: 20
        transactionCodeDescription:
          description: Description of transaction code.
          type: string
          minLength: 0
          maxLength: 2000
        transactionCodeType:
          description: Transaction code type.
          type: string
          minLength: 0
          maxLength: 2
        transactionCodeTypeDescription:
          description: Description of transaction code type.
          type: string
          minLength: 0
          maxLength: 40
        centralRevenue:
          description: Central Revenue for Stay.
          type: number
        localRevenue:
          description: Local Revenue for Stay.
          type: number
        qualifyingForPoints:
          description: Flag to indicate if revenue qualifies for points.
          type: boolean
    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
    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
    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
    facilityCodesType:
      type: array
      description: List of the facility codes.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/facilityCodeType'
    resAttachedProfileListType:
      type: array
      maxItems: 4000
      items:
        $ref: '#/components/schemas/resAttachedProfileType'
    numericUDFsType:
      type: array
      description: Used to hold collection of user defined fields of Numeric Type.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/numericUDFType'
    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
    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'
    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
    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
    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
    givenNameType:
      type: string
      description: Given name, first name or names
      minLength: 0
      maxLength: 40
    stayStatisticsRevenueType:
      type: object
      description: Contains different list of stay statistics revenue information
      properties:
        averageDailyRate:
          $ref: '#/components/schemas/statisticsRevenueTypeType'
        totalRevenue:
          $ref: '#/components/schemas/statisticsRevenueTypeType'
        roomRevenue:
          $ref: '#/components/schemas/statisticsRevenueTypeType'
        fBRevenue:
          $ref: '#/components/schemas/statisticsRevenueTypeType'
        extraRevenue:
          $ref: '#/components/schemas/statisticsRevenueTypeType'
        nonRevenue:
          $ref: '#/components/schemas/statisticsRevenueTypeType'
        currency:
          type: string
        stayReservation:
          $ref: '#/components/schemas/stayReservationType'
    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
    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
    resRevenueBalanceType:
      type: object
      description: Revenue and Balance Amount summary for the reservation.
      properties:
        totalFixedCharge:
          description: Total Fixed Charges on the reservation.
          $ref: '#/components/schemas/currencyAmountType'
        totalPayment:
          description: Total payment received for the reservation.
          $ref: '#/components/schemas/currencyAmountType'
        roomRevenue:
          description: Room Revenue generated by the reservation.
          $ref: '#/components/schemas/currencyAmountType'
        foodAndBevRevenue:
          description: Food and Beverage Revenue generated by the reservation.
          $ref: '#/components/schemas/currencyAmountType'
        otherRevenue:
          description: Other Revenue generated by the reservation.
          $ref: '#/components/schemas/currencyAmountType'
        nonRevenue:
          description: Total Non Revenue posted on the reservation.
          $ref: '#/components/schemas/currencyAmountType'
        totalRevenue:
          description: Total Revenue generated by the reservation.
          $ref: '#/components/schemas/currencyAmountType'
        balance:
          description: Balance amount on the reservation.
          $ref: '#/components/schemas/currencyAmountType'
        compBalance:
          description: Comp Balance amount
          $ref: '#/components/schemas/currencyAmountType'
    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
    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
    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'
    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
        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 resposible 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
        isValidated:
          description: Indicator to define if the Email is validated by the Email Validation System.
          type: boolean
    operaVersionNumberType:
      type: string
      description: Current Opera Version Number
      minLength: 0
      maxLength: 40
    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). Currently this attribute is not used.
          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 resposible 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
    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
    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
    reservationAllowedActionsType:
      type: array
      description: Allowed action.
      maxItems: 11
      items:
        $ref: '#/components/schemas/reservationAllowedActionType'
    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'
    profileStatisticsbyYearSummaryType:
      type: object
      description: Contains stay statistics summary information by year
      properties:
        stayDetail:
          type: array
          maxItems: 2
          items:
            $ref: '#/components/schemas/stayDetailSummaryType'
        netRevenue:
          type: array
          maxItems: 2
          items:
            $ref: '#/components/schemas/stayStatisticsRevenueType'
        year:
          type: string
        netRevenueByTransactionType:
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/statisticsRevenueTypeType'
    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
    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
    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'
    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
    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
    resPreConfiguredRoutingInstrType:
      type: object
      description: Instruction to attach Pre-Configured Routing Instructions to a Reservation.
      properties:
        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
    revenueStatisticsDetailListType:
      type: array
      description: The collection of profile revenue statistics.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/revenueStatisticsDetailType'
    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
    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
    stayDetailType:
      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 resposible 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
        complimentaray:
          description: Indicates the profile stay record is complimentaray.
          type: boolean
        reservationSourceCode:
          description: Indicates the profile stay record reservation source code.
          type: string
          minLength: 0
          maxLength: 20
        reservationSourceType:
          description: Indicates the profile stay record reservation source Type.
          type: string
          minLength: 0
          maxLength: 50
        shareNumber:
          description: Indicates the share Number for Stay if reservation was a share.
          type: string
          minLength: 0
          maxLength: 20
        bookingDate:
          description: Booking date of the stay record.
          type: string
          format: date
          maxLength: 8
        bookedArrivalDate:
          description: Booked arrival date of the stay record.
          type: string
          format: date
          maxLength: 8
        bookedDepartureDate:
          description: Booked departure date of the stay record.
          type: string
          format: date
          maxLength: 8
        cancellationDate:
          description: Cancellation date of the stay record.
          type: string
          format: date
          maxLength: 8
        cancelledRoomNights:
          description: Number of cancelled room nights.
          type: integer
        noShowRoomNights:
          description: Number of no show room nights.
          type: integer
        travelAgentReferenceId:
          description: Travel Agent reference number for stay record.
          type: string
          minLength: 0
          maxLength: 60
        allotmentCode:
          description: Allotment Code for stay record.
          type: string
          minLength: 0
          maxLength: 20
        primarySharer:
          description: Indicates whether the guest was the primary sharer or not.
          type: boolean
        exchangeRate:
          description: Exchange Rate.
          type: number
        promotionCode:
          description: Promotion code associated with the stay.
          type: string
          minLength: 0
          maxLength: 20
        bookedRoomType:
          description: Indicate the category of room originally booked.
          type: string
          minLength: 0
          maxLength: 20
        channelCode:
          description: Indicate channel for stay.
          type: string
          minLength: 0
          maxLength: 20
        stayRecordId:
          description: Stay Record identifier.
          $ref: '#/components/schemas/uniqueID_Type'
        userDefinedFields:
          description: Collection of user defined fields.
          $ref: '#/components/schemas/userDefinedFieldsType'
    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.). Currently this attribute is not used for PUT and POST operations.
          $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.). Currently this attribute is not used for PUT and POST operations.
          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
    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
    reservationFolioWindowType:
      type: object
      description: Folio window view which holds the set of folios for a reservation.
      properties:
        payeeInfo:
          description: The window's configured payee information.
          $ref: '#/components/schemas/payeeInfoType'
        balance:
          description: Running balance of the window.
          $ref: '#/components/schemas/currencyAmountType'
        paymentMethod:
          description: Payment Method Type
          type: string
          minLength: 0
          maxLength: 20
        folioWindowNo:
          type: integer
    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
    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
    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:
        type:
          description: A reference to the type of object defined by the UniqueID element.
          type: string
          minLength: 0
          maxLength: 20
        instance:
          description: The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.
          type: string
          minLength: 0
          maxLength: 80
        idContext:
          description: Used to identify the source of the identifier (e.g., IATA, ABTA).
          type: string
          minLength: 0
          maxLength: 80
        id:
          description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
          type: string
          minLength: 0
          maxLength: 80
    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
    membershipStatisticsType:
      type: object
      description: List of membership transactions and the summary of the different total points statistics.
      properties:
        statisticsSummary:
          description: Totals summary of the several points.
          $ref: '#/components/schemas/membershipStatisticsSummaryType'
        transactions:
          description: Activity or a transaction related to the Membership.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/membershipTransactionSummaryType'
        type:
          description: The type of membership.
          type: string
          minLength: 0
          maxLength: 20
        cardNumber:
          description: The membership card number.
          type: string
          minLength: 0
          maxLength: 50
        level:
          description: The level of the membership.
          type: string
          minLength: 0
          maxLength: 20
    profileIdList:
      type: array
      description: Unique Id that references an object uniquely in the system.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/uniqueID_Type'
    statisticsSummaryListType:
      type: object
      description: Collection of Profile statistics summary information
      properties:
        profileHotelStatisticsbyYearSummary:
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/profileHotelStatisticsbyYearSummaryType'
        profileStatisticsbyYearSummary:
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/profileStatisticsbyYearSummaryType'
    revenueStatisticsSummaryType:
      type: object
      description: Summary of the revenue for a year
      properties:
        revenueDetails:
          description: Details regarding the profile revenue belonging to the specified year.
          $ref: '#/components/schemas/revenueStatisticsDetailListType'
        revenueBucketsSummary:
          description: Details about revenue summary.
          $ref: '#/components/schemas/revenueBucketListType'
        revenueTransactionCodes:
          description: Details about revenue by transaction codes.
          $ref: '#/components/schemas/revenueTransactionCodeListType'
        year:
          description: Year of the revenue.
          type: string
          minLength: 4
          maxLength: 4
    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'
    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'
    reservationAllowedActionType:
      type: string
      description: Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation.
      enum:
      - Cancel
      - Move
      - PreCharge
      - PostCharge
      - FacilitySchedule
      - Upsell
      - PreCheckIn
      - PostToNoShowCancel
      - NoShow
      - NameChange
      - Discount
      - EnrollToPrimaryMembership
      - EnrollInProgress
    links:
      type: array
      items:
        $ref: '#/components/schemas/instanceLink'
    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
    authorizationRuleType:
      type: object
      description: Configured rule for computing the amount to authorize.
      properties:
        code:
          description: The authorization rule code.
          type: integer
          pattern: '[0-9]{1,9}'
        amount:
          description: The amount applicable to the authorization rule.
          $ref: '#/components/schemas/currencyAmountType'
        percent:
          description: A percentage value if the authorization rule is percentage based.
          type: number
    commissionPayoutToType:
      type: string
      enum:
      - TravelAgent
      - Source
      - TravelAgentSource
      - None
    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
    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
  responses:
    '406':
      description: Not acceptable.
    '414':
      description: Request URI Too Large
    '503':
      description: Service Unavailable
    '413':
      description: Request Entity Too Large
    '500':
      description: System Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/exceptionDetailType'
    '400':
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/exceptionDetailType'
    '502':
      description: Bad Gateway
    '403':
      description: Forbidden
    '415':
      description: Unsupported Media Type
    '404':
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/exceptionDetailType'
    '401':
      description: Unauthorized
    '405':
      description: Method not allowed
  parameters:
    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
    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
    Accept-Language:
      name: Accept-Language
      description: Language code
      in: header
      schema:
        type: string
    x-app-key:
      name: x-app-key
      description: Client or Partner's Application Key
      in: header
      required: true
      schema:
        type: string
        pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$
    x-externalsystem:
      name: x-externalsystem
      description: External system code.
      in: header
      x-example: EXTERNALSYSTEMCODE
      schema:
        type: string
        maxLength: 40
    x-originating-application:
      name: x-originating-application
      description: Customer's Integration Application Id
      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}
externalDocs:
  description: Find out more about Oracle Hospitality
  url: https://docs.oracle.com/en/industries/hospitality/integration_platforms.html