Contents x
    [PREVIEW] Get a list of initial costs for concept commercial rent contracts
    • 24 Dec 2024
    • 2 Minutes to read
    • Print
    • Dark
      Light
    Contents

    [PREVIEW] Get a list of initial costs for concept commercial rent contracts

    • Updated on 24 Dec 2024
    • 2 Minutes to read
    • Print
    • Dark
      Light
    Article summary

    Get
    /api/v1/contracts/conceptcommercialrent/initialcosts

    [PREVIEW] Get a list of initial costs for concept commercial rent contracts.

    Description

    Retrieve the list with initial costs currently known in the Bloxs database for concept commercial rent contracts. This refers to the initial contract costs (e.g., nameplates for an apartment complex or keys).

    Either ObjectReference or ContractExternalIdentifier 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 ObjectReference.

    Commercial rent contracts pertains to contracts concerning stores, offices, and commercial spaces (commercial real estate). It is generated for each prospect, with the remaining details to be filled in in the Bloxs application. The draft contract can (optionally) be signed digitally. Once signed, the first invoice can be issued immediately. Please note that the concept contract is not a template; it is a draft with only one mandatory field.

    Use Case

    This operation enables the user to view a list of initial costs currently recorded in the Bloxs database. 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.

    FieldDescription
    ObjectReferenceThe reference of the existing object that should be linked to this contract line. The reference should be identical to the reference such as registered in the Bloxs application. Only real estate object references that have also been entered as 'RealEstateObjects' for this specific contract can be used here.
    contractExternalIdentifierThe 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. For the get operation it gives a up-to-date insight in the data that is currently registered in Bloxs.

    FieldDescription
    contractExternalIdentifierThe unique identifier within the system of the requesting party. This identifier is not generated by the Bloxs system.
    objectReference
    		The reference of the existing object that should be linked to this contract line. The reference should be identical to the reference such as registered in the Bloxs application. Only real estate object references that have also been entered as 'RealEstateObjects' for this specific contract can be used here.
    InitialCostItemName
    		The description (name) of the initial cost component (e.g., key deposit, nameplates).
    amountExclAmount of the invoice line item, excluding VAT. Decimals are separated with a period (.)
    amountVATVAT amount of the invoice line item. Decimals are separated with a period (.)
    amountInclAmount of the invoice line item, including VAT. Decimals are separated with a period (.)
    Security
    HTTP
    Type Bearer

    Please enter a valid token

    Query parameters
    ContractExternalIdentifier
    stringRequired

    The external API identifier of the contract.

    ObjectReference
    string

    The reference id of the real estate object.

    Responses
    200

    OK

    Array of object
    object
    contractExternalIdentifier
    string
    Min length1
    objectReference
    string | null
    initialCostsItemName
    string
    Min length0
    Max length256
    amountExcl
    number (double)
    amountVAT
    number (double)
    amountIncl
    number (double)
    What's Next