opera cloud web self-service - docs.oracle.com · this software or hardware is developed for...

Oracle® Hospitality OPERA Cloud Web Self-Service

Accounts Receivables Web Service Reference

January 2018

Copyright © 2018, Oracle and/or its affiliates. All rights reserved.

This software and related documentation are provided under a license agreement containing

restrictions on use and disclosure and are protected by intellectual property laws. Except as

expressly permitted in your license agreement or allowed by law, you may not use, copy,

reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or

display any part, in any form, or by any means. Reverse engineering, disassembly, or

decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be

error-free. If you find any errors, please report them to us in writing.

If this software or related documentation is delivered to the U.S. Government or anyone licensing it

on behalf of the U.S. Government, then the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated

software, any programs installed on the hardware, and/or documentation, delivered to U.S.

Government end users are "commercial computer software" pursuant to the applicable Federal

Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication,

disclosure, modification, and adaptation of the programs, including any operating system,

integrated software, any programs installed on the hardware, and/or documentation, shall be

subject to license terms and license restrictions applicable to the programs. No other rights are

granted to the U.S. Government.

This software or hardware is developed for general use in a variety of information management

applications. It is not developed or intended for use in any inherently dangerous applications,

including applications that may create a risk of personal injury. If you use this software or

hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe,

backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its

affiliates disclaim any liability for any damages caused by use of this software or hardware in

dangerous applications.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be

trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC

trademarks are used under license and are trademarks or registered trademarks of SPARC

International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or

registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open

Group.

This software or hardware and documentation may provide access to or information about content,

products, and services from third parties. Oracle Corporation and its affiliates are not responsible

for and expressly disclaim all warranties of any kind with respect to third-party content, products,

and services unless otherwise set forth in an applicable agreement between you and Oracle. Oracle

Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to

your access to or use of third-party content, products, or services, except as set forth in an

applicable agreement between you and Oracle.

Contents

Preface ....................................................................................................... 4

Audience ............................................................................................................................................................................. 4

Customer Support ............................................................................................................................................................. 4

Documentation ................................................................................................................................................................... 4

Revision History ................................................................................................................................................................ 4

1 AccountsReceivablesService ................................................................ 5

AccountsReceivablesService Web Service ...................................................................................................................... 6

Methods: AccountsReceivablesService .................................................................................................................... 7

Complex Types: AccountsReceivablesService ........................................................................................................ 9

Elements: AccountsReceivablesService ................................................................................................................. 56

4

Preface

This document describes the AccountsReceivablesService web service. The document describes methods,

complex types, and elements.

Audience

This document is intended for developers who develop applications that interface with OPERA through OPERA

Cloud Web Self-Service.

Customer Support

To contact Oracle Customer Support, access My Oracle Support at the following URL:

https://support.oracle.com

When contacting Customer Support, please provide the following:

Product version and program/module name

Functional and technical description of the problem (include business impact)

Detailed step-by-step instructions to re-create

Exact error message received and any associated log files

Screen shots of each step you take

Documentation Oracle Hospitality product documentation is available on the Oracle Help Center at

http://docs.oracle.com/en/industries/hospitality/

Revision History

Date Description of Change

January 2018 Initial publication

https://support.oracle.com/

http://docs.oracle.com/en/industries/hospitality/

5

1 AccountsReceivablesService

Sources

Name Description

AccountsReceivablesService Accounts Receivables Service provides operations used in Accounts Receivables Management.

6

AccountsReceivablesService Web Service

Name

AccountsReceivablesService

Description

Accounts Receivables Service provides operations used in Accounts Receivables Management.

See Also

Methods

Elements

Complex Types

7

Methods: AccountsReceivablesService

Methods

Name Description

CreateAccount Create a new AR Account.

FetchAccount Fetches details for an AR Account.

Method: CreateAccount

Description

Create a new AR Account.

Input

The input of this method is the document element CreateAccountRQ having the structure defined by the

following table.

Name Type Required? Occurs Description

OperaContext OperaContextType No 0..1 Refer to Generic common types document.

Criteria ARAccountType No 0..1 Criteria to create an AR Account.

Output

The output of this method is the document element CreateAccountRS having the structure defined by the

following table.


Yes 1..1

Yes 1..1

Errors ErrorsType No 0..1 Refer to Generic common types document.

Method: FetchAccount

Description

Fetches details for an AR Account.

Input

The input of this method is the document element FetchAccountRQ having the structure defined by the following

table.


OperaContext OperaContextType No 0..1 Refer to Generic common types document.

Criteria FetchARAccountCriteriaType No 0..1 Criteria to fetch details for the AR Account. Fetch Instructions can be given to include information regarding Aging, Reminders, Statements, invoices, payments, notes and traces for the account.

Output

The output of this method is the document element FetchAccountRS having the structure defined by the

following table.

8


Yes 1..1

Yes 1..1

Errors ErrorsType No 0..1 Refer to Generic common types document.

Account ARAccountType No 0..1 Account Details. Details can include information regarding Aging, Reminders, Statements, invoices, payments, notes and traces.

9

Complex Types: AccountsReceivablesService

Complex Type: AddressInfoType

Description

Provides address information.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

1..1

UniqueID UniqueID_Type 0..1 Address id for the address.

Address AddressType 0..1 Address details for the profile.

Complex Type: AddressSearchType

Description

Address Details such as city, state, country, postal code etc.

Attributes

Name Type Required? Description

ExcludeNoCity boolean No When true indicates that only profiles with city will be fetched.

Content Model



1..1

CityName StringLength40 0..1 City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).

PostalCode StringLength15 0..1 Post Office Code number.

State StringLength20 0..1 State or Province name (e.g., Texas).

CountryName CountryNameType 0..1 Country name (e.g., Ireland).

StreetAddress StringLength80 0..1 First Line of Street Address. For profile search it matches the first Address line.

Complex Type: AddressType

Description

Provides address information.

Attributes


Type CodeType No Defines the type of address (e.g. home, business, other). Refer to OpenTravel Code List Communication Location Type (CLT).

TypeDescription string No Describes the type code

10


PrimaryInd boolean No When true, indicates a primary information.

UpdateReservations boolean No Indicates whether to update the reservations or not. If true and the address is primary, then all associated active reservations will be updated with the new primary address.

Content Model



1..1

AddressLine StringLength80 0..4 When the address is unformatted (FormattedInd="false") these lines will contain free form address details. When the address is formatted and street number and street name must be sent independently, the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence.



CityExtension StringLength20 0..1 Post Office City Extension Code number. City Extension mainly used for UK addresses.

County StringLength20 0..1 County or District Name (e.g., Fairfax). This is read only.



Language CodeType 0..1 Language code associated with the address

Complex Type: ARAccountStatusType

Description

Type for the Account Status. Status can be restricted and a message/description added to the Account.

Attributes


Restricted boolean No Flag to indicate if the Account is restricted.

Content Model



1..1

Restriction CodeType 0..1 The Restriction Code added on the Account. This is available when the functionality for adding restriction codes is ON.

Description StringLength2000 0..1 User defined status message on the Account.

11

Complex Type: ARAccountType

Description

Accounts Receivables Account details type.

Attributes


Primary boolean No Indicates if this Account is the Primary Account for this Guest/Company.

Type CodeType No The type of Account.

Permanent boolean No Indicates if this is a Permanent Account. Permanent Accounts cannot be deleted.

Content Model



1..1

HotelCode CodeType 0..1 Property where the AR Account exists.

AccountName StringLength200 0..1 Name of the AR Account.

AccountID UniqueID_Type 0..1 The unique ID for the Account.

AccountNo CodeType 0..1 The Account Number for the Account.

ProfileID UniqueID_Type (extension)

0..1

Balance CurrencyAmountType 0..1 Open Balance of the Account for this property.

CreditLimit CurrencyAmountType 0..1 The maximum credit allowed for the Account.

ContactName StringLength200 0..1 The person to contact for this Account.

PaymentDueDays StringLength20 0..1 Number of days on which person can make payment.

MonthEndCalcYN boolean 0..1 Month End Calculation.

Address AddressInfoType 0..1 Address information for the address which is attached to this AR Account.

Email EmailInfoType 0..1 Email information for the Account. This is the Email that is attached to this AR Account.

Telephones anyType (restriction) 0..1 Telephone and Fax information which is attached to this AR Account.

LastReminderInfo ARReminderHistoryType (extension)

0..1

LastStatementInfo ARStatementHistoryType (extension)

0..1

Notes anyType (restriction) 0..1 Notes attached to this AR Account.

Traces anyType (restriction) 0..1 Traces attached to this AR Account.

FixedCharges FixedChargesType 0..1 Fixed charges attached to this AR Account.

12


AccountIndicators IndicatorsType 0..1 Indicators of additional information attached to the Account.

AgingInfo ARAgingInfoType 0..1 The Aging balance information for this account, by Aging Buckets.

YearViewInfo ARYearViewInfoType 0..1 The Year View balance information for this account.

Invoices ARInvoicesType 0..1 List of all Invoices.

Payments ARPaymentsType 0..1 List of all Payments made.

Summary ARBalanceType 0..1 The Summary Information of the Invoices for the Account.

Status ARAccountStatusType 0..1 The status of the account.

BatchStatement boolean 0..1 Include In Batch Statement

PrintFoliosWithStatement boolean 0..1 Indicates if associated folios should be printed by default with the statement.

EmailStatementsReminders boolean 0..1 Indicates if the Account has opted to send the statements and reminders to the Account email address by default.

SearchMatches SearchMatchesType 0..1 Super Search matching terms.

Complex Type: ARAgingInfoType

Description

Information regarding the aging balances for an account.

Content Model



1..1

TotalOutstanding ARBalanceType 0..1 The total debit and credit balance of the account.

Aging ARAgingType 0..* The debit and credit balance per Aging bucket.

Complex Type: ARAgingType

Description

Aging information for an Aging Bucket.

Attributes


AgingStartDay integer Yes The start number of days for this Aging bucket. Example: For the range 31-60 days, this would be 31.

AgingEndDay integer Yes The end number of days for this Aging bucket. Example: For the range 31-60 days, this would be 60.

Sequence integer No The sequence for display.

Content Model


13


1..1

AgingBucketRange CodeType 0..1 The bucket description in terms of days. Example : 0-31 days

AgingDate DateRangeType 0..1 The start date and end date for this Aging bucket.

BalanceInfo ARBalanceType 0..1 The balance amounts for this bucket. Contains the Debit Balance, Credit Balance and the Total Balance.

Complex Type: ARBalanceType

Description

Balance information for AR.

Content Model



1..1

Debit CurrencyAmountType 0..1 Debit Balance amount. The amount owed by the Account.

Credit CurrencyAmountType 0..1 The credit Balance amount. Any payment that is Unallocated i.e not applied against an invoice, is included in this.

Total CurrencyAmountType 0..1 The total balance i.e Debit minus Credit amounts.

Complex Type: ARInvoicesType

Description

A collection of AR Invoices.

Content Model



1..1

Invoice ARInvoiceType 0..*

Complex Type: ARInvoiceType

Description

Details of an AR Invoice.

Attributes


TrxNo double Yes Unique Transaction Identifier of the Invoice.

TrxDate date No Transaction Date of the invoice.

Status CodeType No Status of the invoice.

TrxCode CodeType No Transaction code of the invoice.

FolioNo double No Folio Number.

14


InvoiceNo double No Invoice No after the folio is generated. Same invoice number may be referred in multiple folios

FiscalBillNo StringLength40 No The Fiscal Bill number of this posting

FolioTypeName StringLength100 No The name of the Folio Type used for the Folio Number sequence.

InternalFolioWindowID CodeType Yes Internal window ID which is unique to the reservation. This ID can only be used for reference.

FolioDate date Yes Date of Folio Generation.

FolioStatus FolioStatusType No The Folio Status Example: DEPOSIT folio, VOID folio or the default OK folio status.

InvoiceType ARInvoiceCategory No Invoice code of the invoice.

StatementNo integer No Statementno of the invoice.

RevenueDate date No Revenue date ID of the invoice.

CloseDate date No Close date of the invoice.

PostingDate date No Posting date of the invoice.

TransferDate date No Transfer date of the invoice.

CanBeModified boolean No Flag to indicate if postings or adjustments can be made to the invoice.

Content Model



1..1

HotelCode CodeType 0..1 Property where the invoice exists.

ReservationID UniqueID_Type (extension)

0..1

GuestProfileId UniqueID_Type 0..1 Guest Profile ID of the invoice.

Age integer 0..1 The Aging age of the invoice

GuestName StringLength200 0..1 Name of the Guest who consumed these transactions.

OriginalAmount CurrencyAmountType 0..1 Original Amount of the Invoice

Amount CurrencyAmountType 0..1 Current Amount of the Invoice.

Payments CurrencyAmountType 0..1 Total Payments made to this Invoice.

Balance CurrencyAmountType 0..1 Amount still open which has not been paid

Reference StringLength2000 0..1 User-defined posting reference.

Remark StringLength2000 0..1 User-defined posting remark.

Adjusted boolean 0..1

ParentInvoiceNo double 0..1

Compressed boolean 0..1

CompressedDate date 0..1

TransferredOut boolean 0..1

TransferredIn boolean 0..1

15


Market MarketCodeInfoType 0..1 Invoice market code.

RoomClass RoomClassCodeInfoType 0..1 Invoice room class code.

Source SourceCodeInfoType 0..1 Invoice source code.

ReservationInfo ReservationInfoType 0..1 Reservation guest details.

CashierInfo CashierInfoType 0..1 Cashier information. Contains Id and Name details of the cashier.

TrxInfo TrxInfoType 0..1 Transaction information.

PaymentCard ResPaymentCardType 0..1 Payment card details.

AddresseeInfo ProfileInfoType 0..1 Addressee Information for the folio. This is available when the Addressee functionality is used and and Addressee is attached to the folio of the Invoice.

AllowPartialTransferYn boolean 0..1 Flag to check Partial Transfer Allowed.

Printed boolean 0..1 Flag to check Invoice Statement is Printed.

PrintedDate date 0..1 Invoice Statement Printed Date.

FolioTexts FolioTextsType 0..1 Additional text fields to display on the folio.

StoredFolioID UniqueID_Type 0..1 ID of the Stored Folio.

StoredFolioName StringLength2000 0..1 Name of the Stored Folio.

Complex Type: ARPaymentsType

Description

A collection of AR Payments.

Content Model



1..1

Payment ARPaymentType 1..*

Complex Type: ARPaymentType

Description

Details of an AR Payment.

Attributes


TrxNo double Yes Unique Transaction Identifier of the Payment.

TrxDate date No Date of the Payment.

TrxCode CodeType No Transaction code of the Payment.



TransferDate date No Transfer of the invoice.

16


SequenceNo integer No When this PostingType is used to return the postings generated by a batch request, the sequence number is used to relate to the Request's sequence number.

Content Model



1..1

Age integer 0..1 The Aging age of the payment.

Amount CurrencyAmountType 0..1 Amount of the Payment.

AmountUsed CurrencyAmountType 0..1 Total amount applied against an invoice.

Balance CurrencyAmountType 0..1 Amount still open which has not been applied against any invoice.







HotelCode CodeType 0..1 Property code.

Complex Type: ARReminderHistoryType

Description

Statement History Type.

Attributes


Age integer No The minimum age(days) of the invoices to be included in the Reminder

ReportName StringLength2000 No Report Name.

ReportFileName StringLength2000 No Report file name when exists to allow report re-printing.

DateSent date No The Reminder Letter name which is to be used for this Reminder based on the setup on the Account Type.

Complex Type: ARReportHistoryType

Description

Report History Type used as based type for Reminders and Statements History types.

Attributes



17




Complex Type: ARStatementHistoryType

Description

Statement History Type.

Attributes





Content Model



1..1

