Skip to content

Financial Hub · Calculation

Financial Hub profile income and payments

Convert the Hub’s one-total or itemized profile entries into monthly income and debt payments. Return the whole-dollar income rows displayed by the app and P&I when an escrow breakdown is supplied.

Open Financial Hub in HT Calc

Visitors can explore a sample snapshot. Saved accounts, loans and properties open within the member’s own Financial Hub.

Example result · monthlyIncome: 3450 USD/month 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-profile-entry-breakdown.

Keep the key on your server. A successful call uses 1 calculation credit.

Production request

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-profile-entry-breakdown";
const input = {
  "income": {
    "mode": "itemized",
    "items": [
      {
        "amount": 25,
        "frequency": "hourly",
        "hoursPerWeek": 30,
        "convertTo": "annual"
      },
      {
        "amount": 2400,
        "frequency": "annual"
      }
    ]
  },
  "payments": {
    "mode": "itemized",
    "items": [
      125.5,
      50
    ]
  },
  "escrowedHousing": {
    "total": 1850,
    "property_tax_monthly": 300,
    "home_insurance_monthly": 125,
    "pmi": 75
  }
};
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 HT_PRODUCTION_KEY on your server. Run in a POSIX shell with cURL 7.76+ and Python 3.7+ to create a request ID.

(
  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-profile-entry-breakdown' \
    --header "Authorization: Bearer $HT_PRODUCTION_KEY" \
    --header 'Content-Type: application/json' \
    --header "Idempotency-Key: $request_id" \
    --data-binary @- <<'HT_INPUT'
{
  "income": {
    "mode": "itemized",
    "items": [
      {
        "amount": 25,
        "frequency": "hourly",
        "hoursPerWeek": 30,
        "convertTo": "annual"
      },
      {
        "amount": 2400,
        "frequency": "annual"
      }
    ]
  },
  "payments": {
    "mode": "itemized",
    "items": [
      125.5,
      50
    ]
  },
  "escrowedHousing": {
    "total": 1850,
    "property_tax_monthly": 300,
    "home_insurance_monthly": 125,
    "pmi": 75
  }
}
HT_INPUT
)
If your request fails
400 INVALID_INPUT

Read error.details when present. Node prints each issue. cURL returns the JSON body. Each path points 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.

401 or 403
Check that the server has the bearer key for the endpoint’s environment and that the key includes financial-hub-profile-entry-breakdown.
429
Read the service error code, check your allowance, and wait for the Retry-After interval when supplied before trying again.
Lost response, 409 or 503
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_ID to 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.

monthlyIncome
3450 USD/month
monthlyPayments
175.5 USD/month
principalAndInterest
1350 USD/month
How to interpret this result
  • Monthly conversions use 52 weeks, 26 biweekly or 24 semi-monthly checks per year. Each profile income row is rounded to cents.
  • Printed whole-dollar income rows are apportioned to add to the displayed total. Unspecified hours default to 40. The escrow P&I residual stays null without a positive total and positive escrow component.
Full example response (JSON)
{
  "status": "available",
  "result": {
    "monthlyIncome": 3450,
    "monthlyPayments": 175.5,
    "incomeRows": [
      {
        "monthly": 3250,
        "shownWhole": 3250,
        "converted": 39000
      },
      {
        "monthly": 200,
        "shownWhole": 200,
        "converted": null
      }
    ],
    "principalAndInterest": 1350
  },
  "formulaVersion": "financial-hub-profile-entry-breakdown-1.0.0",
  "units": {
    "monthlyIncome": "USD/month",
    "monthlyPayments": "USD/month",
    "incomeRows[].monthly": "USD/month",
    "incomeRows[].shownWhole": "whole USD/month",
    "incomeRows[].converted": "USD in requested frequency",
    "principalAndInterest": "USD/month"
  },
  "assumptions": [
    "Monthly conversions use 52 weeks, 26 biweekly or 24 semi-monthly checks per year. Each profile income row is rounded to cents.",
    "Printed whole-dollar income rows are apportioned to add to the displayed total. Unspecified hours default to 40. The escrow P&I residual stays null without a positive total and positive escrow component."
  ],
  "warnings": [],
  "creditCost": 1
}

Request contract

Accepted inputs

Fields for this example. Expand the schema for all supported combinations and limits.

FieldType, units and limits

incomeRequired
object
income.modeRequired
stringMust equal "itemized"
income.itemsRequired
arrayMax items 100
income.items[].amountRequired
number

USD in the frequency specified; payments and escrow values are USD/month.

Min 0 · Max 10000000 · Step 0.01
income.items[].frequencyRequired
stringAllowed: "hourly", "weekly", "bi-weekly", "semi-monthly", "monthly", "annual"
income.items[].hoursPerWeekOptional
number

Hours/week for hourly conversions; defaults to 40.

Min 0.01 · Max 168 · Step 0.01
income.items[].convertToOptional
stringAllowed: "hourly", "weekly", "bi-weekly", "semi-monthly", "monthly", "annual"
paymentsRequired
object
payments.modeRequired
stringMust equal "itemized"
payments.itemsRequired
arrayMax items 100
escrowedHousingOptional
object
escrowedHousing.totalRequired
number

USD in the frequency specified; payments and escrow values are USD/month.

Min 0 · Max 10000000 · Step 0.01
escrowedHousing.property_tax_monthlyOptional
number

