Seitenhistorie

Element | Attribute	Type	Num	Description +  Content	Comments outbound	pAir	OnPrem
HotelReservation		1	Must be sent for the message to have a meaning.
@CreatorID	StringLength1to32	1	The user or the office that originated the reservation.
@CreateDateTime	dateTime	1	This is the date when the reservation was first made.
@LastModifyDateTime	dateTime	0..1	This indicates the last date and time when the reservation was modified. MANDATORY if the ResStatus is “Modify”.
@LastModifierID	StringLength1to32	0..1	This indicates the last user who modified the reservation.
@ResStatus	PMS_ResStatusType	1	Indicates the current status of the reservation	Reserved – definitive reservations (‚standard‘ status) and optional reservations (deductive) Requested – optional reservations (non-deductive) Waitlisted – reservations on waiting list (non-deductive) Cancelled – cancelled reservations No-show – no-show reservations In-house – checked-in reservations Checked out – checked-out reservation		HTML <a href="https://confluence.protel.net/display/PIODOC/PMS_ResStatusType" target="_blank">PMS_ResStatusType</a>
@RoomNumberLockedIndicator	boolean	0..1	An indicator that shows whether the room number may be changed.	"true" → The room number may not be changed.  "false" → The room number may be changed.
HotelReservation | UniqueID		1	The unique ID depends on the system generating the booking; i.e., if the booking is generated by the PMS this field would contain the PMS confirmation number; if the system is a CRS, the CRS confirmation number.
@Type	OTA_CodeType UIT	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)	HTML <a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810178" target="_blank">Unique ID Type (UIT)</a>
@ID	StringLength1to32	1	ID is the internal confirmation number.
@ID_Context	StringLength1to32	0..1	Used to identify where the ID comes from. “protelIO”	“protelIO”
HotelReservation | RoomStays		1	A collection of RoomStay objects. Room stays associated with this reservation.
HotelReservation | RoomStays | RoomStay		1	Only one instance of RoomStay is allowed.
@MarketCode	StringLength1to64	0..1	This is the abbreviation of the market segment being sold and may be needed by the system for tracking purposes.
@SourceOfBusiness	StringLength1to64	0..1	Used to specify where the business came from; e.g., radio, newspaper ad, or it could be a referring property.
@PromotionCode	StringLength1to32	0..1	A promotion code indicating a specific marketing campaign. Not to be confused with the rate code.
HotelReservation | RoomStays | RoomStay | RoomTypes		0..1	A collection of Room Types associated with a particular Room Stay.
HotelReservation | RoomStays | RoomStay | RoomTypes | RoomType		1..n	Section could be repeated if there is a room move during the stay.
@IsRoom	boolean	1	Indicates the room is a sleeping room when true. If false it is a pseudo room reservation.	"true" "false"
@RoomType	StringLength1to16	0..1	Internal room type ID in PMS system.
@RoomTypeCode	StringLength1to64	1	Abbreviated room type.
@RoomID	StringLength1to64	0..1	Room number when allocated.
@NumberOfUnits	integer	1	The number of booked rooms.
HotelReservation | RoomStays | RoomStay | RoomTypes | RoomType | TPA_Extensions | px:RoomStatusExtensions | px:HouseKeepingInfo
@RoomStatus	StringLength1to32	1	For reservations that will arrive on the business day, the status of the room (clean, dirty, etc.) will be sent with.	pAir: Clean: 0 | Checked: 6 | Touched: 4 | Dirty: 1 | Cleaning: 5 | Out of service: 2
HotelReservation | RoomStays | RoomStay | RatePlans		0..1	0..1	The RatePlans element is not required but can be sent to give further details on the rates booked in this reservation.
HotelReservation | RoomStays | RoomStay | RatePlans | RatePlan		1	The RatePlan to be booked. This can repeat if multiple rate codes are booked against the reservation
@RatePlanCode	StringLength1to64	1	This is the code of the rate booked.
@RatePlanID	StringLength1to64	0..1	Internal ID of the rate code booked
@EffectiveDate	date	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	date	0..1	The Expire date indicates the day when the specific value of the rate is changed to another value.	yyyy-mm-dd
@MarketCode	StringLength1to64	0..1	The code that relates to the market being sold to (e.g., the corporate market, packages).
@PriceViewableInd	boolean	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.
HotelReservation | RoomStays | RoomStay | RatePlans/ RatePlan | Guarantee		0..5	Guarantee provided with the reservation.
@GuaranteeType	StringLength1to32	1	This is the attribute that indicates what guarantee is provided with the reservation.	"CC/ DC/Voucher"
@GuaranteeCode	StringLength1to32	0..1	This is the guarantee code. More specified than @GuaranteeType.	Example: "CC"
HotelReservation | RoomStays | RoomStay | RatePlans | RatePlan | Guarantee | GuaranteeDescription		0..1	Optional. This can be used to pass the details of the guarantee if the guarantee used is not cc or deposit.
@Name	StringLength1to64	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.
HotelReservation | RoomStays | RoomStay | RatePlans | RatePlan | Guarantee | GuaranteeDescription | Text		0..1	Provides text and indicates whether it is formatted or not.	Example: "Credit Card."
@TextFormat	PlainText	0..1	Indicates the format of text used in the description (unformatted or HTML).
HotelReservation | RoomStays | RoomStay | RatePlans/ RatePlan | CancelPenalties		0..5	A collection of cancellation penalty elements
HotelReservation | RoomStays | RoomStay | RatePlans | RatePlan | CancelPenalties | CancelPenalty			Defines the hotel cancellation penalty. The CancelPenalty class defines the cancellation policy of the hotel.
@PolicyCode	StringLength1to16	0..1	This is the penalty code.	Example: "48HRS"
HotelReservation | RoomStays | RoomStay | RatePlans | RatePlan | CancelPenalties | CancelPenalty | PenaltyDescription		0..1	Optional. This can be used to pass additional cancellation policy details.
@Name	StringLength1to64	0..1	Policy Class used in conjunction with the Text element below.
HotelReservation | RoomStays | RoomStay | RatePlans | RatePlan | CancelPenalties | CancelPenalty | PenaltyDescription | Text		0..1	Provides text and indicates whether it is formatted or not.	Example: "Free cancellation 48hrs before arrival"
@TextFormat	PlainText	0..1	Indicates the format of text used in the description.
HotelReservation |RoomStays | RoomStay | RatePlans | RatePlan | RatePlanInclusions		1	Defines charges that are included in this rate plan.
@TaxInclusive	boolean	1	Boolean value. Defines if the rate sent is tax inclusive or not.	"true" - AmountAfterTax "false" - AmountBeforeTax "true" - AmountAfterTax and AmountBeforeTax
HotelReservation | RoomStays | RoomStay | RatePlans | RatePlan | Commission		0..1	Commission associated with the RatePlan. This can be a percentage or a flat amount.
@StatusType	NMTOKEN	1	Indicates the status of the commission payment itself (e.g. no-show indicates that a different commission may be applied if the reservation is not fulfilled).
@Percent	Pecentage	1	The percent applied to the commissionable amount to determine the commission payable amount.
@BillToID	StringLength1to8	1	Identifies who should be billed for the commission amount.
@Frequency	OTA_CodeType CHG	1	This is the frequency at which the commission is applied (e.g. per stay, daily). Refer to OpenTravel Code List Charge Type (CHG).	HTML <a href="https://confluence.protel.net/pages/viewpage.action?pageId=117819921" target="_blank">Charge Type (CHG)</a>
@MaxCommissionUnitApplies	integer	0..1	Maximum The maximum number of units for which the commission will be applied. This may be used in conjunction with the frequency attribute.
@CapAmount	Money	0..1	The highest monetary value that may be paid for the commission.
@CurrencyCode	AlphaLength3	1	An ISO 4217 (3) alpha character code that specifies a monetary unit.
HotelReservation | RoomStays | RoomStay | RatePlans | RatePlan | Commission | UniqueID		0..1	Identifies the recipient of the commission. An identifier is 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).
@Type	OTA_CodeType UIT	0..1	A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT).	HTML <a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810178" target="_blank">Unique ID Type (UIT)</a>
@ID_Context	StringLength1to32	0..1	Used to identify the source of the identifier (e.g., IATA, ABTA).
@ID	StringLength1to32	0..1	A unique identifying value is 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.
HotelReservation | RoomStays | RoomStay | RatePlans | RatePlan | Commission | UniqueID | CompanyName		0..1	Identifies the company that is associated with the UniqueID.Identifies a company by name.
@Division	StringLength1to32	0..1	The division name or ID with which the contact is associated.
@Department	StringLength1to32	0..1	The department name or ID with which the contact is associated.
@CompanyShortName	StringLength1to32	0..1	Used to provide the company common name.
@Code	StringLength1to16	0..1	Identifies a company by the company code.
@CodeContext	StringLength1to32	0..1	Identifies the context of the identifying code, such as DUNS, IATA, or internal code, etc.
HotelReservation | RoomStays | RoomStay | RatePlans | RatePlan | Commission | CommissionableAmount		0..1	The amount on which commission is calculated.
@TaxInclusiveIndicator	boolean	1	When true, indicates that the commission is calculated using the rate including tax. When false, indicates that the commission is calculated using the net rate.
@Amount	Money	1	A monetary amount.
@CurrencyCode	AlphaLength3	0..1	An ISO 4217 (3) alpha character code that specifies a monetary unit.
@DecimalPlaces	integer	0..1	The ISO 4217 standard "minor unit" for the number of decimal places for a particular currency.
HotelReservation | RoomStays | RoomStay | RatePlans | RatePlan | Commission | PrepaidAmount		0..1	The amount of commission paid to the agency prior to the service being rendered.
@Amount	Money	0..1	A monetary amount.
@CurrencyCode	AlphaLength3	0..1	An ISO 4217 (3) alpha character code that specifies a monetary unit.
@DecimalPlaces	integer	0..1	The ISO 4217 standard "minor unit" for the number of decimal places for a particular currency.
HotelReservation | RoomStays | RoomStay | RatePlans | RatePlan | Commission | FlatCommission		0..1	A fixed commission amount.
@Amount	Money	0..1	A monetary amount.
@CurrencyCode	AlphaLength3	0..1	An ISO 4217 (3) alpha character code that specifies a monetary unit.
@DecimalPlaces	integer	0..1	The ISO 4217 standard "minor unit" for the number of decimal places for a particular currency.
HotelReservation | RoomStays | RoomStay | RatePlans | RatePlan | Commission | CommissionPayableAmount		0..1	The amount of commission to be paid.
@Amount	Money	0..1	A monetary amount.
@CurrencyCode	AlphaLength3	0..1	An ISO 4217 (3) alpha character code that specifies a monetary unit.
@DecimalPlaces	integer	0..1	The ISO 4217 standard "minor unit" for the number of decimal places for a particular currency.
HotelReservation | RoomStays | RoomStay | RatePlans | RatePlan | Commission | Comment		0..1	Text related to the commission.An indication of a new paragraph for a sub-section of a formatted text message.
@Name	StringLength1to64	0..1	In many cases the description repeats, this will allow you to define the information that is being sent, typically used when multiple occurrences of ParagraphType are being sent.
@ParagraphNumber	integer	0..1	The sequence number for the paragraph.
@Language	language	0..1	Language identification.
@CreatorID	StringLength1to32	0..1	ID of the creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.
@LastModifierID	StringLength1to32	0..1	Identifies the last software system or person to modify a record.
@CreateDateTime	dateTime	0..1	Date Time of the Creation
HotelReservation | RoomStays | RoomStay | RoomRates		1	A collection of Room Rates associated with a particular Room Stay. Each Room Rate combination can have multiple rates. Example King room, Rack rate plan, Monday through Thursday, weekday amount, Friday and Saturday, weekend amount.
HotelReservation | RoomStays | RoomStay | RoomRates | RoomRate		1..n	One instance of RoomRate per room/rate/period booked. If more than one Rate plan can be booked in one reservation the entire RoomRate element must be repeated for each Room/rate combination. In addition, all RoomRate elements MUST share the same RoomTypeCode.
@RoomTypeCode	StringLength1to64	1	This is the abbreviation for the room type booked.
@RoomID	StringLength1to64	0..1	Room No. (if already allocated) for the mentioned period.
@InvBlockCode	StringLength1to32	0..1	If the room booked booking is part of a block, the block ID is transferred in this field.
@NumberOfUnits	integer	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	StringLength1to64	1	This is the rate booked for the room type code listed in the RoomTypeCode attribute.
@RatePlanID	StringLength1to64	0..1	Internal ID of the rate code booked
@BookingCode	StringLength1to16	0..1	This is used to indicate the item booked and is primarily used to exchange information with GDSs. This filed field also can be used to display the initially booked room type in case of changing RoomType or reservation move.
@EffectiveDate	date	0..1	Indicates the starting date	yyyy-mm-dd
@ExpireDate	date	0..1	Indicates the ending date.	yyyy-mm-dd
@RatePlanCategory	StringLength1to64	0..1	Hotel systems often group multiple rate plans into a single category. This refers to that category that is specific to the hotel CRS/ PMS and should not be confused with a GDS rate category.
HotelReservations | HotelReservation | RoomStays | RoomStay |	1..n	BookingRules | BookingRule		0..1	Provides booking rule information for the room stay.				HotelReservation | RoomStays | RoomStay | RoomRates | RoomRate | Rates | Rate	1..n	At least one instance of Rate per Rate plan. Multiple instances of the Rate element must be sent if rate changes apply to the booking.			@RateTimeUnit	TimeUnitType	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). For protel only ‘Day’ is possible.			@EffectiveDate	date	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. yyyy-mm-dd			@ExpireDate	date	1	The Expire date indicates the day when the specific value of the rate is changed to another value. yyyy-mm-dd			@UnitMultiplier	integer	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.
@AbsoluteCutoff	date	0..1	Defines the absolute deadline. Either this or the offset attributes may be used.	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
HotelReservation | RoomStays | RoomStay | RoomRates | RoomRate | Rates		1..n	Individual rate amount. This rate is valid for a range of the number of occupants and an occupant type.
HotelReservation | RoomStays | RoomStay | RoomRates | RoomRate | Rates | Rate		1..n	At least one instance of Rate per Rate plan. Multiple instances of the Rate element must be sent if rate changes apply to the booking.
@RateTimeUnit	TimeUnitType	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).	For protel only ‘Day’ is possible.
@EffectiveDate	date	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.	yyyy-mm-dd
@ExpireDate	date	1	The Expire date indicates the day when the specific value of the rate is changed to another value.	yyyy-mm-dd
@UnitMultiplier	integer	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.
@AlternateCurrencyInd	boolean	0...1	When true, indicates the amounts are provided in an alternate currency. When false, indicates the amounts are provided in the primary currency. This may be used to indicate that the currency provided is different from the requested or stored currency.	"true" "false"	@AlternateCurrencyInd	boolean	0...1	When true, indicates the amounts are provided in an alternate currency. When false, indicates the amounts are provided in the primary currency. This may be used to indicate that the currency provided is different from the requested or stored currency. "true" "false"			HotelReservation | RoomStays | RoomStay | RoomRates | RoomRate | Rates | Rate | Base	1	Information on the Base Rate.			@CurrencyCode	AlphaLength3	1	Currency code used ISO 4217 codes to indicate the currency of the rate that is being booked.			@AmountBeforeTax	Money	0..1	The total amount not including any associated tax (e.g., sales tax, VAT, GST or any associated tax).			@AmountAfterTax	Money	1	The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax).
HotelReservation | RoomStays | RoomStay | RoomRates | RoomRate | Rates | Rate | TotalBase		0..1	Information on the Total Amount for the certain period of time if it contains more than one nightBase Rate.
@CurrencyCode	AlphaLength3	1	Currency codes used ISO 4217 codes to indicate the currency of the rate that is being booked.
@AmountBeforeTax	Money	0..1	The total amount not including any associated tax (e.g., sales tax, VAT, GST or any associated tax).
@AmountAfterTax	Money	1	The total amount including includes all associated taxes (e.g., sales tax, VAT, GST or any associated tax).
HotelReservation | RoomStays | RoomStay | RoomRates | RoomRate | Rates | Rate | TPA_Extensions | px:RateAmountExtensionsTotal		0..1	Allows extensions to be added to the Open Travel Alliance specification per trading partner agreementInformation on the Total Amount for the certain period of time if it contains more than one night.
@Start@CurrencyCode	AlphaLength3	0..1	Indicates the starting date yyyy-mm-dd			@End	date	0..1	Indicates the ending date. yyyy-mm-dd			HotelReservation | RoomStays | RoomStay | RoomRates | RoomRate | Rates | Rate | TPA_Extensions | px:RateAmountExtensions | RateAmount	0..1	ISO 4217 codes to indicate the currency of the rate that is being booked.
@AmountBeforeTax	Money	0..1	The total amount not including any associated tax (e.g., sales tax, VAT, GST or any associated tax).
@AmountAfterTax	Money	1	The total amount including includes all associated taxes (e.g., sales tax, VAT, GST or any associated tax).				@RevenueCategoryCode	OTA_CodeType RCC	1	Code value from OpenTravel Alliance Code List Revenue Category Code (RCC).

