AvailableProperty
property_idrate_planName of the rate plan with the lowest price for the stay.
Amounts in euro.
AvailablePropertyAmounts
stayPrice of the stay (sum of the price items that make the price, discounts subtracted).
totalTotal of all the price_items (discounts subtracted).
undiscounted_totalTotal before the discounts, the sum of the price_items with a positive amount. Equal to total when there are no discounts; undiscounted_total minus total is the amount of the discounts, so it can be shown as the price before and after the discount.
The items that make the price (rent, cleaning, discounts, ...), in the order of the pricing engine. Their amounts add up to total.
PriceItem
typeType of the price item (for example prenotazione, the rent). The values are the names of the price components of the installation; there is no catalog of them yet, so do not rely on a fixed list.
amountAmount of the item, negative for discounts (the amounts of all the items add up to amounts.total).
PropertyAvailability
property_idrate_planName of the rate plan used for the calendar.
One entry per date from from to to, in ascending order.
AvailabilityDay
dateDay, YYYY-MM-DD.
availabletrue when the property can be booked on this day with the rate plan (bookings, blocks, rules and prices all taken into account).
min_stayMinimum number of nights for a stay that starts this day (1 when the rate plan sets no minimum). null only when restrictions are not available.
max_stayMaximum number of nights for a stay that starts this day. null when there is no maximum or restrictions are not available.
arrival_allowedWhether a stay can start (check-in) on this day: false when the rate plan rules or a block forbid arrivals this day. null only when restrictions are not available.
departure_allowedWhether a stay can end (check-out) on this day: false when the rate plan rules or a block forbid departures this day. null only when restrictions are not available.
RatePlan
codeName of the rate plan, the {ratePlan} of the availability and rates calls.
nameDescription of the rate plan.
min_guestsMinimum number of guests the rate plan accepts.
max_guestsMaximum number of guests the rate plan accepts.
typeWhat the price of /api/v1/rate-plans/{ratePlan}/rates means for this rate plan: per_night, the price of one night; fixed, one flat amount for a stay inside a period, whatever the number of nights.
RateProperty
property_idrate_planName of the rate plan used.
rate_plan_typeType of the rate plan used (the type of /api/v1/rate-plans): it says what price means.
Periods with prices, in ascending order of date; days without a price are not covered by any period. Never empty.
RatePeriod
fromFirst day of the period, YYYY-MM-DD.
toLast day of the period (inclusive), YYYY-MM-DD. Periods are cut to the from-to range of the request; for a fixed rate plan the flat price is the one of the whole period of the rate plan all the same.
Price by number of guests, valid for every day of the period, in ascending order of guests. Never empty. Consecutive numbers of guests with the same price share a row. A number of guests with no price has no row, so the ranges may not be contiguous.
GuestPrice
min_guestsSmallest number of guests this price applies to.
max_guestsLargest number of guests this price applies to (inclusive).
priceIn euro, by the type of the rate plan (rate_plan_type). per_night: total price of one night for that number of guests (not a supplement), the price of the rate plan for that night, as the SOAP getListino gives it: the components added by the application when a stay is quoted (offers, cleaning fees) are not included, so GET /api/v1/search/available-properties with guests can give a different total. fixed: one flat amount for a stay inside the period for that number of guests, whatever the number of nights; a percentage supplement for extra guests increases it, a supplement in euro (charged per night) is not included. price is what a stay of the whole period pays: when the channel markup is rounded (e.g. up to the euro), the rounding applies to each night, so a shorter stay inside the period can pay a slightly different total. Periods of the rate plan that overlap are not repeated: on the days they share, the period that starts later wins (on the same start, the one that ends first).

