@EchoToken

0..1

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.

@CorrelationID

Used to match result messages (*RS) to request messages (*RQ) in asynchronous communication patterns. Therefore mandatory.

@TimeStamp

dateTime

1

Indicates the creation date and time of the message in UTC using the format specified by ISO 8601 with time values using the 24-hour clock

(e.g., 20 November 2003, 1:59:38 pm UTC becomes 2003-11-20T13:59:38Z).

YYYY-MM-DDThh:mm:ssZ

@Version

decimal

0..1

For all OpenTravel versioned messages, the version of the message is indicated by a decimal value.

@PrimaryLangID

language

0..1

The default language of the property

ISO-639-1 (2-char code)

@ID

StringLength1to32

1

A unique identifying value assigned by the creating system. In the context of protel IO, this will be the unique hotel ID where the profile was created.

@Type

OTA_CodeType UIT

1

A numeric reference to the type of object defined by the unique ID attribute. Refer to the OTA code lists Unique ID Type (UIT)

@ID_Context

StringLength1to32

1

Used to identify the source of the identifier. For both outbound (from protelIO) and inbound (to protelIO) request messages, this must carry the string value

“protelIO”

@Primary

boolean

0..1

Indicates whether the enumerated booking channel is the primary means of connectivity used by the source.

• "true" 

• "false"

@Type

OTA_CodeType BCT

1

The type of booking channel. Refer to the OTA code lists Booking Channel Type (BCT).

@ID

StringLength1to32

1

A unique identify 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.

@ID_Context

StringLength1to32

1

Used to identify where the ID comes from.

"protelIO"

@Type

OTA_CodeType UIT

1

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

@GuestPayable

0..1

When true, the Guest may provide payment for the folio. When false, the Guest may not provide payment for the folio.

@FolioID

0..1

Unique identifier of a given folio.

on prem:
Combination of ResID and FolioID as a reservation could have sevaral FolioID's open.

pAir: internal FolioID 

@InvoiceID

0..1

Unique identifier of a given invoice.
As long as there is no invoice no. assigned it is set to "0".

@FolioGroupingID

0..1

Indicator for the status of an invoice

If it is "closed" no further booking is possible

If it is "open" further booking is possible even if a InvoiceID is existing

@FolioType

0..1

An enumeration of the following values: Group, Corporate, Wholesaler, Comp Accounting, Guest, Package, Other.

possible Values:

• "Room"
• "Guest"
• "Corporate"
• "Group"
• "Wholesaler"
• "TravelAgency"
• "Incidental"

@ChainCode

StringLength1to8

0..1

The code that identifies a hotel chain or management group. The hotel chain code is decided between vendors.

@HotelCode

StringLength1to16

0..1

The code that uniquely identifies a single hotel property. 

@HotelCodeContext

StringLength1to32

0..1

A text field used to communicate the context.

"protelIO"

@HotelName

StringLength1to128

0..1

A text field used to communicate the proper name of the hotel.

@ID

1

The ID will transfer the HotelID and needs to be agreed by the trading partners and remain the same throughout the messages.

@ID_Context

1

Used to identify where the ID comes from.

@Type

1

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

The travel sector the company is associated with, such as air, car and hotel. Refer to OpenTravel Code List Travel Sector (TVS). 

• "io.protel.onpremise"
• "io.protel.air"

@ID

1

The ID will transfer the HotelID and needs to be agreed by the trading partners and remain the same throughout the messages.

@ID_Context

1

Used to identify where the ID comes from.

@Type

1

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

The travel sector the company is associated with, such as air, car and hotel. Refer to OpenTravel Code List Travel Sector (TVS). 

• "io.protel.onpremise"
• "io.protel.air"

Unknown("Unknown"),
Batch("Batch"),
BatchForecast("BatchForecast"),
Revenue("Revenue"),
RevenueForecast("RevenueForecast"),
Payment("Payment"),
Void("Void"),
VoidBatch("VoidBatch"),
Deposit("Deposit"),
Allowance("Allowance"),
Tax("Tax"),
TaxForecast("TaxForecast")

@AmountBeforeTax

0..1

The unit amount not including any associated tax (e.g.; sales tax, VAT, GST or any associated tax).

@AmountAfterTax

0..1

The unit amount including all associated taxes (e.g.; sales tax, VAT, GST or any associated tax).

