@EchoToken 

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

1

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

@TimeStamp 

1

Timestamp of the transaction. 

@Version 

0..1

Version of the message.

Version="1.001"

@PrimaryLangID

0..1

Default language of the property.

@ResStatus

1

Transaction Type

• “Commit” = new reservations

• “Modify” = changes to existing reservations

• “Cancel“ = Void of an existing reservation

• “Initiate” = new reservations in Bulk Upload

• “Commit” = new reservations

• “Modify” = changes to existing reservations

• “Cancel“ = Void of an existing reservation

@Type 

1

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

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

• true 
• false

@Type

1

Indicates the type of booking channel per the Open Travel BCT codes. 

@FiscalDate

0..1

This attribute transfers the actual date of the PMS system.

yyyy-mm-dd

@CreatorID

1

The user or the office that originated the reservation.

@CreateDateTime

1

This is the date when the reservation was first made.

@LastModifyDateTime

0..1

This indicates the last date and time when the reservation was modified. MANDATORY if the ResStatus is “Modify”.

@LastModifierID

0..1

This indicates the last user who modified the reservation.

@ResStatus

1

Indicates the current status of the reservation

"true" → The room number may not be changed. 

"false" → The room number may be changed. 

@Type

1

Defines the type of Reservation ID (e.g. reservation number, cancellation number). Refer to OTA Code List Unique ID Type (UIT).

• 14 - Reservation, ID of reservation
• 36 - Group ID 
• 27 - Associated shared reservation, ID of other reservation, the room is shared with (only OnPrem)

The recommended value for this message is "14" (Reservation).

@ID

1

ID is the internal confirmation number.

@ID_Context

0..1

Used to identify where the ID comes from.
“protelIO”

It is highly recommended that each @ID reference has a respective @ID_Context to enable unique ownership of the @ID. 

For modification/cancellation the “protelIO” reference with the respective @ID is required.

@MarketCode

0..1

This is the abbreviation of the market segment being sold and may be needed by the system for tracking purposes.

@SourceOfBusiness

0..1

Used to specify where the business came from; e.g., radio, newspaper ad, or it could be a referring property.

@PromotionCode

0..1

A promotion code indicating a specific marketing campaign. Not to be confused with the rate code.

@IsRoom

1

Indicates the room is a sleeping room when true. If false it is a pseudo room reservation. 

• "true"
• "false"

@RoomType

0..1

Internal room type ID in PMS system.

@RoomTypeCode

1

Abbreviated room type.

@RoomID

0..1

Room number when allocated.

@NumberOfUnits

1

The number of booked rooms.

@RatePlanCode

1

This is the code of the rate booked.

@RatePlanID

0..1

Internal ID of the rate code booked

@EffectiveDate

0..1

The Effective date attribute indicates when the specific rate value is applied. This is required reference at those times when there is a rate change during the stay.
yyyy-mm-dd

@ExpireDate

0..1

The Expire date indicates the day when the specific value of the rate is changed to another value.
yyyy-mm-dd

@MarketCode

0..1

The code that relates to the market being sold to (e.g., the corporate market, packages).

@PriceViewableInd

0..1

When true, the price for this rate plan can be viewed by the guest. When false, the guest must contact another entity to obtain price information.

@GuaranteeType

1

This is the attribute that indicates what guarantee is provided with the reservation.

• "CC/ DC/Voucher"

@GuaranteeCode

0..1

This is the guarantee code. More specified than @GuaranteeType.

Example: "CC"

@Name

0..1

Used in conjunction with Text element below. The name could be used to indicate Voucher and the Text could be used to indicate the voucher number, for instance.

@TextFormat

0..1

Indicates the format of text used in the description (unformatted or HTML).

@PolicyCode

0..1

This is the penalty code.

@Name

0..1

Policy Class used in conjunction with the Text element below.

@TextFormat

0..1

Indicates the format of text used in the description.

@TaxInclusive

0..1

Boolean value. Defines if the rate sent is tax inclusive or not.

• "true" - AmountAfterTax
• "false" - AmountBeforeTax
• "true" - AmountAfterTax and AmountBeforeTax

protel On-Premise default = "False" (will send AmountBeforeTax values only). This can be changed.

protel Air default = "true" (will send AmountAfterTax values only)

@RoomTypeCode

1

This is the abbreviation for the room type booked.

@RoomID

0..1

Room No. (if already allocated) for the mentioned period.

@InvBlockCode

0..1

If the room booked is part of a block, the block ID is transferred in this field.

Receiving an inbound reservation with @InvBlockCode = "" will delete and remove the assigned allotment.

@NumberOfUnits

1

