Skip to content

PDF report

Cash-out debt payoff

Cash-out debt payoff prepared from validated scenario inputs by the original HT Calc report builder.

Cost per success
2 calculation credits + 1 PDF report
Production plans
Business, Scale, Enterprise
Plan allowances
Free sandbox
Not available

Integration example

Request a PDF

Before your first report

  1. Open Widgets & reports in your paid workspace. Save your brand name, accent and at least one exact HTTPS origin, such as https://app.example.com. The origins identify sites allowed to embed your widgets.
  2. Under Report credentials, name a credential, select mortgage-cash-out-debt-payoff and choose Create report credential. Save the secret shown once in your server’s HT_REPORT_KEY.
  3. Run the example on your server against accounts.hasstechapi.com, without an Origin header. A successful request returns a PDF and uses 2 calculation credits and 1 PDF report. Running the example again starts a new paid request.
What if the PDF doesn’t arrive?

For 400 INVALID_INPUT, inspect error.details when present. Paths for template fields start with input. Fix the indicated field and send a new request. This validation error uses zero credits and zero reports.

Open the .pdf.request.json file the example saved before sending. Within 24 hours, open Request lookup in the same workspace, choose Production, and paste the file’s requestId. The response’s X-Request-Id is a separate support identifier.

A settled request shows the calculation credits and report used. The service doesn’t keep the PDF for download. Check your saved file first. A replacement with a new ID uses 2 calculation credits and 1 PDF report on success.

If the outcome is unclear, check the workspace and ID, then look it up again before requesting a replacement.

Download the production PDF

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

import { randomUUID } from "node:crypto";
import { writeFile } from "node:fs/promises";

const key = process.env.HT_REPORT_KEY;
if (!key) throw new Error("Set HT_REPORT_KEY on your server.");
const endpoint = "https://accounts.hasstechapi.com/v2/reports/mortgage-cash-out-debt-payoff";
const input = {
  "current": {
    "balance": 280000,
    "rate": 7.25,
    "months": 336
  },
  "newRate": 6.75,
  "newYears": 25,
  "costs": 8000,
  "value": 500000,
  "annualPropertyTax": 4950,
  "annualHomeInsurance": 1575,
  "monthlyIncome": 8000,
  "otherDebtsMonthly": 0,
  "debts": [
    {
      "kind": "car",
      "balance": 22000,
      "monthlyPayment": 536.05,
      "monthsLeft": 48,
      "ratePercent": 0
    }
  ]
};
const requestId = Date.now() + "." + randomUUID();
const output = "mortgage-cash-out-debt-payoff-" + requestId + ".pdf";
await writeFile(output + ".request.json", JSON.stringify({ requestId, endpoint }), {
  flag: "wx", mode: 0o600
});
console.error("Usage lookup ID:", requestId);

