Overview

The Unit Quotes request provides functionality that allows the Agent to generate a detailed quote for units in the inventory or for a specific unit and date range. By making this request, partners can receive comprehensive information about the pricing and availability of a property during the specified time frame.

The Unit Quotes API allows partners to calculate costs for potential reservations accurately. It takes into account various factors, such as rates, taxes, and any additional fees associated with the Booking.

Endpoints Available

Method	Endpoint	Description
POST	v2024.07.31/unit_quotes	Generate a Quote for a specific Unit and date range
POST	v2024.07.31/unit_quotes/{unit_id}	Generate multiple Quotes for Units and date ranges

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	The unique identifier for a unit in the inventory.	int
unit_ids	Optional	The unique identifiers for multiple units in the inventory.	array[int]
management_company_user_id	Optional	The unique identifier for a supplier of units in the inventory.	int
management_company_user_ids	Optional	The unique identifiers for multiple suppliers of units in the inventory.	array[int]
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	Specify the channel to quote as.	string
fallback_rates	Optional	Use length of stay pricing if available.	boolean

Body Parameters

Parameter	Required / Optional	Description	Data Type
`"id"`	Optional	The unique internal identifier for the quote request. Useful when updating an existing quote.	int
`"management_company_user_id"`	Optional	The unique identifier for the property management company generating the quote.	int
`"unit_id"`	Optional	The unique identifier for the rental unit being quoted.	int
`"reference"`	Optional	The external reference string for the quote.	string
`"type"`	Optional	The type of the quote.	string
`"details"`	Required	An object containing the full details of the quote, including dates, guest info, financials, and more.	object
`"financials"`	Optional	Object containing pricing, payments, and charge info.	object
`"last_modified"`	Optional	The timestamp of the last change to this quote.	date-time
`"error"`	Optional	Returns only if an error occurs when processing the quote.	object

`"details"` Object Body Parameters

Parameter	Required / Optional	Description	Data Type
`"quote_as_super_site_user_id"`	Optional	If quoting as a different user, specify their user ID here.	int
`"arrival"`	Required	A value specifying the arrival date for the quote.	date-time
`"departure"`	Required	A value specifying the departure date for the quote.	date-time
`"added"`	Optional	A value representing the date-time the quote was generated.	date-time
`"expiration"`	Optional	A value representing hen the quote will expire if not confirmed.	date-time
`"cancelled_on"`	Optional	If the quote was canceled, this holds the cancellation date and time.	date-time
`"scenario"`	Optional	Used to control how the quote is viewed or calculated.	int
`"comments"`	Optional	A list of internal or external comments added to the quote.	array[objects]
`"guests"`	Optional	An array of guest records included in the quote.	array[objects]
`"number_of_adults"`	Optional	The total number of adult guests.	int
`"number_of_children"`	Optional	The total number of child guests.	int
`"number_of_pets"`	Optional	The total number of pets.	int
`"category"`	Optional	The reservation category name.	array
`"category_id"`	Optional	The reservation category ID.	int
`"category_description"`	Optional	The internal category name.	string
`"calendar_sync_category_id"`	Optional	The category ID for calendar sync.	int
`"secure_details"`	Optional	Object containing access codes and guest instructions.	array
`"early_check_in"`	Optional	A flag indicating whether early check-in is included or not.	boolean
`"late_check_out"`	Optional	A flag indicating whether late check-out is included or not.	boolean
`"arrival_departure_info"`	Optional	Notes about arrival and departure.	string
`"owner_reservation"`	Optional	A flag indicating if it's an owner's reservation or not.	boolean
`"source"`	Optional	The source of the quote. It indicates the origin or provider of the quote.	string
`"thread_id"`	Optional	Unique identifier for the conversation thread. Used to associate the Quote with a specific conversation or thread.	string
`"airbnb_confirmation_code"`	Optional	Airbnb confirmation code.	string
`"unit_name"`	Optional	The unit name that is being quoted.	string

`"comments"` Object Body Parameters

Parameter	Required / Optional	Description	Data Type
`"text"`	Optional	The text to add to the comment.	string
`"type"`	Optional	The type of comment to include.	string

`"guests"` Object Body Parameters

Parameter	Required / Optional	Description	Data Type
`"id"`	Optional	The CRM ID of the guest.	int
`"type"`	Optional	The type of guest.	string
`"title"`	Optional	The guests' title (Mr., Ms., etc).	string
`"first_name"`	Optional	The guest's first name.	string
`"last_name"`	Optional	The guest's last name.	string
`"age"`	Optional	The age of the guest.	int
`"phone_numbers"`	Optional	A list of phone numbers for the guest.	array[strings]
`"email_addresses"`	Optional	A list of email addresses for the guest.	array[strings]
`"address"`	Optional	The guest's physical address details.	object
`"notes"`	Optional	Internal notes about the guest.	string
`"allow_marketing_emails"`	Optional	A flag indicating whether marketing emails are allowed or not.	boolean
`"airbnb_guest_id"`	Optional	The Airbnb guest ID.	string

