Get a forecast
Authorizations
A workspace API key created in ThinkOut settings. One key reads one workspace.
Path Parameters
Query Parameters
Relations to return as objects instead of ids. Comma-separated. Expansion goes one level deep; an unknown name is rejected with invalid_expand.
category, counterparty, labels, recurrence, linked_transactions Response
The forecast.
"forecast"The day the movement is expected.
Decimal amount as a string with two decimals. Negative means an outflow on transactions, forecasts and report figures.
^-?[0-9]+\.[0-9]{2}$"-1250.00"
The part of amount not yet matched by linked transactions.
^-?[0-9]+\.[0-9]{2}$"-1250.00"
ISO 4217 alphabetic currency code.
^[A-Z]{3}$"RON"
Whether money comes in or goes out. On a transaction or forecast it follows the sign of amount.
inflow, outflow realised is complete. partial has matched transactions. overdue is dated before today with none. planned is dated today or later with none.
planned, overdue, partial, realised A category id, or the full category when named in expand.
A counterparty id, the full counterparty when named in expand, or null when unattributed.
Label ids, or the full labels when labels is named in expand.
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.
Transactions matched to this forecast, as ids, or as transactions when linked_transactions is named in expand.