# Upload (PMS -> SM) ## What is Reservations Upload (PMS -> SM)? **Reservations Upload (PMS -> SM)** is a delivery method where the Property Management System (PMS) actively pushes reservations, modifications, and cancellations to the SiteMinder Ecosystem. This includes all PMS reservations—walk-ins, historic OTA bookings, and direct bookings—which are sent to SiteMinder's web service endpoint in real-time. {% hint style="warning" %} To implement **Reservations Upload**, the PMS must certify for [Reservations PUSH](https://developer.siteminder.com/siteminder-apis/pms-rms/introduction/pmsxchange/api-reference/reservations/reservations-push) or [Reservations PULL](https://developer.siteminder.com/siteminder-apis/pms-rms/introduction/pmsxchange/api-reference/reservations/reservations-pull). {% endhint %} ## Integration Requirements Understand the essential requirements for API integration, including connectivity, authentication, message formats, and security protocols.

Category	Requirement
Web Service Endpoint	SiteMinder will provide a single global endpoint for all hotels for PMS to send push requests `OTA_HotelResNotifRQ` and receive confirmation responses `OTA_ResRetrieveRS`. Test Environment Endpoint: https://tpi-pmsx.preprod.siteminderlabs.com/webservices/{RequestorID}
Authentication	SiteMinder will provide a single username/password for all hotels (PMS Level authentication). PMS must include authentication credentials within the SOAP Security header of each `OTA_HotelResNotifRQ`.
Message Structure	All messages must adhere to the SOAP message format. OTA message must be encapsulated within the SOAP Body. Requests must include a SOAP Security Header for authentication. Responses must be returned in a SOAP envelope with empty SOAP Header.
Content-Type	`text/xml; charset=utf-8`
Version	`SOAP 1.1`
Protocol & Security	All communication must occur over HTTPS using TLS 1.2 or higher. Non-secure (HTTP) connections are not permitted. Communication is synchronous request/response pairs. Each message is atomic - processed entirely or not at all. SiteMinder sends requests over port 443.

## Message Exchange Flow When reservations are created, modified, or canceled outside of SiteMinder's distribution network, your PMS delivers them to the SiteMinder Platform using a synchronous SOAP/HTTPS exchange. This ensures SiteMinder maintains a complete view of property inventory across all booking sources. 1. **Reservation Message (PMS to SiteMinder):** `OTA_HotelResNotifRQ`\ Delivers a single reservation message (new booking, modification, or cancellation). 2. **Confirmation Response (SiteMinder to PMS):** `OTA_HotelResNotifRS`\ Confirms successful receipt or reports processing failure. ## Security Header The Security Header is a mandatory SOAP header that authenticates every reservation request from your PMS to SiteMinder endpoint. It contains the username and password credentials that we provide to the PMS during integration setup. **Key Requirements:** * **Validation**: Our endpoint will validate these credentials on every request. * **Scope**: One set of credentials is used for all properties in your integration. * **Security**: Credentials are transmitted as plain text within the HTTPS encrypted channel. * **Response**: Invalid credentials will return a SOAP fault with appropriate error code. {% hint style="info" %} The only acceptable value for the **Password @Type** attribute is *.* Plain text passwords are acceptable as all communication is done over encrypted HTTP (HTTPS). {% endhint %} {% tabs %} {% tab title="Reservation Message" %} Requests must include a SOAP Security Header for authentication. ```xml

USERNAME PASSWORD

``` {% endtab %} {% tab title="Confirmation Response" %} Responses must be returned in a SOAP envelope with an empty SOAP Header. ```xml

``` {% endtab %} {% endtabs %} ## Multiplicity In the SOAP Specification tables below **M** refers to the number of instances or occurrences of an element or attribute that are allowed or required in a given context. It defines how many times a particular component (element or attribute) can appear within a specific structure.

M	Definition
1	The element or attribute must be present exactly once.
0..1	The element or attribute is optional; it can be present zero or one time.
0..n	The element or attribute can be present zero or more times, with no upper limit (where n represents an infinite number of occurrences).
1..n	The element or attribute must be present at least once and can be present any number of times, with no upper limit.
n..m	Specific range, the element or attribute must be present at least n times and no more than m times (where n and m are specific numbers).

## 1. Reservation Message ### OTA\_HotelResNotifRQ The `OTA_HotelResNotifRQ` message carries reservation data your PMS to SiteMinder. Each message contains exactly one reservation (new booking, modification, or cancellation). The message consists of a list of `HotelReservation` elements. The content may vary since the PMS can delivers reservations from multiple upstream sources (walk-in reservations, direct booking channels, etc.), many of which have significantly different reservation formats and data structures. #### **Reservation Types** **PMS Reservation:** A reservation created directly at the hotel property. For example when a guest arrives without a prior booking, or a customer phones to make a booking. These originate in the PMS and represent the simplest reservation flow with no external channels involved. **Internet :** A reservation from a booking platform or website that connects directly to the PMS, bypassing SiteMinder's distribution network. Examples include the hotel's own booking engine, direct OTA connections, or property-specific reservation tools. **Other Booking Channel Types:** A reservation that flows through an intermediary distribution system before reaching the PMS. The booking originates from a travel agent, GDS (like Amadeus/Sabre), or wholesale platform, passes through a central reservation system, then arrives at the property. **SiteMinder Modification/Cancellation:** An update to an existing reservation originally delivered to the PMS through SiteMinder's channel manager. These messages track changes or cancellations to bookings that SiteMinder previously distributed, ensuring systems stay in sync. {% hint style="success" %} See `Reservation types` structure examples in the [POS / Source](#pos-source) section of this page. {% endhint %} #### **HotelReservation** * Represents a single booking from one channel. * Always contains exactly one reservation per message. * Includes all associated rooms, guests, and payments. ```xml ```

Element / @Attribute	Type	M	Description
`OTA_HotelResNotifRQ`	Element	1	Root element for the request.
`@xmlns`	String	1	Defines the XML namespace for the request. Will be set to `http://www.opentravel.org/OTA/2003/05`
`@EchoToken`	String	1	Unique identifier for the request, used to match requests and responses. Preferred format: UUID `8-4-4-4-12`.
`@TimeStamp`	DateTime	1	Time when the request was generated. TimeStamp must use `ISO 8601` format.
`@Version`	Decimal	1	Specifies the API version. Current Version `1.0`

### HotelReservations {% tabs %} {% tab title="Reserved" %} A confirmed booking that has been accepted. The guest has not yet arrived at the property. Any modification of this booking will be sent with this `ResStatus`. ```xml ``` {% code title="WalkInIndicator=" %} ```xml ``` {% endcode %} {% endtab %} {% tab title="Waitlisted" %} A tentative booking placed on a waiting list when the requested room/dates are not immediately available. Will be confirmed if availability opens up. ```xml ``` {% code title="WalkInIndicator=" %} ```xml ``` {% endcode %} {% endtab %} {% tab title="Cancelled" %} A previously confirmed reservation that has been terminated by either the guest or hotel before the arrival date. ```xml ``` {% code title="WalkInIndicator=" %} ```xml ``` {% endcode %} {% endtab %} {% tab title="No-show" %} A confirmed reservation where the guest failed to arrive on the scheduled check-in date without prior cancellation notice. ```xml ``` {% code title="WalkInIndicator=" %} ```xml ``` {% endcode %} {% endtab %} {% tab title="In-house" %} An active reservation where the guest has checked in and is currently staying at the property. ```xml ``` {% code title="WalkInIndicator=" %} ```xml ``` {% endcode %} {% endtab %} {% tab title="Checked-Out" %} A completed reservation where the guest has departed from the property and settled their account. ```xml ``` {% code title="WalkInIndicator=" %} ```xml ``` {% endcode %} {% endtab %} {% endtabs %}

Element / @Attribute	Type	M	Description
`HotelReservations`	Element	1	Contains the reservation details.
`HotelReservation`	Element	1	Contains the specific reservation information.
`@ResStatus`	Enumeration	1	Status is: `Reserved` `Waitlisted` `Cancelled` `No-show` `In-house` `Checked-Out`
`@CreateDateTime`	DateTime	1	Date and time when the reservation was first made. `CreateDateTime` must follow the `ISO 8601` Date and Time format.
`@LastModifyDateTime`	DateTime	0..1	This indicates the last date and time when the reservation was last modified. Mandatory if a message relating to this reservation has already been uploaded. If the same `LastModifyDateTime` is sent in multiple reservation events, only the first will be processed and the rest ignored since it is considered as the same reservation version. `LastModifyDateTime` must follow the `ISO 8601` Date and Time format.
`@CreatorID`	String	0..1	The creator ID could be a software system identifier or an identifier of an employee responsible for the creation.
`@LastModifierID`	String	0..1	Identifies the last software system or person to modify a record.
`@WalkInIndicator`	Boolean	0..1	Used to identify if the reservation is a walk-in reservation. This attribute is mandatory if a reservation has been generated in the PMS.

### POS / Source {% tabs %} {% tab title="PMS Reservations " %} Contains a single `Source` element with `RequestorID Type="10"` and `BookingChannel Type="4"` . The `CompanyName``@Code` attribute should identify your PMS. The `WalkInIndicator` attribute must be present on the `HotelReservation` element for PMS reservations. If the reservation is a 'walk-in' reservation then the `WalkInIndicator` attribute must be `'true'` ```xml PMS NAME ``` {% endtab %} {% tab title="Internet " %} Contains a single `Source` element with `RequestorID Type="10"` and `BookingChannel Type="7"` (Internet). The `CompanyName@Code` must identify the specific booking channel code using our [Booking Agent Codes](https://developer.siteminder.com/siteminder-apis/additional-resources/reference-tables/booking-agent-codes). ```xml Directly Connected Channel Name ``` {% endtab %} {% tab title="Other Booking Channel Types" %} Contains two `Source` elements: \ \ \- Primary identifying the central system with `Primary="true"` and the appropriate `BookingChannel@Type` for the system that is handling the reservations. For the full list of Booking Channel Types see [Booking Channel Types Code List](https://developer.siteminder.com/siteminder-apis/additional-resources/reference-tables/opentravel-codes-list#booking-channel-type-bct)\ \ \- Secondary with `BookingChannel Primary="false"` and typically `Type="7"`, identifying the original booking source. The `CompanyName@Code` must identify the specific booking channel code using our [Booking Agent Codes](https://developer.siteminder.com/siteminder-apis/additional-resources/reference-tables/booking-agent-codes). ```xml Central Reservation System Name Booking Channel Name ``` {% endtab %} {% tab title="SiteMinder Modification/Cancellation" %} Contains a single `Source` element with `RequestorID Type="10"` and `BookingChannel Type="4"`. The `CompanyName` and `@Code` should identify your PMS. The `HotelReservation` element's `ResStatus` attribute indicates the action (Cancelled, Modified, etc.). ```xml PMS NAME ``` {% endtab %} {% endtabs %}