StatementNo integer 0..1 When using Statement Numbering, a unique number is associated to the Statement.

Complex Type: ArticleInfoType

Description

Information regarding an article.

Attributes


HotelCode CodeType No Hotel code to which the article belongs.

ArticleCode CodeType No Unique code of the article.

Inactive boolean No Indicates whether the article is inactive or not.

OrderSequence double No Display Order sequence.

Content Model



1..1

Description StringLength2000 0..1 Description of the article.

TransactionCode CodeType 0..1 Transaction code to which the article belongs.

Price CurrencyAmountType 0..1 Default price of the article.

PostIt ArticlePostItType 0..1 Post it information of the article.

18


UniversalProductCode CodeType 0..1 Unique Universal product code of the article.

Complex Type: ArticlePostItType

Description

Post it information of an article.

Attributes


AvailableForPostIt boolean No Indicates whether the article is available for post it.

Color ColorType No Color indicator which is only configurable if article is available for post it.

Complex Type: ARYearViewInfoType

Description

Information regarding Year View balances for an account.

Content Model



1..1


YearView ARYearViewType 0..* The debit and credit balance per account.

Complex Type: ARYearViewType

Description

Year information for a Year View.

Content Model



1..1

DateRange DateRangeType 0..1 The period start and end date.

BalanceInfo ARBalanceType 0..1 The balance amounts for this date range. Contains the Debit Balance, Credit Balance and the Total Balance.

RunningTotal CurrencyAmountType 0..1 The running total balance for the date range.

Complex Type: AuthorizationRuleType

Description

Configured rule for computing the amount to authorize.

Content Model


19


1..1

Code integer 0..1 The authorization rule code.

1..1

Amount CurrencyAmountType 0..1 The amount applicable to the authorization rule.

Percent double 0..1 A percentage value if the authorization rule is percentage based.

Complex Type: BedTaxReportingType

Description

This stores the information for Bed Tax Reporting. Mainly used in Maldives.

Attributes


TaxRegistrationNo double No Tax Registration Number for Maldives Bed Tax Reporting.

VisaNumber StringLength40 No Visa number used for Maldives Bed Tax Reporting

VisaIssueDate date No Visa Issue Date used for Maldives Bed Tax Reporting.

VisaExpiryDate date No Visa Expiration Date used for Maldives Bed Tax Reporting

TaxableDays integer No Number of days for which the Maldives tax is applicable.

Complex Type: BillingPrivilegesType

Description


Attributes


PostingRestriction boolean No Flag used by interface program during check in.

PreStayCharging boolean No Indicates if the reservation has charging privileges before arrival.

PostStayCharging boolean No Indicates if the reservation has charging privileges after checkout.

FolioCloseDate date No Date when folio was closed. This works with PostStayCharging flag.

ScheduledCheckout boolean No Indicates if the guest is scheduled for automatic check out.

ScheduledCheckoutTime date No Time of automatic check out if guest is schedule for automatic check out.

DirectBillAuthorized boolean No If Direct bill is authorized this will hold User ID who authorized it.

VideoCheckout boolean No Indicates if the guest can do video checkout

20


AllowAutoCheckin boolean No Indicated if a new reservation should be created and automatically checked in whenever the room is checked out. Available for pseudo room types only.

AutoSettlement boolean No Indicates if the is a candidate for auto folio settlement.

AutoSettlementType StringLength40 No The folio settlement type for auto folio settlement.

AutoSettlementFreq integer No The interval of days between each auto folio settlement.

Complex Type: CashierInfoType

Description

Cashier information. Contains Id and Name details of the cashier.

Attributes


CashierId double No Cashier Id of the Cashier.

CashierName StringLength2000 No Cashier Name.

Complex Type: CodeDescriptionType

Description

This contains a generic code and description information.

Attributes


Code CodeType No Code.

Description StringLength2000 No Description.

Complex Type: CommentInfoType

Description

Comment related to the profile/reservation.

Content Model



1..1

UniqueID UniqueID_Type 0..1 Comment ID for the comment. It will be empty in case of new comment.

Comment CommentType 0..1 Comment details for the comment. It will be empty in case of delete comment.

Complex Type: CommentType

Description

Comment related to the profile/reservation.

21

Attributes


Type CodeType No Specifies type of the comment.

TypeDescription StringLength200 No Comment type Description.

Internal boolean No When true, the comment may not be shown to the consumer. When false, the comment may be shown to the consumer.

Confidential boolean No When true, the comment may be confidential.

OverrideInternal boolean No When true, the note internal could be modified.

ProtectDescription boolean No When true, the note title will be populated from the note type description and couldn't be modified.

HotelCode CodeType No If specified comment belongs to the Hotel, otherwise it is a global comment.

ActionType CodeType No Specifies type of action described in the comments.

ActionDate date No Indicates at which date an action described in the comment must be taken.

CreateDateTime dateTime No Time stamp of the creation.

CreatorID StringLength200 No ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.

LastModifyDateTime dateTime No Time stamp of last modification.

LastModifierID StringLength200 No Identifies the last software system or person to modify a record.

PurgeDate date No Date an item will be purged from a database (e.g., from a live database to an archive).

Content Model



1..1

1..1

Image string 0..1 An image for this paragraph.

Text FormattedTextTextType 0..1 Formatted text content.

URL string 0..1 A URL for this paragraph.

CommentTitle StringLength4000 0..1 Specifies Comment's Title.

Complex Type: CountryNameType

Description

The name or code of a country (e.g. as used in an address or to specify citizenship of a traveler).

Attributes


Code CodeType No Code for a country or a nationality.

22

Complex Type: CurrencyAmountType

Description

A monetary value expressed with a currency code.

Attributes


Amount Money No A monetary amount.

CurrencyCode AlphaLength3 No Provides a currency code to reflect the currency in which an amount may be expressed.

Complex Type: DateRangeType

Description

Date Range with Start and End dates.

Attributes


Start date No The starting value of the date range.

End date No The ending value of the date range.

Complex Type: DateTimeSpanType

Description

Measure of time from a StartDateTime to either specified EndDateTime or StartDateTime plus Duration.

Content Model



1..1

StartDateTime dateTime 0..1

EndDateTime dateTime 0..1

Complex Type: EmailInfoType

Description

Information on an email for the customer.

Content Model



1..1

UniqueID UniqueID_Type 0..1 Unique id for the email.

Email EmailType 0..1 eMail details for the profile.

Complex Type: EmailType

Description

Information on an email for the customer.

23

Attributes


EmailAddress StringLength2000 No Defines the e-mail address.

Type CodeType No Defines the purpose of the e-mail address (e.g. personal, business, list serve).

TypeDescription StringLength2000 No Describes the Type code

EmailFormat NMTOKEN (restriction)

No Supported Email format.



Complex Type: ErrorsType

Description

A collection of errors that occurred during the processing of a message.

Content Model



1..1

Error ErrorType 0..99 An error that occurred during the processing of a message.

Complex Type: ErrorType

Description

Standard way to indicate that an error occurred during the processing of an OpenTravel message. If the message

successfully processes, but there are business errors, those errors should be passed in the warning element.

Attributes


Type CodeType Yes The Error element MUST contain the Type attribute that uses a recommended set of values to indicate the error type. The validating XSD can expect to accept values that it has NOT been explicitly coded for and process them by using Type ="Unknown". Refer to OpenTravel Code List Error Warning Type (EWT).

ShortText string No An abbreviated version of the error in textual format.

Code CodeType No If present, this refers to a table of coded values exchanged between applications to identify errors or warnings. Refer to OpenTravel Code List Error Codes (ERR).

DocURL string No If present, this URL refers to an online description of the error that occurred.

24


Status string No If present, recommended values are those enumerated in the OTA_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.

Tag string No 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].

RecordID string No 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.

NodeList string No An XPath expression that selects all the nodes whose data caused this error. Further, this expression should have an additional constraint which contains the data of the node. This will provide the offending data back to systems that cannot maintain the original message.

Complex Type: FacilityCodesType

Description

List of the facility codes.

Content Model



1..1

FacilityCode FacilityCodeType 0..*

Complex Type: FacilityCodeType

Description

Facility Housekeeping Code, its description and quantity.

Attributes


Code CodeType No Facility code value.

Content Model

25



1..1

Description StringLength80 0..1 Facility Code.

Quantity integer 0..1 Signifies the quantity.

Complex Type: FacilityTaskType

Description

Information regarding facility task on a reservation.

Attributes


Date date No The Date on which the task is applicable.

Content Model



1..1

Task HousekeepingTaskCodeType 0..1 The Task Code.

Supplies FacilityCodesType 0..1 Supplies associated with the task.

Complex Type: FetchARAccountCriteriaType

Description

Criteria to fetch details for an AR Account.

Content Model



1..1

HotelCode CodeType 0..1 Property where the Account exist.

AccountID UniqueID_Type 0..1 The internal unique ID for this Account.

AccountNo StringLength200 0..1 Account Number for the Account.


0..1

FetchInstructions anyType (restriction) 0..1 Instructions to fetch Account Details

Complex Type: FixedChargeDetailType

Description

Holds fixed charge detail.

Content Model



1..1

26


Transaction CodeDescriptionType 0..1 Transaction code and description of a fixed charge.

Quantity integer 0..1 Quantity of the product.

1..1

ChargeAmount CurrencyAmountType 0..1 Price of the product.

Percent Percentage 0..1 Percentage of the rate amount.

Supplement StringLength2000 0..1 Additional information regarding the fixed charge.

Article CodeDescriptionType 0..1 Holds related article code and description.

CompNights integer 0..1 Holds number of comp or cash room night to allocate.

Complex Type: FixedChargeScheduleType

Description

Holds schedule of fixed charge.

Attributes




Frequency FixedChargeFrequencyType No Frequency of a fixed charge.

DayToExecute StringLength3 No Day of when to execute fixed charge. Applicable when frequency is Daily or Weekly.

DateToExecute date No Date of when to execute yearly fixed charge. Applicable when frequency is Yearly.

Complex Type: FixedChargesType

Description

List of fixed charges.

Content Model



1..1

FixedCharge FixedChargeType 0..* Holds fixed charge detail.

Complex Type: FixedChargeType

Description

Holds fixed charge information.

Attributes


URL string No URL that identifies the location associated with the record identified by the UniqueID.

27


Type CodeType Yes A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT).

Instance StringLength80 No The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.

ID StringLength80 Yes 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.

IDExtension integer No Additional identifying value assigned by the creating system.

ID_Context StringLength80 No Used to identify the source of the identifier (e.g., IATA, ABTA).

Content Model



1..1

Schedule FixedChargeScheduleType 0..1 Holds schedule of fixed charge.

Charge FixedChargeDetailType 0..1 Holds specific details of fixed charge.

Complex Type: FolioTextsType

Description

This stores the information the type of tax calculation especially with tax exemption, etc.

Content Model



1..1

FolioText anyType (restriction) 0..2 This stores the description for the type of tax calculation especially with tax exemption, etc.

Complex Type: FormattedTextTextType

Description

Provides text and indicates whether it is formatted or not.

Attributes


Formatted boolean No Textual information, which may be formatted as a line of information, or unformatted, as a paragraph of text.

Language language No Language identification.

28


TextFormat NMTOKEN (restriction)

No Indicates the format of text used in the description e.g. unformatted or html.

Complex Type: FreeTextType

Description

Textual information to provide descriptions and/or additional information.

Attributes



Complex Type: GuestLastStayInfoType

Description

Contains last stay related details of the guest.

Content Model



1..1

LastStayDate date 0..1 Guest's last stay date.

LastStayRoom CodeType 0..1 Room Number where the guest stayed.

LastStayRate CurrencyAmountType 0..1 The Rate amount of the guest's last stay.

TotalStay integer 0..1 The total number of previous stay of the guest.

Complex Type: HotelInterfaceType

Content Model



1..1

InterfaceId UniqueID_Type 1..1 Unique DB internal number of a Hotel Interface record.

HotelCode CodeType 1..1 Hotel Code

InterfaceName StringLength40 1..1 Name of the Hotel Interface

InterfaceType HotelInterfaceTypeType 1..1 Three letter code for each interface that identifies the interface.

Logo CodeType 1..1 Hotel Interface Logo. On the database, this is also referred as DBF Logo. This is a three letter code followed by an underscore (_). This tells us which DBF files and log files with the prefix that IFC7 is going to create.

MachineName StringLength80 0..1 Unique machine name of the running IFC.

Status HotelInterfaceStatusType 1..1 The current status of the IFC.

29

Complex Type: HousekeepingTaskCodeType

Description

Information related to a Task Code. Task Codes are used to generate task sheets in Rooms Management.

Attributes


HotelCode CodeType No Property where this task code is configured.

Code CodeType No The Code for the task.

Sequence integer No Ordering sequence for display.

Content Model



1..1

Description StringLength80 0..1 Description of the Task Code.

Instructions StringLength2000 0..1 Instructions for this Task Code.

FacilityDepartureTask boolean 0..1 Indicates if this task code is the default departure task for Facility Tasks. This requires

LinenChange boolean 0..1 Indicates if a linen change is necessary.

Complex Type: IndicatorsType

Description

Collection of lamp indicators.

Content Model



1..1

Indicator IndicatorType 0..*

Complex Type: IndicatorType

Description

Lamp indicator Type.

Attributes


IndicatorName StringLength80 No Name of the indicator.

Count integer No Indicates number of occurrences of the indicator.

Complex Type: InterfaceRightsStatusType

Content Model



1..1

30


Right integer 1..1 Internal code for each allowed right of a Hotel Interface record.

StatusCode StringLength5 1..1 User defined code for an Interface Right.

Description StringLength80 0..1 User defined description for an Interface Right.

Category StringLength1 1..1 Category code of this interface right.

Complex Type: MarketCodeInfoType

Attributes


MarketCode CodeType Yes Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.

HotelCode CodeType Yes Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.

MarketGroup CodeType No Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.

Description StringLength2000 No Used for Character Strings, length 0 to 2000.

Complex Type: MembershipInfoType

Description

The Membership object identifies the frequent customer reward program.

Attributes


ProgramCode CodeType No The code or name of the membership program ('Hertz', 'AAdvantage', etc.).

BonusCode CodeType No The code or name of the bonus program. BonusCode can be used to indicate the level of membership (Gold Club, Platinum member, etc.)

MembershipTypeDesc StringLength2000 No The description of the ProgramCode.(Delta Privilege for code DP)

MembershipLevelDesc StringLength2000 No The description of the Bonus Code.(Platinum for code P)

AccountID StringLength50 No The account identification number for this particular member in this particular program.

Complex Type: OperaContextType

Description

Common instructions coming with all the messages to set certain context in OPERA Database before serving

message request.

Content Model


31


1..1

UserLanguage language 0..1 User's language code.

CROCode CodeType 0..1 Central Reservation office (CRO) code.

HotelCode CodeType 0..1 Hotel code.

Language CodeType 0..1 Hotel's language code.

RunningApplication StringLength3 0..1 Running Application. (Not supported)

TerminalId StringLength128 0..1 Terminal ID from where this request originated.

LogLevel LogLevelType 0..1 Log level to debug the code. such as FINE, FINER etc.

ExternalSystem StringLength80 1..1 External system code.

Override boolean 0..1 Opera context is derived internally by request but in case client wants to override the Opera Context it can send true and then the OperaContext will override the above settings such as HotelCode etc.

TargetExternalSystem StringLength80 0..1 This element carries ID of the External System that serves this request. It is needed only while making a call to External WebServices from OPERA UI through integration.

UseLocal boolean 0..1 Determines whether local system should be used and ignore the external system instead.

Complex Type: OperaWebServiceRQBaseType

Description

This Request base type is used as a base for an extension for OPERA Web Services Requests to provide uniform

implementation.

Attributes


