Skip to main content
GET
Get a forecast

Authorizations

Authorization
string
header
required

A workspace API key created in ThinkOut settings. One key reads one workspace.

Path Parameters

id
string<uuid>
required

Query Parameters

expand
enum<string>[]

Relations to return as objects instead of ids. Comma-separated. Expansion goes one level deep; an unknown name is rejected with invalid_expand.

Available options:
category,
counterparty,
labels,
recurrence,
linked_transactions

Response

The forecast.

object
string
required
Allowed value: "forecast"
id
string<uuid>
required
date
string<date>
required

The day the movement is expected.

amount
string
required

Decimal amount as a string with two decimals. Negative means an outflow on transactions, forecasts and report figures.

Pattern: ^-?[0-9]+\.[0-9]{2}$
Example:

"-1250.00"

remaining_amount
string
required

The part of amount not yet matched by linked transactions.

Pattern: ^-?[0-9]+\.[0-9]{2}$
Example:

"-1250.00"

currency
string
required

ISO 4217 alphabetic currency code.

Pattern: ^[A-Z]{3}$
Example:

"RON"

direction
enum<string>
required

Whether money comes in or goes out. On a transaction or forecast it follows the sign of amount.

Available options:
inflow,
outflow
status
enum<string>
required

realised is complete. partial has matched transactions. overdue is dated before today with none. planned is dated today or later with none.

Available options:
planned,
overdue,
partial,
realised
description
string | null
required
comment
string | null
required
category
required

A category id, or the full category when named in expand.

counterparty
required

A counterparty id, the full counterparty when named in expand, or null when unattributed.

labels
(string<uuid> | object)[]
required

Label ids, or the full labels when labels is named in expand.

recurrence
required

The id of the recurring plan the forecast was generated from, the full plan when named in expand, or null for a one-off forecast.

linked_transactions
(string<uuid> | object)[]
required

Transactions matched to this forecast, as ids, or as transactions when linked_transactions is named in expand.

created_at
string<date-time>
required
updated_at
string<date-time>
required