---
updatedAt: 2026-08-20T16:48:56.000Z
agentTools:
  projectIndex: https://docs.ciiruspartners.com/llms.txt
---

# Retrieve units extras

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "security": [
    {
      "basicAuth": []
    }
  ],
  "info": {
    "title": "CiiRUS Partner API",
    "version": "2024.07.31"
  },
  "paths": {
    "/unit_extras": {
      "get": {
        "summary": "Retrieve units extras",
        "description": "",
        "parameters": [
          {
            "$ref": "#/components/parameters/page_query"
          },
          {
            "$ref": "#/components/parameters/page_size_query"
          },
          {
            "$ref": "#/components/parameters/last_unit_update_date_query"
          },
          {
            "$ref": "#/components/parameters/last_reservation_update_date_query"
          },
          {
            "$ref": "#/components/parameters/last_agent_module_property_update_date_query"
          },
          {
            "$ref": "#/components/parameters/last_agent_module_agent_update_date_query"
          },
          {
            "$ref": "#/components/parameters/unit_id_query"
          },
          {
            "$ref": "#/components/parameters/unit_ids_query"
          },
          {
            "$ref": "#/components/parameters/management_company_user_id_query"
          },
          {
            "$ref": "#/components/parameters/management_company_user_ids_query"
          },
          {
            "$ref": "#/components/parameters/enabled_query"
          },
          {
            "$ref": "#/components/parameters/deleted_query"
          },
          {
            "$ref": "#/components/parameters/display_on_website_query"
          },
          {
            "$ref": "#/components/parameters/allocation_on_arrival_query"
          },
          {
            "$ref": "#/components/parameters/allocation_on_arrival_unit_query"
          },
          {
            "$ref": "#/components/parameters/channel_query"
          },
          {
            "$ref": "#/components/parameters/listing_id_query"
          },
          {
            "$ref": "#/components/parameters/retrieve_all_extras_query"
          },
          {
            "$ref": "#/components/parameters/include_extras_without_value"
          }
        ],
        "responses": {
          "200": {
            "description": "Units extras response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/retrieve_units_extras_response"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          }
        },
        "tags": [
          "Unit Extras"
        ]
      }
    }
  },
  "servers": [
    {
      "url": "https://api.ciiruspartners.com/v2024.07.31"
    }
  ],
  "components": {
    "parameters": {
      "page_query": {
        "name": "page",
        "in": "query",
        "description": "The page to be shown.",
        "required": false,
        "schema": {
          "type": "integer",
          "format": "int32",
          "minimum": 1,
          "default": 1
        }
      },
      "page_size_query": {
        "name": "page_size",
        "in": "query",
        "description": "Limits the number of returned results.",
        "required": false,
        "schema": {
          "type": "integer",
          "format": "int32",
          "minimum": 1,
          "default": 25
        }
      },
      "last_unit_update_date_query": {
        "name": "last_unit_update_date",
        "in": "query",
        "description": "Only return units which have been modified after the specified date.",
        "required": false,
        "schema": {
          "type": "string",
          "format": "date-time"
        }
      },
      "last_reservation_update_date_query": {
        "name": "last_reservation_update_date",
        "in": "query",
        "description": "Only return units which have received a booking (their own or a calendar sync) after the specified date.",
        "required": false,
        "schema": {
          "type": "string",
          "format": "date-time"
        }
      },
      "last_agent_module_property_update_date_query": {
        "name": "last_agent_module_property_update_date",
        "in": "query",
        "description": "Only return units which have had their agent module property configuration modified after the specified date.",
        "required": false,
        "schema": {
          "type": "string",
          "format": "date-time"
        }
      },
      "last_agent_module_agent_update_date_query": {
        "name": "last_agent_module_agent_update_date",
        "in": "query",
        "description": "Only return units which have had their agent module agent configuration modified after the specified date.",
        "required": false,
        "schema": {
          "type": "string",
          "format": "date-time"
        }
      },
      "unit_id_query": {
        "name": "unit_id",
        "in": "query",
        "description": "Identifier for unit.",
        "required": false,
        "schema": {
          "type": "integer",
          "format": "int32",
          "minimum": 0
        }
      },
      "unit_ids_query": {
        "name": "unit_ids",
        "in": "query",
        "required": false,
        "description": "Identifiers for units.",
        "style": "form",
        "explode": false,
        "schema": {
          "type": "array",
          "items": {
            "type": "integer",
            "format": "int32",
            "minimum": 0
          }
        }
      },
      "management_company_user_id_query": {
        "name": "management_company_user_id",
        "in": "query",
        "description": "Identifier for supplier.",
        "required": false,
        "schema": {
          "type": "integer",
          "format": "int32",
          "minimum": 0
        }
      },
      "management_company_user_ids_query": {
        "name": "management_company_user_ids",
        "in": "query",
        "description": "Identifiers for suppliers.",
        "style": "form",
        "explode": false,
        "schema": {
          "type": "array",
          "items": {
            "type": "integer",
            "format": "int32",
            "minimum": 0
          }
        }
      },
      "enabled_query": {
        "name": "enabled",
        "in": "query",
        "description": "Use only enabled or disabled units.",
        "required": false,
        "schema": {
          "type": "boolean"
        }
      },
      "deleted_query": {
        "name": "deleted",
        "in": "query",
        "description": "Only show properties which are deleted or not deleted.",
        "required": false,
        "schema": {
          "type": "boolean"
        }
      },
      "display_on_website_query": {
        "name": "display_on_website",
        "in": "query",
        "description": "Only show properties which are enabled for website.",
        "required": false,
        "schema": {
          "type": "boolean"
        }
      },
      "allocation_on_arrival_query": {
        "name": "allocation_on_arrival",
        "in": "query",
        "description": "Return the allocation on arrival object.",
        "required": false,
        "schema": {
          "type": "boolean"
        }
      },
      "allocation_on_arrival_unit_query": {
        "name": "allocation_on_arrival_unit",
        "in": "query",
        "description": "Return units which are the representative unit in their group.",
        "required": false,
        "schema": {
          "type": "boolean"
        }
      },
      "channel_query": {
        "name": "channel",
        "in": "query",
        "description": "Specify channel.",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "all",
            "bdc",
            "vrbo",
            "airbnb"
          ]
        }
      },
      "retrieve_all_extras_query": {
        "name": "retrieve_all_extras",
        "in": "query",
        "description": "Return all extras.",
        "required": false,
        "schema": {
          "type": "boolean"
        }
      },
      "include_extras_without_value": {
        "name": "include_extras_without_value",
        "in": "query",
        "description": "Include 0 value extras..",
        "required": false,
        "schema": {
          "type": "boolean"
        }
      },
      "listing_id_query": {
        "name": "listing_id",
        "in": "query",
        "description": "Listing id to lookup.",
        "required": false,
        "schema": {
          "type": "string"
        }
      }
    },
    "responses": {
      "BadRequest": {
        "description": "Bad Request response",
        "content": {
          "*/*": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "Unauthorized": {
        "description": "Unauthorized response",
        "content": {
          "*/*": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "Forbidden": {
        "description": "Forbidden response",
        "content": {
          "*/*": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "NotFound": {
        "description": "Not Found response",
        "content": {
          "*/*": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    },
    "schemas": {
      "Error": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        },
        "required": [
          "code",
          "message"
        ]
      },
      "unit_id": {
        "properties": {
          "unit_id": {
            "type": "integer",
            "format": "int32",
            "description": "Identifier for unit."
          }
        }
      },
      "management_company_user_id": {
        "properties": {
          "management_company_user_id": {
            "type": "integer",
            "format": "int32",
            "description": "Unique Identifier for supplier"
          }
        }
      },
      "extra_id": {
        "properties": {
          "id": {
            "type": "integer"
          }
        }
      },
      "extra_type": {
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "booking_fee",
              "cleaning_fee",
              "pool_heat_fee",
              "mandatory_extra",
              "optional_extra",
              "on_arrival_extra",
              "standard_discount",
              "security_deposit"
            ]
          }
        }
      },
      "extra_reporting_fee_type": {
        "properties": {
          "reporting_fee_type": {
            "type": "string",
            "enum": [
              "tax_one",
              "tax_two",
              "tax_three"
            ]
          }
        }
      },
      "extra_pass_through_fee_type": {
        "properties": {
          "pass_through_fee_type": {
            "type": "string",
            "enum": [
              "pass_through_resort_fee,",
              "pass_through_management_fee,",
              "pass_through_community_fee,",
              "pass_through_linen_fee,",
              "pass_through_electricity_fee,",
              "pass_through_water_fee,",
              "pass_through_heating_fee,",
              "pass_through_air_conditioning_fee,",
              "pass_through_utility_fee,",
              "pass_through_pet_fee,",
              "pass_through_cleaning_fee,",
              "pass_through_short_term_cleaning_fee,",
              "pass_through_security_deposit_fee"
            ]
          }
        }
      },
      "extra_code": {
        "properties": {
          "code": {
            "type": "string"
          }
        }
      },
      "extra_description": {
        "properties": {
          "description": {
            "type": "string"
          }
        }
      },
      "extra_mandatory": {
        "properties": {
          "mandatory": {
            "type": "boolean"
          }
        }
      },
      "extra_age_bands_apply": {
        "properties": {
          "age_bands_apply": {
            "type": "boolean"
          }
        }
      },
      "extra_age_bands": {
        "properties": {
          "age_bands": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/extra_age_band"
            }
          }
        }
      },
      "extra_age_band": {
        "allOf": [
          {
            "$ref": "#/components/schemas/extra_age_range"
          },
          {
            "$ref": "#/components/schemas/extra_age_price"
          }
        ]
      },
      "extra_age_price": {
        "properties": {
          "age_price": {
            "type": "integer"
          }
        }
      },
      "extra_age_range": {
        "properties": {
          "start": {
            "type": "integer"
          },
          "end": {
            "type": "integer"
          }
        }
      },
      "extra_date_range_apply": {
        "properties": {
          "date_range_apply": {
            "type": "boolean"
          }
        }
      },
      "extra_date_restrictions": {
        "properties": {
          "date_restrictions": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/extra_date_restriction"
            }
          }
        }
      },
      "extra_date_restriction": {
        "allOf": [
          {
            "$ref": "#/components/schemas/extra_bookable_dates"
          },
          {
            "$ref": "#/components/schemas/extra_effective_dates"
          },
          {
            "$ref": "#/components/schemas/extra_age_bands"
          },
          {
            "$ref": "#/components/schemas/extra_full_stay"
          }
        ]
      },
      "extra_full_stay": {
        "properties": {
          "full_stay": {
            "type": "boolean"
          }
        }
      },
      "date_range": {
        "properties": {
          "start": {
            "type": "string",
            "format": "date-time"
          },
          "end": {
            "type": "string",
            "format": "date-time"
          }
        }
      },
      "extra_bookable_dates": {
        "properties": {
          "bookable_dates": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/date_range"
            }
          }
        }
      },
      "extra_effective_dates": {
        "properties": {
          "effective_dates": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/date_range"
            }
          }
        }
      },
      "extra_per_guest": {
        "properties": {
          "per_guest": {
            "type": "boolean"
          }
        }
      },
      "extra_guest_quantity": {
        "properties": {
          "guest_quantity": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/extra_age_range"
            }
          }
        }
      },
      "extra_stay_duration": {
        "properties": {
          "stay_duration": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/extra_age_range"
            }
          }
        }
      },
      "extra_per_day": {
        "properties": {
          "per_day": {
            "type": "boolean"
          }
        }
      },
      "extra_minimum_value": {
        "properties": {
          "minimum_value": {
            "type": "integer",
            "format": "int34",
            "description": "The value."
          }
        }
      },
      "value": {
        "properties": {
          "value": {
            "type": "integer",
            "format": "int64",
            "description": "The value."
          }
        }
      },
      "value_management_company": {
        "properties": {
          "value_management_company": {
            "type": "integer",
            "format": "int64",
            "description": "The value."
          }
        }
      },
      "insurance_policy_class": {
        "properties": {
          "insurance_policy_class": {
            "type": "integer",
            "format": "int64",
            "description": "The insurance type."
          }
        }
      },
      "value_owner": {
        "properties": {
          "value_owner": {
            "type": "integer",
            "format": "int64",
            "description": "The value."
          }
        }
      },
      "value_to_vendor": {
        "properties": {
          "value_to_vendor": {
            "type": "integer",
            "format": "int64",
            "description": "The value."
          }
        }
      },
      "value_to_supplier": {
        "properties": {
          "value_to_supplier": {
            "type": "integer",
            "format": "int64",
            "description": "The value."
          }
        }
      },
      "value_type": {
        "properties": {
          "value_type": {
            "type": "string",
            "enum": [
              "percentage",
              "flat",
              "daily"
            ],
            "description": "The type of value."
          }
        }
      },
      "applicable_taxes": {
        "properties": {
          "applicable_taxes": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "tax_one",
                "tax_two",
                "tax_three"
              ]
            }
          }
        }
      },
      "retrieve_units_extras_response": {
        "properties": {
          "unit_extras": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/unit_extras_response"
            }
          }
        },
        "required": [
          "unit_extras",
          "paging"
        ],
        "allOf": [
          {
            "$ref": "#/components/schemas/paging_object"
          },
          {
            "type": "object"
          }
        ]
      },
      "error_object": {
        "properties": {
          "error": {
            "$ref": "#/components/schemas/error"
          }
        }
      },
      "error": {
        "properties": {
          "message": {
            "type": "string",
            "description": "Error message."
          }
        }
      },
      "paging_object": {
        "properties": {
          "paging": {
            "$ref": "#/components/schemas/paging"
          }
        },
        "required": [
          "paging"
        ]
      },
      "paging": {
        "properties": {
          "next_page_url": {
            "type": "string",
            "format": "uri",
            "description": "URL to the next page."
          },
          "prev_page_url": {
            "type": "string",
            "format": "uri",
            "description": "URL to the previous page."
          },
          "total_page_count": {
            "type": "integer",
            "format": "int32",
            "minimum": 0,
            "description": "Total number of pages available."
          },
          "page": {
            "type": "integer",
            "format": "int32",
            "minimum": 0,
            "description": "Current page."
          },
          "page_size": {
            "type": "integer",
            "format": "int32",
            "minimum": 0,
            "description": "Current page size."
          }
        }
      },
      "unit_extras_response": {
        "allOf": [
          {
            "$ref": "#/components/schemas/unit_id"
          },
          {
            "$ref": "#/components/schemas/management_company_user_id"
          },
          {
            "$ref": "#/components/schemas/extras"
          },
          {
            "$ref": "#/components/schemas/error_object"
          }
        ],
        "required": [
          "unit_id",
          "management_company_user_id",
          "extras"
        ]
      },
      "extras": {
        "properties": {
          "extras": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/extra"
            }
          }
        }
      },
      "extra": {
        "allOf": [
          {
            "$ref": "#/components/schemas/extra_id"
          },
          {
            "$ref": "#/components/schemas/extra_type"
          },
          {
            "$ref": "#/components/schemas/extra_reporting_fee_type"
          },
          {
            "$ref": "#/components/schemas/extra_pass_through_fee_type"
          },
          {
            "$ref": "#/components/schemas/extra_code"
          },
          {
            "$ref": "#/components/schemas/extra_description"
          },
          {
            "$ref": "#/components/schemas/extra_mandatory"
          },
          {
            "$ref": "#/components/schemas/extra_age_bands_apply"
          },
          {
            "$ref": "#/components/schemas/extra_age_bands"
          },
          {
            "$ref": "#/components/schemas/extra_date_range_apply"
          },
          {
            "$ref": "#/components/schemas/extra_date_restrictions"
          },
          {
            "$ref": "#/components/schemas/extra_per_guest"
          },
          {
            "$ref": "#/components/schemas/extra_guest_quantity"
          },
          {
            "$ref": "#/components/schemas/extra_stay_duration"
          },
          {
            "$ref": "#/components/schemas/extra_per_day"
          },
          {
            "$ref": "#/components/schemas/extra_minimum_value"
          },
          {
            "$ref": "#/components/schemas/value"
          },
          {
            "$ref": "#/components/schemas/value_management_company"
          },
          {
            "$ref": "#/components/schemas/value_owner"
          },
          {
            "$ref": "#/components/schemas/value_type"
          },
          {
            "$ref": "#/components/schemas/value_to_vendor"
          },
          {
            "$ref": "#/components/schemas/value_to_supplier"
          },
          {
            "$ref": "#/components/schemas/applicable_taxes"
          },
          {
            "$ref": "#/components/schemas/insurance_policy_class"
          }
        ],
        "required": [
          "id",
          "value",
          "value_type"
        ]
      }
    }
  }
}
```