Skip to main content
GET
Summarise transactions

Authorizations

Authorization
string
header
required

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

Query Parameters

from
string<date>
required

First day of the window, inclusive.

to
string<date>
required

Last day of the window, inclusive.

interval
enum<string>
default:month

The period bucket rows are grouped into. A period bucket for report rows.

Available options:
day,
week,
month
group_by
enum<string>

A second dimension to group by, alongside the period bucket. Omit it for one row per period. A dimension to group report rows by, alongside the period bucket.

Available options:
category,
counterparty,
label,
account,
activity,
direction
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"

bank_id
string<uuid>[]

Only rows on the accounts fed by these bank connections. Comma-separated for several.

account_id
string<uuid>[]

Only rows on these accounts. Comma-separated for several.

category_id
string<uuid>[]

Only rows in these categories. Comma-separated for several. On /transactions this also matches a split transaction whose pieces are in one of them. Subcategories are included only on the summaries.

label_id
string<uuid>[]

Only rows carrying at least one of these labels. Comma-separated for several.

counterparty_id
string<uuid>[]

Only rows attributed to these counterparties. 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
activity
enum<string>[]

Only rows whose category sits in these cash flow statement sections. Comma-separated for several.

Cash flow statement section the category belongs to.

Available options:
operating,
investing,
financing

Response

The summary.

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

The window actually computed.

conversion
object
required

What was done to make amounts comparable.

group_by
enum<string> | null
required

A dimension to group report rows by, alongside the period bucket.

Available options:
category,
counterparty,
label,
account,
activity,
direction
has_data
boolean
required

false when no transaction matched, as opposed to totals that came to zero.

totals
object
required

The whole window added up, after the same exclusions as the rows.

data
object[]
required