Skip to main content
POST
Get facility transfers by UUIDs

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

Array of transfer UUIDs to retrieve data for

Example:

Response

Transfer details retrieved successfully

transferUuid
string<uuid>
required

UUID of the transfer

Example:

"7a3d88e1-2f10-11f0-9c3a-0242ac120002"

oldUnitRentalRecordUuid
string<uuid>
required

UUID of the rental record the tenant transferred out of

Example:

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

newUnitRentalRecordUuid
string<uuid> | null
required

UUID of the rental record the tenant transferred into. Set only when the transfer is completed, so it is null on every Scheduled and Canceled transfer.

Example:

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

transferDate
string<date-time> | null
required

When the transfer was completed. Null on every Scheduled and Canceled transfer.

Example:

"2026-09-15T14:32:00.000Z"

creditAmountInPennies
number
required

Credit carried from the old rental record to the new one when the transfer was completed, in pennies. 0 on a Scheduled or Canceled transfer.

Example:

1250

status
enum<string>
required

Scheduled while the transfer is pending, Completed once the tenant has been moved into the new unit, Canceled when the transfer was called off.

Available options:
Scheduled,
Canceled,
Completed
Example:

"Completed"