Overview

The Unit Quote Options endpoint allows partners to retrieve quote configuration details for units managed within the CiiRUS system. This includes information on pool and spa heating options, cleaning and booking fees, tax configurations, and other settings relevant to generating accurate quotes for guests.

Endpoints Available

Method	Endpoint	Description
GET	v2024.07.31/unit_quotes	Retrieve quote options for units in the inventory.
GET	v2024.07.31/unit_quotes/{unit_id}	Retrieve quote options for a specified unit in the inventory.

Path Parameters

Path Parameter	Required / Optional	Description
{unit_id}	Required	Unique Identifier for a unit in the inventory.

Query String Parameters

Parameter	Required / Optional	Description	Data Type
page	Optional	The page to be shown (defaults to 1).	int
page_size	Optional	Limits the number of returned results (defaults to 25).	int
last_unit_update_date	Optional	Only return units that have been modified after the specified date.	date-time
last_reservation_update_date	Optional	Only return units that have received a booking (their own or a calendar sync) after the specified date.	date-time
last_agent_module_property_update_date	Optional	Only return units that have had their agent module property configuration modified after the specified date.	date-time
last_agent_module_agent_update_date	Optional	Only return units that have had their agent module agent configuration modified after the specified date.	date-time
unit_id	Optional	Unique Identifier for Unit in Inventory	int
unit_ids	Optional	Unique Identifiers for Units in Inventory	array
management_company_user_id	Optional	Unique Identifier for Supplier	int
management_company_user_ids	Optional	Unique Identifiers for Suppliers	array
enabled	Optional	Use only enabled or disabled units.	boolean
deleted	Optional	Only show properties that are deleted or not deleted.	boolean
display_on_website	Optional	Only show properties that are enabled for the management company's website.	boolean
allocation_on_arrival	Optional	Return the allocation on arrival object.	boolean
allocation_on_arrival_unit	Optional	Return units that are the representative unit in their group.	boolean
channel	Optional	Leave empty for general, "airbnb" for airbnb, "vrbo" for vrbo and "bdc" for bdc	string

Response Definition

Response Item	Description	Data Type
`"unit_quote_options"`	Each item in the `unit_quote_options` array contains detailed configuration data for a specific unit:	array[objects]

`"unit_quote_options"` Object