`"address"` Object Body Parameters

Parameter	Required / Optional	Description	Data Type
`"address_line_1"`	Optional	The primary street address for the lead guest.	string
`"address_line_2"`	Optional	The secondary address information, if applicable (e.g., unit, suite number).	string
`"city"`	Optional	The city where the guest's address is located.	string
`"state_province"`	Optional	The state or province where the guest's address is located.	string
`"country"`	Optional	The country where the guest's address is located in ISO 3166 (alpha-2) format.	string
`"postal_code"`	Optional	The postal code of the guest's address.	string

`"secure_details"` Object Body Parameters

Parameter	Required / Optional	Description	Data Type
`"lock_box_code"`	Optional	Code for lock box access.	string
`"gate_code"`	Optional	Code for gate access.	string
`"alarm_code"`	Optional	Code for alarm access.	string
`"wifi_ssid"`	Optional	Wifi network name.	string
`"wifi_password"`	Optional	Wifi password.	string
`"lobby_code"`	Optional	Code for lobby access.	string
`"fitness_room_code"`	Optional	Code for fitness room access.	string
`"pool_access_code"`	Optional	Code for pool access.	string
`"beach_access_code"`	Optional	Code for beach access.	string
`"door_code"`	Optional	Code for door access.	string

`"financials"` Object Body Parameters

Parameter	Required / Optional	Description	Data Type
`"rate_set_id"`	Optional	The ID of the rate set used to calculate pricing.	int
`"length_of_stay"`	Optional	A flag indicating whether length-of-stay rules were applied or not.	boolean
`"pool_heat"`	Optional	A flag indicating whether pool heat was requested or not.	boolean
`"discount_code"`	Optional	An optional discount code applied to the reservation.	string
`"currency"`	Optional	The currency of the quote.	string
`"merchant_of_record"`	Optional	Specifies the merchant of record.	string
`"merchant_of_record_user"`	Optional	The user ID of the entity acting as the merchant of record.	int
`"charges"`	Optional	An array containing details about individual charges associated with the quote. Each element in the array represents a specific charge item, such as Rental Rate, Clean Fee, Taxes, or Extra Fees	array[objects]
`"total_amount"`	Optional	Total amount for the reservation. Values utilized by this endpoint use 10⁸ fixed-point format (e.g. 5500000000= 55).	int
`"payments"`	Optional	An array containing records of payments already applied.	array[objects]
`"payment_schedule"`	Optional	An array containing details about the payment schedule if booked.	array[objects]
`"total_paid"`	Optional	The total amount paid by the guest.	int
`"total"`	Optional	Total amount for the reservation. Values utilized by this endpoint use 10⁸ fixed-point format (e.g. 5500000000= 55).	int
`"payment_taken_by"`	Optional	The User ID of the party that accepted the payment.	int
`"merchant_grantee_agent"`	Optional	(Optional) Agent user ID receiving merchant rights.	int
`"merchant_grantee_supplier"`	Optional	(Optional) Supplier user ID receiving merchant rights.	int

`"charges"` Object Body Parameters

Response Item	Required / Optional	Description	Data Type
`"item"`	Optional	The label or description of the charge (e.g., `"Rental Rate"`).	string
`"id"`	Optional	(Optional) ID associated with the charge.	int
`"code"`	Optional	A code representing the charge item.	string
`"applies_to_item"`	Optional	(Optional) Name of the item this charge applies to (for taxes).	string
`"applies_to_id"`	Optional	(Optional) ID of the item this charge applies to (for taxes).	string
`"quantity"`	Optional	The quantity of the charge item. Usually `1`.	int
`"type"`	Optional	The internal classification of the charge (e.g., `rental`, `tax_one`).	string
`"value"`	Optional	The amount for the item. Values utilized by this endpoint use 10⁸ fixed-point format (e.g. 5500000000= 55).	int

`"payments"` Object Body Parameters

Parameter	Required / Optional	Description	Data Type
`"amount"`	Optional	The amount for the payment. Values utilized by this endpoint use 10⁸ fixed-point format (e.g. 5500000000= 55).	int
`"payment_date"`	Optional	The timestamp of when the payment was made.	date-time

`"payment_schedule"` Object Body Parameters

