Personal finance · Calculation
Monthly budget
Calculate surplus from take-home income and expenses and see the share left over.
Example result · surplus: 0 USD/month See output
- Cost per success
- 1 calculation credit
- Production plans
- Standard, Business, Scale, Enterprise
Plan allowances - Free sandbox
- Available · see example
Integration example
Make a request
Use a free sandbox key scoped to budget-arithmetic. New developer? Create a workspace and register an application to issue your key.
Keep the key on your server. A successful call uses 1 calculation credit from the selected environment.
Set HT_SANDBOX_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_SANDBOX_KEY;
if (!key) throw new Error("Set HT_SANDBOX_KEY on your server.");
const endpoint = "https://sandbox.hasstechapi.com/v2/calc/budget-arithmetic";
const input = {
"monthlyIncome": 12,
"monthlyExpenses": 12
};
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_SANDBOX_KEY:?Set HT_SANDBOX_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://sandbox.hasstechapi.com/v2/calc/budget-arithmetic' \
--header "Authorization: Bearer $HT_SANDBOX_KEY" \
--header 'Content-Type: application/json' \
--header "Idempotency-Key: $request_id" \
--data-binary @- <<'HT_INPUT'
{
"monthlyIncome": 12,
"monthlyExpenses": 12
}
HT_INPUT
) 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/budget-arithmetic";
const input = {
"monthlyIncome": 12,
"monthlyExpenses": 12
};
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/budget-arithmetic' \
--header "Authorization: Bearer $HT_PRODUCTION_KEY" \
--header 'Content-Type: application/json' \
--header "Idempotency-Key: $request_id" \
--data-binary @- <<'HT_INPUT'
{
"monthlyIncome": 12,
"monthlyExpenses": 12
}
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
budget-arithmetic. 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.
surplus- 0 USD/month
surplusRatio- 0 ratio
How to interpret this result
- Supplied monthly totals only; no spending classification or recommendations.
Full example response (JSON)
{
"status": "available",
"result": {
"surplus": 0,
"surplusRatio": 0
},
"formulaVersion": "budget-arithmetic-1.0.0",
"units": {
"surplus": "USD/month",
"surplusRatio": "ratio"
},
"assumptions": [
"Supplied monthly totals only; no spending classification or recommendations."
],
"warnings": [],
"creditCost": 1
}Request contract
Accepted inputs
Fields for this example. Expand the schema for all supported combinations and limits.
FieldType, units and limits
monthlyIncomeRequiredTotal income for one month.
Min 0 · Max 1000000000 · Step 0.01monthlyExpensesRequiredTotal expenses for one month.
Min 0 · Max 1000000000 · Step 0.01Example request body (JSON)
{
"monthlyIncome": 12,
"monthlyExpenses": 12
} Full JSON schema
{
"type": "object",
"properties": {
"monthlyIncome": {
"type": "number",
"description": "Total income for one month.",
"x-unit": "USD/month",
"minimum": 0,
"maximum": 1000000000,
"multipleOf": 0.01,
"x-core-refinement": true
},
"monthlyExpenses": {
"type": "number",
"description": "Total expenses for one month.",
"x-unit": "USD/month",
"minimum": 0,
"maximum": 1000000000,
"multipleOf": 0.01,
"x-core-refinement": true
}
},
"required": [
"monthlyIncome",
"monthlyExpenses"
],
"additionalProperties": false
}Production endpoint: POST https://calc.hasstechapi.com/v2/calc/budget-arithmetic
Formula: budget-arithmetic-1.0.0