Skip to content

Mortgage · Calculation

Renovation budget and contractor quote

Total entered estimates and actuals, contingency, markup, discounts, tax, deposit and milestone payments.

Open Renovation Planner in HT Calc

This HT Calc screen includes a Plus sample for visitors.

Example result · estimatedTotal: 5000 USD 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 renovation-budget-and-quote.

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/renovation-budget-and-quote";
const input = {
  "items": [
    {
      "id": "wood",
      "category": "Materials",
      "name": "Lumber",
      "estimatedCost": 3000,
      "actualCost": 2500,
      "materialCost": 3000,
      "isCompleted": true
    },
    {
      "id": "crew",
      "category": "Labor",
      "name": "Installation",
      "estimatedCost": 2000,
      "actualCost": 500,
      "materialCost": 0,
      "isCompleted": false
    }
  ],
  "budget": 6000,
  "contingencyRate": 10,
  "contractorSettings": {
    "markupRate": 10,
    "discountType": "percent",
    "discountAmount": 0,
    "taxMaterialsOnly": true,
    "taxRate": 5,
    "depositPercent": 20,
    "milestones": [
      {
        "id": "m1",
        "name": "Midpoint",
        "percent": 30
      }
    ]
  }
};
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/renovation-budget-and-quote' \
    --header "Authorization: Bearer $HT_PRODUCTION_KEY" \
    --header 'Content-Type: application/json' \
    --header "Idempotency-Key: $request_id" \
    --data-binary @- <<'HT_INPUT'
{
  "items": [
    {
      "id": "wood",
      "category": "Materials",
      "name": "Lumber",
      "estimatedCost": 3000,
      "actualCost": 2500,
      "materialCost": 3000,
      "isCompleted": true
    },
    {
      "id": "crew",
      "category": "Labor",
      "name": "Installation",
      "estimatedCost": 2000,
      "actualCost": 500,
      "materialCost": 0,
      "isCompleted": false
    }
  ],
  "budget": 6000,
  "contingencyRate": 10,
  "contractorSettings": {
    "markupRate": 10,
    "discountType": "percent",
    "discountAmount": 0,
    "taxMaterialsOnly": true,
    "taxRate": 5,
    "depositPercent": 20,
    "milestones": [
      {
        "id": "m1",
        "name": "Midpoint",
        "percent": 30
      }
    ]
  }
}
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 renovation-budget-and-quote.
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.

estimatedTotal
5000 USD
actualTotal
3000 USD
contingencyAmount
500 USD
Full example response (JSON)
{
  "status": "available",
  "result": {
    "estimatedTotal": 5000,
    "actualTotal": 3000,
    "contingencyAmount": 500,
    "finalEstimatedTotal": 5500,
    "remainingBudget": 3000,
    "projectedVariance": 500,
    "percentUsed": 50,
    "percentComplete": 50,
    "chartData": [
      {
        "name": "Materials",
        "value": 3000
      },
      {
        "name": "Labor",
        "value": 2000
      }
    ],
    "totalMarkup": 500,
    "subtotalWithMarkup": 5500,
    "discountValue": 0,
    "subtotalAfterDiscount": 5500,
    "totalTax": 165,
    "clientTotal": 5665,
    "depositAmount": 1133,
    "milestonesTotal": 1699.5,
    "finalPayment": 2832.5
  },
  "formulaVersion": "renovation-budget-and-quote-htcalc-719df2c0e105",
  "units": {
    "estimatedTotal": "USD",
    "actualTotal": "USD",
    "contingencyAmount": "USD",
    "clientTotal": "USD",
    "totalTax": "USD",
    "depositAmount": "USD",
    "finalPayment": "USD"
  },
  "assumptions": [],
  "warnings": [],
  "creditCost": 1
}

Request contract

Accepted inputs

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

FieldType, units and limits

itemsRequired
arrayMin items 1 · Max items 100
items[].idOptional
string or integer
items[].nameOptional
stringMin length 1 · Max length 100
items[].categoryRequired
stringAllowed: "Materials", "Labor", "Services", "Permits", "Other"
items[].quantityOptional
number

Units

Min 0 · Max 1000000
items[].unitOptional
stringMin length 0 · Max length 24
items[].estimatedCostRequired
number

US dollars

Min 0 · Max 1000000000
items[].materialCostRequired
number

US dollars

Min 0 · Max 1000000000
items[].laborCostOptional
number

US dollars

Min 0 · Max 1000000000
items[].actualCostRequired
number

US dollars

Min 0 · Max 1000000000
items[].isCompletedRequired
boolean
budgetRequired
number

US dollars

Min 0 · Max 1000000000
contingencyRateRequired
number

Percent; 5 means 5%

Min 0 · Max 100
contractorSettingsRequired
object
contractorSettings.markupRateRequired
number

Percent; 5 means 5%

Min 0 · Max 100
contractorSettings.taxRateRequired
number

Percent; 5 means 5%

Min 0 · Max 100
contractorSettings.taxMaterialsOnlyRequired
boolean
contractorSettings.discountTypeRequired
stringAllowed: "percent", "fixed"
contractorSettings.discountAmountRequired
number

Percent or US dollars according to discountType

Min 0 · Max 1000000000
contractorSettings.depositPercentRequired
number

