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.

Get Residential Component Info — component context for this rent roll
Get Commercial Rentroll Info — for commercial rent rolls
Get Base Component Info — component market data and trends

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

type string(enum)

Available enum values: Actual, Adjusted, Scenario

totals RentRollTotalsDto

totalSf number(double)

totalUnits number(double)

actual RevenueDto

monthly number(double)

Monthly revenue, in USD

monthlyPerSf number(double)

Monthly revenue per square foot, in USD

monthlyPerUnit number(double)

Monthly revenue per unit, in USD

annual number(double)

Annual revenue, in USD

annualPerSf number(double)

Annual revenue per square foot, in USD

annualPerUnit number(double)

Annual revenue per unit, in USD

borrower RevenueDto

monthly number(double)

Monthly revenue, in USD

monthlyPerSf number(double)

Monthly revenue per square foot, in USD

monthlyPerUnit number(double)

Monthly revenue per unit, in USD

annual number(double)

Annual revenue, in USD

annualPerSf number(double)

Annual revenue per square foot, in USD

annualPerUnit number(double)

Annual revenue per unit, in USD

market RevenueDto

monthly number(double)

Monthly revenue, in USD

monthlyPerSf number(double)

Monthly revenue per square foot, in USD

monthlyPerUnit number(double)

Monthly revenue per unit, in USD

annual number(double)

Annual revenue, in USD

annualPerSf number(double)

Annual revenue per square foot, in USD

annualPerUnit number(double)

Annual revenue per unit, in USD

vacancy number(double)

occupancy number(double)

tenantTurnover number(double)

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

expiringLeases map { number(double) }

rentRollItems array [ ResidentialRentRollItemDto ]

id string

Unique identifier for this rent roll line item

unitNumber string

tenantName string

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)

actual RevenueDto

monthly number(double)

Monthly revenue, in USD

monthlyPerSf number(double)

Monthly revenue per square foot, in USD

monthlyPerUnit number(double)

Monthly revenue per unit, in USD

annual number(double)

Annual revenue, in USD

annualPerSf number(double)

Annual revenue per square foot, in USD

annualPerUnit number(double)

Annual revenue per unit, in USD

borrower RevenueDto

monthly number(double)

Monthly revenue, in USD

monthlyPerSf number(double)

Monthly revenue per square foot, in USD

monthlyPerUnit number(double)

Monthly revenue per unit, in USD

annual number(double)

Annual revenue, in USD

annualPerSf number(double)

Annual revenue per square foot, in USD

annualPerUnit number(double)

Annual revenue per unit, in USD

market RevenueDto

monthly number(double)

Monthly revenue, in USD

monthlyPerSf number(double)

Monthly revenue per square foot, in USD

monthlyPerUnit number(double)

Monthly revenue per unit, in USD

annual number(double)

Annual revenue, in USD

annualPerSf number(double)

Annual revenue per square foot, in USD

annualPerUnit number(double)

Annual revenue per unit, 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",
  "type": "Actual",
  "totals": {
    "totalSf": 0.0,
    "totalUnits": 0.0,
    "actual": {
      "monthly": 0.0,
      "monthlyPerSf": 0.0,
      "monthlyPerUnit": 0.0,
      "annual": 0.0,
      "annualPerSf": 0.0,
      "annualPerUnit": 0.0
    },
    "borrower": {
      "monthly": 0.0,
      "monthlyPerSf": 0.0,
      "monthlyPerUnit": 0.0,
      "annual": 0.0,
      "annualPerSf": 0.0,
      "annualPerUnit": 0.0
    },
    "market": {
      "monthly": 0.0,
      "monthlyPerSf": 0.0,
      "monthlyPerUnit": 0.0,
      "annual": 0.0,
      "annualPerSf": 0.0,
      "annualPerUnit": 0.0
    },
    "vacancy": 0.0,
    "occupancy": 0.0
  },
  "tenantTurnover": 0.0,
  "expiringLeases": {
    "key": 0.0
  },
  "rentRollItems": [
    {
      "id": "string",
      "unitNumber": "string",
      "tenantName": "string",
      "unitSize": 0.0,
      "leaseStart": "2025-01-01",
      "leaseEnd": "2025-01-01",
      "actual": {
        "monthly": 0.0,
        "monthlyPerSf": 0.0,
        "monthlyPerUnit": 0.0,
        "annual": 0.0,
        "annualPerSf": 0.0,
        "annualPerUnit": 0.0
      },
      "borrower": {
        "monthly": 0.0,
        "monthlyPerSf": 0.0,
        "monthlyPerUnit": 0.0,
        "annual": 0.0,
        "annualPerSf": 0.0,
        "annualPerUnit": 0.0
      },
      "market": {
        "monthly": 0.0,
        "monthlyPerSf": 0.0,
        "monthlyPerUnit": 0.0,
        "annual": 0.0,
        "annualPerSf": 0.0,
        "annualPerUnit": 0.0
      },
      "unitType": "string",
      "bedrooms": 0.0,
      "bathrooms": 0.0
    }
  ]
}

Get Residential Rentroll Info¶

Key Details¶

Related Endpoints¶

Parameters¶

Response¶