<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117820190" target="_blank">Revenue Category Code (RCC)</a>

@CurrencyCode

1

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

HotelReservation | RoomStays | RoomStay | RoomRates | RoomRate | Rates | Rate | TPA_

Extensions | px:

RateAmountExtensions

onPremise will only display these elements for reservations which are check-in or in the future. For check-out reservations onPremise will not display any amount in the element.

Allows extensions to be added to the Open Travel Alliance specification per trading partner agreement.

@Start

0..1

Indicates the starting date

@End

0..1

"true"

"false"

Indicates the ending date.

HotelReservation | RoomStays | RoomStay | RoomRates | RoomRate | Rates | Rate | TPA_Extensions | px:

RateAmountExtensions |

RateAmount

@AmountAfterTax@AmountBeforeTax

0..1

The total amount not including

any associated

tax (e.g., sales tax, VAT, GST or any associated tax).

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

<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117820190" target="_blank">Revenue Category Code (RCC)</a>

@CurrencyCode

1

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

onPremise will only display these elements for reservations which are check-in or in the future by default. For check-out reservations it needs to be enabled for onPremise.

In this element only manual booked fixed charges are displayed

.

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

• "true"
• "false"

Contains the type and number of guests included in the reservation.

1. If a AQC is part of the message pAir will evalute against the AQC
2. If the AQC is missing pAir will evalute against the Age
3. If both are missing, pAir treats GuestCounts as Adult