Percent; 5 means 5%

Min 0 · Max 100
contractorSettings.milestonesRequired
arrayMin items 0 · Max items 32
contractorSettings.milestones[].idOptional
string or integer
contractorSettings.milestones[].nameOptional
stringMin length 1 · Max length 80
contractorSettings.milestones[].percentRequired
number

Percent; 5 means 5%

Min 0 · Max 100
Example request body (JSON)
{
  "items": [
    {
      "id": "wood",
      "category": "Materials",
      "name": "Lumber",
      "estimatedCost": 3000,
      "actualCost": 2500,
      "materialCost": 3000,
      "isCompleted": true
    },
    {
      "id": "crew",
      "category": "Labor",
      "name": "Installation",
      "estimatedCost": 2000,
      "actualCost": 500,
      "materialCost": 0,
      "isCompleted": false
    }
  ],
  "budget": 6000,
  "contingencyRate": 10,
  "contractorSettings": {
    "markupRate": 10,
    "discountType": "percent",
    "discountAmount": 0,
    "taxMaterialsOnly": true,
    "taxRate": 5,
    "depositPercent": 20,
    "milestones": [
      {
        "id": "m1",
        "name": "Midpoint",
        "percent": 30
      }
    ]
  }
}
Full JSON schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "anyOf": [
              {
                "type": "string",
                "minLength": 1,
                "maxLength": 80,
                "pattern": "^[^\\u0000-\\u001f\\u007f]*$"
              },
              {
                "type": "integer",
                "minimum": 0,
                "maximum": 1000000000,
                "description": "Local item ID"
              }
            ]
          },
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 100,
            "pattern": "^[^\\u0000-\\u001f\\u007f]*$"
          },
          "category": {
            "type": "string",
            "enum": [
              "Materials",
              "Labor",
              "Services",
              "Permits",
              "Other"
            ]
          },
          "quantity": {
            "type": "number",
            "minimum": 0,
            "maximum": 1000000,
            "description": "Units"
          },
          "unit": {
            "type": "string",
            "minLength": 0,
            "maxLength": 24,
            "pattern": "^[^\\u0000-\\u001f\\u007f]*$"
          },
          "estimatedCost": {
            "type": "number",
            "minimum": 0,
            "maximum": 1000000000,
            "description": "US dollars"
          },
          "materialCost": {
            "type": "number",
            "minimum": 0,
            "maximum": 1000000000,
            "description": "US dollars"
          },
          "laborCost": {
            "type": "number",
            "minimum": 0,
            "maximum": 1000000000,
            "description": "US dollars"
          },
          "actualCost": {
            "type": "number",
            "minimum": 0,
            "maximum": 1000000000,
            "description": "US dollars"
          },
          "isCompleted": {
            "type": "boolean"
          }
        },
        "required": [
          "category",
          "estimatedCost",
          "materialCost",
          "actualCost",
          "isCompleted"
        ]
      },
      "minItems": 1,
      "maxItems": 100
    },
    "budget": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000,
      "description": "US dollars"
    },
    "contingencyRate": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "description": "Percent; 5 means 5%"
    },
    "contractorSettings": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "markupRate": {
          "type": "number",
          "minimum": 0,
          "maximum": 100,
          "description": "Percent; 5 means 5%"
        },
        "taxRate": {
          "type": "number",
          "minimum": 0,
          "maximum": 100,
          "description": "Percent; 5 means 5%"
        },
        "taxMaterialsOnly": {
          "type": "boolean"
        },
        "discountType": {
          "type": "string",
          "enum": [
            "percent",
            "fixed"
          ]
        },
        "discountAmount": {
          "type": "number",
          "minimum": 0,
          "maximum": 1000000000,
          "description": "Percent or US dollars according to discountType"
        },
        "depositPercent": {
          "type": "number",
          "minimum": 0,
          "maximum": 100,
          "description": "Percent; 5 means 5%"
        },
        "milestones": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "id": {
                "anyOf": [
                  {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 80,
                    "pattern": "^[^\\u0000-\\u001f\\u007f]*$"
                  },
                  {
                    "type": "integer",
                    "minimum": 0,
                    "maximum": 1000000000,
                    "description": "Local item ID"
                  }
                ]
              },
              "name": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80,
                "pattern": "^[^\\u0000-\\u001f\\u007f]*$"
              },
              "percent": {
                "type": "number",
                "minimum": 0,
                "maximum": 100,
                "description": "Percent; 5 means 5%"
              }
            },
            "required": [
              "percent"
            ]
          },
          "minItems": 0,
          "maxItems": 32
        }
      },
      "required": [
        "markupRate",
        "taxRate",
        "taxMaterialsOnly",
        "discountType",
        "discountAmount",
        "depositPercent",
        "milestones"
      ]
    }
  },
  "required": [
    "items",
    "budget",
    "contingencyRate",
    "contractorSettings"
  ]
}

Production endpoint: POST https://calc.hasstechapi.com/v2/calc/renovation-budget-and-quote
Formula: renovation-budget-and-quote-htcalc-719df2c0e105

Method and sources

Project and contractor worksheet with itemized estimates and actuals, markup, discount, materials-tax election and payment schedule. AST slice includes only CATEGORIES and calculateRenovationTotals.

Reviewed .