Skip to content

PDF report

Quoted purchase offers

Quoted purchase offers 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 purchase-cash-and-rate-strategies 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/purchase-cash-and-rate-strategies";
const input = {
  "pricing": {
    "source": "Illustrative quote sheet",
    "owner": "Example Planning Group",
    "asOf": "2026-11-14",
    "ownership": "caller-owned"
  },
  "scenario": {
    "homePrice": 300000,
    "cashAvailable": 65000,
    "reserveTarget": 10000,
    "horizonMonths": 12,
    "horizonHomeValue": 300000,
    "monthlyPropertyTax": 250,
    "monthlyHomeInsurance": 100,
    "monthlyHoa": 50,
    "options": [
      {
        "downPayment": 60000,
        "quotedAnnualRate": 0,
        "termYears": 20,
        "closingCashCosts": 5000,
        "pointCost": 0,
        "lenderCredit": 0,
        "financedFees": 0,
        "monthlyMortgageInsurance": 0,
        "mortgageInsuranceMonths": 0,
        "immediateProjectCash": 0
      },
      {
        "downPayment": 30000,
        "quotedAnnualRate": 0,
        "termYears": 20,
        "closingCashCosts": 5000,
        "pointCost": 0,
        "lenderCredit": 1000,
        "financedFees": 0,
        "monthlyMortgageInsurance": 110,
        "mortgageInsuranceMonths": 84,
        "immediateProjectCash": 6000
      }
    ]
  }
};
const requestId = Date.now() + "." + randomUUID();
const output = "purchase-cash-and-rate-strategies-" + 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 purchase-cash-and-rate-strategies-<requestId>.pdf.

