Skip to content

PDF report

Business loan cash flow

Supplied term-loan pricing, business coverage and first-year repayment rows.

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 business-loan-cash-flow 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/business-loan-cash-flow";
const input = {
  "loanAmount": 250000,
  "annualRate": 8.5,
  "termYears": 10,
  "originationFeePercent": 2,
  "hasSbaGuaranteeFee": false,
  "monthlyRevenue": 80000,
  "monthlyExpenses": 55000,
  "existingMonthlyDebtService": 2000
};
const requestId = Date.now() + "." + randomUUID();
const output = "business-loan-cash-flow-" + 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 business-loan-cash-flow-<requestId>.pdf.

See the Business loan cash flow and coverage 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

annualRateRequired
number

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

Min 0 · Max 100
existingMonthlyDebtServiceRequired
number

Existing debt payments before the proposed loan. In USD per month.

Min 0 · Max 100000000
hasSbaGuaranteeFeeRequired
boolean

Manual cash-flow scenarios always disable the SBA fee schedule.

Must equal false
loanAmountRequired
number

Business loan principal before the financed origination fee. In USD.

Min 1 · Max 100000000
monthlyExpensesRequired
number

Business expenses before loan payments. In USD per month.

Min 0 · Max 1000000000
monthlyRevenueRequired
number

Business revenue. In USD per month.

Min 0 · Max 1000000000
originationFeePercentRequired
number

Financed origination fee as a share of principal. In percentage points (6.5 means 6.5%).

Min 0 · Max 100
termYearsRequired
number

Repayment term in years. Fractional years are rounded to the nearest whole month.

Min 0.08333333333333333 · Max 100
Example input (JSON)

The server example adds a fresh requestId to this input.

{
  "input": {
    "loanAmount": 250000,
    "annualRate": 8.5,
    "termYears": 10,
    "originationFeePercent": 2,
    "hasSbaGuaranteeFee": false,
    "monthlyRevenue": 80000,
    "monthlyExpenses": 55000,
    "existingMonthlyDebtService": 2000
  }
}
Full JSON schema
{
  "additionalProperties": false,
  "properties": {
    "annualRate": {
      "anyOf": [
        {
          "const": 0
        },
        {
          "minimum": 0.000001
        }
      ],
      "description": "Annual note rate. In percentage points (6.5 means 6.5%).",
      "maximum": 100,
      "minimum": 0,
      "type": "number"
    },
    "existingMonthlyDebtService": {
      "description": "Existing debt payments before the proposed loan. In USD per month.",
      "maximum": 100000000,
      "minimum": 0,
      "type": "number"
    },
    "hasSbaGuaranteeFee": {
      "const": false,
      "description": "Manual cash-flow scenarios always disable the SBA fee schedule.",
      "type": "boolean"
    },
    "loanAmount": {
      "description": "Business loan principal before the financed origination fee. In USD.",
      "maximum": 100000000,
      "minimum": 1,
      "type": "number"
    },
    "monthlyExpenses": {
      "description": "Business expenses before loan payments. In USD per month.",
      "maximum": 1000000000,
      "minimum": 0,
      "type": "number"
    },
    "monthlyRevenue": {
      "description": "Business revenue. In USD per month.",
      "maximum": 1000000000,
      "minimum": 0,
      "type": "number"
    },
    "originationFeePercent": {
      "description": "Financed origination fee as a share of principal. In percentage points (6.5 means 6.5%).",
      "maximum": 100,
      "minimum": 0,
      "type": "number"
    },
    "termYears": {
      "description": "Repayment term in years. Fractional years are rounded to the nearest whole month.",
      "maximum": 100,
      "minimum": 0.08333333333333333,
      "type": "number"
    }
  },
  "required": [
    "loanAmount",
    "annualRate",
    "termYears",
    "originationFeePercent",
    "hasSbaGuaranteeFee",
    "monthlyRevenue",
    "monthlyExpenses",
    "existingMonthlyDebtService"
  ],
  "type": "object"
}

Production endpoint: POST https://accounts.hasstechapi.com/v2/reports/business-loan-cash-flow
Formula: business-loan-cash-flow-htcalc-719df2c0e105 · Report version: 1.0.0