Skip to main content
POST
/
api
/
{portfolio}
/
portfolios
/
v1
/
tenants
/
get_by_uuids
[
  {
    "tenantUuid": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
    "rentalRecordUuids": [
      "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "3fa85f64-5717-4562-b3fc-2c963f66afa7"
    ],
    "noteUuids": [
      "4b5c6d7e-8f9a-0b1c-2d3e-4f5a6b7c8d9e",
      "5c6d7e8f-9a0b-1c2d-3e4f-5a6b7c8d9e0f"
    ],
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-20T15:45:00.000Z",
    "primaryPersonUuid": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
    "primaryContact": {
      "firstName": "Jane",
      "lastName": "Doe",
      "optedIntoSms": true,
      "address1": "123 Main St",
      "address2": "Apt 4B",
      "city": "Anytown",
      "state": "CA",
      "zipcode": "90210",
      "email": "[email protected]",
      "phone": "+15551234567"
    },
    "active": true,
    "sourceLeadUuids": [
      "6fa85f64-5717-4562-b3fc-2c963f66afa6",
      "7fa85f64-5717-4562-b3fc-2c963f66afa7"
    ],
    "alternateContacts": [],
    "nextBillingDueDate": "2024-02-15T00:00:00.000Z",
    "owedBalance": 1250.5,
    "balanceAge": 15,
    "desiredMoveInDate": "2024-03-15T00:00:00.000Z"
  }
]

Headers

​
x-api-key
any

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

Example:

"monument-2230012-2312321"

Path Parameters

Body

application/json
​
tenantUuids
string<uuid>[]
required

Array of tenant UUIDs to retrieve details for

Example:
[
  "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
  "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a12"
]

Response

Tenant details retrieved successfully

​
tenantUuid
string<uuid>
required

Tenant UUID

Example:

"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11"

​
rentalRecordUuids
string<uuid>[]
required

Array of associated rental record UUIDs

Example:
[
  "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "3fa85f64-5717-4562-b3fc-2c963f66afa7"
]
​
noteUuids
string<uuid>[]
required

Array of note UUIDs associated with the tenant

Example:
[
  "4b5c6d7e-8f9a-0b1c-2d3e-4f5a6b7c8d9e",
  "5c6d7e8f-9a0b-1c2d-3e4f-5a6b7c8d9e0f"
]
​
createdAt
string<date-time>
required

Timestamp when the tenant was created

Example:

"2024-01-15T10:30:00.000Z"

​
updatedAt
string<date-time>
required

Timestamp when the tenant was last updated

Example:

"2024-01-20T15:45:00.000Z"

​
primaryPersonUuid
string<uuid>
required

Primary person UUID associated with the tenant

Example:

"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11"

​
primaryContact
object
required

Primary contact details for the tenant

​
active
boolean
required

Whether the tenant has any active rental records (startRentDate <= now and (endRentDate >= now or endRentDate is null))

Example:

true

​
sourceLeadUuids
string<uuid>[]
required

Array of lead UUIDs associated with this account

Example:
[
  "6fa85f64-5717-4562-b3fc-2c963f66afa6",
  "7fa85f64-5717-4562-b3fc-2c963f66afa7"
]
​
alternateContacts
object[]

Array of alternate contact details (if available)

Example:
[]
​
nextBillingDueDate
string<date-time> | null

Earliest billing due date from billing templates for this tenant

Example:

"2024-02-15T00:00:00.000Z"

​
owedBalance
number | null

Sum of the positive balances for the unit rental records associated with this tenant, this does not include credits when tenant does not owe money. Returned in pennies.

Example:

1250.5

​
balanceAge
number | null

Days since today for the oldest created date of still open/overdue/partial invoices. 0 if no such invoices exist

Example:

15

​
desiredMoveInDate
string<date-time> | null

Desired move-in date from associated leads

Example:

"2024-03-15T00:00:00.000Z"