Skip to main content

Quote

Quotes are the prices that are sent to the guest for a given reservation of a property.

Fields​

PropertyQuote​

FieldTypeDescription
propertyIdstringUnique identifier for the property.
numberOfGuestsnumberNumber of guests.
totalPricenumberTotal price for the quote.
currencystringCurrency of the total price.
arrivalDatestringArrival date for the stay.
departureDatestringDeparture date for the stay.
basePriceobjectBase price details.
feeobjectFee details.
taxobjectTax details.
discountobjectDiscount details.
loyaltyPointsobjectLoyalty points details.

BasePriceBreakdown​

FieldTypeDescription
namestringOptional. Name of the price component.
descriptionstringOptional. Description of the component.
typeBasePriceTypeOptional. Type of the base price.
unitsnumberOptional. Number of units.
totalnumberOptional. Total amount.
isMandatorybooleanOptional. Whether the price is mandatory.

BasePriceType Enum​

  • BASE_PRICE
  • PRICE_PER_GUEST

FeeBreakdown​

FieldTypeDescription
namestringOptional. Name of the fee.
descriptionstringOptional. Description of the fee.
typeFeeTypeOptional. Type of fee.
unitsnumberOptional. Number of units.
totalnumberOptional. Total amount of the fee.
isMandatorybooleanOptional. Whether the fee is mandatory.

FeeType Enum​

  • (All the fee types listed in the interface)

TaxBreakdown​

FieldTypeDescription
namestringOptional. Name of the tax.
descriptionstringOptional. Description of the tax.
typeTaxTypeOptional. Type of tax.
unitsnumberOptional. Number of units.
totalnumberOptional. Total amount of the tax.
isMandatorybooleanOptional. Whether the tax is mandatory.

TaxType Enum​

  • VAT_GST
  • SALES_TAX
  • HOTEL_TAX
  • LODGING_TAX
  • TRANSIENT_OCCUPANCY_TAX
  • CITY_TOURISM_TAX
  • ROOM_TAX
  • OTHER_TAX

DiscountBreakdown​

FieldTypeDescription
namestringOptional. Name of the discount.
descriptionstringOptional. Description of the discount.
typeDiscountTypeOptional. Type of discount.
unitsnumberOptional. Number of units.
totalnumberOptional. Total amount of the discount.
isMandatorybooleanOptional. Whether the discount is mandatory.

DiscountType Enum​

  • WEEKLY_DISCOUNT
  • MONTHLY_DISCOUNT
  • EMPLOYEE_DISCOUNT
  • LAST_MINUTE_DISCOUNT
  • SHAREHOLDER_DISCOUNT
  • OTHER_DISCOUNT

LoyaltyPointsBreakdown​

FieldTypeDescription
namestringOptional. Name of the loyalty points component.
descriptionstringOptional. Description of the component.
typeLoyaltyPointsTypeOptional. Type of loyalty points.
unitsnumberOptional. Number of units.
totalnumberOptional. Total number of points.
isMandatorybooleanOptional. Whether the component is mandatory.

LoyaltyPointsType Enum​

  • CREDIT_POINTS
  • REWARD_POINTS
  • OTHER_POINTS

Supported Methods​

  1. Get a Quotes of the Property