Skip to main content
POST
/
api
/
{portfolio}
/
portfolios
/
v1
/
facilities
/
{facilityUuid}
/
delinquencies
/
get_by_uuids
Get delinquencies by UUIDs
curl --request POST \
  --url https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/delinquencies/get_by_uuids \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "delinquencyUuids": [
    "<string>"
  ]
}
'
[
  {
    "rentalRecordUuid": "<string>",
    "unitUuid": "<string>",
    "accountUuid": "<string>",
    "stage": "<string>",
    "balance": 123,
    "unitNumber": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
]

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
delinquencyUuids
string[]
required

Array of delinquency UUIDs to retrieve

Response

200 - application/json

Array of delinquency details

rentalRecordUuid
string
required

Rental record UUID

unitUuid
string
required

Unit UUID

accountUuid
string
required

Account UUID

stage
string
required

Delinquency status/stage

balance
number
required

Unit rental record balance

unitNumber
string
required

Unit number

createdAt
string<date-time>
required

Creation date

updatedAt
string<date-time>
required

Last update date