See the Compare purchase cash strategies at quoted rates 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.homePriceRequired
numberMin 0.01 · Max 100000000
scenario.cashAvailableRequired
numberMin 0 · Max 100000000
scenario.reserveTargetRequired
numberMin 0 · Max 100000000
scenario.horizonMonthsRequired
integerMin 0 · Max 480
scenario.horizonHomeValueRequired
numberMin 0 · Max 100000000
scenario.monthlyPropertyTaxRequired
numberMin 0 · Max 1000000
scenario.monthlyHomeInsuranceRequired
numberMin 0 · Max 1000000
scenario.monthlyHoaRequired
numberMin 0 · Max 1000000
scenario.optionsRequired
arrayMin items 2 · Max items 5
scenario.options[].downPaymentRequired
numberMin 0 · Max 100000000
scenario.options[].quotedAnnualRateRequired
numberMin 0 · Max 100
scenario.options[].termYearsRequired
integerMin 1 · Max 40
scenario.options[].closingCashCostsRequired
numberMin 0 · Max 100000000
scenario.options[].pointCostRequired
numberMin 0 · Max 100000000
scenario.options[].lenderCreditRequired
numberMin 0 · Max 100000000
scenario.options[].financedFeesRequired
numberMin 0 · Max 100000000
scenario.options[].monthlyMortgageInsuranceRequired
numberMin 0 · Max 1000000
scenario.options[].mortgageInsuranceMonthsRequired
integerMin 0 · Max 480
scenario.options[].immediateProjectCashRequired
numberMin 0 · Max 100000000
scenario.options[].financedGovernmentFeeOptional
numberMin 0 · Max 100000000
scenario.options[].loanProgramOptional
stringAllowed: "conventional", "fha", "va", "usda", "jumbo", "other"
scenario.primaryFhaRemodelOptional
object
scenario.primaryFhaRemodel.annualAppreciationPctOptional
numberMin -50 · Max 50
scenario.primaryFhaRemodel.optionIndexRequired
integerMin 0 · Max 4
scenario.primaryFhaRemodel.plannedBudgetRequired
numberMax 100000000 · Greater than 0
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": {
      "homePrice": 300000,
      "cashAvailable": 65000,
      "reserveTarget": 10000,
      "horizonMonths": 12,
      "horizonHomeValue": 300000,
      "monthlyPropertyTax": 250,
      "monthlyHomeInsurance": 100,
      "monthlyHoa": 50,
      "options": [
        {
          "downPayment": 60000,
          "quotedAnnualRate": 0,
          "termYears": 20,
          "closingCashCosts": 5000,
          "pointCost": 0,
          "lenderCredit": 0,
          "financedFees": 0,
          "monthlyMortgageInsurance": 0,
          "mortgageInsuranceMonths": 0,
          "immediateProjectCash": 0
        },
        {
          "downPayment": 30000,
          "quotedAnnualRate": 0,
          "termYears": 20,
          "closingCashCosts": 5000,
          "pointCost": 0,
          "lenderCredit": 1000,
          "financedFees": 0,
          "monthlyMortgageInsurance": 110,
          "mortgageInsuranceMonths": 84,
          "immediateProjectCash": 6000
        }
      ]
    }
  }
}
Full JSON schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "scenario",
    "pricing"
  ],
  "properties": {
    "scenario": {
      "type": "object",
      "properties": {
        "homePrice": {
          "type": "number",
          "minimum": 0.01,
          "maximum": 100000000
        },
        "cashAvailable": {
          "type": "number",
          "minimum": 0,
          "maximum": 100000000
        },
        "reserveTarget": {
          "type": "number",
          "minimum": 0,
          "maximum": 100000000
        },
        "horizonMonths": {
          "type": "integer",
          "minimum": 0,
          "maximum": 480
        },
        "horizonHomeValue": {
          "type": "number",
          "minimum": 0,
          "maximum": 100000000
        },
        "monthlyPropertyTax": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000
        },
        "monthlyHomeInsurance": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000
        },
        "monthlyHoa": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000
        },
        "options": {
          "type": "array",
          "minItems": 2,
          "maxItems": 5,
          "items": {
            "type": "object",
            "properties": {
              "downPayment": {
                "type": "number",
                "minimum": 0,
                "maximum": 100000000
              },
              "quotedAnnualRate": {
                "type": "number",
                "minimum": 0,
                "maximum": 100,
                "anyOf": [
                  {
                    "const": 0
                  },
                  {
                    "minimum": 0.001
                  }
                ]
              },
              "termYears": {
                "type": "integer",
                "minimum": 1,
                "maximum": 40
              },
              "closingCashCosts": {
                "type": "number",
                "minimum": 0,
                "maximum": 100000000
              },
              "pointCost": {
                "type": "number",
                "minimum": 0,
                "maximum": 100000000
              },
              "lenderCredit": {
                "type": "number",
                "minimum": 0,
                "maximum": 100000000
              },
              "financedFees": {
                "type": "number",
                "minimum": 0,
                "maximum": 100000000
              },
              "monthlyMortgageInsurance": {
                "type": "number",
                "minimum": 0,
                "maximum": 1000000
              },
              "mortgageInsuranceMonths": {
                "type": "integer",
                "minimum": 0,
                "maximum": 480
              },
              "immediateProjectCash": {
                "type": "number",
                "minimum": 0,
                "maximum": 100000000
              },
              "financedGovernmentFee": {
                "maximum": 100000000,
                "minimum": 0,
                "type": "number"
              },
              "loanProgram": {
                "enum": [
                  "conventional",
                  "fha",
                  "va",
                  "usda",
                  "jumbo",
                  "other"
                ],
                "type": "string"
              }
            },
            "required": [
              "downPayment",
              "quotedAnnualRate",
              "termYears",
              "closingCashCosts",
              "pointCost",
              "lenderCredit",
              "financedFees",
              "monthlyMortgageInsurance",
              "mortgageInsuranceMonths",
              "immediateProjectCash"
            ],
            "additionalProperties": false
          }
        },
        "primaryFhaRemodel": {
          "additionalProperties": false,
          "properties": {
            "annualAppreciationPct": {
              "maximum": 50,
              "minimum": -50,
              "type": "number"
            },
            "optionIndex": {
              "maximum": 4,
              "minimum": 0,
              "type": "integer"
            },
            "plannedBudget": {
              "exclusiveMinimum": 0,
              "maximum": 100000000,
              "type": "number"
            }
          },
          "required": [
            "optionIndex",
            "plannedBudget"
          ],
          "type": "object"
        }
      },
      "required": [
        "homePrice",
        "cashAvailable",
        "reserveTarget",
        "horizonMonths",
        "horizonHomeValue",
        "monthlyPropertyTax",
        "monthlyHomeInsurance",
        "monthlyHoa",
        "options"
      ],
      "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/purchase-cash-and-rate-strategies
Formula: purchase-cash-and-rate-strategies-htcalc-719df2c0e105 · Report version: 1.0.0