Get cash flow for a collateral¶
Get the cash flow for the provided collateral id.
Parameters¶
id string
The unique identifier of the collateral that you want to retrieve cash flows for.
Response¶
Type: application/json
Schema: CollateralCashFlowResponseDto
success boolean
error ErrorDto
id string
collateralId string
marketCapRate number(double)
mainIncomeValuationCapRate number(double)
marketValuation RevenueValuationDto
salesValuation number(double)
mainIncomeValuationId string
mainAlternativeValuationId string
mainAlternativeValuation number(double)
mainAlternativeValuationDate string(date)
capRateLastModifiedTime string(date)
rentRollRevenues map { number(double) }
componentTotals ComponentTotalsDto
revenueValuations array [ RevenueValuationDto ]
alternativeValuations array [ AlternativeValuationDto ]
dcfModel DcfModelDto
Response
{
"success": true,
"error": {
"target": "string",
"code": "Duplicated",
"message": "string",
"details": ["string"]
},
"id": "string",
"collateralId": "string",
"marketCapRate": 0,
"mainIncomeValuationCapRate": 0,
"marketValuation": {
"capRate": 0,
"name": "string",
"valuationsInfoId": "string",
"startDate": "2026-01-15",
"endDate": "2026-01-15",
"expensesSourceId": "string",
"userValuationType": "string",
"comment": "string",
"revenueSource": "Market",
"capRateSource": "Market",
"vacancySource": "Market",
"cashFlow": {
"valuationsInfoId": "string",
"fileId": "string",
"comment": "string",
"revenue": {
"total": 0,
"totalByYear": [0],
"groupedTransactions": [
{
"group": "string",
"totalAmount": 0,
"totalPerSf": 0,
"totalPerUnit": 0,
"totalPercentageEGI": 0,
"transactions": [
{
"description": "string",
"group": "string",
"amount": 0,
"measureType": "Unspecified",
"annualized": 0,
"annualizedPerSf": 0,
"annualizedPerUnit": 0,
"annualizedPercentageEGI": 0,
"annualizedByYear": [0],
"comment": "string"
}
]
}
]
},
"vacancyAndConcessions": {
"total": 0,
"totalByYear": [0],
"groupedTransactions": [
{
"group": "string",
"totalAmount": 0,
"totalPerSf": 0,
"totalPerUnit": 0,
"totalPercentageEGI": 0,
"transactions": [
{
"description": "string",
"group": "string",
"amount": 0,
"measureType": "Unspecified",
"annualized": 0,
"annualizedPerSf": 0,
"annualizedPerUnit": 0,
"annualizedPercentageEGI": 0,
"annualizedByYear": [0],
"comment": "string"
}
]
}
]
},
"otherIncome": {
"total": 0,
"totalByYear": [0],
"groupedTransactions": [
{
"group": "string",
"totalAmount": 0,
"totalPerSf": 0,
"totalPerUnit": 0,
"totalPercentageEGI": 0,
"transactions": [
{
"description": "string",
"group": "string",
"amount": 0,
"measureType": "Unspecified",
"annualized": 0,
"annualizedPerSf": 0,
"annualizedPerUnit": 0,
"annualizedPercentageEGI": 0,
"annualizedByYear": [0],
"comment": "string"
}
]
}
]
},
"operatingExpenses": {
"total": 0,
"totalByYear": [0],
"groupedTransactions": [
{
"group": "string",
"totalAmount": 0,
"totalPerSf": 0,
"totalPerUnit": 0,
"totalPercentageEGI": 0,
"transactions": [
{
"description": "string",
"group": "string",
"amount": 0,
"measureType": "Unspecified",
"annualized": 0,
"annualizedPerSf": 0,
"annualizedPerUnit": 0,
"annualizedPercentageEGI": 0,
"annualizedByYear": [0],
"comment": "string"
}
]
}
]
},
"belowTheLineExpense": {
"total": 0,
"totalByYear": [0],
"groupedTransactions": [
{
"group": "string",
"totalAmount": 0,
"totalPerSf": 0,
"totalPerUnit": 0,
"totalPercentageEGI": 0,
"transactions": [
{
"description": "string",
"group": "string",
"amount": 0,
"measureType": "Unspecified",
"annualized": 0,
"annualizedPerSf": 0,
"annualizedPerUnit": 0,
"annualizedPercentageEGI": 0,
"annualizedByYear": [0],
"comment": "string"
}
]
}
]
},
"effectiveIncome": 0,
"effectiveIncomeByYear": [0],
"totalExpenses": 0,
"totalExpensesByYear": [0],
"netOperatingIncome": 0,
"netOperatingIncomeByYear": [0],
"netIncome": 0,
"netIncomeByYear": [0],
"dcfModel": {
"discountRate": 0,
"revenueGrowth": [0],
"expenseGrowth": [0]
},
"finalSale": 0,
"presentValues": [0],
"netPresentValue": 0,
"expenseRatio": 0
},
"totalValuation": 0,
"parentId": "string",
"descriptor": "string",
"archive": true,
"componentsVacancies": {
"additionalProp1": {
"amountValue": 0,
"percentageValue": 0
},
"additionalProp2": {
"amountValue": 0,
"percentageValue": 0
},
"additionalProp3": {
"amountValue": 0,
"percentageValue": 0
}
},
"componentsSelectedRentRolls": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"metrics": [
{
"dealId": "string",
"dscr": 0,
"ltv": 0,
"debtYield": 0
}
]
},
"salesValuation": 0,
"mainIncomeValuationId": "string",
"mainAlternativeValuationId": "string",
"mainAlternativeValuation": 0,
"mainAlternativeValuationDate": "2026-01-15",
"capRateLastModifiedTime": "2026-01-15",
"rentRollRevenues": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"componentTotals": {
"componentsData": [
{
"id": "string",
"assetType": "None",
"totalSf": 0,
"totalUnits": 0,
"saleValue": 0,
"totalMarketAnnualRevenue": 0,
"totalRentRollAnnualRevenue": 0,
"marketVacancy": 0,
"rentRollVacancy": 0
}
],
"totalSaleValue": 0,
"totalSf": 0,
"totalUnits": 0
},
"revenueValuations": [
{
"capRate": 0,
"name": "string",
"valuationsInfoId": "string",
"startDate": "2026-01-15",
"endDate": "2026-01-15",
"expensesSourceId": "string",
"userValuationType": "string",
"comment": "string",
"revenueSource": "Market",
"capRateSource": "Market",
"vacancySource": "Market",
"cashFlow": {
"valuationsInfoId": "string",
"fileId": "string",
"comment": "string",
"revenue": {
"total": 0,
"totalByYear": [0],
"groupedTransactions": [
{
"group": "string",
"totalAmount": 0,
"totalPerSf": 0,
"totalPerUnit": 0,
"totalPercentageEGI": 0,
"transactions": [
{
"description": "string",
"group": "string",
"amount": 0,
"measureType": "Unspecified",
"annualized": 0,
"annualizedPerSf": 0,
"annualizedPerUnit": 0,
"annualizedPercentageEGI": 0,
"annualizedByYear": [0],
"comment": "string"
}
]
}
]
},
"vacancyAndConcessions": {
"total": 0,
"totalByYear": [0],
"groupedTransactions": [
{
"group": "string",
"totalAmount": 0,
"totalPerSf": 0,
"totalPerUnit": 0,
"totalPercentageEGI": 0,
"transactions": [
{
"description": "string",
"group": "string",
"amount": 0,
"measureType": "Unspecified",
"annualized": 0,
"annualizedPerSf": 0,
"annualizedPerUnit": 0,
"annualizedPercentageEGI": 0,
"annualizedByYear": [0],
"comment": "string"
}
]
}
]
},
"otherIncome": {
"total": 0,
"totalByYear": [0],
"groupedTransactions": [
{
"group": "string",
"totalAmount": 0,
"totalPerSf": 0,
"totalPerUnit": 0,
"totalPercentageEGI": 0,
"transactions": [
{
"description": "string",
"group": "string",
"amount": 0,
"measureType": "Unspecified",
"annualized": 0,
"annualizedPerSf": 0,
"annualizedPerUnit": 0,
"annualizedPercentageEGI": 0,
"annualizedByYear": [0],
"comment": "string"
}
]
}
]
},
"operatingExpenses": {
"total": 0,
"totalByYear": [0],
"groupedTransactions": [
{
"group": "string",
"totalAmount": 0,
"totalPerSf": 0,
"totalPerUnit": 0,
"totalPercentageEGI": 0,
"transactions": [
{
"description": "string",
"group": "string",
"amount": 0,
"measureType": "Unspecified",
"annualized": 0,
"annualizedPerSf": 0,
"annualizedPerUnit": 0,
"annualizedPercentageEGI": 0,
"annualizedByYear": [0],
"comment": "string"
}
]
}
]
},
"belowTheLineExpense": {
"total": 0,
"totalByYear": [0],
"groupedTransactions": [
{
"group": "string",
"totalAmount": 0,
"totalPerSf": 0,
"totalPerUnit": 0,
"totalPercentageEGI": 0,
"transactions": [
{
"description": "string",
"group": "string",
"amount": 0,
"measureType": "Unspecified",
"annualized": 0,
"annualizedPerSf": 0,
"annualizedPerUnit": 0,
"annualizedPercentageEGI": 0,
"annualizedByYear": [0],
"comment": "string"
}
]
}
]
},
"effectiveIncome": 0,
"effectiveIncomeByYear": [0],
"totalExpenses": 0,
"totalExpensesByYear": [0],
"netOperatingIncome": 0,
"netOperatingIncomeByYear": [0],
"netIncome": 0,
"netIncomeByYear": [0],
"dcfModel": {
"discountRate": 0,
"revenueGrowth": [0],
"expenseGrowth": [0]
},
"finalSale": 0,
"presentValues": [0],
"netPresentValue": 0,
"expenseRatio": 0
},
"totalValuation": 0,
"parentId": "string",
"descriptor": "string",
"archive": true,
"componentsVacancies": {
"additionalProp1": {
"amountValue": 0,
"percentageValue": 0
},
"additionalProp2": {
"amountValue": 0,
"percentageValue": 0
},
"additionalProp3": {
"amountValue": 0,
"percentageValue": 0
}
},
"componentsSelectedRentRolls": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"metrics": [
{
"dealId": "string",
"dscr": 0,
"ltv": 0,
"debtYield": 0
}
]
}
],
"alternativeValuations": [
{
"name": "string",
"valuationsInfoId": "string",
"valuation": 0,
"description": "string",
"asOfDate": "2026-01-15",
"parentId": "string",
"descriptor": "string"
}
],
"dcfModel": {
"discountRate": 0,
"revenueGrowth": [0],
"expenseGrowth": [0]
}
}