Get facility rent changes by UUIDs

POST

api

{portfolio}

portfolios

facilities

{facilityUuid}

rentChanges

get_by_uuids

Get facility rent changes by UUIDs

curl --request POST \
  --url https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/rentChanges/get_by_uuids \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "rentChangeUuids": [
    "7a3d88e1-2f10-11f0-9c3a-0242ac120002",
    "9c1f0a52-4b7e-11f0-9c3a-0242ac120002"
  ]
}
'

import requests

url = "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/rentChanges/get_by_uuids"

payload = { "rentChangeUuids": ["7a3d88e1-2f10-11f0-9c3a-0242ac120002", "9c1f0a52-4b7e-11f0-9c3a-0242ac120002"] }
headers = {
    "x-api-key": "<x-api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    rentChangeUuids: ['7a3d88e1-2f10-11f0-9c3a-0242ac120002', '9c1f0a52-4b7e-11f0-9c3a-0242ac120002']
  })
};

fetch('https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/rentChanges/get_by_uuids', 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://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/rentChanges/get_by_uuids",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'rentChangeUuids' => [
        '7a3d88e1-2f10-11f0-9c3a-0242ac120002',
        '9c1f0a52-4b7e-11f0-9c3a-0242ac120002'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <x-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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/rentChanges/get_by_uuids"

	payload := strings.NewReader("{\n  \"rentChangeUuids\": [\n    \"7a3d88e1-2f10-11f0-9c3a-0242ac120002\",\n    \"9c1f0a52-4b7e-11f0-9c3a-0242ac120002\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<x-api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/rentChanges/get_by_uuids")
  .header("x-api-key", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"rentChangeUuids\": [\n    \"7a3d88e1-2f10-11f0-9c3a-0242ac120002\",\n    \"9c1f0a52-4b7e-11f0-9c3a-0242ac120002\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/rentChanges/get_by_uuids")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"rentChangeUuids\": [\n    \"7a3d88e1-2f10-11f0-9c3a-0242ac120002\",\n    \"9c1f0a52-4b7e-11f0-9c3a-0242ac120002\"\n  ]\n}"

response = http.request(request)
puts response.read_body

[
  {
    "unitHistoricalRentUuid": "9c1f0a52-4b7e-11f0-9c3a-0242ac120002",
    "unitRentalRecordUuid": "1d9b40c7-0a55-11f0-9c3a-0242ac120002",
    "unitUuid": "b2e7c318-0a55-11f0-9c3a-0242ac120002",
    "unitGroupUuid": "e5f1a904-0a55-11f0-9c3a-0242ac120002",
    "startDate": "2025-09-01",
    "endDate": "2026-02-01",
    "rentInPennies": 19500,
    "priorRentInPennies": 18000,
    "priorRentStartDate": "2025-03-01",
    "priorRentEndDate": "2025-08-31",
    "rentChangeReason": "ECRI",
    "isIncrease": true,
    "rentChangeScheduledDate": "2025-08-02"
  }
]

Headers

x-api-key

any

required

Api key required to authenticate your request. Please reach out to monument for a key.

Example:

"monument-2230012-2312321"

Path Parameters

facilityUuid

string

required

Body

application/json

rentChangeUuids

string<uuid>[]

required

Array of rent change UUIDs to retrieve data for

Example:

[
  "7a3d88e1-2f10-11f0-9c3a-0242ac120002",
  "9c1f0a52-4b7e-11f0-9c3a-0242ac120002"
]

Response

Rent change details retrieved successfully

unitHistoricalRentUuid

string<uuid>

required

UUID of the rent change record

Example:

"9c1f0a52-4b7e-11f0-9c3a-0242ac120002"

unitRentalRecordUuid

string<uuid>

required

UUID of the tenancy this rent applied to

Example:

"1d9b40c7-0a55-11f0-9c3a-0242ac120002"

unitUuid

string<uuid>

required

UUID of the unit

Example:

"b2e7c318-0a55-11f0-9c3a-0242ac120002"

unitGroupUuid

string<uuid> | null

required

UUID of the unit group

Example:

"e5f1a904-0a55-11f0-9c3a-0242ac120002"

startDate

string<date>

required

Date this rent took effect. A tenancy that reached move-out with no rent history recorded carries a synthetic row dated 1971 holding the unit rate rather than a rent that was ever charged.

Example:

"2025-09-01"

endDate

string<date> | null

required

Date this rent stopped applying. Null while it is the latest rent on the tenancy. Written when a period is closed — at move-out, and when a scheduled rent increase is applied — so a non-null value on its own is NOT a move-out signal. On a tenancy with several rent periods the move-out date may land on a row other than the last one.

Example:

"2026-02-01"

rentInPennies

number

required

Rent charged from startDate, in pennies

Example:

19500

priorRentInPennies

number | null

required

Rent that applied immediately before this one on the same tenancy, in pennies. Null on the tenancy first rent record.

Example:

18000

priorRentStartDate

string<date> | null

required

Date the prior rent took effect. Null on the tenancy first rent record.

Example:

"2025-03-01"

priorRentEndDate

string<date> | null

required

Date the prior rent stopped applying. Null on the tenancy first rent record, and also whenever that earlier period was never closed — a rent change applied outside move-out and outside scheduled-increase processing leaves it empty, so this field is commonly absent even when a prior rent exists.

Example:

"2025-08-31"

rentChangeReason

enum<string>

required

Why the rent changed. MOVE_IN is also the column default, so a legacy row saved without an explicit reason reports MOVE_IN. AUTOMATED_ECRI is an existing-customer rate increase applied by auto-scheduling, and is NOT returned by a rentChangeReason=ECRI filter.

Available options:

ECRI,

MOVE_IN,

MANUAL_ADJUSTMENT_MORA,

AUTOMATED_ECRI

Example:

"ECRI"

isIncrease

boolean

required

Whether this change raised the rent

Example:

true

rentChangeScheduledDate

string<date> | null

required

Date the change was scheduled on, when it was scheduled ahead of time. Null otherwise.

Example:

"2025-08-02"

Get facility rent changes by UUIDs

curl --request POST \
  --url https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/rentChanges/get_by_uuids \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "rentChangeUuids": [
    "7a3d88e1-2f10-11f0-9c3a-0242ac120002",
    "9c1f0a52-4b7e-11f0-9c3a-0242ac120002"
  ]
}
'

