List rent adjustments

GET

rent-adjustment-plans

curl --request GET \
  --url https://api.helloproper.com/rent-adjustment-plans \
  --header 'Authorization: <api-key>'

{
  "rentAdjustmentPlans": [
    {
      "id": "<string>",
      "leaseId": "<string>",
      "created": "<string>",
      "modified": "<string>",
      "adjusteeRef": "<string>",
      "balanceChargeType": "<string>",
      "nextAdjustmentDate": "<string>",
      "cancelledOn": "<string>",
      "endedOn": "<string>",
      "cancelledOrEndedOn": "<string>",
      "adjustsRecurringBillItem": true,
      "adjustsBalance": true,
      "vat": {
        "taxMode": "<string>",
        "taxRate": 123
      },
      "rentAdjustmentRules": [
        {
          "id": "<string>",
          "adjustmentType": "<string>",
          "adjustmentMonth": 123,
          "firstYear": "<string>",
          "lastYear": "<string>",
          "indexMonth": 123,
          "minimumPercentage": 123,
          "maximumPercentage": 123,
          "increments": [
            {
              "year": "<string>",
              "amount": {
                "currency": "<string>",
                "amount": 123
              },
              "percentage": 123,
              "recurrence": "<string>"
            }
          ]
        }
      ],
      "adjustments": [
        {
          "id": "<string>",
          "adjustedOn": "<string>",
          "year": "<string>",
          "fromYearlyAmount": {
            "currency": "<string>",
            "amount": 123
          },
          "toYearlyAmount": {
            "currency": "<string>",
            "amount": 123
          },
          "yearlyAmountChange": {
            "currency": "<string>",
            "amount": 123
          },
          "periodAmountChange": {
            "currency": "<string>",
            "amount": 123
          },
          "fromPeriodAmount": {
            "currency": "<string>",
            "amount": 123
          },
          "toPeriodAmount": {
            "currency": "<string>",
            "amount": 123
          },
          "fromBalanceAmount": {
            "currency": "<string>",
            "amount": 123
          },
          "toBalanceAmount": {
            "currency": "<string>",
            "amount": 123
          },
          "balanceAmountChange": {
            "currency": "<string>",
            "amount": 123
          },
          "adjustmentRulesEffects": [
            {
              "rentAdjustmentRuleId": "<string>",
              "calculatedPercentage": 123,
              "fromIndex": 123,
              "toIndex": 123,
              "fromYearMonth": "<string>",
              "toYearMonth": "<string>",
              "fromYearlyAmount": {
                "currency": "<string>",
                "amount": 123
              },
              "toYearlyAmount": {
                "currency": "<string>",
                "amount": 123
              },
              "yearlyAmountChange": {
                "currency": "<string>",
                "amount": 123
              },
              "periodAmountChange": {
                "currency": "<string>",
                "amount": 123
              },
              "fromPeriodAmount": {
                "currency": "<string>",
                "amount": 123
              },
              "toPeriodAmount": {
                "currency": "<string>",
                "amount": 123
              },
              "fromBalanceAmount": {
                "currency": "<string>",
                "amount": 123
              },
              "toBalanceAmount": {
                "currency": "<string>",
                "amount": 123
              },
              "balanceAmountChange": {
                "currency": "<string>",
                "amount": 123
              },
              "minimumPercentage": 123,
              "maximumPercentage": 123
            }
          ]
        }
      ]
    }
  ]
}

Request

This request supports pagination.

Response

rentAdjustmentPlans

array

string

The unique identifier for the rent adjustment plan

leaseId

string

The identifier for the lease associated with the rent adjustment plan

created

date

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

modified

date

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

adjusteeRef

string

The reference to the adjustee in the rent adjustment plan

balanceChargeType

string

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

nextAdjustmentDate

date

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

cancelledOn

date

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

endedOn

date

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

cancelledOrEndedOn

date

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

adjustsRecurringBillItem

boolean

Indicator whether the plan adjusts a recurring bill item

adjustsBalance

boolean

Indicator whether the plan adjusts a balance

vat

object

The VAT setting for the rent adjustment

rentAdjustmentRules

array

adjustments

array

string

The unique identifier for the adjustment

adjustedOn

date

The date when the adjustment was made in ISO 8601 format

year

string

The year the adjustment is applicable

fromYearlyAmount

object

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

toYearlyAmount

object

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

yearlyAmountChange

