Get rental records by UUIDs for a facility

POST

api

{portfolio}

portfolios

facilities

{facilityUuid}

rentalRecords

get_by_uuids

Get rental records by UUIDs for a facility

curl --request POST \
  --url https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/rentalRecords/get_by_uuids \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "unitRentalRecordUuids": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "3fa85f64-5717-4562-b3fc-2c963f66afa7"
  ]
}
'

import requests

url = "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/rentalRecords/get_by_uuids"

payload = { "unitRentalRecordUuids": ["3fa85f64-5717-4562-b3fc-2c963f66afa6", "3fa85f64-5717-4562-b3fc-2c963f66afa7"] }
headers = {
    "x-api-key": "<x-api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    unitRentalRecordUuids: ['3fa85f64-5717-4562-b3fc-2c963f66afa6', '3fa85f64-5717-4562-b3fc-2c963f66afa7']
  })
};

fetch('https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/rentalRecords/get_by_uuids', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/rentalRecords/get_by_uuids",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'unitRentalRecordUuids' => [
        '3fa85f64-5717-4562-b3fc-2c963f66afa6',
        '3fa85f64-5717-4562-b3fc-2c963f66afa7'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/rentalRecords/get_by_uuids"

	payload := strings.NewReader("{\n  \"unitRentalRecordUuids\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa7\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<x-api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/rentalRecords/get_by_uuids")
  .header("x-api-key", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"unitRentalRecordUuids\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa7\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/rentalRecords/get_by_uuids")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"unitRentalRecordUuids\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa7\"\n  ]\n}"

response = http.request(request)
puts response.read_body

[
  {
    "unitUuid": "2a3b4c5d-6e7f-8a9b-0c1d-2e3f4a5b6c7d",
    "facilityUuid": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "rentalRecordUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantUuid": "4b5c6d7e-8f9a-0b1c-2d3e-4f5a6b7c8d9e",
    "tenantStatus": "ACTIVE",
    "isAutopayEnabled": true,
    "status": "MOVED_IN",
    "balance": 12500,
    "paidThroughDate": "2024-01-15",
    "startDate": "2024-01-15",
    "endDate": null,
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-20T15:45:00.000Z",
    "delinquent": false,
    "currentCoveragePartnerId": "COVERAGE_PARTNER_123",
    "coverageUuid": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "billingDayOfMonth": 15,
    "balanceAge": 5,
    "unitBlockedAccessDate": "2024-01-15T10:30:00.000Z",
    "facilityBlockedAccessDate": "2024-01-15T10:30:00.000Z",
    "delinquencyStatus": "OVERDUE",
    "desiredMoveOutDate": "2024-12-31",
    "nextRentInPennies": 16000,
    "nextRentChangeDate": "2025-02-01",
    "previousRentInPennies": 14000,
    "previousRentChangeDate": "2024-06-01",
    "billingTemplate": {
      "currentRentInPennies": 15000,
      "additionalServicesAndFees": [
        {
          "description": "Climate Control Service",
          "amountInPennies": 2500,
          "itemTypeUuid": "5c6d7e8f-9a0b-1c2d-3e4f-5a6b7c8d9e0f",
          "category": "SERVICE",
          "taxAmountInPennies": 200
        }
      ],
      "promotions": [
        {
          "promotionUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "discountType": "PERCENTAGE",
          "fixedDiscountAmountInPennies": 5000,
          "discountPercentage": 10.5,
          "promotionName": "First Month 50% Off",
          "discountAmountType": "OFF_RENT",
          "startPromotionDate": "2025-03-01",
          "durationInMonths": 3,
          "monthStarts": 0,
          "dateCreated": "2025-02-28T15:30:00.000Z",
          "dateArchived": null,
          "isArchived": false
        }
      ],
      "billingDayOfMonth": 15,
      "nextDueDate": "2024-02-15"
    },
    "primaryContact": {
      "firstName": "Jane",
      "lastName": "Doe",
      "address1": "123 Main St",
      "address2": "Apt 4B",
      "city": "Anytown",
      "state": "CA",
      "zipcode": "90210",
      "email": "jane.doe@example.com",
      "phone": "+15551234567",
      "optedIntoSms": true,
      "dateOfBirth": "2024-01-01"
    },
    "alternateContacts": [
      {
        "firstName": "Jane",
        "lastName": "Doe",
        "address1": "123 Main St",
        "address2": "Apt 4B",
        "city": "Anytown",
        "state": "CA",
        "zipcode": "90210",
        "email": "jane.doe@example.com",
        "phone": "+15551234567",
        "optedIntoSms": true,
        "dateOfBirth": "2024-01-01"
      }
    ],
    "accountOwedBalance": 25000,
    "unitNumber": "A101",
    "unitStatus": "VACANT",
    "businessName": "Acme Storage LLC",
    "paymentProfile": [
      {
        "paymentProfileUuid": "1-1-1-1-1",
        "accountType": "ACH",
        "creditCardBrand": "Visa",
        "lastFour": "4444",
        "expirationDate": "01/2025",
        "lastPaymentStatus": "SUCCESS"
      }
    ],
    "lastPayment": {
      "lastPaymentDate": "2023-11-07T05:31:56Z",
      "lastPaymentAmountInPennies": 5000
    }
  }
]

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

Query Parameters

Body

application/json

unitRentalRecordUuids

string<uuid>[]

required

Array of unit rental record UUIDs to retrieve data for

Example:

[
  "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "3fa85f64-5717-4562-b3fc-2c963f66afa7"
]

Response

200 - application/json

Successfully retrieved rental records data

unitUuid

string<uuid>

required

Unit UUID associated with this rental record

Example:

"2a3b4c5d-6e7f-8a9b-0c1d-2e3f4a5b6c7d"

facilityUuid

string<uuid>

required

Facility UUID where the unit is located

Example:

"1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d"

rentalRecordUuid

string<uuid>

required

Rental record UUID

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

tenantUuid

string<uuid>

required

Tenant UUID associated with this rental record

Example:

"4b5c6d7e-8f9a-0b1c-2d3e-4f5a6b7c8d9e"

tenantStatus

enum<string>

required

Tenant status associated with this rental record

Available options:

PENDING_ACTIVATION,

ACTIVE,

PENDING_DEACTIVATION,

DEACTIVATED

Example:

"ACTIVE"

isAutopayEnabled

boolean

required

Whether the rental record currently has autopay enabled

Example:

true

status

string

required

Current status of the rental record

Example:

"MOVED_IN"

balance

number

required

Current balance on the rental record in pennies

Example:

12500

paidThroughDate

string<date> | null

required

Date when the rental record is paid through

Example:

"2024-01-15"

startDate

string<date>

required

Start date of the rental agreement

Example:

"2024-01-15"

endDate

string<date> | null

required

End date of the rental agreement (null if ongoing)

Example:

null

createdAt

string<date-time>

required

Timestamp when the rental record was created

Example:

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

updatedAt

string<date-time>

required

Timestamp when the rental record was last updated

Example:

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

delinquent

boolean

required

Whether the rental record is currently delinquent

Example:

false

currentCoveragePartnerId

string | null

required

Current coverage partner ID (null if no coverage)

Example:

"COVERAGE_PARTNER_123"

coverageUuid

string<uuid> | null

required

UUID of the coverage. For private coverage, this will be the private coverage UUID: 11111111-1111-1111-1111-111111111111

Example:

"1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d"

billingDayOfMonth

number

required

Day of month when billing occurs

Example:

15

balanceAge

number

required

Age of balance in 24-hour increments since oldest open/partial/overdue invoice

Example:

5

unitBlockedAccessDate

string<date> | null

required

Date when the unit was blocked from access

Example:

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

facilityBlockedAccessDate

string<date> | null

required

Date when the facility was blocked from access

Example:

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

delinquencyStatus

string | null

required

Delinquency status if there is an active delinquency, null otherwise

Example:

"OVERDUE"

desiredMoveOutDate

string<date> | null

required

Desired move-out date for the tenant (null if not specified)

Example:

"2024-12-31"

nextRentInPennies

number | null

required

Next scheduled rent amount in pennies

Example:

16000

nextRentChangeDate

string<date> | null

required

Date when the next rent amount becomes effective

Example:

"2025-02-01"

previousRentInPennies

number | null

required

Previous rent amount in pennies

Example:

14000

previousRentChangeDate

string<date> | null

required

Date when the previous rent amount changed

Example:

"2024-06-01"

billingTemplate

object | null

required

Billing template information for this rental record

Show child attributes

primaryContact

object

required

Contact details for the

Show child attributes

alternateContacts

object[]

required

Contact details for the alternate contacts

Show child attributes

accountOwedBalance

number

required

Sum of all positive balances across the tenant's entire account (in pennies)

Example:

25000

unitNumber

string

required

Unit number

Example:

"A101"

unitStatus

enum<string>

required

Unit occupancy status

Available options:

VACANT,

RESERVED,

OCCUPIED,

UNRENTABLE,

OWNER OCCUPIED,

PENDING_SIGNATURE

Example:

"VACANT"

businessName

string | null

Business name (populated for BUSINESS accounts, null for PERSONAL)

Example:

"Acme Storage LLC"

paymentProfile

object[]

Included when ?expand[paymentProfile][] is present; autopay payment profile for this rental record

Show child attributes

lastPayment

object | null

Included when ?expand[lastPayment][] is present; most recent payment for this rental record

Show child attributes

Update coverage selection for a unit rentalUpdates coverage to the new selection, ending current coverage for the unit rental, applying a prorated credit memo for their current or future invoices

Get rental records by UUIDs for a facility

curl --request POST \
  --url https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/rentalRecords/get_by_uuids \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "unitRentalRecordUuids": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "3fa85f64-5717-4562-b3fc-2c963f66afa7"
  ]
}
'

