Unit Extras
Retrieve Unit Extras for the Inventory or specific Unit
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 | v2024.07.31/unit_extras | Retrieve unit extras for units in the inventory. |
| GET | v2024.07.31/unit_extras/{unit_id} | Retrieve Rental Extras for a 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_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 | The unique identifier for a unit in the inventory. | int |
| unit_ids | Optional | The unique identifiers for multiple units in the inventory. | array |
| management_company_user_id | Optional | The unique identifier for a supplier. | int |
| management_company_user_ids | Optional | The unique Identifiers for multiple 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 |
| retrieve_all_extras | Optional | Return all extras. | boolean |
| channel | Optional | Specify channel. | string |
| include_extras_without_value | Optional | Include 0 value extras. | boolean |
Response Definition
| Response Item | Description | Data Type |
|---|---|---|
"unit_extras" | An array containing Extras details about different units | array |
"unit_extras" Object
"unit_extras" Object| Response Item | Description | Data Type |
|---|---|---|
"unit_id" | The unique identifier for the unit. | int |
"management_company_user_id" | The unique identifier for the supplier associated with the unit. | int |
"extras" | An array containing details about additional extras associated with the unit. | array |
"extras" Object
"extras" Object| Response Item | Description | Data Type |
|---|---|---|
"id" | The unique identifier for the extra fee. | int |
"type" | The type of the extra fee. | string |
"reporting_fee_type" | The categorization of the extra fee for reporting purposes. | string |
"pass_through_fee_type" | The extra fee categorization passed to vendors. | string |
"code" | The code that represents the extra fee item. | string |
"description" | A description of the extra fee item. | string |
"mandatory" | A flag indicating whether the extra fee is mandatory (true) or not (false). | boolean |
"age_bands_apply" | If true, age-based pricing applies. | boolean |
"age_bands" | An array that lists the age-based pricing bands. | array[objects] |
"date_range_apply" | If true, the extra is limited to certain date ranges. | boolean |
"date_restrictions" | An array that defines the date restrictions and pricing rules. | array[objects] |
"per_guest" | A flag indicating whether the extra fee is charged per guest (true) or not (false). | boolean |
"guest_quantity" | An array that defines guest count ranges where the fee applies. | array[objects] |
"stay_duration" | An array containing details about the stay duration associated with the extra fee (if applicable). | array[objects] |
"per_day" | A flag indicating whether the extra fee is charged per day (true) or not (false) (if applicable). | boolean |
"minimum_value" | The Minimum amount of the fee. Values utilized by this endpoint use 10⁸ fixed-point format (e.g. 5500000000= 55). | int |
"value" | The value of the extra fee. Values utilized by this endpoint use 10⁸ fixed-point format (e.g. 5500000000= 55). | int |
"value_management_company" | The amount received by the management company. | int |
"value_owner" | The amount allocated to the property owner. | int |
"value_type" | The type of value. | string |
"value_to_vendor" | The amount to be paid to the vendor for the extra fee (if applicable). | int |
"value_to_supplier" | The amount to be paid to the supplier for the extra fee (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[strings] |
"insurance_policy_class" | Optional class ID for insurance-related extras. | int |
"age_bands" Object
"age_bands" Object| Response Item | Description | Data Type |
|---|---|---|
"start" | The starting age for this extra fee. | int |
"end" | The ending age for this extra fee. | int |
"age_price" | The value (in fixed-point format) for this age group. | int |
"date_restrictions" Object
"date_restrictions" Object| Response Item | Description | Data Type |
|---|---|---|
"bookable_dates" | An array with details of when the extra can be booked. | array[objects] |
"effective_dates" | An array with details of when the extra applies during the stay. | array[objects] |
"age_bands" | An array with details of any age-based pricing overrides for this restriction | array[objects] |
"full_stay" | If true, date range must cover full stay. | boolean |
"bookable_dates" and "effective_dates" Objects
"bookable_dates" and "effective_dates" Objects| Response Item | Description | Data Type |
|---|---|---|
"start" | The start date of the "bookable_dates" or "effective_dates" in ISO format. | string |
"end" | The end date of the "bookable_dates" or "effective_dates" in ISO format. | string |
"guest_quantity" Object
"guest_quantity" Object| Response Item | Description | Data Type |
|---|---|---|
"start" | The minimum guest count required for the extra fee. | int |
"end" | The maximum guest count required for the extra fee. | int |
"stay_duration" Object
"stay_duration" Object| Response Item | Description | Data Type |
|---|---|---|
"start" | The minimum stay duration required for the extra fee. | int |
"end" | The maximum stay duration required for the extra fee. | int |
"applicable_taxes" Object
"applicable_taxes" Object| Response Item | Description | Data Type |
|---|---|---|
"tax_type" | The type of tax that is associated with the extra fee. | string |
Sample Request
curl --location 'https://api.ciiruspartners.com/v2024.07.31/unit_extras?page=1&page_size=25' \
--header 'Authorization: Basic {APIUsername:APIPassword}'
Sample Response
{
"unit_extras": [
{
"unit_id": 219264,
"management_company_user_id": 42330,
"extras": [
{
"type": "booking_fee",
"value": 300000000,
"value_type": "flat",
"applicable_taxes": [
"tax_one",
"tax_two"
]
},
{
"type": "cleaning_fee",
"stay_duration": {
"minimum": 1,
"maximum": 5
},
"value": 20000000000,
"value_type": "flat",
"applicable_taxes": [
"tax_one",
"tax_two"
]
},
{
"type": "pool_heat_fee",
"stay_duration": {
"minimum": 7
},
"value": 2500000000,
"value_type": "daily",
"applicable_taxes": [
"tax_one",
"tax_two"
]
},
{
"type": "security_deposit",
"value": 5000000000,
"value_type": "flat"
},
{
"id": 7417,
"type": "mandatory_extra",
"code": "Fee1",
"description": "Example Fee 1",
"mandatory": true,
"value": 300000000,
"value_management_company": 300000000,
"value_owner": 300000000,
"value_type": "percentage",
"applicable_taxes": [
"tax_one",
"tax_two",
"tax_three"
]
},
{
"id": 7418,
"type": "mandatory_extra",
"code": "Fee2",
"description": "Example Fee 2",
"mandatory": true,
"per_day": true,
"value": 1000000000,
"value_management_company": 1000000000,
"value_type": "flat",
"applicable_taxes": [
"tax_one",
"tax_two",
"tax_three"
]
},
{
"id": 7419,
"type": "mandatory_extra",
"code": "Fee3",
"description": "Example Fee 3",
"mandatory": true,
"value": 1000000000,
"value_management_company": 1000000000,
"value_type": "flat",
"applicable_taxes": [
"tax_one",
"tax_two",
"tax_three"
]
},
{
"id": 7420,
"type": "standard_discount",
"code": "Fee4",
"description": "Example Fee 4",
"value": 1000000000,
"value_management_company": 1000000000,
"value_type": "flat",
"applicable_taxes": [
"tax_three"
]
},
{
"id": 7421,
"type": "mandatory_extra",
"code": "Fee5",
"description": "Example Fee 5",
"mandatory": true,
"per_day": true,
"value": 500000000,
"value_management_company": 500000000,
"value_type": "flat",
"applicable_taxes": [
"tax_three"
]
},
{
"id": 7422,
"type": "mandatory_extra",
"code": "Fee6",
"description": "Fee Example 6",
"mandatory": true,
"value": 500000000,
"value_management_company": 500000000,
"value_type": "flat",
"applicable_taxes": [
"tax_one",
"tax_two",
"tax_three"
]
},
{
"id": 21728,
"type": "mandatory_extra",
"code": "ADI",
"description": "Accidental Damage Insurance",
"mandatory": true,
"value": 7500000000,
"value_management_company": 7500000000,
"value_type": "flat",
"applicable_taxes": [
"tax_three"
]
},
{
"id": 24651,
"type": "mandatory_extra",
"code": "DAY",
"description": "Daily Amount Fee Example",
"mandatory": true,
"per_day": true,
"value": 1750000000,
"value_management_company": 1700000000,
"value_type": "flat",
"applicable_taxes": [
"tax_three"
]
},
{
"id": 24652,
"type": "optional_extra",
"code": "GUEST",
"description": "Charge Per Guest Fee Example 1",
"age_bands": [
{
"age_range": {
"Start": {
"Value": 18,
"IsFromEnd": false
},
"End": {
"Value": 99,
"IsFromEnd": false
}
},
"age_price": 700000000
}
],
"per_guest": true,
"guest_quantity": {
"minimum": 5,
"maximum": 10
},
"value": 700000000,
"value_management_company": 700000000,
"value_type": "flat",
"applicable_taxes": [
"tax_three"
]
},
{
"id": 24654,
"type": "optional_extra",
"code": "GUEST3",
"description": "Charge Per Guest Fee Example 3",
"age_bands": [
{
"age_range": {
"Start": {
"Value": 18,
"IsFromEnd": false
},
"End": {
"Value": 99,
"IsFromEnd": false
}
},
"age_price": 750000000
}
],
"date_range_apply": true,
"date_restrictions": [
{
"bookable_dates": [
{
"start": "2023-06-01T00:00:00",
"end": "2023-08-01T00:00:00"
}
],
"effective_dates": [
{
"start": "2023-02-14T00:00:00",
"end": "2023-08-01T00:00:00"
}
],
"age_bands": [
{
"age_range": {
"Start": {
"Value": 18,
"IsFromEnd": false
},
"End": {
"Value": 99,
"IsFromEnd": false
}
},
"age_price": 750000000
}
],
"full_stay": true
}
],
"per_guest": true,
"value": 2200000000,
"value_management_company": 2200000000,
"value_type": "flat",
"applicable_taxes": [
"tax_three"
]
},
{
"id": 25011,
"type": "mandatory_extra",
"code": "CP-STD",
"description": "Property Protection Fee",
"mandatory": true,
"value": 6500000000,
"value_management_company": 6500000000,
"value_to_vendor": 5200000000,
"value_type": "flat",
"applicable_taxes": [
"tax_three"
]
},
{
"id": 27980,
"type": "optional_extra",
"code": "BOAT",
"description": "BOAT COVER",
"value": 5000000000,
"value_management_company": 5000000000,
"value_type": "flat",
"applicable_taxes": [
"tax_three"
]
}
]
},
{
"unit_id": 219265,
"management_company_user_id": 42330,
"extras": [
{
"type": "booking_fee",
"value": 0,
"applicable_taxes": [
"tax_one",
"tax_two"
]
},
{
"type": "pool_heat_fee",
"stay_duration": {
"minimum": 7
},
"value": 2142857142,
"value_type": "daily",
"applicable_taxes": [
"tax_one",
"tax_two"
]
},
{
"id": 7417,
"type": "mandatory_extra",
"code": "Fee1",
"description": "Example Fee 1",
"mandatory": true,
"value": 300000000,
"value_management_company": 300000000,
"value_owner": 300000000,
"value_type": "percentage",
"applicable_taxes": [
"tax_one",
"tax_two",
"tax_three"
]
},
{
"id": 7418,
"type": "mandatory_extra",
"code": "Fee2",
"description": "Example Fee 2",
"mandatory": true,
"per_day": true,
"value": 1000000000,
"value_management_company": 1000000000,
"value_type": "flat",
"applicable_taxes": [
"tax_one",
"tax_two",
"tax_three"
]
},
{
"id": 7419,
"type": "mandatory_extra",
"code": "Fee3",
"description": "Example Fee 3",
"mandatory": true,
"value": 1000000000,
"value_management_company": 1000000000,
"value_type": "flat",
"applicable_taxes": [
"tax_one",
"tax_two",
"tax_three"
]
},
{
"id": 7420,
"type": "standard_discount",
"code": "Fee4",
"description": "Example Fee 4",
"value": 1000000000,
"value_management_company": 1000000000,
"value_type": "flat",
"applicable_taxes": [
"tax_three"
]
},
{
"id": 7421,
"type": "mandatory_extra",
"code": "Fee5",
"description": "Example Fee 5",
"mandatory": true,
"per_day": true,
"value": 500000000,
"value_management_company": 500000000,
"value_type": "flat",
"applicable_taxes": [
"tax_three"
]
},
{
"id": 7422,
"type": "mandatory_extra",
"code": "Fee6",
"description": "Fee Example 6",
"mandatory": true,
"value": 500000000,
"value_management_company": 500000000,
"value_type": "flat",
"applicable_taxes": [
"tax_one",
"tax_two",
"tax_three"
]
},
{
"id": 21728,
"type": "mandatory_extra",
"code": "ADI",
"description": "Accidental Damage Insurance",
"mandatory": true,
"value": 7500000000,
"value_management_company": 7500000000,
"value_type": "flat",
"applicable_taxes": [
"tax_three"
]
},
{
"id": 24651,
"type": "mandatory_extra",
"code": "DAY",
"description": "Daily Amount Fee Example",
"mandatory": true,
"per_day": true,
"value": 1750000000,
"value_management_company": 1700000000,
"value_type": "flat",
"applicable_taxes": [
"tax_three"
]
},
{
"id": 24652,
"type": "optional_extra",
"code": "GUEST",
"description": "Charge Per Guest Fee Example 1",
"age_bands": [
{
"age_range": {
"Start": {
"Value": 18,
"IsFromEnd": false
},
"End": {
"Value": 99,
"IsFromEnd": false
}
},
"age_price": 700000000
}
],
"per_guest": true,
"guest_quantity": {
"minimum": 5,
"maximum": 10
},
"value": 700000000,
"value_management_company": 700000000,
"value_type": "flat",
"applicable_taxes": [
"tax_three"
]
},
{
"id": 24654,
"type": "optional_extra",
"code": "GUEST3",
"description": "Charge Per Guest Fee Example 3",
"age_bands": [
{
"age_range": {
"Start": {
"Value": 18,
"IsFromEnd": false
},
"End": {
"Value": 99,
"IsFromEnd": false
}
},
"age_price": 750000000
}
],
"date_range_apply": true,
"date_restrictions": [
{
"bookable_dates": [
{
"start": "2023-06-01T00:00:00",
"end": "2023-08-01T00:00:00"
}
],
"effective_dates": [
{
"start": "2023-02-14T00:00:00",
"end": "2023-08-01T00:00:00"
}
],
"age_bands": [
{
"age_range": {
"Start": {
"Value": 18,
"IsFromEnd": false
},
"End": {
"Value": 99,
"IsFromEnd": false
}
},
"age_price": 750000000
}
],
"full_stay": true
}
],
"per_guest": true,
"value": 2200000000,
"value_management_company": 2200000000,
"value_type": "flat",
"applicable_taxes": [
"tax_three"
]
},
{
"id": 25011,
"type": "mandatory_extra",
"code": "CP-STD",
"description": "Property Protection Fee",
"mandatory": true,
"value": 6500000000,
"value_management_company": 6500000000,
"value_to_vendor": 5200000000,
"value_type": "flat",
"applicable_taxes": [
"tax_three"
]
},
{
"id": 27980,
"type": "optional_extra",
"code": "BOAT",
"description": "BOAT COVER",
"value": 5000000000,
"value_management_company": 5000000000,
"value_type": "flat",
"applicable_taxes": [
"tax_three"
]
}
]
}, ..
],
"paging": {
"next_page_url": "https://api.ciiruspartners.com/v2024.07.31/unit_extras?page=2&page_size=25",
"total_page_count": 6,
"page": 1,
"page_size": 25
}
}
Updated about 1 month ago