Skip to main content
GET
Summarise a scenario

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

period
enum<string>

A named window, resolved against the workspace's local day and echoed in the response. Takes precedence over from and to. A named window resolved on the server. last_30_days and last_90_days end today and include it; last_12_months starts the day after today minus twelve months. next_month, next_quarter and next_year cover the whole next calendar month, quarter or year.

Available options:
this_month,
last_month,
this_quarter,
last_quarter,
this_year,
last_year,
month_to_date,
quarter_to_date,
year_to_date,
last_30_days,
last_90_days,
last_12_months,
next_month,
next_quarter,
next_year
from
string<date>

First day of the window, inclusive. Give it with to. Leave out period, from and to for the default window.

to
string<date>

Last day of the window, inclusive. Give it with from. Leave out period, from and to for the default window.

interval
enum<string>
default:month

The period rows are grouped into. month for each calendar month, total for the whole window as one period. A period bucket for budget and scenario rows, which are monthly. total reports the whole window as one period, as the budgets screen's Total column does.

Available options:
month,
total
group_by
enum<string>

category for one row per category per period. Omit it for one row per period.

Available options:
category
category_id
string<uuid>[]

Only these categories and the categories nested under them. Comma-separated for several.

Response

The scenario's tab.

object
string
required
Allowed value: "scenario_summary"
scenario
object
required

The scenario reported.

period
object
required

The window actually computed, widened to whole months.

currency
string
required

The workspace currency. Scenario amounts are never converted.

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

"RON"

group_by
enum<string> | null
required
Available options:
category,
null
has_data
boolean
required

false when totals.inflow, totals.outflow and totals.final_balance are all zero or absent.

totals
object
required

One period of a scenario's tab, or its whole window in totals. Outflows are negative.

data
object[]
required

One ScenarioPeriod per period without group_by. One ScenarioCategoryRow per category per period with group_by=category.

One period of a scenario's tab, or its whole window in totals. Outflows are negative.