Parameter	Required / Optional	Description	Data Type
`"amount"`	Optional	The scheduled payment amount. Values utilized by this endpoint use 10⁸ fixed-point format (e.g. 5500000000= 55).	int
`"due_date"`	Optional	The timestamp of when the payment is due.	date-time

Response Definition

Response Item	Description	Data Type
`"unit_id"`	The unique identifier for the unit associated with the quote.	int
`"type"`	Always set to `"quote"` for successful results.	string
`"management_company_user_id"`	The unique identifier for the supplier associated with the quote.	int
`"details"`	An object containing specific details related to the booking	object
`"financials"`	An object containing financial details related to the booking	object

`"details"` Object

Response Item	Description	Data Type
`"arrival"`	The arrival date for the quote.	string
`"departure"`	The departure date for the quote.	string
`"added"`	The timestamp of when the quote was generated.	date-time
`"expiration"`	When the quote expires and is no longer valid.	date-time
`"guests"`	List of guests with their roles and names.	array
`"number_of_adults"`	The number of adults included in the booking	int
`"number_of_children"`	The number of children included in the booking	int
`"number_of_pets"`	The number of pets included in the booking	int
`"category_id"`	The reservation category ID.	int
`"early_check_in"`	A flag indicating whether early check-in is included or not.	boolean
`"late_check_out"`	A flag indicating whether late check-out is included or not.	boolean
`"owner_reservation"`	A flag indicating if it's an owner's reservation or not.	boolean

`"guests"` Object

Response Item	Description	Data Type
`"type"`	Role of the guest (e.g., `"lead_guest"`).	string
`"first_name"`	First name of the guest.	string

`"financials"` Object

Response Item	Description	Data Type
`"rate_set_id"`	The ID of the rate set used to calculate pricing.	int
`"length_of_stay"`	A flag indicating whether length-of-stay rules were applied or not.	boolean
`"pool_heat"`	A flag indicating whether pool heat was requested or not.	boolean
`"currency"`	The currency of the quote.	string
`"charges"`	An array containing details about individual charges associated with the quote. Each element in the array represents a specific charge item, such as Rental Rate, Clean Fee, Taxes, or Extra Fees	array
`"payment_schedule"`	An array containing details about the payment schedule if booked.	array
`"total_value"`	Total amount for the reservation, in fixed-point format (÷100,000,000).	int
`"payment_taken_by"`	ID of the user or system that took the payment (0 = none).	int

`"charges"` Object

Response Item	Description	Data Type
`"item"`	The label or description of the charge (e.g., `"Rental Rate"`).	string
`"code"`	A code representing the charge item.	string
`"applies_to_item"`	(Optional) Name of the item this charge applies to (for taxes).	string
`"applies_to_id"`	(Optional) ID of the item this charge applies to (for taxes).	string
`"quantity"`	The quantity of the charge item. Usually `1`.	int
`"type"`	The internal classification of the charge (e.g., `rental`, `tax_one`).	string
`"value"`	The amount for the item in micro-units (÷100,000,000).	int

`"payment_schedule"` Object

Response Item	Description	Data Type
`"value"`	The total amount of the scheduled payment in micro-units (÷100,000,000).	int
`"value_due"`	The outstanding amount due.	int
`"payment_type"`	Type of payment (e.g., `down_payment`, `scheduled_payment`).	string
`"payment_status"`	The status of the `"value"` (e.g., `"due"`).	string
`"due_date"`	The due date for the payment schedule - ISO 8601 date-time format	string

Sample Request (Units)

curl --location 'https://api.ciiruspartners.com/v2024.07.31/unit_quotes?page=1&page_size=25' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic {APIUsername:APIPassword}' \
--data '{
  "details": {
    "arrival": "2026-06-12",
    "departure": "2026-06-15"
  }
}
'

Sample Request (Unit)

curl --location 'https://api.ciiruspartners.com/v2024.07.31/unit_quotes/219264' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic {APIUsername:APIPassword}' \
--data '{
  "details": {
    "arrival": "2026-06-12",
    "departure": "2026-06-15"
  },
  "unit_id": 219264
}'

Sample Response

