Skip to content

Get Collateral Component Summary

Retrieves summary information for all property components within a single collateral, providing a quick overview of component-level metrics.

Key Details

  • Returns componentSummary[] — one entry per component (Residential, Commercial, or Hotel) within the specified collateral.
  • Each summary includes id (component UUID), componentType (Residential/Commercial/Hotel), assetType (Office, Multi_Family_Apartments, etc.), and key metrics: totalUnits, totalSf, saleValue, and revenue/vacancy figures.
  • leaseToPreLeaseRatio indicates the proportion of actual leases vs. pre-leased/planned units.
  • selectedRentRollId references the currently active rent roll for the component — use Get Commercial Rentroll Info or Get Residential Rentroll Info to retrieve tenant-level details.
  • Mixed-use properties will return multiple component summaries (e.g., one Residential, one Commercial).

Parameters

collateralId string

Unique identifier for the collateral property

Response

Status: 200

Type: application/json

Schema: ComponentSummaryResponseDto

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 ]
componentSummary array [ ComponentSummaryDto ]
id string

Unique identifier for this component

collateralId string

ID of the collateral property this component belongs to

componentType string(enum)

Property use classification: Residential, Commercial, or Hotel

Available enum values: Unknown, Residential, Commercial, Hotel

assetType string(enum)

Property category (e.g., Multi_Family_Apartments, Office, Retail, Hotel)

Available enum values: None, Mixed, Hotel, Industrial, Multi_Family_Apartments, Office, Retail, Self_Storage, Land, Special_Purpose, Senior_Housing, Distribution_Warehouse, Flex_Office, Portfolio

leaseToPreLeaseRatio number(double)

totalUnits number(double)

Total number of units (apartments, suites, or rooms) in the component

totalSf number(double)

Total square footage of the component

saleValue number(double)

Property value from sales comparables, in USD

totalMarketAnnualRevenue number(double)

Annual revenue based on market rents, in USD

totalConcludedRentAnnualRevenue number(double)

Annual revenue based on analyst-concluded achievable rents, in USD

marketVacancy number(double)

Market vacancy rate, expressed as a decimal (e.g., 0.06 = 6%)

selectedRentRollId string

ID of the primary rent roll used for revenue calculations

totalRentRollAnnualRevenue number(double)

Total annual revenue from the primary rent roll, in USD

rentRollVacancy number(double)

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

GET 
/api/apiGateway/getCollateralComponentSummary/{collateralId}
Response
{
  "success": true,
  "error": {
    "target": "string",
    "code": "Duplicated",
    "message": "string",
    "details": [
      {}
    ]
  },
  "componentSummary": [
    {
      "id": "string",
      "collateralId": "string",
      "componentType": "Unknown",
      "assetType": "None",
      "leaseToPreLeaseRatio": 0.0,
      "totalUnits": 0.0,
      "totalSf": 0.0,
      "saleValue": 0.0,
      "totalMarketAnnualRevenue": 0.0,
      "totalConcludedRentAnnualRevenue": 0.0,
      "marketVacancy": 0.0,
      "selectedRentRollId": "string",
      "totalRentRollAnnualRevenue": 0.0,
      "rentRollVacancy": 0.0
    }
  ]
}