Get residential rent roll

GET

/api/apiGateway/getResidentialRentrollInfo/{id}

Get the details of a single residential rent roll, identified by its id.

Parameters

id string

The unique identifier of the rent roll that you want to retrieve.

Response

Type: application/json

Schema: ResidentialRentRollInfoResponseDto

success boolean

Indicates whether the request completed successfully.

error ErrorDto

id string

componentId string

name string

fileId string

effectiveDate string(date)

comment string

totalSf number(double)

Multifamily total SF

totalUnits number(double)

totalMonthlyRevenue number(double)

Rent roll total monthly revenue

totalMonthlyRevenuePerSf number(double)

Rent roll total monthly revenue per SF

totalAnnualRevenue number(double)

totalAnnualRevenuePerSf number(double)

vacancy number(double)

tenantTurnover number(double)

Tenant turnover percentage

expiringLeases map { number(double) }

unitTypeSummaryTable array [ RentRollUnitTypeSummaryDto ]

rentRollItems array [ ResidentialRentRollItemDto ]

HTTPcURL

GET ${BASE_URL}/api/apiGateway/getResidentialRentrollInfo/0b6696e4-7c45-46c2-bb1f-d36d3ee93df7
Accept: */*
Authorization: Bearer eyJz93a...k4laUWw

curl --request GET \
    --url "${BASE_URL}/api/apiGateway/getResidentialRentrollInfo/0b6696e4-7c45-46c2-bb1f-d36d3ee93df7" \
    --header 'Accept: */*' \
    --header 'Authorization: Bearer eyJz93a...k4laUWw'

Response

{
  "success": true,
  "error": {
    "target": "string",
    "code": "Duplicated",
    "message": "string",
    "details": ["string"]
  },
  "id": "string",
  "componentId": "string",
  "name": "string",
  "fileId": "string",
  "effectiveDate": "2025-11-05",
  "comment": "string",
  "totalSf": 0,
  "totalUnits": 0,
  "totalMonthlyRevenue": 0,
  "totalMonthlyRevenuePerSf": 0,
  "totalAnnualRevenue": 0,
  "totalAnnualRevenuePerSf": 0,
  "vacancy": 0,
  "tenantTurnover": 0,
  "expiringLeases": {
    "additionalProp1": 0,
    "additionalProp2": 0,
    "additionalProp3": 0
  },
  "unitTypeSummaryTable": [
    {
      "totalUnits": 0,
      "bedrooms": 0,
      "bathrooms": 0,
      "avgSf": 0,
      "avgMonthlyRevenuePerSf": 0,
      "avgMonthlyRevenuePerUnit": 0
    }
  ],
  "rentRollItems": [
    {
      "id": "string",
      "unitNumber": "string",
      "tenantName": "string",
      "monthlyRent": 0,
      "unitSize": 0,
      "leaseStart": "2025-11-05",
      "leaseEnd": "2025-11-05",
      "annualRent": 0,
      "monthlyRentPerSf": 0,
      "annualRentPerSf": 0,
      "unitType": "string",
      "bedrooms": 0,
      "bathrooms": 0
    }
  ]
}