Element / @Attribute	Type	M	Description
`POS`	Element	1	Point of Sale (POS) identifies the party or connection channel making the request.
`Source`	Element	1..10	This holds the details about the requestor. It may be repeated to also accommodate the delivery systems. Provides information on the source of a request.
`RequestorID`	Element	1	This identifies the system which is sending the reservation. This element must appear in the first Source element.
`@Type`	Integer	1	`10` for PMS
`@ID`	String	1	PMS Code assigned by SiteMinder. Remains the same throughout the messages.
`BookingChannel`	Element	0..1	Contains booking channel information.
`@Type`	Integer	1	The type of booking channel: `4` - Identifier Property management system (PMS). `5` - Identifier for Central reservation system (CRS). `7` - Identifier for Internet. Refer to OpenTravel Code List Booking Channel Type (BCT).
`@Primary`	Boolean	0..1	`true` for the primary booking channel in the first Source element. `false` in the second Source element.
`CompanyName`	Element	1	Identifies the company that is associated with the booking channel.
`@Code`	String	0..1	Identifies a company by the company code. The Code must identify the specific booking channel code using our Booking Agent Codes.

### UniqueID ```xml ```

Element / @Attribute	Type	M	Description
`UniqueID`	Element	1	Used to provide PMS and/or CRS identifiers. An identifier 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).
`@ID`	String	1	A unique identifying 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.

### RoomStays ```xml ```

Element / @Attribute	Type	M	Description
`RoomStays`	Element	1	A collection of RoomStay objects. Room stays associated with this reservation.
`RoomStay`	Element	1..n	One instance of `RoomStay` per room type booked.
`@MarketCode`	String	0..1	The code that relates to the market being sold to (e.g., the corporate market, packages).
`@SourceOfBusiness`	String	0..1	To specify where the business came from e.g. radio, newspaper ad, etc.
`@PromotionCode`	String	0..1	If configured, this is the promotion code indicating, for instance, a specific marketing campaign (not the rate code).

### RoomTypes ```xml Double ```

Element / @Attribute	Type	M	Description
`RoomTypes`	Element	0..1	A collection of Room Types associated with a particular Room Stay.
`RoomType`	Element	0..1	Provides details regarding rooms, usually guest rooms. Can be sent to give more information on the room type for this room stay.
`@RoomType`	String	0..1	A code value that indicates the type of room for which this request is made, e.g.: double, king, etc. Values may use the Hotel Descriptive Content table or a codes specific to the property or hotel brand.
`@RoomTypeCode`	String	0..1	Specific system room type code, ex: A1K, A1Q etc.
`@RoomCategory`	Integer	0..1	Indicates the category of the room. Typical values would be `Moderate`, `Standard`, or `Deluxe`. Refer to OpenTravel Code List Segment Category Code (SEG)
`@RoomID`	Integer	0..1	A string value representing the unique identification of a room if the request is looking for a specific room.
`@NonSmoking`	Boolean	0..1	Non-smoking indicator.
`@Configuration`	String	0..1	Textual description of room configuration.
`RoomDescription`	Element	0..1	Textual information regarding the room.
`@Text`	Element	0..n	A text description of the room
`AdditionalDetails`	Element	0..1	Container for additional information about this room.
`AdditionalDetail`	Element	1..n
`@Type`	Integer	0..1	Used to define the type of information being sent (e.g., rate description, property description, room information). Refer to the Additional Detail Type (ADT). Some common usages are: `43` - Meal plan information `15` - Promotion information
`@Code`	String	0..1	Trading partner code associated to AdditionalDetailType.
`DetailDescription`	Element	0..1	Textual description of AdditionalDetail information.
`Text`	Element	0..n	A text description of AdditionalDetail

### RatePlans ```xml Weekend Package includes wine, chocolates, champagne on arrival and late checkout at 3PM Champagne on arrival, English Breakfast, Chocolates and 3PM Checkout ```

Element / @Attribute	Type	M	Description
`RatePlans`	Element	0..1	A collection of Rate Plans associated with a particular Room Stay.
`RatePlan`	Element	0..1	Defines the details of the rate plan as used in the booking process.
`@RatePlanName`	String	0..1	Provides the name of the rate plan or group. Typically used with RatePlanType to further describe the rate plan.
`@EffectiveDate`	Date	0..1	The effective date of the RatePlan.
`@ExpireDate`	Date	0..1	The expire date for a RatePlan, this should be considered an exclusive date, the date for which the current rate plan information is no longer valid.
`@RatePlanCode`	String	0..1	Code of the rate booked.
`RatePlanDescription`	Element	0..1	Textual description of the RatePlan.
`Text`	Element	0..n	A text description of the RatePlan.
`RatePlanInclusions`	Element	0..1	Defines charges that are included in this rate plan.
`@TaxInclusive`	Boolean	0..1	Indicates that service fees are included in the rate.
`@ServiceFeeInclusive`	Boolean	0..1	Indicates that tax is included in the rate.
`RatePlanInclusionDescription`	Element	0..1	Textual description of what is included in the rate plan.
`Text`	Element	0..1	A text description of the RatePlanInclusionDescription
`MealsIncluded`	Element	0..1	Container.
`@MealPlanIndicator`	Boolean	0..1	When `true`, a meal plan is included in this rate plan. When `false`, a meal plan is not included in this rate plan.
`@MealPlanCodes`	String	0..1	Used to identify the types of meals included with a rate plan. Refer to OpenTravel Code List Meal Plan Type (MPT)
`AdditionalDetails`	Element	0..1	Textual description of AdditionalDetail information.
`AdditionalDetail`	Element	0..1	A text description of AdditionalDetail
`@Type`	Integer	0..1	Used to define the type of information being sent (e.g., rate description, property description, room information). Refer to OpenTravel Code List Additional Detail Type (ADT) Some common usages are: `43` - Meal plan information `15` - Promotion information
`@Code`	String	0..1	Trading partner code associated to AdditionalDetailType.
`DetailDescription`	Element	0..1	Textual description of AdditionalDetail information.
`Text`	Element	0..n	A text description of AdditionalDetail

### RoomRates {% tabs %} {% tab title="Room Rates" %} ```xml GST GST ``` {% endtab %} {% tab title="Same Value per Night" %} ```xml ``` {% endtab %} {% tab title="Different Value per Night" %} ```xml ``` {% endtab %} {% tab title="Combined" %} ```xml ``` {% endtab %} {% endtabs %}

Element / @Attribute	Type	M	Description
`RoomRates`	Element	0..1	Contains details of the rates applied to the room stay.
`RoomRate`	Element	1..n	One RoomRate per RoomStay. Multiple rates are listed under the RoomRate.
`@InvBlockCode`	String	0..1	Code that identifies an inventory block.
`@NumberOfUnits`	Integer	0..1	Must be set to `1`. If there are multiple RoomStays for the same RoomTypeCode and RatePlanCode, multiple RoomStay elements should be sent.
`@RoomID`	String	0..1	A string value representing the unique identification of a room.
`@RoomTypeCode`	String	0..1	Code of the room booked.
`@RatePlanCode`	String	0..1	Code of the rate plan booked. Must be included if RoomStay / RatePlans is present.
`@RatePlanCategory`	String	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.
`@EffectiveDate`	Date	1	Indicates the starting date.
`@ExpireDate`	Date	1	ExpireDate is the first day after the applicable period (e.g. when expire date is 2012-04-03 the last date of the period is 2012-04-02). Format yyyy-MM-dd. This date is exclusive.
`Rates`	Element	0..1	Container that will contain instances of Rates.
`Rate`	Element	1..n	Rate will contain a timespan for which a rate will apply for a room type. Multiple instances of Rate will be sent if rate changes apply.
`@UnitMultiplier`	Integer	1	Must be set to `1`.
`@EffectiveDate`	Date	1	Starting date of the rate. This date is inclusive.
`@ExpireDate`	Date	1	Expire date is the first day after the applicable period. This date is not inclusive.
`Base`	Element	1	Base amount charged for the accommodation.
`@AmountBeforeTax`	Decimal	0..1	At least one of `AmountAfterTax` or `AmountBeforeTax` must be set.
`@AmountAfterTax`	Decimal	0..1	At least one of `AmountAfterTax` or `AmountBeforeTax` must be set.
`@CurrencyCode`	String	1	Use `ISO 4217` currency codes.
`Taxes`	Element	0..1	Contains details of the taxes applied.
`@CurrencyCode`	String	0..1	Use `ISO 4217` currency codes.
`@Amount`	Decimal	0..1	A monetary amount of tax.
`Tax`	Element	0..n	Contains specific tax information.
`@Code`	String	0..1	Indicates the specific tax or fee that is being transferred. Refer to Fee Tax Type (FTT).
`@Amount`	Decimal	0..1	Tax amount applied.
`@CurrencyCode`	String	0..1	Use `ISO 4217` currency codes.
`@Percent`	Integer	0..1	Tax percentage; if zero, assume use of the Amount attribute (Amount or Percent must be a zero value).
`TaxDescription`	Element	0..5	Text description of the taxes.
`Text`	Element	0..n	Textual description of the tax
`Total`	Element	1	Total amount charged, including additional occupants and fees. If empty, assume the Base amount equals the Total amount.
`@AmountBeforeTax`	Decimal	0..1	At least one of `AmountAfterTax` or `AmountBeforeTax` must be set.
`@AmountAfterTax`	Decimal	0..1	At least one of `AmountAfterTax` or `AmountBeforeTax` must be set.
`@CurrencyCode`	String	0..1	Use `ISO 4217` currency codes.
`Taxes`	Element	0..1	Contains details of the taxes applied.
`@Amount`	Decimal	0..1	Tax amount applied.
`@CurrencyCode`	String	0..1	Use `ISO 4217` currency codes.
`Tax`	Element	0..99	An individual tax per tax element. This element allows for both percentages and flat amounts. If one field is used, the other should be zero since logically, taxes should be calculated in only one of the two ways.
`@Code`	Integer	0..1	The type of tax being applied to the total. Refer to the OpenTravel Code List Fee Tax Type (FTT).
`@Amount`	Integer	0..1	A monetary amount of tax. if zero, assume use of the Percent attribute (Amount or Percent must be a zero value).
`@CurrencyCode`	String	0..1	Use `ISO 4217` currency codes.
`@Percent`	Integer	0..1	Tax percentage; if zero, assume use of the Amount attribute (Amount or Percent must be a zero value).
`TaxDescription`	Element	0..5	Text description of the taxes.
`Text`	String	0..n	Textual description of the tax
`Total`	Element	1	The Total amount charged for the accommodation or service per unit of time.
`@AmountBeforeTax`	Integer	0..1	The Total amount charged for the accommodation or service per unit of time.
`@AmountAfterTax`	Integer	0..1	The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax).
`@CurrencyCode`	Integer	0..1	Use `ISO 4217` currency codes.
`Taxes`	Element	0..1	A collection of taxes.
`@CurrencyCode`	Integer	0..1	Use `ISO 4217` currency codes.
`@Amount`	Integer	0..1	A monetary amount of tax.
`Tax`	Element	0..99	An individual tax per tax element. This element allows for both percentages and flat amounts. If one field is used, the other should be zero since logically, taxes should be calculated in only one of the two ways.
`@Code`	Integer	0..1	The type of tax is applied to the total. Refer to the OpenTravel Code List Fee Tax Type (FTT).
`@Amount`	Integer	0..1	A monetary amount of tax. if zero, assume use of the Percent attribute (Amount or Percent must be a zero value).
`@CurrencyCode`	Integer	0..1	Use `ISO 4217` currency codes.
`@Percent`	Integer	0..1	Tax percentage; if zero, assume use of the Amount attribute (Amount or Percent must be a zero value).
`TaxDescription`	String	0..5	Text description of the taxes.
`Text`	String	0..n	Textual description of the tax
`ServiceRPHs`	Element	0..1	A collection of unsigned integers that reference the RPH (Reference Place holder) attribute in the Service object. The ServiceRPH attribute in the Service object is an indexing attribute that identifies the services attached this RoomRate.
`ServiceRPH`	Element	1..n	This is a reference placeholder used as an index for a service to be associated with this stay
`@RPH`	Integer	1	Provides a unique reference to the service.

