Skip to content

PDF report

Vehicle purchase financing

Vehicle purchase costs, contractual payment, amortization and illustrative vehicle depreciation.

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-purchase-financing 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-purchase-financing";
const input = {
  "params": {
    "loanAmount": 35000,
    "interestRate": 6,
    "loanTerm": 60,
    "downPayment": 3000,
    "tradeInValue": 5000,
    "amountOwedOnTrade": 2000,
    "salesTaxRate": 6,
    "fees": 500,
    "tradeInReducesTax": true
  },
  "loanType": "AUTO"
};
const requestId = Date.now() + "." + randomUUID();
const output = "auto-purchase-financing-" + 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-purchase-financing-<requestId>.pdf.

See the Auto purchase financing 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

loanTypeRequired
string

Fixed calculation branch.

Must equal "AUTO"
paramsRequired
object
params.amountOwedOnTradeOptional
number

Outstanding balance on the trade-in. In USD.

Min 0 · Max 250000 · Default: 0
params.downPaymentOptional
number

Cash down payment. In USD.

Min 0 · Max 250000 · Default: 0
params.feesOptional
number

Title, registration and other financed fees. In USD.

Min 0 · Max 250000 · Default: 0
params.interestRateRequired
number

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

Min 0 · Max 100
params.loanAmountRequired
number

Purchase price before trade-in, taxes and fees. In USD.

Min 1 · Max 250000
params.loanTermRequired
integer

Repayment term. In whole months.

Min 1 · Max 120
params.salesTaxRateOptional
number

Entered sales tax rate. In percentage points (6.5 means 6.5%).

Min 0 · Max 20 · Default: 0
params.tradeInReducesTaxOptional
boolean

Whether the trade-in allowance reduces taxable price.

Default: true
params.tradeInValueOptional
number

Allowance for a trade-in vehicle. In USD.

Min 0 · Max 250000 · Default: 0
Example input (JSON)

The server example adds a fresh requestId to this input.

{
  "input": {
    "params": {
      "loanAmount": 35000,
      "interestRate": 6,
      "loanTerm": 60,
      "downPayment": 3000,
      "tradeInValue": 5000,
      "amountOwedOnTrade": 2000,
      "salesTaxRate": 6,
      "fees": 500,
      "tradeInReducesTax": true
    },
    "loanType": "AUTO"
  }
}
Full JSON schema
{
  "additionalProperties": false,
  "properties": {
    "loanType": {
      "const": "AUTO",
      "description": "Fixed calculation branch.",
      "type": "string"
    },
    "params": {
      "additionalProperties": false,
      "properties": {
        "amountOwedOnTrade": {
          "default": 0,
          "description": "Outstanding balance on the trade-in. In USD.",
          "maximum": 250000,
          "minimum": 0,
          "type": "number"
        },
        "downPayment": {
          "default": 0,
          "description": "Cash down payment. In USD.",
          "maximum": 250000,
          "minimum": 0,
          "type": "number"
        },
        "fees": {
          "default": 0,
          "description": "Title, registration and other financed fees. In USD.",
          "maximum": 250000,
          "minimum": 0,
          "type": "number"
        },
        "interestRate": {
          "anyOf": [
            {
              "const": 0
            },
            {
              "minimum": 0.000001
            }
          ],
          "description": "Annual note rate. In percentage points (6.5 means 6.5%).",
          "maximum": 100,
          "minimum": 0,
          "type": "number"
        },
        "loanAmount": {
          "description": "Purchase price before trade-in, taxes and fees. In USD.",
          "maximum": 250000,
          "minimum": 1,
          "type": "number"
        },
        "loanTerm": {
          "description": "Repayment term. In whole months.",
          "maximum": 120,
          "minimum": 1,
          "type": "integer"
        },
        "salesTaxRate": {
          "default": 0,
          "description": "Entered sales tax rate. In percentage points (6.5 means 6.5%).",
          "maximum": 20,
          "minimum": 0,
          "type": "number"
        },
        "tradeInReducesTax": {
          "default": true,
          "description": "Whether the trade-in allowance reduces taxable price.",
          "type": "boolean"
        },
        "tradeInValue": {
          "default": 0,
          "description": "Allowance for a trade-in vehicle. In USD.",
          "maximum": 250000,
          "minimum": 0,
          "type": "number"
        }
      },
      "required": [
        "loanAmount",
        "interestRate",
        "loanTerm"
      ],
      "type": "object"
    }
  },
  "required": [
    "loanType",
    "params"
  ],
  "type": "object"
}

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