Skip to content

PDF report

Renovation project analysis

Renovation project analysis prepared from validated scenario inputs by the original HT Calc report builder.

Open Renovation Planner in HT Calc

This HT Calc screen includes a Plus sample for visitors.

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

  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 mortgage-renovation 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 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.

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/mortgage-renovation";
const input = {
  "projectName": "Kitchen renovation",
  "budget": 28000,
  "contingencyRate": 10,
  "items": [
    {
      "name": "Cabinets",
      "category": "Materials",
      "estimatedCost": 12000,
      "materialCost": 12000,
      "laborCost": 0,
      "actualCost": 11850,
      "isCompleted": true
    },
    {
      "name": "Installation",
      "category": "Labor",
      "estimatedCost": 7300,
      "materialCost": 0,
      "laborCost": 7300,
      "actualCost": 0,
      "isCompleted": false
    }
  ]
};
const requestId = Date.now() + "." + randomUUID();
const output = "mortgage-renovation-" + 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 mortgage-renovation-<requestId>.pdf.

Request contract

Accepted inputs

Fields for this example. Expand the schema for all supported combinations and limits.

FieldType, units and limits

projectNameRequired
string

Short plain-text scenario label.

Min length 1 · Max length 64
budgetRequired
number

US dollars, greater than zero.

Max 1000000000 · Greater than 0
contingencyRateRequired
number

Percentage points (6.5 means 6.5%).

Min 0 · Max 100
itemsRequired
arrayMin items 1 · Max items 50
items[].nameRequired
string

Short plain-text scenario label.

Min length 1 · Max length 64
items[].categoryRequired
stringAllowed: "Materials", "Labor", "Services", "Permits", "Other"
items[].estimatedCostRequired
number

US dollars; enter zero when this cost is absent.

Min 0 · Max 1000000000
items[].materialCostRequired
number

US dollars; enter zero when this cost is absent.

Min 0 · Max 1000000000
items[].laborCostRequired
number

US dollars; enter zero when this cost is absent.

Min 0 · Max 1000000000
items[].actualCostRequired
number

US dollars; enter zero when this cost is absent.

Min 0 · Max 1000000000
items[].isCompletedRequired
boolean
Example input (JSON)

The server example adds a fresh requestId to this input.

{
  "input": {
    "projectName": "Kitchen renovation",
    "budget": 28000,
    "contingencyRate": 10,
    "items": [
      {
        "name": "Cabinets",
        "category": "Materials",
        "estimatedCost": 12000,
        "materialCost": 12000,
        "laborCost": 0,
        "actualCost": 11850,
        "isCompleted": true
      },
      {
        "name": "Installation",
        "category": "Labor",
        "estimatedCost": 7300,
        "materialCost": 0,
        "laborCost": 7300,
        "actualCost": 0,
        "isCompleted": false
      }
    ]
  }
}
Full JSON schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "projectName": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64,
      "pattern": "^[^<>\\p{Cc}]+$",
      "description": "Short plain-text scenario label."
    },
    "budget": {
      "type": "number",
      "exclusiveMinimum": 0,
      "maximum": 1000000000,
      "description": "US dollars, greater than zero."
    },
    "contingencyRate": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Percentage points (6.5 means 6.5%)."
    },
    "items": {
      "minItems": 1,
      "maxItems": 50,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 64,
            "pattern": "^[^<>\\p{Cc}]+$",
            "description": "Short plain-text scenario label."
          },
          "category": {
            "type": "string",
            "enum": [
              "Materials",
              "Labor",
              "Services",
              "Permits",
              "Other"
            ]
          },
          "estimatedCost": {
            "type": "number",
            "minimum": 0,
            "maximum": 1000000000,
            "description": "US dollars; enter zero when this cost is absent."
          },
          "materialCost": {
            "type": "number",
            "minimum": 0,
            "maximum": 1000000000,
            "description": "US dollars; enter zero when this cost is absent."
          },
          "laborCost": {
            "type": "number",
            "minimum": 0,
            "maximum": 1000000000,
            "description": "US dollars; enter zero when this cost is absent."
          },
          "actualCost": {
            "type": "number",
            "minimum": 0,
            "maximum": 1000000000,
            "description": "US dollars; enter zero when this cost is absent."
          },
          "isCompleted": {
            "type": "boolean"
          }
        },
        "required": [
          "name",
          "category",
          "estimatedCost",
          "materialCost",
          "laborCost",
          "actualCost",
          "isCompleted"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "projectName",
    "budget",
    "contingencyRate",
    "items"
  ],
  "additionalProperties": false
}

Production endpoint: POST https://accounts.hasstechapi.com/v2/reports/mortgage-renovation
Formula: prepare-mortgage-renovation-1.0.0 · Report version: 1.0.0