Sign in

v1

latestOpenAPI 3.0.32026-07-2672165314.6 KB
Reservations

Gets a quote

get/v2/quote/{propertyId}

Path parameters

propertyIdinteger required

Property identifier

Query parameters

arrivalstring date-time

Arrival date

departurestring date-time

Departure date

idinteger

The unique identifier of the room type.

peopleinteger

Deprecated. Use GuestBreakdown.Adults instead.

Room type details

idinteger

The unique identifier of the add-on.

unitsinteger nullable

The number of units selected for the add-on, if applicable.

Optional add-ons to include in Quote

promotionCodestring

Optional promotion code to apply to Quote

Response

OK

total_including_vatnumber double nullable

The total amount including Value Added Tax (VAT).

total_excluding_vatnumber double nullable

The total amount excluding Value Added Tax (VAT).

total_vatnumber double nullable

The total Value Added Tax (VAT) amount.

property_idinteger

The unique identifier of the property associated with the quote.

date_arrivalstring date-time

The scheduled arrival date.

date_departurestring date-time

The scheduled departure date.

currency_codestring nullable

The ISO currency code (e.g., USD, EUR) used for the quote.

add_ons_subtotalnumber double

The subtotal amount for all selected add-ons.

rate_policy_user_idinteger nullable

The identifier of the rate policy.

security_depositnumber double

The amount required for the security deposit.

total_scheduled_paymentsnumber double

The total amount of all scheduled payments.

total_to_collect_manuallynumber double

The total amount that needs to be collected manually.

amount_grossnumber double

The gross amount for the quote.

rental_agreementstring uuid nullable

The unique identifier for the rental agreement.

cancellation_policy_textstring nullable

The text description of the cancellation policy.

security_deposit_textstring nullable

The text description of the security deposit requirements.

is_verificationboolean

Indicates whether this quote requires a credit card verification before creating a reservation.