### **GuestCounts** ```xml ```

Element / @Attribute	Type	M	Description
`GuestCounts`	Element	1	Total guest counts, divided by age group (adult, child, infant). Adult count must always be sent.
`GuestCount`	Element	1..n	Represents the count for a specific age group.
`@AgeQualifyingCode`	Integer	1	`10` = Adult (mandatory) `8` = Child (optional) `7` = Infant (optional)
`@Count`	Integer	1	Number of guests for this age group.
`@Age`	Integer	0..1	Age of the guest, required only for children and infants.
`@AgeBucket`	String	0..1	Defines the age range category or bucket a guest can be booked into. This is typically used in conjunction with the age qualifying code to further define the applicable age range.

### TimeSpan ```xml ```

Element / @Attribute	Type	M	Description
`TimeSpan`	Element	1	Contains the timespan for the RoomStay.
`@Start`	Date	1	Check-in date.
`@End`	Date	1	Check-out date. Must be after Start.

### Guarantee ```xml Leonard Woolf Combined Guarantees Accepted (Platinum Membership) ```

Element / @Attribute	Type	M	Description
`Guarantee`	Element	0..1	Guarantee provided with the reservation. Used if no deposit is paid for the reservation.
`@GuaranteeCode`	String	0..1	Contains the details of accepted Guarantee Code.
`@GuaranteeType`	Enumeration	0..1	An enumerated type defining the guarantee to be applied to this reservation. Value: CC/DC/Voucher Deposit DepositRequired GuaranteeRequired None PrePay Profile
`GuaranteesAccepted`	Element	0.1	The guarantee information associated to the Room Stay. A maximum of 5 occurrences are available for use depending on the context.
`GuaranteeAccepted`	Element	1..n	Guarantee Detail. One of PaymentCard, Voucher, DirectBill elements must be included within GuranteeAccepted.
`@PaymentTransactionTypeCode`	String	0..1	This is used to indicate either a charge, reserve (deposit) or refund. charge: This indicates that an actual payment has been made. refund: This indicates that the payment amount of this PaymentDetail element is for a refund. reserve: This indicates that a hold for the indicated amount has been placed on a credit card or that a cash amount has been taken from the customer to guarantee final payment.
`PaymentCard`	Element	0..1	Specific payment card information. Details of a debit or credit card.
`@CardCode`	String	1	2-character code of the credit card issuer. Refer to Payment Card Provider Codes.
`@EffectiveDate`	String	0..1	Indicates the starting date. format `MMyy`).
`@ExpireDate`	String	0..1	Expiry date of the credit card (format `MMyy`).
`CardHolderName`	Element	0..1	Card Holder Name
`CardNumber`	String	0..1	Secure information that supports PCI tokens, data masking and other encryption methods.
`@Mask`	String	0..1	Masked data.
`@Token`	Integer	0..1	Tokenized information.
`@TokenProviderID`	String	0..1	Provider ID.
`Voucher`	Element	0..1	Identification of a series of coupons or vouchers identified by serial number(s).
`@SeriesCode`	String	0..1	Identification of a series of coupons or vouchers identified by serial number(s).
`DirectBill`	Element	0..1	Details of a direct billing arrangement.
`@DirectBill_ID`	Integer	0..1	Identifier for the organization to be billed directly for travel services.
`GuaranteeDescription`	Element	0..1	Text description relating to the Guarantee.
`Text`	Sting	0..n	Textual information relating to the Guarantee.

### DepositPayments ```xml Leonard Woolf Credit Card surcharge. 30% deposit (of the total cost of the stay) will be charged to card holder's account 10 days before the date of arrival at the latest.

12 Pine Street Sydney 2095 New South Wales Australia

