Skip to content

PDF report

Quoted refinance alternatives

Quoted refinance alternatives using caller-supplied prices and a settled numerical comparison.

Open Loan Estimate Analyzer 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 quoted-refinance-alternatives 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/quoted-refinance-alternatives";
const input = {
  "pricing": {
    "source": "Illustrative quote sheet",
    "owner": "Example Planning Group",
    "asOf": "2026-11-14",
    "ownership": "caller-owned"
  },
  "scenario": {
    "profile": {
      "current": {
        "balance": 300000,
        "rate": 7.25,
        "monthlyPI": 2229,
        "monthsRemaining": 288,
        "loanType": "conventional",
        "hasMI": true
      },
      "property": {
        "estimatedValue": 400000,
        "originalValue": 380000,
        "type": "single-family",
        "occupancy": "primary"
      },
      "borrower": {
        "creditTier": "excellent",
        "isVeteran": false,
        "seasonedSixMonths": true,
        "expectedYearsToStay": 7
      },
      "goals": [
        "lower-payment"
      ]
    },
    "quotes": [
      {
        "mode": "lower-rate",
        "noteRate": 6,
        "closingCosts": 3500
      },
      {
        "mode": "cash-out",
        "noteRate": 6.5,
        "closingCosts": 5000
      }
    ]
  }
};
const requestId = Date.now() + "." + randomUUID();
const output = "quoted-refinance-alternatives-" + 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 quoted-refinance-alternatives-<requestId>.pdf.

See the Compare entered refinance alternatives 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

scenarioRequired
object
scenario.profileRequired
object
scenario.profile.currentRequired
object
scenario.profile.current.balanceRequired
number

USD

Min 0.01 · Max 1000000000
scenario.profile.current.rateRequired
number

Percent

Min 0 · Max 50
scenario.profile.current.monthlyPIRequired
number

USD per month

Min 0 · Max 1000000000
scenario.profile.current.monthsRemainingRequired
integer

Whole months

Min 1 · Max 600
scenario.profile.current.originalAmountOptional
number

USD

Min 0.01 · Max 1000000000
scenario.profile.current.loanTypeRequired
stringAllowed: "conventional", "fha", "va", "usda", "arm"
scenario.profile.current.hasMIRequired
boolean
scenario.profile.propertyRequired
object
scenario.profile.property.estimatedValueRequired
number

USD

Min 0.01 · Max 1000000000
scenario.profile.property.originalValueOptional
number

USD

Min 0.01 · Max 1000000000
scenario.profile.property.typeRequired
stringAllowed: "single-family", "condo", "multi-unit"
scenario.profile.property.occupancyRequired
stringAllowed: "primary", "second-home", "investment"
scenario.profile.borrowerRequired
object
scenario.profile.borrower.creditTierRequired
stringAllowed: "excellent", "good", "fair", "below"
scenario.profile.borrower.isVeteranRequired
boolean
scenario.profile.borrower.seasonedSixMonthsRequired
boolean
scenario.profile.borrower.expectedYearsToStayOptional
number

Years

Min 0 · Max 50
scenario.profile.borrower.marginalTaxRateOptional
number

Fraction

Min 0 · Max 1
scenario.profile.goalsRequired
arrayMin items 0 · Max items 6
scenario.profile.debtsToConsolidateOptional
arrayMin items 0 · Max items 20
scenario.profile.debtsToConsolidate[].descriptionRequired
stringMax length 64
scenario.profile.debtsToConsolidate[].balanceRequired
number

USD

Min 0.01 · Max 1000000000
scenario.profile.debtsToConsolidate[].aprRequired
number

Percent

Min 0 · Max 50
scenario.profile.debtsToConsolidate[].monthlyPaymentRequired
number

USD per month

Min 0 · Max 1000000000
scenario.profile.cashOutAmountOptional
number

USD

Min 0 · Max 1000000000
scenario.profile.extraPrincipalPerMonthOptional
number

Additional principal per month on the current loan in USD.

Min 0 · Max 10000000
scenario.quotesRequired
arrayMin items 1 · Max items 10
scenario.quotes[].modeRequired
stringAllowed: "lower-rate", "shorter-term", "pay-same-save-more", "drop-pmi", "fha-to-conv", "arm-to-fixed", "cash-out", "cash-out-consolidate", "va-irrrl", "fha-streamline"
scenario.quotes[].noteRateRequired
number

Percent

Min 0 · Max 50
scenario.quotes[].closingCostsRequired
number

