openapi: 3.2.0
info:
  title: OPERA Cloud Front Desk Configuration Accounts Receivables Config API
  description: APIs to cater for Front Desk Configuration in OPERA Cloud. Here you can find operations to get, post, put and delete front desk codes such as commission codes, transaction groups, codes & subgroups, articles, payment methods and credit card types.<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,2023 Oracle and/or its affiliates.</p><br /><br /> Compatible with OPERA Cloud release 20.99.99.99.<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: /fof/config/v1
tags:
- name: AccountsReceivablesConfig
  description: The Accounts Receivables Config module offers the capability of creating, managing, and retrieving of Accounts Receivables configuration.
paths:
  /accountTypes:
    put:
      summary: Operation to modify AR Account Types.
      description: Operation to change account types. <p><strong>OperationId:</strong>putARAccountTypes</p>
      operationId: putARAccountTypes
      parameters:
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: Response Body.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/status'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - AccountsReceivablesConfig
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/arAccountTypes'
        description: Request object for changing account types.
        required: true
    post:
      summary: Operation to create AR Account Types.
      description: Operation to create account types. <p><strong>OperationId:</strong>postARAccountTypes</p>
      operationId: postARAccountTypes
      parameters:
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '201':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: HATEOAS links which help the consumer to navigate to resources
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/status'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - AccountsReceivablesConfig
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/arAccountTypes'
        description: Request object to create account receivables account types
        required: true
    delete:
      summary: Operation to remove AR Account types.
      description: Operation to remove account types. <p><strong>OperationId:</strong>deleteARAccountTypes</p>
      operationId: deleteARAccountTypes
      parameters:
      - name: hotelId
        in: query
        description: Property associated with account type
        required: true
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: accountTypes
        in: query
        description: Account receivable account type
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: HATEOAS links which help the consumer to navigate to resources
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/status'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - AccountsReceivablesConfig
  /flaggedReasons:
    get:
      summary: Operation to fetch AR flagged reasons.
      description: ' <p><strong>OperationId:</strong>getARFlaggedReasons</p>'
      operationId: getARFlaggedReasons
      parameters:
      - name: reasonCodes
        in: query
        description: Codes to be searched.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: reasonWildCard
        in: query
        required: false
        description: Wildcard search on the code.
        schema:
          type: string
      - name: description
        in: query
        required: false
        description: Description text set to the search criteria
        schema:
          type: string
      - name: propertyCodes
        in: query
        description: Codes to be searched.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: propertyWildCard
        in: query
        required: false
        description: Wildcard search on the code.
        schema:
          type: string
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response for fetching Flagged Reasons.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/arFlaggedReasons'
        '204':
          description: ARFlaggedReasons 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:
      - AccountsReceivablesConfig
    put:
      summary: Operation to change AR flagged reasons.
      description: ' <p><strong>OperationId:</strong>putARFlaggedReasons</p>'
      operationId: putARFlaggedReasons
      parameters:
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: Response Body.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/status'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - AccountsReceivablesConfig
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/arFlaggedReasons'
        description: Request object to edit Flagged Reasons.
        required: true
    post:
      summary: Operation to create AR flagged reasons.
      description: ' <p><strong>OperationId:</strong>postARFlaggedReasons</p>'
      operationId: postARFlaggedReasons
      parameters:
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '201':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: HATEOAS links which help the consumer to navigate to resources
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/status'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - AccountsReceivablesConfig
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/arFlaggedReasons'
        description: Request object to create Flagged Reason
        required: true
    delete:
      summary: Operation to remove AR flagged reasons.
      description: ' <p><strong>OperationId:</strong>deleteARFlaggedReasons</p>'
      operationId: deleteARFlaggedReasons
      parameters:
      - name: hotelIds
        in: query
        description: Hotel where the code is configured.
        required: true
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: codes
        in: query
        description: Configuration code.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: HATEOAS links which help the consumer to navigate to resources
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/status'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - AccountsReceivablesConfig
  /hotels/{hotelId}/ARAccountTypes:
    get:
      summary: Operation to fetch AR account types.
      description: Operation to fetch account types. <p><strong>OperationId:</strong>getARAccountTypes</p>
      operationId: getARAccountTypes
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Unique ID of the hotel in OPERA
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: accountType
        in: query
        required: false
        description: Account receivable account type
        schema:
          type: string
      - name: description
        in: query
        required: false
        description: Full description of account type
        schema:
          type: string
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response for fetch account types
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/arAccountTypes'
        '204':
          description: ARAccountTypes 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:
      - AccountsReceivablesConfig
  /services/accountsReceivables/status:
    get:
      summary: Operation to ping.
      description: ' <p><strong>OperationId:</strong>pingAccountsReceivables</p>'
      operationId: pingAccountsReceivables
      parameters:
      - name: operaPingInput
        in: query
        required: false
        description: Opera Ping request input type
        schema:
          type: string
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response for Ping operation.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/operaVersion'
        '204':
          description: pingAccountsReceivables 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:
      - AccountsReceivablesConfig
  /upsert/accountTypes:
    put:
      summary: Operation to modify/create AR Account Types.
      description: Operation to change/create account types. <p><strong>OperationId:</strong>putUpsertARAccountTypes</p>
      operationId: putUpsertARAccountTypes
      parameters:
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: Response Body.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/status'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - AccountsReceivablesConfig
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/arAccountTypes'
        description: Request object for changing account types.
        required: true
