Skip to content

PDF report

Vehicle financing offers

Compare the supplied offers, including each rate, fee treatment and total cost.

Related HT Calc tool: Auto Loan Calculator

The standalone offer-comparison component has no public route. This related calculator models the purchase and financing of one vehicle.

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 auto-offer-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/auto-offer-comparison";
const input = {
  "offers": [
    {
      "id": 1,
      "lender": "Bank A",
      "loanAmount": 30000,
      "rate": 5.9,
      "term": 60,
      "fees": 0,
      "feeTreatment": "financed"
    },
    {
      "id": 2,
      "lender": "Credit Union",
      "loanAmount": 30000,
      "rate": 4.5,
      "term": 60,
      "fees": 250,
      "feeTreatment": "financed"
    },
    {
      "id": 3,
      "lender": "Online Lender",
      "loanAmount": 30000,
      "rate": 6.9,
      "term": 72,
      "fees": 0,
      "feeTreatment": "financed"
    }
  ]
};
const requestId = Date.now() + "." + randomUUID();
const output = "auto-offer-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 auto-offer-comparison-<requestId>.pdf.

See the Auto loan offer comparison 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

offersRequired
array

Offers to compare.

Min items 2 · Max items 4
offers[].feeTreatmentRequired
string

Whether fees increase principal or are paid at signing.

Allowed: "financed", "upfront"
offers[].feesRequired
number

Entered lender fees. In USD.

Min 0 · Max 250000
offers[].idRequired
integer

Caller-provided offer identifier.

Min 1 · Max 1000000
offers[].lenderRequired
string

Caller-provided offer label.

Min length 1 · Max length 80
offers[].loanAmountRequired
number

Principal before fees. In USD.

Min 1 · Max 250000
offers[].rateRequired
number

Annual note rate. In percentage points (6.5 means 6.5%).

Min 0 · Max 30
offers[].termRequired
integer

Offer term in whole months.

Allowed: 24, 36, 48, 60, 72, 84
Example input (JSON)

The server example adds a fresh requestId to this input.

{
  "input": {
    "offers": [
      {
        "id": 1,
        "lender": "Bank A",
        "loanAmount": 30000,
        "rate": 5.9,
        "term": 60,
        "fees": 0,
        "feeTreatment": "financed"
      },
      {
        "id": 2,
        "lender": "Credit Union",
        "loanAmount": 30000,
        "rate": 4.5,
        "term": 60,
        "fees": 250,
        "feeTreatment": "financed"
      },
      {
        "id": 3,
        "lender": "Online Lender",
        "loanAmount": 30000,
        "rate": 6.9,
        "term": 72,
        "fees": 0,
        "feeTreatment": "financed"
      }
    ]
  }
}
Full JSON schema
{
  "additionalProperties": false,
  "properties": {
    "offers": {
      "description": "Offers to compare.",
      "items": {
        "additionalProperties": false,
        "properties": {
          "feeTreatment": {
            "description": "Whether fees increase principal or are paid at signing.",
            "enum": [
              "financed",
              "upfront"
            ],
            "type": "string"
          },
          "fees": {
            "description": "Entered lender fees. In USD.",
            "maximum": 250000,
            "minimum": 0,
            "type": "number"
          },
          "id": {
            "description": "Caller-provided offer identifier.",
            "maximum": 1000000,
            "minimum": 1,
            "type": "integer"
          },
          "lender": {
            "description": "Caller-provided offer label.",
            "maxLength": 80,
            "minLength": 1,
            "type": "string"
          },
          "loanAmount": {
            "description": "Principal before fees. In USD.",
            "maximum": 250000,
            "minimum": 1,
            "type": "number"
          },
          "rate": {
            "anyOf": [
              {
                "const": 0
              },
              {
                "minimum": 0.000001
              }
            ],
            "description": "Annual note rate. In percentage points (6.5 means 6.5%).",
            "maximum": 30,
            "minimum": 0,
            "type": "number"
          },
          "term": {
            "description": "Offer term in whole months.",
            "enum": [
              24,
              36,
              48,
              60,
              72,
              84
            ],
            "type": "integer"
          }
        },
        "required": [
          "id",
          "lender",
          "loanAmount",
          "rate",
          "term",
          "fees",
          "feeTreatment"
        ],
        "type": "object"
      },
      "maxItems": 4,
      "minItems": 2,
      "type": "array"
    }
  },
  "required": [
    "offers"
  ],
  "type": "object"
}

Production endpoint: POST https://accounts.hasstechapi.com/v2/reports/auto-offer-comparison
Formula: auto-offer-comparison-htcalc-719df2c0e105 · Report version: 1.0.0