List rent adjustments
curl --request GET \
--url https://api.helloproper.com/rent-adjustment-plans \
--header 'Authorization: <api-key>'import requests
url = "https://api.helloproper.com/rent-adjustment-plans"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.helloproper.com/rent-adjustment-plans', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.helloproper.com/rent-adjustment-plans",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.helloproper.com/rent-adjustment-plans"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.helloproper.com/rent-adjustment-plans")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.helloproper.com/rent-adjustment-plans")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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
}
]
}
]
}
]
}Rent adjustment
List rent adjustments
GET
/
rent-adjustment-plans
List rent adjustments
curl --request GET \
--url https://api.helloproper.com/rent-adjustment-plans \
--header 'Authorization: <api-key>'import requests
url = "https://api.helloproper.com/rent-adjustment-plans"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.helloproper.com/rent-adjustment-plans', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.helloproper.com/rent-adjustment-plans",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.helloproper.com/rent-adjustment-plans"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.helloproper.com/rent-adjustment-plans")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.helloproper.com/rent-adjustment-plans")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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
array
Show child attributes
Show child 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
object
array
Show child attributes
Show child attributes
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
The increments used for the adjustment year by year
Show child attributes
Show child attributes
string
The year when the increment occurs
object
number
The percentage used for the increment
string
The recurrence of the increment (e.g., “Recurring”, “OneTime”)
array
Show child attributes
Show child attributes
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
object
object
object
object
object
object
object
object
object
array
Show child attributes
Show child attributes
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
object
object
object
object
object
object
object
object
number
The minimum percentage used for the adjustment rule (if applicable)
number
The maximum percentage used for the adjustment rule (if applicable)
⌘I