Overview

The Unit Taxes 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	v2024.07.31/unit_taxes	Retrieve unit taxes for units in the inventory.
GET	v2024.07.31/unit_taxes/{unit_id}	Retrieve unit taxes for a specific 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 a unit in the inventory.	int
unit_ids	Optional	Unique identifiers for multiple units in the inventory.	array
management_company_user_id	Optional	Unique identifier for a specific supplier of inventory.	int
management_company_user_ids	Optional	Unique identifiers for multiple suppliers of inventory.	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 which are the representative unit in their group.	boolean

Response Definition

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

`"unit_taxes"` Object

Response Item	Description	Data Type
`"unit_id"`	The unique identifier for the unit in the inventory.	int
`"management_company_user_id"`	The unique identifier for the supplier of the unit.	int
`"taxes"`	A list of tax objects associated with the rental unit, specifying tax information. May be empty if no taxes apply.	array[objects]
`"error"`*	An error object, present if the unit could not be processed.	object## `"taxes"` Object

Response Item	Description	Data Type
`"name"`	The display name or label of the tax.	string
`"value"`	The numerical value of the tax, representing the tax rate or amount. Values utilized by this endpoint use 10⁸ fixed-point format (e.g. 750000000 = 7.5).	int
`"value_type"`	The type of tax value (typically will be `"percentage"`.	string
`"tax_type"`	A classification or category of the tax type.	string

`"error"` Object

Response Item	Description	Data Type
`"message"`	An error message indicating the reason for a failed request or why the unit could not be processed (e.g. `"Property has been deleted."`	string

Sample Request

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

Sample Response

{
    "unit_taxes": [
        {
            "unit_id": 219264,
            "management_company_user_id": 42330,
            "taxes": [
                {
                    "name": "Sales Tax",
                    "value": 750000000,
                    "value_type": "percentage",
                    "tax_type": "tax_one"
                },
                {
                    "name": "Tourist Tax",
                    "value": 600000000,
                    "value_type": "percentage",
                    "tax_type": "tax_two"
                }
            ]
        },
        {
            "unit_id": 219265,
            "management_company_user_id": 42330,
            "taxes": [
                {
                    "name": "Sales Tax",
                    "value": 700000000,
                    "value_type": "percentage",
                    "tax_type": "tax_one"
                },
                {
                    "name": "Tourist Tax",
                    "value": 500000000,
                    "value_type": "percentage",
                    "tax_type": "tax_two"
                }
            ]
        },
        {
            "unit_id": 219266,
            "management_company_user_id": 42330,
            "taxes": [
                {
                    "name": "Sales Tax",
                    "value": 650000000,
                    "value_type": "percentage",
                    "tax_type": "tax_one"
                },
                {
                    "name": "Tourist Tax",
                    "value": 600000000,
                    "value_type": "percentage",
                    "tax_type": "tax_two"
                }
            ]
        },
        {
            "unit_id": 219267,
            "management_company_user_id": 42330,
            "taxes": [
                {
                    "name": "Sales Tax",
                    "value": 650000000,
                    "value_type": "percentage",
                    "tax_type": "tax_one"
                },
                {
                    "name": "Tourist Tax",
                    "value": 600000000,
                    "value_type": "percentage",
                    "tax_type": "tax_two"
                }
            ]
        },
        {
            "unit_id": 219268,
            "management_company_user_id": 42330,
            "taxes": [
                {
                    "name": "Sales Tax",
                    "value": 650000000,
                    "value_type": "percentage",
                    "tax_type": "tax_one"
                },
                {
                    "name": "Tourist Tax",
                    "value": 600000000,
                    "value_type": "percentage",
                    "tax_type": "tax_two"
                }
            ]
        }
    ],
    "paging": {
        "next_page_url": "https://api.ciiruspartners.com/v2024.07.31/unit_taxes?page=2&page_size=25",
        "total_page_count": 6,
        "page": 1,
        "page_size": 25
    }
}