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

# Retrieve unit quote options

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "security": [
    {
      "basicAuth": []
    }
  ],
  "info": {
    "title": "CiiRUS Partner API",
    "version": "2024.07.31"
  },
  "paths": {
    "/unit_quotes/{unit_id}": {
      "get": {
        "summary": "Retrieve unit quote options",
        "description": "",
        "parameters": [
          {
            "$ref": "#/components/parameters/unit_id_path"
          },
          {
            "$ref": "#/components/parameters/channel_query"
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/unit_settings"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          }
        },
        "tags": [
          "Unit Quotes"
        ]
      }
    }
  },
  "servers": [
    {
      "url": "https://api.ciiruspartners.com/v2024.07.31"
    }
  ],
  "components": {
    "parameters": {
      "unit_id_path": {
        "name": "unit_id",
        "in": "path",
        "description": "Unique Identifier for inventory.",
        "required": true,
        "schema": {
          "type": "integer",
          "format": "int32"
        }
      },
      "channel_query": {
        "name": "channel",
        "in": "query",
        "description": "Specify channel.",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "all",
            "bdc",
            "vrbo",
            "airbnb"
          ]
        }
      }
    },
    "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_settings": {
        "properties": {
          "unit_id": {
            "type": "integer"
          },
          "management_company_user_id": {
            "type": "integer"
          },
          "pool_heatable": {
            "type": "boolean"
          },
          "pool_heat_included": {
            "type": "boolean"
          },
          "pool_heat_weekly": {
            "type": "boolean"
          },
          "pool_heat_minimum_days": {
            "type": "integer"
          },
          "pool_heat_daily_price": {
            "type": "integer"
          },
          "pool_heat_weekly_price": {
            "type": "integer"
          },
          "percent_of_clean_fee_to_management_company_on_management_company_booking": {
            "type": "integer"
          },
          "percent_of_clean_fee_to_management_company_on_owner_booking": {
            "type": "integer"
          },
          "management_company_pool_heat_amount_method_on_management_company_bookings": {
            "type": "integer"
          },
          "management_company_pool_heat_amount_on_management_company_bookings": {
            "type": "integer"
          },
          "management_company_pool_heat_amount_method_on_owner_bookings": {
            "type": "integer"
          },
          "management_company_pool_heat_amount_on_owner_bookings": {
            "type": "number"
          },
          "spa": {
            "type": "boolean"
          },
          "spa_heat_included": {
            "type": "boolean"
          },
          "spa_heat_weekly": {
            "type": "boolean"
          },
          "spa_heat_minimum_days": {
            "type": "integer"
          },
          "spa_heat_daily_price": {
            "type": "integer"
          },
          "spa_heat_weekly_price": {
            "type": "integer"
          },
          "private_pool": {
            "type": "boolean"
          },
          "private_pool_heatable": {
            "type": "boolean"
          },
          "charge_security_deposit": {
            "type": "boolean"
          },
          "allow_csa_insurance": {
            "type": "boolean"
          },
          "security_deposit_amount": {
            "type": "integer"
          },
          "charge_cleaning_fee": {
            "type": "integer"
          },
          "cleaning_fee_amount": {
            "type": "integer"
          },
          "charge_booking_fee": {
            "type": "integer"
          },
          "charge_booking_fee_only_when_credit_card": {
            "type": "boolean"
          },
          "booking_fee_amount": {
            "type": "number"
          },
          "online_bookings_down_payment_setting": {
            "type": "integer"
          },
          "online_bookings_down_payment_c1": {
            "type": "integer"
          },
          "deposit_percent_to_include_optional_extras": {
            "type": "boolean"
          },
          "balance_due_weeks": {
            "type": "integer"
          },
          "minimum_nights_stay": {
            "type": "integer"
          },
          "gap_days": {
            "type": "integer"
          },
          "days_valid_for": {
            "type": "integer"
          },
          "tax_included": {
            "type": "boolean"
          },
          "tax_1_percent": {
            "type": "integer"
          },
          "tax_2_percent": {
            "type": "integer"
          },
          "tax_3_percent": {
            "type": "integer"
          },
          "total_tax_percent": {
            "type": "integer"
          },
          "charge_tax_1_on_rental_rate": {
            "type": "boolean"
          },
          "charge_tax_2_on_rental_rate": {
            "type": "boolean"
          },
          "charge_tax_3_on_rental_rate": {
            "type": "boolean"
          },
          "charge_tax_1_on_booking_fee": {
            "type": "boolean"
          },
          "charge_tax_2_on_booking_fee": {
            "type": "boolean"
          },
          "charge_tax_3_on_booking_fee": {
            "type": "boolean"
          },
          "charge_tax_1_on_cleaning_fee": {
            "type": "boolean"
          },
          "charge_tax_2_on_cleaning_fee": {
            "type": "boolean"
          },
          "charge_tax_3_on_cleaning_fee": {
            "type": "boolean"
          },
          "charge_tax_1_on_pool_heat": {
            "type": "boolean"
          },
          "charge_tax_2_on_pool_heat": {
            "type": "boolean"
          },
          "charge_tax_3_on_pool_heat": {
            "type": "boolean"
          },
          "default_check_in_time": {
            "type": "string",
            "format": "time"
          },
          "default_check_out_time": {
            "type": "string",
            "format": "time"
          },
          "currency_symbol": {
            "type": "string"
          },
          "short_stay_daily_rate_threshold": {
            "type": "integer"
          },
          "short_stay_daily_rate_factor": {
            "type": "integer"
          },
          "long_stay_daily_rate_factor": {
            "type": "integer"
          },
          "short_stay_clean_threshold": {
            "type": "integer"
          },
          "range_method": {
            "type": "integer"
          },
          "security_deposit_id": {
            "type": "integer"
          },
          "security_deposit_type": {
            "type": "string",
            "enum": [
              "none",
              "security_deposit_only",
              "security_deposit_or_damage_protection",
              "security_deposit_and_damage_protection"
            ],
            "description": "Security deposit type settings."
          }
        },
        "required": [
          "unit_id",
          "management_company_user_id"
        ]
      }
    }
  }
}
```