Forecast programs · StartupBuilder

Reference for Forecast.

Noun	System	Run by
Forecast	Treasury	Treasurer

Forecast.create

Creates a Forecast. Verb page.

Text

do: return await $.Forecast.create(input)

Emits Forecast.created.

Inputs

Input	Type	Required	Description
`asOf`	`datetime`	required	When the inputs were read.
`runwayWeeks`	`number`	required	Weeks until cash reaches zero at the projected rates.
`defaultAlive`	`boolean`	required	True when projected revenue covers projected Cost before cash runs out.
`profitWeek`	`date`		The first week projected revenue covers fully loaded Cost.
`spendState`	`string`	required	The spend state it sets: `free` when default alive, `tight` when default dead, `hold` under 13 weeks of runway.

Returns

Output	Type	Required	Description
`forecast`	Forecast	required	The Forecast.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Forecast.create({ asOf: '2026-10-22T12:00:00Z', runwayWeeks: 1, defaultAlive: true, spendState: 'free' })"
  }
}

Forecast.get

Returns one Forecast by id. Verb page.

Text

do: return await $.Forecast.get(input)

Reads only: it emits no Event.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Forecast.
`at`	`string`		A time or Version name: the record as it stood then. Unset: as it stands now.

Returns

Output	Type	Required	Description
`forecast`	Forecast	required	The Forecast.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Forecast.get({ id: 'forecast_a2kwkwcmRy' })"
  }
}

Forecast.list

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

Text

do: return await $.Forecast.list(input)

Reads only: it emits no Event.

Inputs

Input	Type	Description
`limit`	`integer`	At most this many records, up to 100. The default is 20.
`after`	`string`	The cursor from the previous page.
`where`	`string`	A filter over the properties, such as `paidAt = null and total.amount > 500`.
`sort`	`string`	Properties to sort by, comma-separated; a leading minus sorts descending.
`total`	`boolean`	True adds the match count as `meta.total`, exact up to 10,000 matches and estimated above.
`facets`	`string`	Properties to count by value, comma-separated, returned as `meta.facets`.
`fields`	`string`	Properties to return on each record, comma-separated; `$id` and `$type` always return.
`include`	`string`	Related records to embed in place of their URLs, comma-separated.
`depth`	`integer`	How many levels of related records to embed. The default is 1.
`q`	`string`	Words to match across the text properties, ranked by relevance.
`match`	`string`	Ranks the search by `words`, or `meaning`; words is the default.

Returns

Output	Type	Required	Description
`forecasts`	list of Forecast	required	One page of Forecasts.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Forecast.list({ limit: 20 })"
  }
}

Forecast.createCopy Anchor Link

Forecast.getCopy Anchor Link

Forecast.listCopy Anchor Link

Forecast.create

Forecast.get

Forecast.list