Get a list of theoretical rents for buildings
Get a list of theoretical rents for buildings
This endpoint retrieves the theoretical rent entries currently recorded in Bloxs for a building.
Theoretical rent represents the rent Bloxs assumes for the building under either a residential or a commercial lease, independent of any actual rental contract. A building can have theoretical rent entries for only one of these two contract types, not both.
Integrators call this endpoint to review the recorded theoretical rents for a building, for example to determine which one is appropriate for a new contract or to identify entries that need to be added or corrected.
Request Fields
Field | Type | Required | Description |
|---|---|---|---|
reference | string | Conditional | Internal identifier of the building. Either reference or externalIdentifier must be provided. If both are given, the building must match both values. |
externalIdentifier | string | Conditional | External identifier of the building, as set by the integrating system. Either reference or externalIdentifier must be provided. If both are given, the building must match both values. |
Response Fields
Field | Type | Required | Description |
|---|---|---|---|
contractType | integer | No | Type of contract the theoretical rent applies to. 33 is a residential lease contract, 65 is a commercial lease contract. A building has entries for only one of these two types. |
contractItemName | string | No | Name of the theoretical rent entry. |
description | string | No | Free text description of the theoretical rent entry. |
amountExcl | number (double) | No | Theoretical rent amount, excluding VAT (net amount). Decimals are separated with a period. |
The internal identifier of the model (i.e. Reference, Code, Name, depends on model).
The external API identifier of the model.
OK
PrivateRent = 33 CommercialRent = 65