Skip to content

Lending · Calculation

Commercial mortgage income and balloon analysis

Combines purchase financing, balloon and full-term costs with the annual debt-service coverage test and reconciled property report figures.

Example result · monthlyPayment: 50 USD/month See output

Cost per success
1 calculation credit
Production plans
Standard, Business, Scale, Enterprise
Plan allowances
Free sandbox
Not available

Integration example

Make a request

Use a production key scoped to commercial-mortgage-analysis.

Keep the key on your server. A successful call uses 1 calculation credit.

Production request

Set HT_PRODUCTION_KEY on your server. Save as example.mjs and run node example.mjs with Node.js 18 or later.

import { randomUUID } from "node:crypto";

const key = process.env.HT_PRODUCTION_KEY;
if (!key) throw new Error("Set HT_PRODUCTION_KEY on your server.");
const endpoint = "https://calc.hasstechapi.com/v2/calc/commercial-mortgage-analysis";
const input = {
  "purchasePrice": 1200,
  "downPaymentPct": 0,
  "annualNOI": 750,
  "ratePct": 0,
  "amortYears": 2,
  "balloonYears": 1
};
const requestId = process.env.HT_REQUEST_ID || Date.now() + "." + randomUUID();
// Keep this ID to look up usage if the connection is interrupted.
console.error("Usage lookup ID:", requestId);

const response = await fetch(endpoint, {
  method: "POST",
  redirect: "error",
  headers: {
    "Authorization": "Bearer " + key,
    "Content-Type": "application/json",
    "Idempotency-Key": requestId
  },
  body: JSON.stringify(input)
});
if (!response.ok) {
  const problem = await response.json().catch(() => null);
  const code = problem?.error?.code || response.statusText;
  const delay = response.headers.get("retry-after");
  if (delay) console.error("Retry-After (seconds):", delay);
  console.error("HTTP " + response.status + " " + code + ". Usage lookup ID: " + requestId);
  if (Array.isArray(problem?.error?.details)) {
    for (const issue of problem.error.details) console.error("Input issue:", JSON.stringify(issue));
  }
  process.exitCode = 1;
} else {
  console.log(JSON.stringify(await response.json(), null, 2));
}
cURL (shell)

Set HT_PRODUCTION_KEY on your server. Run in a POSIX shell with cURL 7.76+ and Python 3.7+ to create a request ID.

(
  set -eu
  : "${HT_PRODUCTION_KEY:?Set HT_PRODUCTION_KEY on your server}"
  request_id="${HT_REQUEST_ID:-}"
  if [ -z "$request_id" ]; then
    request_id=$(python3 -c 'import time, uuid; print(str(time.time_ns() // 1000000) + "." + str(uuid.uuid4()))')
  fi
  printf 'Usage lookup ID: %s\n' "$request_id" >&2
  # On INVALID_INPUT, read error.details in the JSON response body.
  curl --disable --silent --show-error --fail-with-body --include \
    --request POST 'https://calc.hasstechapi.com/v2/calc/commercial-mortgage-analysis' \
    --header "Authorization: Bearer $HT_PRODUCTION_KEY" \
    --header 'Content-Type: application/json' \
    --header "Idempotency-Key: $request_id" \
    --data-binary @- <<'HT_INPUT'
{
  "purchasePrice": 1200,
  "downPaymentPct": 0,
  "annualNOI": 750,
  "ratePct": 0,
  "amortYears": 2,
  "balloonYears": 1
}
HT_INPUT
)
If your request fails
400 INVALID_INPUT

Read error.details when present. Node prints each issue. cURL returns the JSON body. Each path points into your request. An empty path refers to the whole body.

Check the accepted inputs for required fields, units and ranges. Send the corrected JSON as a new request.

401 or 403
Check that the server has the bearer key for the endpoint’s environment and that the key includes commercial-mortgage-analysis.
429
Read the service error code, check your allowance, and wait for the Retry-After interval when supplied before trying again.
Lost response, 409 or 503
Open Request lookup, select the same environment and enter the printed usage lookup ID. A settled ID has already consumed credits. To retry the same calculation, set HT_REQUEST_ID to the original ID and reuse the same inputs. A settled request does not return its result again. Unset the variable for a new request, which can consume credits.

The usage lookup ID is the Idempotency-Key your server sends. The response’s x-request-id identifies the HTTP exchange for support.

Output

Example result

These values come from running this operation on the example inputs.