@Type

0..1

Used to indicate if the amount is inclusive or exclusive of other charges, such as taxes, or is cumulative (amounts have been added to each other).

@Percent

0..1

Fee percentage; if zero, assume use of the Amount attribute (Amount or Percent must be a zero value).

Sample:

Percent="7.00"

@Amount

1

A monetary amount.

@AmountBeforeTax

0..1

The unit amount not including any associated tax (e.g.; sales tax, VAT, GST or any associated tax).

@AmountAfterTax

0..1

The unit amount including all associated taxes (e.g.; sales tax, VAT, GST or any associated tax).

@Quantity

0..1

The number of items purchased.

@Type

0..1

Used to indicate if the amount is inclusive or exclusive of other charges, such as taxes, or is cumulative (amounts have been added to each other).

• Inclusive
• Exclusive

@Percent

0..1

Fee percentage; if zero, assume use of the Amount attribute (Amount or Percent must be a zero value).

Sample:

Percent="7.00"

@Amount

1

A monetary amount.

@Type

0..1

Used to indicate if the amount is inclusive or exclusive of other charges, such as taxes, or is cumulative (amounts have been added to each other).

• Inclusive
• Exclusive

@Percent

0..1

Fee percentage; if zero, assume use of the Amount attribute (Amount or Percent must be a zero value).

@Amount

1

A monetary amount.

@AmountBeforeTax

0..1

The unit amount not including any associated tax (e.g.; sales tax, VAT, GST or any associated tax).

@AmountAfterTax

0..1

The unit amount including all associated taxes (e.g.; sales tax, VAT, GST or any associated tax).

@Quantity

0..1

The number of items purchased.

@Type

0..1

Used to indicate if the amount is inclusive or exclusive of other charges, such as taxes, or is cumulative (amounts have been added to each other).

@Percent

0..1

Fee percentage; if zero, assume use of the Amount attribute (Amount or Percent must be a zero value).

@Amount

1

A monetary amount.

• Create an entry
  CREATE
• Modify an entry
  UPDATE
• Delete an entry
  DELETE
• Cancel an entry
  CANCEL
• void an entry
  VOID
• Checkin a Reservation
  CHECKIN
• Checkout a Reservation
  CHECKOUT
• Room move of a Reservation
  ROOMMOVE
• End of day 
  ENDOFDAY or UPDATE

• false: Default
• true: If more than 10000 items in Folio

• true
• false

Earliest Item Booking date in folio (CBD, when IncrementalItemsInd = true)

Latest Item Booking Date in Folio

@EchoToken

0..1

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.

@CorrelationID

Used to match result messages (*RS) to request messages (*RQ) in asynchronous communication patterns. Therefore mandatory.

@TimeStamp

dateTime

1

Indicates the creation date and time of the message in UTC using the format specified by ISO 8601 with time values using the 24-hour clock

(e.g., 20 November 2003, 1:59:38 pm UTC becomes 2003-11-20T13:59:38Z).

YYYY-MM-DDThh:mm:ssZ

@Version

decimal

0..1

For all OpenTravel versioned messages, the version of the message is indicated by a decimal value.

@PrimaryLangID

language

0..1

The default language of the property

ISO-639-1 (2-char code)

@Type 

OTA_CodeType

1

Mandatory. Refer to the OTA Code List: Error Warning Type (EWT).

@Code 

OTA_CodeType

0..1 

Refers to the OTA Code List: Error Codes (ERR). 

@RecordID 

StringLength1to64

0..1 

If the receiving system is able to identify within a batch of availability status messages which specific message failed, the UniqueID of the message should be reported here. 

@ShortText

StringLength1to64

0..1

Describes the occurring error in short.Example: "A rate plan 'XY' was not found for the code provided."

@Type 

OTA_CodeType

1

Mandatory. Refer to the OTA Code List: Error Warning Type (EWT).

@Code 

OTA_CodeType

0..1 

Refers to the OTA Code List: Error Codes (ERR). 

@RecordID 

StringLength1to64

0..1 

If the receiving system is able to identify within a batch of availability status messages which specific message failed, the UniqueID of the message should be reported here. 

@ShortText

StringLength1to64

0..1

Describes the occurring error in short.Example: "A rate plan 'XY' was not found for the code provided."