Overview

The Rental Taxes request on the rates endpoint allows the Agent to retrieve tax percentages for rental properties in the Inventory or for specific units managed by the Property Manager. These tax percentages are essential for accurately calculating the total rental cost, ensuring compliance with local tax regulations, and providing transparency to guests regarding additional charges.

Endpoints Available

Method	Endpoint	Description
GET	v2023.07.31/rates/taxes	Retrieve Rental Taxes for Inventory
GET	v2023.07.31/rates/taxes/{unitId}	Retrieve Rental Taxes 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

Response Definition

Response Item	Description	Data Type
`"units"`	A list of rental units in the inventory	array

`"units"` Object

Response Item	Description	Data Type
`"unit_id"`	Unique Identifier for Unit in Inventory	int
`"taxes"`	A list of tax objects associated with the rental unit, specifying tax information	array
`"error_message"`*	An error message indicating the reason for a failed request or operation (if applicable)	string
`"error_code"`*	An error code associated with the specific error message (if applicable)	string
`"mc_user_id"`	Unique Identifier for the Supplier	int

`"taxes"` Object

Response Item	Description	Data Type
`"name"`	The name or label of the tax	string
`"value"`	The numerical value of the tax, representing the tax rate or amount	float
`"value_type"`	The type of tax value, which could be "PERCENTAGE" or "AMOUNT	string
`"tax_type"`	A classification or category of the tax (e.g., "TAX_ONE", "TAX_TWO", TAX_THREE)	string

Sample Request

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

Sample Response

"units": [
        {
            "unit_id": 219264,
            "taxes": [
                {
                    "name": "Sales Tax",
                    "value": 7.500,
                    "value_type": "PERCENTAGE",
                    "tax_type": "TAX_ONE"
                },
                {
                    "name": "Tourist Tax",
                    "value": 6.000,
                    "value_type": "PERCENTAGE",
                    "tax_type": "TAX_TWO"
                }
            ],
            "mc_user_id": 30620
        }
     ],
    "next_page_url": "https://api.ciiruspartners.com/v20230731/rates/taxes?page=2&pageSize=50",
    "total_page_count": 2