components:
  schemas:
    aRAccountTypesType:
      type: array
      description: Holds collection of account types
      maxItems: 4000
      items:
        $ref: '#/components/schemas/aRAccountTypeType'
    aRDaysReminderCycleType:
      type: object
      description: Custom reminder cycles determine which to generated statements for the account with outstanding balances
      properties:
        accountTypeReminderCycleId:
          description: Internal number associated with daily reminder type
          $ref: '#/components/schemas/uniqueID_Type'
        noOfDays:
          description: Number of days in the reminder cycle
          type: integer
        reportName:
          description: File name for the reminder letter to be granted for this cycle
          type: string
          minLength: 0
          maxLength: 80
    aRFinanceChargeType:
      type: object
      description: Finance charges will allow user to post a flat amount or percentage finance charge based on user-defined cycle.
      properties:
        postOnDay:
          description: Day of the month when the end of day procedure should run
          type: integer
        financeCharge:
          description: Determines how the finance charge will be applied to outstanding balance valid values are F, P
          type: string
          minLength: 1
          maxLength: 1
        financeChargeValue:
          description: Amount or percentage value
          type: number
        daysOlderThan:
          description: Number of days after which an outstanding balance triggers
          type: integer
        includeUnallocatedPayments:
          description: If true unallocated payments are subtracted from the outstanding balances before finance charge is calculated
          type: boolean
    aRReminderCycleType:
      type: object
      description: When reminder letters needs to be generated. user can choose from End of month or Day cycle
      properties:
        endOfMonthCycle:
          description: Reminder letters are generated at the end of month if user specifies this element
          $ref: '#/components/schemas/aREndOfMonthCycleType'
        daysCycle:
          description: Reminder letters are generate at user-defined cycles if user specifies this element
          $ref: '#/components/schemas/aRDaysCycleType'
    managedByOptions:
      description: Describes of the Configuration is Managed by Enterprise or Property.
      type: string
      enum:
      - EnterpriseManaged
      - PropertyManaged
      - EnterpriseEnforced
      - PropertyOverridden
    arFlaggedReasons:
      type: object
      description: Response for fetching Flagged Reasons.
      properties:
        aRFlaggedReasons:
          description: Collection of Flagged Reasons.
          $ref: '#/components/schemas/aRFlaggedReasonsType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    instanceLink:
      type: object
      description: Metadata describing link description objects that MAY appear in the JSON instance representation.
      properties:
        href:
          description: URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the "templated" property must be set to true.
          type: string
        rel:
          description: Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.
          type: string
        templated:
          description: Boolean flag that specifies that "href" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false.
          type: boolean
          default: false
        method:
          description: HTTP method for requesting the target of the link.
          type: string
          enum:
          - GET
          - POST
          - PUT
          - DELETE
          - PATCH
          - OPTIONS
          - HEAD
        targetSchema:
          description: Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..
          type: string
        operationId:
          description: The operationId of the path you can call to follow this link.  This allows you to look up not only the path and method, but the description of that path and any parameters you need to supply.
          type: string
        title:
          description: Exact copy of the "summary" field on the linked operation.
          type: string
    errorInstance:
      title: Error Instance Details
      description: Complex type that contains error instance details for a REST call.
      type: object
      properties:
        type:
          type: string
          description: Absolute URI [RFC3986] that identifies the problem type.  When dereferenced, it SHOULD provide a human-readable summary of the problem (for example, using HTML).
        title:
          type: string
          description: Short, human-readable summary of the problem.  The summary SHOULD NOT change for subsequent occurrences of the problem, except for purposes of localization.
        status:
          type: integer
          description: HTTP status code for this occurrence of the problem, set by the origin server.
        detail:
          type: string
          description: Human-readable description specific to this occurrence of the problem.
        instance:
          type: string
          description: Absolute URI that identifies the specific occurrence of the problem.  It may or may not provide additional information if dereferenced.
        o:errorCode:
          type: string
          description: Application error code, which is different from HTTP error code.
        o:errorPath:
          type: string
          description: Path to the problem at the resource or property level.
      required:
      - type
      - title
    aRPrintPreferenceType:
      type: string
      description: Preference type when separate folios has to be included in the statement
      enum:
      - InvoicesWithoutDetails
      - InvoicesWithDetails
      - SeparateFolios
    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
    arAccountTypes:
      type: object
      description: Request object for changing account types.
      properties:
        accountTypes:
          description: Collection of account types that needs to be created
          $ref: '#/components/schemas/aRAccountTypesType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    aRFlaggedReasonType:
      type: object
      description: Details for AR Flagged Reason.
      properties:
        code:
          description: AR Flagged Reason Code.
          type: string
          minLength: 0
          maxLength: 20
        hotelId:
          description: Hotel code.
          type: string
          minLength: 0
          maxLength: 20
        description:
          description: Description of AR Flagged Reason.
          type: string
          minLength: 0
          maxLength: 2000
        displaySequence:
          description: Display sequence for AR Flagged Reason.
          type: number
        managedBy:
          $ref: '#/components/schemas/managedByOptions'
    aRDaysCycleType:
      type: array
      description: Reminder letters will be generated based on the number of days for which the account has had an outstanding balance
      maxItems: 4000
      items:
        $ref: '#/components/schemas/aRDaysReminderCycleType'
    status:
      type: object
      description: Response Body.
      properties:
        warnings:
          $ref: '#/components/schemas/warningsType'
        links:
          $ref: '#/components/schemas/links'
    aRFlaggedReasonsType:
      type: array
      description: List of the Flagged Reason to be configured or fetched
      maxItems: 4000
      items:
        $ref: '#/components/schemas/aRFlaggedReasonType'
    aREndOfMonthCycleType:
      type: object
      description: Reminder letters will be generated at the end of each month if user specifies this element
      properties:
        reportName:
          description: Reminder letter file name for the reminder letter to be generated at the end of month
          type: string
          minLength: 0
          maxLength: 80
        reportNameDesc:
          description: Description associated with reminder letter.
          type: string
          minLength: 0
          maxLength: 1000
    warningsType:
      type: array
      description: Used in conjunction with the Success element to define a business error.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/warningType'
    statementType:
      type: string
      description: The Types of Statements that can be used on an Account Type.
      enum:
      - BalanceForward
      - IndividualOpenItems
    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'
    aRAccountTypeType:
      type: object
      description: Information which uniquely identifies account type
      properties:
        hotelId:
          description: Property associated with account type
          type: string
          minLength: 0
          maxLength: 20
        accountType:
          description: Account receivable account type
          type: string
          minLength: 0
          maxLength: 20
        description:
          description: Full description of account type
          type: string
          minLength: 0
          maxLength: 2000
        creditLimit:
          description: Maximum credit available for account type
          type: number
        statementMode:
          description: Statements for all account types will be prepared using this statement mode
          $ref: '#/components/schemas/statementType'
        statementName:
          description: Statement file name that account receivable account types uses
          type: string
          minLength: 0
          maxLength: 80
        statementNameDesc:
          description: Description associated with statement file name
          type: string
          minLength: 0
          maxLength: 1000
        printPreference:
          description: Print preference whether to print statement with invoice details or with out invoice details or print separate folios
          $ref: '#/components/schemas/aRPrintPreferenceType'
        financeCharge:
          description: Finance charges will allow user to post a flat amount or percentage finance charge based on user-defined cycle.
          $ref: '#/components/schemas/aRFinanceChargeType'
        reminderCycle:
          description: When reminder letters needs to be generated. user can choose from End of month or Day cycle
          $ref: '#/components/schemas/aRReminderCycleType'
        reminderDelayDays:
          description: Defines the number of days(aging) within which the payment must be made for a account type, if not a reminder is generated.
          type: integer
        managedBy:
          $ref: '#/components/schemas/managedByOptions'
    links:
      type: array
      items:
        $ref: '#/components/schemas/instanceLink'
    operaVersionNumberType:
      type: string
      description: Current Opera Version Number
      minLength: 0
      maxLength: 40
    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
  responses:
    '406':
      description: Not acceptable.
    '414':
      description: Request URI Too Large
    '400':
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/exceptionDetailType'
    '403':
      description: Forbidden
    '413':
      description: Request Entity Too Large
    '415':
      description: Unsupported Media Type
    '404':
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/exceptionDetailType'
    '502':
      description: Bad Gateway
    '500':
      description: System Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/exceptionDetailType'
    '503':
      description: Service Unavailable
    '401':
      description: Unauthorized
    '405':
      description: Method not allowed
  parameters:
    x-hotelid:
      name: x-hotelid
      description: Mandatory parameter to identify the hotel code where the end user is logged in
      in: header
      required: true
      schema:
        type: string
    x-app-key:
      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}$
    authKey:
      name: authorization
      description: Bearer token that needs to be passed which is generated post user authentication
      in: header
      required: true
      schema:
        type: string
    x-externalsystem:
      name: x-externalsystem
      description: External system code.
      in: header
      x-example: EXTERNALSYSTEMCODE
      schema:
        type: string
        maxLength: 40
    externalData:
      name: externalData
      description: Pass this header as true, if payload needs DVM
      in: header
      schema:
        type: string
    x-originating-application:
      name: x-originating-application
      description: Customer's Integration Application Id
      in: header
      schema:
        type: string
    Accept-Language:
      name: Accept-Language
      description: Language code
      in: header
      schema:
        type: string
    x-request-id:
      name: x-request-id
      description: Request Id of an incoming request
      in: header
      schema:
        type: string
        pattern: ~*[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}
externalDocs:
  description: Find out more about Oracle Hospitality
  url: https://docs.oracle.com/en/industries/hospitality/integration_platforms.html