@AmountAfterTax

@AmountBefore Tax

@AgeQualifyingCode

@RevenueCategoryCode

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

<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810269117820190" target="_blank">Age>Revenue QualifyingCategory Code (AQCRCC)</a>

@Count@CurrencyCode

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

Contains the type and number of guests included in the reservation.

1. If a AQC is part of the message pAir will evaluate against the AQC
2. If the AQC is missing pAir will evaluate against the Age
3. If both are missing, pAir treats GuestCounts as Adult

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

@AgeQualifyingCode

<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810269" target="_blank">Age Qualifying Code (AQC)</a>

@Count

HotelReservation | RoomStays | RoomStay | GuestCounts

1

Contains the guest counts of the booking.

@IsPerRoom

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

• "true"
• "false"

Contains the type and number of guests included in the reservation.

@AgeQualifyingCode

1

AgeQualifyingCode = 10 (Adult)

<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810269" target="_blank">Age Qualifying Code (AQC)</a>

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

HotelReservation | RoomStays | RoomStay | GuestCounts

1

Contains the guest counts of the booking.

@IsPerRoom

0..1

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

• "true"
• "false"

HotelReservation | RoomStays | RoomStay | GuestCounts | GuestCount

1..n

Contains the type and number of guests included in the reservation.

@AgeQualifyingCode

