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

    [PREVIEW] Get a list of contract lines for concept commercial rent contracts

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

    Get
    /api/v1/contracts/conceptcommercialrent/contractlines

    [PREVIEW] Get a list of contract lines for concept commercial rent contracts.

    Description

    Retrieve the list with contract lines for concept commercial rent contracts. This pertains to the particular contract terms associated with the agreement. These include costs for the tenant, such as rent, furniture, and rent discounts (negative costs). It is a generic list.

    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 theoretical rents for commercial rent contracts in the Bloxs database. For instance, the user can review all known theoretical rents to determine which one is applicable and identify any that need to be added or modified.

    Request fields

    The request contains the following fields:

    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.
    lineItemNameThis pertains to the reference name of the contract line item. A GET operation is available to retrieve the reference name.
    descriptionThis is the description of the xxx. It appears on the invoice.
    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 (.)
    startDateStart date of the contract line item.
    endDateEnd date of the contract line item.
    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
    lineItemName
    string
    Min length0
    Max length256
    description
    string | null
    Min length0
    Max length512
    amountExcl
    number (double)
    amountVAT
    number (double)
    amountIncl
    number (double)
    startDate
    string (date) | null
    endDate
    string (date) | null
    What's Next