Skip to content

Get Residential Rentroll Info

Retrieves tenant-level rent roll information for a residential component, including lease terms, rental rates, unit types, bedroom/bathroom counts, and unit mix summaries.

Key Details

  • Returns rentRollItems[] — one entry per residential unit/tenant with unitNumber, tenantName, bedrooms, bathrooms, unitSize (in SF), monthlyRent, annualRent, per-SF rates, lease start/end dates, and unitType (e.g., "2BR/1BA").
  • unitTypeSummaryTable[] provides aggregate metrics by unit type — totalUnits, bedrooms, bathrooms, average SF, and average monthly revenue per SF and per unit. This is useful for quick unit mix analysis.
  • totalSf and totalUnits aggregate square footage and unit count across the rent roll.
  • monthlyRevenue, annualRevenue, monthlyRevenuePerSf, and annualRevenuePerSf provide rolled-up revenue metrics.
  • vacancy is expressed as a decimal (e.g., 0.05 = 5% vacant).
  • expiringLeases breaks down lease rollover by year — useful for understanding turnover timing.
  • tenantTurnover indicates the annual tenant churn rate.
  • fileId references the uploaded rent roll document. effectiveDate is the date the rent roll snapshot was taken.
  • All monetary values are in USD.

Parameters

id string

Unique identifier for the residential rent roll

Response

Status: 200

Type: application/json

Schema: ResidentialRentRollInfoResponseDto

success boolean

Indicates whether the API request completed successfully

error ErrorDto
target string

Field or parameter that caused the error

code string(enum)

Error code (e.g., Duplicated, MissingMandatoryField, InvalidCreateValues, MissingEntity)

Available enum values: Duplicated, MissingMandatoryField, InvalidCreateValues, Existing, ValidationError, MissingEntity

message string

details array [ ErrorDto ]
id string

Unique identifier for this rent roll

componentId string

ID of the property component this rent roll belongs to

name string

fileId string

ID of the uploaded rent roll document

effectiveDate string(date)

Date the rent roll data is effective as of

comment string

totalSf number(double)

Total square footage covered by the rent roll

totalUnits number(double)

Total units in the rent roll

totalMonthlyRevenue number(double)

Total monthly rent revenue, in USD

totalMonthlyRevenuePerSf number(double)

Average monthly rent per square foot, in USD

totalAnnualRevenue number(double)

Total annual rent revenue, in USD

totalAnnualRevenuePerSf number(double)

Average annual rent per square foot, in USD

vacancy number(double)

Vacancy rate calculated from the rent roll, expressed as a decimal (e.g., 0.08 = 8%)

tenantTurnover number(double)

Annual tenant turnover rate, expressed as a decimal (e.g., 0.30 = 30%)

expiringLeases map { number(double) }

unitTypeSummaryTable array [ RentRollUnitTypeSummaryDto ]
totalUnits number(double)

Total units of this unit type

bedrooms number(double)

Number of bedrooms for this unit type

bathrooms number(double)

Number of bathrooms for this unit type

avgSf number(double)

Average square footage for this unit type

avgMonthlyRevenuePerSf number(double)

Average monthly rent per square foot, in USD

avgMonthlyRevenuePerUnit number(double)

Average monthly rent per unit, in USD

rentRollItems array [ ResidentialRentRollItemDto ]
id string

Unique identifier for this rent roll line item

unitNumber string

tenantName string

monthlyRent number(double)

Monthly rent for this unit, in USD

unitSize number(double)

Square footage of this unit

leaseStart string(date)

Lease start date (ISO 8601 format: YYYY-MM-DD)

leaseEnd string(date)

Lease end date (ISO 8601 format: YYYY-MM-DD)

annualRent number(double)

Annual rent for this unit, in USD

monthlyRentPerSf number(double)

Monthly rent per square foot, in USD

annualRentPerSf number(double)

Annual rent per square foot, in USD

unitType string

bedrooms number(double)

Number of bedrooms

bathrooms number(double)

Number of bathrooms

GET 
/api/apiGateway/getResidentialRentrollInfo/{id}
Response
{
  "success": true,
  "error": {
    "target": "string",
    "code": "Duplicated",
    "message": "string",
    "details": [
      {}
    ]
  },
  "id": "string",
  "componentId": "string",
  "name": "string",
  "fileId": "string",
  "effectiveDate": "2025-01-01",
  "comment": "string",
  "totalSf": 0.0,
  "totalUnits": 0.0,
  "totalMonthlyRevenue": 0.0,
  "totalMonthlyRevenuePerSf": 0.0,
  "totalAnnualRevenue": 0.0,
  "totalAnnualRevenuePerSf": 0.0,
  "vacancy": 0.0,
  "tenantTurnover": 0.0,
  "expiringLeases": {
    "key": 0.0
  },
  "unitTypeSummaryTable": [
    {
      "totalUnits": 0.0,
      "bedrooms": 0.0,
      "bathrooms": 0.0,
      "avgSf": 0.0,
      "avgMonthlyRevenuePerSf": 0.0,
      "avgMonthlyRevenuePerUnit": 0.0
    }
  ],
  "rentRollItems": [
    {
      "id": "string",
      "unitNumber": "string",
      "tenantName": "string",
      "monthlyRent": 0.0,
      "unitSize": 0.0,
      "leaseStart": "2025-01-01",
      "leaseEnd": "2025-01-01",
      "annualRent": 0.0,
      "monthlyRentPerSf": 0.0,
      "annualRentPerSf": 0.0,
      "unitType": "string",
      "bedrooms": 0.0,
      "bathrooms": 0.0
    }
  ]
}