```

Element / @Attribute	Type	M	Description
`DepositPayments`	Element	0..1	A collection of required payments.
`GuaranteePayment`	Element	1..n	Used to define the deposit policy, guarantees policy, and/or accepted forms of payment.
`AcceptedPayments`	Element	0..1	Collection of forms of payment accepted for payment. Used to define the types of payments accepted.
`AcceptedPayment`	Element	0..1	An acceptable form of payment.
`@PaymentTransactionTypeCode`	String	0..1	`charge` - This indicates that an actual payment has been made. `refund`- This indicates that the payment amount of this PaymentDetail element is for a refund. `reserve` - This indicates that a hold for the indicated amount has been placed on a credit card or that a cash amount has been taken from the customer to guarantee final payment.
`PaymentCard`	Element	0..1	Specific payment card information. Details of a debit or credit card. NOTE: PCI-sensitive payment card information should not be included in the message. Do not attempt to send any payment card data for there isn't a specific element or attribute in the API.
`@CardCode`	String	0..1	Issuer code. See OTA Payment Card Provider Codes
`@EffectiveDate`	Date	0..1	Indicates the starting date.
`@ExpireDate`	Date	0..1	Indicates the ending date.
`CardHolderName`	Element	0..1	Card holder name.
`CardNumber`	Element	0..1	Secure information that supports PCI tokens, data masking and other encryption methods.
`@Mask`	String	0..1	Masked data.
`@Token`	Integer	0..1	Tokenized information.
`@TokenProviderID`	String	0..1	Provider ID.
`Voucher`	Element	0..1	Details of a paper or electronic document indicating prepayment.
`@SeriesCode`	Integer	0..1	Identification of a series of coupons or vouchers identified by serial number(s).
`DirectBill`	Element	0..1	Details of a direct billing arrangement.
`@DirectBill_ID`	Integer	0..1	Identifier for the organization to be billed directly for travel services.
`AmountPercent`	Element	0..1	Payment expressed as a fixed amount, or a percentage of/or room nights. If the the Total.amountAfterTax is provided, it will be a percentage of this value. If only the amountBeforeTax is provided it will be the percentage of this value. At least @Amount or @Percent will be populated.
`@Percent`	Integer	0..1	The percentage used to calculate the amount.
`@CurrencyCode`	String	0..1	Use `ISO 4217` currency codes.
`@Amount`	Decimal	0..1	A monetary amount taken for the deposit.
`@NmbrOfNights`	Integer	0..1	The number of nights of the hotel stay that are used to calculate the fee amount.
`Taxes`	Element	0..1	A collection of taxes relating to the deposit.
`@CurrencyCode`	String	0..1	Use `ISO 4217` currency codes.
`@Amount`	Integer	0..1
`Tax`	Element	0..99	An individual tax. This element allows for both percentages and flat amounts. If one field is used, the other should be zero since logically, taxes should be calculated in only one of the two ways.
`@Code`	String	0..1	Code identifying the fee (e.g., agency fee, municipality fee). Refer to OpenTravel Code List Fee Tax Type (FTT).
`@Amount`	Decimal	0..1	A monetary amount of tax.
`@CurrencyCode`	String	0..1	Use `ISO 4217` currency codes.
`@Percent`	Integer	0..1	Fee percentage; if zero, assume use of the Amount attribute (Amount or Percent must be a zero value).
`TaxDescription`	Element	0..5	Text description of the taxes.
`Text`	Element	0..n	Textual description of the tax
`Deadline`	Element	0..2	Payment deadline, absolute or relative.
`@AbsoluteDeadline`	DateTime	0..1	Defines the absolute deadline. Either this or the offset attributes may be used.
`@OffsetTimeUnit`	String	0..1	The units of time, e.g.: days, hours, etc., that apply to the deadline.
`@OffsetUnitMultiplier`	Integer	0..1	The number of units of DeadlineTimeUnit.
`@OffsetDropTime`	String	0..1	An enumerated type indicating when the deadline drop time goes into effect.
`Description`	Element	0..5	Text description of the Payment in a given language.
`Text`	String	0..n	Textual information information relating to the payment.
`Address`	String	0..1	The address to which a deposit may be sent.
`@Type`	Integer	0..1	Defines the type of address (e.g. home, business, other). Refer to OpenTravel Code List Communication Location Type (CLT).
`AddressLine`	Element	0..5	Address including any relevant street number.
`CityName`	Element	0..1	City.
`PostalCode`	Element	0..1	Postal code.
`StateProv`	Element	0..1	State, province, or region name or code needed to identify location.
`@StateCode`	Integer	0..1	The standard code or abbreviation for the state, province, or region.
`CountryName`	Element	0..1	The name or code of a country (as used in an address).
`@Code`	Integer	0..1	`ISO 3166` code for a country.

### Discount ```xml GST Stay 2 nights and get 15% off. ```

Element / Attribute	Type	M	Description
`Discount`	Element	0..1	Discount percentage and/or Amount, code and textual reason for discount.
`@TaxInclusive`	Boolean	0..1	Is Discount tax inclusive.
`@Percent`	Integer	0..1	Percentage value of the discount.
`@DiscountCode`	String	0..1	Specifies the type of discount (e.g., No condition, LOS, Deposit or Total amount spent).
`@AmountBeforeTax`	Decimal	0..1	The total amount not including any associated tax (e.g., sales tax, VAT, GST or any associated tax).
`@AmountAfterTax`	Decimal	0..1	The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax).
`@CurrencyCode`	String	0..1	Use `ISO 4217` currency codes.
`Taxes`	Element	0..1	A collection of taxes relating to Discount
`@CurrencyCode`	String	0..1	Use `ISO 4217` currency codes.
`@Amount`	Decimal	0..1	A monetary amount of tax.
`Tax`	Element	0..1	This element allows for both percentages and flat amounts. If one field is used, the other should be zero since logically, taxes should be calculated in only one of the two ways.
`@Code`	Integer	0..1	Code identifying the fee (e.g.,agency fee, municipality fee). Refer to OpenTravel Code List Fee Tax Type (FTT).
`@Amount`	Decimal	0..1	A monetary amount of tax.
`@CurrencyCode`	String	0..1	Use `ISO 4217` currency codes.
`@Percent`	Integer	0..1	Fee percentage; if zero, assume use of the Amount attribute (Amount or Percent must be a zero value).
`TaxDescription`	Element	0..1	Text description of the taxes.
`Text`	Element	0..1	Textual description of the tax
`DiscountReason`	Element	1	Text description of Discount Reason.
`Text`	Element	1	Textual description of Discount Reason.

### Total ```xml GST Insurance Premium Tax ```

Element / @Attribute	Type	M	Description
`Total`	Element	0..1	The total amount charged for the service including additional amounts and fees.
`@AmountBeforeTax`	Decimal	0..1	The total amount not including any associated tax (e.g., sales tax, VAT, GST or any associated tax).
`@AmountAfterTax`	Decimal	0..1	The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax).
`@CurrencyCode`	String	0..1	Use `ISO 4217` currency codes.
`Taxes`	Element	0..1	A collection of taxes relating to Discount
`@CurrencyCode`	String	0..1	Use `ISO 4217` currency codes.
`@Amount`	Decimal	0..1	A monetary amount of tax.
`Tax`	Element	0..1	This element allows for both percentages and flat amounts. If one field is used, the other should be zero since logically, taxes should be calculated in only one of the two ways.
`@Code`	String	0..1	Code identifying the fee (e.g., agency fee, municipality fee). Refer to OpenTravel Code List Fee Tax Type (FTT).
`@Amount`	Decimal	0..1	A monetary amount of tax.
`@CurrencyCode`	String	0..1	Use `ISO 4217` currency codes.
`@Percent`	Integer	0..1	Fee percentage; if zero, assume use of the Amount attribute (Amount or Percent must be a zero value).
`TaxDescription`	Element	0..5	Text description of the taxes.
`Text`	Element	0..n	Textual description of Discount Reason.

### ResGuestRPHs ```xml ```

Element / @Attribute	Type	M	Description
`ResGuestRPHs`	Element	0..1	Container for the `ResGuestRPH` elements.
`ResGuestRPH`	Element	1..n	Container for the `RPH` attribute.
`@RPH`	Integer	1	Links the `RoomStay` to `ResGuest`. Find the links in ResGuests.

### Memberships ```xml ```

Element / @Attribute	Type	M	Description
`Memberships`	Element	0..1	A collection of Membership objects. Memberships provides a list of reward programs which may be credited with points accrued from the guest's activity. Which memberships are to be applied to which part is determined by each object's SelectedMembershipRPHs collection.
`Membership`	Element	1..n	The SelectedMembership object identifies the frequent customer reward program and (optionally) indicates points awarded for stay activity.
`@ProgramCode`	String	0..1	The code or name of the membership program ('Hertz', 'AAdvantage', etc.).
`@AccountID`	String	0..1	The account identification number for this particular member in this particular program.

### Comments ```xml Platinum Members are offered a free spa entry for the whole length of stay. ```

Element / @Attribute	Type	M	Description
`Comments`	Element	0..1	Contains comment for the `RoomStay`.
`Comment`	Element	1	Holds the actual comment.
`@GuestViewable`	Boolean	0..1	When true, the comment may be shown to the consumer. When false, the comment may not be shown to the consumer.
`Text`	Element	1	The content of the comment. PCI sensitive data is prohibited.

### SpecialRequests ```xml King Split + Single Bed. ```

Element / @Attribute	Type	M	Description
`SpecialRequests`	Element	0..1	Contains special requests for the `RoomStay`.
`SpecialRequest`	Element	1..n	The SpecialRequests related to the RoomStay.
`@RequestCode`	String	0..1	This identifies a special request for this reservation and is typically hotel-specific.
`@CodeContext`	String	0..1	Identifies the source authority for the RequestCode.
`Text`	Element	0..n	Textual information relating to the SpecialRequest.

### ServiceRPHs ```xml ```

Element / @Attribute	Type	M	Description
`ServiceRPHs`	Element	0..1	Container for the `ServiceRPH` elements.
`ServiceRPH`	Element	1..n	Service at the `RoomStay` level.
`@RPH`	Integer	1	Links a `Service` to the Service information provided at the HotelReservation level (if applicable).

### Services ```xml GST Car space needs to be released before 3PM check-out day. No exceptions allowed. Accessible, covered and secured vehicle storage space. ```

Element / @Attribute	Type	M	Description
`Services`	Element	0..1	This is the collection of all services associated with any part of this reservation (the reservation in its entirety, one or more guests, or one or more room stays).
`Service`	Element	1..n	A Service object represents a non-room product provided to guests. Service products may have associated inventory and charges.
`@ServicePricingType`	String	0..1	An enumerated type that defines how a service is priced. Values: Per stay, Per person, Per night, Per person per night, Per use.
`@ServiceCategoryCode`	String	0..1	The representation of the specific service category for the service being reserved.
`@ServiceInventoryCode`	String	0..1	Identifier code for the service. Refer to Service and Extra Charge.
`@Inclusive`	Boolean	1	Must be set to `TRUE`, as SiteConnect reports totals as inclusive of charges and extras.
`@Quantity`	Integer	1	Number of units included in the charge. This value does not affect the total amount.
`@ServiceRPH`	Integer	0..1	Links the `Service` to a `RoomStay` or `RatePlan`. `ServiceRPH` absence indicates a HotelReservation-level charge.
`@Type`	Integer	0..1	A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT).
`@ID`	String	0..1	Reference ID for the extra/service provided by the source booking channel.
`@ID_Context`	String	0..1	Used to identify the source of the identifier (e.g., IATA, ABTA).
`Price`	Element	0..99	Container for pricing details of the service.
`Total`	Element	0..1	The total amount charged for this rate including additional occupant amounts and fees.The total amount charged for the service including additional amounts and fees.
`@AmountAfterTax`	Decimal	0..1	The total amount not including any associated tax. At least one of `AmountAfterTax` or `AmountBeforeTax` must be set.
`@AmountBeforeTax`	Decimal	0..1	The total amount including any associated tax. At least one of `AmountAfterTax` or `AmountBeforeTax` must be set.
`@CurrencyCode`	String	0..1	Use ISO 4217 currency codes.
`Taxes`	Element	0..1	Contains details of the taxes applied.
`Tax`	Element	1	Contains specific tax information.
`@Code`		1	Indicates the specific tax or fee that is being transferred. Refer to Fee Tax Type (FTT).
`@Percentage`	Decimal	0..1	Percentage rate of the applied tax.
`@Amount`	Decimal	0..1	Tax amount applied.
`TaxDescription`	Element	0..1	Container for a detailed description of the tax.
`Text`	Element	1	Text description of the tax.
`Total`	Element	1	Container for the total amount of the service.
`@CurrencyCode`	String	0..1	Use ISO 4217 currency codes.
`@AmountAfterTax`	Decimal	0..1	At least one of `AmountAfterTax` or `AmountBeforeTax` must be set.
`@AmountBeforeTax`	Decimal	0..1	At least one of `AmountAfterTax` or `AmountBeforeTax` must be set.
`Taxes`	Element	0..1	Contains details of the taxes applied.
`@CurrencyCode`	String	0..1	Use ISO 4217 currency codes.
`@Amount`	Decimal	0..1	A monetary amount.
`Tax`	Element	0..99	Contains specific tax information.
`@Code`		1	Indicates the specific tax or fee that is being transferred. Refer to Fee Tax Type (FTT).
`@Amount`	Decimal	0..1	Tax amount applied.
`@CurrencyCode`	String	0..1	Use ISO 4217 currency codes.
`@Percent`	Integer	0..1	Percentage rate of the applied tax.
`TaxDescription`	Element	0..5	Text description of the taxes in a given language
`Text`	Element	1	Text description of the tax.
`ServiceDetails`	Element	0..1	Container for additional service details.
`GuestCounts`	Element	0..1	A collection of Guest Counts associated to the whole Reservation or a particular Room Stay or Service.
`GuestCount`	Element	0..99	A recurring element that identifies the number of guests and ages of the guests.
`@AgeQualifyingCode`	Integer	0..1	A code representing a business rule that determines the charges for a guest based upon age range (e.g. Adult, Child, Senior, Child With Adult, Child Without Adult). This attribute allows for an increase in rate by occupant class. Refer to OpenTravel Code List Age Qualifying Code (AQC).
`@Age`	Integer	0..1	Defines the age of a guest.
`@Count`	Integer	0..1	The number of guests in one AgeQualifyingCode or Count. Valid value between 1 and 9999.
`@AgeBucket`	String	0..1	This defines the age range category or bucket into which a guest can be booked. It is typically used in conjunction with the age qualifying code to further define the applicable age range.
`TimeSpan`	Element	0..1	Contains the time span for which the service is provided.
`@Start`	Date	0..1	The starting value of the time span.
`@End`	Date	0..1	The ending value of the time span.
`Comments`	Element	0..1	A collection of Comment objects. Comments which apply to the Service.
`Comment`	Element	0..n	Comment details.
`@GuestViewable`	Boolean	0..1	When true, the comment may be shown to the consumer. When false, it may not be.
`Text`	Element	0..n	Service detail comments
`ServiceDescription`	Element	0..1	Description of the service
`Text`	Element	0..n	A text description of the service
`ServiceCategory`	Element	0..n	Hotel systems often group multiple services into a single category. This refers to the category specific to the hotel CRS/PMS.
`@ServiceCategoryCode`	String	1	The representation of the specific service category for the service being reserved.

### **BillingInstructionCode** ```xml ```

Element / @Attribute	Type	M	Description
`BillingInstructionCode`	Element	0..n	Billing codes apply to a set of instructions for a set of transactions that are routed to a designated folio.
`@BillingCode`	String	1	The individual billing code that applies to a set of instructions that are routed to a designated folio.
`@AccountNumber`	String	0..1	Identifies the account number where the charges will be routed.
`@Start`	Date	0..1	The starting value of the time span.
`@End`	Date	0..1	The ending value of the time span.
`@AuthorizationCode`	Integer	0..1	The authorization code associated with the billing code.
`@Description`	String	0..1	A short description of the billing code or instructions.
`ResGuestRPH`	Element	0..1	A reference to a guest ID object that may be defined in ResGuests/ResGuest
`@RPH`	Integer	0..1	A unique reference to the guest ID.

### ResGuests ```xml Mrs. Ginny Adeline Woolf Jr. Ph.D. Virginia.Woolf@hotmail.com

