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

    [PREVIEW] Delete an initial cost from concept private rent contract

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

    Delete
    /api/v1/contracts/conceptprivaterent/initialcosts

    [PREVIEW] Delete an initial cost from concept private rent contract.

    Description

    Removes an initial service cost item from a concept private rent contract. This refers to the initial contract costs (e.g., nameplates for an apartment complex or keys).

    This endpoint can only be used to delete an initial service cost item from a concept private rent 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 an initial service cost item from a concept private rent contract. For example, because the service cost is no longer applicable to the concept private rent contract.

    Request fields

    The request contains the following field:

    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.
    InitialCostItemName
    		The description (name) of the initial cost component (e.g., key deposit, nameplates).
    Security
    HTTP
    Type Bearer

    Please enter a valid token

    Body parameters
    object
    contractExternalIdentifier
    string Required
    Min length1
    objectReference
    string Required
    Min length1
    initialCostsItemName
    string Required
    Min length0
    Max length256
    Responses
    200

    An initial cost for concept private rent contract was deleted

    boolean
    400

    The initial cost 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