monthlyPayment
50 USD/month
balloonAmount
600
totalInterestUntilBalloon
0
How to interpret this result
  • Property type is a reporting label. Income covers debt service at 1.0x and meets the modeled strong band at 1.25x.
Full example response (JSON)
{
  "status": "available",
  "result": {
    "monthlyPayment": 50,
    "balloonAmount": 600,
    "totalInterestUntilBalloon": 0,
    "totalInterestFullAmort": 0,
    "principal": 1200,
    "downPaymentAmount": 0,
    "ltv": 100,
    "propertyType": "multifamily",
    "annualDebtService": 600,
    "dscr": 1.25,
    "dscrStatus": "strong",
    "hasBalloon": true,
    "totalInterest": 0,
    "printed": {
      "price": 1200,
      "loan": 1200,
      "down": 0,
      "balloon": 600,
      "paidDown": 600,
      "interest": 0,
      "totalPayments": 1200,
      "annualNOI": 750,
      "annualDebtService": 600,
      "leftOver": 150
    }
  },
  "formulaVersion": "commercial-mortgage-analysis-1.0.0",
  "units": {
    "money": "USD",
    "monthlyPayment": "USD/month",
    "annualDebtService": "USD/year",
    "annualNOI": "USD/year",
    "dscr": "multiple",
    "ltv": "percent",
    "printed": "whole USD"
  },
  "assumptions": [
    "Property type is a reporting label. Income covers debt service at 1.0x and meets the modeled strong band at 1.25x."
  ],
  "warnings": [],
  "creditCost": 1
}

Request contract

Accepted inputs

Fields for this example. Expand the schema for all supported combinations and limits.

FieldType, units and limits

purchasePriceRequired
number

Purchase price (USD).

Min 0.01 · Max 10000000000 · Step 0.01
downPaymentPctRequired
number

Cash down as a share of purchase price (percentage points, up to 6 decimals).

Min 0 · Max 100 · Step 0.000001
annualNOIRequired
number

Annual net operating income before debt service (USD/year).

Min 0 · Max 10000000000 · Step 0.01
ratePctRequired
number

Annual note rate (percentage points, up to 6 decimals).

Min 0 · Max 100 · Step 0.000001
amortYearsRequired
integer

Full amortization (years).

Min 1 · Max 100
balloonYearsRequired
integer

Year of balloon, zero or a term at or beyond full amortization means fully amortizing.

Min 0 · Max 100
propertyTypeOptional
string

Property label used in the report.

Allowed: "multifamily", "retail", "office", "industrial"
Example request body (JSON)
{
  "purchasePrice": 1200,
  "downPaymentPct": 0,
  "annualNOI": 750,
  "ratePct": 0,
  "amortYears": 2,
  "balloonYears": 1
}
Full JSON schema
{
  "type": "object",
  "properties": {
    "purchasePrice": {
      "type": "number",
      "description": "Purchase price (USD).",
      "minimum": 0.01,
      "maximum": 10000000000,
      "multipleOf": 0.01
    },
    "downPaymentPct": {
      "type": "number",
      "description": "Cash down as a share of purchase price (percentage points, up to 6 decimals).",
      "minimum": 0,
      "maximum": 100,
      "multipleOf": 0.000001
    },
    "annualNOI": {
      "type": "number",
      "description": "Annual net operating income before debt service (USD/year).",
      "minimum": 0,
      "maximum": 10000000000,
      "multipleOf": 0.01
    },
    "ratePct": {
      "type": "number",
      "description": "Annual note rate (percentage points, up to 6 decimals).",
      "minimum": 0,
      "maximum": 100,
      "multipleOf": 0.000001
    },
    "amortYears": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "description": "Full amortization (years)."
    },
    "balloonYears": {
      "type": "integer",
      "minimum": 0,
      "maximum": 100,
      "description": "Year of balloon, zero or a term at or beyond full amortization means fully amortizing."
    },
    "propertyType": {
      "type": "string",
      "enum": [
        "multifamily",
        "retail",
        "office",
        "industrial"
      ],
      "description": "Property label used in the report."
    }
  },
  "required": [
    "purchasePrice",
    "downPaymentPct",
    "annualNOI",
    "ratePct",
    "amortYears",
    "balloonYears"
  ],
  "additionalProperties": false
}

Production endpoint: POST https://calc.hasstechapi.com/v2/calc/commercial-mortgage-analysis
Formula: commercial-mortgage-analysis-1.0.0