Rental Fees

Retrieve Rental Fees for the Inventory or specific Unit

Overview

The Rental Fees request allows partners to retrieve the Rental Fees associated with the Inventory or a specific unit. This request returns standard fees configured by the Property Manager, including Cleaning Fees, Booking Fees, and additional fees related to guest services, such as Pool Heat charges.

By utilizing the Rental Fees request, partners gain valuable insights into the fee structure set by the PM, which will provide accurate and transparent quotes to guests while streamlining the booking process.

📘
Calculating Booking Fee
When calculating the Booking Fee during the quoting process, use the following formula:
Rental Rate + Cleaning Fee + Pool Heat (if applicable) + Sum of any Mandatory Extras (if applicable) = X
X * Booking Fee (%) OR + Booking Fee (Flat) = Booking Fee Total

Endpoints Available

Method	Endpoint	Description
GET	v2023.07.31/rates/fees	Retrieve Rental Extras for Inventory
GET	v2023.07.31/rates/fees/{unitId}	Retrieve Rental Extras for Unit in Inventory

Path Parameters

Path Parameter	Required / Optional	Description
{unitId}	Required	Unique Identifier for Unit in Inventory

Query String Parameters

Parameter	Required / Optional	Description	Data Type
page	Optional	The page to be shown	int
pageSize	Optional	Limits the number of returned results	int
lastUpdateDate	Optional	Only return objects which have been modified after a certain date	date-time
mcUserId	Optional	Unique Identifier for Supplier	int
mcUserIds	Optional	Unique Identifiers for Suppliers	array
unitId	Optional	Unique Identifier for Unit in Inventory	int
unitIds	Optional	Unique Identifier for Units in Inventory	array
airbnb	Optional	Return additional context information relating to Airbnb	boolean

Response Definition

Response Item	Description	Data Type
`"units"`	This is an array containing unit information. Each element of the array represents a unit with specific details.	array

`"units"` Object

Response Item	Description	Data Type
`"unit_id"`	Unique Identifier for Unit in Inventory	int
`"fees"`	An array containing details about various fees associated with the unit	array
`"mc_user_id"`	Unique Identifier for Supplier	int

`"fees"` Object

Response Item	Description	Data Type
`"unit_id"`	Unique Identifier for Unit in Inventory	int
`"fee_type"`	A string representing the type of fee	string
`"amount"`	The amount of the fee	long
`"rate_decimal_places"`	The number of decimal places in the `"amount"` value	int
`"applicable_taxes"`	An array containing details about taxes applicable to the unit's fees	array
`"airbnb_fee_type"`**	A special attribute related to Airbnb's specific fee types	string
`"stay_duration"`*	An object containing information about the stay duration for the Pool Heat Fee	object

`"applicable_taxes"` Object

Response Item	Description	Data Type
`"tax_type"`	The type of tax applied to the fees, e.g., "TAX_ONE" "TAX_TWO" or "TAX_THREE"	string

`"stay_duration"` Object

Response Item	Description	Data Type
`"min"`	The minimum stay duration required for the unit to charge Pool Heat	int

📘
Response Items notaed with '*' will only be returned when "fee_type": "POOL_HEAT_FEE" is applied to the Unit
Response Items notaed with '**' will only be returned when using 'airbnb' Query Parameter set as
"True"

Sample Request

curl --request GET \
     --url 'https://api.ciiruspartners.com/v2023.07.31/rates/fees?page=1&pageSize=50&airbnb=true'

Sample Response

{
    "units": [        
				{
            "unit_id": 219264,
            "fees": [
                {
                    "unit_id": 219264,
                    "fee_type": "CLEANING_FEE",
                    "amount": 17200,
                    "rate_decimal_places": 2,
                    "applicable_taxes": [
                        {
                            "tax_type": "TAX_ONE"
                        },
                        {
                            "tax_type": "TAX_TWO"
                        },
                        {
                            "tax_type": "TAX_THREE"
                        }
                    ],
                  	"airbnb_fee_type": "PASS_THROUGH_CLEANING_FEE"
                },
                {
                    "unit_id": 219264,
                    "fee_type": "POOL_HEAT_FEE",
                    "amount": 3500,
                    "rate_decimal_places": 2,
                    "applicable_taxes": [
                        {
                            "tax_type": "TAX_ONE"
                        },
                        {
                            "tax_type": "TAX_TWO"
                        },
                        {
                            "tax_type": "TAX_THREE"
                        }
                    ],
                    "stay_duration ": {
                        "min": 3
                    }
                }
            ],
            "mc_user_id": 42330
        },
      ...
    ],
    "next_page_url": "https://api.ciiruspartners.com/v20230731/rates/fees?page=2&pageSize=50",
    "total_page_count": 2
}

Updated 3 months ago