object

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

periodAmountChange

object

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

fromPeriodAmount

object

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

toPeriodAmount

object

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

fromBalanceAmount

object

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

toBalanceAmount

object

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

balanceAmountChange

object

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

adjustmentRulesEffects

array

rentAdjustmentRuleId

string

The unique identifier for the corresponding rent adjustment rule

calculatedPercentage

number

The calculated adjustment percentage (if applicable)

fromIndex

number

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

toIndex

number

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

fromYearMonth

string

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

toYearMonth

string

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

fromYearlyAmount

Amount Object

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

toYearlyAmount

object

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

yearlyAmountChange

object

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

periodAmountChange

object

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

fromPeriodAmount

object

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

toPeriodAmount

object

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

fromBalanceAmount

object

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

toBalanceAmount

object

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

balanceAmountChange

object

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

minimumPercentage

number

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

maximumPercentage

number

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

The rent adjustment plan object The category object

curl --request GET \
  --url https://api.helloproper.com/rent-adjustment-plans \
  --header 'Authorization: <api-key>'

{
  "rentAdjustmentPlans": [
    {
      "id": "<string>",
      "leaseId": "<string>",
      "created": "<string>",
      "modified": "<string>",
      "adjusteeRef": "<string>",
      "balanceChargeType": "<string>",
      "nextAdjustmentDate": "<string>",
      "cancelledOn": "<string>",
      "endedOn": "<string>",
      "cancelledOrEndedOn": "<string>",
      "adjustsRecurringBillItem": true,
      "adjustsBalance": true,
      "vat": {
        "taxMode": "<string>",
        "taxRate": 123
      },
      "rentAdjustmentRules": [
        {
          "id": "<string>",
          "adjustmentType": "<string>",
          "adjustmentMonth": 123,
          "firstYear": "<string>",
          "lastYear": "<string>",
          "indexMonth": 123,
          "minimumPercentage": 123,
          "maximumPercentage": 123,
          "increments": [
            {
              "year": "<string>",
              "amount": {
                "currency": "<string>",
                "amount": 123
              },
              "percentage": 123,
              "recurrence": "<string>"
            }
          ]
        }
      ],
      "adjustments": [
        {
          "id": "<string>",
          "adjustedOn": "<string>",
          "year": "<string>",
          "fromYearlyAmount": {
            "currency": "<string>",
            "amount": 123
          },
          "toYearlyAmount": {
            "currency": "<string>",
            "amount": 123
          },
          "yearlyAmountChange": {
            "currency": "<string>",
            "amount": 123
          },
          "periodAmountChange": {
            "currency": "<string>",
            "amount": 123
          },
          "fromPeriodAmount": {
            "currency": "<string>",
            "amount": 123
          },
          "toPeriodAmount": {
            "currency": "<string>",
            "amount": 123
          },
          "fromBalanceAmount": {
            "currency": "<string>",
            "amount": 123
          },
          "toBalanceAmount": {
            "currency": "<string>",
            "amount": 123
          },
          "balanceAmountChange": {
            "currency": "<string>",
            "amount": 123
          },
          "adjustmentRulesEffects": [
            {
              "rentAdjustmentRuleId": "<string>",
              "calculatedPercentage": 123,
              "fromIndex": 123,
              "toIndex": 123,
              "fromYearMonth": "<string>",
              "toYearMonth": "<string>",
              "fromYearlyAmount": {
                "currency": "<string>",
                "amount": 123
              },
              "toYearlyAmount": {
                "currency": "<string>",
                "amount": 123
              },
              "yearlyAmountChange": {
                "currency": "<string>",
                "amount": 123
              },
              "periodAmountChange": {
                "currency": "<string>",
                "amount": 123
              },
              "fromPeriodAmount": {
                "currency": "<string>",
                "amount": 123
              },
              "toPeriodAmount": {
                "currency": "<string>",
                "amount": 123
              },
              "fromBalanceAmount": {
                "currency": "<string>",
                "amount": 123
              },
              "toBalanceAmount": {
                "currency": "<string>",
                "amount": 123
              },
              "balanceAmountChange": {
                "currency": "<string>",
                "amount": 123
              },
              "minimumPercentage": 123,
              "maximumPercentage": 123
            }
          ]
        }
      ]
    }
  ]
}

API reference

Resources

List rent adjustments

Request

Response

API reference

Resources

​Request

​Response

Request

Response