This is the number of rooms booked for the room type code listed in the RoomTypeCode attribute.

In the case of shared reservations, this value will always be "1".

@RatePlanCode

1

This is the rate booked for the room type code listed in the RoomTypeCode attribute.

@RatePlanID

0..1

Internal ID of the rate code booked

@BookingCode

0..1

This is used to indicate the item booked and is primarily used to exchange information with GDSs.

This field also can be used to display the initially booked room type in case of changing RoomType or reservation move.

@EffectiveDate

1

Indicates the starting date

@ExpireDate

1

Indicates the ending date.

yyyy-mm-dd

onprem:

• it is possible to set a Option Date, which is later then the Arrival Date  → we will display the Option Date as well
• it is possible to set a Option Date, even if the Reservation Status is not optional → we will display the Option date as well for all Reservationsstatus

@RateTimeUnit

0..1

Rate Time unit is an Enumeration of time units upon which the rate amount is based (e.g., daily, weekly, single rate for full stay).

@EffectiveDate

1

The Effective date attribute indicates the starting date of when the specific rate value is applied.

This is needed when during the stay there are some rate changes.

@ExpireDate

1

The Expire date indicates the day when the specific value of the rate is changed to another value.

@UnitMultiplier

0..1

UnitMultiplier is the number of RateTimeUnits that the rate amount is based upon (e.g., the rate for one day in case of nightly rates). As protel is dealing with days as a unit it should display the number of nights. If it is set to zero the reservation will be a day-use room for the specific date.

• "true"
• "false"

When "true", then the rates will not be overwritten in the PMS. 

When "false", then the rates are calculated from the PMS system data.

• "true"
• "false"

@CurrencyCode

1

Currency code used ISO 4217 codes to indicate the currency of the rate that is being booked.

@AmountBeforeTax

0..1

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

@AmountAfterTax

0..1

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

@CurrencyCode

1

ISO 4217 codes to indicate the currency of the rate that is being booked.

@AmountBeforeTax

0..1

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

@AmountAfterTax

0..1

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

@Start

1

Indicates the starting date

@End

1

Indicates the ending date.

@AmountBeforeTax

0..1

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

@AmountAfterTax

1

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

@RevenueCategoryCode

1

Code value from OpenTravel Alliance Code List Revenue Category Code (RCC). 

@CurrencyCode

1

Currency code used ISO 4217 codes to indicate the currency of the rate that is being booked

• "true"
• "false"

@AmountAfterTax

@AmountBefore Tax

@RevenueCategoryCode

Code value from OpenTravel Alliance Code List Revenue Category Code (RCC). 

@CurrencyCode

Indicates that the guest count provided is on a per room basis.

@AgeQualifyingCode

@Count

• Name="MarketCode"
• Name="SourceOfBusiness"

@IsPerRoom

0..1

Indicates that the guest count provided is on a per room basis.

• "true"
• "false"

@AgeQualifyingCode

1

AgeQualifyingCode = 10 (Adult)

@Count

1

The count will include the number and will be repeated for each Type of guest.

@Start

1

Arrival date/time.

yyyy-mm-dd

IDS:

the "Thh:mm" will be used for the Arrival Time

@End

1

Departure date/time.

yyyy-mm-dd

IDS:

the Thh:mm will be used for the Departure Time

This is the attribute that indicates what guarantee is provided with the reservation.

• "CC/ DC/Voucher"

• "CC/ DC/Voucher"

Not supported:

• "GuaranteeRequired"

• "None"

• "Profile"

• "Deposit"

• "PrePay"

This is the guarantee code. More specified than @GuaranteeType .

Payment card type.

Indicates the format of text used in the description (unformatted or HTML).

This is the penalty code.

Indicates the format of text used in the description.

@CurrencyCode

1

ISO 4217 codes to indicate the currency of the rate that is being booked.

@AmountBeforeTax

0..1

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

@AmountAfterTax

0..1

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

@Start

1

Indicates the starting date

@End

1

Indicates the ending date.

• "true"
• "false"

@AmountAfterTax

1

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

@AmountBefore Tax

1

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

@RevenueCategoryCode

Code value from OpenTravel Alliance Code List Revenue Category Code (RCC). 

@CurrencyCode

1

Currency code used ISO 4217 codes to indicate the currency of the rate that is being booked

• "true"
• "false"

@AmountAfterTax

@AmountBefore Tax

@RevenueCategoryCode

Code value from OpenTravel Alliance Code List Revenue Category Code (RCC). 

@CurrencyCode

@RPH

1

Used to refer to the guest associated with this reservation.

If profiles for guest, travel agency and company are available in the message, they would all have a separate entry per profile type.