const response = await fetch(endpoint, {
  method: "POST",
  redirect: "error",
  headers: {
    "Authorization": "Bearer " + key,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({ requestId, 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 {
  if (response.headers.get("content-type")?.split(";")[0] !== "application/pdf") {
    throw new Error("Expected a PDF. Look up request " + requestId);
  }
  await writeFile(output, new Uint8Array(await response.arrayBuffer()), { flag: "wx" });
  console.log("Saved", output);
}

Output

PDF output

A successful request returns the PDF file as application/pdf. The example writes a file named mortgage-cash-out-debt-payoff-<requestId>.pdf.

Request contract

Accepted inputs

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

FieldType, units and limits

currentRequired
object
current.balanceRequired
number

US dollars, greater than zero.

Max 1000000000 · Greater than 0
current.rateRequired
number

Percentage points (6.5 means 6.5%).

Min 0 · Max 100
current.monthsRequired
integer

Whole months of payments.

Min 1 · Max 600
newRateRequired
number

Percentage points (6.5 means 6.5%).

Min 0 · Max 100
newYearsRequired
integer

Whole years of payments.

Min 1 · Max 50
costsRequired
number

US dollars; enter zero when this cost is absent.

Min 0 · Max 1000000000
valueRequired
number

US dollars, greater than zero.

Max 1000000000 · Greater than 0
annualPropertyTaxRequired
number

US dollars; enter zero when this cost is absent.

Min 0 · Max 1000000000
annualHomeInsuranceRequired
number

US dollars; enter zero when this cost is absent.

Min 0 · Max 1000000000
monthlyIncomeRequired
number

US dollars; enter zero when this cost is absent.

Min 0 · Max 1000000000
otherDebtsMonthlyRequired
number

US dollars; enter zero when this cost is absent.

Min 0 · Max 1000000000
debtsRequired
arrayMin items 1 · Max items 8
debts[].kindRequired
stringAllowed: "card", "car", "student", "personal", "other"
debts[].nameOptional
string

Short plain-text scenario label.

Min length 1 · Max length 24
debts[].balanceRequired
number

US dollars, greater than zero.

Max 1000000000 · Greater than 0
debts[].monthlyPaymentRequired
number

US dollars, greater than zero.

Max 1000000000 · Greater than 0
debts[].monthsLeftRequired
integerMin 0 · Max 600
debts[].ratePercentRequired
number

Percentage points (6.5 means 6.5%).

Min 0 · Max 100
Example input (JSON)

The server example adds a fresh requestId to this input.

{
  "input": {
    "current": {
      "balance": 280000,
      "rate": 7.25,
      "months": 336
    },
    "newRate": 6.75,
    "newYears": 25,
    "costs": 8000,
    "value": 500000,
    "annualPropertyTax": 4950,
    "annualHomeInsurance": 1575,
    "monthlyIncome": 8000,
    "otherDebtsMonthly": 0,
    "debts": [
      {
        "kind": "car",
        "balance": 22000,
        "monthlyPayment": 536.05,
        "monthsLeft": 48,
        "ratePercent": 0
      }
    ]
  }
}
Full JSON schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "current": {
      "type": "object",
      "properties": {
        "balance": {
          "type": "number",
          "exclusiveMinimum": 0,
          "maximum": 1000000000,
          "description": "US dollars, greater than zero."
        },
        "rate": {
          "type": "number",
          "minimum": 0,
          "maximum": 100,
          "description": "Percentage points (6.5 means 6.5%)."
        },
        "months": {
          "type": "integer",
          "minimum": 1,
          "maximum": 600,
          "description": "Whole months of payments."
        }
      },
      "required": [
        "balance",
        "rate",
        "months"
      ],
      "additionalProperties": false
    },
    "newRate": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Percentage points (6.5 means 6.5%)."
    },
    "newYears": {
      "type": "integer",
      "minimum": 1,
      "maximum": 50,
      "description": "Whole years of payments."
    },
    "costs": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars; enter zero when this cost is absent."
    },
    "value": {
      "type": "number",
      "exclusiveMinimum": 0,
      "maximum": 1000000000,
      "description": "US dollars, greater than zero."
    },
    "annualPropertyTax": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars; enter zero when this cost is absent."
    },
    "annualHomeInsurance": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars; enter zero when this cost is absent."
    },
    "monthlyIncome": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars; enter zero when this cost is absent."
    },
    "otherDebtsMonthly": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars; enter zero when this cost is absent."
    },
    "debts": {
      "minItems": 1,
      "maxItems": 8,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "enum": [
              "card",
              "car",
              "student",
              "personal",
              "other"
            ]
          },
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 24,
            "pattern": "^[^<>\\p{Cc}]+$",
            "description": "Short plain-text scenario label."
          },
          "balance": {
            "type": "number",
            "exclusiveMinimum": 0,
            "maximum": 1000000000,
            "description": "US dollars, greater than zero."
          },
          "monthlyPayment": {
            "type": "number",
            "exclusiveMinimum": 0,
            "maximum": 1000000000,
            "description": "US dollars, greater than zero."
          },
          "monthsLeft": {
            "type": "integer",
            "minimum": 0,
            "maximum": 600
          },
          "ratePercent": {
            "type": "number",
            "minimum": 0,
            "maximum": 100,
            "description": "Percentage points (6.5 means 6.5%)."
          }
        },
        "required": [
          "kind",
          "balance",
          "monthlyPayment",
          "monthsLeft",
          "ratePercent"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "current",
    "newRate",
    "newYears",
    "costs",
    "value",
    "annualPropertyTax",
    "annualHomeInsurance",
    "monthlyIncome",
    "otherDebtsMonthly",
    "debts"
  ],
  "additionalProperties": false
}

Production endpoint: POST https://accounts.hasstechapi.com/v2/reports/mortgage-cash-out-debt-payoff
Formula: prepare-mortgage-cash-out-debt-payoff-1.0.0 · Report version: 1.0.0