Unit Rental
Retrieve Rental Rates for the inventory or specific unit
Overview
The Unit Rental request is designed to provide partners with the ability to access Rental Rates for either the Inventory or a specific unit, which allows partners to efficiently manage pricing in their application and offer accurate Rental Rates to potential guests.
Through the Unit Rental request, partners can retrieve comprehensive and up-to-date information about the Rental Rates associated with a unit.
Endpoints Available
| Method | Endpoint | Description |
|---|---|---|
| GET | v2024.07.31/unit_rental | Retrieve Rental Rates for units in the inventory. |
| GET | v2024.07.31/unit_rental/{unit_id} | Retrieve Rental Rates 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 |
| start | Required | The desired start date for the rental rates. | date-time |
| end | Required | The desired end date for the rental rates. | date-time |
| maximum_future_days | Optional | Maximum future days for LOS. | int |
| fallback_rates | Optional | Use length of stay pricing if available. | 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_rental" | An array containing rate details for a specific Unit. Each element in the array represents a rate set associated with the Unit | array |
"unit_rental" Object
"unit_rental" 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 |
"rental" | An object containing details about the rates for the unit. | object |
"rental" Object
"rental" Object| Response Item | Description | Data Type |
|---|---|---|
"rate_set_id" | The unique identifier for the rate set being returned for the date range. | int |
"start" | The start date of the "rental" period | string |
"end" | The end date of the "rental" period | string |
"iso_currency" | The ISO 4217 currency code (e.g., "USD") for all monetary values. | string |
"currency_exchanges" | An array containing details about currency exchanges for the unit, if applicable. | array |
"rates" | An array containing rate details for the specified length. Each element in the array corresponds to one day starting from the "start" date. Values utilized by this endpoint use 10⁸ fixed-point format (e.g. 5500000000= 55). | array |
"settings" | An array containing daily booking rules including minimum/maximum stay, gap rules, and allowed arrival/departure days. One entry per day. | int |
"applicable_taxes" | An array containing a list of tax names that apply to the "rental" "rates" (can be empty). | array |
"rate_set_details" | An array containing detailed configuration of the rate set, including markup, inclusions, and display settings. | array |
"settings" Object
"settings" Object| Response Item | Description | Data Type |
|---|---|---|
"booking_fence" | The minimum number of days in advance required before a booking can be made (0 = same-day bookings allowed). | int |
"gap_days" | The required gap days before or after a booking (0 = no gap required). | int |
"minimum_nights" | The minimum number of nights allowed for a stay on this day. | int |
"maximum_nights" | The maximum number of nights allowed for a stay on this day (0 = no maximum). | int |
"arrival_days" | The days of the week allowed for check-in (e.g., "monday", "tuesday"). | array[string] |
"departure_days" | The days of the week allowed for check-out (e.g., "monday", "tuesday"). | array[string] |
Note: There will be multiple
"settings"objects in the array. These represent rules for each day over the requested date range.
"rate_set_details" Object
"rate_set_details" Object| Response Item | Description | Data Type |
|---|---|---|
"agent_daily_markup" | The flat daily markup applied by the booking agent, in currency units (e.g., 0.00 = no markup). | decimal |
"agent_rate_factor" | The multiplier used by agents to adjust rates (1.0 = no adjustment). | decimal |
"management_company_rate_factor" | The multiplier used by the management company to adjust base rates (1.0 = no adjustment). | decimal |
"includes_tax" | Indicates whether the returned rates include taxes (true) or not (false). | boolean |
"ciirus_percentage" | The percentage retained by CiiRUS, if applicable. Usually 0.00 for partner-facing APIs. | decimal |
"include_mandatory_extras" | Indicates whether the agent should include mandatory extras in the quotes (true) or not (false). | boolean |
"days_in_month" | The number of days in the month being evaluated (used for prorated calculations or monthly rates). | int |
If a 0 appears in the
"rates"array, this was defined by the Property Manager. Please contact the PM and request they populate this data. As long as a rateband has been defined (even as 0) for the date period of a reservation and the user has set the property to be bookable online, the property can be booked and the quote will be calculated based on the defined rates.
Sample Request
curl --location 'https://api.ciiruspartners.com/v2024.07.31/unit_rental?page=1&page_size=25&management_company_user_id=42330&start=2025-01-01&end=2025-12-31' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic {APIUsername:APIPassword}' \
Sample Response
{
"unit_rental": [
{
"unit_id": 219264,
"management_company_user_id": 42330,
"rental": {
"rate_set_id": 75114,
"start": "2025-01-01",
"end": "2025-12-31",
"iso_currency": "USD",
"currency_exchanges": [],
"rates": [
5500000000,
5500000000,
5500000000,
5500000000
],
"settings": [
{
"booking_fence": 0,
"gap_days": 0,
"minimum_nights": 1,
"maximum_nights": 0,
"arrival_days": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday",
"sunday"
],
"departure_days": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday",
"sunday"
]
},
],
"applicable_taxes": [
"tax_one",
"tax_two"
],
"rate_set_details": {
"agent_daily_markup": 0.00,
"agent_rate_factor": 1.00,
"management_company_rate_factor": 1,
"includes_tax": false,
"ciirus_percentage": 0.00,
"include_mandatory_extras": true,
"days_in_month": 28
}
}
},
],
"paging": {
"next_page_url": "https://api.ciiruspartners.com/v2024.07.31/unit_rental?page=1&page_size=25&management_company_user_id=42330&start=2025-01-01&end=2025-12-31",
"total_page_count": 13,
"page": 1,
"page_size": 25
}
}
Updated about 1 month ago