PDF report
Monthly income breakdown
Convert entered pay periods to comparable monthly income.
Visitors can explore a sample snapshot. Saved accounts, loans and properties open within the member’s own Financial Hub.
- Cost per success
- 1 calculation credit + 1 PDF report
- Production plans
- Business, Scale, Enterprise
Plan allowances - Free sandbox
- Not available
Integration example
Request a PDF
Before your first report
- 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. - Under Report credentials, name a credential, select
income-frequency-breakdownand choose Create report credential. Save the secret shown once in your server’sHT_REPORT_KEY. - Run the example on your server against
accounts.hasstechapi.com, without anOriginheader. A successful request returns a PDF and uses 1 calculation credit 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 1 calculation credit 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.
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/income-frequency-breakdown";
const input = {
"items": [
{
"amount": 26,
"frequency": "hourly",
"hoursPerWeek": 40
},
{
"amount": 1300,
"frequency": "weekly",
"hoursPerWeek": 40
}
]
};
const requestId = Date.now() + "." + randomUUID();
const output = "income-frequency-breakdown-" + 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 income-frequency-breakdown-<requestId>.pdf.
See the Monthly income from multiple pay schedules 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
itemsRequiredIndependent manual income sources.
Min items 1 · Max items 50items[].amountRequiredUSD earned for the specified frequency.
Min 0 · Max 100000000items[].frequencyRequiredFrequency used for the entered amount.
Allowed: "hourly", "weekly", "bi-weekly", "semi-monthly", "monthly", "annual"items[].hoursPerWeekConditionalHours worked per week. Required for hourly pay and ignored for other frequencies.
Min 0.01 · Max 168Example input (JSON)
The server example adds a fresh requestId to this input.
{
"input": {
"items": [
{
"amount": 26,
"frequency": "hourly",
"hoursPerWeek": 40
},
{
"amount": 1300,
"frequency": "weekly",
"hoursPerWeek": 40
}
]
}
} Full JSON schema
{
"additionalProperties": false,
"properties": {
"items": {
"description": "Independent manual income sources.",
"items": {
"additionalProperties": false,
"if": {
"properties": {
"frequency": {
"const": "hourly"
}
}
},
"properties": {
"amount": {
"description": "USD earned for the specified frequency.",
"maximum": 100000000,
"minimum": 0,
"type": "number"
},
"frequency": {
"description": "Frequency used for the entered amount.",
"enum": [
"hourly",
"weekly",
"bi-weekly",
"semi-monthly",
"monthly",
"annual"
],
"type": "string"
},
"hoursPerWeek": {
"description": "Hours worked per week. Required for hourly pay and ignored for other frequencies.",
"maximum": 168,
"minimum": 0.01,
"type": "number"
}
},
"required": [
"amount",
"frequency"
],
"then": {
"required": [
"hoursPerWeek"
]
},
"type": "object"
},
"maxItems": 50,
"minItems": 1,
"type": "array"
}
},
"required": [
"items"
],
"type": "object"
}Production endpoint: POST https://accounts.hasstechapi.com/v2/reports/income-frequency-breakdown
Formula: income-frequency-breakdown-htcalc-719df2c0e105 · Report version: 1.0.0