EchoToken StringLength128 No A reference for additional message identification, assigned by the requesting host system. When a request message includes an echo token the corresponding response message MUST include an echo token with an identical value.

TimeStamp dateTime No Indicates the creation date and time of the message in UTC using the following format specified by ISO 8601; YYYY-MM-DDThh:mm:ssZ with time values using the 24 hour clock (e.g. 20 November 2003, 1:59:38 pm UTC becomes 2003-11-20T13:59:38Z).

Version StringLength40 No For all OPERA versioned messages, the version of the message is indicated by an OPERA Version value.

CorrelationID StringLength80 No Allow end-to-end correlation of log messages with the corresponding Web service message throughout the processing of the Web service message.

Content Model


32


1..1

OperaContext OperaContextType 0..1 Refer to Generic common types document.

Complex Type: OperaWebServiceRSBaseType

Description

This Response base type is used as a base for an extension for OPERA Web Services Responses to provide

uniform implementation.

Attributes






Content Model



1..1

1..1

Errors ErrorsType 0..1 Refer to Generic common types document.

1..1

Success SuccessType 0..1 Refer to Generic common types document.

Warnings WarningsType 0..1 Refer to Generic common types document.

Complex Type: ParagraphType

Description

An indication of a new paragraph for a sub-section of a formatted text message.

Content Model



1..1

1..1

33





Complex Type: PointsType

Description

The Redeem Points contains the number of points required to book a room type.

Attributes


AwardsType string No Awards type for the award type rate code.

Points integer No No of points required to book this Room Stay.

Complex Type: ProfileInfoType

Description

Provides information about attached profiles to the block.

Attributes


Type CodeType No Defines the type of Linked profiles for a block.

Content Model



1..1

ProfileID UniqueID_Type 0..1 OPERA ID for the profile attached to the block.

Name StringLength200 0..1 Name for the profile attached to the block.

City StringLength80 0..1 City for the profile attached to the block.

Phone StringLength80 0..1 Phone for the profile attached to the block.

Complex Type: ResAccompanyGuestInfoType

Content Model



1..1

FirstName string 0..1 Given name, first name or names

LastName string 0..1 Family name, last name.

FullName string 0..1 String representation of the full name

RegistrationCardNo StringLength40 0..1 Unique identifier of the police registration card number.

ProfileIDList UniqueIDListType (extension)

0..1

34

Complex Type: ResAccompanyGuestListType

Description

Collection of accompany guests

Content Model



1..1

AccompanyGuest ResAccompanyGuestInfoType 0..*

Complex Type: ResAttachedProfileListType

Content Model



1..1

AttachedProfile ResAttachedProfileType 0..*

Complex Type: ResAttachedProfileType

Attributes


ResProfileType ResProfileTypeType No

Content Model



1..1

Name string 0..1 Attached profile name


0..1

Complex Type: ResCashieringType

Description

Cashiering Information for the reservation.

Attributes


FinanciallyResponsible boolean No The guest from whom payment has to be recovered (direct guest).

ProratedBilling boolean No In case of Appartment style billing indicates whether a prorated amount should be used for an Apartment Style Billing rate.

LastRoomAndTaxPostedDate date No Date of the last Room And Tax posting. Used primarily to know the date in case of Advance Billing.

35


ReverseCheckInAllowed boolean No This attribute is to verify if reverse check-in is allowed for the reservation.

TransactionsPosted boolean No Specifies whether reservation has a financial transaction associated with it.

Content Model



1..1

RevenuesAndBalances ResRevenueBalanceType 0..1 Revenues and Balances Amount summary for the reservation.

BillingPrivileges BillingPrivilegesType 0..1 Billing privileges set on the reservation.

TaxType ReservationTaxTypeInfo 0..1 This stores the code for the type of tax calculation especially with tax exemption, etc.

BedTaxReporting BedTaxReportingType 0..1 This stores the information for Bed Tax Reporting. Mainly used in Maldives.


PeriodicFolio ResPeriodicFolioType 0..1 Information regarding periodic folios set on the reservation.

CompAccounting ResCompAccountingType 0..1 Information regarding comp accounting on the reservation.

ResPreConfiguredRoutingInstruction ResPreConfiguredRoutingInstrType 0..1 Information regarding the selected preconfigured routing instruction on the reservation.

Complex Type: ResCompAccountingType

Description

Information regarding comp accounting on the reservation.

Attributes


CompType CodeType No Code used to identify the casino comp type and ranking of a guest.

Authorizer StringLength40 No ID of the employee who will act as the host for this guest.

36

Complex Type: ReservationAllowedActionsType

Content Model



1..1

AllowedAction ReservationAllowedActionType 0..11 Allowed action.

Complex Type: ReservationBlockType

Description

Key information about the block for a reservation.

Attributes


HotelCode CodeType No This is the HotelCode of the Block.

Content Model



1..1

BlockIDList UniqueIDListType (extension)

0..1

BlockName StringLength40 0..1 The Name of the block that is attached to the reservation.

Complex Type: ReservationDepositType

Description

Reservation Deposit Type.

Attributes


HasPaid boolean No Resolves whether reservation has paid deposit.

HasOutstanding boolean No Resolves whether reservation has outstanding deposit.

Content Model



1..1

AmountRequired Money 0..1 Deposit Amount Required.

AmountPaid Money 0..1 Deposit Amount Paid.

AmountOwed Money 0..1 Deposit Amount Owed.

DueDate date 0..1 Deposit Due Date.

PostingDate date 0..1 Deposit Posting Date.

37

Complex Type: ReservationInfoType

Description

The Reservation class contains the current reservation being created or altered.

Attributes


HotelCode CodeType No Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.

HotelName StringLength80 No Used for Character Strings, length 0 to 80.

RoomStayReservation boolean No Boolean True if this reservation is reserving rooms. False if it is only reserving services.






ResStatus PMS_ResStatusType No Indicates the status of the reservation.

ComputedResStatus PMS_ResStatusType No Indicates the status of the reservation.

WalkInIndicator boolean No When true, indicates the reservation is for a guest that walks-in without a reservation. When false, the reservation is not a walk-in.

AccessRestriction ResAccessRestrictionType No Indicates user restriction on the reservation based on the Access exclusion functionality such as Restriction on Changes, Cancellation or both.

CommissionPayoutTo CommissionPayoutToType No If not null, reservation is considered to pay out commission to either Travel Agent, Source or both.

PaymentMethod CodeType No Payment Method.

PreRegistered boolean No Defines if the reservation is pre-registered or not.

OpenFolio boolean No Returns true when reservation has an open folio.

AllowMobileCheckout boolean No Flag containing true or false value for reservation to be eligible for self-checkout by guest using mobile device . Pass the ‘true’ or ‘false’ values when creating / modifying reservation to indicate whether a reservation is eligible for mobile checkout yes / no. Upon fetch, the current state of the flag will show true or false.

38


AllowMobileViewFolio boolean No Attribute AllowMobileViewFolio is set to true when the reservation is eligible for viewing folio using mobile device.

Content Model



1..1

ReservationIDList UniqueIDListType (extension) 0..1

RoomStay StayInfoType 0..1 Collection of room stays.

ResGuest ResGuestInfoType 0..1 Collection of guests associated with the reservation.

SharedGuests ResSharedGuestListType 0..1 Collection of guests who share this reservation.

AttachedProfiles ResAttachedProfileListType 0..1 List of attached profiles

ReservationPaymentMethod ReservationPaymentMethodType 0..1 Payment method used for this reservation

Specials StringLength4000 0..1 Set of reservation preferences which belongs to the Specials group.

DisplayColor CodeType 0..1 Color setting of the reservation.

ReservationIndicators IndicatorsType 0..1 Indicators of additional information attached to the reservation

RoomStatus HousekeepingRoomStatusType 0..1 Current room status


SourceOfSale SourceOfSaleType 0..1 Point of Sale of reservation. Identifies the entity/channel who made the reservation.

Waitlist WaitlistResType 0..1 Information regarding why reservation has been/was waitlisted. This could hold information as history even if reservation is not in Waitlist status anymore.

Queue ReservationQueueInformationType 0..1 Information about the time and duration this reservation was on Queue for Checkin.

Housekeeping ResHousekeepingType 0..1 Information regarding housekeeping for this reservation.

Cashiering ResCashieringType 0..1 Holds cashiering related information for the reservation.

TaxType TaxTypeType 0..1 This stores the code for the type of tax calculation especially with tax exemption, etc.

Deposit ReservationDepositType 0..1 Holds reservation deposit information.

39


AllowedActions ReservationAllowedActionsType 0..1 Collection of reservation allowed actions.


HotelInterfaceStatusList ReservationInterfaceStatusType 0..* Collection of Hotel Interfaces and rights, this is populated only when fetching interface status for rooms.

GuestPreferredCurrency CodeType 0..1 Currency code preferred by guest.

TurndownInfo ReservationTurndownInfoType 0..1 Currency code preferred by guest.

LastPrivacyPromptDate date 0..1 Last Privacy Prompt Date

Complex Type: ReservationInterfaceStatusType

Description

Hotel Interface Type for a reservation and status of the various services

Content Model



1..1

RoomExtension StringLength20 1..1 Identifier for the room extension

HotelInterface HotelInterfaceType 1..1 Hotel interface information for the reservation

InterfaceRights InterfaceRightsStatusType 0..* Contains a list of status/rights for the various services under this interface

Complex Type: ReservationPaymentMethodType

Attributes


PaymentMethod CodeType No Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.


FolioView integer No

Content Model



1..1

PaymentCard ResPaymentCardType 0..1

Balance CurrencyAmountType 0..1

AuthorizationRule AuthorizationRuleType 0..1

40


EmailFolioInfo EmailInfoType (extension)

0..1 Information element for Email Folio functionality.

Complex Type: ReservationQueueInformationType

Description

Information regarding the Date, Duration and Priority of the reservation on Queue for Check in.

Attributes


Priority integer No The Queue Priority given to this reservation.

AvgQueueTimeToCheckIn integer No The average time, in seconds, a reservation was on queue prior to Check-In.

AvgQueueTimeCurrentReservations integer No The average time, in seconds, of the reservations currently in queue.

QueueDate date No The Business date on which the reservation was due to arrive and is currently placed on Queue for Check In.

Content Model



1..1

TimeSpan TimeSpanType (extension)

1..1 Start and End times on the Queue for the reservation.

Complex Type: ReservationTaxTypeInfo

Description

This stores the information the type of tax calculation especially with tax exemption, etc.

Attributes


TaxExemptNo StringLength20 No Tax exempt number on the profile.

Content Model



1..1

HotelCode CodeType 0..1 Code of the Hotel.

Code CodeType 0..1 Code of the Tax Type.

Description StringLength2000 0..1 Description of the Tax Type.

CollectingAgentTax boolean 1..1 A boolean flag for Collecting Agent Tax

PrintAutoAdjust boolean 1..1 Print auto adjust information for this tax type on the tax exempt report.

41


ReportExemptDays integer 1..1 Number of days after which the guest will be tax exempt. Only used for tax exempt report.

ReportTaxPerc Percentage 1..1 Tax percentage. Only used for tax exempt report.

Complex Type: ReservationTurndownInfoType

Description

Turndown information for a reservation

Content Model



1..1

Allowed boolean 0..1 Indicates if turndown is allowed or not

Status TurndownStatusType 0..1 Indicates turndown status, values could be required, not required, completed

Complex Type: ResExpectedTimesType

Description

Holds the Arrival and Departure Time Information

Attributes


ResExpectedArrivalTime dateTime No Arrival Time

ResExpectedDepartureTime dateTime No Departure Time

Complex Type: ResGuaranteeType

Description

Validations type record returned after Validations are done.

Attributes


GuaranteeCode CodeType No Guarantee Code.

ShortDescription StringLength80 No Guarantee Code.

OnHold boolean No Guarantee Code.

Complex Type: ResGuestExternalInfoType

Description

Specifies Company or Travel Agent profile using IATA or Corp. No.

Content Model



1..1

GivenName GivenNameType 0..1 Given name, first name or names

42


Surname SurnameType 0..1 Family name, last name.

Complex Type: ResGuestInfoType

Description

Specifies Company or Travel Agent profile using IATA or Corp. No.

Attributes


NameType NameTypeType No

Content Model



1..1

UniqueID UniqueID_Type 0..1 Unique identifier of this reservation guest

Membership MembershipInfoType 0..1 The Membership object identifying the frequent customer reward program.

NamePrefix NamePrefixType 0..1 Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.)


AltGivenName StringLength40 0..1 Alternate given name, first name or names

MiddleName StringLength40 0..1 The middle name of the person name

SurnamePrefix StringLength20 0..1 e.g "van der", "von", "de"


AltSurname StringLength40 0..1 Alternate family name, last name.

NameSuffix StringLength20 0..1 Hold various name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.).

NameTitle StringLength20 0..1 Degree or honors (e.g., Ph.D., M.D.)

FullName string 0..1 Full display name

AltFullName string 0..1 Altername full display name

PhoneNumber PhoneNumberType 0..1 Phone number

Email BasicEmailType 0..1 Email address

BirthDate date 0..1 Date of birth

Language LanguageType 0..1 Default language

Nationality CountryNameType 0..1 Affiliation or ethnicity to a particular country.

VIP VIPType 0..1 The supplier's ranking of the customer (e.g., VIP, numerical ranking).

Address AddressSearchType 0..1 Address information that is attached to the reservation guest

43


AccompanyGuests ResAccompanyGuestListType 0..1 List of guest names that are accompanying the reservation guest

ExternalInfo ResGuestExternalInfoType 0..1 External information about the guest associated with the reservation.

GuestLastStayInfo GuestLastStayInfoType 0..1 Contains information regarding the last stay of this guest.

GuestRestrictedCode string 1..1 Guest profile restricted reason code

GuestRestrictedReasonDesc string 1..1 Guest profile restricted reason description

GuestRestricted boolean 1..1 True indicates there are restrictions associated with the current profile.


Complex Type: ResHousekeepingType

Description

Holds housekeeping turndown service information for the room.

Attributes


TurndownRequested boolean No Indicates whether guest wants turndown facility or not.

ServiceTime date No This is the Turndown room service time.

ExpectedServiceTime time No Expected Start Time for housekeeping task(s).

RoomStatus HousekeepingRoomStatusType No Current room status. Current room status is populated only if room is assigned to the reservation and reservation is due in or in house.

Content Model



1..1

Instructions string 0..1 Turndown instructions for the room.

FacilityTaskInfo FacilityTaskType 0..1 The facility task applicable for the current day. This will be information only and not used for any updates.


Complex Type: ResPaymentCardType

Description

Information on a credit card for the customer.

Attributes


CardType CardTypeType No Indicates the type of credit card

44


CardNumber StringLength80 No Used for Character Strings, length 0 to 80.

CardNumberMasked StringLength80 No Used for Character Strings, length 0 to 80.

ExpirationDate date No Expiration date of the credit card

ExpirationDateMasked StringLength20 No Masked Expiration date of the credit card

ExpirationDateExpired boolean No

CardHolderName StringLength200 No Used for Character Strings, length 0 to 200.

AttachCreditCardToProfile boolean No Attach the credit card to profile.

Processing CardProcessingType No This contains information on whether EFT is enabled. A value of 'C' indicates EFT is enabled and 'M' indicates manual authorization is available for this payment card type.

Swiped boolean No

CardNumberType CardNumberTypeType No This contains information on whether credit card is tokenized (token enabled). A value of 'Token' indicates credit card is token enabled and 'CardNumber' indicates non token environment for this payment card type.

Content Model



1..1

CardId UniqueID_Type 0..1 credit card id

CurrentAuthorizedAmount CurrencyAmountType 0..1

ApprovalAmountNeeded CurrencyAmountType 0..1

Complex Type: ResPeriodicFolioType

Description

Information regarding periodic folios set on the reservation.

Attributes


