The rent adjustment plan object

Attributes

string

The unique identifier for the rent adjustment plan

string

The identifier for the lease associated with the rent adjustment plan

date

The creation date and time of the rent adjustment plan in ISO 8601 format

date

The last modification date and time of the rent adjustment plan in ISO 8601 format

string

The reference to the adjustee in the rent adjustment plan

string

The type of the balance charge adjusted by the rent adjustment (if applicable)

date

The next adjustment date in ISO 8601 format (if applicable)

date

The rent adjustment cancellation date in ISO 8601 format (if applicable)

date

The rent adjustment end date in ISO 8601 format (if applicable)

date

The rent adjustment cancellation date or end date, in ISO 8601 format (if applicable)

boolean

Indicator whether the plan adjusts a recurring bill item

boolean

Indicator whether the plan adjusts a balance

VAT Object

The VAT setting for the rent adjustment

Show properties of VAT Object

string

The tax mode for the VAT (e.g., “Exempt”, “Exclusive”)

number

The tax rate for the VAT (e.g., 0.25)

Array of Rent Adjustment Rule Objects

Show properties of Rent Adjustment Rule Object

string

The unique identifier for the rent adjustment rule

string

The type of adjustment (e.g., “Index”)

integer

The month when adjustment occurs

string

The first year of the adjustment rule

string

The last year of the rent adjustment rule

integer

The month of the index used for the adjustment (if applicable)

number

The minimum percentage used for the adjustment (if applicable)

number

The maximum percentage used for the adjustment (if applicable)

Array of Increment Objects

The increments used for the adjustment year by year

Show properties of Increment Object

string

The year when the increment occurs

Amount Object

The amount used for the increment

Show properties of Amount Object

string

The currency code for the increment amount (e.g., “DKK”)

number

The amount of the increment amount (e.g., 100.00)

number

The percentage used for the increment

string

The recurrence of the increment (e.g., “Recurring”, “OneTime”)

Array of Adjustment Objects

Show properties of Adjustment Object

string

The unique identifier for the adjustment

date

The date when the adjustment was made in ISO 8601 format

string

The year the adjustment is applicable

Amount Object

The from yearly amount used for the rent adjustment (if applicable)

Show properties of Amount Object

string

The currency code for the from yearly amount (e.g., “DKK”)

number

The amount of the from yearly amount (e.g., 100.00)

Amount Object

The to yearly amount used for the rent adjustment (if applicable)

Show properties of Amount Object

string

The currency code for the to yearly amount (e.g., “DKK”)

number

The amount of the to yearly amount (e.g., 100.00)

Amount Object

The yearly amount change of the rent adjustment (if applicable)

Show properties of Amount Object

string

The currency code for the yearly amount change (e.g., “DKK”)

number

The amount of the yearly amount change (e.g., 100.00)

Amount Object

The period amount change of the rent adjustment (if applicable)

Show properties of Amount Object

string

The currency code for the period amount change (e.g., “DKK”)

number

The amount of the period amount change (e.g., 100.00)

Amount Object

The from period amount of the rent adjustment (if applicable)

Show properties of Amount Object

string

The currency code for the from period amount (e.g., “DKK”)

number

The amount of the from period amount (e.g., 100.00)

Amount Object

The to period amount of the rent adjustment (if applicable)

Show properties of Amount Object

string

The currency code for the to period amount (e.g., “DKK”)

number

The amount of the to period amount (e.g., 100.00)

Amount Object

The from balance amount of the rent adjustment (if applicable)

Show properties of Amount Object

string

The currency code for the from balance amount (e.g., “DKK”)

number

The amount of the from balance amount (e.g., 100.00)

Amount Object

The to balance amount of the rent adjustment (if applicable)

Show properties of Amount Object

string

The currency code for the to balance amount (e.g., “DKK”)

number

The amount of the to balance amount (e.g., 100.00)

Amount Object

The balance amount change of the rent adjustment (if applicable)

Show properties of Amount Object

string

The currency code for the balance amount change (e.g., “DKK”)

number

The amount of the balance amount change (e.g., 100.00)

Array of Adjustment Rules Effect Objects

Show properties of Adjustment Rules Effect Object

string

The unique identifier for the corresponding rent adjustment rule

number

The calculated adjustment percentage (if applicable)

number

The from index used to calculate the percentage (if applicable)

number

The to index used to calculate the percentage (if applicable)

string

The from year and month used to calculate the percentage (if applicable)

string

The to year and month used to calculate the percentage (if applicable)

Amount Object

The from yearly amount used for the rent adjustment rule (if applicable)

Show properties of Amount Object

string

The currency code for the from yearly amount (e.g., “DKK”)

number

The amount of the from yearly amount (e.g., 100.00)

Amount Object

The to yearly amount used for the rent adjustment rule (if applicable)

Show properties of Amount Object

string

The currency code for the to yearly amount (e.g., “DKK”)

number

The amount of the to yearly amount (e.g., 100.00)

Amount Object

The yearly amount change of the rent adjustment rule (if applicable)

Show properties of Amount Object

string

The currency code for the yearly amount change (e.g., “DKK”)

number

The amount of the yearly amount change (e.g., 100.00)

Amount Object

The period amount change of the rent adjustment rule (if applicable)

Show properties of Amount Object

string

The currency code for the period amount change (e.g., “DKK”)

number

The amount of the period amount change (e.g., 100.00)

Amount Object

The from period amount of the rent adjustment rule (if applicable)

Show properties of Amount Object

string

The currency code for the from period amount (e.g., “DKK”)

number

The amount of the from period amount (e.g., 100.00)

Amount Object

The to period amount of the rent adjustment rule (if applicable)

Show properties of Amount Object

string

The currency code for the to period amount (e.g., “DKK”)

number

The amount of the to period amount (e.g., 100.00)

Amount Object

The from balance amount of the rent adjustment rule (if applicable)

Show properties of Amount Object

string

The currency code for the from balance amount (e.g., “DKK”)

number

The amount of the from balance amount (e.g., 100.00)

Amount Object

The to balance amount of the rent adjustment rule (if applicable)

Show properties of Amount Object

string

The currency code for the to balance amount (e.g., “DKK”)

number

The amount of the to balance amount (e.g., 100.00)

Amount Object

The balance amount change of the rent adjustment rule (if applicable)

Show properties of Amount Object

string

The currency code for the balance amount change (e.g., “DKK”)

number

The amount of the balance amount change (e.g., 100.00)

number

The minimum percentage used for the adjustment rule (if applicable)

number

The maximum percentage used for the adjustment rule (if applicable)

API reference

Resources

The rent adjustment plan object

Attributes

​Attributes

Attributes