Skip to main content
POST
/
api
/
{portfolio}
/
portfolios
/
v1
/
facilities
/
{facilityUuid}
/
ecri
/
scheduled
Get scheduled ECRIs
curl --request POST \
  --url https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/ecri/scheduled \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "unitGroupUuids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "unitRentalRecordUuids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "ecriEffectiveDate": "2023-12-25",
  "ecriScheduleDate": "2023-12-25"
}
'
[
  {
    "unitRentalRecordUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "currentRentInPennies": 123,
    "newRentInPennies": 123,
    "ecriEffectiveDate": "2023-12-25"
  }
]

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
​
facilityUuid
string
required

Body

application/json

Optional filters for scheduled ECRIs

​
unitGroupUuids
string<uuid>[]
​
unitRentalRecordUuids
string<uuid>[]
​
ecriEffectiveDate
string<date>
​
ecriScheduleDate
string<date>

Response

200 - application/json

Scheduled ECRIs retrieved successfully

​
unitRentalRecordUuid
string<uuid>
required
​
currentRentInPennies
number
required
​
newRentInPennies
number
required
​
ecriEffectiveDate
string<date>
required