Contents x
    [PREVIEW] Get a concept private rent contract
    • 30 Dec 2024
    • 7 Minutes to read
    • Print
    • Dark
      Light
    Contents

    [PREVIEW] Get a concept private rent contract

    • Updated on 30 Dec 2024
    • 7 Minutes to read
    • Print
    • Dark
      Light
    Article summary

    Get
    /api/v1/contracts/conceptprivaterent

    [PREVIEW] Get an existing concept private rent contract. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the concept private rent contract.

    Description

    Retrieve the information currently known in the Bloxs database about a certain concept private rent contract. 

    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.

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

    Use Case

    Through this operation the user can display a specific concept of a private rent contract and the related information. For example the user wants to use the PUT operation to edit the details of a concept contract. In order to see which properties need to be adjusted the GET operation can be used to retrieve the properties and gain insight in the current details.

    Request fields

    The request contains the following fields:

    FieldDescription
    externalIdentifierThe unique identifier within the system of the requesting party. This identifier is not generated by the Bloxs system.

    Response fields

    The response contains the fields in the table below. For the GET operation it gives an up-to-date insight in the data that is currently registered in Bloxs.

    FieldDescription
    externalIdentifierThe unique identifier within the system of the requesting party. This identifier is not generated by the Bloxs system.
    nameThe free name field of the contract. Intended as clarification for search purposes.
    ownerReference
    		The relationship number within Bloxs. This is unique (per client specific environment) for all concept sales contracts. The relationship number is generated by the Bloxs system
    relationReferenceThis pertains to the primary tenant who is financially responsible. Please note, a reference must be included here.
    extraRelationsThis pertains to co-tenants. Please note, a reference must be included here
    startDateStart date of the contract.
    endDateEnd date of the contract. This may be left blank; otherwise, please fill in the contract end date. This can also be the date on which the contract is automatically renewed.
    automaticExtendsThis indicator indicates whether the contract is subject to automatic renewal. The default value is "false."
    notifyOnExpirationWith this indicator, the user (not the tenant) can indicate whether they wish to receive a notification when the rental period expires. The default value is "false".
    notifyOnExpirationMonthsThis allows you to specify how many months in advance you wish to receive the notification. The notification refers to a task in the application. The notification will not be sent if the contract has already been renewed.
    paymentMethod

    The payment method. There is no default value.

    OwnerBankAccountContains the IBAN to which the rent amount should be transferred to.
    paymentTermInDaysThis is the payment term in days, calculated from the start of the rental period. For example, if a tenant begins renting on November 1, the payment term will expire on November 8. The due date is calculated based on this payment term. This field can be left empty in the API, but it must be filled in within Bloxs itself; otherwise, the contract cannot be finalised.
    invoiceIntervalThis field indicates how often an invoice is sent. The invoice will be sent to the tenant's email address. The invoicing process can also be turned off in the application. There is no default value in the API.
    automaticInvoicingFrom

    This field indicates the date from which the Bloxs system will begin the automated invoicing process. It is strongly recommended to set this date to the first day of the month. If the contract starts mid-month, the first invoice will need to be generated manually. Regardless of the selected start date, the invoicing period will be monthly or quarterly. For example, if the user sets October 5 as the start date for automated invoicing, the invoicing period will run from October 5 to November 4, and so forth. The start date must be on or after the contract start date.

    indexationInfoDetails regarding the indexation that should be applied to this contract can be entered here
    indexationInfo.indexationMethodNameThe method of indexation that should be applied to this specific contract. The available methods consist of a predefined list by Bloxs, which can be customized by the user in the Bloxs application. In order to retrieve the available methods, the following endpoint can be used: GET indexationMethods. Examples of indexation methods are a fixed yearly amount (eg. 2%) or a percentage linked to the inflation numbers. The inflation numbers are automatically processed by Bloxs, the user does not need to upload these numbers manually.
    indexationInfo.nextIndexDate

    The next date from which the indexation method will be applied. Further indexations will be applied on an annual basis, starting from the 'nextIndexDate'. For example the nextIndexDate is 2025-01-01. This means subsequent dates for indexation are 2026-01-01, 2027-01-01 etc.

    indexationInfo.indexationUseOverrulesThis field indicates if certain overrules should be applied to the chosen indexation method. The following 3 overrules are available: MinimumIndexRate, MaximumIndexRate & IncrementRate. The overrule information entered in one (or multiple) of these 3 fields will only be applied of 'IndexationUseOverrules' has the value 'true'. The default value is false.
    indexationInfo.indexationOverrule_MinimumIndexRateThis overrule will apply a minimum indexation percentage. This will overrule the chosen indexation method. For example, the user wants to use the inflation method for indexation. However, the user does not want the indexation to be less than 2%. In this case this field can be used to enter a minimum indexation percentage. For this scenario the value '0.02' should be entered. The number 1 means 100%. This field should always be used in combination with 'IndexationUseOverrules' value 'true'.
    indexationInfo.indexationOverrule_MaximumIndexRateThis overrule will apply a maximum indexation percentage. This will overrule the chosen indexation method. For example, the user wants to use the inflation method for indexation. However, the user does not want the indexation to be more than 8%. In this case this field can be used to enter a maximum indexation percentage. For this scenario the value '0.08' should be entered. The number 1 means 100%. This field should always be used in combination with 'IndexationUseOverrules' value 'true'.
    indexationInfo.indexationOverrule_IncrementRateThis overrule wil apply a fixed increment rate to the chosen indexation method. The increment rate applies a percentage (+ or -) to the base number. In this example the indexation derived from the indexation method is 5%. If the user wants to always apply an extra 2% on top op de number derived from the indexation method, this can be entered here with the value 0.02. In this case the total indexation would be 7%. The outcome (7%) can still be overruled by the MinimumIndexRate or the MaximumIndexRate in case the value is not within the min/max range. This field should always be used in combination with 'IndexationUseOverrules' value 'true'.
    sendInvoicesBoolean indicating whether invoices should be send. Default value is false.
    extraInvoiceTextExtra text that can be added on the invoice. For example the number of the contract, relation number or other client/contract specific details.
    remarks

    General remarks field for the user. The content of this field is not included on the actual invoice.

    noticePeriod

    Notice period of the contract specified in months. This is relevant if automatic extension applies to this contract (automaticExtends = true).

    depositTypeName

    This field indicates the type of deposit that applies to this contract. Bloxs provides a standard list with deposit types. The user can edit this list in the Bloxs application, through the API this is not possible. In order to retrieve the full list of available deposit types, the following endpoint can be used: GET depositTypes GET depositTypes.

    depositAmountThe amount of the deposit. Decimals are point separated.
    contractRealEstateObjectsThe reference of the real estate object(s) which is (are) the subject of this contract. Please note, a reference must be included here. If the contract contains multiple real estate objects, an array of reference can be entered here.
    extensionPeriods.numberOfMonthsNumber of months by which the contract is automatically renewed. If a contract is renewed every six months, set `"automaticExtends"` to `"true"` and `"extensionPeriods.numberOfMonths"` to `6`.
    Security
    HTTP
    Type Bearer

    Please enter a valid token

    Query parameters
    externalIdentifier
    stringRequired

    The external API identifier of the model.

    Responses
    200

    OK

    Expand All
    object
    externalIdentifier
    string | null
    name
    string | null
    ownerReference
    string | null
    relationReference
    string | null
    extraRelations
    Array of string | null
    string
    startDate
    string (date) | null
    endDate
    string (date) | null
    automaticExtends
    boolean
    notifyOnExpiration
    boolean
    notifyOnExpirationMonths
    integer (int32) | null
    paymentMethod
    integer (int32)

    1 = DirectDebit

    2 = BankTransfer

    Valid values[ \1\, \2\ ]
    ownerBankAccount
    string | null
    paymentTermInDays
    integer (int32) | null
    invoiceInterval
    integer (int32)

    1 = Month

    3 = Quarter

    6 = HalfYear

    12 = Year

    Valid values[ \1\, \3\, \6\, \12\ ]
    automaticInvoicingFrom
    string (date) | null
    indexationInfo
    object (SalesContractIndexationInfoAPIModel)
    indexationMethodName
    string
    Min length1
    nextIndexDate
    string (date)
    indexationUseOverrules
    boolean
    indexationOverrule_MinimumIndexRate
    number (double) | null
    Minimum-1
    Maximum1
    indexationOverrule_MaximumIndexRate
    number (double) | null
    Minimum-1
    Maximum1
    indexationOverrule_IncrementRate
    number (double) | null
    Minimum-1
    Maximum1
    sendInvoices
    boolean
    extraInvoiceText
    string | null
    remarks
    string | null
    noticePeriod
    integer (int32) | null
    depositTypeName
    string | null
    depositAmount
    number (double) | null
    contractRealEstateObjects
    Array of string | null
    string
    extensionPeriods
    Array of object (ConceptContractExtensionPeriod) | null
    object
    numberOfMonths
    integer (int32) | null
    Minimum1
    Maximum9999
    404

    The requested concept private rent contract was not found.

    What's Next