Summarise cash flow

What the cash flow screen shows, decomposed, per period bucket and at most one more dimension. Give period, or both from and to.

Each period has an actual half and a forecast half. The actual half is the transactions dated in the period, counted as /transactions/summary counts them: transfers between the workspace’s own accounts and excluded movements are left out, and split transactions count through their pieces. The forecast half is the remaining amount of the unrealised forecasts dated in the period. A partly matched forecast counts only what is still expected, and its linked transactions count as actuals. inflow, outflow and net add the two halves and equal the screen.

Forecasts dated before today and still unrealised are overdue. They are left out of the rows unless include_overdue=true. totals.overdue_inflow and totals.overdue_outflow always report the remaining amount of the overdue forecasts the rows did not count.

Amounts convert to currency at the rate of each movement’s own date. Buckets are calendar aligned and clipped to the window. totals covers the whole window.

Rows grouped by period alone also carry the period’s starting balance, opened accounts, transfers, excluded movements and final balance. The final balance of a future period is the projected balance. Those five are null when group_by or direction is given.

A bank_id or account_id filter narrows the actual half and the balances, never the forecasts, which have no account and always cover the whole workspace. A bank_id that matches no account returns the empty result: no rows and zero totals. group_by=account is rejected with 400 for the same reason.

Grouped rows are ordered by absolute net, largest first. A period keeps at most 50 groups; the rest fold into one row labelled other. Transactions and forecasts with no counterparty or no label fall in a none row, and one with several labels counts once per label. Here category_id also covers subcategories.

Filters combine with AND; a filter that takes a list combines its values with OR.

Cash flow per month for the next quarter

GET /cash-flow/summary?period=next_quarter&interval=month

Expected inflows per counterparty next month

GET /cash-flow/summary?period=next_month&group_by=counterparty&direction=inflow

GET

cash-flow

summary

Summarise cash flow

curl --request GET \
  --url https://api.thinkout.io/v1/cash-flow/summary \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.thinkout.io/v1/cash-flow/summary', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

using RestSharp;


var options = new RestClientOptions("https://api.thinkout.io/v1/cash-flow/summary");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

{
  "object": "cash_flow_summary",
  "period": {
    "from": "2023-12-25",
    "to": "2023-12-25",
    "macro": "this_month",
    "interval": "month"
  },
  "conversion": {
    "applied": true,
    "currency": "RON",
    "basis": "transaction_date"
  },
  "group_by": "category",
  "bank_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "account_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "forecast_scope": "workspace",
  "include_overdue": true,
  "has_data": true,
  "totals": {
    "currency": "RON",
    "actual_inflow": "-1250.00",
    "actual_outflow": "-1250.00",
    "actual_count": 123,
    "forecast_inflow": "-1250.00",
    "forecast_outflow": "-1250.00",
    "forecast_count": 123,
    "inflow": "-1250.00",
    "outflow": "-1250.00",
    "net": "-1250.00",
    "overdue_inflow": "-1250.00",
    "overdue_outflow": "-1250.00",
    "starting_balance": "-1250.00",
    "opened_accounts": "-1250.00",
    "transfers": "-1250.00",
    "excluded": "-1250.00",
    "final_balance": "-1250.00"
  },
  "data": [
    {
      "period_start": "2023-12-25",
      "period_end": "2023-12-25",
      "group": {
        "dimension": "category",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "label": "Telecom"
      },
      "currency": "RON",
      "actual_inflow": "-1250.00",
      "actual_outflow": "-1250.00",
      "actual_count": 123,
      "forecast_inflow": "-1250.00",
      "forecast_outflow": "-1250.00",
      "forecast_count": 123,
      "inflow": "-1250.00",
      "outflow": "-1250.00",
      "net": "-1250.00",
      "starting_balance": "-1250.00",
      "opened_accounts": "-1250.00",
      "transfers": "-1250.00",
      "excluded": "-1250.00",
      "final_balance": "-1250.00"
    }
  ]
}

{
  "error": {
    "type": "invalid_request",
    "code": "invalid_parameter",
    "message": "direction must be 'inflow' or 'outflow'",
    "param": "direction",
    "request_id": "0HNF8K3QJL2VM:00000001"
  }
}

{
  "error": {
    "type": "authentication",
    "code": "unauthorized",
    "message": "Missing, malformed, unknown or revoked API key",
    "param": null,
    "request_id": "0HNF8K3QJL2VM:00000001"
  }
}

{
  "error": {
    "type": "authentication",
    "code": "forbidden",
    "message": "The API is not included in this company's ThinkOut plan. Contact support@thinkout.io to enable it.",
    "param": null,
    "request_id": "0HNF8K3QJL2VM:00000001"
  }
}

{
  "error": {
    "type": "invalid_request",
    "code": "too_many_groups",
    "message": "Grouping by counterparty over this period produces 1240 groups. The maximum is 1000. Narrow the period or the filters.",
    "param": "group_by",
    "request_id": "0HNF8K3QJL2VM:00000001"
  }
}

