_Reservation element outbound

@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
• 27 - Associated shared reservation, ID of other reservation, the room is shared with (only OnPrem)

@ID

1

ID is the internal confirmation number.

@ID_Context

0..1

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

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

pAir:

Clean: 0 | Checked: 6 | Touched: 4 | Dirty: 1 | Cleaning: 5 | Out of service: 2

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

@ExpireDate

0..1

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

@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

1

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

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

@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 booking is part of a block, the block ID is transferred in this field.

@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

0..1

Indicates the starting date

@ExpireDate

0..1

Indicates the ending date.

yyyy-mm-dd

onprem:

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

@RateTimeUnit

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

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"

@CurrencyCode

1

Currency codes 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

1

The total amount includes 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

1

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

@Start

0..1

Indicates the starting date

@End

0..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 includes 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

This 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

@End

1

Departure date

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

• "CC/ DC/Voucher"

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 does not include any associated tax (e.g., sales tax, VAT, GST or any associated tax).

@AmountAfterTax

1

The total amount includes 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 includes all associated taxes (e.g., sales tax, VAT, GST or any associated tax).

@AmountBefore Tax

1

The total amount does not include 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 guests, 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

1

HTML versus Plain Text.

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

• charge
• refund
• reserve
  

Payment card type.

@ResID_Type

1

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

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

@ForGuest

0..1

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

This number should be searchable by the destination.

"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 

Indicates the number of RateTimeUnits that the rate package amount is based upon. 

@ID

0..1

Internal ID

@RPH

0..1

Numeric value referencing the PMS reservation number.

@Type

0..1

String value indicating "CommunicationChannel" or "TravelReason"

@Name

0..1

Values taken from the hotel PMS and used to reference the booking communication method and reason for travel (one instance of the ReservationCode element for each respectively)

@Language

0..1

The language code for which the name data is represented.

OnPremise:

pAir:

Protel Cloud is not using these Codes, Protel Cloud display the configured ShortName of the Reservation Status. This can be different per Hotel. 

• true
• false