---
updatedAt: 2025-09-09T21:11:32.000Z
agentTools:
  projectIndex: https://docs.ciiruspartners.com/v2023.07.31/llms.txt
---

# Retrieve quote

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "security": [
    {
      "basicAuth": []
    }
  ],
  "info": {
    "title": "CiiRUS Partner API",
    "version": "2023.07.31"
  },
  "paths": {
    "/quote": {
      "post": {
        "summary": "Retrieve quote",
        "description": "",
        "responses": {
          "200": {
            "description": "Quote response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RetrieveQuoteResponse"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PostQuoteRequest"
              }
            }
          },
          "description": "Use this object to quote for a unit."
        },
        "tags": [
          "Quotes"
        ]
      }
    }
  },
  "servers": [
    {
      "url": "https://api.ciiruspartners.com/v2023.07.31"
    }
  ],
  "components": {
    "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"
        ]
      },
      "first_name": {
        "properties": {
          "first_name": {
            "type": "string"
          }
        }
      },
      "last_name": {
        "properties": {
          "last_name": {
            "type": "string"
          }
        }
      },
      "payment_schedule_item": {
        "allOf": [
          {
            "$ref": "#/components/schemas/amount"
          },
          {
            "$ref": "#/components/schemas/amount_decimal_places"
          },
          {
            "$ref": "#/components/schemas/due_date"
          }
        ]
      },
      "due_date": {
        "properties": {
          "due_date": {
            "type": "string",
            "format": "date-time"
          }
        }
      },
      "payment_schedule": {
        "properties": {
          "payment_schedule": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/payment_schedule_item"
            }
          }
        }
      },
      "amount_decimal_places": {
        "properties": {
          "amount_decimal_places": {
            "type": "integer",
            "default": 2,
            "minimum": 1,
            "description": "The number of decimal places to represent the amount as."
          }
        }
      },
      "financials": {
        "properties": {
          "financials": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/charge"
            }
          }
        },
        "allOf": [
          {
            "$ref": "#/components/schemas/total_amount"
          },
          {
            "$ref": "#/components/schemas/amount_decimal_places"
          }
        ]
      },
      "charge": {
        "properties": {
          "item": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "code": {
            "type": "string"
          },
          "applies_to_id": {
            "type": "string"
          },
          "quantity": {
            "type": "integer"
          }
        },
        "allOf": [
          {
            "$ref": "#/components/schemas/charge_type"
          },
          {
            "$ref": "#/components/schemas/amount"
          },
          {
            "$ref": "#/components/schemas/amount_decimal_places"
          }
        ]
      },
      "age": {
        "properties": {
          "age": {
            "type": "integer"
          }
        }
      },
      "RetrieveQuoteResponse": {
        "allOf": [
          {
            "$ref": "#/components/schemas/RetrieveQuoteResponseObject"
          },
          {
            "type": "object"
          }
        ]
      },
      "RetrieveQuoteResponseObject": {
        "allOf": [
          {
            "$ref": "#/components/schemas/financials"
          },
          {
            "$ref": "#/components/schemas/payment_schedule"
          },
          {
            "$ref": "#/components/schemas/inventory_id"
          },
          {
            "$ref": "#/components/schemas/organization_id"
          },
          {
            "$ref": "#/components/schemas/details"
          }
        ]
      },
      "PostQuoteRequest": {
        "allOf": [
          {
            "$ref": "#/components/schemas/inventory_id"
          },
          {
            "$ref": "#/components/schemas/organization_id"
          },
          {
            "$ref": "#/components/schemas/source"
          },
          {
            "$ref": "#/components/schemas/source_id"
          },
          {
            "$ref": "#/components/schemas/optional_extras"
          },
          {
            "$ref": "#/components/schemas/pool_heat"
          },
          {
            "$ref": "#/components/schemas/length_of_stay_pricing"
          },
          {
            "$ref": "#/components/schemas/discount_code"
          },
          {
            "$ref": "#/components/schemas/details"
          },
          {
            "$ref": "#/components/schemas/thread_id"
          }
        ],
        "required": [
          "inventory_id",
          "source",
          "source_id",
          "details"
        ]
      },
      "inventory_id": {
        "properties": {
          "inventory_id": {
            "type": "integer"
          }
        }
      },
      "organization_id": {
        "properties": {
          "organization_id": {
            "type": "integer",
            "description": "The organization under which the booking is made/quoted."
          }
        }
      },
      "source": {
        "properties": {
          "source": {
            "type": "string",
            "default": "readme",
            "description": "The source of the booking."
          }
        }
      },
      "source_id": {
        "properties": {
          "source_id": {
            "type": "string",
            "default": "readme",
            "description": "Id representing the booking source."
          }
        }
      },
      "optional_extras": {
        "properties": {
          "optional_extras": {
            "type": "array",
            "items": {
              "type": "integer",
              "description": "Pass extra ids here to have them auto quote, pass them multiple times for multiple quantities."
            }
          }
        }
      },
      "pool_heat": {
        "properties": {
          "pool_heat": {
            "type": "boolean",
            "description": "Indicate if you would like pool heat auto quoted for you."
          }
        }
      },
      "discount_code": {
        "properties": {
          "discount_code": {
            "type": "string",
            "description": "Input discount code item code here to apply it to the quote."
          }
        }
      },
      "thread_id": {
        "properties": {
          "thread_id": {
            "type": "string",
            "description": "Id identifying relevant message thread for channel."
          }
        }
      },
      "details": {
        "properties": {
          "details": {
            "$ref": "#/components/schemas/detail"
          }
        }
      },
      "detail": {
        "allOf": [
          {
            "$ref": "#/components/schemas/arrival"
          },
          {
            "$ref": "#/components/schemas/departure"
          },
          {
            "$ref": "#/components/schemas/origination_date"
          },
          {
            "$ref": "#/components/schemas/number_of_adults"
          },
          {
            "$ref": "#/components/schemas/number_of_children"
          },
          {
            "$ref": "#/components/schemas/number_of_pets"
          },
          {
            "$ref": "#/components/schemas/party_members"
          }
        ],
        "required": [
          "arrival",
          "departure",
          "origination_date",
          "number_of_adults",
          "number_of_children",
          "number_of_pets",
          "party_members"
        ]
      },
      "arrival": {
        "properties": {
          "arrival": {
            "type": "string",
            "format": "date-time"
          }
        }
      },
      "departure": {
        "properties": {
          "departure": {
            "type": "string",
            "format": "date-time"
          }
        }
      },
      "origination_date": {
        "properties": {
          "origination_date": {
            "type": "string",
            "format": "date-time"
          }
        }
      },
      "number_of_adults": {
        "properties": {
          "number_of_adults": {
            "type": "integer",
            "default": 1,
            "minimum": 1
          }
        }
      },
      "number_of_children": {
        "properties": {
          "number_of_children": {
            "type": "integer",
            "default": 0,
            "minimum": 0
          }
        }
      },
      "number_of_pets": {
        "properties": {
          "number_of_pets": {
            "type": "integer",
            "default": 0,
            "minimum": 0
          }
        }
      },
      "party_members": {
        "properties": {
          "party_members": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/party_member"
            }
          }
        }
      },
      "party_member": {
        "allOf": [
          {
            "$ref": "#/components/schemas/first_name"
          },
          {
            "$ref": "#/components/schemas/last_name"
          },
          {
            "$ref": "#/components/schemas/age"
          }
        ],
        "required": [
          "first_name",
          "last_name",
          "age"
        ]
      },
      "amount": {
        "properties": {
          "amount": {
            "type": "integer"
          }
        }
      },
      "total_amount": {
        "properties": {
          "total_amount": {
            "type": "integer"
          }
        }
      },
      "length_of_stay_pricing": {
        "properties": {
          "length_of_stay_pricing": {
            "type": "boolean"
          }
        }
      },
      "charge_type": {
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "TAX_ONE,",
              "TAX_TWO,",
              "TAX_THREE",
              "EXTRA,",
              "BOOKING_FEE,",
              "CLEAN_FEE",
              "RENTAL,",
              "STANDARD_DISCOUNT,",
              "POOL_HEAT_FEE"
            ]
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```