Oracle Hospitality Accounts Receivables API

openapi: 3.2.0
info:
  title: OPERA Cloud Accounts Receivables API
  description: APIs to cater for Accounts Receivables functionality in OPERA Cloud. <br /><br The OPERA Cloud Accounts Receivable module enables you to manage debtors' accounts, invoices, and remittance.<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: /ars/v1
tags:
- name: AccountsReceivables
  description: The REST API's will allow you to create, manage, or delete accounts, add comments, traces, reminders, create or close invoices for example.
paths:
  /accountReminders:
    get:
      summary: Get account receivable's reminder statements
      description: Use this API to get AR account holders' reminder letter that includes detail of payment due, their current account balance, or for other purposes. <p><strong>OperationId:</strong>getReminders</p>
      operationId: getReminders
      parameters:
      - name: accounts
        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: Property where the AR Account exists. This is required.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: profiles
        in: query
        description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: accountNo
        in: query
        description: Account Number for the AR Account.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: accountName
        in: query
        description: Account Name for the AR Account.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response to the request to fetch pending Reminders for Accounts.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/reminders'
        '204':
          description: Reminders 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:
      - AccountsReceivables
    post:
      summary: Generate reminders
      description: Use this API to generate a reminder statement which includes payment due,  current account balance, and etc. of account receivable account holder. <p><strong>OperationId:</strong>postReminders</p>
      operationId: postReminders
      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:
      - AccountsReceivables
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/reminders'
        description: Request to update the reminder information on an Account. After the letter has been generated and sent, the account and the invoices will be updated with the Reminder Cycle information. This is done so that the next cycle of Reminder Letters c can be generated correctly.
        required: true
  /accounts:
    get:
      summary: Get given profile's account receivable detail
      description: Use this API to search for AR Accounts for a given OPERA Profile id. API returns contain a list of AR Accounts and their AR information. <p><strong>OperationId:</strong>getAccounts</p> <p>The maximum allowable limit for this API is <strong>20</strong>.</p>
      operationId: getAccounts
      parameters:
      - name: balance
        in: query
        required: false
        description: Search By Balance. Search will be done for 'All', 'Open Balance' or 'Zero Balance' Accounts.
        schema:
          type: string
          enum:
          - All
          - Open
          - Zero
          uniqueItems: true
      - name: batchStatement
        in: query
        required: false
        description: Search criteria for batch processing
        schema:
          type: boolean
      - name: limit
        in: query
        required: false
        description: Indicates maximum number of records a Web Service should return.
        schema:
          type: integer
      - name: offset
        in: query
        required: false
        description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.
        schema:
          type: integer
          default: 0
      - name: hotelIds
        in: query
        description: Property where the Accounts exist.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: profileId
        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: profileIdContext
        in: query
        required: false
        description: Used to identify the source of the identifier (e.g., IATA, ABTA).
        schema:
          type: string
      - name: profileType
        in: query
        required: false
        description: A reference to the type of object defined by the UniqueID element.
        schema:
          type: string
      - name: type
        in: query
        required: false
        description: Search by Account Type.
        schema:
          type: string
      - name: accountNo
        in: query
        description: Account Number .
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: accountName
        in: query
        required: false
        description: Wild Card Search by Account Name. Search will be done for any Accounts whose name starts with this value.
        schema:
          type: string
      - name: accountId
        in: query
        description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: accountIdContext
        in: query
        description: Used to identify the source of the identifier (e.g., IATA, ABTA).
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: accountType
        in: query
        description: A reference to the type of object defined by the UniqueID element.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: includeStatementHistoryIndicator
        in: query
        required: false
        description: Return statement history indicator in result. This flag included for performance reason to populate history flag only for Statements Mode.
        schema:
          type: boolean
      - name: includeReminderHistoryIndicator
        in: query
        required: false
        description: Return reminder history indicator in result. This flag included for performance reason to populate history flag only for Statements Mode.
        schema:
          type: boolean
      - name: superSearch
        in: query
        required: false
        description: Free form text field for searching all reservation fields
        schema:
          type: string
      - name: searchHotelIds
        in: query
        description: Hotel code.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: attributeName
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: orderType
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Asc
            - Desc
          uniqueItems: true
      - name: minimumBalance
        in: query
        required: false
        description: Search AR Accounts with a minimum balance filter.
        schema:
          type: number
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          description: Response for the request to search for AR Accounts. Based on the criteria, the response can contain a list of AR Accounts and their AR information.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/accountsInfo'
        '204':
          description: Accounts 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:
      - AccountsReceivables
  /accounts/{accountId}/remindersHistory:
    get:
      summary: Get history of reminder letters for a given account receivable
      description: Use this API to get history of reminder letters prepared for AR account. <p><strong>OperationId:</strong>getRemindersHistory</p>
      operationId: getRemindersHistory
      parameters:
      - name: accountId
        in: path
        required: true
        description: Unique ID of the account
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: query
        required: false
        description: Property where the AR Account exists. This is required.
        schema:
          type: string
      - name: profileId
        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: accountIdContext
        in: query
        required: false
        description: Used to identify the source of the identifier (e.g., IATA, ABTA).
        schema:
          type: string
      - name: accountType
        in: query
        required: false
        description: A reference to the type of object defined by the UniqueID element.
        schema:
          type: string
      - name: accountNo
        in: query
        required: false
        description: Account Number for the AR Account.
        schema:
          type: string
      - name: accountName
        in: query
        required: false
        description: Account Name for the AR Account.
        schema:
          type: string
      - name: dateSent
        in: query
        required: false
        description: History Date filter.
        schema:
          type: string
          format: date
      - name: reportFileNameWildCard
        in: query
        required: false
        description: Report Name wild card.
        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: Reminders History.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/remindersHistory'
        '204':
          description: RemindersHistory 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:
      - AccountsReceivables
  /accounts/{accountId}/statements:
    get:
      summary: Get given profile's account receivable statements
      description: Use this API to prepare statement for an AR account holders. It is typically prepared for billing purposes.<br><p><strong><mark>This API is deprecated. Please use getARStatements instead</mark></strong></p> <p><strong>OperationId:</strong>getStatements</p>
      operationId: getStatements
      deprecated: true
      parameters:
      - name: accountId
        in: path
        required: true
        description: Unique ID of the account
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelId
        in: query
        description: Property where the AR Account exists. This is required.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: profileId
        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: profileIdContext
        in: query
        required: false
        description: Used to identify the source of the identifier (e.g., IATA, ABTA).
        schema:
          type: string
      - name: profileType
        in: query
        required: false
        description: A reference to the type of object defined by the UniqueID element.
        schema:
          type: string
      - name: accountNo
        in: query
        description: Account Number for the AR Account.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: accountName
        in: query
        description: Account Name for the AR Account.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: canBeModified
        in: query
        description: Flag to indicate if postings or adjustments can be made to the invoice.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: boolean
      - name: closeDate
        in: query
        description: Close date of the invoice.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            format: date
      - name: fiscalBillNo
        in: query
        description: The Fiscal Bill number of this posting
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: folioDate
        in: query
        description: Date of Folio Generation.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            format: date
      - name: folioNo
        in: query
        description: Folio Number.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: number
      - name: folioStatus
        in: query
        description: 'The Folio Status Example: DEPOSIT folio, VOID folio or the default OK folio status.'
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Deposit
            - Void
            - Ok
            - Zero
            - Compress
            - Converted
            - Internal
          uniqueItems: true
      - name: folioTypeName
        in: query
        description: The name of the Folio Type used for the Folio Number sequence.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: internalFolioWindowID
        in: query
        description: Internal window ID which is unique to the reservation. This ID can only be used for reference.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: invoiceNo
        in: query
        description: Invoice No after the folio is generated. Same invoice number may be referred in multiple folios
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: number
      - name: invoiceType
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Normal
            - Credit
            - OldBalance
            - PasserBy
          uniqueItems: true
      - name: postingDate
        in: query
        description: Posting date of the invoice.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            format: date
      - name: revenueDate
        in: query
        description: Revenue date ID of the invoice.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            format: date
      - name: statementNo
        in: query
        description: Statementno of the invoice.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: integer
      - name: status
        in: query
        description: Status of the invoice.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: transferDate
        in: query
        description: Transfer date of the invoice.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            format: date
      - name: invoiceTransactionCode
        in: query
        description: Transaction code of the invoice.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: transactionDate
        in: query
        description: Transaction Date of the invoice.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            format: date
      - name: transactionNo
        in: query
        description: Unique Transaction Identifier of the Invoice.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: number
      - name: invoiceHotelIds
        in: query
        description: Property where the AR Account exists. This is required.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            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: reservationType
        in: query
        required: false
        description: A reference to the type of object defined by the UniqueID element.
        schema:
          type: string
      - name: guestProfileId
        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: guestProfileIdContext
        in: query
        required: false
        description: Used to identify the source of the identifier (e.g., IATA, ABTA).
        schema:
          type: string
      - name: guestProfileType
        in: query
        required: false
        description: A reference to the type of object defined by the UniqueID element.
        schema:
          type: string
      - name: age
        in: query
        description: The Aging age of the invoice
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: integer
      - name: guestName
        in: query
        description: Name of the Guest who consumed these transactions.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: originalAmount
        in: query
        required: false
        description: A monetary amount.
        schema:
          type: number
      - name: originalAmountCurrencyCode
        in: query
        required: false
        description: Provides a currency code to reflect the currency in which an amount may be expressed.
        schema:
          type: string
      - name: amount
        in: query
        required: false
        description: A monetary amount.
        schema:
          type: number
      - name: currencyCode
        in: query
        required: false
        description: Provides a currency code to reflect the currency in which an amount may be expressed.
        schema:
          type: string
      - name: paymentsAmount
        in: query
        required: false
        description: A monetary amount.
        schema:
          type: number
      - name: paymentsCurrencyCode
        in: query
        required: false
        description: Provides a currency code to reflect the currency in which an amount may be expressed.
        schema:
          type: string
      - name: balanceAmount
        in: query
        required: false
        description: A monetary amount.
        schema:
          type: number
      - name: balanceCurrencyCode
        in: query
        required: false
        description: Provides a currency code to reflect the currency in which an amount may be expressed.
        schema:
          type: string
      - name: reference
        in: query
        description: User-defined posting reference.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: remark
        in: query
        description: User-defined posting remark.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: adjusted
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: boolean
      - name: parentInvoiceNo
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: number
      - name: compressed
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: boolean
      - name: compressedDate
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            format: date
      - name: transferredOut
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: boolean
      - name: transferredIn
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: boolean
      - name: marketDescription
        in: query
        required: false
        schema:
          type: string
      - name: marketHotelId
        in: query
        required: false
        description: Property where the AR Account exists. This is required.
        schema:
          type: string
      - name: marketCode
        in: query
        required: false
        schema:
          type: string
      - name: marketGroup
        in: query
        required: false
        schema:
          type: string
      - name: roomClassDescription
        in: query
        required: false
        schema:
          type: string
      - name: roomClassHotelId
        in: query
        required: false
        description: Property where the AR Account exists. This is required.
        schema:
          type: string
      - name: roomClassCode
        in: query
        required: false
        schema:
          type: string
      - name: sourceDescription
        in: query
        required: false
        schema:
          type: string
      - name: sourceHotelId
        in: query
        required: false
        description: Property where the AR Account exists. This is required.
        schema:
          type: string
      - name: sourceCode
        in: query
        required: false
        schema:
          type: string
      - name: sourceGroup
        in: query
        required: false
        schema:
          type: string
      - name: cashierId
        in: query
        required: false
        description: Cashier Id of the Cashier.
        schema:
          type: number
      - name: cashierName
        in: query
        required: false
        description: Cashier Name.
        schema:
          type: string
      - name: transactionHotelId
        in: query
        required: false
        description: Property where the AR Account exists. This is required.
        schema:
          type: string
 

# --- truncated at 32 KB (530 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle-hospitality/refs/heads/main/openapi/oracle-hospitality-accountsreceivables-api-openapi.yml