USD

Min 0 · Max 1000000000
scenario.includeCurrentAlternativesOptional
boolean

Include the current loan and informational recast. Include extra principal when supplied.

scenario.matchGoalsOptional
boolean

Apply the original mortgage goal filter.

scenario.sortByOptional
string

Use the original strategy ordering by the stated criterion.

Allowed: "biggest-monthly-savings", "biggest-lifetime-savings", "fastest-break-even", "most-cash-received"
pricingRequired
object
pricing.sourceRequired
string

Name of the supplied price sheet or quote set.

Min length 1 · Max length 48
pricing.ownerRequired
string

Owner of the quoted pricing.

Min length 1 · Max length 48
pricing.asOfRequired
string

Effective date of the price sheet or quotes.

Format: date
pricing.ownershipRequired
string

Caller declaration covering use of the pricing in this report.

Allowed: "caller-owned", "authorized-for-report-use"
Example input (JSON)

The server example adds a fresh requestId to this input.

{
  "input": {
    "pricing": {
      "source": "Illustrative quote sheet",
      "owner": "Example Planning Group",
      "asOf": "2026-11-14",
      "ownership": "caller-owned"
    },
    "scenario": {
      "profile": {
        "current": {
          "balance": 300000,
          "rate": 7.25,
          "monthlyPI": 2229,
          "monthsRemaining": 288,
          "loanType": "conventional",
          "hasMI": true
        },
        "property": {
          "estimatedValue": 400000,
          "originalValue": 380000,
          "type": "single-family",
          "occupancy": "primary"
        },
        "borrower": {
          "creditTier": "excellent",
          "isVeteran": false,
          "seasonedSixMonths": true,
          "expectedYearsToStay": 7
        },
        "goals": [
          "lower-payment"
        ]
      },
      "quotes": [
        {
          "mode": "lower-rate",
          "noteRate": 6,
          "closingCosts": 3500
        },
        {
          "mode": "cash-out",
          "noteRate": 6.5,
          "closingCosts": 5000
        }
      ]
    }
  }
}
Full JSON schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "scenario",
    "pricing"
  ],
  "properties": {
    "scenario": {
      "type": "object",
      "properties": {
        "profile": {
          "type": "object",
          "properties": {
            "current": {
              "type": "object",
              "properties": {
                "balance": {
                  "type": "number",
                  "minimum": 0.01,
                  "maximum": 1000000000,
                  "description": "USD"
                },
                "rate": {
                  "type": "number",
                  "minimum": 0,
                  "maximum": 50,
                  "description": "Percent"
                },
                "monthlyPI": {
                  "type": "number",
                  "minimum": 0,
                  "maximum": 1000000000,
                  "description": "USD per month"
                },
                "monthsRemaining": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 600,
                  "description": "Whole months"
                },
                "originalAmount": {
                  "type": "number",
                  "minimum": 0.01,
                  "maximum": 1000000000,
                  "description": "USD"
                },
                "loanType": {
                  "type": "string",
                  "enum": [
                    "conventional",
                    "fha",
                    "va",
                    "usda",
                    "arm"
                  ]
                },
                "hasMI": {
                  "type": "boolean"
                }
              },
              "required": [
                "balance",
                "rate",
                "monthlyPI",
                "monthsRemaining",
                "loanType",
                "hasMI"
              ],
              "additionalProperties": false
            },
            "property": {
              "type": "object",
              "properties": {
                "estimatedValue": {
                  "type": "number",
                  "minimum": 0.01,
                  "maximum": 1000000000,
                  "description": "USD"
                },
                "originalValue": {
                  "type": "number",
                  "minimum": 0.01,
                  "maximum": 1000000000,
                  "description": "USD"
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "single-family",
                    "condo",
                    "multi-unit"
                  ]
                },
                "occupancy": {
                  "type": "string",
                  "enum": [
                    "primary",
                    "second-home",
                    "investment"
                  ]
                }
              },
              "required": [
                "estimatedValue",
                "type",
                "occupancy"
              ],
              "additionalProperties": false
            },
            "borrower": {
              "type": "object",
              "properties": {
                "creditTier": {
                  "type": "string",
                  "enum": [
                    "excellent",
                    "good",
                    "fair",
                    "below"
                  ]
                },
                "isVeteran": {
                  "type": "boolean"
                },
                "seasonedSixMonths": {
                  "type": "boolean"
                },
                "expectedYearsToStay": {
                  "type": "number",
                  "minimum": 0,
                  "maximum": 50,
                  "description": "Years"
                },
                "marginalTaxRate": {
                  "type": "number",
                  "minimum": 0,
                  "maximum": 1,
                  "description": "Fraction"
                }
              },
              "required": [
                "creditTier",
                "isVeteran",
                "seasonedSixMonths"
              ],
              "additionalProperties": false
            },
            "goals": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "lower-payment",
                  "pay-off-faster",
                  "cash-out",
                  "drop-mi",
                  "arm-to-fixed",
                  "consolidate-debts"
                ]
              },
              "minItems": 0,
              "maxItems": 6
            },
            "debtsToConsolidate": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "description": {
                    "type": "string",
                    "maxLength": 64
                  },
                  "balance": {
                    "type": "number",
                    "minimum": 0.01,
                    "maximum": 1000000000,
                    "description": "USD"
                  },
                  "apr": {
                    "type": "number",
                    "minimum": 0,
                    "maximum": 50,
                    "description": "Percent"
                  },
                  "monthlyPayment": {
                    "type": "number",
                    "minimum": 0,
                    "maximum": 1000000000,
                    "description": "USD per month"
                  }
                },
                "required": [
                  "description",
                  "balance",
                  "apr",
                  "monthlyPayment"
                ],
                "additionalProperties": false
              },
              "minItems": 0,
              "maxItems": 20
            },
            "cashOutAmount": {
              "type": "number",
              "minimum": 0,
              "maximum": 1000000000,
              "description": "USD"
            },
            "extraPrincipalPerMonth": {
              "type": "number",
              "minimum": 0,
              "maximum": 10000000,
              "description": "Additional principal per month on the current loan in USD."
            }
          },
          "required": [
            "current",
            "property",
            "borrower",
            "goals"
          ],
          "additionalProperties": false
        },
        "quotes": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "mode": {
                "type": "string",
                "enum": [
                  "lower-rate",
                  "shorter-term",
                  "pay-same-save-more",
                  "drop-pmi",
                  "fha-to-conv",
                  "arm-to-fixed",
                  "cash-out",
                  "cash-out-consolidate",
                  "va-irrrl",
                  "fha-streamline"
                ]
              },
              "noteRate": {
                "type": "number",
                "minimum": 0,
                "maximum": 50,
                "description": "Percent"
              },
              "closingCosts": {
                "type": "number",
                "minimum": 0,
                "maximum": 1000000000,
                "description": "USD"
              }
            },
            "required": [
              "mode",
              "noteRate",
              "closingCosts"
            ],
            "additionalProperties": false
          },
          "minItems": 1,
          "maxItems": 10
        },
        "includeCurrentAlternatives": {
          "type": "boolean",
          "description": "Include the current loan and informational recast. Include extra principal when supplied."
        },
        "matchGoals": {
          "type": "boolean",
          "description": "Apply the original mortgage goal filter."
        },
        "sortBy": {
          "type": "string",
          "enum": [
            "biggest-monthly-savings",
            "biggest-lifetime-savings",
            "fastest-break-even",
            "most-cash-received"
          ],
          "description": "Use the original strategy ordering by the stated criterion."
        }
      },
      "required": [
        "profile",
        "quotes"
      ],
      "additionalProperties": false
    },
    "pricing": {
      "$schema": "https://json-schema.org/draft/2020-12/schema",
      "type": "object",
      "properties": {
        "source": {
          "type": "string",
          "minLength": 1,
          "maxLength": 48,
          "pattern": "^[^<>\\p{Cc}]+$",
          "description": "Name of the supplied price sheet or quote set."
        },
        "owner": {
          "type": "string",
          "minLength": 1,
          "maxLength": 48,
          "pattern": "^[^<>\\p{Cc}]+$",
          "description": "Owner of the quoted pricing."
        },
        "asOf": {
          "type": "string",
          "format": "date",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
          "description": "Effective date of the price sheet or quotes."
        },
        "ownership": {
          "type": "string",
          "enum": [
            "caller-owned",
            "authorized-for-report-use"
          ],
          "description": "Caller declaration covering use of the pricing in this report."
        }
      },
      "required": [
        "source",
        "owner",
        "asOf",
        "ownership"
      ],
      "additionalProperties": false
    }
  }
}

Production endpoint: POST https://accounts.hasstechapi.com/v2/reports/quoted-refinance-alternatives
Formula: quoted-refinance-alternatives-htcalc-719df2c0e105 · Report version: 1.0.0