Skip to main content

Rates File

The Rates file defines the rules under which rooms will be sold. It defines the commercial configuration of each rate plan: booking conditions, cancellation policies, and surcharges.

Purpose​

This file is used to define:

  • rate code and name
  • associated hotel
  • board plan
  • market scope
  • payment method
  • fine details of commercial rules
  • cancellation policies
  • surcharges

Example​

Download the example Rates file (CSV)

Understanding complex fields​

Because CSVs are flat, we use specific delimiters (, and |) to send lists inside a single cell.

1. baseCancelPolicy​

Single object β€” the pipe | delimiter is not needed.

  • Format: refundable,daysBeforeArrival,penaltyType,value
  • Example: false,0,PERCENTAGE,100.0
  • Meaning: non-refundable, 0 days, percentage penalty, 100%.

2. cancelPoliciesByDate​

List of objects β€” separate different date ranges with a pipe |.

  • Format: start,end,refundable,daysBeforeArrival,penaltyType,value | start,end...
  • Example: 2026-06-01,2026-06-30,true,7,NIGHTS,1.0|2026-07-01,2026-08-31,true,14,PERCENTAGE,50.0
  • Meaning: one policy for June (7 days notice, 1 night penalty), and another for July-August (14 days notice, 50% penalty).

3. surcharges​

List of objects β€” separate different surcharges with a pipe |.

  • Format: chargeType,taxType,value,applyType,perNight,perPax | chargeType...
  • Example: EXCLUDED,CITY,2.5,AMOUNT,true,true|EXCLUDED,RESORT_FEE,5.0,PERCENTAGE,false,false
  • Meaning: a city tax of 2.5 applied per night and per person, plus a 5% resort fee applied once per stay. Neither is included in the price.
ElementDescription
chargeTypeWhether the surcharge is included in the price: INCLUDED or EXCLUDED.
taxTypeType of tax: CITY, LOCAL, RESORT_FEE, or SUPPLEMENT_TO_BE_PAID_ON_SPOT.
valueValue of the surcharge.
applyTypeHow the value is applied: AMOUNT or PERCENTAGE.
perNighttrue if the surcharge applies per night.
perPaxtrue if the surcharge applies per person.

Field definitions​

FieldTypeDescription
rateCodeStringUnique code of the rate plan.
rateNameStringCommercial name of the rate.
hotelCodeStringHotel to which the rate belongs.
activeBooleanIndicates whether the rate is active.
boardStringMeal or board plan, such as BB, RO, HB, or FB.
childMaxAgeIntegerMaximum age considered a child.
infantMaxAgeIntegerMaximum age considered an infant.
infantsStayFreeBooleanWhether infants stay free of charge.
childrenStayFreeBooleanWhether children stay free of charge.
priceCurrencyStringCurrency for rate pricing.
commissionDecimalCommission or commercial margin applied.
priceBindingBooleanWhether the rate is tied to fixed or bound pricing.
paymentTypeStringPayment model, for example MERCHANT.
cardTypeStringAccepted card types.
bookingWindowStartDateDateStart date of the booking window.
bookingWindowEndDateDateEnd date of the booking window.
includedMarketsStringMarkets that are included in the rate.
excludeMarketsStringMarkets excluded from the rate.
rateRuleStringCommercial rule classification.
seniorRuleStringSenior-specific rule or condition.
baseCancelPolicyStringBase cancellation policy in compact structured format.
cancelPoliciesByDateStringCancellation policies applied by date range.
surchargesStringAdditional taxes or fees applied to the rate.

Notes​

This file is the commercial layer of the integration. It complements the hotel and room structure and is applied together with the restrictions and pricing files to define the final selling logic.