1

AgeQualifyingCode = 10 (Adult)

<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810269" target="_blank">Age Qualifying Code (AQC)</a>

@Count

1

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

HotelReservation | RoomStays | RoomStay | TimeSpan

1

These are the in and out dates of the booking.

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

<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117820627" target="_blank">Card Type (CDT)</a>

@Count

1

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

These are the in and out dates of the booking.

@Start

1

Arrival date
yyyy-mm-dd

@End

1

Departure date
yyyy-mm-dd

Provides text and indicates whether it is formatted or not.

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

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

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

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

Indicates the format of text used in the description.

HotelReservation | RoomStays | RoomStay |

Total

0..1

This is the total amount for the stay.

@CurrencyCode

1

Payment card type.

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

<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117820627" target="_blank">Card Type (CDT)</a>

HotelReservation | RoomStays | RoomStay |

TPA_Extension | px:RateAmountExtensions

0..1

@Start

1

Indicates the starting date

@End

1

Indicates the ending date.

Provides text and indicates whether it is formatted or not.
Example: "Credit Card."

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

• "true"
• "false"

HotelReservation | RoomStays | RoomStay

| TPA_Extensions | px:RateAmountExtensions | px:RateAmount

0..

This is the penalty code.
Example: "48HRS"

1

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

<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117820190" target="_blank">Revenue Category Code (RCC)</a>