{
  "error": {
    "type": "rate_limit",
    "code": "rate_limited",
    "message": "Too many requests",
    "param": null,
    "request_id": "0HNF8K3QJL2VM:00000001"
  }
}

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.

string<date>

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

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 cash flow rows by, alongside the period bucket. There is no account, because forecasts have none.

Available options:

category,

counterparty,

label,

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

include_overdue

boolean

default:false

Whether overdue forecasts, those dated before today and still unrealised, count in the rows of the periods they fall in. Off, they only appear in totals.overdue_inflow and totals.overdue_outflow.

Response

The summary.

object

string

required

Allowed value: "cash_flow_summary"

period

object

required

The window actually computed.

Show child attributes

conversion

object

required

What was done to make amounts comparable.

Show child attributes

group_by

enum<string> | null

required

A dimension to group cash flow rows by, alongside the period bucket. There is no account, because forecasts have none.

Available options:

category,

counterparty,

label,

activity,

direction

bank_ids

string<uuid>[]

required

The bank_id filter echoed, empty when none was given.

account_ids

string<uuid>[]

required

The account_id filter echoed, empty when none was given.

forecast_scope

string

required

What the forecast half and the overdue totals cover. Always the whole workspace: a forecast has no account, so bank_ids and account_ids narrow only the actual half and the balances.

Allowed value: "workspace"

include_overdue

boolean

required

Whether overdue forecasts counted in the rows, as requested.

has_data

boolean

required

false when no transaction and no forecast matched.

totals

object

required

The whole window added up, over the same transactions and forecasts as the rows.

Show child attributes

data

object[]

required

Show child attributes

Summarise cash flow

curl --request GET \
  --url https://api.thinkout.io/v1/cash-flow/summary \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.thinkout.io/v1/cash-flow/summary', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

using RestSharp;


var options = new RestClientOptions("https://api.thinkout.io/v1/cash-flow/summary");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

{
  "object": "cash_flow_summary",
  "period": {
    "from": "2023-12-25",
    "to": "2023-12-25",
    "macro": "this_month",
    "interval": "month"
  },
  "conversion": {
    "applied": true,
    "currency": "RON",
    "basis": "transaction_date"
  },
  "group_by": "category",
  "bank_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "account_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "forecast_scope": "workspace",
  "include_overdue": true,
  "has_data": true,
  "totals": {
    "currency": "RON",
    "actual_inflow": "-1250.00",
    "actual_outflow": "-1250.00",
    "actual_count": 123,
    "forecast_inflow": "-1250.00",
    "forecast_outflow": "-1250.00",
    "forecast_count": 123,
    "inflow": "-1250.00",
    "outflow": "-1250.00",
    "net": "-1250.00",
    "overdue_inflow": "-1250.00",
    "overdue_outflow": "-1250.00",
    "starting_balance": "-1250.00",
    "opened_accounts": "-1250.00",
    "transfers": "-1250.00",
    "excluded": "-1250.00",
    "final_balance": "-1250.00"
  },
  "data": [
    {
      "period_start": "2023-12-25",
      "period_end": "2023-12-25",
      "group": {
        "dimension": "category",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "label": "Telecom"
      },
      "currency": "RON",
      "actual_inflow": "-1250.00",
      "actual_outflow": "-1250.00",
      "actual_count": 123,
      "forecast_inflow": "-1250.00",
      "forecast_outflow": "-1250.00",
      "forecast_count": 123,
      "inflow": "-1250.00",
      "outflow": "-1250.00",
      "net": "-1250.00",
      "starting_balance": "-1250.00",
      "opened_accounts": "-1250.00",
      "transfers": "-1250.00",
      "excluded": "-1250.00",
      "final_balance": "-1250.00"
    }
  ]
}

{
  "error": {
    "type": "invalid_request",
    "code": "invalid_parameter",
    "message": "direction must be 'inflow' or 'outflow'",
    "param": "direction",
    "request_id": "0HNF8K3QJL2VM:00000001"
  }
}

{
  "error": {
    "type": "authentication",
    "code": "unauthorized",
    "message": "Missing, malformed, unknown or revoked API key",
    "param": null,
    "request_id": "0HNF8K3QJL2VM:00000001"
  }
}

{
  "error": {
    "type": "authentication",
    "code": "forbidden",
    "message": "The API is not included in this company's ThinkOut plan. Contact support@thinkout.io to enable it.",
    "param": null,
    "request_id": "0HNF8K3QJL2VM:00000001"
  }
}

{
  "error": {
    "type": "invalid_request",
    "code": "too_many_groups",
    "message": "Grouping by counterparty over this period produces 1240 groups. The maximum is 1000. Narrow the period or the filters.",
    "param": "group_by",
    "request_id": "0HNF8K3QJL2VM:00000001"
  }
}

{
  "error": {
    "type": "rate_limit",
    "code": "rate_limited",
    "message": "Too many requests",
    "param": null,
    "request_id": "0HNF8K3QJL2VM:00000001"
  }
}

Getting started

MCP

REST API

API reference

Summarise cash flow

Authorizations

Query Parameters

Response