Skip to content

PDF report

Pay like a lower rate

Extra principal to match the supplied target rate, with monthly or biweekly figures, payoff timing, and conditional escrow and tax projections.

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-target-rate-paydown 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-target-rate-paydown";
const input = {
  "loanBalance": 300000,
  "currentRate": 7,
  "targetRate": 5.5,
  "currentMonthlyPI": 1995.9074855375
};
const requestId = Date.now() + "." + randomUUID();
const output = "mortgage-target-rate-paydown-" + 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-target-rate-paydown-<requestId>.pdf.

See the Pay like a lower rate calculation and example result.

Request contract

Accepted inputs

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

FieldType, units and limits

loanBalanceRequired
number

US dollars

Min 0.01 · Max 1000000000 · Greater than 0
currentRateRequired
number

Annual rate in percent

Min 0 · Max 100
targetRateRequired
number

Annual rate in percent

Min 0 · Max 100
currentMonthlyPIConditional
number

US dollars per month

Min 0.01 · Max 1000000000 · Greater than 0
remainingTermMonthsConditional
integer

Whole months

Min 1 · Max 600
annualPropertyTaxOptional
number

US dollars per year

Min 0 · Max 1000000000
annualHomeInsuranceOptional
number

US dollars per year

Min 0 · Max 1000000000
monthlyMortgageInsuranceOptional
number

US dollars per month

Min 0 · Max 1000000000
monthlyHoaOptional
number

US dollars per month

Min 0 · Max 1000000000
annualEscrowGrowthRateOptional
number

Annual percentage change

Min -50 · Max 100
homeValueOptional
number

US dollars

Min 0.01 · Max 1000000000 · Greater than 0
annualHomeAppreciationRateOptional
number

Annual percentage change

Min -50 · Max 100
pmiDropLtvPercentOptional
number

Percent

Min 0.01 · Max 100 · Greater than 0
extraStartMonthOptional
integer

Whole months

Min 1 · Max 600
annualExtraPaymentOptional
number

US dollars per year

Min 0 · Max 1000000000
oneTimePrincipalPaymentOptional
number

US dollars

Min 0 · Max 1000000000
includeTaxAdjustedViewOptional
boolean
marginalTaxRateConditional
number

Percent, e.g. 5 means 5%

Min 0 · Max 50
itemizesDeductionsConditional
boolean
principalOnlyConfirmedOptional
boolean
hasPrepaymentPenaltyOptional
boolean
cadenceOptional
string

Optional report display cadence. The solver calculates both payment amounts.

Allowed: "monthly", "biweekly"
Example input (JSON)

The server example adds a fresh requestId to this input.

{
  "input": {
    "loanBalance": 300000,
    "currentRate": 7,
    "targetRate": 5.5,
    "currentMonthlyPI": 1995.9074855375
  }
}
Full JSON schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "loanBalance": {
      "type": "number",
      "minimum": 0.01,
      "maximum": 1000000000,
      "description": "US dollars",
      "exclusiveMinimum": 0
    },
    "currentRate": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Annual rate in percent"
    },
    "targetRate": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Annual rate in percent"
    },
    "currentMonthlyPI": {
      "type": "number",
      "minimum": 0.01,
      "maximum": 1000000000,
      "description": "US dollars per month",
      "exclusiveMinimum": 0
    },
    "remainingTermMonths": {
      "type": "integer",
      "minimum": 1,
      "maximum": 600,
      "description": "Whole months"
    },
    "annualPropertyTax": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars per year"
    },
    "annualHomeInsurance": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars per year"
    },
    "monthlyMortgageInsurance": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars per month"
    },
    "monthlyHoa": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars per month"
    },
    "annualEscrowGrowthRate": {
      "type": "number",
      "minimum": -50,
      "maximum": 100,
      "description": "Annual percentage change"
    },
    "homeValue": {
      "type": "number",
      "minimum": 0.01,
      "maximum": 1000000000,
      "description": "US dollars",
      "exclusiveMinimum": 0
    },
    "annualHomeAppreciationRate": {
      "type": "number",
      "minimum": -50,
      "maximum": 100,
      "description": "Annual percentage change"
    },
    "pmiDropLtvPercent": {
      "type": "number",
      "minimum": 0.01,
      "maximum": 100,
      "description": "Percent",
      "exclusiveMinimum": 0
    },
    "extraStartMonth": {
      "type": "integer",
      "minimum": 1,
      "maximum": 600,
      "description": "Whole months"
    },
    "annualExtraPayment": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars per year"
    },
    "oneTimePrincipalPayment": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars"
    },
    "includeTaxAdjustedView": {
      "type": "boolean"
    },
    "marginalTaxRate": {
      "type": "number",
      "minimum": 0,
      "maximum": 50,
      "description": "Percent, e.g. 5 means 5%"
    },
    "itemizesDeductions": {
      "type": "boolean"
    },
    "principalOnlyConfirmed": {
      "type": "boolean"
    },
    "hasPrepaymentPenalty": {
      "type": "boolean"
    },
    "cadence": {
      "type": "string",
      "enum": [
        "monthly",
        "biweekly"
      ],
      "description": "Optional report display cadence. The solver calculates both payment amounts."
    }
  },
  "required": [
    "loanBalance",
    "currentRate",
    "targetRate"
  ],
  "oneOf": [
    {
      "required": [
        "currentMonthlyPI"
      ]
    },
    {
      "required": [
        "remainingTermMonths"
      ]
    }
  ],
  "allOf": [
    {
      "if": {
        "required": [
          "includeTaxAdjustedView"
        ],
        "properties": {
          "includeTaxAdjustedView": {
            "const": true
          }
        }
      },
      "then": {
        "required": [
          "marginalTaxRate",
          "itemizesDeductions"
        ]
      }
    }
  ]
}

Production endpoint: POST https://accounts.hasstechapi.com/v2/reports/mortgage-target-rate-paydown
Formula: target-rate-paydown-htcalc-719df2c0e105 · Report version: 1.0.0