Financial Hub · Calculation
Financial Hub liability progress
Aggregate principal repaid and remaining, card utilization, individual payoff progress and whole-dollar figures that add up as printed on the Hub.
Visitors can explore a sample snapshot. Saved accounts, loans and properties open within the member’s own Financial Hub.
Example result · totalOriginalPrincipal: 100.4 See output
- Cost per success
- 1 calculation credit
- Production plans
- Standard, Business, Scale, Enterprise
Plan allowances - Free sandbox
- Not available
Integration example
Make a request
Use a production key scoped to financial-hub-liability-progress.
Keep the key on your server. A successful call uses 1 calculation credit.
Set HT_PRODUCTION_KEY on your server. Save as example.mjs and run node example.mjs with Node.js 18 or later.
import { randomUUID } from "node:crypto";
const key = process.env.HT_PRODUCTION_KEY;
if (!key) throw new Error("Set HT_PRODUCTION_KEY on your server.");
const endpoint = "https://calc.hasstechapi.com/v2/calc/financial-hub-liability-progress";
const input = {
"accounts": [
{
"key": "loan",
"accountType": "auto_loan",
"currentBalance": 70,
"projectedBalance": 80.6,
"originalPrincipal": 100.4
},
{
"key": "card",
"accountType": "credit_card",
"currentBalance": 70.6,
"creditLimit": 50
},
{
"key": "skip",
"accountType": "loan",
"archived": true,
"currentBalance": 400,
"originalPrincipal": 500
}
]
};
const requestId = process.env.HT_REQUEST_ID || Date.now() + "." + randomUUID();
// Keep this ID to look up usage if the connection is interrupted.
console.error("Usage lookup ID:", requestId);
const response = await fetch(endpoint, {
method: "POST",
redirect: "error",
headers: {
"Authorization": "Bearer " + key,
"Content-Type": "application/json",
"Idempotency-Key": requestId
},
body: JSON.stringify(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 {
console.log(JSON.stringify(await response.json(), null, 2));
} cURL (shell)
(
set -eu
: "${HT_PRODUCTION_KEY:?Set HT_PRODUCTION_KEY on your server}"
request_id="${HT_REQUEST_ID:-}"
if [ -z "$request_id" ]; then
request_id=$(python3 -c 'import time, uuid; print(str(time.time_ns() // 1000000) + "." + str(uuid.uuid4()))')
fi
printf 'Usage lookup ID: %s\n' "$request_id" >&2
# On INVALID_INPUT, read error.details in the JSON response body.
curl --disable --silent --show-error --fail-with-body --include \
--request POST 'https://calc.hasstechapi.com/v2/calc/financial-hub-liability-progress' \
--header "Authorization: Bearer $HT_PRODUCTION_KEY" \
--header 'Content-Type: application/json' \
--header "Idempotency-Key: $request_id" \
--data-binary @- <<'HT_INPUT'
{
"accounts": [
{
"key": "loan",
"accountType": "auto_loan",
"currentBalance": 70,
"projectedBalance": 80.6,
"originalPrincipal": 100.4
},
{
"key": "card",
"accountType": "credit_card",
"currentBalance": 70.6,
"creditLimit": 50
},
{
"key": "skip",
"accountType": "loan",
"archived": true,
"currentBalance": 400,
"originalPrincipal": 500
}
]
}
HT_INPUT
) If your request fails
400 INVALID_INPUT-
Read
error.detailswhen present. Node prints each issue. cURL returns the JSON body. Eachpathpoints into your request. An empty path refers to the whole body.Check the accepted inputs for required fields, units and ranges. Send the corrected JSON as a new request.
401or403- Check that the server has the bearer key for the endpoint’s environment and that the key includes
financial-hub-liability-progress. 429- Read the service error code, check your allowance, and wait for the
Retry-Afterinterval when supplied before trying again. - Lost response,
409or503 - Open Request lookup, select the same environment and enter the printed usage lookup ID. A settled ID has already consumed credits. To retry the same calculation, set
HT_REQUEST_IDto the original ID and reuse the same inputs. A settled request does not return its result again. Unset the variable for a new request, which can consume credits.
The usage lookup ID is the Idempotency-Key your server sends. The response’s x-request-id identifies the HTTP exchange for support.
Output
Example result
These values come from running this operation on the example inputs.
totalOriginalPrincipal- 100.4
totalCurrentLoanBalance- 80.6
totalDebtPaidOff- 19.80000000000001
How to interpret this result
- Use projected balances where supplied. Exclude archived accounts and assets. Only non-card loans with recorded positive original principal enter the overall payoff calculation.
Full example response (JSON)
{
"status": "available",
"result": {
"totalOriginalPrincipal": 100.4,
"totalCurrentLoanBalance": 80.6,
"totalDebtPaidOff": 19.80000000000001,
"overallLoanPayoffProgress": 19.721115537848615,
"printed": {
"liabilities": 152,
"original": 100,
"remaining": 81,
"paidOff": 19
},
"accounts": [
{
"key": "loan",
"balance": 80.6,
"progressKind": "paid",
"progressPercent": 19.721115537848615
},
{
"key": "card",
"balance": 70.6,
"progressKind": "utilized",
"progressPercent": 141.2
}
]
},
"formulaVersion": "financial-hub-liability-progress-v1",
"units": {
"money": "USD",
"progressPercent": "percent",
"overallLoanPayoffProgress": "percent"
},
"assumptions": [
"Use projected balances where supplied. Exclude archived accounts and assets. Only non-card loans with recorded positive original principal enter the overall payoff calculation."
],
"warnings": [],
"creditCost": 1
}Request contract
Accepted inputs
Fields for this example. Expand the schema for all supported combinations and limits.
FieldType, units and limits
accountsRequiredaccounts[].keyRequiredCaller-defined, nonidentifying key within this request.
Min length 1 · Max length 48accounts[].accountTypeRequiredaccounts[].archivedOptionalaccounts[].currentBalanceRequiredNonnegative currency major units; smallest nonzero amount is 0.000001.
Min 0 · Max 1000000000000accounts[].projectedBalanceOptionalNonnegative currency major units; smallest nonzero amount is 0.000001.
Min 0 · Max 1000000000000accounts[].originalPrincipalOptionalNonnegative currency major units; smallest nonzero amount is 0.000001.
Min 0 · Max 1000000000000accounts[].creditLimitOptionalNonnegative currency major units; smallest nonzero amount is 0.000001.
Min 0 · Max 1000000000000Example request body (JSON)
{
"accounts": [
{
"key": "loan",
"accountType": "auto_loan",
"currentBalance": 70,
"projectedBalance": 80.6,
"originalPrincipal": 100.4
},
{
"key": "card",
"accountType": "credit_card",
"currentBalance": 70.6,
"creditLimit": 50
},
{
"key": "skip",
"accountType": "loan",
"archived": true,
"currentBalance": 400,
"originalPrincipal": 500
}
]
} Full JSON schema
{
"type": "object",
"properties": {
"accounts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"minLength": 1,
"maxLength": 48,
"pattern": "^[A-Za-z0-9_-]+$",
"description": "Caller-defined, nonidentifying key within this request."
},
"accountType": {
"type": "string",
"enum": [
"checking",
"savings",
"cash",
"investment",
"retirement",
"money_market",
"cd",
"crypto",
"property",
"vehicle",
"collectible",
"business_interest",
"other",
"credit_card",
"mortgage",
"auto_loan",
"student_loan",
"personal_loan",
"loan",
"heloc",
"home_equity_loan"
]
},
"archived": {
"type": "boolean"
},
"currentBalance": {
"type": "number",
"minimum": 0,
"maximum": 1000000000000,
"description": "Nonnegative currency major units; smallest nonzero amount is 0.000001.",
"anyOf": [
{
"const": 0
},
{
"minimum": 0.000001
}
]
},
"projectedBalance": {
"type": "number",
"minimum": 0,
"maximum": 1000000000000,
"description": "Nonnegative currency major units; smallest nonzero amount is 0.000001.",
"anyOf": [
{
"const": 0
},
{
"minimum": 0.000001
}
]
},
"originalPrincipal": {
"type": "number",
"minimum": 0,
"maximum": 1000000000000,
"description": "Nonnegative currency major units; smallest nonzero amount is 0.000001.",
"anyOf": [
{
"const": 0
},
{
"minimum": 0.000001
}
]
},
"creditLimit": {
"type": "number",
"minimum": 0,
"maximum": 1000000000000,
"description": "Nonnegative currency major units; smallest nonzero amount is 0.000001.",
"anyOf": [
{
"const": 0
},
{
"minimum": 0.000001
}
]
}
},
"required": [
"key",
"accountType",
"currentBalance"
],
"additionalProperties": false
},
"minItems": 0,
"maxItems": 128
}
},
"required": [
"accounts"
],
"additionalProperties": false
}Production endpoint: POST https://calc.hasstechapi.com/v2/calc/financial-hub-liability-progress
Formula: financial-hub-liability-progress-v1