Skip to content

PDF report

Portfolio statement

Portfolio statement with the calculator’s supporting assumptions and breakdown.

Cost per success
20 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 investment-portfolio-v1 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 20 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 20 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/investment-portfolio-v1";
const input = {
  "asOfDate": "2026-10-16",
  "staleAfterDays": 120,
  "appreciationRatePct": 3,
  "properties": [
    {
      "id": "unit-a",
      "label": "Property A",
      "market": "North district",
      "type": "duplex",
      "valueCents": 45000000,
      "valuationAsOf": "2026-10-01",
      "debtAsOf": "2026-10-01",
      "firstMortgageCents": 28000000,
      "monthlyDebtPaymentCents": 180000,
      "monthlyRentCents": 320000,
      "monthlyTaxesCents": 40000,
      "monthlyInsuranceCents": 15000,
      "monthlyHoaCents": 0
    }
  ]
};
const requestId = Date.now() + "." + randomUUID();
const output = "investment-portfolio-v1-" + 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 investment-portfolio-v1-<requestId>.pdf.

See the Portfolio ledger and rent sensitivity 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

asOfDateRequired
stringFormat: date
staleAfterDaysRequired
integerMin 1 · Max 730
appreciationRatePctRequired
numberMin -99 · Max 100
propertiesRequired
arrayMin items 1 · Max items 40
properties[].idRequired
stringMin length 1 · Max length 80
properties[].labelRequired
stringMin length 1 · Max length 80
properties[].marketRequired
stringMin length 1 · Max length 80
properties[].typeRequired
stringMin length 1 · Max length 80
properties[].valueCentsRequired
integer

USD cents

Max 10000000000000 · Greater than 0
properties[].valuationAsOfRequired
stringFormat: date
properties[].debtAsOfRequired
stringFormat: date
properties[].firstMortgageCentsOptional
integer

USD cents

Min 0 · Max 10000000000000
properties[].secondMortgageCentsOptional
integer

USD cents

Min 0 · Max 10000000000000
properties[].monthlyDebtPaymentCentsOptional
integer

USD cents

Min 0 · Max 10000000000000
properties[].monthlyRentCentsOptional
integer

USD cents

Min 0 · Max 10000000000000
properties[].monthlyTaxesCentsOptional
integer

USD cents

Min 0 · Max 10000000000000
properties[].monthlyInsuranceCentsOptional
integer

USD cents

Min 0 · Max 10000000000000
properties[].monthlyHoaCentsOptional
integer

USD cents

Min 0 · Max 10000000000000
Example input (JSON)

The server example adds a fresh requestId to this input.

{
  "input": {
    "asOfDate": "2026-10-16",
    "staleAfterDays": 120,
    "appreciationRatePct": 3,
    "properties": [
      {
        "id": "unit-a",
        "label": "Property A",
        "market": "North district",
        "type": "duplex",
        "valueCents": 45000000,
        "valuationAsOf": "2026-10-01",
        "debtAsOf": "2026-10-01",
        "firstMortgageCents": 28000000,
        "monthlyDebtPaymentCents": 180000,
        "monthlyRentCents": 320000,
        "monthlyTaxesCents": 40000,
        "monthlyInsuranceCents": 15000,
        "monthlyHoaCents": 0
      }
    ]
  }
}
Full JSON schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "asOfDate": {
      "type": "string",
      "format": "date",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
    },
    "staleAfterDays": {
      "type": "integer",
      "minimum": 1,
      "maximum": 730
    },
    "appreciationRatePct": {
      "type": "number",
      "minimum": -99,
      "maximum": 100
    },
    "properties": {
      "minItems": 1,
      "maxItems": 40,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1,
            "maxLength": 80,
            "pattern": "^[^<>\\u0000-\\u001f]*$"
          },
          "label": {
            "type": "string",
            "minLength": 1,
            "maxLength": 80,
            "pattern": "^[^<>\\u0000-\\u001f]*$"
          },
          "market": {
            "type": "string",
            "minLength": 1,
            "maxLength": 80,
            "pattern": "^[^<>\\u0000-\\u001f]*$"
          },
          "type": {
            "type": "string",
            "minLength": 1,
            "maxLength": 80,
            "pattern": "^[^<>\\u0000-\\u001f]*$"
          },
          "valueCents": {
            "type": "integer",
            "exclusiveMinimum": 0,
            "maximum": 10000000000000,
            "description": "USD cents"
          },
          "valuationAsOf": {
            "type": "string",
            "format": "date",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
          },
          "debtAsOf": {
            "type": "string",
            "format": "date",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
          },
          "firstMortgageCents": {
            "type": "integer",
            "minimum": 0,
            "maximum": 10000000000000,
            "description": "USD cents"
          },
          "secondMortgageCents": {
            "type": "integer",
            "minimum": 0,
            "maximum": 10000000000000,
            "description": "USD cents"
          },
          "monthlyDebtPaymentCents": {
            "type": "integer",
            "minimum": 0,
            "maximum": 10000000000000,
            "description": "USD cents"
          },
          "monthlyRentCents": {
            "type": "integer",
            "minimum": 0,
            "maximum": 10000000000000,
            "description": "USD cents"
          },
          "monthlyTaxesCents": {
            "type": "integer",
            "minimum": 0,
            "maximum": 10000000000000,
            "description": "USD cents"
          },
          "monthlyInsuranceCents": {
            "type": "integer",
            "minimum": 0,
            "maximum": 10000000000000,
            "description": "USD cents"
          },
          "monthlyHoaCents": {
            "type": "integer",
            "minimum": 0,
            "maximum": 10000000000000,
            "description": "USD cents"
          }
        },
        "required": [
          "id",
          "label",
          "market",
          "type",
          "valueCents",
          "valuationAsOf",
          "debtAsOf"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "asOfDate",
    "staleAfterDays",
    "appreciationRatePct",
    "properties"
  ],
  "additionalProperties": false
}

Production endpoint: POST https://accounts.hasstechapi.com/v2/reports/investment-portfolio-v1
Formula: portfolio-ledger-1.0.0-marketplace.1 · Report version: 1.0.0