Investment · Calculation
Lease-up and vacancy reserve
Projects monthly lease-up with new-lease concessions and first-month proration, reserve required, break-even units and stabilized cash flow. The engine caps schedules at 1,200 months.
This HT Calc screen includes a Pro sample for visitors.
Example result · state: available See output
- Cost per success
- 10 calculation credits
- Production plans
- Standard, Business, Scale, Enterprise
Plan allowances - Free sandbox
- Not available
Integration example
Make a request
Use a production key scoped to investor-lease-up.
Keep the key on your server. A successful call uses 10 calculation credits.
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/investor-lease-up";
const input = {
"totalUnits": 8,
"occupiedUnits": 2,
"targetOccupancyPct": 100,
"monthlyRentPerUnit": 1000,
"fixedMonthlyExpenses": 3000,
"monthlyDebtService": 3000,
"unitsLeasedPerMonth": 2,
"concessionPerNewLease": 200,
"firstMonthProration": 0.5
};
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/investor-lease-up' \
--header "Authorization: Bearer $HT_PRODUCTION_KEY" \
--header 'Content-Type: application/json' \
--header "Idempotency-Key: $request_id" \
--data-binary @- <<'HT_INPUT'
{
"totalUnits": 8,
"occupiedUnits": 2,
"targetOccupancyPct": 100,
"monthlyRentPerUnit": 1000,
"fixedMonthlyExpenses": 3000,
"monthlyDebtService": 3000,
"unitsLeasedPerMonth": 2,
"concessionPerNewLease": 200,
"firstMonthProration": 0.5
}
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
investor-lease-up. 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.
state- available
formulaVersion- lease-up-2.0.0
value.targetOccupiedUnits- 8
How to interpret this result
- Projects monthly lease-up with new-lease concessions and first-month proration, reserve required, break-even units and stabilized cash flow. The engine caps schedules at 1,200 months.
Full example response (JSON)
{
"status": "available",
"result": {
"state": "available",
"fieldErrors": {},
"warnings": [],
"assumptions": [
{
"key": "firstMonthProration",
"value": "0.5",
"unit": "share of first month",
"source": "user"
}
],
"provenance": [
{
"source": "Unit-month lease-up cash ledger",
"asOf": "2026-08-13"
}
],
"formulaVersion": "lease-up-2.0.0",
"ruleVersions": [
"new-lease-first-month-proration-v1",
"zero-pace-not-applicable-v1"
],
"auditTrail": [
"Target occupancy requires 8 occupied unit(s).",
"New leases earned 50% of first-month rent.",
"Accumulated positive monthly shortfalls across 3 month(s)."
],
"value": {
"targetOccupiedUnits": 8,
"unitsNeeded": "6",
"monthsToStabilize": 3,
"firstMonthProration": "0.5",
"reserveRequired": "4800",
"stabilizedRent": "8000",
"stabilizedCashFlow": "2000",
"breakEvenUnits": 6,
"schedule": [
{
"month": 1,
"openingOccupiedUnits": "2",
"newlyLeasedUnits": "2",
"endingOccupiedUnits": "4",
"collectedRent": "3000",
"concessions": "400",
"monthlyShortfall": "3400"
},
{
"month": 2,
"openingOccupiedUnits": "4",
"newlyLeasedUnits": "2",
"endingOccupiedUnits": "6",
"collectedRent": "5000",
"concessions": "400",
"monthlyShortfall": "1400"
},
{
"month": 3,
"openingOccupiedUnits": "6",
"newlyLeasedUnits": "2",
"endingOccupiedUnits": "8",
"collectedRent": "7000",
"concessions": "400",
"monthlyShortfall": "0"
}
]
}
},
"formulaVersion": "lease-up-2.0.0",
"units": {
"totalUnits": "units",
"occupiedUnits": "units",
"targetOccupancyPct": "percent",
"monthlyRentPerUnit": "USD per unit per month",
"fixedMonthlyExpenses": "USD per month",
"monthlyDebtService": "USD per month",
"unitsLeasedPerMonth": "units per month",
"concessionPerNewLease": "USD per newly leased unit",
"firstMonthProration": "fraction (0.5 = half a month)",
"reserveRequired": "USD",
"stabilizedCashFlow": "USD per month"
},
"assumptions": [
"Projects monthly lease-up with new-lease concessions and first-month proration, reserve required, break-even units and stabilized cash flow. The engine caps schedules at 1,200 months."
],
"warnings": [],
"creditCost": 10
}Request contract
Accepted inputs
Fields for this example. Expand the schema for all supported combinations and limits.
FieldType, units and limits
totalUnitsRequiredTotal rentable units at the property, a whole-unit count.
Min 1 · Max 1000000occupiedUnitsRequiredUnits already occupied at the start, a whole-unit count.
Min 0 · Max 1000000targetOccupancyPctRequiredDesired occupied share of all units, in percent. The engine rounds the required unit count up.
Min 0 · Max 100monthlyRentPerUnitRequiredScheduled rent per occupied unit, in USD per month.
Min 0 · Max 1000000000fixedMonthlyExpensesRequiredFixed property expenses before debt service, in USD per month.
Min 0 · Max 1000000000monthlyDebtServiceRequiredDebt payments for the property, in USD per month.
Min 0 · Max 1000000000unitsLeasedPerMonthRequiredModeled absorption pace, in additional units per month.
Min 0 · Max 1000000concessionPerNewLeaseRequiredOne-time move-in concession, in USD per newly leased unit.
Min 0 · Max 1000000000firstMonthProrationOptionalFraction of the first month’s rent collected on new leases (0.5 means half a month). Default 0.5.
Min 0 · Max 1Example request body (JSON)
{
"totalUnits": 8,
"occupiedUnits": 2,
"targetOccupancyPct": 100,
"monthlyRentPerUnit": 1000,
"fixedMonthlyExpenses": 3000,
"monthlyDebtService": 3000,
"unitsLeasedPerMonth": 2,
"concessionPerNewLease": 200,
"firstMonthProration": 0.5
} Full JSON schema
{
"type": "object",
"properties": {
"totalUnits": {
"type": "integer",
"minimum": 1,
"maximum": 1000000,
"description": "Total rentable units at the property, a whole-unit count."
},
"occupiedUnits": {
"type": "integer",
"minimum": 0,
"maximum": 1000000,
"description": "Units already occupied at the start, a whole-unit count."
},
"targetOccupancyPct": {
"type": "number",
"minimum": 0,
"maximum": 100,
"description": "Desired occupied share of all units, in percent. The engine rounds the required unit count up."
},
"monthlyRentPerUnit": {
"type": "number",
"minimum": 0,
"maximum": 1000000000,
"description": "Scheduled rent per occupied unit, in USD per month."
},
"fixedMonthlyExpenses": {
"type": "number",
"minimum": 0,
"maximum": 1000000000,
"description": "Fixed property expenses before debt service, in USD per month."
},
"monthlyDebtService": {
"type": "number",
"minimum": 0,
"maximum": 1000000000,
"description": "Debt payments for the property, in USD per month."
},
"unitsLeasedPerMonth": {
"type": "number",
"minimum": 0,
"maximum": 1000000,
"description": "Modeled absorption pace, in additional units per month."
},
"concessionPerNewLease": {
"type": "number",
"minimum": 0,
"maximum": 1000000000,
"description": "One-time move-in concession, in USD per newly leased unit."
},
"firstMonthProration": {
"type": "number",
"minimum": 0,
"maximum": 1,
"description": "Fraction of the first month’s rent collected on new leases (0.5 means half a month). Default 0.5."
}
},
"required": [
"totalUnits",
"occupiedUnits",
"targetOccupancyPct",
"monthlyRentPerUnit",
"fixedMonthlyExpenses",
"monthlyDebtService",
"unitsLeasedPerMonth",
"concessionPerNewLease"
],
"additionalProperties": false,
"description": "Projects monthly lease-up with new-lease concessions and first-month proration, reserve required, break-even units and stabilized cash flow. The engine caps schedules at 1,200 months."
}Production endpoint: POST https://calc.hasstechapi.com/v2/calc/investor-lease-up
Formula: lease-up-2.0.0