Submit your question using the contact form below to request a new article.

    Alternatively, Log a Service Request for assistance from our Customer Support Team.


    Booking Quote Request & Response for the Online API

    Information on the Booking Quote Request & Response for the RMS Online API.

    The booking quote requests allows for obtaining a quote for a specific online booking.

    Info

    The API will return a quote for a particular Rate Type regardless of any minimum or maximum length of stay restrictions. The developer should filter relevant Rate Types based on the minimum & maximum night restrictions returned as part of the RMSAvailRateChartRQ.


    Request Elements

    Element Name Parent Element Element Description Attributes Required
    RMSQuoteRQ   Root element.  Containing the request for a booking quote. Version - document version of the response schema. Yes
    AgentId RMSQuoteRQ The agent code of the RMS agent enquiring.   Yes
    RMSClientId RMSQuoteRQ The RMS Client Id of the property being searched.   Yes
    Test RMSQuoteRQ Optional element.  If present, points to the test data for a property   No
    Quotes RMSQuoteRQ Contains one or multiple booking quotes   Yes
    Quote Quotes Represents one booking quote   Yes
    QuoteItem Quote Contains details of the booking quote   Yes
    RoomTypeId QuoteItem The identity of the requested room types   Yes
    AreaId QuoteItem The identity of the requested area.   No
    UseAreaSpareFieldLookup QuoteItem If supplied, uses specified spare field to search for Area using the value in SpareFieldValue, Ignored if AreaId is supplied.   No
    AreaSpareFieldValue QuoteItem Value to search for in spare field.   No
    NoOfRooms QuoteItem Number of rooms required under this room type.  Optional element use either AreaId or NoOfRooms.   No
    Overridden QuoteItem Used if the price will be overridden manually or no price is required in RMSQuoteRS   No
    ChargeTypeId QuoteItem The identity of the charge type used against the booking.  Not required if Overridden element is present.  Exluding it will cause Price element in RMSQuoteRS to be blank.   Yes
    PromoCode QuoteItem Used to place a promotional discount against the price or Group Allotment name against the reservation   No
    PromoCodeSecond QuoteItem Used to place a second promotional discount against the price. Used in conjunction with PromoCode   No
    ArrivalDate QuoteItem The day which the guest will arrive.   Yes
    DepartureDate QuoteItem The day which the guest will depart.   Yes
    Adults QuoteItem Number of adults for rate calculation.   Yes
    Children QuoteItem Number of children for rate calculation.   Yes
    Infants QuoteItem Number of infants for rate calculation.   Yes
    Additionals1 QuoteItem Number of first additionals for rate calculation.   No
    Additionals2 QuoteItem Number of second additionals for rate calculation.   No
    Additionals3 QuoteItem Number of third additionals for rate calculation.   No
    Additionals4 QuoteItem Number of fourth additionals for rate calculation.   No
    Additionals5 QuoteItem Number of fifth additionals for rate calculation.   No
    RVLengthId QuoteItem Is optional and should only be used if they are provided   No
    RVTypeId QuoteItem Is optional and should only be used if they are provided   No
    RVSlide QuoteItem Is optional and should only be used if they are provided   No
    Requirements Quote Contains any additional requirements chosen by the guest.   No
    Requirement Requirements A specified additional requirment.   No
    Id Requirement The identifier of the requirement.   Yes - if providing Requirement
    Quantity Requirement The quantity of the requirement requested.   Yes - if providing Requirement
    Name Requirement The requirement name.

    Optional. If supplied will override RMS calculated value
      No
    Amount Requirement The amount charged for the requirement(s).

    Optional. If supplied will override RMS calculated value
      No
    Sundry_Id Requirement The identifier of the sundry charge associated.

    Optional. If supplied will override RMS calculated value
      No
    ExcludeAmountFromDeposit Requirement Should the Requirement Amount be Excluded from the Deposit Calculation

    Optional. If supplied will override RMS calculated value
      No
    From Requirement The date the requirement begins.  If left out it will default to the booking arrival.

    Optional. If left out it will default to the booking arrival.
      No
    To Requirement The date the requirement ends.  

    Optional - If left out it will default to the booking departure.
      No


    Example Request

    <RMSQuoteRQ>
      <RMSClientId>3038</RMSClientId>
      <AgentId>1</AgentId>
      <Quotes>
        <Quote>
          <QuoteItem>
            <RoomTypeId>1</RoomTypeId>
            <NoOfRooms>1</NoOfRooms>
            <ChargeTypeId>1</ChargeTypeId>
           <PromoCode>*DGetaway</PromoCode>
            <PromoCodeSecond>*DGetaway2</PromoCodeSecond>
         <BookingSourceId></BookingSourceId>
            <ArrivalDate>2018-01-25T00:00:00</ArrivalDate>
            <DepartureDate>2018-01-28T00:00:00</DepartureDate>
            <Adults>2</Adults>
            <Children>0</Children>
            <Infants>0</Infants>
            <Additionals1>0</Additionals1>
            <Additionals2>0</Additionals2>
            <Additionals3>0</Additionals3>
            <Additionals4>0</Additionals4>
            <Additionals4>0</Additionals4>
            <CurrencyId>5</CurrencyId>
          </QuoteItem>
          <Requirements>
            <Requirement>
              <Id>2</Id>
              <Quantity>1</Quantity>
              <Sundry_Id>3</Sundry_Id>
             <ExcludeAmountFromDeposit>true</ExcludeAmountFromDeposit>
              <Amount>15.00</Amount>
            </Requirement>
          </Requirements>
        </Quote>
      </Quotes>
    </RMSQuoteRQ>



    Response Elements

    Element Name Parent Element Element Description Attributes
    RMSQuoteRS   Root element.  Containing the response to a booking quote request. Version - document version of the response schema.
    UID RMSQuoteRS Unique identifier for the quote.  
    TotalTotal RMSQuoteRS Total charge for the tariff part of the quote excluding requirements and discounts.  
    TotalDiscount RMSQuoteRS Total of any discounts applied  
    TotalPrice RMSQuoteRS Total charge for the tariff part of the quote after discounts have been applied  
    TotalRequirements RMSQuoteRS Total charge for the requirements in the quote  
    TotalDeposit RMSQuoteRS Deposit required for the quote (includes tariff, requirements and any other fees)  
    TotalDepositTax RMSQuoteRS Total Tax for the tariff portion of the quote. Used in regions that require all taxes to be collected at the time of booking.

    Where this requirement does not exist, only the TotalDeposit amount is required
     
    TotalTax RMSQuoteRS The total tax amount of the totaltotal element.  
    BookingFee RMSQuoteRS The amount to charge for the booking fee.  
    CCFees RMSQuoteRS The amount to charge for the credit card fees.  
    Quotes RMSQuoteRS Contains quote responses for each quote sent in request.  
    Quote Quotes Specified Quote.  
    QuoteItem Quote Contains details of the booking Quote  
    RoomTypeId QuoteItem The identity of the requested room type.  
    AreaId QuoteItem The identity of the requested area.  Optional element use either AreaId OR NumberOfRooms.  
    NumberOfRooms QuoteItem Number of rooms required under this room type.  Optional element use either AreaId OR NumberOfRooms.  
    ChargeTypeId QuoteItem The identity of the charge type used against the booking.  
    BookingSourceId QuoteItem Identifier for the booking source for the request received.  
    ArrivalDate QuoteItem The day which the guest will arrive.  
    DepartureDate QuoteItem The day which the guest will depart.  
    Adults QuoteItem Number of adults for rate calculation.  
    Children QuoteItem Number of children for rate calculation.  
    Infants QuoteItem Number of infants for rate calculation.  
    Additionals1 QuoteItem Number of first additionals for rate calculation.  
    Additionals2 QuoteItem Number of second additionals for rate calculation.  
    Additionals3 QuoteItem Number of third additionals for rate calculation.  
    Additionals4 QuoteItem Number of fourth additionals for rate calculation.  
    Additionals5 QuoteItem Number of fifth additionals for rate calculation.  
    CurrancyId QuoteItem The identifier of the currency of the quote.  
    QuotedPrice Quotes Contains the quote detailed pricing.  
    Currency QuotedPrice The properties preferred currency.  
    OriginalPrice QuotedPrice The original amount before discounts (if any).  
    Tax QuotedPrice The tax portion of the quote.  
    Discount QuotedPrice The amount to be discounted from original Id = The identifier of the discount to be used in the BookingRQ
    Price QuotedPrice The price for the tariff part of the booking after discounts are applied.  
    Requirements QuotedPrice The price for the requirements of the booking.  
    Deposit QuotedPrice The deposit required for the booking  
    DepositTax QuotedPrice Tax element of the deposit required  
    DepositIncTax QuotedPrice Deposit amount plus tax  
    RefundableCharge QuotedPrice The amount refundable to the guest on arrival Name = The name of the refundable charge.
    NightlyBreakdown QuotedPrice    
    Night NightlyBreakdown Represents nightly rate of the booking quote.

    Id = Identifies the night entry

    Date = The date represented by the night of this entry

    Price = The nightly rate for this entry.

     

    Nightly breakdown of the element Price.

    Unavailable QuotedPrice This element will be present if quote request has no inventory to place a booking.  
    NoRate QuotedPrice This element will be present if quote request returns no rates for the specified period.  
    Requirements Quotes Contains any additional requirements chosen by the guest.  
    Requirement Requirements A specified additional requirement.  
    Id Requirement The identifier of the requirement.  
    Name Requirement The requirement name.  
    Quantity Requirement The quantity of the requirement requested.  
    Amount Requirement The amount charged for the requirement(s).  
    Sundry_Id Requirement The identifier of the sundry charge assosiated.  
    ExcludeAmountFromDeposit Requirement Should the Requirement Amount be Excluded from the Deposit Calculation  
    From Requirement The date the requirement begins.  If left out it will default to the booking arrival.  
    To Requirement The date the requirement ends.  If left out it will default to the booking departure.  



    Example Response

    <UID>10727874</UID>
      <TotalTotal>135.00</TotalTotal>
      <TotalDiscount>13.50</TotalDiscount>
      <TotalPrice>121.50</TotalPrice>
      <TotalRequirements>15.00</TotalRequirements>
      <TotalDeposit>14.80</TotalDeposit>
      <TotalDepositTax>0.00</TotalDepositTax>
      <TotalDepositIncTax>14.80</TotalDepositIncTax>
      <TotalTax>0.00</TotalTax>
      <BookingFee>2.50</BookingFee>
      <CCFees>0.15</CCFees>
      <Quotes>
        <Quote>
          <QuoteItem>
            <RoomTypeId>1</RoomTypeId>
            <NoOfRooms>1</NoOfRooms>
            <ChargeTypeId>1</ChargeTypeId>
            <PromoCode>*DGetaway</PromoCode>
            <PromoCodeSecond>*DGetaway2</PromoCodeSecond>
            <BookingSourceId></BookingSourceId>
            <ArrivalDate>2018-01-25T00:00:00</ArrivalDate>
            <DepartureDate>2018-01-28T00:00:00</DepartureDate>
            <Adults>2</Adults>
            <Children>0</Children>
            <Infants>0</Infants>
            <Additionals1>0</Additionals1>
            <Additionals2>0</Additionals2>
            <Additionals3>0</Additionals3>
            <Additionals4>0</Additionals4>
            <Additionals4>0</Additionals4>
            <CurrencyId>5</CurrencyId>
          </QuoteItem>
          <Requirements>
            <Requirement>
              <Id>2</Id>
              <Name>Full Breakfast</Name>
              <Quantity>1</Quantity>
              <Sundry_Id>3</Sundry_Id>
              <ExcludeAmountFromDeposit>true</ExcludeAmountFromDeposit>
              <Amount>15.00</Amount>
            </Requirement>
          </Requirements>
          <QuotedPrice>
            <CurrencySymbol>AUD</CurrencySymbol>
            <OriginalPrice>135.00</OriginalPrice>
            <Tax>0.00</Tax>
            <Discount Id="10">13.50</Discount>
            <DiscountSecond Id="11">0.00</DiscountSecond>
            <Price>121.50</Price>
            <Requirements>15.00</Requirements>
            <Deposit>12.15</Deposit>
            <DepositTax>0.00</DepositTax>
            <DepositIncTax>12.15</DepositIncTax>
            <RefundableCharge Name="">0.00</RefundableCharge>
            <NightlyBreakdown>
              <Night Id="1" Date="2018-01-25" Price="45.00" />
              <Night Id="2" Date="2018-01-26" Price="45.00" />
              <Night Id="3" Date="2018-01-27" Price="45.00" />
            </NightlyBreakdown>
          </QuotedPrice>
        </Quote>
      </Quotes>
    </RMSQuoteRS>


    Was this article helpful?

    Send Feedback

    Can’t find what you’re looking for?

    Our team of RMS experts are here for you!

    Submit a Question