Financials pillar · v0.16.0
cash-forecast CashForecast
Cash forecast record per BDR 0068 §2.
$id · https://corpospec.com/schemas/v0.16.0/cash-forecast.schema.json
Fields
| Field | Type | Required | Description |
|---|---|---|---|
| as_of | IsoDate | yes | ISO 8601 date (YYYY-MM-DD). |
| assumptions | ForecastAssumption[] | yes | |
| content_hash | string | yes | |
| currency | IsoCurrency | yes | ISO 4217 currency code. |
| entity | PathRef | yes | Path-based cross-reference relative to .corpospec/ root. Pattern: `^[a-z0-9_-]+(/[a-z0-9_.-]+)+$` |
| granularity | Granularity | yes | Granularity of period cells within the forecast. |
| horizon | ForecastHorizon | yes | Forecast horizon. |
| id | PathRef | yes | Path-based cross-reference relative to .corpospec/ root. Pattern: `^[a-z0-9_-]+(/[a-z0-9_.-]+)+$` |
| periods | ForecastPeriod[] | yes | |
| confidence_interval | ConfidenceBand? | — | |
| minimum_cash_breach_date | IsoDate? | — | |
| runway_months | number? | — | |
| scenarios | ForecastScenario[] | — | |
| source_position_ref | PathRef? | — | PathRef into the CashPosition that anchored the forecast. |
| superseded_by | PathRef? | — | PathRef into the successor forecast (forecasts are versioned). |
Definitions
Shared types referenced within this schema.
CashFlowCategory
Cash-flow categorisation per BDR 0068 §2.
CashFlowLine
One forecasted cash-flow line within a period.
type: object
Confidence
Driver / assumption confidence.
ConfidenceBand
Confidence band on the forecast envelope (e.g. 80% confidence).
type: object
ForecastAssumption
One named driver / assumption underlying the forecast.
type: object
ForecastHorizon
Forecast horizon.
ForecastPeriod
One period cell within the forecast horizon.
type: object
ForecastScenario
Forecast scenario (base / downside / upside / custom).
type: object
Granularity
Granularity of period cells within the forecast.
enum: "daily", "weekly", "monthly"
IsoCurrency
ISO 4217 currency code.
pattern: ^[A-Z]{3}$
IsoDate
ISO 8601 date (YYYY-MM-DD).
type: string
PathRef
Path-based cross-reference relative to .corpospec/ root.
Pattern: `^[a-z0-9_-]+(/[a-z0-9_.-]+)+$`
pattern: ^[a-z0-9_-]+(/[a-z0-9_.-]+)+$
Reference in your YAML
# yaml-language-server: $schema=https://corpospec.com/schemas/v0.16.0/cash-forecast.schema.json