LastSettlementDate date No Latest date when a direct bill settlement was automatically done using the "Direct Bill Batch Folios" option.

LastFolioDate date No Latest date when a folio was printed using the "Periodic Batch Folios" option

Frequency integer No Frequency in number of days when folios should be printed for this reservation.

Complex Type: ResPreConfiguredRoutingInstrType

Description

This stores the rate plan code and profile type information of the preconfigured routing instruction.

45

Attributes


RatePlanCode CodeType No This denotes the rateCode attached with the routing instruction of rateCode type.

ProfileType ResProfileTypeType No This stores the profile type attached with the preconfigured routing instruction.

Complex Type: ResRevenueBalanceType

Description

Revenue and Balance Amount summary for the reservation.

Content Model



1..1

TotalFixedCharge CurrencyAmountType 0..1 Total Fixed Charges on the reservation.

TotalPayment CurrencyAmountType 0..1 Total payment received for the reservation.

RoomRevenue CurrencyAmountType 0..1 Room Revenue generated by the reservation.

FoodAndBevRevenue CurrencyAmountType 0..1 Food and Beverage Revenue generated by the reservation.

OtherRevenue CurrencyAmountType 0..1 Other Revenue generated by the reservation.

NonRevenue CurrencyAmountType 0..1 Total Non Revenue posted on the reservation.

TotalRevenue CurrencyAmountType 0..1 Total Revenue generated by the reservation.

Balance CurrencyAmountType 0..1 Balance amount on the reservation.

Complex Type: ResSharedGuestInfoType

Content Model



1..1


0..1




Complex Type: ResSharedGuestListType

Description

Collection of shared guest reservations.

Content Model



1..1

46


SharedGuest ResSharedGuestInfoType 0..*

Complex Type: RoomClassCodeInfoType

Description

Code of the room class type.

Attributes


RoomClassCode CodeType Yes Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.



Complex Type: RoutingLimitType

Description

Routing Limit Type

Content Model



1..1

RoutingAmount double 0..1 Amount to route for a routing code

RoutingPercent double 0..1 Percentage to route for a routing code

RoutingCovers double 0..1 Covers to route for a routing code

Complex Type: SearchMatchesType

Description

List of Generic Name-Value-Pair Parameters used for super search matches.

Content Model



1..1

SearchMatch SearchMatchType 0..*

Complex Type: SearchMatchType

Description

Search match indicating attribute and the matching value.

Attributes

47


Attribute StringLength2000 No Search match attribute.

Value StringLength2000 No Search match value.

Complex Type: SourceCodeInfoType

Attributes


SourceCode CodeType Yes Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.


SourceGroup CodeType No Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.


Complex Type: SourceOfSaleType

Description

Point of Sale of reservation. Identifies the entity/channel who made the reservation.

Attributes


SourceType StringLength40 No Type of entity/channel who made the reservation.

SourceCode CodeType No The entity/channel who made the reservation.

Complex Type: StayInfoType

Description

Details on the Room Stay including Guest Counts, Time Span of this Room Stay, pointers to Res Guests, guest

Memberships, Comments and Special Requests pertaining to this particular Room Stay and finally financial

information related to the Room Stay, including Guarantee, Deposit and Payment and Cancellation Penalties.

Attributes


ScheduledCheckoutTime date No Indicates that this reservation is scheduled for automated check-out.

RoomNumberLocked boolean No When true, indicates a room number cannot be changed. When false, indicates a room number may be changed.

PseudoRoom boolean No True indicates as pseudo room type. This is usually used for a posting master reservation.

Content Model


48


1..1

TimeSpan TimeSpanType 0..1 The Time Span which covers the Room Stay.

ExpectedTimes ResExpectedTimesType 0..1 The expected arrival and departure times of the guest.

AdultCount integer 0..1 A collection of Guest Counts associated with Room Stay.

ChildCount integer 0..1 A collection of Child Counts associated with Room Stay.

RoomClass CodeType 0..1 Room class code

RoomType CodeType 0..1 Room type code

NumberOfRooms integer 0..1 Room Id

RoomNumber CodeType 0..1 Room Id

RatePlanCode CodeType 0..1 Rate plan code

RateAmount CurrencyAmountType 0..1 Rate amount

Points PointsType 0..1 The Points contains the number of points used to book a particular room type.

RateSuppressed boolean 0..1 Whether this rate should be suppressed from view

ReservationBlock ReservationBlockType 0..1 Key information about the block for this reservation.

BookingChannelCode CodeType 0..1 Booking channel code

PartyCode string 0..1 Party code

FixedRate boolean 0..1 True if the rate is a fixed rate, otherwise false

TotalAmount CurrencyAmountType 0..1 The total amount charged for the Room Stay including additional occupant amounts and fees. If TaxInclusive is set to True, then taxes are included in the total amount.

Guarantee ResGuaranteeType 0..1 The guarantee information associated to the Room Stay. A maximum of 5 occurrences are available for use depending on the context.

MarketCode CodeType 0..1 Market code

49


SourceOfBusiness CodeType 0..1 Source of business

SourceOfBusinessDescription StringLength4000 0..1 Description of the source of business.

Balance CurrencyAmountType 0..1 Balance amount

CompBalance CurrencyAmountType 0..1 Comp Balance amount

RoomTypeCharged CodeType 0..1 Room type code that was charged

DepositPayments CurrencyAmountType 0..1 A collection of deposit and/or payments for the Room Stay.

GuestServiceStatus GuestHousekeepingServiceRequestType 0..1 Service Status of In House guest like DND or MUP

Complex Type: SuccessType

Description

Returning an empty element of this type indicates the successful processing of an OpenTravel message. This is

used in conjunction with the Warning Type to report any warnings or business errors.

Complex Type: TaxTypeType

Description

Provides information about the Tax Type.

Content Model



1..1








Complex Type: TelephoneInfoType

Description

Information on a telephone number for the customer.

Content Model


50


1..1

UniqueID UniqueID_Type 0..1 Unique id for the phone.

Telephone TelephoneType 0..1 Phone details for the profile.

Complex Type: TelephoneType

Description

Information on a telephone number for the customer.

Attributes


PhoneTechType CodeType No Indicates type of technology associated with this telephone number, such as Voice, Data, Fax, Pager, Mobile, TTY, etc. Refer to OpenTravel Code List Phone Technology Type (PTT).

PhoneUseType CodeType No Describes the type of telephone number, in the context of its general use (e.g. Home, Business, Emergency Contact, Travel Arranger, Day, Evening). Refer to OpenTravel Code List Phone Use Type (PUT).

PhoneUseTypeDescription StringLength2000 No Description of the PhoneUseType code

PhoneNumber StringLength40 Yes Telephone number assigned to a single location.

Extension StringLength20 No Extension to reach a specific party at the phone number.



Complex Type: TimeSpanType

Description

Measure of time from a StartDate to either specified EndDate or StartDate plus Duration.

Content Model



1..1

StartDate date 0..1

1..1

Duration duration 0..1

EndDate date 0..1

Complex Type: TraceResolveType

Content Model


51


1..1

ResolvedOn date 0..1 Date the trace was resolved

ResolvedBy string 0..1 User that resolved the trace

Complex Type: TraceTimeInfoType

Content Model



1..1

DateTimeSpan DateTimeSpanType 0..1 Time span for the trace.

TraceOn dateTime 0..1 Date of the trace.

TraceTime StringLength20 0..1 Time of the trace

EnteredBy string 0..1 User that entered this trace.

Complex Type: TraceType

Attributes













52

Content Model



1..1

TimeInfo TraceTimeInfoType 0..1 Date of the trace.


0..1

DepartmentID CodeType 0..1 Indicates the Department code.

TraceText string 0..1 The information this trace contains.

ResolveInfo TraceResolveType 0..1 Information regarding the status of the trace

Complex Type: TrxInfoType

Description

Transaction codes info.

Attributes


TrxCode CodeType No Unique identifier for the Transaction code.

HotelCode CodeType No Hotel context of the Transaction code.

PrintTrxReceipt boolean No Print receipt flag that tells whether the transaction receipt is to be printed or not. This is based on the transaction code.

Content Model



1..1

Description StringLength2000 0..1 Transaction codes info.

TrxGroup StringLength20 0..1 Category of the transaction code.

TrxSubGroup StringLength20 0..1 Sub category of the transaction code.

UniversalProductCode CodeType 0..1 Unique Universal product code of the transaction code.

Articles anyType (restriction) 0..1 The List of Articles defined for this transaction code, when using the Articles functionality.

RoutingLimit RoutingLimitType 0..1 Routing Limit Details

Complex Type: UniqueID_Type

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).

Attributes



53







Complex Type: UniqueIDListType

Description

Used to provide PMS and/or CRS identifiers.

Content Model



1..1

UniqueID UniqueID_Type 0..* Unique Id that references an object uniquely in the system.

Complex Type: VIPType

Description

The supplier's ranking of the customer.

Attributes


VIPCode CodeType No VIP Code.

VIPDescription StringLength80 No VIP Description.

Complex Type: WaitlistResType

Description

Information regarding why reservation is being /has been waitlisted.

Attributes


ReasonCode CodeType No Waitlist Reason Code.

PriorityCode CodeType No Waitlist Priority Code.

54


Telephone StringLength40 No Guest telephone number.

Content Model



1..1

ReasonDescription StringLength2000 0..1 Waitlist Reason Description.

PriorityDescription StringLength2000 0..1 Waitlist priority Description.

Description StringLength2000 0..1 Description why the reservation is being /has been waitlisted.

Complex Type: WarningsType

Description

Collection of warnings.

Content Model



1..1

Warning WarningType 0..* Used in conjunction with the Success element to define a business error.

Complex Type: WarningType

Description

Used when a message has been successfully processed to report any warnings or business errors that occurred.

Attributes


Type CodeType Yes 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". Refer to OpenTravel Code List Error Warning Type (EWT).




55





RPH RPH_Type No Reference Place Holder used as an index for this warning.

56

Elements: AccountsReceivablesService

Element: AccompanyGuest [type ResAccompanyGuestListType]

Content Model



1..1






0..1

Element: AccompanyGuests [type ResGuestInfoType]

Description

List of guest names that are accompanying the reservation guest

Content Model



1..1

AccompanyGuest ResAccompanyGuestInfoType 0..*

Element: Account [element FetchAccountRS]

Description

Account Details. Details can include information regarding Aging, Reminders, Statements, invoices, payments,

notes and traces.

Attributes





Content Model



1..1



57





0..1










0..1


0..1















58

Element: AccountID [type ARAccountType]

Description

The unique ID for the Account.

Attributes








Element: AccountID [type FetchARAccountCriteriaType]

Description

The internal unique ID for this Account.

Attributes







59



Element: AccountIndicators [type ARAccountType]

Description

Indicators of additional information attached to the Account.

Content Model



1..1


Element: AccountName [type ARAccountType]

Description

Name of the AR Account.

Element: AccountNo [type ARAccountType]

Description

The Account Number for the Account.

Element: AccountNo [type FetchARAccountCriteriaType]

Description

Account Number for the Account.

Element: Address [type AddressInfoType]

Description

Address details for the profile.

Attributes


Type CodeType No Defines the type of address (e.g. home, business, other). Refer to OpenTravel Code List Communication Location Type (CLT).

TypeDescription string No Describes the type code


UpdateReservations boolean No Indicates whether to update the reservations or not. If true and the address is primary, then all associated active reservations will be updated with the new primary address.

Content Model



1..1

60


AddressLine StringLength80 0..4 When the address is unformatted (FormattedInd="false") these lines will contain free form address details. When the address is formatted and street number and street name must be sent independently, the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence.



CityExtension StringLength20 0..1 Post Office City Extension Code number. City Extension mainly used for UK addresses.

County StringLength20 0..1 County or District Name (e.g., Fairfax). This is read only.



Language CodeType 0..1 Language code associated with the address

Element: Address [type ARAccountType]

Description

Address information for the address which is attached to this AR Account.

Content Model



1..1

UniqueID UniqueID_Type 0..1 Address id for the address.

Address AddressType 0..1 Address details for the profile.

Element: Address [type ResGuestInfoType]

Description

Address information that is attached to the reservation guest

Attributes


ExcludeNoCity boolean No When true indicates that only profiles with city will be fetched.

Content Model



1..1


61





StreetAddress StringLength80 0..1 First Line of Street Address. For profile search it matches the first Address line.

Element: AddresseeInfo [type ARInvoiceType]

Description

Addressee Information for the folio. This is available when the Addressee functionality is used and Addressee is

attached to the folio of the Invoice.

Attributes


Type CodeType No Defines the type of Linked profiles for a block.

Content Model



1..1

ProfileID UniqueID_Type 0..1 OPERA ID for the profile attached to the block.

Name StringLength200 0..1 Name for the profile attached to the block.

City StringLength80 0..1 City for the profile attached to the block.

Phone StringLength80 0..1 Phone for the profile attached to the block.

Element: AddressLine [type AddressType]

Description

When the address is unformatted (FormattedInd="false") these lines will contain free form address details. When

the address is formatted and street number and street name must be sent independently, the street number will

be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence.

Element: Adjusted [type ARInvoiceType]

Element: AdultCount [type StayInfoType]

Description

A collection of Guest Counts associated with Room Stay.

Element: Age [type ARInvoiceType]

Description

The Aging age of the invoice

Element: Age [type ARPaymentType]

Description

The Aging age of the payment.

62

Element: Aging [type ARAgingInfoType]

Description

The debit and credit balance per Aging bucket.

Attributes


AgingStartDay integer Yes The start number of days for this Aging bucket. Example: For the range 31-60 days, this would be 31.

AgingEndDay integer Yes The end number of days for this Aging bucket. Example: For the range 31-60 days, this would be 60.

Sequence integer No The sequence for display.

Content Model



1..1

AgingBucketRange CodeType 0..1 The bucket description in terms of days. Example : 0-31 days

AgingDate DateRangeType 0..1 The start date and end date for this Aging bucket.

BalanceInfo ARBalanceType 0..1 The balance amounts for this bucket. Contains the Debit Balance, Credit Balance and the Total Balance.

Element: AgingBucketRange [type ARAgingType]

Description

The bucket description in terms of days. Example: 0-31 days

Element: AgingDate [type ARAgingType]

Description

The start date and end date for this Aging bucket.

Attributes




Element: AgingInfo [type ARAccountType]

Description

The Aging balance information for this account, by Aging Buckets.

Content Model



1..1


63


Aging ARAgingType 0..* The debit and credit balance per Aging bucket.

Element: Allowed [type ReservationTurndownInfoType]

Description

Indicates if turndown is allowed or not

Element: AllowedAction [type ReservationAllowedActionsType]

Description

Allowed action.

Enumeration

Value

Cancel

Move

PreCharge

PostCharge

FacilitySchedule

Upsell

PreCheckIn

PostToNoShowCancel

NoShow

NameChange

Discount

Element: AllowedActions [type ReservationInfoType]

Description

Collection of reservation allowed actions.

Content Model



1..1

AllowedAction ReservationAllowedActionType 0..11 Allowed action.

Element: AllowPartialTransferYn [type ARInvoiceType]

Description

Flag to check Partial Transfer Allowed.

Element: AltFullName [type ResGuestInfoType]

Description

Altername full display name

64

Element: AltGivenName [type ResGuestInfoType]

Description

Alternate given name, first name or names

Element: AltSurname [type ResGuestInfoType]

Description

Alternate family name, last name.

Element: Amount [type ARInvoiceType]

Description

Current Amount of the Invoice.

Attributes




Element: Amount [type ARPaymentType]

Description

Amount of the Payment.

Attributes




Element: Amount [type AuthorizationRuleType]

Description

The amount applicable to the authorization rule.

Attributes




Element: AmountOwed [type ReservationDepositType]

Description

Deposit Amount Owed.

Element: AmountPaid [type ReservationDepositType]

