[PREVIEW] Get a list of private rent indexation methods
  • 30 Dec 2024
  • 1 Minute to read
  • Dark
    Light

[PREVIEW] Get a list of private rent indexation methods

  • Dark
    Light

Article summary

Get
/api/v1/contracts/conceptprivaterent/indexationmethods

[PREVIEW] Get a list of existing private rent indexation methods.

Description

Retrieve a list with all known private rent 'indexation methods' within Bloxs. Examples of indexation methods are MinimumIndexRate, MaximumIndexRate or IncrementRate. This is a generic list, however the list can be edited 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. No API endpoint will be made available to finalise the contract. 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 user wants to add an indexation method of a private rent contract through the update concept private rent contract operation update concept private rent contract operation. One of the obligatory fields in the request of this operation is 'IndexationMethodName'. However, the user does not know the options which are available to choose from. The user can utilize this operation to retrieve a list, so a choice can be made regarding which 'IndexationMethodName' to choose.

Response fields

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

FieldDescription
nameName of the indexation method
Security
HTTP
Type Bearer

Please enter a valid token

Responses
200

OK

Array of object
object
name
string | null