@CurrencyCode

1

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

onPremise will only display these elements for which are check-in or in the future. For check-out reservations, onPremise will not display any amount in the element.

In this element, only manually booked fixed charges are displayed.

Indicates the format of text used in the description.

HotelReservation | RoomStays | RoomStay | Total

0..1

• "true"
• "false"

@AmountBeforeTax

@AmountAfterTax

@AmountAfterTax@AmountBefore Tax

@RevenueCategoryCode

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

<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117820190" target="_blank">Revenue Category Code (RCC)</a>

@CurrencyCode

HotelReservation | RoomStays | RoomStay | ResGuestRPHs

1

A collection of unsigned integers serving as reference placeholders, and used as an index identifying which guests occupy this room

HotelReservation | RoomStays | RoomStay | TPA_Extension | px:RateAmountExtensionsResGuestRPHs | ResGuestRPH

10..1

@Start

1

Indicates the starting date
yyyy-mm-dd

@End

1

Indicates the ending date.
yyyy-mm-dd

"true"

"false"

n

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.

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

HotelReservation | RoomStays | RoomStay | TPA_Extensions | px:RateAmountExtensions | px:RateAmountComments | Comment

1

Comment details.

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

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

<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117820190" target="_blank">Revenue Category Code (RCC)</a>

HotelReservation | RoomStays | RoomStay | Comments | Comment | Text