Description

65

Deposit Amount Paid.

Element: AmountRequired [type ReservationDepositType]

Description

Deposit Amount Required.

Element: AmountUsed [type ARPaymentType]

Description

Total amount applied against an invoice.

Attributes




Element: ApprovalAmountNeeded [type ResPaymentCardType]

Attributes




Element: Article [type FixedChargeDetailType]

Description

Holds related article code and description.

Attributes




Element: Article [type TrxInfoType/Articles]

Attributes


HotelCode CodeType No Hotel code to which the article belongs.

ArticleCode CodeType No Unique code of the article.

Inactive boolean No Indicates whether the article is inactive or not.


Content Model



1..1

66


Description StringLength2000 0..1 Description of the article.

TransactionCode CodeType 0..1 Transaction code to which the article belongs.

Price CurrencyAmountType 0..1 Default price of the article.

PostIt ArticlePostItType 0..1 Post it information of the article.

UniversalProductCode CodeType 0..1 Unique Universal product code of the article.

Element: Articles [type TrxInfoType]

Description

The List of Articles defined for this transaction code, when using the Articles functionality.

Content Model



1..1

Article ArticleInfoType 1..*

Element: AttachedProfile [type ResAttachedProfileListType]

Attributes


ResProfileType ResProfileTypeType No

Content Model



1..1

Name string 0..1 Attached profile name


0..1

Element: AttachedProfiles [type ReservationInfoType]

Description

List of attached profiles

Content Model



1..1

AttachedProfile ResAttachedProfileType 0..*

Element: AuthorizationRule [type ReservationPaymentMethodType]

Content Model


67


1..1

Code integer 0..1 The authorization rule code.

1..1

Amount CurrencyAmountType 0..1 The amount applicable to the authorization rule.

Percent double 0..1 A percentage value if the authorization rule is percentage based.

Element: Balance [type ARAccountType]

Description

Open Balance of the Account for this property.

Attributes




Element: Balance [type ARInvoiceType]

Description

Amount still open which has not been paid

Attributes




Element: Balance [type ARPaymentType]

Description

Amount still open which has not been applied against any invoice.

Attributes




Element: Balance [type ReservationPaymentMethodType]

Attributes




68

Element: Balance [type ResRevenueBalanceType]

Description

Balance amount on the reservation.

Attributes




Element: Balance [type StayInfoType]

Description

Balance amount

Attributes




Element: BalanceInfo [type ARAgingType]

Description

The balance amounts for this bucket. Contains the Debit Balance, Credit Balance and the Total Balance.

Content Model



1..1




Element: BalanceInfo [type ARYearViewType]

Description

The balance amounts for this date range. Contains the Debit Balance, Credit Balance and the Total Balance.

Content Model



1..1


69




Element: BatchStatement [type ARAccountType]

Description

Include In Batch Statement

Element: BedTaxReporting [type ResCashieringType]

Description


Attributes


TaxRegistrationNo double No Tax Registration Number for Maldives Bed Tax Reporting.

VisaNumber StringLength40 No Visa number used for Maldives Bed Tax Reporting

VisaIssueDate date No Visa Issue Date used for Maldives Bed Tax Reporting.

VisaExpiryDate date No Visa Expiration Date used for Maldives Bed Tax Reporting

TaxableDays integer No Number of days for which the Maldives tax is applicable.

Element: BillingPrivileges [type ResCashieringType]

Description

Billing privileges set on the reservation.

Attributes


PostingRestriction boolean No Flag used by interface program during check in.

PreStayCharging boolean No Indicates if the reservation has charging privileges before arrival.

PostStayCharging boolean No Indicates if the reservation has charging privileges after checkout.

FolioCloseDate date No Date when folio was closed. This works with PostStayCharging flag.

ScheduledCheckout boolean No Indicates if the guest is scheduled for automatic check out.

ScheduledCheckoutTime date No Time of automatic check out if guest is schedule for automatic check out.

DirectBillAuthorized boolean No If Direct bill is authorized this will hold User ID who authorized it.

VideoCheckout boolean No Indicates if the guest can do video checkout

70


AllowAutoCheckin boolean No Indicated if a new reservation should be created and automatically checked in whenever the room is checked out. Available for pseudo room types only.

AutoSettlement boolean No Indicates if the is a candidate for auto folio settlement.

AutoSettlementType StringLength40 No The folio settlement type for auto folio settlement.

AutoSettlementFreq integer No The interval of days between each auto folio settlement.

Element: BirthDate [type ResGuestInfoType]

Description

Date of birth

Element: BlockIDList

Content Model



1..1


Element: BlockName [type ReservationBlockType]

Description

The Name of the block that is attached to the reservation.

Element: BookingChannelCode [type StayInfoType]

Description

Booking channel code

Element: CardId [type ResPaymentCardType]

Description

Credit card id

Attributes




71






Element: CashierInfo [type ARInvoiceType]

Description


Attributes




Element: CashierInfo [type ARPaymentType]

Description


Attributes




Element: Cashiering [type ReservationInfoType]

Description

Holds cashiering related information for the reservation.

Attributes


FinanciallyResponsible boolean No The guest from whom payment has to be recovered (direct guest).

ProratedBilling boolean No In case of Appartment style billing indicates whether a prorated amount should be used for an Apartment Style Billing rate.

LastRoomAndTaxPostedDate date No Date of the last Room And Tax posting. Used primarily to know the date in case of Advance Billing.

72


ReverseCheckInAllowed boolean No This attribute is to verify if reverse check-in is allowed for the reservation.

TransactionsPosted boolean No Specifies whether reservation has a financial transaction associated with it.

Content Model



1..1


BillingPrivileges BillingPrivilegesType 0..1 Billing privileges set on the reservation.

TaxType ReservationTaxTypeInfo 0..1 This stores the code for the type of tax calculation especially with tax exemption, etc.

BedTaxReporting BedTaxReportingType 0..1 This stores the information for Bed Tax Reporting. Mainly used in Maldives.


PeriodicFolio ResPeriodicFolioType 0..1 Information regarding periodic folios set on the reservation.

CompAccounting ResCompAccountingType 0..1 Information regarding comp accounting on the reservation.

ResPreConfiguredRoutingInstruction ResPreConfiguredRoutingInstrType 0..1 Information regarding the selected preconfigured routing instruction on the reservation.

Element: Category [type InterfaceRightsStatusType]

Description

Category code of this interface right.

Element: Charge [type FixedChargeType]

Description

Holds specific details of fixed charge.

Content Model


73


1..1

Transaction CodeDescriptionType 0..1 Transaction code and description of a fixed charge.

Quantity integer 0..1 Quantity of the product.

1..1

ChargeAmount CurrencyAmountType 0..1 Price of the product.

Percent Percentage 0..1 Percentage of the rate amount.

Supplement StringLength2000 0..1 Additional information regarding the fixed charge.

Article CodeDescriptionType 0..1 Holds related article code and description.

CompNights integer 0..1 Holds number of comp or cash room night to allocate.

Element: ChargeAmount [type FixedChargeDetailType]

Description

Price of the product.

Attributes




Element: ChildCount [type StayInfoType]

Description

A collection of Child Counts associated with Room Stay.

Element: City [type ProfileInfoType]

Description

City for the profile attached to the block.

Element: CityExtension [type AddressType]

Description

Post Office City Extension Code number. City Extension mainly used for UK addresses.

Element: CityName [type AddressSearchType]

Description

City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).

Element: CityName [type AddressType]

Description

City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).

74

Element: Code [type AuthorizationRuleType]

Description

The authorization rule code.

Element: Code [type TaxTypeType]

Description

Code of the Tax Type.

Element: CollectingAgentTax [type TaxTypeType]

Description

A boolean flag for Collecting Agent Tax

Element: Comment [type CommentInfoType]

Description

Comment details for the comment. It will be empty in case of delete comment.

Attributes


Type CodeType No Specifies type of the comment.

TypeDescription StringLength200 No Comment type Description.

Internal boolean No When true, the comment may not be shown to the consumer. When false, the comment may be shown to the consumer.

Confidential boolean No When true, the comment may be confidential.

OverrideInternal boolean No When true, the note internal could be modified.

ProtectDescription boolean No When true, the note title will be populated from the note type description and couldn't be modified.

HotelCode CodeType No If specified comment belongs to the Hotel, otherwise it is a global comment.

ActionType CodeType No Specifies type of action described in the comments.

ActionDate date No Indicates at which date an action described in the comment must be taken.






Content Model


75


1..1

1..1




CommentTitle StringLength4000 0..1 Specifies Comment's Title.

Element: CommentTitle [type CommentType]

Description

Specifies Comment's Title.

Element: CompAccounting [type ResCashieringType]

Description

Information regarding comp accounting on the reservation.

Attributes


CompType CodeType No Code used to identify the casino comp type and ranking of a guest.

Authorizer StringLength40 No ID of the employee who will act as the host for this guest.

Element: CompBalance [type StayInfoType]

Description

Comp Balance amount

Attributes




Element: CompNights [type FixedChargeDetailType]

Description

Holds number of comp or cash room night to allocate.

Element: Compressed [type ARInvoiceType]

Element: CompressedDate [type ARInvoiceType]

Element: ContactName [type ARAccountType]

Description

The person to contact for this Account.

76

Element: CountryName [type AddressSearchType]

Description

Country name (e.g., Ireland).

Attributes



Element: CountryName [type AddressType]

Description

Country name (e.g., Ireland).

Attributes



Element: County [type AddressType]

Description

County or District Name (e.g., Fairfax). This is read only.

Element: CreateAccountRQ

Description

Request to create a new AR Account

Attributes






Content Model



1..1

77



Criteria ARAccountType 0..1 Criteria to create an AR Account.

Element: CreateAccountRS

Description

Response for the request to create a new AR Account. Contains errors or warnings if any.

Attributes






Content Model



1..1

1..1


1..1



Element: Credit [type ARBalanceType]

Description

The credit Balance amount. Any payment that is Unallocated i.e not applied against an invoice, is included in this.

Attributes




78

Element: CreditLimit [type ARAccountType]

Description

The maximum credit allowed for the Account.

Attributes




Element: Criteria [element CreateAccountRQ]

Description

Criteria to create an AR Account.

Attributes





Content Model



1..1






0..1








79




0..1


0..1















Element: Criteria [element FetchAccountRQ]

Description

Criteria to fetch details for the AR Account. Fetch Instructions can be given to include information regarding

Aging, Reminders, Statements, invoices, payments, notes and traces for the account.

Content Model



1..1

HotelCode CodeType 0..1 Property where the Account exist.

AccountID UniqueID_Type 0..1 The internal unique ID for this Account.

AccountNo StringLength200 0..1 Account Number for the Account.


0..1

FetchInstructions anyType (restriction) 0..1 Instructions to fetch Account Details

80

Element: CROCode [type OperaContextType]

Description

Central Reservation office (CRO) code.

Element: CurrentAuthorizedAmount [type ResPaymentCardType]

Attributes




Element: DateRange [type ARYearViewType]

Description

The period start and end date.

Attributes




Element: DateTimeSpan [type TraceTimeInfoType]

Description

Time span for the trace.

Content Model



1..1

StartDateTime dateTime 0..1

EndDateTime dateTime 0..1

Element: Debit [type ARBalanceType]

Description

Debit Balance amount. The amount owed by the Account.

Attributes




Element: DepartmentID [type TraceType]

Description

Indicates the Department code.

81

Element: Deposit [type ReservationInfoType]

Description

Holds reservation deposit information.

Attributes


HasPaid boolean No Resolves whether reservation has paid deposit.

HasOutstanding boolean No Resolves whether reservation has outstanding deposit.

Content Model



1..1

AmountRequired Money 0..1 Deposit Amount Required.

AmountPaid Money 0..1 Deposit Amount Paid.

AmountOwed Money 0..1 Deposit Amount Owed.

DueDate date 0..1 Deposit Due Date.

PostingDate date 0..1 Deposit Posting Date.

Element: DepositPayments [type StayInfoType]

Description

A collection of deposit and/or payments for the Room Stay.

Attributes




Element: Description [type ARAccountStatusType]

Description

User defined status message on the Account.

Element: Description [type ArticleInfoType]

Description

Description of the article.

Element: Description [type FacilityCodeType]

Description

Facility Code.

Element: Description [type HousekeepingTaskCodeType]

Description

82

Description of the Task Code.

Element: Description [type InterfaceRightsStatusType]

Description

User defined description for an Interface Right.

Element: Description [type TaxTypeType]

Description

Description of the Tax Type.

Element: Description [type TrxInfoType]

Description

Transaction codes info.

Element: Description [type WaitlistResType]

Description

Description why the reservation is being /has been waitlisted.

Element: DisplayColor [type ReservationInfoType]

Description

Color setting of the reservation.

Element: DueDate [type ReservationDepositType]

Description

Deposit Due Date.

Element: Duration [type TimeSpanType]

Element: Email [type ARAccountType]

Description

Email information for the Account. This is the Email that is attached to this AR Account.

Content Model



1..1



Element: Email [type EmailInfoType]

Description

eMail details for the profile.

Attributes

83


EmailAddress StringLength2000 No Defines the e-mail address.

Type CodeType No Defines the purpose of the e-mail address (e.g. personal, business, list serve).

TypeDescription StringLength2000 No Describes the Type code

EmailFormat NMTOKEN (restriction)

No Supported Email format.



Element: Email [type ResGuestInfoType]

Description

Email address

Element: EmailFolioInfo [type ReservationPaymentMethodType]

Description

Information element for Email Folio functionality.

Attributes


EmailFolio boolean No

Content Model



1..1



Element: EmailStatementsReminders [type ARAccountType]

Description

Indicates if the Account has opted to send the statements and reminders to the Account email address by default.

Element: EndDate [type TimeSpanType]

Element: EndDateTime [type DateTimeSpanType]

Element: EnteredBy [type TraceTimeInfoType]

Description

User that entered this trace.

Element: Error [type ErrorsType]

Description

An error that occurred during the processing of a message.

84

Attributes


Type CodeType Yes The Error element MUST contain the Type attribute that uses a recommended set of values to indicate the error type. The validating XSD can expect to accept values that it has NOT been explicitly coded for and process them by using Type ="Unknown". Refer to OpenTravel Code List Error Warning Type (EWT).







NodeList string No An XPath expression that selects all the nodes whose data caused this error. Further, this expression should have an additional constraint which contains the data of the node. This will provide the offending data back to systems that cannot maintain the original message.

Element: Errors [type OperaWebServiceRSBaseType]

Description

Refer to Generic common types document.

Content Model

85



1..1

Error ErrorType 0..99 An error that occurred during the processing of a message.

Element: ExpectedTimes [type StayInfoType]

Description

The expected arrival and departure times of the guest.

Attributes


ResExpectedArrivalTime dateTime No Arrival Time

ResExpectedDepartureTime dateTime No Departure Time

Element: ExternalInfo [type ResGuestInfoType]

Description

External information about the guest associated with the reservation.

Content Model



1..1



Element: ExternalSystem [type OperaContextType]

Description

External system code.

Element: FacilityCode [type FacilityCodesType]

Attributes


Code CodeType No Facility code value.

Content Model



1..1

Description StringLength80 0..1 Facility Code.

Quantity integer 0..1 Signifies the quantity.

Element: FacilityDepartureTask [type HousekeepingTaskCodeType]

Description

86

Indicates if this task code is the default departure task for Facility Tasks. This requires

Element: FacilityTaskInfo [type ResHousekeepingType]

Description

The facility task applicable for the current day. This will be information only and not used for any updates.

Attributes


Date date No The Date on which the task is applicable.

Content Model



1..1

Task HousekeepingTaskCodeType 0..1 The Task Code.

Supplies FacilityCodesType 0..1 Supplies associated with the task.

Element: FetchAccountRQ