125 Pitt Street Sydney 2000 New South Wales Australia Dalloway

```

Element / @Attribute	Type	M	Description
`ResGuests`	Element	0..1	Contains the guests for the reservation.
`ResGuest`	Element	1..n	Contains the specific guest details.
`@ResGuestRPH`	Integer	0..1	Links the `ResGuest` to `RoomStay`. Find the links in ResGuestRPHs.
`@AgeQualifyingCode`	Integer	0..1	A code representing a business rule that determines the charges for a guest based upon age range (e.g. Adult, Child, Senior, Child With Adult, Child Without Adult). Refer to OpenTravel Code List Age Qualifying Code (AQC).
`@ArrivalTime`	Time	0..1	Arrival time of the guest.
`@PrimaryIndicator`	Boolean	0..1	When true, indicates this is the primary guest. Only one ResGuest can be the primary guest.
`@Age`	Integer	0..1	The age of the guest.
`Profiles`	Element	0..1	Contains the guest profile information.
`ProfileInfo`	Element	1..n	Contains the profile information for the guest.
`UniqueID`	Element	0..9	A unique ID for a profile. This element can repeat to accommodate multiple unique IDs for a single profile across multiple systems.
`@ID`	Integer	1	A unique identifying 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.
`@Type`	Integer	1	A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT).
`@ID_Context`	String	0..1	Used to identify the source of the identifier.
`Profile`	Element	1	Contains detailed customer profile information.
`@ProfileType`	Integer	1	Must be set to `1` (Customer).
`@ShareAllOptOutInd`	Boolean	1	Customer has 'opted out' of receiving marking information (Non EU).
`@ShareAllMarketInd`	Boolean	1	Customer has 'opted in' to receive marking information (EU Customers).
`Customer`	Element	0..1	Contains detailed guest information.
`@VIP_Indicator`	Boolean	0..1	If true, indicates a very important person.
`@CustomerValue`	String	0..1	The supplier's ranking of the customer (e.g., VIP, numerical ranking).
`@BirthDate`	Date	0..1	The customer’s birthday information.
`PersonName`	Element	0..1	Contains the name information for the guest.
`@Language`	String	0..1	The language code for which the name data is represented.
`@NameType`	Integer	0..1	Former, Nickname, Alternate, etc. Please refer to OpenTravel Code List Name Type (NAM).
`NamePrefix`	Element	0..3	Title of the guest.
`GivenName`	Element	0..5	First name of the guest.
`MiddleName`	Element	0..3	The middle name of the person name.
`Surname`	Element	1	Last name of the guest.
`NameSuffix`	Element	0..3	Name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.)
`NameTitle`	Element	0..5	Degree or honours (e.g., Ph.D., M.D.)
`Telephone`	Element	0..5	Contains telephone information related to the guest.
`@PhoneLocationType`	Integer	0..1	Describes the location of the phone, such as Home, Office, Property Reservation Office, etc. Refer to OpenTravel Code List Phone Location Type (PLT).
`@PhoneTechType`	Integer	0..1	Indicates type of technology associated with this telephone number, such as Voice, Data, Fax, Pager, Mobile, TTY, etc. Refer to OpenTravel Code List Phone Technology Type (PTT).
`@CountryAccessCode`	Integer	0..1	Code assigned by telecommunications authorities for international country access identifier.
`@AreaCityCode`	Integer	0..1	Code assigned for telephones in a specific region, city, or area.
`@PhoneNumber`	Integer	0..1	Telephone number assigned to a single location.
`@Remark`	String	0..1	A remark associated with the telephone number.
`@FormattedInd`	Boolean	0..1	Specifies if the associated data is formatted or not. When true, then it is formatted; when false, then not formatted.
`@DefaultInd`	Boolean	0..1	When true, indicates a default value should be used.
`Email`	Element	0..5	Contact email address.
`@EmailType`	Integer	0..1	Defines the purpose of the e-mail address (e.g. personal, business, listserve). Refer to OpenTravel Code List Email Address Type (EAT).
`@DefaultInd`	Boolean	0..5	When true, indicates a default value should be used.
`Address`	Element	0..5	Address information of the guest.
`@Type`	Integer	0..1	Defines the type of address (e.g. home, business, other). Refer to OpenTravel Code List Communication Location Type (CLT).
`AddressLine`	Element	0..5	Address lines for the guest.
`CityName`	Element	0..1	City of residence.
`PostalCode`	Element	0..1	Postal code.
`StateProv`	Element	0..1	State or province name.
`@StateCode`	String	0..1	The standard code or abbreviation for the state, province, or region.
`CompanyName`	Element	0..1	Identifies a company.
`@Code`	String	0..1	ISO 3166 code for a country.
`CountryName`	Element	0..1	Country name (maximum 64 characters).
`@Code`	String	0..1	ISO 3166 code for a country.
`CustLoyalty`	Element	0..25	Loyalty program information for the customer.
`@ProgramID`	String	0..1	The ProgramID attribute can be used to indicate the program that is being passed. For instance, we could use it to pass: Frequent Guest, Frequent Traveller and Company ID.
`@MembershipID`	Integer	0..1	The membershipID attribute will indicate the actual number.
`@LoyalLevel`	String	0..1	Indicates special privileges in the program assigned to an individual.
`@LoyalLevelCode`	Integer	0..1	Provides a numeric code assigned to a particular loyalty level.
`@SignupDate`	Date	0..1	Indicates the starting date of the program.
`@EffectiveDate`	Date	0..1	Indicates the expiration date of the program.
`@ExpireDate`	Date	0..1	Indicates the customer’s sign-up date.
`@Remark`	String	0..1	A remark associated with the customer's loyalty program.
`CompanyInfo`	Element	0..1	Detailed information about a company.
`CompanyName`	Element	0..1	Identifies a company by name.
`@Code`	String	0..1	Identifies a company by the company code.
`AddressInfo`	Element	0..5
`@Type`	Integer	0..1	Defines the type of address (e.g. home, business, other). Refer to OpenTravel Code List Communication Location Type (CLT).
`AddressLine`	Element	0..5	These lines will contain free-form address details.
`CityName`	Element	0..1	City (e.g., Dublin), town, or postal station.
`StateProv`	Element	0..1	State, province, or region name.
`@StateCode`	String	0..1	The standard code or abbreviation for the state, province, or region.
`PostalCode`	String	0..1	Post Office Code number.
`CountryName`	String	0..1	Country name (e.g., Ireland).
`@Code`	Integer	0..1	ISO 3166 code for a country.
`TelephoneInfo`	Element	0..n	Information on a telephone number for the company.
`@PhoneLocationType`	Integer	0..1	Describes the location of the phone, such as Home, Office, Property Reservation Office, etc. Refer to OpenTravel Code List Phone Location Type (PLT).
`@PhoneTechType`	Integer	0..1	Indicates type of technology associated with this telephone number, such as Voice, Data, Fax, Pager, Mobile, TTY, etc. Refer to OpenTravel Code List Phone Technology Type (PTT).
`@CountryAccessCode`	Integer	0..1	Code assigned by telecommunications authorities for international country access identifier.
`@AreaCityCode`	Integer	0..1	Code assigned for telephones in a specific region, city, or area.
`@PhoneNumber`	Integer	1	Telephone number assigned to a single location.
`@FormattedInd`	Boolean	0..1	Specifies if the associated data is formatted or not. When true, then it is formatted; when false, then not formatted.
`@DefaultInd`	Boolean	0..1	When true, indicates a default value should be used.
`@Remark`	String	0..1	A remark associated with the telephone number.
`Email`	Element	0..5	Information on an email address for the company.
`@EmailType`	Integer	0..1	Defines the purpose of the e-mail address (e.g. personal, business, listserve). Refer to OpenTravel Code List Email Address Type (EAT).
`@DefaultInd`	Boolean	0..1	When true, indicates a default value should be used.
`ContactPerson`	Element	0..n	Information on a contact person for the company. Name of an individual and appropriate contact information. May be contact information for the customer or someone affiliated with the customer.
`PersonName`	Element	0..1
`@Language`	String	0..1	The language code for which the name data is represented.
`@NameType`	Integer	0..1	Former, Nickname, Alternate, etc. Please refer to OpenTravel Code List Name Type (NAM).
`NamePrefix`	Element	0..3	Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.)
`GivenName`	Element	0.5	Given name, first name or names.
`MiddleName`	Element	0..3	The middle name of the person name.
`Surname`	Element	1	Family or last name.
`NameSuffix`	Element	0..3	Name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.)
`NameTitle`	Element	0..5	Degree or honours (e.g., Ph.D., M.D.)
`Telephone`	Element	0..5	Information on a telephone number for the customer.
`@PhoneLocationType`	Integer	0..1	Describes the location of the phone, such as Home, Office, Property Reservation Office, etc. Refer to OpenTravel Code List Phone Location Type (PLT).
`@PhoneTechType`	Integer	0..1	Indicates the type of technology associated with this telephone number, such as Voice, Data, Fax, Pager, Mobile, TTY, etc. Refer to OpenTravel Code List Phone Technology Type (PTT).
`@CountryAccessCode`	Integer	0..1	Code assigned by telecommunications authorities for international country access identifier.
`@AreaCityCode`	Integer	0..1	Code assigned for telephones in a specific region, city, or area.
`@PhoneNumber`	Integer	1	Telephone number assigned to a single location.
`@FormattedInd`	Boolean	0..1	Specifies if the associated data is formatted or not. When true, then it is formatted; when false, then not formatted.
`@DefaultInd`	Boolean	0..1	When true, indicates a default value should be used.
`@Remark`	String	0..1	A remark associated with the telephone number.
`Address`	Element	0..5	Detailed information on an address for the contact person for the company.
`@Type`	Integer	0..1	Defines the type of address (e.g. home, business, other). Refer to OpenTravel Code List Communication Location Type (CLT).
`AddressLine`	String	0..5	These lines will contain free-form address details.
`CityName`	String	0..1	City (e.g., Dublin), town, or postal station.
`StateProv`	String	0..1	State, province, or region name.
`@StateCode`	String	0..1	The standard code or abbreviation for the state, province, or region.
`PostalCode`	Element	0..1	Post Office Code number.
`CountryName`	Element	0..1	Country name (e.g., Ireland).
`@Code`	Integer	0..1	ISO 3166 code for a country.
`Email`	Element	0..5	Information on an email address for the contact person for the company.
`@EmailType`	Integer	0..1	Defines the purpose of the e-mail address (e.g. personal, business, listserve). Refer to OpenTravel Code List Email Address Type (EAT).
`@DefaultInd`	Boolean	0..1	When true, indicates a default value should be used.
`SpecialRequests`	Element	0..1
`SpecialRequest`	Element	1..n	The SpecialRequest object indicates special requests for a particular guest, service or reservation.
`@RequestCode`	String	0..1	This identifies a special request for this reservation and is typically hotel-specific.
`@CodeContext`	String	0..1	Identifies the source authority for the RequestCode.
`Text`	Element	0..1	Provides more information about the request code or describes requests that are yet uncoded.
`Comments`	Element	0..1	Comment section relating to the ResGuest.
`Comment`	Element	1	Comment details.
`@GuestViewable`	Boolean	1	This indicates that the comment can be seen by the guest and is necessary when two different types of comments are passed: one which is guest-viewable and one that isn’t.
`Text`	Element	1	Textual description of Comments.
`ServiceRPHs`	Element	0..1
`ServiceRPH`	Element	1..n	This is a reference placeholder used as an index for a service to be associated with this guest.
`@RPH`	Integer	1	Services ID
`ArrivalTransport`	Element	0..1	Contains information about the arrival transportation for a guest
`TransportInfo`	Element	1..n	Indicates transportation information for a guest.
`@Type`	String	0..1	Method of conveyance of this guest. Values: Air, Rail, Bus, Boat, Private Auto, Other.
`@ID`	String	0..1	Identifier of this transportation method (e.g., flight number).
`@Time`	DateTime	0..1	Time of transportation. The local time of the location, indicated by the LocationCode.
`DepartureTransport`	Element	0..1	Contains information about the departure transportation for a guest
`TransportInfo`	Element	1..n	Indicates transportation information for a guest.
`@Type`	String	0..1	Method of conveyance of this guest. Values: Air, Rail, Bus, Boat, Private Auto, Other.
`@ID`	String	0..1	Identifier of this transportation method (e.g., flight number).
`@Time`	DateTime	0..1	Time of transportation. The local time of the location, indicated by the LocationCode.

### ResGlobalInfo ```xml ```

Element / @Attribute	Type	M	Description
`ResGlobalInfo`	Element	1	Contains global information about the reservation.
`GuestCounts`	Element	0..1
`GuestCount`	Element	1..99	A recurring element that identifies the number of guests and ages of the guests.
`@AgeQualifyingCode`	Integer	0..1	A code representing a business rule that determines the charges for a guest based upon age range (e.g. Adult, Child, Senior, Child With Adult, Child Without Adult). This attribute allows for an increase in rate by occupant class. Refer to OpenTravel Code List Age Qualifying Code (AQC).
`@Age`	Integer	0..1	Defines the age of a guest.
`@Count`	Integer	0..1	The number of guests in one AgeQualifyingCode or Count. Valid value between 1 and 9999.
`@AgeBucket`	Integer	0..1	Defines the age range category or bucket a guest can be booked into. This is typically used in conjunction with the age qualifying code to further define the applicable age range.
`Timespan`	Element	1	The Time Span which covers the Reservation
`@Start`	Date	1	The ending value of the time span (Check in date)
`@End`	Date	1	The starting value of the time span (Check out date)
`Memberships`	Element	0..1	A collection of Membership objects. Memberships provides a list of reward progream which may be credited with points accrued from the guest's activity.
`Membership`	Integer	0..n	The Membership object identifes the frequent customer reward program.
`@ProgramCode`	Integer	0..1	The code or name of the membership program ('Hertz', 'AAdvantage', etc.).
`@AccountID`	Integer	0..1	The account identification number for this particular member in this particular program.
`Comments`	String	0..1	A collection of Comment objects. Comments which apply to the Service.
`Comment`	String	0..n	Comment details.
`@GuestViewable`	Boolean	0..1	When true, the comment may be shown to the consumer. When false, the comment may not be shown to the consumer.
`Text`	String	0..n	Reservation comments
`SpecialRequests`	String	0..1
`SpecialRequest`	String	1..n	The SpecialRequest object indicates special requests for a particular guest, service or reservation.
`@RequestCode`	String	1..n	This identifies a special request for this reservation and is typically hotel-specific.
`@CodeContext`	String	0..1	Identifies the source authority for the RequestCode.
`Text`	String	0..n	Provides more information about the request code or provides description for requests that are yet uncoded.
`Guarantee`	Element	0..5	The guarantee information to hold a reservation
`@GuaranteeCode`	String	0..1	Guarantee Code
`@GuaranteeType`	String	0..1	An enumerated type defining the guarantee to be applied to this reservation. Value: CC/DC/Voucher Deposit DepositRequired GuaranteeRequired None PrePay Profile
`GuaranteesAccepted`	Element	0..1	The guarantee information associated to the reservation. A maximum of 5 occurances are available for use depending on the context.
`GuaranteeAccepted`	Element	1..n	Guarantee Detail.
`@PaymentTransactionTypeCode`	Enumeration	0..1	This is used to indicate either a charge, reserve (deposit) or refund. charge: This indicates that an actual payment has been made. refund: This indicates that the payment amount of this PaymentDetail element is for a refund. reserve: This indicates that a hold for the indicated amount has been placed on a credit card or that a cash amount has been taken from the customer to guarantee final payment.
`PaymentCard`	Integer	0..1	Specific payment card information. Details of a debit or credit card. NOTE: PCI sensitive information is out of scope in Payment card. Please do not attempt to parse any 'out of scope' elements / data
`@CardCode`	Integer	0..1	Issuer code. See OTA Payment Card Provider Codes
`@EffectiveDate`	Date	0..1	Indicates the starting date.
`@ExpireDate`	Date	0..1	Indicates the ending date.
`CardHolderName`	String	0..1
`CardNumber`	Integer	0..1	Secure information that supports PCI tokens, data masking and other encryption methods.
`@Mask`	Integer	0..1	Masked data.
`@Token`	Integer	0..1	Tokenized information.
`@TokenProviderID`	String	0..1	Provider ID.
`Voucher`	Element	0..1	Details of a paper or electronic document indicating prepayment.
`@SeriesCode`	Integer	0..1	Identification of a series of coupons or vouchers identified by serial number(s).
`DirectBill`	Element	0..1	Details of a direct billing arrangement.
`@DirectBill_ID`	Integer	0..1	Identifier for the organization to be billed directly for travel services.

### **Guarantee** ```xml Leonard Woolf Combined Guarantees Accepted (Platinum Membership) ```

Element / @Attribute	Type	M	Description
`Guarantee`	Element	0..1	Guarantee provided with the reservation. Used if no deposit is paid for the reservation.
`@GuaranteeCode`	String	0..1	Guarantee Code
`@GuaranteeType`	String	0..1	An enumerated type defining the guarantee to be applied to this reservation. Value: CC/DC/Voucher Deposit DepositRequired GuaranteeRequired None PrePay Profile
`GuaranteesAccepted`	Element	0..1	Contains the details of accepted guarantees.
`GuaranteeAccepted`	Element	1..n	Specific details of the accepted guarantee.
`@PaymentTransactionTypeCode`	String	0..1	`charge` - This indicates that an actual payment has been made. `refund` - This indicates that the payment amount of this PaymentDetail element is for a refund. `reserve` - This indicates that a hold for the indicated amount has been placed on a credit card or that a cash amount has been taken from the customer to guarantee final payment.
`PaymentCard`	Element	0..1	Details of the payment card used for the guarantee.
`@CardType`	String	0..1	Must be set to `1` (Credit Card).
`@CardCode`	String	0..1	2-character code of the credit card issuer. Refer to Payment Card Provider Codes.
`@EffectiveDate`	String	0..1	Indicates the starting date (format `MMyy`).
`@ExpireDate`	String	0..1	Expiry date of the credit card (format `MMyy`).
`CardHolderName`	Element	0..1	Name of the cardholder.
`CardNumber`	Integer	0..1	Secure information that supports PCI tokens, data masking and other encryption methods.
`@Mask`	String	0..1	Masked data.
`@Token`	Integer	0..1	Tokenized information.
`@TokenProviderID`	String	0..1	Provider ID.
`Voucher`	Element	0..1	Details of a paper or electronic document indicating prepayment.
`@SeriesCode`	Integer	0..1	Identification of a series of coupons or vouchers identified by serial number(s).
`DirectBill`	Element	0..1	Details of a direct billing arrangement.
`@DirectBill_ID`	Integer	0..1	Identifier for the organization to be billed directly for travel services.

### **DepositPayments** {% tabs %} {% tab title="Credit Card " %} ```xml Leonard Woolf Credit Card surcharge. 30% deposit (of the total reservation cost) will be charged to card holder's account 10 days before the date of arrival at the latest.

