Mortgage · Calculation
Monthly income across pay frequencies
Combine verified entered wages and salaries into a monthly budget, including the selected treatment of hourly overtime.
Example result · value: 7200 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 income-frequency-normalization.
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/income-frequency-normalization";
const input = {
"items": [
{
"id": "hourly",
"label": "Hourly wages",
"amount": 30,
"frequency": "hourly",
"hoursPerWeek": 48,
"overtimeVerified": false
},
{
"id": "annual",
"label": "Other salary",
"amount": 24000,
"frequency": "annual",
"hoursPerWeek": 40,
"overtimeVerified": false
}
]
};
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/income-frequency-normalization' \
--header "Authorization: Bearer $HT_PRODUCTION_KEY" \
--header 'Content-Type: application/json' \
--header "Idempotency-Key: $request_id" \
--data-binary @- <<'HT_INPUT'
{
"items": [
{
"id": "hourly",
"label": "Hourly wages",
"amount": 30,
"frequency": "hourly",
"hoursPerWeek": 48,
"overtimeVerified": false
},
{
"id": "annual",
"label": "Other salary",
"amount": 24000,
"frequency": "annual",
"hoursPerWeek": 40,
"overtimeVerified": false
}
]
}
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
income-frequency-normalization. 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.
value- 7200 USD/month
How to interpret this result
- Hourly earnings are capped at 40 hours a week unless overtime history is confirmed.
Full example response (JSON)
{
"status": "available",
"result": {
"value": 7200
},
"formulaVersion": "income-frequency-normalization-htcalc-719df2c0e105",
"units": {
"value": "USD/month"
},
"assumptions": [
"Hourly earnings are capped at 40 hours a week unless overtime history is confirmed."
],
"warnings": [],
"creditCost": 1
}Request contract
Accepted inputs
Fields for this example. Expand the schema for all supported combinations and limits.
FieldType, units and limits
itemsRequireditems[].idRequireditems[].labelRequireditems[].amountRequiredUSD per pay period, or USD/hour for hourly
Min 0 · Max 1000000000items[].frequencyRequireditems[].hoursPerWeekRequiredHours per week
Min 0 · Max 168items[].overtimeVerifiedRequiredExample request body (JSON)
{
"items": [
{
"id": "hourly",
"label": "Hourly wages",
"amount": 30,
"frequency": "hourly",
"hoursPerWeek": 48,
"overtimeVerified": false
},
{
"id": "annual",
"label": "Other salary",
"amount": 24000,
"frequency": "annual",
"hoursPerWeek": 40,
"overtimeVerified": false
}
]
} Full JSON schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"items": {
"type": "array",
"maxItems": 40,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"maxLength": 64
},
"label": {
"type": "string",
"maxLength": 100
},
"amount": {
"type": "number",
"minimum": 0,
"maximum": 1000000000,
"description": "USD per pay period, or USD/hour for hourly"
},
"frequency": {
"type": "string",
"enum": [
"annual",
"monthly",
"semi-monthly",
"bi-weekly",
"weekly",
"hourly"
]
},
"hoursPerWeek": {
"type": "number",
"minimum": 0,
"maximum": 168,
"description": "Hours per week"
},
"overtimeVerified": {
"type": "boolean"
}
},
"required": [
"id",
"label",
"amount",
"frequency",
"hoursPerWeek",
"overtimeVerified"
]
}
}
},
"required": [
"items"
]
}Production endpoint: POST https://calc.hasstechapi.com/v2/calc/income-frequency-normalization
Formula: income-frequency-normalization-htcalc-719df2c0e105