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

    [PREVIEW] Delete a concept private rent contract

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

    Delete
    /api/v1/contracts/conceptprivaterent

    [PREVIEW] Delete an existing concept private rent contract.

    Description

    Removes a concept of private rent contract. 

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

    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

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

    Request fields

    The request contains the following field:

    FieldDescription
    externalIdentifierThe 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.
    Security
    HTTP
    Type Bearer

    Please enter a valid token

    Query parameters
    externalIdentifier
    stringRequired

    The external API identifier of the model.

    Responses
    200

    A concept private rent contract was deleted

    boolean
    400

    The concept private rent contract data 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