12 Pine Street Sydney 2095 New South Wales Australia

``` {% endtab %} {% tab title="Deposit Only" %} ```xml ``` {% endtab %} {% endtabs %}

Element / @Attribute	Type	M	Description
`DepositPayments`	Element	0..1	Deposit provided with the reservation.
`GuaranteePayment`	Element	1	Contains details of the payment guarantee for the reservation.
`AcceptedPayments`	Element	0..1	Contains the accepted payment methods.
`AcceptedPayment`	Element	1	Specific payment method accepted.
`@PaymentTransactionTypeCode`	Enumeration	0..1	This is used to indicate either a charge, reserve (deposit) or refund. charge: This indicates that an actual payment has been made. refund: This indicates that the payment amount of this PaymentDetail element is for a refund. reserve: This indicates that a hold for the indicated amount has been placed on a credit card or that a cash amount has been taken from the customer to guarantee final payment.
`PaymentCard`	Element	1	Details of the payment card used for the guarantee.
`@CardType`	String	0..1	Must be set to `1` (Credit Card).
`@CardCode`	String	0..1	2-character code of the credit card issuer. Refer to Payment Card Provider Codes.
`@EffectiveDate`	Date	0..1	Indicates the starting date.
`@ExpireDate`	Date	0..1	Indicates the ending date.
`CardHolderName`	Element	0..1	Name of the cardholder.
`@CardNumber`	String	0..1	Actual credit card number.
`@Mask`	Integer	0..1	Masked data.
`@Token`	Integer	0..1	Tokenized information.
`@TokenProviderID`	String	0..1	Provider ID.
`Voucher`	Element	0..1	Details of a paper or electronic document indicating prepayment.
`@SeriesCode`	Integer	0..1	Identification of a series of coupons or vouchers identified by serial number(s).
`DirectBill`	Integer	0..1	Details of a direct billing arrangement.
`@DirectBill_ID`	Integer	0..1	Identifier for the organization to be billed directly for travel services.
`@AmountPercent`	Integer	0..1	Payment expressed as a fixed amount, or a percentage of/or room nights. If the the Total.amountAfterTax is provided, it will be a percentage of this value. If only the amountBeforeTax is provided it will be the percentage of this value. At least @Amount or @Percent will be populated.
`@Percent`	Integer	0..1	The percentage used to calculate the amount.
`@CurrencyCode`	String	0..1	Use `ISO 4217` currency codes.
`@Amount`	Decimal	0..1	A monetary amount taken for the deposit.
`@NmbrOfNights`	Integer	1	The number of nights of the hotel stay that are used to calculate the fee amount.
`Taxes`	Element	0..1	A collection of taxes relating to the deposit.
`@CurrencyCode`	Integer	0..1	Use `ISO 4217` currency codes.
`@Amount`	Decimal	0..1
`Tax`	Element	0..99	An individual tax. This element allows for both percentages and flat amounts. If one field is used, the other should be zero since logically, taxes should be calculated in only one of the two ways.
`@Code`	Integer	0..1	Code identifying the fee (e.g.,agency fee, municipality fee). Refer to OpenTravel Code List Fee Tax Type (FTT).
`@Amount`	Integer	0..1	A monetary amount of tax.
`@CurrencyCode`	Integer	0..1	Use `ISO 4217` currency codes.
`@Percent`	Integer	0..1	Fee percentage; if zero, assume use of the Amount attribute (Amount or Percent must be a zero value).
`Deadline`	Element	1	Payment deadline, absolute or relative.
`@AbsoluteDeadline`	DateTime	1	Defines the absolute deadline. Either this or the offset attributes may be used.
`@OffsetTimeUnit`	String	0..1	The units of time, e.g.: days, hours, etc., that apply to the deadline.
`@OffsetUnitMultiplier`	Integer	0..1	The number of units of DeadlineTimeUnit.
`@OffsetDropTime`	String	0..1	An enumerated type indicating when the deadline drop time goes into effect.
`Description`	Element	0..1	Text description of the Payment in a given language.
`Text`	Element	0..1	Textual information information relating to the payment.
`Address`	Element	0..1	The address to which a deposit may be sent.
`@Type`	Integer	0..1	Defines the type of address (e.g. home, business, other). Refer to OpenTravel Code List Communication Location Type (CLT).
`AddressLine`	Element	0..5	Address including any relevent street number.
`CityName`	Element	0..1	City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).
`PostalCode`	Element	0..1	Postal Code
`StateProv`	Element	0..1	State, province, or region name or code needed to identify location.
`@StateCode`	String	0..1	The standard code or abbreviation for the state, province, or region.
`CountryName`	Element	0..1	The name or code of a country (as used in an address).
`@Code`	Integer	0..1	ISO 3166 code for a country.
`@Type`	Integer	1	A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT).
`@ID_Context`	String	0..1	Used to identify the source of the identifier.

### ReservationTotal ```xml GST ```

Element / @Attribute	Type	M	Description
`Total`	Element	1	Total amount for the reservation. This includes all `RoomStays` and any additional fees or charges that apply.
`@AmountBeforeTax`	Decimal	0..1	At least one of `AmountAfterTax` or `AmountBeforeTax` must be set.
`@AmountAfterTax`	Decimal	0..1	At least one of `AmountAfterTax` or `AmountBeforeTax` must be set.
`@CurrencyCode`	String	1	Use `ISO 4217` currency codes.
`Taxes`	Element	0..1	Contains details of the taxes applied.
`@CurrencyCode`	Integer	0..1	Use `ISO 4217` currency codes.
`@Amount`	Decimal	0..1	A monetary amount of tax.
`Tax`	Element	1	Contains specific tax information.
`@Code`	String	0..1	Indicates the specific tax or fee that is being transferred. Refer to Fee Tax Type (FTT).
`@Amount`	Decimal	0..1	Tax amount applied.
`@CurrencyCode`	String	0..1	Use `ISO 4217` currency codes.
`@Percent`	Integer	0..1	Fee percentage; if zero, assume use of the Amount attribute (Amount or Percent must be a zero value).
`TaxDescription`	Element	0..5	Text description of the taxes.
`Text`	String	0..n	Textual description of Discount Reason.

### HotelReservationIDs {% tabs %} {% tab title="PMS Reservation" %} Contains only one `HotelReservationID` with `ResID_Type="14"` with the PMS reservation identifier. No other reservation IDs are present since the booking originates entirely within the property management system. ```xml ``` {% endtab %} {% tab title="Internet" %} Contains two `HotelReservationID`: `ResID_Type="14"` for the PMS reservation identifier and `ResID_Type="29"` for the original booking reference from the external channel that sent the reservation directly to the PMS. In this case the `ResID_Source` must identify the specific booking channel code using our [PMS to SM Booking Agent Code List](broken://pages/XZmhGmBHt90cEfbyCdU7). ```xml ``` {% endtab %} {% tab title="Other Booking Channel Types" %} Contains two `HotelReservationID`: `ResID_Type="14"` for the PMS reservation identifier and `ResID_Type="29"` for the original booking reference from the source system (GDS confirmation, wholesaler booking ID, etc.). ```xml < ``` {% endtab %} {% tab title="SiteMinder Modification/Cancellation" %} Contains two `HotelReservationID`: `ResID_Type="14"` for the PMS reservation identifier and `ResID_Type="25"` for the SiteMinder reservation reference that links back to the original channel booking previously distributed through SiteMinder. ```xml ``` {% endtab %} {% endtabs %}

Element / @Attribute	Type	M	Description
`HotelReservationIDs`	Element	0..1	A collection of `HotelReservationID` objects for a given reservation.
`HotelReservationID`	Element	0..n	The `HotelReservationID` object contains various unique (reservation ID) and non unique (confirmation ID, cancellation ID) identifiers that the trading partners associate with a given reservation.
`@ResID_Type`	Integer	1	`14` to identify the `ResID_Value` is the reservation ID from your PMS. `29` to identify the `ResID_Value` is the reservation ID from the Booking Channel. For more information about the different `ResID_Type` Codes, refer to OpenTravel Code List (Unique ID Types).
`@ResID_Value`	String	1	This is the actual value associated with `ResID_Type`
`@ResID_Source`	String	0..1	A unique identifier to indicate the source system which generated the `ResID_Value`.

### Profiles ```xml Mrs. Ginny Adeline Woolf Jr. Ph.D. Virginia.Woolf@hotmail.com

