Skip to content

PDF report

Biweekly mortgage payment schedule

Biweekly mortgage payment schedule with the calculator’s supporting assumptions and breakdown.

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 mortgage-biweekly-schedule 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/mortgage-biweekly-schedule";
const input = {
  "loanAmount": 300000,
  "annualRate": 7,
  "termYears": 30,
  "options": {
    "principalApplication": "immediate-biweekly",
    "escrowTreatment": "annualized",
    "biWeeklyPlanFee": 3
  }
};
const requestId = Date.now() + "." + randomUUID();
const output = "mortgage-biweekly-schedule-" + 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-biweekly-schedule-<requestId>.pdf.

See the Biweekly mortgage payments and fees 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

loanAmountRequired
number

Outstanding mortgage principal. In USD.

Min 1 · Max 100000000
annualRateRequired
number

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

Min 0 · Max 100
termYearsRequired
integer

Repayment term. In whole years.

Min 1 · Max 50
optionsRequired
object
options.principalApplicationRequired
string

Lender posting of the extra half-payment.

Allowed: "monthly-extra", "immediate-biweekly", "not-applied"
options.escrowTreatmentRequired
string

Escrow draft treatment.

Allowed: "annualized", "split-total"
options.extraPrincipalCadenceOptional
string

Frequency of optional extra principal.

Allowed: "monthly", "biweekly"
options.monthlyEscrowOptional
number

Escrow excluding mortgage insurance and other costs. In USD per month.

Min 0 · Max 1000000
options.monthlyMortgageInsuranceOptional
number

Mortgage insurance. In USD per month.

Min 0 · Max 1000000
options.monthlyOtherCostsOptional
number

Other recurring costs. In USD per month.

Min 0 · Max 1000000
options.biWeeklyPlanFeeOptional
number

Fee per two-week draft. In USD.

Min 0 · Max 10000
options.extraBiWeeklyPrincipalOptional
number

Extra principal each selected cadence. In USD.

Min 0 · Max 10000000
Example input (JSON)

The server example adds a fresh requestId to this input.

{
  "input": {
    "loanAmount": 300000,
    "annualRate": 7,
    "termYears": 30,
    "options": {
      "principalApplication": "immediate-biweekly",
      "escrowTreatment": "annualized",
      "biWeeklyPlanFee": 3
    }
  }
}
Full JSON schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "loanAmount": {
      "type": "number",
      "minimum": 1,
      "maximum": 100000000,
      "description": "Outstanding mortgage principal. In USD."
    },
    "annualRate": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Annual note rate. In percentage points (6.5 means 6.5%).",
      "anyOf": [
        {
          "const": 0
        },
        {
          "minimum": 0.000001
        }
      ]
    },
    "termYears": {
      "type": "integer",
      "minimum": 1,
      "maximum": 50,
      "description": "Repayment term. In whole years."
    },
    "options": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "principalApplication": {
          "type": "string",
          "enum": [
            "monthly-extra",
            "immediate-biweekly",
            "not-applied"
          ],
          "description": "Lender posting of the extra half-payment."
        },
        "escrowTreatment": {
          "type": "string",
          "enum": [
            "annualized",
            "split-total"
          ],
          "description": "Escrow draft treatment."
        },
        "extraPrincipalCadence": {
          "type": "string",
          "enum": [
            "monthly",
            "biweekly"
          ],
          "description": "Frequency of optional extra principal."
        },
        "monthlyEscrow": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000,
          "description": "Escrow excluding mortgage insurance and other costs. In USD per month."
        },
        "monthlyMortgageInsurance": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000,
          "description": "Mortgage insurance. In USD per month."
        },
        "monthlyOtherCosts": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000,
          "description": "Other recurring costs. In USD per month."
        },
        "biWeeklyPlanFee": {
          "type": "number",
          "minimum": 0,
          "maximum": 10000,
          "description": "Fee per two-week draft. In USD."
        },
        "extraBiWeeklyPrincipal": {
          "type": "number",
          "minimum": 0,
          "maximum": 10000000,
          "description": "Extra principal each selected cadence. In USD."
        }
      },
      "required": [
        "principalApplication",
        "escrowTreatment"
      ]
    }
  },
  "required": [
    "loanAmount",
    "annualRate",
    "termYears",
    "options"
  ]
}

Production endpoint: POST https://accounts.hasstechapi.com/v2/reports/mortgage-biweekly-schedule
Formula: biweekly-mortgage-payments-htcalc-719df2c0e105 · Report version: 1.0.0