Skip to content

PDF report

Mortgage payment comparison

Mortgage payment comparison prepared from validated scenario inputs by the original HT Calc report builder.

Open Mortgage Calculator in HT Calc

This HT Calc screen includes a Pro sample for visitors.

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-payment-comparison 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-payment-comparison";
const input = {
  "labelA": "30 years",
  "labelB": "20 years",
  "a": {
    "loanAmount": 300000,
    "interestRate": 6.75,
    "loanTerm": 30,
    "propertyTax": 3600,
    "homeInsurance": 1200,
    "hoaFees": 0,
    "estimatedValue": 400000,
    "useEstimatedPmi": false,
    "extraPayment": 0,
    "payoffFrequency": "monthly",
    "yearlyExtra": 0,
    "oneTimeExtra": 0,
    "oneTimeExtraMonth": 12
  },
  "b": {
    "loanAmount": 300000,
    "interestRate": 6.25,
    "loanTerm": 20,
    "propertyTax": 3600,
    "homeInsurance": 1200,
    "hoaFees": 0,
    "estimatedValue": 400000,
    "useEstimatedPmi": false,
    "extraPayment": 0,
    "payoffFrequency": "monthly",
    "yearlyExtra": 0,
    "oneTimeExtra": 0,
    "oneTimeExtraMonth": 12
  }
};
const requestId = Date.now() + "." + randomUUID();
const output = "mortgage-payment-comparison-" + 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-payment-comparison-<requestId>.pdf.

Request contract

Accepted inputs

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

FieldType, units and limits

labelARequired
string

Short plain-text scenario label.

Min length 1 · Max length 64
labelBRequired
string

Short plain-text scenario label.

Min length 1 · Max length 64
aRequired
object
a.loanAmountRequired
number

US dollars, greater than zero.

Max 1000000000 · Greater than 0
a.interestRateRequired
number

Percentage points (6.5 means 6.5%).

Min 0 · Max 100
a.loanTermRequired
integer

Whole years of payments.

Min 1 · Max 50
a.propertyTaxRequired
number

Annual property tax in dollars.

Min 0 · Max 1000000000
a.homeInsuranceRequired
number

Annual home insurance in dollars.

Min 0 · Max 1000000000
a.hoaFeesRequired
number

Monthly HOA dues in dollars.

Min 0 · Max 1000000000
a.estimatedValueRequired
number

Property value in dollars. Zero omits the valuation.

Min 0 · Max 1000000000
a.useEstimatedPmiRequired
boolean
a.extraPaymentRequired
number

Extra principal each month.

Min 0 · Max 1000000000
a.payoffFrequencyRequired
stringAllowed: "monthly", "biweekly"
a.yearlyExtraRequired
number

US dollars; enter zero when this cost is absent.

Min 0 · Max 1000000000
a.oneTimeExtraRequired
number

US dollars; enter zero when this cost is absent.

Min 0 · Max 1000000000
a.oneTimeExtraMonthRequired
integer

Whole months of payments.

Min 1 · Max 600
bRequired
object
b.loanAmountRequired
number

US dollars, greater than zero.

Max 1000000000 · Greater than 0
b.interestRateRequired
number

Percentage points (6.5 means 6.5%).

Min 0 · Max 100
b.loanTermRequired
integer

Whole years of payments.

Min 1 · Max 50
b.propertyTaxRequired
number

Annual property tax in dollars.

Min 0 · Max 1000000000
b.homeInsuranceRequired
number

Annual home insurance in dollars.

Min 0 · Max 1000000000
b.hoaFeesRequired
number

Monthly HOA dues in dollars.

Min 0 · Max 1000000000
b.estimatedValueRequired
number

Property value in dollars. Zero omits the valuation.

Min 0 · Max 1000000000
b.useEstimatedPmiRequired
boolean
b.extraPaymentRequired
number

Extra principal each month.

Min 0 · Max 1000000000
b.payoffFrequencyRequired
stringAllowed: "monthly", "biweekly"
b.yearlyExtraRequired
number

US dollars; enter zero when this cost is absent.

Min 0 · Max 1000000000
b.oneTimeExtraRequired
number

US dollars; enter zero when this cost is absent.

Min 0 · Max 1000000000
b.oneTimeExtraMonthRequired
integer

Whole months of payments.

Min 1 · Max 600
Example input (JSON)

The server example adds a fresh requestId to this input.

