Skip to content

PDF report

Two loan offers compared

Two loan offers compared prepared from validated scenario inputs by the original HT Calc report builder. Set kind to AUTO, PERSONAL, STUDENT, BUSINESS or MORTGAGE. Supply the two offers in the form for that loan type.

Open Personal Loan Calculator in HT Calc

This report compares two loans. On the personal loan screen, use Compare to enter a second scenario.

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 lending-compare 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/lending-compare";
const input = {
  "kind": "PERSONAL",
  "a": {
    "loanAmount": 10000,
    "interestRate": 10.5,
    "loanTerm": 36,
    "originationFee": 0
  },
  "b": {
    "loanAmount": 10000,
    "interestRate": 9,
    "loanTerm": 60,
    "originationFee": 0
  }
};
const requestId = Date.now() + "." + randomUUID();
const output = "lending-compare-" + 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 lending-compare-<requestId>.pdf.

Request contract

Accepted inputs

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

FieldType, units and limits

kindRequired
stringMust equal "PERSONAL"
aRequired
object
a.loanAmountRequired
number

US dollars

Max 1000000000 · Greater than 0
a.interestRateRequired
number

Annual percent, e.g. 6.25

Min 0 · Max 100
a.extraPaymentOptional
number

Additional principal per month in USD

Min 0 · Max 1000000000
a.loanTermRequired
integer

Number of monthly payments

Min 1 · Max 600
a.originationFeeRequired
number

Percentage withheld from proceeds

Min 0 · Less than 100
bRequired
object
b.loanAmountRequired
number

US dollars

Max 1000000000 · Greater than 0
b.interestRateRequired
number

Annual percent, e.g. 6.25

Min 0 · Max 100
b.extraPaymentOptional
number

Additional principal per month in USD

Min 0 · Max 1000000000
b.loanTermRequired
integer

Number of monthly payments

Min 1 · Max 600
b.originationFeeRequired
number

Percentage withheld from proceeds

Min 0 · Less than 100
Example input (JSON)

The server example adds a fresh requestId to this input.