@GuestViewable

0..1

This indicates that the comment can actually be seen by the guest and is necessary when two different types of comments are passed: one that is guest viewable and one that isn’t. The Attribute is of Boolean nature.

@TextFormat

0..1

HTML versus Plain Text.

This is the attribute that indicates what guarantee is provided with the reservation.

• "CC/ DC/Voucher"

Not supported:

• "GuaranteeRequired"

• "None"

• "Profile"

• "Deposit"

• "PrePay"

This is the guarantee code. More specified than @GuaranteeType .

• AcceptedPaymentForms - "Used to define the acceptable payment forms of the property"

Used to specify how the amount needs to be applied with respect to the stay

• FirstNightDeposit ="Amount to be applied as a deposit for the first night."
• FirstNightPayment "Amount to be applied as payment for the first night."

FirstNightDeposit =

• charge
• refund
• reserve
  

charge
refund
reserve

Payment card type.

@ResGuestRPH

0..1

This is a reference placeholder, used as an index for this guest in this reservation. In the ResGuest object it is used like all other RPH attributes to send the delta of a reservation. It is used by the RoomStay and Service objects to indicate which guests are associated with that room stay or service.

@PrimaryIndicator

0..1

This indicates the primary guest on a reservation. In the case of multiple guests on a reservation, the guest responsible for payment, etc. will be marked true. Currently Optional but needs to be Mandatory to support passing of multiple guests on a reservation (Additional Profile).

(MANDATORY for incoming messages to pAir!)

• "true"
• "false"

Note:

This means default message ResGuest@PrimaryInd set to true is saying "this booker is a guest as well" and ResGuest@PrimaryInd set to false says the booker (first ResGuest element) is not an arriving guest.

"true"

"false"

pAir: will always display the time in UTC Time

ArrivalTime="12:00:00+02:00"

onprem: will always display the time in local Time

 ArrivalTime="14:05:00"

pAir: will always display the time in UTC Time

ArrivalTime="12:00:00+02:00"

onprem: will always display the time in local Time

 ArrivalTime="14:05:00"

pAir: will always display the time in UTC Time

DepartureTime="12:00:00+02:00"

onprem: will always display the time in local Time

DepartureTime="18:05:00"

pAir: will always display the time in UTC Time

DepartureTime="12:00:00+02:00"

onprem: will always display the time in local Time

DepartureTime="18:05:00"

Define the Role of the ResGuest

• Res booker = Role "Booker" 
• Res guest profile = "ArrivingGuest" (main guest = PrimaryInd true)
• Res linked profile = "LinkedProfile"
• 2nd guest and booker = "BookerAndArrivingGuest"

• Res booker = Role "Booker" 
• Res guest profile = "ArrivingGuest" (main guest = PrimaryInd true)
• Res linked profile = "LinkedProfile"

This indicates the primary guest on a reservation. In the case of multiple guests on a reservation, the guest responsible for payment, etc. will be marked true. Currently Optional but needs to be Mandatory to support passing of multiple guests on a reservation (Additional Profile).

• "true"
• "false"

0..1

OnPrem:

1 = All calls
2 = Nat. calls
3 = Local calls
4 = Incoming calls

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

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"

"io.protel.onpremise"

"io.protel.air"

@ResID_Type

1

Defines the type of Reservation ID (e.g. reservation number, cancellation number). Refer to OTA Code List Unique ID Type (UIT).

• 14 - Reservation, ID of reservation
• Shared reservation are not supported inbound

@ResID_Value

1

Internal reservation number in hotel property management system (PMS).

@ResID_Source

0..1

A unique identifier to indicate the source system which generated the ResID_Value.

"protelIO"

It is highly recommended that each @ResID_Value reference has a respective @ResID_Source to enable unique ownership of the @ResID_Value. 

For modification/cancellation the “protelIO” reference with the respective @ResID_Value is required.

@ForGuest

0..1

A boolean value used to determine if the ResID_Value is given to a guest.

This number should be searchable by the destination.

"true"

"false"

"true"

"false"

If it is "true" then this is the main guest. 

If it is "false" then this is a sharer reservation 

• true

• false

• true
• false

• true
• false

pAir:

• Per person per night
• Per stay

OnPrem:

• Per stay

• true
• false

If the @ServicePricingType equals "Per person per night" the value of @EffectiveDate will be the first Start Posting Date

if the @ServicePricingType equals "Per Stay" the value of @EffectiveDate will be the Arrival Date 

If the @ServicePricingType equals "Per person per night" the value of @EffectiveDate will be the latest Start Posting Date

if the @ServicePricingType equals "Per Stay" the value of @EffectiveDate will be the Departure Date