import requests

url = "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/rentChanges/get_by_uuids"

payload = { "rentChangeUuids": ["7a3d88e1-2f10-11f0-9c3a-0242ac120002", "9c1f0a52-4b7e-11f0-9c3a-0242ac120002"] }
headers = {
    "x-api-key": "<x-api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    rentChangeUuids: ['7a3d88e1-2f10-11f0-9c3a-0242ac120002', '9c1f0a52-4b7e-11f0-9c3a-0242ac120002']
  })
};

fetch('https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/rentChanges/get_by_uuids', 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://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/rentChanges/get_by_uuids",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'rentChangeUuids' => [
        '7a3d88e1-2f10-11f0-9c3a-0242ac120002',
        '9c1f0a52-4b7e-11f0-9c3a-0242ac120002'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <x-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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/rentChanges/get_by_uuids"

	payload := strings.NewReader("{\n  \"rentChangeUuids\": [\n    \"7a3d88e1-2f10-11f0-9c3a-0242ac120002\",\n    \"9c1f0a52-4b7e-11f0-9c3a-0242ac120002\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<x-api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/rentChanges/get_by_uuids")
  .header("x-api-key", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"rentChangeUuids\": [\n    \"7a3d88e1-2f10-11f0-9c3a-0242ac120002\",\n    \"9c1f0a52-4b7e-11f0-9c3a-0242ac120002\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/rentChanges/get_by_uuids")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"rentChangeUuids\": [\n    \"7a3d88e1-2f10-11f0-9c3a-0242ac120002\",\n    \"9c1f0a52-4b7e-11f0-9c3a-0242ac120002\"\n  ]\n}"

response = http.request(request)
puts response.read_body

[
  {
    "unitHistoricalRentUuid": "9c1f0a52-4b7e-11f0-9c3a-0242ac120002",
    "unitRentalRecordUuid": "1d9b40c7-0a55-11f0-9c3a-0242ac120002",
    "unitUuid": "b2e7c318-0a55-11f0-9c3a-0242ac120002",
    "unitGroupUuid": "e5f1a904-0a55-11f0-9c3a-0242ac120002",
    "startDate": "2025-09-01",
    "endDate": "2026-02-01",
    "rentInPennies": 19500,
    "priorRentInPennies": 18000,
    "priorRentStartDate": "2025-03-01",
    "priorRentEndDate": "2025-08-31",
    "rentChangeReason": "ECRI",
    "isIncrease": true,
    "rentChangeScheduledDate": "2025-08-02"
  }
]

Coverage

Portfolios

Facilities

Rental Records

Delinquencies

Item Types

GL Accounts

ECRI

Journal Entries

Ledger Entries

Rent Changes

Summary

Auctions

Tenants

User Accounts

Units

Unit Groups

Physical Locks

Move Out

Leads

Tasks

People

Lead Source Options

Notes

Promotions

Payments

Webhooks

Get facility rent changes by UUIDs

Headers

Path Parameters

Body

Response