Contents x
    [PREVIEW] Add a contract line with the amount for concept private rent contracts
    • 24 Dec 2024
    • 2 Minutes to read
    • Print
    • Dark
      Light
    Contents

    [PREVIEW] Add a contract line with the amount for concept private rent contracts

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

    Post
    /api/v1/contracts/conceptprivaterent/contractlines

    [PREVIEW] Add a contract line with the amount for concept private rent contracts.

    Description

    Adds a contract line with the amount for concept private 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.

    Private rent contracts pertains to contracts concerning real estate objects in the private sector. 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 add a contract line to the Blox application. 

    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.
    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 invoice line item that appears on the invoice.
    amountExclAmount of the invoice line item, excluding VAT. Decimals are separated with a period (.)
    startDateStart date of the contract line item.
    endDateEnd date of the contract line item

    Response fields

    The response contains the fields in the request with the aditional fields in the table below.

    FieldDescription
    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

    Body parameters
    object
    contractExternalIdentifier
    string Required
    Min length1
    objectReference
    string Required
    Min length1
    lineItemName
    string Required
    Min length0
    Max length256
    description
    string | null
    amountExcl
    number (double) Required
    startDate
    string (date) | null
    endDate
    string (date) | null
    Responses
    200

    OK

    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