Core Object: RatePlan (1.0.0)

Library: HospitalityStrawman (http://www.opentravel.org/Sandbox/product/hospitality/v1)

• Dictionary
• Where-Used
• Errors & Warnings

Property	Value
Simple Facet:	Empty
Facets	Summary  Detail

Summary

Field Name	Member Type	Field Type	Description
bookingCode	Attribute	StringTiny	This is used to indicate the item booked and is primarily used to exchange information with GDSs.
ratePlanCode	Attribute	StringTiny	The RatePlanCode assigned by the receiving system for the inventory item in response to a new rate plan notification. (Implementation Notes: This would only be returned when the notification is of type New and the sender is translating RatePlanCode values. On subsequent transactions for this rate plan, the sender would populate the RatePlanCode attribute with this value returned by the receiver.)
rateIndicator	Attribute	RateIndicator_Enum	Information pertaining to the availability of the rate plan.
ratePlanType	Attribute	RatePlanType_Enum	An enumerated type that allows the query to specify a rate category type, and provides major categories for comparison across brands. Refer to OpenTravel Code List Rate Plan Type (RPT).
ratePlanID	Attribute	StringShort	A text field used to provide a special ID code that is associated with the rate and is required in the reservation request in order to obtain the rate. Examples are a corporate ID number, a promotion code or a membership number.
ratePlanName	Attribute	StringShort	Provides the name of the rate plan or group. Typically used with RatePlanType to further describe the rate plan.
marketCode	Attribute	StringShort	The code that relates to the market being sold to (e.g., the corporate market, packages).
availabilityStatus	Attribute	RateIndicator_Enum	Used to specify an availability status for the rate plan.
qualificationType	Attribute	OTA_Code	Indicates the type of document required by the guest to qualify for this rate plan. Refer to OpenTravel Code List Document Type (DOC).
availableQuantity	Attribute	NonNegativeInteger	Provides the number of rooms available within this rate plan.
Guarantee	Element	Guarantee	Guarantee information that applies to the rate plan. A maximum of 5 occurances are available for use depending on the context.
CancelPolicies	Element	CancelPolicies	Collection of cancellation penalties.
Description	Element	Description	Describes the rate plan.
RatePlanInclusions	Element	RatePlanInclusions	Defines charges that are included in this rate plan.This element allows for future extension should there be a need.
Commission	Element	Commission	Commission associated with the RatePlan. This can be a percentage or a flat amount.
MealsIncluded	Element	MealsIncluded	Defines which meals are included with this rate program.
RateRestrictionStatus	Element	RoomRateRestrictionStatus	Used to indicate whether the rate is on request or available.
AdditionalDetails	Element	AdditionalDetails	Additional information related to a rate plan.
ModificationFee	Element	ModificationFee	A collection of modification fees. Note that although this modification fee is typed as CancelPenaltiesType to promote reuse, cancellation penalties information should be entered in the CancelPenalties element.
EffectiveExpireDate	Element	DateEffectiveExpire	Effective expirer date for thsi rate plan.
BookingRule	Element	BookingRule	Specifies the booking rules for this rate plan.
iD_RequiredInd	Indicator		When true, indicates proof of qualification for this rate is required.
priceViewableInd	Indicator		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.
prepaidIndicatorInd	Indicator		When true, indicates if the rate is a prepaid rate.

Detail