Skip to content

PDF report

Savings goal and milestones

Goal status, annual balances, contribution alternatives and milestone interest from the supplied savings plan.

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 savings-plan-milestones 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/savings-plan-milestones";
const input = {
  "initialDeposit": 5000,
  "monthlyContribution": 500,
  "annualRate": 4.5,
  "years": 10,
  "compounding": "monthly",
  "goal": 75000
};
const requestId = Date.now() + "." + randomUUID();
const output = "savings-plan-milestones-" + 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 savings-plan-milestones-<requestId>.pdf.

See the Savings plan milestones and comparisons 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

initialDepositRequired
number

Opening deposit in USD.

Min 0 · Max 100000000 · Step 0.01
monthlyContributionRequired
number

Contribution in USD per month. Daily mode distributes this across 365 periods per year.

Min 0 · Max 10000000 · Step 0.01
annualRateRequired
number

Fixed annual nominal rate in percentage points (4.5 means 4.5%).

Min 0 · Max 15
yearsRequired
integer

Whole projection years.

Min 1 · Max 100
compoundingRequired
string

Contribution and crediting cadence; interest accrues before each period-end deposit.

Allowed: "monthly", "daily"
goalOptional
number

Optional USD goal. Manual goals use whole dollars. Share links can supply a goal with cents up to $100 million. Zero or omission disables the goal.

Min 0 · Max 9007199254740991
Example input (JSON)

The server example adds a fresh requestId to this input.

{
  "input": {
    "initialDeposit": 5000,
    "monthlyContribution": 500,
    "annualRate": 4.5,
    "years": 10,
    "compounding": "monthly",
    "goal": 75000
  }
}
Full JSON schema
{
  "type": "object",
  "properties": {
    "initialDeposit": {
      "type": "number",
      "minimum": 0,
      "maximum": 100000000,
      "description": "Opening deposit in USD.",
      "multipleOf": 0.01
    },
    "monthlyContribution": {
      "type": "number",
      "minimum": 0,
      "maximum": 10000000,
      "description": "Contribution in USD per month. Daily mode distributes this across 365 periods per year.",
      "multipleOf": 0.01
    },
    "annualRate": {
      "type": "number",
      "minimum": 0,
      "maximum": 15,
      "description": "Fixed annual nominal rate in percentage points (4.5 means 4.5%)."
    },
    "years": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "description": "Whole projection years."
    },
    "compounding": {
      "type": "string",
      "enum": [
        "monthly",
        "daily"
      ],
      "description": "Contribution and crediting cadence; interest accrues before each period-end deposit."
    },
    "goal": {
      "type": "number",
      "minimum": 0,
      "maximum": 9007199254740991,
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "number",
          "minimum": 0,
          "maximum": 100000000,
          "description": "Shared savings goal in USD.",
          "multipleOf": 0.01
        }
      ],
      "description": "Optional USD goal. Manual goals use whole dollars. Share links can supply a goal with cents up to $100 million. Zero or omission disables the goal."
    }
  },
  "required": [
    "initialDeposit",
    "monthlyContribution",
    "annualRate",
    "years",
    "compounding"
  ],
  "additionalProperties": false
}

Production endpoint: POST https://accounts.hasstechapi.com/v2/reports/savings-plan-milestones
Formula: savings-plan-milestones-1.0.0 · Report version: 1.0.0