APIs to cater for Accounts Receivables functionality in OPERA Cloud. 60 operation(s) documented; base path /ars/v1. Harvested verbatim from Oracle's public hospitality-api-docs repository (Swagger 2.0, release 26.2.0.0).
{
"swagger": "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"
}
},
"schemes": [
"https"
],
"basePath": "/ars/v1",
"produces": [
"application/json"
],
"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",
"type": "array",
"collectionFormat": "multi",
"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.",
"items": {
"type": "string"
},
"required": true
},
{
"name": "hotelIds",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Property where the AR Account exists. This is required.",
"items": {
"type": "string"
},
"required": false
},
{
"name": "profiles",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"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.",
"items": {
"type": "string"
},
"required": false
},
{
"name": "accountNo",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Account Number for the AR Account.",
"items": {
"type": "string"
},
"required": false
},
{
"name": "accountName",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Account Name for the AR Account.",
"items": {
"type": "string"
},
"required": false
},
{
"$ref": "#/parameters/authKey"
},
{
"$ref": "#/parameters/externalData"
},
{
"$ref": "#/parameters/x-app-key"
},
{
"$ref": "#/parameters/x-request-id"
},
{
"$ref": "#/parameters/x-originating-application"
},
{
"$ref": "#/parameters/x-hotelid"
},
{
"$ref": "#/parameters/x-externalsystem"
},
{
"$ref": "#/parameters/Accept-Language"
}
],
"responses": {
"200": {
"headers": {
"Content-Language": {
"type": "string",
"description": "Audience language",
"pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*",
"x-example": "en-GB"
}
},
"description": "Response to the request to fetch pending Reminders for Accounts.",
"schema": {
"$ref": "#/definitions/reminders"
}
},
"204": {
"description": "Reminders not found."
},
"400": {
"$ref": "#/responses/400"
},
"401": {
"$ref": "#/responses/401"
},
"403": {
"$ref": "#/responses/403"
},
"404": {
"$ref": "#/responses/404"
},
"405": {
"$ref": "#/responses/405"
},
"406": {
"$ref": "#/responses/406"
},
"413": {
"$ref": "#/responses/413"
},
"414": {
"$ref": "#/responses/414"
},
"415": {
"$ref": "#/responses/415"
},
"500": {
"$ref": "#/responses/500"
},
"502": {
"$ref": "#/responses/502"
},
"503": {
"$ref": "#/responses/503"
}
},
"consumes": [
"application/json;charset=UTF-8"
],
"produces": [
"application/json;charset=UTF-8"
],
"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": [
{
"name": "reminders",
"in": "body",
"required": true,
"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.",
"schema": {
"allOf": [
{
"$ref": "#/definitions/reminders"
}
]
}
},
{
"$ref": "#/parameters/authKey"
},
{
"$ref": "#/parameters/externalData"
},
{
"$ref": "#/parameters/x-app-key"
},
{
"$ref": "#/parameters/x-request-id"
},
{
"$ref": "#/parameters/x-originating-application"
},
{
"$ref": "#/parameters/x-hotelid"
},
{
"$ref": "#/parameters/x-externalsystem"
},
{
"$ref": "#/parameters/Accept-Language"
}
],
"responses": {
"201": {
"headers": {
"Content-Language": {
"type": "string",
"description": "Audience language",
"pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*",
"x-example": "en-GB"
},
"Location": {
"type": "string",
"description": "Location of newly created resource"
}
},
"description": "HATEOAS links which help the consumer to navigate to resources",
"schema": {
"$ref": "#/definitions/status"
}
},
"400": {
"$ref": "#/responses/400"
},
"401": {
"$ref": "#/responses/401"
},
"403": {
"$ref": "#/responses/403"
},
"404": {
"$ref": "#/responses/404"
},
"405": {
"$ref": "#/responses/405"
},
"406": {
"$ref": "#/responses/406"
},
"413": {
"$ref": "#/responses/413"
},
"414": {
"$ref": "#/responses/414"
},
"415": {
"$ref": "#/responses/415"
},
"500": {
"$ref": "#/responses/500"
},
"502": {
"$ref": "#/responses/502"
},
"503": {
"$ref": "#/responses/503"
}
},
"consumes": [
"application/json;charset=UTF-8"
],
"produces": [
"application/json;charset=UTF-8"
],
"tags": [
"AccountsReceivables"
]
}
},
"/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.",
"type": "string",
"uniqueItems": true,
"enum": [
"All",
"Open",
"Zero"
]
},
{
"name": "batchStatement",
"in": "query",
"required": false,
"description": "Search criteria for batch processing",
"type": "boolean"
},
{
"name": "limit",
"in": "query",
"required": false,
"description": "Indicates maximum number of records a Web Service should return.",
"type": "integer"
},
{
"name": "offset",
"in": "query",
"default": 0,
"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.",
"type": "integer"
},
{
"name": "hotelIds",
"in": "query",
"type": "array",
"maxItems": 4000,
"collectionFormat": "multi",
"description": "Property where the Accounts exist.",
"items": {
"type": "string"
},
"required": false
},
{
"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.",
"type": "string"
},
{
"name": "profileIdContext",
"in": "query",
"required": false,
"description": "Used to identify the source of the identifier (e.g., IATA, ABTA).",
"type": "string"
},
{
"name": "profileType",
"in": "query",
"required": false,
"description": "A reference to the type of object defined by the UniqueID element.",
"type": "string"
},
{
"name": "type",
"in": "query",
"required": false,
"description": "Search by Account Type.",
"type": "string"
},
{
"name": "accountNo",
"in": "query",
"type": "array",
"maxItems": 4000,
"collectionFormat": "multi",
"description": "Account Number .",
"items": {
"type": "string"
},
"required": false
},
{
"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.",
"type": "string"
},
{
"name": "accountId",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"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.",
"items": {
"type": "string"
},
"required": false
},
{
"name": "accountIdContext",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Used to identify the source of the identifier (e.g., IATA, ABTA).",
"items": {
"type": "string"
},
"required": false
},
{
"name": "accountType",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "A reference to the type of object defined by the UniqueID element.",
"items": {
"type": "string"
},
"required": false
},
{
"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.",
"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.",
"type": "boolean"
},
{
"name": "superSearch",
"in": "query",
"required": false,
"description": "Free form text field for searching all reservation fields",
"type": "string"
},
{
"name": "searchHotelIds",
"in": "query",
"type": "array",
"maxItems": 4000,
"collectionFormat": "multi",
"description": "Hotel code.",
"items": {
"type": "string"
},
"required": false
},
{
"name": "attributeName",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"items": {
"type": "string"
},
"required": false
},
{
"name": "orderType",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"Asc",
"Desc"
]
},
"required": false
},
{
"name": "minimumBalance",
"in": "query",
"required": false,
"description": "Search AR Accounts with a minimum balance filter.",
"type": "number"
},
{
"$ref": "#/parameters/authKey"
},
{
"$ref": "#/parameters/externalData"
},
{
"$ref": "#/parameters/x-app-key"
},
{
"$ref": "#/parameters/x-request-id"
},
{
"$ref": "#/parameters/x-originating-application"
},
{
"$ref": "#/parameters/x-hotelid"
},
{
"$ref": "#/parameters/x-externalsystem"
},
{
"$ref": "#/parameters/Accept-Language"
}
],
"responses": {
"200": {
"headers": {
"Content-Language": {
"type": "string",
"description": "Audience language",
"pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*",
"x-example": "en-GB"
}
},
"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.",
"schema": {
"$ref": "#/definitions/accountsInfo"
}
},
"204": {
"description": "Accounts not found."
},
"400": {
"$ref": "#/responses/400"
},
"401": {
"$ref": "#/responses/401"
},
"403": {
"$ref": "#/responses/403"
},
"404": {
"$ref": "#/responses/404"
},
"405": {
"$ref": "#/responses/405"
},
"406": {
"$ref": "#/responses/406"
},
"413": {
"$ref": "#/responses/413"
},
"414": {
"$ref": "#/responses/414"
},
"415": {
"$ref": "#/responses/415"
},
"500": {
"$ref": "#/responses/500"
},
"502": {
"$ref": "#/responses/502"
},
"503": {
"$ref": "#/responses/503"
}
},
"consumes": [
"application/json;charset=UTF-8"
],
"produces": [
"application/json;charset=UTF-8"
],
"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,
"type": "string",
"minLength": 1,
"maxLength": 2000,
"description": "Unique ID of the account"
},
{
"name": "hotelId",
"in": "query",
"required": false,
"description": "Property where the AR Account exists. This is required.",
"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.",
"type": "string"
},
{
"name": "accountIdContext",
"in": "query",
"required": false,
"description": "Used to identify the source of the identifier (e.g., IATA, ABTA).",
"type": "string"
},
{
"name": "accountType",
"in": "query",
"required": false,
"description": "A reference to the type of object defined by the UniqueID element.",
"type": "string"
},
{
"name": "accountNo",
"in": "query",
"required": false,
"description": "Account Number for the AR Account.",
"type": "string"
},
{
"name": "accountName",
"in": "query",
"required": false,
"description": "Account Name for the AR Account.",
"type": "string"
},
{
"name": "dateSent",
"in": "query",
"required": false,
"description": "History Date filter.",
"type": "string",
"format": "date"
},
{
"name": "reportFileNameWildCard",
"in": "query",
"required": false,
"description": "Report Name wild card.",
"type": "string"
},
{
"$ref": "#/parameters/authKey"
},
{
"$ref": "#/parameters/externalData"
},
{
"$ref": "#/parameters/x-app-key"
},
{
"$ref": "#/parameters/x-request-id"
},
{
"$ref": "#/parameters/x-originating-application"
},
{
"$ref": "#/parameters/x-hotelid"
},
{
"$ref": "#/parameters/x-externalsystem"
},
{
"$ref": "#/parameters/Accept-Language"
}
],
"responses": {
"200": {
"headers": {
"Content-Language": {
"type": "string",
"description": "Audience language",
"pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*",
"x-example": "en-GB"
}
},
"description": "Reminders History.",
"schema": {
"$ref": "#/definitions/remindersHistory"
}
},
"204": {
"description": "RemindersHistory not found."
},
"400": {
"$ref": "#/responses/400"
},
"401": {
"$ref": "#/responses/401"
},
"403": {
"$ref": "#/responses/403"
},
"404": {
"$ref": "#/responses/404"
},
"405": {
"$ref": "#/responses/405"
},
"406": {
"$ref": "#/responses/406"
},
"413": {
"$ref": "#/responses/413"
},
"414": {
"$ref": "#/responses/414"
},
"415": {
"$ref": "#/responses/415"
},
"500": {
"$ref": "#/responses/500"
},
"502": {
"$ref": "#/responses/502"
},
"503": {
"$ref": "#/responses/503"
}
},
"consumes": [
"application/json;charset=UTF-8"
],
"produces": [
"application/json;charset=UTF-8"
],
"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,
"type": "string",
"minLength": 1,
"maxLength": 2000,
"description": "Unique ID of the account"
},
{
"name": "hotelId",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Property where the AR Account exists. This is required.",
"items": {
"type": "string"
},
"required": false
},
{
"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.",
"type": "string"
},
{
"name": "profileIdContext",
"in": "query",
"required": false,
"description": "Used to identify the source of the identifier (e.g., IATA, ABTA).",
"type": "string"
},
{
"name": "profileType",
"in": "query",
"required": false,
"description": "A reference to the type of object defined by the UniqueID element.",
"type": "string"
},
{
"name": "accountNo",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Account Number for the AR Account.",
"items": {
"type": "string"
},
"required": false
},
{
"name": "accountName",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Account Name for the AR Account.",
"items": {
"type": "string"
},
"required": false
},
{
"name": "canBeModified",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Flag to indicate if postings or adjustments can be made to the invoice.",
"items": {
"type": "boolean"
},
"required": false
},
{
"name": "closeDate",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Close date of the invoice.",
"items": {
"type": "string",
"format": "date"
},
"required": false
},
{
"name": "fiscalBillNo",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "The Fiscal Bill number of this posting",
"items": {
"type": "string"
},
"required": false
},
{
"name": "folioDate",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Date of Folio Generation.",
"items": {
"type": "string",
"format": "date"
},
"required": false
},
{
"name": "folioNo",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Folio Number.",
"items": {
"type": "number"
},
"required": false
},
{
"name": "folioStatus",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "The Folio Status Example: DEPOSIT folio, VOID folio or the default OK folio status.",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"Deposit",
"Void",
"Ok",
"Zero",
"Compress",
"Converted",
"Internal"
]
},
"required": false
},
{
"name": "folioTypeName",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "The name of the Folio Type used for the Folio Number sequence.",
"items": {
"type": "string"
},
"required": false
},
{
"name": "internalFolioWindowID",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Internal window ID which is unique to the reservation. This ID can only be used for reference.",
"items": {
"type": "string"
},
"required": false
},
{
"name": "invoiceNo",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Invoice No after the folio is generated. Same invoice number may be referred in multiple folios",
"items": {
"type": "number"
},
"required": false
},
{
"name": "invoiceType",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"Normal",
"Credit",
"OldBalance",
"PasserBy"
]
},
"required": false
},
{
"name": "postingDate",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Posting date of the invoice.",
"items": {
"type": "string",
"format": "date"
},
"required": false
},
{
"name": "revenueDate",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Revenue date ID of the invoice.",
"items": {
"type": "string",
"format": "date"
},
"required": false
},
{
"name": "statementNo",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Statementno of the invoice.",
"items": {
"type": "integer"
},
"required": false
},
{
"name": "status",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Status of the invoice.",
"items": {
"type": "string"
},
"required": false
},
{
"name": "transferDate",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Transfer date of the invoice.",
"items": {
"type": "string",
"format": "date"
},
"required": false
},
{
"name": "invoiceTransactionCode",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Transaction code of the invoice.",
"items": {
"type": "string"
},
"required": false
},
{
"name": "transactionDate",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Transaction Date of the invoice.",
"items": {
"type": "string",
"format": "date"
},
"required": false
},
{
"name": "transactionNo",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Unique Transaction Identifier of the Invoice.",
"items": {
"type": "number"
},
"required": false
},
{
"name": "invoiceHotelIds",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Property where the AR Account exists. This is required.",
"items": {
"type": "string"
},
"required": false
},
{
"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.",
"type": "string"
},
{
"name": "reservationIdContext",
"in": "query",
"require
# --- truncated at 32 KB (649 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle-hospitality/refs/heads/main/openapi/oracle-hospitality-property-v1-ars.json