{
    "unit_quotes": [
        {
            "unit_id": 219264,
            "type": "quote",
            "management_company_user_id": 42330,
            "details": {
                "arrival": "2026-06-12T16:00:00",
                "departure": "2026-06-15T10:00:00",
                "added": "2025-05-05T20:33:50.9272254Z",
                "expiration": "2025-05-05T00:00:00+00:00",
                "guests": [
                    {
                        "type": "lead_guest",
                        "first_name": "Adult 1"
                    }
                ],
                "number_of_adults": 1,
                "number_of_children": 0,
                "number_of_pets": 0,
                "category_id": 16,
                "early_check_in": false,
                "late_check_out": false,
                "owner_reservation": false
            },
            "financials": {
                "rate_set_id": 75114,
                "length_of_stay": false,
                "pool_heat": false,
                "currency": "USD",
                "charges": [
                    {
                        "item": "Rental Rate",
                        "quantity": 1,
                        "type": "rental",
                        "value": 16500000000
                    },
                    {
                        "item": "Clean Fee",
                        "quantity": 1,
                        "type": "clean_fee",
                        "value": 20000000000
                    },
                    {
                        "item": "Clean Fee Tax 1",
                        "applies_to_item": "Clean Fee",
                        "quantity": 1,
                        "type": "tax_one",
                        "value": 1500000000
                    },
                    {
                        "item": "Clean Fee Tax 2",
                        "applies_to_item": "Clean Fee",
                        "quantity": 1,
                        "type": "tax_two",
                        "value": 1200000000
                    },
                    {
                        "item": "Booking Fee",
                        "quantity": 1,
                        "type": "clean_fee",
                        "value": 300000000
                    },
                    {
                        "item": "Booking Fee Tax 1",
                        "applies_to_item": "Booking Fee",
                        "quantity": 1,
                        "type": "tax_one",
                        "value": 23000000
                    },
                    {
                        "item": "Booking Fee Tax 2",
                        "applies_to_item": "Booking Fee",
                        "quantity": 1,
                        "type": "tax_two",
                        "value": 18000000
                    },
                    {
                        "item": "Example Fee 1",
                        "code": "Fee1",
                        "applies_to_id": "7417",
                        "quantity": 1,
                        "type": "extra",
                        "value": 495000000
                    },
                    {
                        "item": "Example Fee 1 Tax 1",
                        "applies_to_item": "Example Fee 1",
                        "quantity": 1,
                        "type": "tax_one",
                        "value": 37000000
                    },
                    {
                        "item": "Example Fee 1 Tax 2",
                        "applies_to_item": "Example Fee 1",
                        "quantity": 1,
                        "type": "tax_two",
                        "value": 30000000
                    },
                    {
                        "item": "Example Fee 2",
                        "code": "Fee2",
                        "applies_to_id": "7418",
                        "quantity": 1,
                        "type": "extra",
                        "value": 1000000000
                    },
                    {
                        "item": "Example Fee 2 Tax 1",
                        "applies_to_item": "Example Fee 2",
                        "quantity": 1,
                        "type": "tax_one",
                        "value": 75000000
                    },
                    {
                        "item": "Example Fee 2 Tax 2",
                        "applies_to_item": "Example Fee 2",
                        "quantity": 1,
                        "type": "tax_two",
                        "value": 60000000
                    },
                    {
                        "item": "Example Fee 5",
                        "code": "Fee5",
                        "applies_to_id": "7421",
                        "quantity": 1,
                        "type": "extra",
                        "value": 500000000
                    },
                    {
                        "item": "Accidental Damage Insurance",
                        "code": "ADI",
                        "applies_to_id": "21728",
                        "quantity": 1,
                        "type": "extra",
                        "value": 7500000000
                    },
                    {
                        "item": "Property Protection Fee",
                        "code": "CP-STD",
                        "applies_to_id": "25011",
                        "quantity": 1,
                        "type": "extra",
                        "value": 6500000000
                    }
                ],
                "payment_schedule": [
                    {
                        "value": 100000000,
                        "value_due": 100000000,
                        "payment_type": "down_payment",
                        "payment_status": "due",
                        "due_date": "2025-05-05T00:00:00Z"
                    },
                    {
                        "value": 55638000000,
                        "value_due": 55638000000,
                        "payment_type": "scheduled_payment",
                        "payment_status": "due",
                        "due_date": "2026-04-17T00:00:00"
                    }
                ],
                "total_value": 55738000000,
                "payment_taken_by": 1
            }
        },
        {
            "management_company_user_id": 0,
            "error": {
                "message": "{\"message\":\"Unit is not available for 3 nights. Valid stays: 0\"}"
            }
        },
       ],
       "paging": {
        "next_page_url": "https://api.ciiruspartners.com/v2024.07.31/unit_quotes?page=2&page_size=25",
        "total_page_count": 3,
        "page": 1,
        "page_size": 25
    }
}

Overview

Endpoints Available

Path Parameters

Query String Parameters

Body Parameters

"details" Object Body Parameters

"comments" Object Body Parameters

"guests" Object Body Parameters

"address" Object Body Parameters

"secure_details" Object Body Parameters

"financials" Object Body Parameters

"charges" Object Body Parameters

"payments" Object Body Parameters

"payment_schedule" Object Body Parameters