1

Comments.

@TextFormat

1

HTML versus Plain Text.

@CurrencyCode

1

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

onPremise will only display these elements for which are check-in or in the future. For check-out reservations onPremise will not display any amount in the element.

In this element only manual booked fixed charges are displayed.

"true"

"false"

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

@AmountAfterTax

@AmountBefore Tax

@RevenueCategoryCode

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

<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117820190" target="_blank">Revenue Category Code (RCC)</a>

@CurrencyCode

A collection of unsigned integers serving as reference placeholders, and used as an index identifying which guests occupy this room

HotelReservation | RoomStays | RoomStay | ResGuestRPHs | ResGuestRPH

1..n

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.

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

• charge
• refund
• reserve
  

Payment card type.

<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117820627" target="_blank">Card Type (CDT)</a>

1

Comment details.

@GuestViewable

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.

HotelReservation | ResGlobalInfo | HotelReservationIDs | HotelReservationID

1..n

The HotelReservationID element can be repeated multiple types to transfer:

1. The PNR number for the reservation assigned by the GDS.

2. The reservation number for reservations that are linked to this reservation as associated reservation either for guests travelling together, sharing a room or as part of an Itinerary.

@ResID_Type

1

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

<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810178" target="_blank">Unique ID Type (UIT)</a>

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

