Skip to content

Get Deal Collateral Summary

Retrieves summary information for all collateral properties securing a deal, including valuations, NOI, square footage, unit counts, and property identifiers.

Key Details

  • Returns an array of collateralSummaries[] — one entry per collateral property in the deal.
  • Each summary includes id (collateral UUID), name (property name), address, netIncome, netOperatingIncome (NOI), and three valuation methods: incomeValuation, salesValuation, and alternativeValuation.
  • All monetary values are in USD.
  • totalSF and totalUnit provide aggregate square footage and unit counts across all components within each collateral.
  • Useful for multi-collateral deals where you need a quick property-level breakdown without drilling into components or cash flows.

Parameters

dealId string

Unique identifier for the deal

Response

Status: 200

Type: application/json

Schema: CollateralSummaryResponseDto

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 ]
collateralSummaries array [ CollateralSummaryDto ]
id string

Unique identifier for the collateral property

address AddressDto
fullAddress string

Complete street address validated by Google Places API (e.g., "1600 Amphitheatre Parkway, Mountain View, CA 94043")

placeId string

Google Places unique identifier for this address

geoLocation LatLng

lat number(double)

lng number(double)

zipCode string

number integer(int32)

street string

city string

county string

state string

country string

additionalFreeText string

Additional address information such as suite or unit number

name string

netIncome number(double)

Net income after operating expenses and below-the-line expenses, in USD

netOperatingIncome number(double)

Net Operating Income (NOI) calculated as revenue minus operating expenses before debt service, in USD

incomeValuation number(double)

Property value derived from capitalizing NOI (NOI / Cap Rate), in USD

alternativeValuation number(double)

Alternative property value from appraisal, broker opinion, or other valuation method, in USD

salesValuation number(double)

Property value derived from sales comparable analysis, in USD

totalSF number(double)

Total square footage of the collateral property

totalUnit number(double)

Total number of units in the collateral property

yearBuilt number(double)

Year the property was originally constructed

GET 
/api/apiGateway/getDealCollateralSummary/{dealId}
Response
{
  "success": true,
  "error": {
    "target": "string",
    "code": "Duplicated",
    "message": "string",
    "details": [
      {}
    ]
  },
  "collateralSummaries": [
    {
      "id": "string",
      "address": {
        "fullAddress": "string",
        "placeId": "string",
        "geoLocation": {
          "lat": 0.0,
          "lng": 0.0
        },
        "zipCode": "string",
        "number": 0,
        "street": "string",
        "city": "string",
        "county": "string",
        "state": "string",
        "country": "string",
        "additionalFreeText": "string"
      },
      "name": "string",
      "netIncome": 0.0,
      "netOperatingIncome": 0.0,
      "incomeValuation": 0.0,
      "alternativeValuation": 0.0,
      "salesValuation": 0.0,
      "totalSF": 0.0,
      "totalUnit": 0.0,
      "yearBuilt": 0.0
    }
  ]
}