Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APIFinance

Forecast routes

Every Forecast Verb as an api.sb route, with its inputs, result, refusals and an example.

Reference for Forecast.

NounSystemRun by
ForecastTreasuryTreasurer

Forecast.create

Creates a Forecast. Verb page.

Text
POST /{namespace}/forecasts

Body, as JSON: the inputs. Emits Forecast.created.

Inputs

InputTypeRequiredDescription
asOfdatetimerequiredWhen the inputs were read.
runwayWeeksnumberrequiredWeeks until cash reaches zero at the projected rates.
defaultAlivebooleanrequiredTrue when projected revenue covers projected Cost before cash runs out.
profitWeekdateThe first week projected revenue covers fully loaded Cost.
spendStatestringrequiredThe spend state it sets: free when default alive, tight when default dead, hold under 13 weeks of runway.

Returns

OutputTypeRequiredDescription
forecastForecastrequiredThe Forecast.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/forecasts \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"asOf":"2026-10-22T12:00:00Z","runwayWeeks":1,"defaultAlive":true,"spendState":"free"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "forecast": {
    "$id": "https://api.sb/leaseline.app/forecasts/forecast_a2kwkwcmRy",
    "$type": "Forecast",
    "asOf": "2026-10-22T12:00:00Z",
    "runwayWeeks": 1,
    "defaultAlive": true,
    "spendState": "free"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Forecast.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Forecast.get

Returns one Forecast by id. Verb page.

Text
GET /{namespace}/forecasts/{id}

Path: id. Query: the other inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Forecast.
atstringA time or Version name: the record as it stood then. Unset: as it stands now.

Returns

OutputTypeRequiredDescription
forecastForecastrequiredThe Forecast.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl https://api.sb/leaseline.app/forecasts/forecast_a2kwkwcmRy \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Forecast",
  "$id": "https://api.sb/leaseline.app/forecasts/forecast_a2kwkwcmRy",
  "forecast": {
    "$id": "https://api.sb/leaseline.app/forecasts/forecast_a2kwkwcmRy",
    "$type": "Forecast",
    "asOf": "2026-10-22T12:00:00Z",
    "runwayWeeks": 1,
    "defaultAlive": true,
    "spendState": "free"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/forecasts/forecast_a2kwkwcmRy",
    "up": "https://api.sb/leaseline.app/forecasts"
  }
}

Forecast.list

Returns Forecasts, newest first, one page at a time. Verb page.

Text
GET /{namespace}/forecasts

Query: the inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
limitintegerAt most this many records, up to 100. The default is 20.
afterstringThe cursor from the previous page.
wherestringA filter over the properties, such as paidAt = null and total.amount > 500.
sortstringProperties to sort by, comma-separated; a leading minus sorts descending.
totalbooleanTrue adds the match count as meta.total, exact up to 10,000 matches and estimated above.
facetsstringProperties to count by value, comma-separated, returned as meta.facets.
fieldsstringProperties to return on each record, comma-separated; $id and $type always return.
includestringRelated records to embed in place of their URLs, comma-separated.
depthintegerHow many levels of related records to embed. The default is 1.
qstringWords to match across the text properties, ranked by relevance.
matchstringRanks the search by words, or meaning; words is the default.

Returns

OutputTypeRequiredDescription
forecastslist of ForecastrequiredOne page of Forecasts.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl "https://api.sb/leaseline.app/forecasts?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Forecast",
  "forecasts": [
    {
      "$id": "https://api.sb/leaseline.app/forecasts/forecast_a2kwkwcmRy",
      "$type": "Forecast",
      "asOf": "2026-10-22T12:00:00Z",
      "runwayWeeks": 1,
      "defaultAlive": true,
      "spendState": "free"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "forecast_a2kwkwcmRy"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/forecasts?limit=20",
    "next": "https://api.sb/leaseline.app/forecasts?after=forecast_a2kwkwcmRy"
  }
}

check

Previous

Holder

Next