Description

Request to fetch details for an AR Account based on fetch Instructions.

Attributes






Content Model



1..1


87


Criteria FetchARAccountCriteriaType 0..1 Criteria to fetch details for the AR Account. Fetch Instructions can be given to include information regarding Aging, Reminders, Statements, invoices, payments, notes and traces for the account.

Element: FetchAccountRS

Description

Response for the request to fetch details for an AR Account.

Attributes






Content Model



1..1

1..1


1..1



Account ARAccountType 0..1 Account Details. Details can include information regarding Aging, Reminders, Statements, invoices, payments, notes and traces.

Element: FetchInstructions [type FetchARAccountCriteriaType]

Description

Instructions to fetch Account Details

Content Model


88


1..1

Instruction ARAccountInstructionsType 0..*

Element: FirstName [type ResAccompanyGuestInfoType]

Description

Given name, first name or names

Element: FirstName [type ResSharedGuestInfoType]

Description


Element: FixedCharge [type FixedChargesType]

Description

Holds fixed charge detail.

Attributes








Content Model



1..1

Schedule FixedChargeScheduleType 0..1 Holds schedule of fixed charge.

Charge FixedChargeDetailType 0..1 Holds specific details of fixed charge.

Element: FixedCharges [type ARAccountType]

Description

89

Fixed charges attached to this AR Account.

Content Model



1..1

FixedCharge FixedChargeType 0..* Holds fixed charge detail.

Element: FixedRate [type StayInfoType]

Description

True if the rate is a fixed rate, otherwise false

Element: FolioText [type FolioTextsType]

Description

This stores the description for the type of tax calculation especially with tax exemption, etc.

Attributes


Text StringLength50 No Additional text field to display on the folio.

Row integer No Row number of the additional text.

Element: FolioTexts [type ARInvoiceType]

Description

Additional text fields to display on the folio.

Content Model



1..1


Element: FolioTexts [type ResCashieringType]

Description

Additional text fields to display on the folio.

Content Model



1..1


Element: FoodAndBevRevenue [type ResRevenueBalanceType]

Description

90

Food and Beverage Revenue generated by the reservation.

Attributes




Element: FullName [type ResAccompanyGuestInfoType]

Description

String representation of the full name

Element: FullName [type ResGuestInfoType]

Description

Full display name

Element: FullName [type ResSharedGuestInfoType]

Description

String representation of the full name

Element: GivenName [type ResGuestExternalInfoType]

Description


Element: GivenName [type ResGuestInfoType]

Description


Element: Guarantee [type StayInfoType]

Description

The guarantee information associated to the Room Stay. A maximum of 5 occurrences are available for use

depending on the context.

Attributes


GuaranteeCode CodeType No Guarantee Code.

ShortDescription StringLength80 No Guarantee Code.

OnHold boolean No Guarantee Code.

Element: GuestLastStayInfo [type ResGuestInfoType]

Description

Contains information regarding the last stay of this guest.

Content Model


91


1..1

LastStayDate date 0..1 Guest's last stay date.

LastStayRoom CodeType 0..1 Room Number where the guest stayed.

LastStayRate CurrencyAmountType 0..1 The Rate amount of the guest's last stay.

TotalStay integer 0..1 The total number of previous stay of the guest.

Element: GuestName [type ARInvoiceType]

Description

Name of the Guest who consumed these transactions.

Element: GuestPreferredCurrency [type ReservationInfoType]

Description

Currency code preferred by guest.

Element: GuestProfileId [type ARInvoiceType]

Description

Guest Profile ID of the invoice.

Attributes








Element: GuestRestricted [type ResGuestInfoType]

Description

True indicates there are restrictions associated with the current profile.

92

Element: GuestRestrictedCode [type ResGuestInfoType]

Description

Guest profile restricted reason code

Element: GuestRestrictedReasonDesc [type ResGuestInfoType]

Description

Guest profile restricted reason description

Element: GuestServiceStatus [type StayInfoType]

Description

Service Status of In House guest like DND or MUP

Enumeration

Value

Do Not Disturb

Make Up Room

Element: HistoryExists [type ARAccountType/LastReminderInfo]

Description

Indicates that reminders history exists.

Element: HistoryExists [type ARAccountType/LastStatementInfo]

Description

Indicates that statement history exists.

Element: HotelCode [type ARAccountType]

Description

Property where the AR Account exists.

Element: HotelCode [type ARInvoiceType]

Description

Property where the invoice exists.

Element: HotelCode [type ARPaymentType]

Description

Property code.

Element: HotelCode [type FetchARAccountCriteriaType]

Description

Property where the Account exist.

Element: HotelCode [type HotelInterfaceType]

Description

93

Hotel Code

Element: HotelCode [type OperaContextType]

Description

Hotel code.

Element: HotelCode [type TaxTypeType]

Description

Code of the Hotel.

Element: HotelInterface [type ReservationInterfaceStatusType]

Description

Hotel interface information for the reservation

Content Model



1..1

InterfaceId UniqueID_Type 1..1 Unique DB internal number of a Hotel Interface record.

HotelCode CodeType 1..1 Hotel Code

InterfaceName StringLength40 1..1 Name of the Hotel Interface

InterfaceType HotelInterfaceTypeType 1..1 Three letter code for each interface that identifies the interface.

Logo CodeType 1..1 Hotel Interface Logo. On the database, this is also referred as DBF Logo. This is a three letter code followed by an underscore (_). This tells us which DBF files and log files with the prefix that IFC7 is going to create.

MachineName StringLength80 0..1 Unique machine name of the running IFC.

Status HotelInterfaceStatusType 1..1 The current status of the IFC.

Element: HotelInterfaceStatusList [type ReservationInfoType]

Description

Collection of Hotel Interfaces and rights, this is populated only when fetching interface status for rooms.

Content Model



1..1

RoomExtension StringLength20 1..1 Identifier for the room extension

HotelInterface HotelInterfaceType 1..1 Hotel interface information for the reservation

InterfaceRights InterfaceRightsStatusType 0..* Contains a list of status/rights for the various services under this interface

94

Element: Housekeeping [type ReservationInfoType]

Description

Information regarding housekeeping for this reservation.

Attributes


TurndownRequested boolean No Indicates whether guest wants turndown facility or not.

ServiceTime date No This is the Turndown room service time.

ExpectedServiceTime time No Expected Start Time for housekeeping task(s).

RoomStatus HousekeepingRoomStatusType No Current room status. Current room status is populated only if room is assigned to the reservation and reservation is due in or in house.

Content Model



1..1

Instructions string 0..1 Turndown instructions for the room.

FacilityTaskInfo FacilityTaskType 0..1 The facility task applicable for the current day. This will be information only and not used for any updates.


Element: Image [type ParagraphType]

Description

An image for this paragraph.

Element: Indicator [type IndicatorsType]

Attributes


IndicatorName StringLength80 No Name of the indicator.

Count integer No Indicates number of occurrences of the indicator.

Element: Instruction [type FetchARAccountCriteriaType/FetchInstructions]

Enumeration

Value

Account

Aging

FixedCharges

Invoices

Payments

Summary

95

Value

Comments

Traces

Reminder

Statement

Indicators

YearView

Element: Instructions [type HousekeepingTaskCodeType]

Description

Instructions for this Task Code.

Element: Instructions [type ResHousekeepingType]

Description

Turndown instructions for the room.

Element: InterfaceId [type HotelInterfaceType]

Description

Unique DB internal number of a Hotel Interface record.

Attributes








Element: InterfaceName [type HotelInterfaceType]

Description

Name of the Hotel Interface

96

Element: InterfaceRights [type ReservationInterfaceStatusType]

Description

Contains a list of status/rights for the various services under this interface

Content Model



1..1

Right integer 1..1 Internal code for each allowed right of a Hotel Interface record.

StatusCode StringLength5 1..1 User defined code for an Interface Right.

Description StringLength80 0..1 User defined description for an Interface Right.

Category StringLength1 1..1 Category code of this interface right.

Element: InterfaceType [type HotelInterfaceType]

Description

Three letter code for each interface that identifies the interface.

Enumeration

Value

BMS

CAS

CCW

DLS

EFT

EXP

MAK

MBS

MSC

PBX

POS

SVS

TIK

VID

VMS

WWW

XML

Element: Invoice [type ARInvoicesType]

Attributes


TrxNo double Yes Unique Transaction Identifier of the Invoice.

97


TrxDate date No Transaction Date of the invoice.

Status CodeType No Status of the invoice.

TrxCode CodeType No Transaction code of the invoice.

FolioNo double No Folio Number.

InvoiceNo double No Invoice No after the folio is generated. Same invoice number may be referred in multiple folios

FiscalBillNo StringLength40 No The Fiscal Bill number of this posting

FolioTypeName StringLength100 No The name of the Folio Type used for the Folio Number sequence.

InternalFolioWindowID CodeType Yes Internal window ID which is unique to the reservation. This ID can only be used for reference.

FolioDate date Yes Date of Folio Generation.

FolioStatus FolioStatusType No

InvoiceType ARInvoiceCategory No Invoice code of the invoice.

StatementNo integer No Statement number of the invoice.


CloseDate date No Close date of the invoice.


TransferDate date No Transfer date of the invoice.

CanBeModified boolean No Flag to indicate if postings or adjustments can be made to the invoice.

Content Model



1..1

HotelCode CodeType 0..1 Property where the invoice exists.


0..1

GuestProfileId UniqueID_Type 0..1 Guest Profile ID of the invoice.

Age integer 0..1 The Aging age of the invoice

GuestName StringLength200 0..1 Name of the Guest who consumed these transactions.

OriginalAmount CurrencyAmountType 0..1 Original Amount of the Invoice

Amount CurrencyAmountType 0..1 Current Amount of the Invoice.

Payments CurrencyAmountType 0..1 Total Payments made to this Invoice.

Balance CurrencyAmountType 0..1 Amount still open which has not been paid



Adjusted boolean 0..1

ParentInvoiceNo double 0..1

Compressed boolean 0..1

98


CompressedDate date 0..1



Market MarketCodeInfoType 0..1 Invoice market code.

RoomClass RoomClassCodeInfoType 0..1 Invoice room class code.

Source SourceCodeInfoType 0..1 Invoice source code.

ReservationInfo ReservationInfoType 0..1 Reservation guest details.


TrxInfo TrxInfoType 0..1 Transaction information.


AddresseeInfo ProfileInfoType 0..1 Addressee Information for the folio. This is available when the Addressee functionality is used and and Addressee is attached to the folio of the Invoice.

AllowPartialTransferYn boolean 0..1 Flag to check Partial Transfer Allowed.

Printed boolean 0..1 Flag to check Invoice Statement is Printed.

PrintedDate date 0..1 Invoice Statement Printed Date.


StoredFolioID UniqueID_Type 0..1 ID of the Stored Folio.

StoredFolioName StringLength2000 0..1 Name of the Stored Folio.

Element: Invoices [type ARAccountType]

Description

List of all Invoices.

Content Model



1..1

Invoice ARInvoiceType 0..*

Element: Language [type AddressType]

Description

Language code associated with the address

Element: Language [type OperaContextType]

Description

Hotel's language code.

Element: Language [type ResGuestInfoType]

Description

99

Default language

Element: LastName [type ResAccompanyGuestInfoType]

Description

Family name, last name.

Element: LastName [type ResSharedGuestInfoType]

Description


Element: LastPrivacyPromptDate [type ReservationInfoType]

Description

Last Privacy Prompt Date

Element: LastReminderInfo [type ARAccountType]

Attributes


Age integer No The minimum age(days) of the invoices to be included in the Reminder




Content Model



1..1

HistoryExists boolean 0..1 Indicates that reminders history exists.

Element: LastStatementInfo [type ARAccountType]

Attributes





Content Model


100


1..1

StatementNo integer 0..1 When using Statement Numbering, a unique number is associated to the Statement.

HistoryExists boolean 0..1 Indicates that statement history exists.

Element: LastStayDate [type GuestLastStayInfoType]

Description

Guest's last stay date.

Element: LastStayRate [type GuestLastStayInfoType]

Description

The Rate amount of the guest's last stay.

Attributes




Element: LastStayRoom [type GuestLastStayInfoType]

Description

Room Number where the guest stayed.

Element: LinenChange [type HousekeepingTaskCodeType]

Description

Indicates if a linen change is necessary.

Element: LinenChange [type ResHousekeepingType]

Description

Indicates if a linen change is necessary.

Element: LogLevel [type OperaContextType]

Description

Log level to debug the code. such as FINE, FINER etc.

Enumeration

Value

SEVERE

WARNING

INFO

CONFIG

FINE

FINER

101

Value

FINEST

ERROR

MESSAGE

DEBUG

TRACE

Element: Logo [type HotelInterfaceType]

Description

Hotel Interface Logo. On the database, this is also referred as DBF Logo. This is a three letter code followed by an

underscore (_). This tells us which DBF files and log files with the prefix that IFC7 is going to create.

Element: MachineName [type HotelInterfaceType]

Description

Unique machine name of the running IFC.

Element: Market [type ARInvoiceType]

Description

Invoice market code.

Attributes


MarketCode CodeType Yes

HotelCode CodeType Yes

MarketGroup CodeType No

Description StringLength2000 No

Element: MarketCode [type StayInfoType]

Description

Market code

Element: Membership [type ResGuestInfoType]

Description

The Membership object identifying the frequent customer reward program.

Attributes


ProgramCode CodeType No The code or name of the membership program ('Hertz', 'AAdvantage', etc.).

BonusCode CodeType No The code or name of the bonus program. BonusCode can be used to indicate the level of membership (Gold Club, Platinum member, etc.)

MembershipTypeDesc StringLength2000 No The description of the ProgramCode.(Delta Privilege for code DP)

102


MembershipLevelDesc StringLength2000 No The description of the Bonus Code.(Platinum for code P)

AccountID StringLength50 No The account identification number for this particular member in this particular program.

Element: MiddleName [type ResGuestInfoType]

Description

The middle name of the person name

Element: MonthEndCalcYN [type ARAccountType]

Description

Month End Calculation.

Element: Name [type ProfileInfoType]

Description

Name for the profile attached to the block.

Element: Name [type ResAttachedProfileType]

Description

Attached profile name

Element: NamePrefix [type ResGuestInfoType]

Description

Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.)

Element: NameSuffix [type ResGuestInfoType]

Description

Hold various name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.).

Element: NameTitle [type ResGuestInfoType]

Description

Degree or honors (e.g., Ph.D., M.D.)

Element: Nationality [type ResGuestInfoType]

Description

Affiliation or ethnicity to a particular country.

Attributes



Element: NonRevenue [type ResRevenueBalanceType]

Description

103

Total Non Revenue posted on the reservation.

Attributes




Element: NoteInfo [type ARAccountType/Notes]

Description

The Note details attached to the Account.

Content Model



1..1

UniqueID UniqueID_Type 0..1 Comment ID for the comment. It will be empty in case of new comment.

Comment CommentType 0..1 Comment details for the comment. It will be empty in case of delete comment.

Element: Notes [type ARAccountType]

Description

Notes attached to this AR Account.

Content Model



1..1

NoteInfo CommentInfoType 0..* The Note details attached to the Account.

Element: NumberOfRooms [type StayInfoType]

Description

Room Id

Element: OperaContext [type OperaWebServiceRQBaseType]

Description


Content Model



1..1

UserLanguage language 0..1 User's language code.

CROCode CodeType 0..1 Central Reservation office (CRO) code.

104


HotelCode CodeType 0..1 Hotel code.

Language CodeType 0..1 Hotel's language code.

RunningApplication StringLength3 0..1 Running Application. (Not supported)

TerminalId StringLength128 0..1 Terminal ID from where this request originated.

LogLevel LogLevelType 0..1 Log level to debug the code. such as FINE, FINER etc.

