Contents x
    [PREVIEW] Delete a contract line from concept private rent contract
    • 24 Dec 2024
    • 1 Minute to read
    • Print
    • Dark
      Light
    Contents

    [PREVIEW] Delete a contract line from concept private rent contract

    • Updated on 24 Dec 2024
    • 1 Minute to read
    • Print
    • Dark
      Light
    Article summary

    Delete
    /api/v1/contracts/conceptprivaterent/contractlines

    [PREVIEW] Delete a contract line from concept private rent contract.

    Description

    Removes a contractline from a concept private rent contract. 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.

    This endpoint can only be used to delete a contractline from a concept contract before it is finalised in the Bloxs application.

    This pertains to the private rental sector This is a draft contract that can be signed digitally. It is generated for each prospect, with the remaining details to be filled in. The draft contract can (optionally) be signed digitally. Once signed, the first invoice can be issued immediately. Please note that the draft contract is not a template; it is a draft with only one mandatory field. 

    Use Case

    The Bloxs user wants to remove a contractline from a concept contract. For example, because the contractline is not agreed upon and will therefore not be finalised.

    Request fields

    The request contains the following fields:

    FieldDescription
    contractExternalIdentifierThe unique identifier within the system of the requesting party. This identifier is not generated by the Bloxs system. This field should contain the externalIdentifier of the estate agent to which the bank accounts belongs.
    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.
    lineItemNameThis pertains to the reference name of the contract line item. A GET operation is available to retrieve the reference name.
    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
    Responses
    200

    Contract line for concept private rent contract was deleted

    boolean
    400

    The contract line data for concept private rent contract has validation issues

    Expand All
    object
    type
    string | null
    title
    string | null
    traceId
    string | null
    status
    integer (int32)
    errors
    object | null
    property*
    Array of string | null additionalProperties
    string
    What's Next