Skip to content

Mortgage · Calculation

DTI after selected debt payoffs

Rank entered debts and show the cash, removed payments and DTI change for the selected payoffs.

Example result · cashRequired: 2400 USD 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 dti-payoff-impact.

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/dti-payoff-impact";
const input = {
  "debts": [
    {
      "id": "a",
      "name": "Installment",
      "current_balance": 2400,
      "monthly_payment": 200,
      "is_excluded_from_dti": true,
      "will_pay_off": true
    },
    {
      "id": "b",
      "name": "Card",
      "current_balance": 3000,
      "monthly_payment": 100,
      "is_excluded_from_dti": false,
      "will_pay_off": false
    }
  ],
  "monthlyIncome": 8000,
  "currentHousingPayment": 1600,
  "startDti": 23.75
};
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/dti-payoff-impact' \
    --header "Authorization: Bearer $HT_PRODUCTION_KEY" \
    --header 'Content-Type: application/json' \
    --header "Idempotency-Key: $request_id" \
    --data-binary @- <<'HT_INPUT'
{
  "debts": [
    {
      "id": "a",
      "name": "Installment",
      "current_balance": 2400,
      "monthly_payment": 200,
      "is_excluded_from_dti": true,
      "will_pay_off": true
    },
    {
      "id": "b",
      "name": "Card",
      "current_balance": 3000,
      "monthly_payment": 100,
      "is_excluded_from_dti": false,
      "will_pay_off": false
    }
  ],
  "monthlyIncome": 8000,
  "currentHousingPayment": 1600,
  "startDti": 23.75
}
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 dti-payoff-impact.
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.

cashRequired
2400 USD
monthlyDebtRemoved
200 USD/month
newDti
21.25 percent
How to interpret this result
  • A debt being paid at closing must also be marked excluded from ongoing DTI.
Full example response (JSON)
{
  "status": "available",
  "result": {
    "rankedDebts": [
      {
        "id": "a",
        "name": "Installment",
        "current_balance": 2400,
        "monthly_payment": 200,
        "is_excluded_from_dti": true,
        "will_pay_off": true
      },
      {
        "id": "b",
        "name": "Card",
        "current_balance": 3000,
        "monthly_payment": 100,
        "is_excluded_from_dti": false,
        "will_pay_off": false
      }
    ],
    "cashRequired": 2400,
    "monthlyDebtRemoved": 200,
    "newDti": 21.25,
    "dtiReduction": 2.5
  },
  "formulaVersion": "dti-payoff-impact-htcalc-719df2c0e105",
  "units": {
    "cashRequired": "USD",
    "monthlyDebtRemoved": "USD/month",
    "newDti": "percent",
    "dtiReduction": "percentage-points"
  },
  "assumptions": [
    "A debt being paid at closing must also be marked excluded from ongoing DTI."
  ],
  "warnings": [],
  "creditCost": 1
}

Request contract

Accepted inputs

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

FieldType, units and limits

debtsRequired
arrayMax items 40
debts[].idRequired
stringMax length 64
debts[].nameRequired
stringMax length 80
debts[].current_balanceRequired
number

US dollars

Min 0 · Max 1000000000
debts[].monthly_paymentRequired
number

US dollars per month

Min 0 · Max 1000000000
debts[].is_excluded_from_dtiRequired
boolean
debts[].will_pay_offRequired
boolean
monthlyIncomeRequired
number

Gross monthly USD

Min 0.01 · Max 1000000000
currentHousingPaymentRequired
number

US dollars per month

Min 0 · Max 1000000000
startDtiRequired
number

Starting DTI in percentage points

Min 0 · Max 1000
Example request body (JSON)
{
  "debts": [
    {
      "id": "a",
      "name": "Installment",
      "current_balance": 2400,
      "monthly_payment": 200,
      "is_excluded_from_dti": true,
      "will_pay_off": true
    },
    {
      "id": "b",
      "name": "Card",
      "current_balance": 3000,
      "monthly_payment": 100,
      "is_excluded_from_dti": false,
      "will_pay_off": false
    }
  ],
  "monthlyIncome": 8000,
  "currentHousingPayment": 1600,
  "startDti": 23.75
}
Full JSON schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "debts": {
      "type": "array",
      "maxItems": 40,
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "string",
            "maxLength": 64
          },
          "name": {
            "type": "string",
            "maxLength": 80
          },
          "current_balance": {
            "type": "number",
            "minimum": 0,
            "maximum": 1000000000,
            "description": "US dollars"
          },
          "monthly_payment": {
            "type": "number",
            "minimum": 0,
            "maximum": 1000000000,
            "description": "US dollars per month"
          },
          "is_excluded_from_dti": {
            "type": "boolean"
          },
          "will_pay_off": {
            "type": "boolean"
          }
        },
        "required": [
          "id",
          "name",
          "current_balance",
          "monthly_payment",
          "is_excluded_from_dti",
          "will_pay_off"
        ]
      }
    },
    "monthlyIncome": {
      "type": "number",
      "minimum": 0.01,
      "maximum": 1000000000,
      "description": "Gross monthly USD"
    },
    "currentHousingPayment": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars per month"
    },
    "startDti": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000,
      "description": "Starting DTI in percentage points"
    }
  },
  "required": [
    "debts",
    "monthlyIncome",
    "currentHousingPayment",
    "startDti"
  ]
}

Production endpoint: POST https://calc.hasstechapi.com/v2/calc/dti-payoff-impact
Formula: dti-payoff-impact-htcalc-719df2c0e105