Response Item	Description	Data Type
`"unit_id"`	The unique identifier for the unit.	int
`"management_company_user_id"`	The unique ID of the management company that owns or manages the unit.	int
`"pool_heatable"`	A flag indicating whether the pool is heatable (`true`) or not (`false`).	boolean
`"pool_heat_included"`	A flag indicating whether the pool heat is included in the base rate (`true`) or not (`false`).	boolean
`"pool_heat_weekly"`	A flag indicating whether pool heat is charged on a weekly basis (`true`) or not (`false`).	boolean
`"pool_heat_minimum_days"`	The minimum number of days required for pool heating.	int
`"pool_heat_daily_price"`	The daily price for pool heat (in fixed-point format).	int
`"pool_heat_weekly_price"`	The weekly price for pool heat (in fixed-point format).	int
`"percent_of_clean_fee_to_management_company_on_management_company_booking"`	The percentage of the cleaning fee paid to the management company for their own bookings.	int
`"percent_of_clean_fee_to_management_company_on_owner_booking"`	The percentage of the cleaning fee paid to the management company on owner bookings.	int
`"management_company_pool_heat_amount_method_on_management_company_bookings"`	The pricing method used for pool heat on management company bookings.	int
`"management_company_pool_heat_amount_on_management_company_bookings"`	The pool heat amount for management company bookings (in fixed-point format).	int
`"management_company_pool_heat_amount_method_on_owner_bookings"`	The pricing method used for pool heat on owner bookings.	int
`"management_company_pool_heat_amount_on_owner_bookings"`	The pool heat amount for owner bookings (in fixed-point format).	int
`"spa"`	A flag indicating whether the unit has a spa (`true`) or not (`false`).	boolean
`"spa_heat_included"`	A flag indicating whether spa heat is included in the rental price (`true`) or not (`false`).	boolean
`"spa_heat_weekly"`	A flag indicating whether spa heat is charged on a weekly basis (`true`) or not (`false`).	boolean
`"spa_heat_minimum_days"`	The minimum number of days required for spa heating.	int
`"spa_heat_daily_price"`	The daily price for spa heat (in fixed-point format).	int
`"spa_heat_weekly_price"`	The weekly price for pool heat (in fixed-point format).	int
`"private_pool"`	A flag indicating if the unit has a private pool (`true`) or not (`false`).	boolean
`"private_pool_heatable"`	A flag indicating whether the private pool is heatable (`true`) or not (`false`).	boolean
`"charge_security_deposit"`	A flag indicating whether a security deposit is required (`true`) or not (`false`).	boolean
`"allow_csa_insurance"`	A flag indicating whether CSA insurance is allowed for this unit (`true`) or not (`false`).	boolean
`"security_deposit_amount"`	The Security deposit amount (in fixed-point format).	int
`"charge_cleaning_fee"`	Indicates if a cleaning fee is charged (0 = no, -1 = yes).	int
`"cleaning_fee_amount"`	The cleaning fee amount (in fixed-point format).	int
`"charge_booking_fee"`	Indicates if a cleaning fee is charged (0 = no, 1 = yes).	int
`"charge_booking_fee_only_when_credit_card"`	A flag indicating whether the booking fee is only charged for credit card payments (`true`) or not (`false`).	boolean
`"booking_fee_amount"`	The booking fee amount (in fixed-point format).	int
`"online_bookings_down_payment_setting"`	The configuration setting for how down payments are calculated.	int
`"online_bookings_down_payment_c1"`	Down payment amount or percentage (based on setting - in fixed-point format).	int
`"deposit_percent_to_include_optional_extras"`	A flag indicating whether the deposit percentage includes optional extras.	boolean
`"balance_due_weeks"`	The number of weeks before arrival when the balance is due (0 = Full payment on booking).	int
`"minimum_nights_stay"`	The minimum number of nights required per stay.	int
`"gap_days"`	The minimum number of gap days required between reservations.	int
`"days_valid_for"`	The number of days a quote remains valid.	int
`"tax_included"`	A flag indicating whether taxes are included in the rate (`true`) or not (`false`).	boolean
`"tax_1_percent"`	The first tax rate percentage.	decimal
`"tax_2_percent"`	The second tax rate percentage.	decimal
`"tax_3_percent"`	The third tax rate percentage.	decimal
`"total_tax_percent"`	The combined tax percentage.	decimal
`"charge_tax_1_on_rental_rate"`	A flag indicating whether tax 1 applies to the rental rate (`true`) or not (`false`).	boolean
`"charge_tax_2_on_rental_rate"`	A flag indicating whether tax 2 applies to the rental rate (`true`) or not (`false`).	boolean
`"charge_tax_3_on_rental_rate"`	A flag indicating whether tax 3 applies to the rental rate (`true`) or not (`false`).	boolean
`"charge_tax_1_on_booking_fee"`	A flag indicating whether tax 1 applies to the booking fee (`true`) or not (`false`).	boolean
`"charge_tax_2_on_booking_fee"`	A flag indicating whether tax 2 applies to the booking fee (`true`) or not (`false`).	boolean
`"charge_tax_3_on_booking_fee"`	A flag indicating whether tax 3 applies to the booking fee (`true`) or not (`false`).	boolean
`"charge_tax_1_on_cleaning_fee"`	A flag indicating whether tax 1 applies to the cleaning fee (`true`) or not (`false`).	boolean
`"charge_tax_2_on_cleaning_fee"`	A flag indicating whether tax 2 applies to the cleaning fee (`true`) or not (`false`).	boolean
`"charge_tax_3_on_cleaning_fee"`	A flag indicating whether tax 3 applies to the cleaning fee (`true`) or not (`false`).	boolean
`"charge_tax_1_on_pool_heat"`	A flag indicating whether tax 1 applies to pool heat (`true`) or not (`false`).	boolean
`"charge_tax_2_on_pool_heat"`	A flag indicating whether tax 2 applies to pool heat (`true`) or not (`false`).	boolean
`"charge_tax_3_on_pool_heat"`	A flag indicating whether tax 3 applies to pool heat (`true`) or not (`false`).	boolean
`"default_check_in_time"`	The default check-in time (HH:mm:ss format).	date-time
`"default_check_out_time"`	The default check-out time (HH:mm:ss format).	date-time
`"currency_symbol"`	The symbol of the currency used for pricing.	string
`"short_stay_daily_rate_threshold"`	The threshold in days for short-stay daily rate adjustment.	int
`"short_stay_daily_rate_factor"`	The factor used to calculate the short-stay daily rate.	int
`"long_stay_daily_rate_factor"`	The factor used for long-stay daily rate calculations.	int
`"short_stay_clean_threshold"`	The minimum stay threshold under which additional cleaning rules may apply.	int
`"range_method"`	The method for how rental rate ranges are calculated.	int