USD in the frequency specified; payments and escrow values are USD/month.

Min 0 · Max 10000000 · Step 0.01
escrowedHousing.home_insurance_monthlyOptional
number

USD in the frequency specified; payments and escrow values are USD/month.

Min 0 · Max 10000000 · Step 0.01
escrowedHousing.pmiOptional
number

USD in the frequency specified; payments and escrow values are USD/month.

Min 0 · Max 10000000 · Step 0.01
Example request body (JSON)
{
  "income": {
    "mode": "itemized",
    "items": [
      {
        "amount": 25,
        "frequency": "hourly",
        "hoursPerWeek": 30,
        "convertTo": "annual"
      },
      {
        "amount": 2400,
        "frequency": "annual"
      }
    ]
  },
  "payments": {
    "mode": "itemized",
    "items": [
      125.5,
      50
    ]
  },
  "escrowedHousing": {
    "total": 1850,
    "property_tax_monthly": 300,
    "home_insurance_monthly": 125,
    "pmi": 75
  }
}
Full JSON schema
{
  "type": "object",
  "properties": {
    "income": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "mode": {
              "const": "total"
            },
            "total": {
              "type": "object",
              "properties": {
                "amount": {
                  "type": "number",
                  "minimum": 0,
                  "maximum": 10000000,
                  "multipleOf": 0.01,
                  "description": "USD in the frequency specified; payments and escrow values are USD/month."
                },
                "frequency": {
                  "type": "string",
                  "enum": [
                    "hourly",
                    "weekly",
                    "bi-weekly",
                    "semi-monthly",
                    "monthly",
                    "annual"
                  ]
                },
                "hoursPerWeek": {
                  "type": "number",
                  "minimum": 0.01,
                  "maximum": 168,
                  "multipleOf": 0.01,
                  "description": "Hours/week for hourly conversions; defaults to 40."
                },
                "convertTo": {
                  "type": "string",
                  "enum": [
                    "hourly",
                    "weekly",
                    "bi-weekly",
                    "semi-monthly",
                    "monthly",
                    "annual"
                  ]
                }
              },
              "required": [
                "amount",
                "frequency"
              ],
              "additionalProperties": false
            }
          },
          "required": [
            "mode",
            "total"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "mode": {
              "const": "itemized"
            },
            "items": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "amount": {
                    "type": "number",
                    "minimum": 0,
                    "maximum": 10000000,
                    "multipleOf": 0.01,
                    "description": "USD in the frequency specified; payments and escrow values are USD/month."
                  },
                  "frequency": {
                    "type": "string",
                    "enum": [
                      "hourly",
                      "weekly",
                      "bi-weekly",
                      "semi-monthly",
                      "monthly",
                      "annual"
                    ]
                  },
                  "hoursPerWeek": {
                    "type": "number",
                    "minimum": 0.01,
                    "maximum": 168,
                    "multipleOf": 0.01,
                    "description": "Hours/week for hourly conversions; defaults to 40."
                  },
                  "convertTo": {
                    "type": "string",
                    "enum": [
                      "hourly",
                      "weekly",
                      "bi-weekly",
                      "semi-monthly",
                      "monthly",
                      "annual"
                    ]
                  }
                },
                "required": [
                  "amount",
                  "frequency"
                ],
                "additionalProperties": false
              },
              "maxItems": 100
            }
          },
          "required": [
            "mode",
            "items"
          ],
          "additionalProperties": false
        }
      ]
    },
    "payments": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "mode": {
              "const": "total"
            },
            "total": {
              "type": "number",
              "minimum": 0,
              "maximum": 10000000,
              "multipleOf": 0.01,
              "description": "USD in the frequency specified; payments and escrow values are USD/month."
            }
          },
          "required": [
            "mode",
            "total"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "mode": {
              "const": "itemized"
            },
            "items": {
              "type": "array",
              "items": {
                "type": "number",
                "minimum": 0,
                "maximum": 10000000,
                "multipleOf": 0.01,
                "description": "USD in the frequency specified; payments and escrow values are USD/month."
              },
              "maxItems": 100
            }
          },
          "required": [
            "mode",
            "items"
          ],
          "additionalProperties": false
        }
      ]
    },
    "escrowedHousing": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "minimum": 0,
          "maximum": 10000000,
          "multipleOf": 0.01,
          "description": "USD in the frequency specified; payments and escrow values are USD/month."
        },
        "property_tax_monthly": {
          "type": "number",
          "minimum": 0,
          "maximum": 10000000,
          "multipleOf": 0.01,
          "description": "USD in the frequency specified; payments and escrow values are USD/month."
        },
        "home_insurance_monthly": {
          "type": "number",
          "minimum": 0,
          "maximum": 10000000,
          "multipleOf": 0.01,
          "description": "USD in the frequency specified; payments and escrow values are USD/month."
        },
        "pmi": {
          "type": "number",
          "minimum": 0,
          "maximum": 10000000,
          "multipleOf": 0.01,
          "description": "USD in the frequency specified; payments and escrow values are USD/month."
        }
      },
      "required": [
        "total"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "income",
    "payments"
  ],
  "additionalProperties": false
}

Production endpoint: POST https://calc.hasstechapi.com/v2/calc/financial-hub-profile-entry-breakdown
Formula: financial-hub-profile-entry-breakdown-1.0.0