Overview

The Rental Extras request is designed to provide partners with access to any additional fees or extras configured by the Property Manager for the available Inventory or a specific unit.

With the Rental Extras request, partners can retrieve detailed information about any additional fees that have been configured by the PM. These Rental Extras may encompass various charges, such as Property Protection Fees (PPF), Management Fees, Linen Fees, Credit Card Processing Fees (CC Fees), and other customized fees. Mandatory Rental Extras, which are configured with "fee_type": "MANDATORY_EXTRA", should always be included.

Endpoints Available

Method	Endpoint	Description
GET	v2023.07.31/rates/extras	Retrieve Rental Extras for Inventory
GET	v2023.07.31/rates/extras/{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 Identifiers for Units in Inventory	array

Response Definition

Response Item	Description	Data Type
`"units"`	An array containing Extras details about different units	array

`"units"` Object

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

`"extras"` Object

Response Item	Description	Data Type
`"extra_id"`	The unique identifier for the extra fee	int
`"per_day"`*	A flag indicating whether the extra fee is charged per day (true) or not (false) (if applicable)	boolean
`"per_guest"`	A flag indicating whether the extra fee is charged per guest (true) or not (false)	boolean
`"fee_type"`	The type of the extra fee, which can be "MANDATORY_EXTRA" or "OPTIONAL_EXTRA"	string
`"amount"`*	The amount of the extra fee (if applicable)	long
`"amount_to_vendor"`*	The amount to be paid to the vendor for the extra fee (if applicable)	long
`"amount_to_supplier"`*	The amount to be paid to the supplier for the extra fee (if applicable)	long
`"rate_decimal_places"`*	The number of decimal places in the `"amount"`values (if applicable)	int
`"applicable_taxes"`	An array containing details about applicable taxes for the extra fee. Each element in the array represents a specific tax type associated with the fee	array
`"item_code"`	The code representing the extra fee item	string
`"item_description"`	A description of the extra fee item	string
`"stay_duration"`*	An object containing details about the stay duration associated with the extra fee (if applicable)	object
`"percent"`*	The percentage value of the extra fee (if applicable)	float

`"applicable_taxes"` Object

Response Item	Description	Data Type
`"tax_type"`	The type of tax associated with the extra fee, 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 extra fee	int
`"max"`*	The maximum stay duration required for the extra fee	int

Sample Request

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

Sample Response

{
    "units": [
        {
            "unit_id": 219264,
            "extras": [
                {
                    "extra_id": 7417,
                    "per_guest": false,
                    "fee_type": "MANDATORY_EXTRA",
                    "applicable_taxes": [
                        {
                            "tax_type": "TAX_ONE"
                        },
                        {
                            "tax_type": "TAX_TWO"
                        },
                        {
                            "tax_type": "TAX_THREE"
                        }
                    ],
                    "item_code": "Fee1",
                    "item_description": "Example Fee 1",
                    "percent": 3.00
                },
                {
                    "extra_id": 7421,
                    "per_day": true,
                    "per_guest": false,
                    "fee_type": "OPTIONAL_EXTRA",
                    "amount": 1500,
                    "rate_decimal_places": 2,
                    "applicable_taxes": [
                        {
                            "tax_type": "TAX_ONE"
                        },
                        {
                            "tax_type": "TAX_TWO"
                        },
                        {
                            "tax_type": "TAX_THREE"
                        }
                    ],
                    "item_code": "Fee5",
                    "item_description": "Example Fee 5",
                    "stay_duration ": {
                        "min": 0
                    }
                },
                {
                    "extra_id": 24652,
                    "per_guest": true,
                    "fee_type": "OPTIONAL_EXTRA",
                    "amount": 70000,
                    "amount_to_vendor": 0,
                    "amount_to_supplier": 0,
                    "rate_decimal_places": 2,
                    "applicable_taxes": [
                        {
                            "tax_type": "TAX_THREE"
                        }
                    ],
                    "item_code": "GUEST",
                    "item_description": "Charge Per Guest Fee Example 1"
                },
                {
                    "extra_id": 21728,
                    "per_guest": false,
                    "fee_type": "MANDATORY_EXTRA",
                    "amount": 7500,
                    "amount_to_vendor": 0,
                    "amount_to_supplier": 0,
                    "rate_decimal_places": 2,
                    "applicable_taxes": [
                        {
                            "tax_type": "TAX_THREE"
                        }
                    ],
                    "item_code": "ADI",
                    "item_description": "Accidental Damage Insurance"
                },
                {
                    "extra_id": 25011,
                    "per_guest": false,
                    "fee_type": "MANDATORY_EXTRA",
                    "amount": 6500,
                    "amount_to_vendor": 52,
                    "amount_to_supplier": 0,
                    "rate_decimal_places": 2,
                    "applicable_taxes": [
                        {
                            "tax_type": "TAX_THREE"
                        }
                    ],
                    "item_code": "CP-STD",
                    "item_description": "Property Protection Fee"
                }
            ],
            "mc_user_id": 42330
        }
    ],