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

    Get a list of initial costs for buildings

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

    Get
    /api/v1/realestateobjects/buildings/initialcosts

    [PREVIEW] Get a list of initial costs for buildings

    Description

    Retrieve the list with initial costs currently known in the Bloxs database for a specific building. This refers to the initial costs (e.g., nameplates for an apartment complex or keys).

    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 initial costs for the specific building as an array.

    Use Case

    This operation enables the user to view a list of initial costs currently recorded in the Bloxs database for a specific building. For instance, the user can review all known initial costs to determine which ones are available 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
    nameThe description (name) of the initial cost component (e.g., key deposit, nameplates).
    amountExclDefault amount of the initial cost, excluding VAT. Decimals are separated with a period (.)
    orderNoOrder in which the fields are displayed within the screen in Bloxs. This can also help arrange the fields in the correct order in the connected application.
    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
    name
    string | null
    amountExcl
    number (double)
    orderNo
    integer (int32)
    What's Next