125 Pitt Street Sydney 2000 New South Wales Australia Dalloway

Dalloway 88 Pall Mall London SW1Y 5ER England United Kingdom info@dalloway.co.uk Mr. Warren Glass Smith II M.D.

88 Pall Mall London SW1Y 5ER England United Kingdom

Phillip.Glass-Smith@dalloway.co.uk ```

Element / @Attribute	Type	M	Description
`Profiles`	Element	0..1	Contains the profile information.
`ProfileInfo`	Element	1..n	Contains the profiles.
`UniqueID`	Element	0..9	A unique ID for a profile. This element can repeat to accommodate multiple unique IDs for a single profile across multiple systems.
`@Type`	Integer	1	A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT).
`@ID`	Integer	1	A unique identifying 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`	String	0..1	Used to identify the source of the identifier.
`Profile`	Element	1	Provides detailed information regarding either a company or a customer profile.
`@ProfileType`	Integer	1	Code to specify a profile such as Customer, Corporation, etc. Refer to OpenTravel Code List Profile Type (PRT).
`@ShareAllOptOutInd`	Boolean	0..1	Customer has 'opted out' of receiving marking information (Non EU).
`@ShareAllMarketInd`	Boolean	0..1	Customer has 'opted in' to receive marking information (EU Customers).
`Customer`	Element	1	Detailed customer information for this profile.
`@VIP_Indicator`	Boolean	0..1	If true, indicates a very important person.
`@CustomerValue`	String	0..1	The supplier's ranking of the customer (e.g., VIP, numerical ranking).
`@BirthDate`	DateTime	0..1	The customer’s birthday information.
`PersonName`	Element	0..1	Detailed name information for the customer.
`@Language`	String	0..1	The language code for which the name data is represented.
`@NameType`	Integer	0..1	Former, Nickname, Alternate, etc. Refer to OpenTravel Codes List - Name Type (NAM).
`NamePrefix`	Element	0..3	Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.)
`GivenName`	Element	0..5	Given name, first name or names.
`MiddleName`	Element	0..3	The middle name of the person name.
`Surname`	Element	1	Family or last name.
`NameSuffix`	Element	0..3	Name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.)
`NameTitle`	Element	0..5	Degree or honours (e.g., Ph.D., M.D.)
`Telephone`	Element	0..5	Information on a telephone number for the customer.
`@PhoneLocationType`	Integer	0..1	Describes the location of the phone, such as Home, Office, Property Reservation Office, etc. Refer to OpenTravel Code List - Phone Location Type (PLT).
`@PhoneTechType`	Integer	0..1	Indicates the type of technology associated with this telephone number, such as Voice, Data, Fax, Pager, Mobile, TTY, etc. Refer to OpenTravel Code List - Phone Technology Type (PTT).
`@PhoneNumber`	String	1	Telephone number assigned to a single location.
`@CountryAccessCode`	Integer	0..1	Code assigned by telecommunications authorities for international country access identifier.
`@AreaCityCode`	Integer	0..1	Code assigned for telephones in a specific region, city, or area.
`@FormattedInd`	Boolean	0..1	Specifies if the associated data is formatted or not. When true, then it is formatted; when false, then not formatted.
`@DefaultInd`	Boolean	0..1	When true, indicates a default value should be used.
`@Remark`	String	0..1	A remark associated with the telephone number.
`Email`	Element	0..5	Information on an email address for the customer.
`@EmailType`	Integer	0..1	Defines the purpose of the e-mail address (e.g. personal, business, listserve). Refer to OpenTravel Code List - Email Address Type (EAT).
`@DefaultInd`	Boolean	0..1	When true, indicates a default value should be used.
`Address`	Element	0..5	Detailed information on an address for the customer.
`@Type`	Integer	0..1	Defines the type of address (e.g. home, business, other). Refer to OpenTravel Code List - Communication Location Type (CLT).
`AddressLine`	Element	0..5	These lines will contain free form address details.
`CityName`	Element	0..1	City (e.g., Dublin), town, or postal station.
`StateProv`	Element	0..1	State, province, or region name.
`@StateCode`	String	0..1	The standard code or abbreviation for the state, province, or region.
`PostalCode`	Element	0..1	Post Office Code number.
`CountryName`	Element	0..1	Country name (e.g., Ireland).
`@Code`	String	0..1	`ISO 3166` code for a country.
`Email`	Element	0..5	Information on an email address for the contact person for the company.
`@EmailType`	Integer	0..1	Defines the purpose of the e-mail address (e.g. personal, business, listserve). Refer to OpenTravel Code List Email Address Type (EAT).
`@DefaultInd`	Boolean	0..1	When true, indicates a default value should be used.

