Skip to main content
GET
Summarise budgets

Authorizations

Authorization
string
header
required

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

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. Required with to unless period is given.

to
string<date>

Last day of the window, inclusive. Required with from unless period is given.

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 direction per period.

Available options:
category
currency
string

Currency to report in. Defaults to the workspace currency. An unknown code is rejected. ISO 4217 alphabetic currency code.

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

"RON"

category_id
string<uuid>[]

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

direction
enum<string>

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

Available options:
inflow,
outflow

Response

The summary.

object
string
required
Allowed value: "budgets_summary"
period
object
required

The window actually computed, widened to whole months.

conversion
object
required

What was done to make amounts comparable.

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

false when nothing is budgeted, has moved or is expected in the window, as opposed to figures that came to zero.

totals
object
required

The planning tab's Total column for each direction, over the whole window and the same categories as the rows.

data
object[]
required
balances
object[]
required

The planning tab's final balance row, one entry per month. Empty with interval=total, group_by, category_id or direction.