Contents x
    Get a list of theoretical rents for buildings
    • 07 Feb 2025
    • 1 Minute to read
    • Print
    • Dark
      Light
    Contents

    Get a list of theoretical rents for buildings

    • Updated on 07 Feb 2025
    • 1 Minute to read
    • Print
    • Dark
      Light
    Article summary

    Get
    /api/v1/realestateobjects/buildings/theoreticalrents

    [PREVIEW] Get a list of theoretical rents for buildings

    Description

    Retrieve the list with theoretical rents costs currently known in the Bloxs database for a specific building. 

    Either reference or externalIdentifier must have a value. Please note that if both identifiers are given, both must match; otherwise, an error message will be generated. It is recommended that the user utilizes only one identifier, with a preference for the reference.

    The response provides the full list of theoretical rents for the specific building as an array.

    Use Case

    This operation enables the user to view a list of theoretical rents currently recorded in the Bloxs database for a specific building. For instance, the user can review all known initial rents to determine which one is appropiate and identify any that need to be added or modified.

    Request fields

    The request contains the following fields:

    FieldDescription
    referenceThe relationship number within Bloxs. This is unique (per client specific environment) for all objects. The relationship number is generated by the Bloxs system.
    externalIdentifierThe unique identifier within the system of the requesting party. This identifier is not generated by the Bloxs system.

    Response fields

    The response contains the fields in the table below:

    FieldDescription
    contractTypeType of contract, either Private or Commercial Rent
    contractItemNameThe name of the theoretical rent entry
    descriptionThe description of the theoretical rent entry.
    amountExclDefault amount of the initial cost, excluding VAT. Decimals are separated with a period (.)
    Security
    HTTP
    Type Bearer

    Please enter a valid token

    Query parameters
    reference
    string

    The internal identifier of the model (i.e. Reference, Code, Name, depends on model).

    externalIdentifier
    string

    The external API identifier of the model.

    Responses
    200

    OK

    Array of object
    object
    contractType
    integer (int32)

    33 = PrivateRent

    65 = CommercialRent

    Valid values[ 33, 65 ]
    contractItemName
    string | null
    description
    string | null
    amountExcl
    number (double)
    What's Next