The identity and technical contract details declared by the specification.
reminders
object
Response to the request to fetch pending Reminders for Accounts.
3 properties
aRRemindersType
array
Information about a Reminder.
aRReminderType
object
AR Reminder Information Type.
13 properties
uniqueID_Type
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
2 properties
reminderCycleType
string
The different types of Reminder Cycle calculation rules.
aRInvoicesType
array
A collection of AR Invoices.
aRInvoiceType
object
Details of an AR Invoice.
54 properties
reservationId
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
6 properties
currencyAmountType
object
A monetary value expressed with a currency code.
2 properties
marketCodeInfoType
object
4 properties
roomClassCodeInfoType
object
Code of the room class type.
3 properties
sourceCodeInfoType
object
4 properties
reservationInfoType
object
The Reservation class contains the current reservation being created or altered.
51 properties
reservationIdList
array
Unique Id that references an object uniquely in the system.
stayInfoType
object
Details on the Room Stay including Guest Counts, Time Span of this Room Stay, pointers to Res Guests, guest Memberships, Comments and Special Requests pertaini…
36 properties
timeSpanType
object
Allows for a choice in description of the amount of time spanned by this type. EndDate specifies a specific date, while Duration provides a measure of time to…
3 properties
resExpectedTimesType
object
Holds the Arrival and Departure Time Information
2 properties
pointsType
object
The Redeem Points contains the number of points required to book a room type.
2 properties
reservationBlockType
object
Key information about the block for a reservation.
3 properties
blockIdList
array
Unique Id that references an object uniquely in the system.
resGuaranteeType
object
Validations type record returned after Validations are done.
3 properties
promotionType
object
Type to specify a rate promotion. Usually attached to a reservation to indicate a specific promotion is applied to the reservation.
3 properties
guestHousekeepingServiceRequestType
string
Possible values for the Guest Service Status.
resGuestInfoType
object
Specifies Company or Travel Agent profile using IATA or Corp. No.
30 properties
membershipInfoType
object
The Membership object identifies the frequent customer reward program.
8 properties
namePrefixType
string
Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.)
givenNameType
string
Given name, first name or names
surnameType
string
Family name, last name.
phoneNumberType
string
Phone number
basicEmailType
string
Email address
countryNameType
object
Code for a country or a nationality.
2 properties
vIPType
object
The supplier's ranking of the customer.
2 properties
addressSearchType
object
Address Details such as city, state, country, postal code etc.
6 properties
anonymizationType
object
Provides information about guest's anonymization status.
2 properties
anonymizationStatusType
string
Guest has been anonymized.
resAccompanyGuestListType
array
Collection of accompany guests
resAccompanyGuestInfoType
object
5 properties
profileIdList
array
Unique Id that references an object uniquely in the system.
resGuestExternalInfoType
object
Specifies Company or Travel Agent profile using IATA or Corp. No.
2 properties
guestLastStayInfoType
object
Contains last stay related details of the guest.
4 properties
resSharedGuestListType
array
Collection of shared guest reservations.
resSharedGuestInfoType
object
Contains information regarding the share reservation.
4 properties
profileId
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
6 properties
resAttachedProfileListType
array
resAttachedProfileType
object
3 properties
resProfileTypeType
string
reservationPaymentMethodType
object
7 properties
resPaymentCardType
object
Information on a credit card for the customer.
18 properties
cardTypeType
string
This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method.
cardProcessingType
string
cardNumberTypeType
string
Simple type for indicating if credit card number is tokenized.
authorizationRuleType
object
Configured rule for computing the amount to authorize.
3 properties
emailType
object
Information on an email for the customer.
11 properties
reservationFolioWindowsType
array
Collection of reservation folio windows.
reservationFolioWindowType
object
Folio window view which holds the set of folios for a reservation.
4 properties
payeeInfoType
object
Payee information.
7 properties
addressInfoType
object
Provides address information.
3 properties
addressType
object
Provides address information.
19 properties
aRAccountShortInfoType
object
Accounts Receivabales Account details type charged for batched posting.
4 properties
aRAccountStatusType
object
Type for the Account Status. Status can be restricted and a message/description added to the Account.
3 properties
indicatorsType
array
Collection of lamp indicators.
indicatorType
object
Lamp indicator Type.
2 properties
housekeepingRoomStatusType
string
Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOf…
searchMatchesType
array
List of Generic Name-Value-Pair Parameters used for super search matches.
searchMatchType
object
Search match indicating attribute and the matching value.
2 properties
sourceOfSaleType
object
Point of Sale of reservation. Identifies the entity/channel who made the reservation.
2 properties
waitlistResType
object
Information regarding why reservation is being /has been waitlisted.
6 properties
reservationQueueInformationType
object
Information regarding the Date, Duration and Priority of the reservation on Queue for Check in.
6 properties
queueTextInfoType
object
Information regarding the message sent to guest.
2 properties
resHousekeepingType
object
Holds housekeeping turndown service information for the room.
7 properties
facilityTaskType
object
Information regarding facility task on a reservation.
3 properties
housekeepingTaskCodeType
object
Information related to a Task Code. Task Codes are used to generate task sheets in Rooms Management.
7 properties
facilityCodesType
array
List of the facility codes.
facilityCodeType
object
Facility Housekeeping Code, its description and quantity.
3 properties
resCashieringType
object
Cashiering Information for the reservation.
14 properties
resRevenueBalanceType
object
Revenue and Balance Amount summary for the reservation.
9 properties
billingPrivilegesType
object
This stores the information for Bed Tax Reporting. Mainly used in Maldives.
13 properties
reservationTaxTypeInfo
object
Provides information about the Tax Type.
9 properties
bedTaxReportingType
object
This stores the information for Bed Tax Reporting. Mainly used in Maldives.
5 properties
folioTextsType
array
This stores the description for the type of tax calculation especially with tax exemption, etc.
resPeriodicFolioType
object
Information regarding periodic folios set on the reservation.
3 properties
resCompAccountingType
object
Information regarding comp accounting on the reservation.
3 properties
resPreConfiguredRoutingInstrType
object
Instruction to attach Pre-Configured Routing Instructions to a Reservation.
4 properties
authorizerInfoType
object
Authorizer Information
5 properties
taxTypeType
object
Provides information about the Tax Type.
8 properties
reservationDepositType
object
Reservation Deposit Type.
7 properties
reservationAllowedActionsType
array
Allowed action.
reservationAllowedActionType
string
Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation.
reservationInterfaceStatusType
object
Hotel Interface Type for a reservation and status of the various services
3 properties
hotelInterfaceType
object
8 properties
hotelInterfaceTypeType
string
XML Posting Interface
hotelInterfaceStatusType
string
Status of the Hotel Interface either STOPPED or RUNNING.
interfaceRightsStatusType
object
4 properties
reservationTurndownInfoType
object
Turndown information for a reservation
2 properties
turndownStatusType
string
Simple type for turndown status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Required, Not Required and Complet…
resMobileNotificationsType
object
Contains the status of Room Ready and Key Ready messages.
5 properties
communicationStatusType
string
Enum to denote the Status of Readiness messages sent to Guest Devices.
resCommunicationType
object
Communication details for a reservation.
2 properties
telephoneInfoType
object
Information on a telephone number for the customer.
3 properties
telephoneType
object
Information on a telephone number for the customer.
12 properties
emailInfoType
object
Information on an email for the customer.
3 properties
advanceCheckInType
object
Information relating to Reservation's Advance Checked In state and Expected Time of Return
3 properties
pMS_ResStatusType
string
This reservation is in checked in status and the business date is past departure date. This could occur when ORS and PMS are in same environment.
resAccessRestrictionType
string
Indicates any Updates/Changes on the reservation as well as Reservation Cancellation are not allowed.
commissionPayoutToType
string
cashierInfoType
object
Cashier information. Contains Id and Name details of the cashier.
2 properties
trxInfoType
object
Transaction codes info.
10 properties
articleInfoType
object
Information regarding an article.
9 properties
articlePostItType
object
Post it information of an article.
2 properties
colorType
string
Color configuration type. This color configuration provides a visual category of entities.
profileInfoType
object
Provides information about attached profiles to the block.
5 properties
customNumberType
string
Custom number
fiscalResponseType
object
Provides information which is used for fiscal response processing.
2 properties
folioStatusType
string
The Folio Status Example: DEPOSIT folio, VOID folio or the default OK folio status.
instanceLink
object
Metadata describing link description objects that MAY appear in the JSON instance representation.
7 properties
warningsType
array
Used in conjunction with the Success element to define a business error.
warningType
object
Used when a message has been successfully processed to report any warnings or business errors that occurred.
10 properties
exceptionDetailType
object
Complex type that contains error details for a REST call.
9 properties
2 required
errorInstance
object
Complex type that contains error instance details for a REST call.
7 properties
2 required
status
object
Response Body.
2 properties
accountsInfo
object
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.
9 properties
aRAccountsType
array
Information regarding the AR Account.
aRAccountType
object
Accounts Receivabales Account details type.
33 properties
commentInfoType
object
Comment related to the profile/reservation.
8 properties
commentType
object
An indication of a new paragraph for a sub-section of a formatted text message.
19 properties
formattedTextTextType
object
Provides text and indicates whether it is formatted or not.
2 properties
traceType
object
16 properties
traceTimeInfoType
object
4 properties
dateTimeSpanType
object
Allows for a choice in description of the amount of time spanned by this type. EndDate specifies a specific date, while Duration provides a measure of time to…
2 properties
traceResolveType
object
2 properties
fixedChargesType
array
Holds fixed charge detail.
fixedChargeType
object
Holds fixed charge information.
8 properties
fixedChargeScheduleType
object
Holds schedule of fixed charge.
5 properties
fixedChargeFrequencyType
string
Yearly.
fixedChargeDetailType
object
Fixed charge amount could be specified by flat fee or be a percentage of the rate amount.
7 properties
codeDescriptionType
object
This contains a generic code and description information.
2 properties
aRAgingInfoType
object
Information regarding the aging balances for an account.
2 properties
aRBalanceType
object
Balance information for AR.
3 properties
aRAgingType
object
Aging information for an Aging Bucket.
6 properties
dateRangeType
object
Date Range with Start and End dates.
2 properties
aRYearViewInfoType
object
Information regarding Year View balances for an account.
2 properties
aRYearViewType
object
Year information for an Year View.
3 properties
aRPaymentsType
array
A collection of AR Payments.
aRPaymentType
object
Details of an AR Payment.
18 properties
remindersHistory
object
Reminders History.
3 properties
aRReminderHistoryType
object
Report History Type used as based type for Remiders and Statements History types.
4 properties
statements
object
Details of the Statement to generate.
3 properties
aRStatementType
object
Details about an AR Statement.
10 properties
statementType
string
The Types of Statements that can be used on an Account Type.
arTransactions
object
Response after fetching AR transaction details.
4 properties
aRTransactionType
object
Transaction Information.
2 properties
accountInvoicesInfoType
array
Account Invoice Info.
accountInvoiceInfoType
object
Details of an AR Invoice.
57 properties
accountPaymentsInfoType
array
Account Payments info .
accountPaymentInfoType
object
Details of an AR Payment.
21 properties
trxCodesInfoType
array
List of Transaction codes info.
accountCriteria
object
Request to create a new AR Account
3 properties
invoicesOnHold
object
Response after fetching on-hold invoices.
3 properties
aRAccountsInvoicesPaymentsType
array
Account Invoice information.
aRAccountInvoicesPaymentsType
object
AR Account Invoices Information.
10 properties
account
object
Response for the request to fetch details for an AR Account.
3 properties
creditToInvoices
object
3 properties
aRApplyPaymentCriteriaType
object
Criteria type for apply credits to Invoices. Requires a list of invoices to apply the credit.
6 properties
aRAccountCriteriaType
object
Criteria type for an AR Account.
5 properties
aRPaymentInvoicesType
array
AR Invoice to which the payment will be applied.
aRApplyType
string
Apply payment Selectively to the Invoices included.
cashierId
number
The Cashier ID of the Cashier who is currently processing the transaction(s).
arCreditCardPaymentsToTransfer
object
Request to transfer AR Credit Card payments.
3 properties
transferARCreditCardPaymentsType
object
Transfer AR Credit Card payment information.
6 properties
arChargesPostingCriteria
object
Request to post charges to an existing invoice, when the functionality is available. If the invoice should not be modified or if the folio should not be modifi…
3 properties
aRChargesPostingCriteriaType
object
The charges which have to be posted.
6 properties
chargesCriteriaType
array
Collection of Charges to be posted.
chargeCriteriaType
object
Criteria information for posting a charge.
15 properties
uniqueIDListType
array
Unique Id that references an object uniquely in the system.
accountComment
object
Request to create a Comment for an Account.
3 properties
aRAccountCommentCriteriaType
object
The comments on the AR Account.
12 properties
arCompressInvoices
object
Request to compress two or more invoices for an Account
3 properties
aRCompressInvoicesType
object
Criteria type compressing invoices i.e grouping multiple invoices into one,for an Account.
6 properties
compressedARInvoices
object
Response for the request to compress two or more invoices.
3 properties
arAccountCopy
object
Request to copy AR Account
3 properties
copyARAccountCriteriaType
object
Criteria for copying AR account.
2 properties
accountFixedCharge
object
Request to create a Fixed Charge for an Account.
3 properties
aRAccountFixedChargeCriteriaType
object
The traces on the AR Account.
10 properties
arFolioPrinters
object
Response to the request to fetch the Folio Printers applicable for a Folio, based on the
3 properties
folioPrintersType
object
List of Folio Printers.
2 properties
folioPrinterType
object
Information about a Printer which can be used to print a Folio.
4 properties
arInvoice
object
Request to create a new Invoice for an Account.
3 properties
createARInvoiceCriteriaType
object
Criteria to Create a new AR Invoice.
13 properties
nameValueHeaderDetailType
object
Name value details collected before Folio Settlement
2 properties
nameValueBaseSearchType
object
Contains name value information search criteria.
5 properties
nameValueModuleType
string
customNameValueConfigType
string
Italian Lottery Number.
nameValueDetailType
object
Detailed information returned during name value search.
1 property
nameValuesType
array
List of name value pairs.
nameValueType
object
Contains name value pair.
6 properties
nameValueDataTypeType
string
nameValueOriginType
object
Contains origin details.
4 properties
fiscalServiceType
object
Generate Fiscal Folio Criteria type to be used for fiscal folio generation
5 properties
fiscalFolioInstruction
string
Action to generate Offline folio when no response is received from fiscal service.
folioQueueType
object
List of charges that will be posted against the transaction code based from the test criteria.
3 properties
arInvoiceDetails
object
Response to the request to create an invoice for an Account.
3 properties
statementsToBeGenerated
object
Operation to generate AR Statements. This will validate and check if there exists any invoices to be included in the Statement based on the criteria used. If S…
3 properties
aRGenerateStatementCriteriaType
object
Criteria to process AR Printed Statements - create history and update invoices.
2 properties
aRStatementCriteriaType
object
Statements criteria for AR Accounts.
6 properties
accountTrace
object
Request to create a Trace for an Account.
3 properties
aRAccountTraceCriteriaType
object
The traces on the AR Account.
18 properties
invoicePayment
object
4 properties
invoice
object
Response to the request to change invoice
3 properties
aRInvoiceCriteriaType
object
Details of an AR Invoice.
59 properties
arAgingCycles
object
Response for Fetch AR Aging Cycles.
3 properties
aRAgingCyclesType
array
Collections of AR Aging Cycles.
batchChargesToPost
object
Request for posting a charge in a batch to list of accounts.
3 properties
aRPostChargesInBatchCriteriaType
object
Criteria for posting a charge to list of accounts.
4 properties
transferDirectBillsToAr
object
Request for Transfer Directs bill to AR.
3 properties
transferDirectBillsToArCriteriaType
object
Provides information about Transfer Direct Bills To Ar Criteria Type.
3 properties
invoiceAppliedPayments
object
Response to the applied payment details,Contains errors or warnings if any.
4 properties
aRAppliedPaymentsType
array
Applied Payment record.
aRAppliedPaymentType
object
Details of an AR Invoice.
56 properties
arPaymentsToBeCreated
object
Request to post a payment to an AR Account and apply the payment to Invoices..
3 properties
aRPaymentsCriteriaType
object
2 properties
aRPaymentCriteria
object
Criteria for applying payments to invoices or posting an unallocated payment to an AR Account.
26 properties
cashieringPaymentMethodType
object
9 properties
authorizationInfoType
object
5 properties
paymentTaxType
object
Information regarding payments made which have Payment Tax.
12 properties
paymentTax
string
The types of Payment Tax transactions.
paymentTaxesType
array
Payment Tax record.
compRedemptionsType
array
Information regarding Complimentary Bucket Redemption object.
redemptionType
object
Redemption information.
8 properties
postPaymentActionType
string
Prepaid Card Redemption Action.
prepaidCardRedemptionsType
array
A prepaid redemption info object to be used for posting a payment.
prepaidCardRedemptionType
object
Redemption information.
6 properties
arPayments
object
Response notifying if the posting of a payment to an AR Account.
4 properties
statementHistory
object
Statement History.
3 properties
aRStatementHistoryType
object
Report History Type used as based type for Remiders and Statements History types.
4 properties
reversePayment
object
Request for reverse AR payment
3 properties
reversePaymentCriteriaType
object
Criteria type for an AR Account.
6 properties
arCreditCardPayments
object
Response after fetching AR credit card payments.
8 properties
aRCreditCardPaymentsInfoType
object
Collection of AR Credit Card payments Details.
2 properties
aRCreditCardPaymentInfoType
object
AR Credit Card payment information.
10 properties
unlinkInvoiceFromStatement
object
Request to unlink invoice from statement
3 properties
unlinkStatementCriteriaType
object
Criteria for unlinking invoice from statement.
3 properties
invoiceTrxNoList
array
Transaction Number .
invoicesPayments
object
Response for the fetch invoice and payments details request.
10 properties
invoicePostings
object
Response to the request to fetch postings for an invoice
4 properties
aRInvoicePostingsType
array
Invoice posting detail.
aRInvoicePostingType
object
Posting details.
43 properties
cashieringTransactionTypeType
string
Wrapper Transaction Type.
postingGroupType
object
Transaction group information. Ever posting could represent a. Regular transaction b. Group header - has Group Id, Count, Descripton and Includes Group Memeber…
4 properties
compPostingsType
object
Collection of comp postings.
2 properties
exchangeAmounts
object
Converted values for the Exchange Currency requested.
2 properties
invoices
object
Request to close invoice(s)
3 properties
aRInvoicesCriteriaType
array
Criteria for searching Invoices.
arInvoicesAccount
object
Request to change AR invoice(s) account in AR.
3 properties
changeARInvoicesAccountCriteriaType
object
Criteria for changing AR invoice(s) account.
3 properties
arOldBalances
object
Request to Post AR Old Balances
3 properties
aROldBalancePostingsType
array
Collections of Old Balance Postings
aROldBalancePostingType
object
AR Old Balances Base Posting Type.
4 properties
aROldBalanceChargeType
object
AR Old Balances Single Posting Type.
8 properties
aRTaxCodesType
array
Values of atmost 20 Taxes entered.
aRTaxCodeType
object
AR Old Balances Single Posting Type - Tax and Transaction Code details.
3 properties
profileAging
object
Response to the request to fetch the total Aging information for a Profile.
3 properties
aRProfileAgingInfoType
object
Aging information for a profile. Includes information for the profile for all accounts across properties.
2 properties
profileYearView
object
Response to the request to fetch the total Year View information for a Profile.
3 properties
aRProfileYearViewInfoType
object
Year View information for a profile. Includes information for the profile for all accounts across properties.
2 properties
invoicesAndPaymentsToTransfer
object
Request for transferring invoice(s) in AR.
3 properties
transferARInvoicesCriteriaType
object
Criteria for transferring invoice(s) to another account.
7 properties
transferPostings
object
Request for transferring invoice posting(s)in AR.
3 properties
aRTransferPostingsCriteriaType
object
2 properties
folioReasonType
object
Type for Folio Reason and Text.
2 properties
operaVersionNumberType
string
Current Opera Version Number
operaVersion
object
Response for Ping operation.
3 properties
deleteARTransactionsCriteriaType
object
Criteria type for deletion of transactions.
5 properties
totalTransferARHoldings
object
Details of the Statement to generate.
4 properties
transferARHoldingsProcess
object
Request for Transfer AR Holdings
2 properties
transferARHoldingsProcessDetails
object
Response for Transfer AR Holdings request.
3 properties
SearchARTransactionsRequest
object
14 properties
1 required
searchInvoicesOnHoldRequest
object
14 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Oracle Hospitality publishes across the network.