Get a list of private rent indexation methods

Prev Next
Get
/api/v1/contracts/conceptprivaterent/indexationmethods

Get a list of existing private rent indexation methods.

Get a list of private rent indexation methods

This endpoint retrieves the list of indexation methods available for residential lease contracts in Bloxs, for example a fixed percentage, a fixed amount, a statutory rate for a specific segment or a method based on a monthly CPI index with a base value.

This is a generic list that can be edited within the Bloxs application.

A developer calls this endpoint to look up the valid values before setting the indexation method on a concept residential lease contract, since indexationMethodName is one of the fields required to update a concept residential lease contract.


Request Fields

This endpoint takes no request fields.


Response Fields

Field

Type

Required

Description

name

string

No

The name of the indexation method.

Security
Responses
200

OK

Array of object
object
name
string | null