{
  "input": {
    "kind": "PERSONAL",
    "a": {
      "loanAmount": 10000,
      "interestRate": 10.5,
      "loanTerm": 36,
      "originationFee": 0
    },
    "b": {
      "loanAmount": 10000,
      "interestRate": 9,
      "loanTerm": 60,
      "originationFee": 0
    }
  }
}
Full JSON schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "oneOf": [
    {
      "type": "object",
      "properties": {
        "kind": {
          "type": "string",
          "const": "AUTO"
        },
        "a": {
          "type": "object",
          "properties": {
            "loanAmount": {
              "type": "number",
              "exclusiveMinimum": 0,
              "maximum": 1000000000,
              "description": "Vehicle purchase price before tax/trade-in, USD"
            },
            "interestRate": {
              "type": "number",
              "minimum": 0,
              "maximum": 100,
              "description": "Annual percent, e.g. 6.25"
            },
            "extraPayment": {
              "description": "Additional principal per month in USD",
              "type": "number",
              "minimum": 0,
              "maximum": 1000000000
            },
            "loanTerm": {
              "type": "integer",
              "minimum": 1,
              "maximum": 600,
              "description": "Number of monthly payments"
            },
            "downPayment": {
              "type": "number",
              "minimum": 0,
              "maximum": 1000000000,
              "description": "US dollars"
            },
            "tradeInValue": {
              "type": "number",
              "minimum": 0,
              "maximum": 1000000000,
              "description": "US dollars"
            },
            "amountOwedOnTrade": {
              "type": "number",
              "minimum": 0,
              "maximum": 1000000000,
              "description": "US dollars"
            },
            "tradeInReducesTax": {
              "type": "boolean"
            },
            "salesTaxRate": {
              "type": "number",
              "minimum": 0,
              "maximum": 100,
              "description": "Annual percent, e.g. 6.25"
            },
            "fees": {
              "type": "number",
              "minimum": 0,
              "maximum": 1000000000,
              "description": "US dollars"
            },
            "monthlyInsurance": {
              "type": "number",
              "minimum": 0,
              "maximum": 1000000000,
              "description": "US dollars"
            },
            "monthlyGas": {
              "type": "number",
              "minimum": 0,
              "maximum": 1000000000,
              "description": "US dollars"
            },
            "monthlyMaintenance": {
              "type": "number",
              "minimum": 0,
              "maximum": 1000000000,
              "description": "US dollars"
            }
          },
          "required": [
            "loanAmount",
            "interestRate",
            "loanTerm",
            "downPayment",
            "tradeInValue",
            "amountOwedOnTrade",
            "tradeInReducesTax",
            "salesTaxRate",
            "fees",
            "monthlyInsurance",
            "monthlyGas",
            "monthlyMaintenance"
          ],
          "additionalProperties": false
        },
        "b": {
          "type": "object",
          "properties": {
            "loanAmount": {
              "type": "number",
              "exclusiveMinimum": 0,
              "maximum": 1000000000,
              "description": "Vehicle purchase price before tax/trade-in, USD"
            },
            "interestRate": {
              "type": "number",
              "minimum": 0,
              "maximum": 100,
              "description": "Annual percent, e.g. 6.25"
            },
            "extraPayment": {
              "description": "Additional principal per month in USD",
              "type": "number",
              "minimum": 0,
              "maximum": 1000000000
            },
            "loanTerm": {
              "type": "integer",
              "minimum": 1,
              "maximum": 600,
              "description": "Number of monthly payments"
            },
            "downPayment": {
              "type": "number",
              "minimum": 0,
              "maximum": 1000000000,
              "description": "US dollars"
            },
            "tradeInValue": {
              "type": "number",
              "minimum": 0,
              "maximum": 1000000000,
              "description": "US dollars"
            },
            "amountOwedOnTrade": {
              "type": "number",
              "minimum": 0,
              "maximum": 1000000000,
              "description": "US dollars"
            },
            "tradeInReducesTax": {
              "type": "boolean"
            },
            "salesTaxRate": {
              "type": "number",
              "minimum": 0,
              "maximum": 100,
              "description": "Annual percent, e.g. 6.25"
            },
            "fees": {
              "type": "number",
              "minimum": 0,
              "maximum": 1000000000,
              "description": "US dollars"
            },
            "monthlyInsurance": {
              "type": "number",
              "minimum": 0,
              "maximum": 1000000000,
              "description": "US dollars"
            },
            "monthlyGas": {
              "type": "number",
              "minimum": 0,
              "maximum": 1000000000,
              "description": "US dollars"
            },
            "monthlyMaintenance": {
              "type": "number",
              "minimum": 0,
              "maximum": 1000000000,
              "description": "US dollars"
            }
          },
          "required": [
            "loanAmount",
            "interestRate",
            "loanTerm",
            "downPayment",
            "tradeInValue",
            "amountOwedOnTrade",
            "tradeInReducesTax",
            "salesTaxRate",
            "fees",
            "monthlyInsurance",
            "monthlyGas",
            "monthlyMaintenance"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "kind",
        "a",
        "b"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "kind": {
          "type": "string",
          "const": "PERSONAL"
        },
        "a": {
          "type": "object",
          "properties": {
            "loanAmount": {
              "type": "number",
              "exclusiveMinimum": 0,
              "maximum": 1000000000,
              "description": "US dollars"
            },
            "interestRate": {
              "type": "number",
              "minimum": 0,
              "maximum": 100,
              "description": "Annual percent, e.g. 6.25"
            },
            "extraPayment": {
              "description": "Additional principal per month in USD",
              "type": "number",
              "minimum": 0,
              "maximum": 1000000000
            },
            "loanTerm": {
              "type": "integer",
              "minimum": 1,
              "maximum": 600,
              "description": "Number of monthly payments"
            },
            "originationFee": {
              "type": "number",
              "minimum": 0,
              "exclusiveMaximum": 100,
              "description": "Percentage withheld from proceeds"
            }
          },
          "required": [
            "loanAmount",
            "interestRate",
            "loanTerm",
            "originationFee"
          ],
          "additionalProperties": false
        },
        "b": {
          "type": "object",
          "properties": {
            "loanAmount": {
              "type": "number",
              "exclusiveMinimum": 0,
              "maximum": 1000000000,
              "description": "US dollars"
            },
            "interestRate": {
              "type": "number",
              "minimum": 0,
              "maximum": 100,
              "description": "Annual percent, e.g. 6.25"
            },
            "extraPayment": {
              "description": "Additional principal per month in USD",
              "type": "number",
              "minimum": 0,
              "maximum": 1000000000
            },
            "loanTerm": {
              "type": "integer",
              "minimum": 1,
              "maximum": 600,
              "description": "Number of monthly payments"
            },
            "originationFee": {
              "type": "number",
              "minimum": 0,
              "exclusiveMaximum": 100,
              "description": "Percentage withheld from proceeds"
            }
          },
          "required": [
            "loanAmount",
            "interestRate",
            "loanTerm",
            "originationFee"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "kind",
        "a",
        "b"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "kind": {
          "type": "string",
          "const": "STUDENT"
        },
        "a": {
          "type": "object",
          "properties": {
            "loanAmount": {
              "type": "number",
              "exclusiveMinimum": 0,
              "maximum": 1000000000,
              "description": "US dollars"
            },
            "interestRate": {
              "type": "number",
              "minimum": 0,
              "maximum": 100,
              "description": "Annual percent, e.g. 6.25"
            },
            "extraPayment": {
              "description": "Additional principal per month in USD",
              "type": "number",
              "minimum": 0,
              "maximum": 1000000000
            },
            "loanTerm": {
              "type": "integer",
              "minimum": 1,
              "maximum": 50,
              "description": "Whole years"
            },
            "originationFee": {
              "type": "number",
              "minimum": 0,
              "exclusiveMaximum": 100,
              "description": "Annual percent, e.g. 6.25"
            },
            "defermentMonths": {
              "type": "integer",
              "minimum": 0,
              "maximum": 120
            },
            "loanSubtype": {
              "type": "string",
              "enum": [
                "subsidized",
                "unsubsidized"
              ]
            }
          },
          "required": [
            "loanAmount",
            "interestRate",
            "loanTerm",
            "originationFee",
            "defermentMonths",
            "loanSubtype"
          ],
          "additionalProperties": false
        },
        "b": {
          "type": "object",
          "properties": {
            "loanAmount": {
              "type": "number",
              "exclusiveMinimum": 0,
              "maximum": 1000000000,
              "description": "US dollars"
            },
            "interestRate": {
              "type": "number",
              "minimum": 0,
              "maximum": 100,
              "description": "Annual percent, e.g. 6.25"
            },
            "extraPayment": {
              "description": "Additional principal per month in USD",
              "type": "number",
              "minimum": 0,
              "maximum": 1000000000
            },
            "loanTerm": {
              "type": "integer",
              "minimum": 1,
              "maximum": 50,
              "description": "Whole years"
            },
            "originationFee": {
              "type": "number",
              "minimum": 0,
              "exclusiveMaximum": 100,
              "description": "Annual percent, e.g. 6.25"
            },
            "defermentMonths": {
              "type": "integer",
              "minimum": 0,
              "maximum": 120
            },
            "loanSubtype": {
              "type": "string",
              "enum": [
                "subsidized",
                "unsubsidized"
              ]
            }
          },
          "required": [
            "loanAmount",
            "interestRate",
            "loanTerm",
            "originationFee",
            "defermentMonths",
            "loanSubtype"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "kind",
        "a",
        "b"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "kind": {
          "type": "string",
          "const": "BUSINESS"
        },
        "a": {
          "type": "object",
          "properties": {
            "loanAmount": {
              "type": "number",
              "exclusiveMinimum": 0,
              "maximum": 1000000000,
              "description": "US dollars"
            },
            "interestRate": {
              "type": "number",
              "minimum": 0,
              "maximum": 100,
              "description": "Annual percent, e.g. 6.25"
            },
            "extraPayment": {
              "description": "Additional principal per month in USD",
              "type": "number",
              "minimum": 0,
              "maximum": 1000000000
            },
            "loanTerm": {
              "type": "integer",
              "minimum": 1,
              "maximum": 50,
              "description": "Whole years"
            },
            "originationFee": {
              "type": "number",
              "minimum": 0,
              "exclusiveMaximum": 100,
              "description": "Annual percent, e.g. 6.25"
            },
            "financeOriginationFee": {
              "type": "boolean"
            },
            "businessRevenue": {
              "type": "number",
              "minimum": 0,
              "maximum": 1000000000,
              "description": "Monthly revenue in USD"
            },
            "businessExpenses": {
              "type": "number",
              "minimum": 0,
              "maximum": 1000000000,
              "description": "Monthly expenses in USD"
            }
          },
          "required": [
            "loanAmount",
            "interestRate",
            "loanTerm",
            "originationFee",
            "financeOriginationFee",
            "businessRevenue",
            "businessExpenses"
          ],
          "additionalProperties": false
        },
        "b": {
          "type": "object",
          "properties": {
            "loanAmount": {
              "type": "number",
              "exclusiveMinimum": 0,
              "maximum": 1000000000,
              "description": "US dollars"
            },
            "interestRate": {
              "type": "number",
              "minimum": 0,
              "maximum": 100,
              "description": "Annual percent, e.g. 6.25"
            },
            "extraPayment": {
              "description": "Additional principal per month in USD",
              "type": "number",
              "minimum": 0,
              "maximum": 1000000000
            },
            "loanTerm": {
              "type": "integer",
              "minimum": 1,
              "maximum": 50,
              "description": "Whole years"
            },
            "originationFee": {
              "type": "number",
              "minimum": 0,
              "exclusiveMaximum": 100,
              "description": "Annual percent, e.g. 6.25"
            },
            "financeOriginationFee": {
              "type": "boolean"
            },
            "businessRevenue": {
              "type": "number",
              "minimum": 0,
              "maximum": 1000000000,
              "description": "Monthly revenue in USD"
            },
            "businessExpenses": {
              "type": "number",
              "minimum": 0,
              "maximum": 1000000000,
              "description": "Monthly expenses in USD"
            }
          },
          "required": [
            "loanAmount",
            "interestRate",
            "loanTerm",
            "originationFee",
            "financeOriginationFee",
            "businessRevenue",
            "businessExpenses"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "kind",
        "a",
        "b"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "kind": {
          "type": "string",
          "const": "MORTGAGE"
        },
        "a": {
          "type": "object",
          "properties": {
            "loanAmount": {
              "type": "number",
              "exclusiveMinimum": 0,
              "maximum": 1000000000,
              "description": "Purchase price in USD"
            },
            "interestRate": {
              "type": "number",
              "minimum": 0,
              "maximum": 100,
              "description": "Annual percent, e.g. 6.25"
            },
            "extraPayment": {
              "description": "Additional principal per month in USD",
              "type": "number",
              "minimum": 0,
              "maximum": 1000000000
            },
            "loanTerm": {
              "type": "integer",
              "minimum": 1,
              "maximum": 50,
              "description": "Whole years"
            },
            "downPayment": {
              "type": "number",
              "minimum": 0,
              "maximum": 1000000000,
              "description": "US dollars"
            },
            "propertyTax": {
              "type": "number",
              "minimum": 0,
              "maximum": 1000000000,
              "description": "Annual property tax in USD"
            },
            "homeInsurance": {
              "type": "number",
              "minimum": 0,
              "maximum": 1000000000,
              "description": "Annual insurance in USD"
            },
            "pmi": {
              "type": "number",
              "minimum": 0,
              "maximum": 100,
              "description": "Annual PMI percent"
            }
          },
          "required": [
            "loanAmount",
            "interestRate",
            "loanTerm",
            "downPayment",
            "propertyTax",
            "homeInsurance",
            "pmi"
          ],
          "additionalProperties": false
        },
        "b": {
          "type": "object",
          "properties": {
            "loanAmount": {
              "type": "number",
              "exclusiveMinimum": 0,
              "maximum": 1000000000,
              "description": "Purchase price in USD"
            },
            "interestRate": {
              "type": "number",
              "minimum": 0,
              "maximum": 100,
              "description": "Annual percent, e.g. 6.25"
            },
            "extraPayment": {
              "description": "Additional principal per month in USD",
              "type": "number",
              "minimum": 0,
              "maximum": 1000000000
            },
            "loanTerm": {
              "type": "integer",
              "minimum": 1,
              "maximum": 50,
              "description": "Whole years"
            },
            "downPayment": {
              "type": "number",
              "minimum": 0,
              "maximum": 1000000000,
              "description": "US dollars"
            },
            "propertyTax": {
              "type": "number",
              "minimum": 0,
              "maximum": 1000000000,
              "description": "Annual property tax in USD"
            },
            "homeInsurance": {
              "type": "number",
              "minimum": 0,
              "maximum": 1000000000,
              "description": "Annual insurance in USD"
            },
            "pmi": {
              "type": "number",
              "minimum": 0,
              "maximum": 100,
              "description": "Annual PMI percent"
            }
          },
          "required": [
            "loanAmount",
            "interestRate",
            "loanTerm",
            "downPayment",
            "propertyTax",
            "homeInsurance",
            "pmi"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "kind",
        "a",
        "b"
      ],
      "additionalProperties": false
    }
  ]
}

Production endpoint: POST https://accounts.hasstechapi.com/v2/reports/lending-compare
Formula: prepare-lending-compare-1.0.0 · Report version: 1.0.0