pAir: is displaying the Services for mandatory packages and bookable packages.

onPrem: is displaying mandatory packages and bookable packages, but only for check-in Reservations and future Reservation - for checked-out Reservation, it can be enabled

onPrem: is displaying Rentable Objects in the service element with the name rentable object

• true
• false

HotelReservation | RoomStays | RoomStay | Comments | Comment | Text

1

Comments.

@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

<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117820627117810178" target="_blank">Card>Unique ID Type (CDTUIT)</a>

HotelReservation | ResGlobalInfo | HotelReservationIDs | HotelReservationID

1..n

The HotelReservationID element can be repeated multiple types to transfer:

1. The PNR number for the reservation assigned by the GDS.

2. The reservation number for reservations that are linked to this reservation as associated reservation either for guests travelling together, sharing a room, or as part of an Itinerary.

@ResID_Type

1

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

<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810178" target="_blank">Unique ID Type (UIT)</a>

@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 used to determine if the ResID_Value is given to a guest.

This number should be searchable by the destination.

"true"

"false"

pAir: is displaying the Services for mandatory packages and bookable packages.

onPrem: is displaying mandatory packages and bookable packages, but only for check-in Reservations and future Reservation - for checked-out Reservation it can be enabled

onPrem: is displaying Rentable Objects in the service element with the name rentable object

• true
• false

<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810178" target="_blank">Unique ID Type (UIT)</a>

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. 

pAir:

• Per person per night
• Per stay

OnPrem:

• Per stay

If the @ServicePricingType equals "Per person per night" the value of @EffectiveDate will be the first Start Posting 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 

HotelReservation | TPA_Extensions

0..1

HotelReservation | TPA_Extensions | px:ReservationExtensions

1

HotelReservation | TPA_Extensions | px:ReservationExtensions | px:ReservationCode

0..

n

Passes information pertaining to booking communication channel and reason for travel.

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

HotelReservation | TPA_Extensions

0..1

HotelReservation | TPA_Extensions | px:ReservationExtensions

1

HotelReservation | TPA_Extensions | px:ReservationExtensions | px:ReservationCode

0..n

Passes information pertaining to booking communication channel and reason for travel.

@ID

@Type

@Name

Code

Bezeich

Code

OTA_HotelResNotifRQ | HotelReservations | HotelReservation | Status

Reserved

Reserved

Cancelled

No-Show

Requested

Waitlisted

In-house

Checked out

<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810178" target="_blank">Unique ID Type (UIT)</a>

<a href="https://confluence.protel.net/display/PIODOC/IO+Types#IOTypes-RecurrenceType" target="_blank">RecurrenceType</a>

• true
• false

<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810178" target="_blank">Unique ID Type (UIT)</a>