PDF report
Advanced affordability
Advanced affordability prepared from validated scenario inputs by the original HT Calc report builder.
Choose Advanced in the affordability calculator.
- 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
- 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
mortgage-affordability-advancedand 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 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.
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-affordability-advanced";
const input = {
"baseMonthlyIncome": 8500,
"monthlyDebts": 650,
"loanProgram": "conventional",
"interestRate": 6.5,
"loanTerm": 30,
"propertyTaxRate": 1.1,
"insuranceRate": 0.35,
"targetDti": 43,
"downPaymentMode": "percent",
"downPaymentPercent": 10,
"downPaymentCash": 0,
"incomeHistory": {
"rule": "fannie",
"commission": {
"lastYear": 17000,
"priorYear": 22000
},
"retirementMonthly": 0,
"includeMortgageInsurance": true
}
};
const requestId = Date.now() + "." + randomUUID();
const output = "mortgage-affordability-advanced-" + 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-affordability-advanced-<requestId>.pdf.
Request contract
Accepted inputs
Fields for this example. Expand the schema for all supported combinations and limits.
FieldType, units and limits
baseMonthlyIncomeRequiredUS dollars, greater than zero.
Max 1000000000 · Greater than 0monthlyDebtsRequiredUS dollars; enter zero when this cost is absent.
Min 0 · Max 1000000000loanProgramRequiredinterestRateRequiredPercentage points (6.5 means 6.5%).
Min 0 · Max 100loanTermRequiredWhole years of payments.
Min 1 · Max 50propertyTaxRateRequiredPercentage points (6.5 means 6.5%).
Min 0 · Max 100insuranceRateRequiredPercentage points (6.5 means 6.5%).
Min 0 · Max 100targetDtiRequiredPercentage points (6.5 means 6.5%).
Max 100 · Greater than 0downPaymentModeRequireddownPaymentPercentRequiredPercentage points (6.5 means 6.5%).
Min 0 · Less than 100downPaymentCashRequiredUS dollars; enter zero when this cost is absent.
Min 0 · Max 1000000000comparisonRatesOptionalCaller-supplied annual note rates in percent for the side-by-side program estimates.
comparisonRates.conventionalRequiredPercentage points (6.5 means 6.5%).
Min 0 · Max 100comparisonRates.fhaRequiredPercentage points (6.5 means 6.5%).
Min 0 · Max 100comparisonRates.vaRequiredPercentage points (6.5 means 6.5%).
Min 0 · Max 100comparisonRates.usdaRequiredPercentage points (6.5 means 6.5%).
Min 0 · Max 100incomeHistoryRequiredincomeHistory.ruleRequiredincomeHistory.selfEmploymentOptionalincomeHistory.selfEmployment.lastYearRequiredUS dollars; enter zero when this cost is absent.
Min 0 · Max 1000000000incomeHistory.selfEmployment.priorYearRequiredUS dollars; enter zero when this cost is absent.
Min 0 · Max 1000000000incomeHistory.selfEmployment.ytdOptionalincomeHistory.selfEmployment.ytd.amountRequiredUS dollars; enter zero when this cost is absent.
Min 0 · Max 1000000000incomeHistory.selfEmployment.ytd.monthsElapsedRequiredincomeHistory.commissionOptionalincomeHistory.commission.lastYearRequiredUS dollars; enter zero when this cost is absent.
Min 0 · Max 1000000000incomeHistory.commission.priorYearRequiredUS dollars; enter zero when this cost is absent.
Min 0 · Max 1000000000incomeHistory.commission.ytdOptionalincomeHistory.commission.ytd.amountRequiredUS dollars; enter zero when this cost is absent.
Min 0 · Max 1000000000incomeHistory.commission.ytd.monthsElapsedRequiredincomeHistory.bonusOptionalincomeHistory.bonus.lastYearRequiredUS dollars; enter zero when this cost is absent.
Min 0 · Max 1000000000incomeHistory.bonus.priorYearRequiredUS dollars; enter zero when this cost is absent.
Min 0 · Max 1000000000incomeHistory.bonus.ytdOptionalincomeHistory.bonus.ytd.amountRequiredUS dollars; enter zero when this cost is absent.
Min 0 · Max 1000000000incomeHistory.bonus.ytd.monthsElapsedRequiredincomeHistory.retirementMonthlyRequiredUS dollars; enter zero when this cost is absent.
Min 0 · Max 1000000000incomeHistory.includeMortgageInsuranceRequiredincomeHistory.pmiRateOverrideOptionalPercentage points (6.5 means 6.5%).
Min 0 · Max 100Example input (JSON)
The server example adds a fresh requestId to this input.
{
"input": {
"baseMonthlyIncome": 8500,
"monthlyDebts": 650,
"loanProgram": "conventional",
"interestRate": 6.5,
"loanTerm": 30,
"propertyTaxRate": 1.1,
"insuranceRate": 0.35,
"targetDti": 43,
"downPaymentMode": "percent",
"downPaymentPercent": 10,
"downPaymentCash": 0,
"incomeHistory": {
"rule": "fannie",
"commission": {
"lastYear": 17000,
"priorYear": 22000
},
"retirementMonthly": 0,
"includeMortgageInsurance": true
}
}
} Full JSON schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"baseMonthlyIncome": {
"type": "number",
"exclusiveMinimum": 0,
"maximum": 1000000000,
"description": "US dollars, greater than zero."
},
"monthlyDebts": {
"type": "number",
"minimum": 0,
"maximum": 1000000000,
"description": "US dollars; enter zero when this cost is absent."
},
"loanProgram": {
"type": "string",
"enum": [
"conventional",
"fha",
"va",
"usda"
]
},
"interestRate": {
"type": "number",
"minimum": 0,
"maximum": 100,
"description": "Percentage points (6.5 means 6.5%)."
},
"loanTerm": {
"type": "integer",
"minimum": 1,
"maximum": 50,
"description": "Whole years of payments."
},
"propertyTaxRate": {
"type": "number",
"minimum": 0,
"maximum": 100,
"description": "Percentage points (6.5 means 6.5%)."
},
"insuranceRate": {
"type": "number",
"minimum": 0,
"maximum": 100,
"description": "Percentage points (6.5 means 6.5%)."
},
"targetDti": {
"type": "number",
"exclusiveMinimum": 0,
"maximum": 100,
"description": "Percentage points (6.5 means 6.5%)."
},
"downPaymentMode": {
"type": "string",
"enum": [
"percent",
"cash"
]
},
"downPaymentPercent": {
"type": "number",
"minimum": 0,
"exclusiveMaximum": 100,
"description": "Percentage points (6.5 means 6.5%)."
},
"downPaymentCash": {
"type": "number",
"minimum": 0,
"maximum": 1000000000,
"description": "US dollars; enter zero when this cost is absent."
},
"comparisonRates": {
"description": "Caller-supplied annual note rates in percent for the side-by-side program estimates.",
"type": "object",
"properties": {
"conventional": {
"type": "number",
"minimum": 0,
"maximum": 100,
"description": "Percentage points (6.5 means 6.5%)."
},
"fha": {
"type": "number",
"minimum": 0,
"maximum": 100,
"description": "Percentage points (6.5 means 6.5%)."
},
"va": {
"type": "number",
"minimum": 0,
"maximum": 100,
"description": "Percentage points (6.5 means 6.5%)."
},
"usda": {
"type": "number",
"minimum": 0,
"maximum": 100,
"description": "Percentage points (6.5 means 6.5%)."
}
},
"required": [
"conventional",
"fha",
"va",
"usda"
],
"additionalProperties": false
},
"incomeHistory": {
"type": "object",
"properties": {
"rule": {
"type": "string",
"enum": [
"fannie",
"freddie"
]
},
"selfEmployment": {
"type": "object",
"properties": {
"lastYear": {
"type": "number",
"minimum": 0,
"maximum": 1000000000,
"description": "US dollars; enter zero when this cost is absent."
},
"priorYear": {
"type": "number",
"minimum": 0,
"maximum": 1000000000,
"description": "US dollars; enter zero when this cost is absent."
},
"ytd": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"minimum": 0,
"maximum": 1000000000,
"description": "US dollars; enter zero when this cost is absent."
},
"monthsElapsed": {
"type": "integer",
"minimum": 1,
"maximum": 12
}
},
"required": [
"amount",
"monthsElapsed"
],
"additionalProperties": false
}
},
"required": [
"lastYear",
"priorYear"
],
"additionalProperties": false
},
"commission": {
"type": "object",
"properties": {
"lastYear": {
"type": "number",
"minimum": 0,
"maximum": 1000000000,
"description": "US dollars; enter zero when this cost is absent."
},
"priorYear": {
"type": "number",
"minimum": 0,
"maximum": 1000000000,
"description": "US dollars; enter zero when this cost is absent."
},
"ytd": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"minimum": 0,
"maximum": 1000000000,
"description": "US dollars; enter zero when this cost is absent."
},
"monthsElapsed": {
"type": "integer",
"minimum": 1,
"maximum": 12
}
},
"required": [
"amount",
"monthsElapsed"
],
"additionalProperties": false
}
},
"required": [
"lastYear",
"priorYear"
],
"additionalProperties": false
},
"bonus": {
"type": "object",
"properties": {
"lastYear": {
"type": "number",
"minimum": 0,
"maximum": 1000000000,
"description": "US dollars; enter zero when this cost is absent."
},
"priorYear": {
"type": "number",
"minimum": 0,
"maximum": 1000000000,
"description": "US dollars; enter zero when this cost is absent."
},
"ytd": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"minimum": 0,
"maximum": 1000000000,
"description": "US dollars; enter zero when this cost is absent."
},
"monthsElapsed": {
"type": "integer",
"minimum": 1,
"maximum": 12
}
},
"required": [
"amount",
"monthsElapsed"
],
"additionalProperties": false
}
},
"required": [
"lastYear",
"priorYear"
],
"additionalProperties": false
},
"retirementMonthly": {
"type": "number",
"minimum": 0,
"maximum": 1000000000,
"description": "US dollars; enter zero when this cost is absent."
},
"includeMortgageInsurance": {
"type": "boolean"
},
"pmiRateOverride": {
"type": "number",
"minimum": 0,
"maximum": 100,
"description": "Percentage points (6.5 means 6.5%)."
}
},
"required": [
"rule",
"retirementMonthly",
"includeMortgageInsurance"
],
"additionalProperties": false
}
},
"required": [
"baseMonthlyIncome",
"monthlyDebts",
"loanProgram",
"interestRate",
"loanTerm",
"propertyTaxRate",
"insuranceRate",
"targetDti",
"downPaymentMode",
"downPaymentPercent",
"downPaymentCash",
"incomeHistory"
],
"additionalProperties": false
}Production endpoint: POST https://accounts.hasstechapi.com/v2/reports/mortgage-affordability-advanced
Formula: prepare-mortgage-affordability-1.0.0 · Report version: 1.0.0