import requests

url = "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/rentalRecords/get_by_uuids"

payload = { "unitRentalRecordUuids": ["3fa85f64-5717-4562-b3fc-2c963f66afa6", "3fa85f64-5717-4562-b3fc-2c963f66afa7"] }
headers = {
    "x-api-key": "<x-api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    unitRentalRecordUuids: ['3fa85f64-5717-4562-b3fc-2c963f66afa6', '3fa85f64-5717-4562-b3fc-2c963f66afa7']
  })
};

fetch('https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/rentalRecords/get_by_uuids', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/rentalRecords/get_by_uuids",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'unitRentalRecordUuids' => [
        '3fa85f64-5717-4562-b3fc-2c963f66afa6',
        '3fa85f64-5717-4562-b3fc-2c963f66afa7'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/rentalRecords/get_by_uuids"

	payload := strings.NewReader("{\n  \"unitRentalRecordUuids\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa7\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<x-api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/rentalRecords/get_by_uuids")
  .header("x-api-key", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"unitRentalRecordUuids\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa7\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/rentalRecords/get_by_uuids")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"unitRentalRecordUuids\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa7\"\n  ]\n}"

response = http.request(request)
puts response.read_body

[
  {
    "unitUuid": "2a3b4c5d-6e7f-8a9b-0c1d-2e3f4a5b6c7d",
    "facilityUuid": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "rentalRecordUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantUuid": "4b5c6d7e-8f9a-0b1c-2d3e-4f5a6b7c8d9e",
    "tenantStatus": "ACTIVE",
    "isAutopayEnabled": true,
    "status": "MOVED_IN",
    "balance": 12500,
    "paidThroughDate": "2024-01-15",
    "startDate": "2024-01-15",
    "endDate": null,
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-20T15:45:00.000Z",
    "delinquent": false,
    "currentCoveragePartnerId": "COVERAGE_PARTNER_123",
    "coverageUuid": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "billingDayOfMonth": 15,
    "balanceAge": 5,
    "unitBlockedAccessDate": "2024-01-15T10:30:00.000Z",
    "facilityBlockedAccessDate": "2024-01-15T10:30:00.000Z",
    "delinquencyStatus": "OVERDUE",
    "desiredMoveOutDate": "2024-12-31",
    "nextRentInPennies": 16000,
    "nextRentChangeDate": "2025-02-01",
    "previousRentInPennies": 14000,
    "previousRentChangeDate": "2024-06-01",
    "billingTemplate": {
      "currentRentInPennies": 15000,
      "additionalServicesAndFees": [
        {
          "description": "Climate Control Service",
          "amountInPennies": 2500,
          "itemTypeUuid": "5c6d7e8f-9a0b-1c2d-3e4f-5a6b7c8d9e0f",
          "category": "SERVICE",
          "taxAmountInPennies": 200
        }
      ],
      "promotions": [
        {
          "promotionUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "discountType": "PERCENTAGE",
          "fixedDiscountAmountInPennies": 5000,
          "discountPercentage": 10.5,
          "promotionName": "First Month 50% Off",
          "discountAmountType": "OFF_RENT",
          "startPromotionDate": "2025-03-01",
          "durationInMonths": 3,
          "monthStarts": 0,
          "dateCreated": "2025-02-28T15:30:00.000Z",
          "dateArchived": null,
          "isArchived": false
        }
      ],
      "billingDayOfMonth": 15,
      "nextDueDate": "2024-02-15"
    },
    "primaryContact": {
      "firstName": "Jane",
      "lastName": "Doe",
      "address1": "123 Main St",
      "address2": "Apt 4B",
      "city": "Anytown",
      "state": "CA",
      "zipcode": "90210",
      "email": "jane.doe@example.com",
      "phone": "+15551234567",
      "optedIntoSms": true,
      "dateOfBirth": "2024-01-01"
    },
    "alternateContacts": [
      {
        "firstName": "Jane",
        "lastName": "Doe",
        "address1": "123 Main St",
        "address2": "Apt 4B",
        "city": "Anytown",
        "state": "CA",
        "zipcode": "90210",
        "email": "jane.doe@example.com",
        "phone": "+15551234567",
        "optedIntoSms": true,
        "dateOfBirth": "2024-01-01"
      }
    ],
    "accountOwedBalance": 25000,
    "unitNumber": "A101",
    "unitStatus": "VACANT",
    "businessName": "Acme Storage LLC",
    "paymentProfile": [
      {
        "paymentProfileUuid": "1-1-1-1-1",
        "accountType": "ACH",
        "creditCardBrand": "Visa",
        "lastFour": "4444",
        "expirationDate": "01/2025",
        "lastPaymentStatus": "SUCCESS"
      }
    ],
    "lastPayment": {
      "lastPaymentDate": "2023-11-07T05:31:56Z",
      "lastPaymentAmountInPennies": 5000
    }
  }
]