ExternalSystem StringLength80 1..1 External system code.

Override boolean 0..1 Opera context is derived internally by request but in case client wants to override the Opera Context it can send true and then the OperaContext will override the above settings such as HotelCode etc.

TargetExternalSystem StringLength80 0..1 This element carries ID of the External System that serves this request. It is needed only while making a call to External WebServices from OPERA UI through integration.

UseLocal boolean 0..1 Determines whether local system should be used and ignore the external system instead.

Element: OriginalAmount [type ARInvoiceType]

Description

Original Amount of the Invoice

Attributes




Element: OtherRevenue [type ResRevenueBalanceType]

Description

Other Revenue generated by the reservation.

Attributes




Element: Override [type OperaContextType]

Description

Opera context is derived internally by request but in case client wants to override the Opera Context it can send

true and then the OperaContext will override the above settings such as HotelCode etc.

105

Element: ParentInvoiceNo [type ARInvoiceType]

Element: PartyCode [type StayInfoType]

Description

Party code

Element: Payment [type ARPaymentsType]

Attributes


TrxNo double Yes Unique Transaction Identifier of the Payment.

TrxDate date No Date of the Payment.

TrxCode CodeType No Transaction code of the Payment.



TransferDate date No Transfer of the invoice.

SequenceNo integer No When this PostingType is used to return the postings generated by a batch request, the sequence number is used to relate to the Request's sequence number.

Content Model



1..1

Age integer 0..1 The Aging age of the payment.

Amount CurrencyAmountType 0..1 Amount of the Payment.

AmountUsed CurrencyAmountType 0..1 Total amount applied against an invoice.

Balance CurrencyAmountType 0..1 Amount still open which has not been applied against any invoice.







HotelCode CodeType 0..1 Property code.

Element: PaymentCard [type ARInvoiceType]

Description

Payment card details.

Attributes

106



CardNumber StringLength80 No

CardNumberMasked StringLength80 No




CardHolderName StringLength200 No



Swiped boolean No


Content Model



1..1




Element: PaymentCard [type ARPaymentType]

Description

Payment card details.

Attributes










107



Swiped boolean No


Content Model



1..1




Element: PaymentCard [type ReservationPaymentMethodType]

Attributes











Swiped boolean No


Content Model


108


1..1




Element: PaymentDueDays [type ARAccountType]

Description

Number of days on which person can make payment.

Element: Payments [type ARAccountType]

Description

List of all Payments made.

Content Model



1..1

Payment ARPaymentType 1..*

Element: Payments [type ARInvoiceType]

Description

Total Payments made to this Invoice.

Attributes




Element: Percent [type AuthorizationRuleType]

Description

A percentage value if the authorization rule is percentage based.

Element: Percent [type FixedChargeDetailType]

Description

Percentage of the rate amount.

Element: PeriodicFolio [type ResCashieringType]

Description

Information regarding periodic folios set on the reservation.

Attributes

109


LastSettlementDate date No Latest date when a direct bill settlement was automatically done using the "Direct Bill Batch Folios" option.

LastFolioDate date No Latest date when a folio was printed using the "Periodic Batch Folios" option

Frequency integer No Frequency in number of days when folios should be printed for this reservation.

Element: Phone [type ProfileInfoType]

Description

Phone for the profile attached to the block.

Element: PhoneNumber [type ResGuestInfoType]

Description

Phone number

Element: Points [type StayInfoType]

Description

The Points contains the number of points used to book a particular room type.

Attributes


AwardsType string No Awards type for the award type rate code.

Points integer No No of points required to book this Room Stay.

Element: PostalCode [type AddressSearchType]

Description

Post Office Code number.

Element: PostalCode [type AddressType]

Description

Post Office Code number.

Element: PostingDate [type ReservationDepositType]

Description

Deposit Posting Date.

Element: PostIt [type ArticleInfoType]

Description

Post it information of the article.

Attributes


AvailableForPostIt boolean No Indicates whether the article is available for post it.

110


Color ColorType No Color indicator which is only configurable if article is available for post it.

Element: Price [type ArticleInfoType]

Description

Default price of the article.

Attributes




Element: PrintAutoAdjust [type TaxTypeType]

Description

Print auto adjust information for this tax type on the tax exempt report.

Element: Printed [type ARInvoiceType]

Description

Flag to check Invoice Statement is Printed.

Element: PrintedDate [type ARInvoiceType]

Description

Invoice Statement Printed Date.

Element: PrintFoliosWithStatement [type ARAccountType]

Description

Indicates if associated folios should be printed by default with the statement.

Element: PriorityDescription [type WaitlistResType]

Description

Waitlist priority Description.

Element: ProfileID [type ProfileInfoType]

Description

Opera ID for the profile attached to the block.

Attributes




111






Element: ProfileID

Attributes








Element: ProfileIDList

Content Model



1..1


112

Element: Quantity [type FacilityCodeType]

Description

Signifies the quantity.

Element: Quantity [type FixedChargeDetailType]

Description

Quantity of the product.

Element: Queue [type ReservationInfoType]

Description

Information about the time and duration this reservation was on Queue for Checkin.

Attributes


Priority integer No The Queue Priority given to this reservation.

AvgQueueTimeToCheckIn integer No The average time, in seconds, a reservation was on queue prior to Check-In.

AvgQueueTimeCurrentReservations integer No The average time, in seconds, of the reservations currently in queue.

QueueDate date No The Business date on which the reservation was due to arrive and is currently placed on Queue for Check In.

Content Model



1..1

TimeSpan TimeSpanType (extension)

1..1 Start and End times on the Queue for the reservation.

Element: RateAmount [type StayInfoType]

Description

Rate amount

Attributes




Element: RatePlanCode [type StayInfoType]

Description

Rate plan code

113

Element: RateSuppressed [type StayInfoType]

Description

Whether this rate should be suppressed from view

Element: ReasonDescription [type WaitlistResType]

Description

Waitlist Reason Description.

Element: Reference [type ARInvoiceType]

Description

User-defined posting reference.

Element: Reference [type ARPaymentType]

Description

User-defined posting reference.

Element: RegistrationCardNo [type ResAccompanyGuestInfoType]

Description

Unique identifier of the police registration card number.

Element: RegistrationCardNo [type ResGuestInfoType]

Description

Unique identifier of the police registration card number.

Element: Remark [type ARInvoiceType]

Description

User-defined posting remark.

Element: Remark [type ARPaymentType]

Description

User-defined posting remark.

Element: ReportExemptDays [type TaxTypeType]

Description

Number of days after which the guest will be tax exempt. Only used for tax exempt report.

Element: ReportTaxPerc [type TaxTypeType]

Description

Tax percentage. Only used for tax exempt report.

Element: ReservationBlock [type StayInfoType]

Description

Key information about the block for this reservation.

114

Attributes


HotelCode CodeType No This is the HotelCode of the Block.

Content Model



1..1

BlockIDList UniqueIDListType (extension)

0..1

BlockName StringLength40 0..1 The Name of the block that is attached to the reservation.

Element: ReservationID

Attributes








Element: ReservationIDList

Content Model



1..1


Element: ReservationIndicators [type ReservationInfoType]

Description

Indicators of additional information attached to the reservation

115

Content Model



1..1


Element: ReservationInfo [type ARInvoiceType]

Description

Reservation guest details.

Attributes


HotelCode CodeType No

HotelName StringLength80 No

RoomStayReservation boolean No Boolean True if this reservation is reserving rooms. False if it is only reserving services.






ResStatus PMS_ResStatusType No Indicates the status of the reservation.

ComputedResStatus PMS_ResStatusType No Indicates the status of the reservation.

WalkInIndicator boolean No When true, indicates the reservation is for a guest that walks-in without a reservation. When false, the reservation is not a walk-in.

AccessRestriction ResAccessRestrictionType No Indicates user restriction on the reservation based on the Access exclusion functionality such as Restriction on Changes, Cancellation or both.

CommissionPayoutTo CommissionPayoutToType No If not null, reservation is considered to pay out commission to either Travel Agent, Source or both.

PaymentMethod CodeType No Payment Method.

PreRegistered boolean No Defines if the reservation is pre-registered or not.

OpenFolio boolean No Returns true when reservation has an open folio.

116


AllowMobileCheckout boolean No Flag containing true or false value for reservation to be eligible for self-checkout by guest using mobile device. Pass the ‘true’ or ‘false’ values when creating / modifying reservation to indicate whether a reservation is eligible for mobile checkout yes / no. Upon fetch, the current state of the flag will show true or false.

AllowMobileViewFolio boolean No Attribute AllowMobileViewFolio is set to true when the reservation is eligible for viewing folio using mobile device.

Content Model



1..1

ReservationIDList UniqueIDListType (extension) 0..1

RoomStay StayInfoType 0..1 Collection of room stays.

ResGuest ResGuestInfoType 0..1 Collection of guests associated with the reservation.

SharedGuests ResSharedGuestListType 0..1 Collection of guests who share this reservation.

AttachedProfiles ResAttachedProfileListType 0..1 List of attached profiles

ReservationPaymentMethod ReservationPaymentMethodType 0..1 Payment method used for this reservation

Specials StringLength4000 0..1 Set of reservation preferences which belongs to the Specials group.

DisplayColor CodeType 0..1 Color setting of the reservation.

ReservationIndicators IndicatorsType 0..1 Indicators of additional information attached to the reservation

RoomStatus HousekeepingRoomStatusType 0..1 Current room status


SourceOfSale SourceOfSaleType 0..1 Point of Sale of reservation. Identifies the entity/channel who made the reservation.

Waitlist WaitlistResType 0..1 Information regarding why reservation has been/was waitlisted. This could hold information as history even if reservation is not in Waitlist status anymore.

Queue ReservationQueueInformationType 0..1 Information about the time and duration this reservation was on Queue for Checkin.

117


Housekeeping ResHousekeepingType 0..1 Information regarding housekeeping for this reservation.

Cashiering ResCashieringType 0..1 Holds cashiering related information for the reservation.

TaxType TaxTypeType 0..1 This stores the code for the type of tax calculation especially with tax exemption, etc.

Deposit ReservationDepositType 0..1 Holds reservation deposit information.

AllowedActions ReservationAllowedActionsType 0..1 Collection of reservation allowed actions.


HotelInterfaceStatusList ReservationInterfaceStatusType 0..* Collection of Hotel Interfaces and rights, this is populated only when fetching interface status for rooms.

GuestPreferredCurrency CodeType 0..1 Currency code preferred by guest.

TurndownInfo ReservationTurndownInfoType 0..1 Currency code preferred by guest.

LastPrivacyPromptDate date 0..1 Last Privacy Prompt Date

Element: ReservationPaymentMethod [type ReservationInfoType]

Description

Payment method used for this reservation

Attributes


PaymentMethod CodeType No


FolioView integer No

Content Model



1..1

PaymentCard ResPaymentCardType 0..1

Balance CurrencyAmountType 0..1

AuthorizationRule AuthorizationRuleType 0..1

EmailFolioInfo EmailInfoType (extension)

0..1 Information element for Email Folio functionality.

118

Element: ResGuest [type ReservationInfoType]

Description

Collection of guests associated with the reservation.

Attributes


NameType NameTypeType No

Content Model



1..1

UniqueID UniqueID_Type 0..1 Unique identifier of this reservation guest

Membership MembershipInfoType 0..1 The Membership object identifying the frequent customer reward program.

NamePrefix NamePrefixType 0..1 Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.)


AltGivenName StringLength40 0..1 Alternate given name, first name or names

MiddleName StringLength40 0..1 The middle name of the person name

SurnamePrefix StringLength20 0..1 e.g "van der", "von", "de"


AltSurname StringLength40 0..1 Alternate family name, last name.

NameSuffix StringLength20 0..1 Hold various name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.).

NameTitle StringLength20 0..1 Degree or honors (e.g., Ph.D., M.D.)

FullName string 0..1 Full display name

AltFullName string 0..1 Altername full display name

PhoneNumber PhoneNumberType 0..1 Phone number

Email BasicEmailType 0..1 Email address

BirthDate date 0..1 Date of birth

Language LanguageType 0..1 Default language

Nationality CountryNameType 0..1 Affiliation or ethnicity to a particular country.

VIP VIPType 0..1 The supplier's ranking of the customer (e.g., VIP, numerical ranking).

Address AddressSearchType 0..1 Address information that is attached to the reservation guest

AccompanyGuests ResAccompanyGuestListType 0..1 List of guest names that are accompanying the reservation guest

119


ExternalInfo ResGuestExternalInfoType 0..1 External information about the guest associated with the reservation.

GuestLastStayInfo GuestLastStayInfoType 0..1 Contains information regarding the last stay of this guest.

GuestRestrictedCode string 1..1 Guest profile restricted reason code

GuestRestrictedReasonDesc string 1..1 Guest profile restricted reason description

GuestRestricted boolean 1..1 True indicates there are restrictions associated with the current profile.


Element: ResolvedBy [type TraceResolveType]

Description

User that resolved the trace

Element: ResolvedOn [type TraceResolveType]

Description

Date the trace was resolved

Element: ResolveInfo [type TraceType]

Description

Information regarding the status of the trace

Content Model



1..1

ResolvedOn date 0..1 Date the trace was resolved

ResolvedBy string 0..1 User that resolved the trace

Element: ResPreConfiguredRoutingInstruction [type ResCashieringType]

Description

Information regarding the selected preconfigured routing instruction on the reservation.

Attributes


RatePlanCode CodeType No This denotes the rateCode attached with the routing instruction of rateCode type.

ProfileType ResProfileTypeType No This stores the profile type attached with the preconfigured routing instruction.

Element: Restriction [type ARAccountStatusType]

Description

120

The Restriction Code added on the Account. This is available when the functionality for adding restriction codes

is ON.

Element: RevenuesAndBalances [type ResCashieringType]

Description

Revenues and Balances Amount summary for the reservation.

Content Model



1..1









Element: RevenuesAndBalances [type ReservationInfoType]

Description

Revenues and Balances Amount summary for the reservation.

Content Model



1..1









Element: Right [type InterfaceRightsStatusType]

Description

Internal code for each allowed right of a Hotel Interface record.

121

Element: RoomClass [type ARInvoiceType]

Description

Invoice room class code.

Attributes


RoomClassCode CodeType Yes



Element: RoomClass [type StayInfoType]

Description

Room class code

Element: RoomExtension [type ReservationInterfaceStatusType]

Description

Identifier for the room extension

Element: RoomNumber [type StayInfoType]

Description

Room Id

Element: RoomRevenue [type ResRevenueBalanceType]

Description

Room Revenue generated by the reservation.

Attributes




Element: RoomStatus [type ReservationInfoType]

Description

Current room status

Enumeration

Value

Clean

Dirty

Pickup

Inspected

Out Of Order

Out Of Service

122

Element: RoomStay [type ReservationInfoType]

Description

Collection of room stays.

Attributes


ScheduledCheckoutTime date No Indicates that this reservation is scheduled for automated check-out.

RoomNumberLocked boolean No When true, indicates a room number cannot be changed. When false, indicates a room number may be changed.

PseudoRoom boolean No True indicates as pseudo room type. This is usually used for a posting master reservation.

Content Model



1..1

TimeSpan TimeSpanType 0..1 The Time Span which covers the Room Stay.

ExpectedTimes ResExpectedTimesType 0..1 The expected arrival and departure times of the guest.

AdultCount integer 0..1 A collection of Guest Counts associated with Room Stay.

ChildCount integer 0..1 A collection of Child Counts associated with Room Stay.

RoomClass CodeType 0..1 Room class code

RoomType CodeType 0..1 Room type code

NumberOfRooms integer 0..1 Room Id

RoomNumber CodeType 0..1 Room Id

RatePlanCode CodeType 0..1 Rate plan code

RateAmount CurrencyAmountType 0..1 Rate amount