Sample Request

curl --location 'https://api.ciiruspartners.com/v2024.07.31/unit_quotes?page=1&page_size=25' \
--header 'Authorization: Basic {APIUsername:APIPassword}'

Sample Response

{
    "unit_quote_options": [
        {
            "unit_id": 219264,
            "management_company_user_id": 45692,
            "pool_heatable": true,
            "pool_heat_included": false,
            "pool_heat_weekly": false,
            "pool_heat_minimum_days": 7,
            "pool_heat_daily_price": 2500000000,
            "pool_heat_weekly_price": 15000000000,
            "percent_of_clean_fee_to_management_company_on_management_company_booking": 0,
            "percent_of_clean_fee_to_management_company_on_owner_booking": 0,
            "management_company_pool_heat_amount_method_on_management_company_bookings": 1,
            "management_company_pool_heat_amount_on_management_company_bookings": 0,
            "management_company_pool_heat_amount_method_on_owner_bookings": 1,
            "management_company_pool_heat_amount_on_owner_bookings": 0,
            "spa": false,
            "spa_heat_included": false,
            "spa_heat_weekly": true,
            "spa_heat_minimum_days": 7,
            "spa_heat_daily_price": 0.00,
            "spa_heat_weekly_price": 0.00,
            "private_pool": true,
            "private_pool_heatable": true,
            "charge_security_deposit": true,
            "allow_csa_insurance": false,
            "security_deposit_amount": 5000000000,
            "charge_cleaning_fee": -1,
            "cleaning_fee_amount": 20000000000,
            "charge_booking_fee": 1,
            "charge_booking_fee_only_when_credit_card": false,
            "booking_fee_amount": 300000000,
            "online_bookings_down_payment_setting": 0,
            "online_bookings_down_payment_c1": 100000000,
            "deposit_percent_to_include_optional_extras": false,
            "balance_due_weeks": 8,
            "minimum_nights_stay": 1,
            "gap_days": 2,
            "days_valid_for": 30,
            "tax_included": false,
            "tax_1_percent": 7.500,
            "tax_2_percent": 6.000,
            "tax_3_percent": 0.000,
            "total_tax_percent": 13.500,
            "charge_tax_1_on_rental_rate": false,
            "charge_tax_2_on_rental_rate": false,
            "charge_tax_3_on_rental_rate": false,
            "charge_tax_1_on_booking_fee": true,
            "charge_tax_2_on_booking_fee": true,
            "charge_tax_3_on_booking_fee": false,
            "charge_tax_1_on_cleaning_fee": true,
            "charge_tax_2_on_cleaning_fee": true,
            "charge_tax_3_on_cleaning_fee": false,
            "charge_tax_1_on_pool_heat": true,
            "charge_tax_2_on_pool_heat": true,
            "charge_tax_3_on_pool_heat": false,
            "default_check_in_time": "16:00:00",
            "default_check_out_time": "10:00:00",
            "currency_symbol": "$",
            "short_stay_daily_rate_threshold": 5,
            "short_stay_daily_rate_factor": 7,
            "long_stay_daily_rate_factor": 7,
            "short_stay_clean_threshold": 5,
            "range_method": 0
        }, ...
    ],
    "paging": {
        "next_page_url": "https://api.ciiruspartners.com/v2024.07.31/unit_quotes?page=2&page_size=25&no_total=false",
        "total_page_count": 13,
        "page": 1,
        "page_size": 25
    }
}