Skip to content

Get Deal Funds

Retrieves the sources and uses of funds for a deal, including loan details, equity contributions, acquisition costs, closing costs, and reserves.

Key Details

  • fundsLoansInfo contains loan-level funding details and aggregate metrics (avgLTV, totalDSCR, totalDebtYield) across all loans in the deal.
  • fundsSourcesInfo itemizes where capital is coming from — loans, equity contributions, seller financing, etc. — with subtotals and remaining balance.
  • fundsUsesInfo itemizes where capital is allocated — acquisition cost, hard/soft construction costs, closing costs, interest reserves, operating reserves, etc. — with subtotals.
  • All monetary values are in USD.
  • This endpoint provides the complete capital stack and uses breakdown for underwriting and loan committee presentations.

Parameters

dealId string

Unique identifier for the deal

Response

Status: 200

Type: application/json

Schema: DealFundsInfoResponseDto

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 the deal funds analysis

fundsLoansInfo FundsLoansInfoDto
loanFundsItems array [ FundsLoanItemDto ]

sourcesOfFunds string

amount number(double)

Loan amount for this funding source, in USD

loanPaymentStructure string(enum)

Available enum values: InterestOnly, P_I_Amortization

amortizationTerm number(double)

Amortization period for this loan, in months

interestRate number(double)

Interest rate for this loan, expressed as a decimal (e.g., 0.065 = 6.5%)

dealIncomeValuation number(double)

Total deal income-based valuation, in USD

dealNOI number(double)

Total deal Net Operating Income, in USD

debtYield number(double)

Debt yield for this loan (NOI / Loan Amount), expressed as a percentage

ltv number(double)

Loan-to-Value ratio for this loan, expressed as a decimal (e.g., 0.75 = 75%)

dscr number(double)

Debt Service Coverage Ratio for this loan. Values > 1.0 indicate income exceeds debt obligations

avgLTV number(double)

Weighted average LTV across all loans, expressed as a decimal

totalDSCR number(double)

Overall DSCR across all loans

totalDebtYield number(double)

Overall debt yield across all loans, expressed as a percentage

fundsSourcesInfo FundsSourcesInfoDto
fundSourceItems array [ FundSourceItemDto ]
id string

Unique identifier for this funding source line item

sourcesOfFunds string

amount number(double)

Amount from this funding source, in USD

loanPaymentStructure string(enum)

Available enum values: InterestOnly, P_I_Amortization

amortizationTerm number(double)

Amortization term if this source is a loan, in months

interestRate number(double)

Interest rate for this source if it's a loan, expressed as a decimal

dollarPerUnit number(double)

Amount per unit, in USD

dollarPerSF number(double)

Amount per square foot, in USD

percentOfTotal number(double)

Percentage of total sources, expressed as a decimal (e.g., 0.75 = 75%)

default boolean

isDefault boolean

totalAmount number(double)

Total funding from all sources, in USD

totalDollarPerUnit number(double)

Total funding per unit, in USD

totalDollarPerSF number(double)

Total funding per square foot, in USD

balanceBetweenUsesAndSources number(double)

Difference between total uses and total sources (should be near zero for balanced budgets), in USD

balanceName string

fundsUsesInfo FundsUsesInfoDto
fundUseItems array [ FundUseItemDto ]
id string

Unique identifier for this funding use line item

usesOfFunds string

amount number(double)

Amount allocated to this use, in USD

dollarPerUnit number(double)

Amount per unit, in USD

dollarPerSF number(double)

Amount per square foot, in USD

percentOfTotal number(double)

Percentage of total uses, expressed as a decimal (e.g., 0.60 = 60%)

default boolean

isDefault boolean

totalAmount number(double)

Total funding allocated to all uses, in USD

totalDollarPerUnit number(double)

Total uses per unit, in USD

totalDollarPerSF number(double)

Total uses per square foot, in USD

GET 
/api/apiGateway/getDealFunds/{dealId}
Response
{
  "success": true,
  "error": {
    "target": "string",
    "code": "Duplicated",
    "message": "string",
    "details": [
      {}
    ]
  },
  "id": "string",
  "fundsLoansInfo": {
    "loanFundsItems": [
      {
        "sourcesOfFunds": "string",
        "amount": 0.0,
        "loanPaymentStructure": "InterestOnly",
        "amortizationTerm": 0.0,
        "interestRate": 0.0,
        "dealIncomeValuation": 0.0,
        "dealNOI": 0.0,
        "debtYield": 0.0,
        "ltv": 0.0,
        "dscr": 0.0
      }
    ],
    "avgLTV": 0.0,
    "totalDSCR": 0.0,
    "totalDebtYield": 0.0
  },
  "fundsSourcesInfo": {
    "fundSourceItems": [
      {
        "id": "string",
        "sourcesOfFunds": "string",
        "amount": 0.0,
        "loanPaymentStructure": "InterestOnly",
        "amortizationTerm": 0.0,
        "interestRate": 0.0,
        "dollarPerUnit": 0.0,
        "dollarPerSF": 0.0,
        "percentOfTotal": 0.0,
        "default": true,
        "isDefault": true
      }
    ],
    "totalAmount": 0.0,
    "totalDollarPerUnit": 0.0,
    "totalDollarPerSF": 0.0,
    "balanceBetweenUsesAndSources": 0.0,
    "balanceName": "string"
  },
  "fundsUsesInfo": {
    "fundUseItems": [
      {
        "id": "string",
        "usesOfFunds": "string",
        "amount": 0.0,
        "dollarPerUnit": 0.0,
        "dollarPerSF": 0.0,
        "percentOfTotal": 0.0,
        "default": true,
        "isDefault": true
      }
    ],
    "totalAmount": 0.0,
    "totalDollarPerUnit": 0.0,
    "totalDollarPerSF": 0.0
  }
}