> ## Documentation Index
> Fetch the complete documentation index at: https://www.bloxs.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a list of theoretical rents for units

> Get a list of theoretical rents for units

## OpenAPI

````json GET /api/v1/realestateobjects/units/theoreticalrents
{
  "openapi": "3.0.4",
  "info": {
    "title": "RealEstateObjects V1",
    "description": "Welcome to BETA version of the new RealEstateObjects API - intended for client public testing before the launch of the final version. During this BETA phase, we'll be improving the API based on specific client's feedbacks.",
    "version": "v1"
  },
  "security": [
    {}
  ],
  "tags": [
    {
      "name": "Admin"
    },
    {
      "name": "Buildings"
    },
    {
      "name": "Complexes"
    },
    {
      "name": "Generic"
    },
    {
      "name": "Metadata"
    },
    {
      "name": "PublishObjects"
    },
    {
      "name": "ScoringPointTotals"
    },
    {
      "name": "Sections"
    },
    {
      "name": "Units"
    }
  ],
  "paths": {
    "/api/v1/realestateobjects/units/theoreticalrents": {
      "get": {
        "tags": [
          "Units"
        ],
        "summary": "Get a list of theoretical rents for units",
        "description": "Get a list of theoretical rents for units",
        "operationId": "GetUnitTheoreticalRents",
        "parameters": [
          {
            "name": "reference",
            "in": "query",
            "description": "The internal identifier of the model (i.e. Reference, Code, Name, depends on model).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "externalIdentifier",
            "in": "query",
            "description": "The external API identifier of the model.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/TheoreticalRentAPIModel"
                  }
                }
              }
            }
          }
        },
        "x-d360-narrative-url": "<h3 id=\"get-a-list-of-theoretical-rents-for-units\">Get a list of theoretical rents for units</h3><p>This endpoint retrieves the theoretical rent entries currently recorded in Bloxs for a unit. </p><p>Theoretical rent represents the rent Bloxs assumes for the unit under either a residential or a commercial lease, independent of any actual rental contract. A unit has entries for only one of these two contract types, not both. </p><p>Integrators call this endpoint to review the recorded theoretical rents for a unit, for example to determine which one is appropriate for a new contract or to identify entries that need to be added or corrected.</p><hr class=\"hr-divider1\"><h4 id=\"request-fields\">Request Fields</h4><div data-type=\"table-content\"><table width=\"100%\" class=\"editor360-table\" borderstyle=\"solid\" bordercollapse=\"collapse\"><colgroup style=\"display: none;\"><col style=\"width: 250px;\"><col style=\"width: 250px;\"><col style=\"width: 250px;\"><col style=\"width: 250px;\"></colgroup><tbody><tr><th colspan=\"1\" rowspan=\"1\"><p>Field</p></th><th colspan=\"1\" rowspan=\"1\"><p>Type</p></th><th colspan=\"1\" rowspan=\"1\"><p>Required</p></th><th colspan=\"1\" rowspan=\"1\"><p>Description</p></th></tr><tr><td colspan=\"1\" rowspan=\"1\"><p>reference</p></td><td colspan=\"1\" rowspan=\"1\"><p>string</p></td><td colspan=\"1\" rowspan=\"1\"><p>Conditional</p></td><td colspan=\"1\" rowspan=\"1\"><p>Internal identifier of the unit. Either reference or externalIdentifier must be provided. If both are given, the unit must match both values.</p></td></tr><tr><td colspan=\"1\" rowspan=\"1\"><p>externalIdentifier</p></td><td colspan=\"1\" rowspan=\"1\"><p>string</p></td><td colspan=\"1\" rowspan=\"1\"><p>Conditional</p></td><td colspan=\"1\" rowspan=\"1\"><p>External identifier of the unit, as set by the integrating system. Either reference or externalIdentifier must be provided. If both are given, the unit must match both values.</p></td></tr></tbody></table></div><hr class=\"hr-divider1\"><h4 id=\"response-fields\">Response Fields</h4><div data-type=\"table-content\"><table width=\"100%\" class=\"editor360-table\" borderstyle=\"solid\" bordercollapse=\"collapse\"><colgroup style=\"display: none;\"><col style=\"width: 250px;\"><col style=\"width: 250px;\"><col style=\"width: 250px;\"><col style=\"width: 250px;\"></colgroup><tbody><tr><th colspan=\"1\" rowspan=\"1\"><p>Field</p></th><th colspan=\"1\" rowspan=\"1\"><p>Type</p></th><th colspan=\"1\" rowspan=\"1\"><p>Required</p></th><th colspan=\"1\" rowspan=\"1\"><p>Description</p></th></tr><tr><td colspan=\"1\" rowspan=\"1\"><p>contractType</p></td><td colspan=\"1\" rowspan=\"1\"><p>integer</p></td><td colspan=\"1\" rowspan=\"1\"><p>No</p></td><td colspan=\"1\" rowspan=\"1\"><p>Type of contract the theoretical rent applies to. 33 is a residential lease contract, 65 is a commercial lease contract. A unit has entries for only one of these two types.</p></td></tr><tr><td colspan=\"1\" rowspan=\"1\"><p>contractItemName</p></td><td colspan=\"1\" rowspan=\"1\"><p>string</p></td><td colspan=\"1\" rowspan=\"1\"><p>No</p></td><td colspan=\"1\" rowspan=\"1\"><p>Name of the theoretical rent entry.</p></td></tr><tr><td colspan=\"1\" rowspan=\"1\"><p>description</p></td><td colspan=\"1\" rowspan=\"1\"><p>string</p></td><td colspan=\"1\" rowspan=\"1\"><p>No</p></td><td colspan=\"1\" rowspan=\"1\"><p>Free text description of the theoretical rent entry.</p></td></tr><tr><td colspan=\"1\" rowspan=\"1\"><p>amountExcl</p></td><td colspan=\"1\" rowspan=\"1\"><p>number (double)</p></td><td colspan=\"1\" rowspan=\"1\"><p>No</p></td><td colspan=\"1\" rowspan=\"1\"><p>Theoretical rent amount, excluding VAT (net amount). Decimals are separated with a period.</p></td></tr></tbody></table></div><p></p>"
      }
    }
  },
  "components": {
    "schemas": {
      "TheoreticalRentAPIModel": {
        "required": [
          "amountExcl",
          "contractItemName",
          "contractType",
          "description",
          "endDate",
          "startDate"
        ],
        "type": "object",
        "properties": {
          "contractType": {
            "type": "integer",
            "description": "PrivateRent = 33\nCommercialRent = 65",
            "format": "int32",
            "x-enumNames": [
              "PrivateRent",
              "CommercialRent"
            ]
          },
          "contractItemName": {
            "type": "string",
            "nullable": true
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "amountExcl": {
            "type": "number",
            "format": "double"
          },
          "startDate": {
            "type": "string",
            "format": "date"
          },
          "endDate": {
            "type": "string",
            "format": "date",
            "nullable": true
          }
        },
        "additionalProperties": false
      }
    }
  }
}
````