{
  "input": {
    "labelA": "30 years",
    "labelB": "20 years",
    "a": {
      "loanAmount": 300000,
      "interestRate": 6.75,
      "loanTerm": 30,
      "propertyTax": 3600,
      "homeInsurance": 1200,
      "hoaFees": 0,
      "estimatedValue": 400000,
      "useEstimatedPmi": false,
      "extraPayment": 0,
      "payoffFrequency": "monthly",
      "yearlyExtra": 0,
      "oneTimeExtra": 0,
      "oneTimeExtraMonth": 12
    },
    "b": {
      "loanAmount": 300000,
      "interestRate": 6.25,
      "loanTerm": 20,
      "propertyTax": 3600,
      "homeInsurance": 1200,
      "hoaFees": 0,
      "estimatedValue": 400000,
      "useEstimatedPmi": false,
      "extraPayment": 0,
      "payoffFrequency": "monthly",
      "yearlyExtra": 0,
      "oneTimeExtra": 0,
      "oneTimeExtraMonth": 12
    }
  }
}
Full JSON schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "labelA": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64,
      "pattern": "^[^<>\\p{Cc}]+$",
      "description": "Short plain-text scenario label."
    },
    "labelB": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64,
      "pattern": "^[^<>\\p{Cc}]+$",
      "description": "Short plain-text scenario label."
    },
    "a": {
      "type": "object",
      "properties": {
        "loanAmount": {
          "type": "number",
          "exclusiveMinimum": 0,
          "maximum": 1000000000,
          "description": "US dollars, greater than zero."
        },
        "interestRate": {
          "type": "number",
          "minimum": 0,
          "maximum": 100,
          "description": "Percentage points (6.5 means 6.5%)."
        },
        "loanTerm": {
          "type": "integer",
          "minimum": 1,
          "maximum": 50,
          "description": "Whole years of payments."
        },
        "propertyTax": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000,
          "description": "Annual property tax in dollars."
        },
        "homeInsurance": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000,
          "description": "Annual home insurance in dollars."
        },
        "hoaFees": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000,
          "description": "Monthly HOA dues in dollars."
        },
        "estimatedValue": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000,
          "description": "Property value in dollars. Zero omits the valuation."
        },
        "useEstimatedPmi": {
          "type": "boolean"
        },
        "extraPayment": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000,
          "description": "Extra principal each month."
        },
        "payoffFrequency": {
          "type": "string",
          "enum": [
            "monthly",
            "biweekly"
          ]
        },
        "yearlyExtra": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000,
          "description": "US dollars; enter zero when this cost is absent."
        },
        "oneTimeExtra": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000,
          "description": "US dollars; enter zero when this cost is absent."
        },
        "oneTimeExtraMonth": {
          "type": "integer",
          "minimum": 1,
          "maximum": 600,
          "description": "Whole months of payments."
        }
      },
      "required": [
        "loanAmount",
        "interestRate",
        "loanTerm",
        "propertyTax",
        "homeInsurance",
        "hoaFees",
        "estimatedValue",
        "useEstimatedPmi",
        "extraPayment",
        "payoffFrequency",
        "yearlyExtra",
        "oneTimeExtra",
        "oneTimeExtraMonth"
      ],
      "additionalProperties": false
    },
    "b": {
      "type": "object",
      "properties": {
        "loanAmount": {
          "type": "number",
          "exclusiveMinimum": 0,
          "maximum": 1000000000,
          "description": "US dollars, greater than zero."
        },
        "interestRate": {
          "type": "number",
          "minimum": 0,
          "maximum": 100,
          "description": "Percentage points (6.5 means 6.5%)."
        },
        "loanTerm": {
          "type": "integer",
          "minimum": 1,
          "maximum": 50,
          "description": "Whole years of payments."
        },
        "propertyTax": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000,
          "description": "Annual property tax in dollars."
        },
        "homeInsurance": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000,
          "description": "Annual home insurance in dollars."
        },
        "hoaFees": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000,
          "description": "Monthly HOA dues in dollars."
        },
        "estimatedValue": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000,
          "description": "Property value in dollars. Zero omits the valuation."
        },
        "useEstimatedPmi": {
          "type": "boolean"
        },
        "extraPayment": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000,
          "description": "Extra principal each month."
        },
        "payoffFrequency": {
          "type": "string",
          "enum": [
            "monthly",
            "biweekly"
          ]
        },
        "yearlyExtra": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000,
          "description": "US dollars; enter zero when this cost is absent."
        },
        "oneTimeExtra": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000,
          "description": "US dollars; enter zero when this cost is absent."
        },
        "oneTimeExtraMonth": {
          "type": "integer",
          "minimum": 1,
          "maximum": 600,
          "description": "Whole months of payments."
        }
      },
      "required": [
        "loanAmount",
        "interestRate",
        "loanTerm",
        "propertyTax",
        "homeInsurance",
        "hoaFees",
        "estimatedValue",
        "useEstimatedPmi",
        "extraPayment",
        "payoffFrequency",
        "yearlyExtra",
        "oneTimeExtra",
        "oneTimeExtraMonth"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "labelA",
    "labelB",
    "a",
    "b"
  ],
  "additionalProperties": false
}

Production endpoint: POST https://accounts.hasstechapi.com/v2/reports/mortgage-payment-comparison
Formula: prepare-mortgage-payment-comparison-1.0.0 · Report version: 1.0.0