Skip to main content
GET
Get unit rental records overdue for a rent increase

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

portfolio
string
required

Query Parameters

minMonthsSinceLastIncrease
number
required

Minimum number of months since the last rent increase (or since move-in, if never increased) for a rental to be considered overdue.

Required range: x >= 0
min
number
max
number
facilityUuids
string[]
unitGroupUuids
string[]

Response

200 - application/json
unitRentalRecordUuid
string<uuid>
required
unitUuid
string<uuid>
required
unitNumber
string
required
accountUuid
string<uuid>
required
tenantFirstName
string
required
tenantLastName
string
required
facilityUuid
string<uuid>
required
unitGroupUuid
string<uuid>
required
unitGroupTier
string
required
currentRentInPennies
number
required
streetRateInPennies
number
required
occupancyPercent
number
required
totalGroupOccupancyPercent
number
required
lastIncreaseDate
string<date> | null
required
monthsSinceLastIncrease
number
required
startedRentingOn
string<date>
required