Points PointsType 0..1 The Points contains the number of points used to book a particular room type.

RateSuppressed boolean 0..1 Whether this rate should be suppressed from view

ReservationBlock ReservationBlockType 0..1 Key information about the block for this reservation.

BookingChannelCode CodeType 0..1 Booking channel code

PartyCode string 0..1 Party code

123


FixedRate boolean 0..1 True if the rate is a fixed rate, otherwise false

TotalAmount CurrencyAmountType 0..1 The total amount charged for the Room Stay including additional occupant amounts and fees. If TaxInclusive is set to True, then taxes are included in the total amount.

Guarantee ResGuaranteeType 0..1 The guarantee information associated to the Room Stay. A maximum of 5 occurrences are available for use depending on the context.

MarketCode CodeType 0..1 Market code

SourceOfBusiness CodeType 0..1 Source of business

SourceOfBusinessDescription StringLength4000 0..1 Description of the source of business.

Balance CurrencyAmountType 0..1 Balance amount

CompBalance CurrencyAmountType 0..1 Comp Balance amount

RoomTypeCharged CodeType 0..1 Room type code that was charged

DepositPayments CurrencyAmountType 0..1 A collection of deposit and/or payments for the Room Stay.

GuestServiceStatus GuestHousekeepingServiceRequestType 0..1 Service Status of In House guest like DND or MUP

Element: RoomType [type StayInfoType]

Description

Room type code

Element: RoomTypeCharged [type StayInfoType]

Description

Room type code that was charged

Element: RoutingAmount [type RoutingLimitType]

Description

Amount to route for a routing code

Element: RoutingCovers [type RoutingLimitType]

Description

124

Covers to route for a routing code

Element: RoutingLimit [type TrxInfoType]

Description

Routing Limit Details

Content Model



1..1

RoutingAmount double 0..1 Amount to route for a routing code

RoutingPercent double 0..1 Percentage to route for a routing code

RoutingCovers double 0..1 Covers to route for a routing code

Element: RoutingPercent [type RoutingLimitType]

Description

Percentage to route for a routing code

Element: RunningApplication [type OperaContextType]

Description

Running Application. (Not supported)

Element: RunningTotal [type ARYearViewType]

Description

The running total balance for the date range.

Attributes




Element: Schedule [type FixedChargeType]

Description

Holds schedule of fixed charge.

Attributes




Frequency FixedChargeFrequencyType No Frequency of a fixed charge.

DayToExecute StringLength3 No Day of when to execute fixed charge. Applicable when frequency is Daily or Weekly.

125


DateToExecute date No Date of when to execute yearly fixed charge. Applicable when frequency is Yearly.

Element: SearchMatch [type SearchMatchesType]

Attributes


Attribute StringLength2000 No Search match attribute.

Value StringLength2000 No Search match value.

Element: SearchMatches [type ARAccountType]

Description

Super Search matching terms.

Content Model



1..1


Element: SearchMatches [type ReservationInfoType]

Description

Super Search matching terms.

Content Model



1..1


Element: SharedGuest [type ResSharedGuestListType]

Content Model



1..1


0..1




Element: SharedGuests [type ReservationInfoType]

Description

Collection of guests who share this reservation.

126

Content Model



1..1

SharedGuest ResSharedGuestInfoType 0..*

Element: Source [type ARInvoiceType]

Description

Invoice source code.

Attributes


SourceCode CodeType Yes


SourceGroup CodeType No


Element: SourceOfBusiness [type StayInfoType]

Description

Source of business

Element: SourceOfBusinessDescription [type StayInfoType]

Description

Description of the source of business.

Element: SourceOfSale [type ReservationInfoType]

Description

Point of Sale of reservation. Identifies the entity/channel who made the reservation.

Attributes


SourceType StringLength40 No Type of entity/channel who made the reservation.

SourceCode CodeType No The entity/channel who made the reservation.

Element: Specials [type ReservationInfoType]

Description

Set of reservation preferences which belongs to the Specials group.

Element: StartDate [type TimeSpanType]

Element: StartDateTime [type DateTimeSpanType]

Element: State [type AddressSearchType]

Description

127

State or Province name (e.g., Texas).

Element: State [type AddressType]

Description

State or Province name (e.g., Texas).

Element: StatementNo [type ARStatementHistoryType]

Description

When using Statement Numbering, a unique number is associated to the Statement.

Element: Status [type ARAccountType]

Description

The status of the account.

Attributes


Restricted boolean No Flag to indicate if the Account is restricted.

Content Model



1..1

Restriction CodeType 0..1 The Restriction Code added on the Account. This is available when the functionality for adding restriction codes is ON.

Description StringLength2000 0..1 User defined status message on the Account.

Element: Status [type HotelInterfaceType]

Description

The current status of the IFC.

Enumeration

Value

STOPPED

RUNNING

WAITING

STOP INITIATED

START INITIATED

REBOOT INITIATED

OTHER

Element: Status [type ReservationTurndownInfoType]

Description

Indicates turndown status, values could be required, not required, completed

128

Enumeration

Value

Required

Not Required

Completed

Element: StatusCode [type InterfaceRightsStatusType]

Description

User defined code for an Interface Right.

Element: StoredFolioID [type ARInvoiceType]

Description

ID of the Stored Folio.

Attributes








Element: StoredFolioName [type ARInvoiceType]

Description

Name of the Stored Folio.

Element: StreetAddress [type AddressSearchType]

Description

First Line of Street Address. For profile search it matches the first Address line.

Element: Success [type OperaWebServiceRSBaseType]

Description

129


Element: Summary [type ARAccountType]

Description

The Summary Information of the Invoices for the Account.

Content Model



1..1




Element: Supplement [type FixedChargeDetailType]

Description

Additional information regarding the fixed charge.

Element: Supplies [type FacilityTaskType]

Description

Supplies associated with the task.

Content Model



1..1

FacilityCode FacilityCodeType 0..*

Element: Surname [type ResGuestExternalInfoType]

Description


Element: Surname [type ResGuestInfoType]

Description


Element: SurnamePrefix [type ResGuestInfoType]

Description

e.g "van der", "von", "de"

Element: TargetExternalSystem [type OperaContextType]

Description

130

This element carries ID of the External System that serves this request. It is needed only while making a call to

External WebServices from OPERA UI through integration.

Element: Task [type FacilityTaskType]

Description

The Task Code.

Attributes


HotelCode CodeType No Property where this task code is configured.

Code CodeType No The Code for the task.

Sequence integer No Ordering sequence for display.

Content Model



1..1

Description StringLength80 0..1 Description of the Task Code.

Instructions StringLength2000 0..1 Instructions for this Task Code.

FacilityDepartureTask boolean 0..1 Indicates if this task code is the default departure task for Facility Tasks. This requires


Element: TaxType [type ResCashieringType]

Description

This stores the code for the type of tax calculation especially with tax exemption, etc.

Attributes


TaxExemptNo StringLength20 No Tax exempt number on the profile.

Content Model



1..1








131

Element: TaxType [type ReservationInfoType]

Description

This stores the code for the type of tax calculation especially with tax exemption, etc.

Content Model



1..1








Element: Telephone [type TelephoneInfoType]

Description

Phone details for the profile.

Attributes


PhoneTechType CodeType No Indicates type of technology associated with this telephone number, such as Voice, Data, Fax, Pager, Mobile, TTY, etc. Refer to OpenTravel Code List Phone Technology Type (PTT).

PhoneUseType CodeType No Describes the type of telephone number, in the context of its general use (e.g. Home, Business, Emergency Contact, Travel Arranger, Day, Evening). Refer to OpenTravel Code List Phone Use Type (PUT).

PhoneUseTypeDescription StringLength2000 No Description of the PhoneUseType code

PhoneNumber StringLength40 Yes Telephone number assigned to a single location.

Extension StringLength20 No Extension to reach a specific party at the phone number.



Element: TelephoneInfo [type ARAccountType/Telephones]

Description

The Telephone and Fax details attached to the Account.

Content Model

132



1..1

UniqueID UniqueID_Type 0..1 Unique id for the phone.

Telephone TelephoneType 0..1 Phone details for the profile.

Element: Telephones [type ARAccountType]

Description

Telephone and Fax information which is attached to this AR Account.

Content Model



1..1

TelephoneInfo TelephoneInfoType 0..* The Telephone and Fax details attached to the Account.

Element: TerminalId [type OperaContextType]

Description

Terminal ID from where this request originated.

Element: Text [type ParagraphType]

Description

Formatted text content.

Attributes


Formatted boolean No Textual information, which may be formatted as a line of information, or unformatted, as a paragraph of text.


TextFormat NMTOKEN (restriction)

No Indicates the format of text used in the description e.g. unformatted or html.

Element: TimeInfo [type TraceType]

Description

Date of the trace.

Content Model



1..1

DateTimeSpan DateTimeSpanType 0..1 Time span for the trace.

TraceOn dateTime 0..1 Date of the trace.

TraceTime StringLength20 0..1 Time of the trace

133


EnteredBy string 0..1 User that entered this trace.

Element: TimeSpan [type ReservationQueueInformationType]

Description

Start and End times on the Queue for the reservation.

Attributes


DurationInSeconds integer No The total duration, in seconds, the reservation is on Queue.

Content Model



1..1

StartDate date 0..1

1..1


EndDate date 0..1

Element: TimeSpan [type StayInfoType]

Description

The Time Span which covers the Room Stay.

Content Model



1..1

StartDate date 0..1

1..1


EndDate date 0..1

Element: Total [type ARBalanceType]

Description

The total balance i.e Debit minus Credit amounts.

Attributes




134

Element: TotalAmount [type StayInfoType]

Description

The total amount charged for the Room Stay including additional occupant amounts and fees. If TaxInclusive is

set to True, then taxes are included in the total amount.

Attributes




Element: TotalFixedCharge [type ResRevenueBalanceType]

Description

Total Fixed Charges on the reservation.

Attributes




Element: TotalOutstanding [type ARAgingInfoType]

Description

The total debit and credit balance of the account.

Content Model



1..1




Element: TotalOutstanding [type ARYearViewInfoType]

Description

The total debit and credit balance of the account.

Content Model



1..1


135




Element: TotalPayment [type ResRevenueBalanceType]

Description

Total payment received for the reservation.

Attributes




Element: TotalRevenue [type ResRevenueBalanceType]

Description

Total Revenue generated by the reservation.

Attributes




Element: TotalStay [type GuestLastStayInfoType]

Description

The total number of previous stay of the guest.

Element: TraceInfo [type ARAccountType/Traces]

Description

The Trace details attached to the Account.

Attributes





136










Content Model



1..1

TimeInfo TraceTimeInfoType 0..1 Date of the trace.


0..1

DepartmentID CodeType 0..1 Indicates the Department code.

TraceText string 0..1 The information this trace contains.

ResolveInfo TraceResolveType 0..1 Information regarding the status of the trace

Element: TraceOn [type TraceTimeInfoType]

Description

Date of the trace.

Element: Traces [type ARAccountType]

Description

Traces attached to this AR Account.

Content Model



1..1

TraceInfo TraceType 0..* The Trace details attached to the Account.

Element: TraceText [type TraceType]

Description

137

The information this trace contains.

Element: TraceTime [type TraceTimeInfoType]

Description

Time of the trace

Element: Transaction [type FixedChargeDetailType]

Description

Transaction code and description of a fixed charge.

Attributes




Element: TransactionCode [type ArticleInfoType]

Description

Transaction code to which the article belongs.

Element: TransferredIn [type ARInvoiceType]

Element: TransferredIn [type ARPaymentType]

Element: TransferredOut [type ARInvoiceType]

Element: TransferredOut [type ARPaymentType]

Element: TrxGroup [type TrxInfoType]

Description

Category of the transaction code.

Element: TrxInfo [type ARInvoiceType]

Description

Transaction information.

Attributes


TrxCode CodeType No Unique identifier for the Transaction code.

HotelCode CodeType No Hotel context of the Transaction code.

PrintTrxReceipt boolean No Print receipt flag that tells whether the transaction receipt is to be printed or not. This is based on the transaction code.

Content Model


138


1..1

Description StringLength2000 0..1 Transaction codes info.

TrxGroup StringLength20 0..1 Category of the transaction code.

TrxSubGroup StringLength20 0..1 Sub category of the transaction code.

UniversalProductCode CodeType 0..1 Unique Universal product code of the transaction code.

Articles anyType (restriction) 0..1 The List of Articles defined for this transaction code, when using the Articles functionality.

RoutingLimit RoutingLimitType 0..1 Routing Limit Details

Element: TrxSubGroup [type TrxInfoType]

Description

Sub category of the transaction code.

Element: TurndownInfo [type ReservationInfoType]

Description

Currency code preferred by guest.

Content Model



1..1

Allowed boolean 0..1 Indicates if turndown is allowed or not

Status TurndownStatusType 0..1 Indicates turndown status, values could be required, not required, completed

Element: UniqueID [type AddressInfoType]

Description

Address id for the address.

Attributes





139





Element: UniqueID [type CommentInfoType]

Description

Comment ID for the comment. It will be empty in case of new comment.

Attributes








Element: UniqueID [type EmailInfoType]

Description

Unique id for the email.

Attributes




140






Element: UniqueID [type ResGuestInfoType]

Description

Unique identifier of this reservation guest

Attributes








Element: UniqueID [type TelephoneInfoType]

Description

Unique id for the phone.

Attributes



141







Element: UniqueID [type UniqueIDListType]

Description

Unique Id that references an object uniquely in the system.

Attributes








Element: UniversalProductCode [type ArticleInfoType]

Description

Unique Universal product code of the article.

142

Element: UniversalProductCode [type TrxInfoType]

Description

Unique Universal product code of the transaction code.

Element: URL [type ParagraphType]

Description

A URL for this paragraph.

Element: UseLocal [type OperaContextType]

Description

Determines whether local system should be used and ignore the external system instead.

Element: UserLanguage [type OperaContextType]

Description

User's language code.

Element: VIP [type ResGuestInfoType]

Description

The supplier's ranking of the customer (e.g., VIP, numerical ranking).

Attributes


VIPCode CodeType No VIP Code.

VIPDescription StringLength80 No VIP Description.

Element: Waitlist [type ReservationInfoType]

Description

Information regarding why reservation has been/was waitlisted. This could hold information as history even if

reservation is not in Waitlist status anymore.

Attributes


ReasonCode CodeType No Waitlist Reason Code.

PriorityCode CodeType No Waitlist Priority Code.

Telephone StringLength40 No Guest telephone number.

Content Model



1..1

ReasonDescription StringLength2000 0..1 Waitlist Reason Description.

PriorityDescription StringLength2000 0..1 Waitlist priority Description.

Description StringLength2000 0..1 Description why the reservation is being /has been waitlisted.

143

Element: Warning [type WarningsType]

Description

Used in conjunction with the Success

element to define a business error.

Attributes


Type CodeType Yes 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". Refer to OpenTravel Code List Error Warning Type (EWT).







RPH RPH_Type No Reference Place Holder used as an index for this warning.

Element: Warnings [type OperaWebServiceRSBaseType]

Description


144

Content Model



1..1

Warning WarningType 0..* Used in conjunction with the Success element to define a business error.

Element: YearView [type ARYearViewInfoType]

Description

The debit and credit balance per account.

Content Model



1..1

DateRange DateRangeType 0..1 The period start and end date.

BalanceInfo ARBalanceType 0..1 The balance amounts for this date range. Contains the Debit Balance, Credit Balance and the Total Balance.

RunningTotal CurrencyAmountType 0..1 The running total balance for the date range.

Element: YearViewInfo [type ARAccountType]

Description

The Year View balance information for this account.

Content Model



1..1


YearView ARYearViewType 0..* The debit and credit balance per account.

opera cloud web self-service - docs.oracle.com · this software or hardware is developed for...

Documents