### TotalCommission ```xml Booking agent reservation commission - flat rate. ```

Element / @Attribute	Type	M	Description
`TotalCommissions`	Element	0..1	Contains details pertaining to commissions.
`UniqueID`	Element	0..1	Identifies the recipient of the commission.
`@Type`	Integer	1	A unique identifying 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`	String	1	A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List - Unique ID Type (UIT).
`CommissionPayableAmount`	Element	0..1	The amount of commission to be paid.
`@CurrencyCode`	String	0..1	Use `ISO 4217` currency codes.
`@Amount`	Decimal	0..1	A monetary amount.
`Comment`	Element	0..1	Holds the actual comment.
`Text`	Element	1	The content of the comment related to the commission.

### BasicPropertyInfo {% code overflow="wrap" %} ```xml ``` {% endcode %}

Element / @Attribute	Type	M	Description
`BasicPropertyInfo`	Element	1	Property information for the reservation.
`@ChainCode`	String	0..1	The code that identifies a hotel chain or management group. The hotel chain code is decided between vendors.
`@BrandCode`	String	0..1	A code that identifies the brand or flag of a hotel, often used for independently owned or franchised properties that are known by a specific brand.
`@HotelCode`	String	1	The code that uniquely identifies a single hotel property. The hotel code is decided between vendors.
`@HotelName`	String	0..1	A text field used to communicate the proper name of the hotel.

## 2. Confirmation Response SiteMinder's response determines the next steps for your integration. Understanding these outcomes is critical for proper error handling and retry logic. * **Successful Delivery**: If SiteMinder responds with `` and returns the SiteMinder Reservation ID (`UniqueID` `Type="14"`) and Payment Context ID (`UniqueID` `Type="34"`) the reservation is successfully stored.. * **Error in Delivery**: If SiteMinder responds with `` containing an error description, the reservation must be retained in your PMS retry cycle and resent after resolving the error. If retry cycle expires, manual intervention may be required. * **Connectivity Issues**: If no response received due to network outages the reservation must be retained in your retry cycle and resent once connectivity is restored. If retry cycle expires, manual intervention may be required. {% tabs %} {% tab title="Success" %} ```xml

``` {% endtab %} {% tab title="Success + Warning" %} ```xml

Missing last name

``` {% endtab %} {% tab title="Error" %} ```xml

Authentication timed out

``` {% endtab %} {% endtabs %}

Element / @Attribute	Type	M	Description
`OTA_HotelResNotifRS`	Element	1	Root element for the response.
`@xmlns`	String	1	Defines the XML namespace for the request. Will be set to `http://www.opentravel.org/OTA/2003/05`
`@EchoToken`	String	1	Unique identifier for the request, used to match requests and responses. Preferred format: UUID `8-4-4-4-12`.
`@TimeStamp`	DateTime	1	Time when the response was generated. `TimeStamp` must use `ISO 8601` format.
`@Version`	String	1	Specifies the API version. Will be set to `1.0`.
`@ResResponseType`	String	0..1	Given that the `OTA_HotelResNotifRQ` message is used for additions, modifications and cancellations, this attribute is used to replicate whether the original message was an addition, a modification or a cancellation and does not refer to the status of the transaction itself but rather to the nature of the original message. The only three enumerations allowed are: `Committed` `Modified` `Cancelled`.
`Errors`	Element	0..1	Indicates an error occurred during the processing of the request.
`Error`	Element	1..n	Single error information containing free text.
`@Type`	Integer	1	Type of error. Refer to Error Warning Types (EWT).
`@Code`	Integer	0..1	Code representing the error. Refer to Error Codes (ERR).
`@RecordID`	Integer	0..1	If the receiving system is able to identify within a batch of reservations which reservation failed, the `UniqueID` of the rejected reservation should be reported here.
`Success`	Element	0..1	Annotation that the reservation batch was received successfully. Mandatory if no `Errors` were sent. It can be combined with `Warnings` messages if some of the reservations in the batch had issues.
`Warnings`	Element	0..1	Only can be used in conjunction with a `Success` message.
`Warning`	Element	0..99	Contains details of the warning returned.
`@Type`	Integer	1	Type of error. Refer to Error Warning Types (EWT).
`@Code`	Integer	0..1	Code representing the error. Refer to Error Codes (ERR).
`@RecordID`	Integer	0..1	If the receiving system is able to identify within a batch of reservations which reservation has a warning, the `UniqueID` of that reservation should be reported here.
`HotelReservations`	Element	1	Contains details of the reservation made.
`HotelReservation`	Element	1	Individual hotel reservation information.
`@ResStatus`	String	0..1	Indicates the current status of the reservation. Valid values are dependent on the roles: `Reserved` `Waitlisted` `In-house` `Checked-Out`
`UniqueID`	Element	1..2	Unique identifier for the reservation.
`@Type`	String	1	`14` - Reservation ID `34` - SM Platform Res ID
`@ID`	String	1	Actual confirmation number.

## Reservation XML Samples

Maximum Content XML

{% code overflow="wrap" %} ```xml

USERNAMEPASSWORD

PMS NAMEBooking Channel NameDeluxe Room with a lovely view over the harbour and a seperate lounge with 50" LED TVThis room is a Deluxe Corner RoomWeekend Package includes wine, chocolates, champagne on arrival and late checkout at 3PMChampagne on arrival, English Breakfast, Chocolates and 3PM Checkout Some parts of this package (such as wine selection) will need to be arranged with guest prior to check-inGSTGSTGSTGSTLeonard WoolfCombined Guarantees Accepted (Platinum Membership)Leonard WoolfCredit Card surcharge.30% deposit (of the total cost of the stay) will be charged to card holder's account 10 days before the date of arrival at the latest.

12 Pine StreetSydney2095New South WalesAustralia

Payment surcharge.10% deposit (of the total cost of the stay) will be charged using provided Voucher code 10 days before the date of arrival at the latest.

12 Pine StreetSydney2095New South WalesAustralia

Payment surcharge.20% deposit (of the total cost of the stay) will be charged using Direct Bill ID provided 10 days before the date of arrival at the latest.

125 Pitt StreetSydney2000New South WalesAustralia

GSTStay 2 nights and get 15% off.GSTInsurance Premium TaxPlatinum Members are offered a free spa entry for the whole length of stay.King Split + Single Bed.Non-smoking room.GSTCar space needs to be released before 3PM check-out day. No exceptions allowed.Accessible, covered and secured vehicle storage space.Service chargeFrench manicure - Platinum Members are offered a free pedicure.Manicure and pedicure set.Mrs.GinnyAdelineWoolfJr.Ph.D.virginia.woolf@example.com

125 Pitt StreetSydney2000New South WalesAustraliaDalloway

Dalloway88 Pall MallLondonSW1Y 5EREnglandUnited Kingdominfo@example.comMr.WarrenGlassSmithIIM.D.

88 Pall MallLondonSW1Y 5EREnglandUnited Kingdom

phillip.glass-smith@example.comAircon offNo flowers - pollen allergy.Mr.WillyBradshawwbradshaw@example.com

3 Hunter StreetSydney2025New South WalesAustralia

Orlando175B George StreetSydney2000New South WalesAustraliainfo@example.comDisability - accessible room and parking space necessary.Business tripPlease make sure your chef Leonard is on duty during our stay, thanks.Leonard WoolfCombined Guarantees Accepted (Platinum Membership)Leonard WoolfCredit Card surcharge.30% deposit (of the total reservation cost) will be charged to card holder's account 10 days before the date of arrival at the latest.

12 Pine StreetSydney2095New South WalesAustralia

Payment surcharge.10% deposit (of the total reservation cost) will be charged using provided Voucher code 10 days before the date of arrival at the latest.

12 Pine StreetSydney2095New South WalesAustralia

Payment surcharge.20% deposit (of the total reservation cost) will be charged using Direct Bill ID provided 10 days before the date of arrival at the latest.

125 Pitt StreetSydney2000New South WalesAustralia

GSTInsurance Premium TaxService charge - manicureMr.LeoDarcyWoolfRet.BAleonardowoolf59@example.com

12 Pine StreetSydney2095New South WalesAustralia

Asterix360C Bergen StreetNew York - Brooklyn11238New YorkUnited Statessupport@example.comMs.ElleMariaVanHoffJr.M.D.

360C Bergen StreetNew York - Brooklyn11238New YorkUnited States

elle.vanhoff@example.comBooking agent reservation commission - flat rate.

``` {% endcode %}

Minimum Recommended Content XML

{% code overflow="wrap" %} ```xml

USERNAMEPASSWORD

PMS NAMEGinnyWoolfvirginia.woolf@example.comWillyBradshawwbradshaw@oexample.comLeoWoolfleonardowoolf59@example.com

``` {% endcode %}

{% hint style="success" icon="sparkles" %} ## Still have questions? Use the **Ask** button at the top of the page to chat with our AI assistant — it can help you navigate the guide, understand requirements, and troubleshoot issues. If you need more support, visit [Integration Support](/integration-support/integration-support.md). {% endhint %} --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://developer.siteminder.com/pmsxchange-api/reference/reservations/upload.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.