Contents x
    [PREVIEW] Add an initial cost with the amount for concept private rent contracts
    • 24 Dec 2024
    • 1 Minute to read
    • Print
    • Dark
      Light
    Contents

    [PREVIEW] Add an initial cost with the amount for concept private rent contracts

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

    Post
    /api/v1/contracts/conceptprivaterent/initialcosts

    [PREVIEW] Add an initial cost with the amount for concept private rent contracts.

    Description

    Adds an initial cost to concept private rent contracts. This refers to the initial contract costs (e.g., nameplates for an apartment complex or keys).

    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 an initial service cost to a concept private rent contract. For instance, The user wishes to include an additional initial cost component due to the implementation of extra facilities for the tenant.

    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).
    amountExclAmount of the invoice line item, excluding VAT. Decimals are separated with a period (.)

    Response fields

    The response contains the fields in the request with the additional fields belowtable 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
    initialCostsItemName
    string Required
    Min length0
    Max length256
    amountExcl
    number (double) Required
    Responses
    200

    OK

    object
    contractExternalIdentifier
    string
    Min length1
    objectReference
    string | null
    initialCostsItemName
    string
    Min length0
    Max length256
    amountExcl
    number (double)
    amountVAT
    number (double)
    amountIncl
    number (double)
    What's Next