Skip to content

PDF report

Vehicle rebate comparison

Compare a quoted promotional rate with a cash rebate and alternate financing.

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-rebate-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-rebate-comparison";
const input = {
  "price": 35000,
  "downPayment": 1750,
  "promoAprPct": 0,
  "promoTermMonths": 60,
  "rebate": 3000,
  "bankAprPct": 6.5,
  "bankTermMonths": 60
};
const requestId = Date.now() + "." + randomUUID();
const output = "auto-rebate-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-rebate-comparison-<requestId>.pdf.

See the Dealer financing versus cash rebate 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

bankAprPctRequired
number

Annual bank loan rate. In percentage points (6.5 means 6.5%).

Min 0 · Max 100
bankTermMonthsRequired
integer

Bank loan term. In whole months.

Min 1 · Max 120
downPaymentRequired
number

Cash paid up front. In USD.

Min 0 · Max 250000
priceRequired
number

Vehicle price. In USD.

Min 1 · Max 250000
promoAprPctRequired
number

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

Min 0 · Max 100
promoTermMonthsRequired
integer

Promotional loan term. In whole months.

Min 1 · Max 120
rebateRequired
number

Cash rebate applied to the alternative loan. In USD.

Min 0 · Max 250000
Example input (JSON)

The server example adds a fresh requestId to this input.

{
  "input": {
    "price": 35000,
    "downPayment": 1750,
    "promoAprPct": 0,
    "promoTermMonths": 60,
    "rebate": 3000,
    "bankAprPct": 6.5,
    "bankTermMonths": 60
  }
}
Full JSON schema
{
  "additionalProperties": false,
  "properties": {
    "bankAprPct": {
      "anyOf": [
        {
          "const": 0
        },
        {
          "minimum": 0.000001
        }
      ],
      "description": "Annual bank loan rate. In percentage points (6.5 means 6.5%).",
      "maximum": 100,
      "minimum": 0,
      "type": "number"
    },
    "bankTermMonths": {
      "description": "Bank loan term. In whole months.",
      "maximum": 120,
      "minimum": 1,
      "type": "integer"
    },
    "downPayment": {
      "description": "Cash paid up front. In USD.",
      "maximum": 250000,
      "minimum": 0,
      "type": "number"
    },
    "price": {
      "description": "Vehicle price. In USD.",
      "maximum": 250000,
      "minimum": 1,
      "type": "number"
    },
    "promoAprPct": {
      "anyOf": [
        {
          "const": 0
        },
        {
          "minimum": 0.000001
        }
      ],
      "description": "Annual promotional rate. In percentage points (6.5 means 6.5%).",
      "maximum": 100,
      "minimum": 0,
      "type": "number"
    },
    "promoTermMonths": {
      "description": "Promotional loan term. In whole months.",
      "maximum": 120,
      "minimum": 1,
      "type": "integer"
    },
    "rebate": {
      "description": "Cash rebate applied to the alternative loan. In USD.",
      "maximum": 250000,
      "minimum": 0,
      "type": "number"
    }
  },
  "required": [
    "price",
    "downPayment",
    "promoAprPct",
    "promoTermMonths",
    "rebate",
    "bankAprPct",
    "bankTermMonths"
  ],
  "type": "object"
}

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