Get balances

Every account’s balance and the workspace total, in one call.

Balances are historical only. A balance is the account’s opening balance plus the signed amounts of its transactions up to the end of as_of, so a future as_of is rejected rather than answered with today’s figure wearing a future date. For a forward-looking position, render a cash flow view of type balances, which projects planned movements and reports them separately from actuals.

Conversion here differs from the summaries, deliberately. An account holds one currency, so its whole balance converts at a single rate for as_of, answering what the position is worth then. A transaction summary converts each movement at its own date, answering what each cost at the time.

GET /balances

Get balances

cURL

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

200

{
  "object": "balances",
  "as_of": "2023-12-25",
  "conversion": {
    "applied": true,
    "currency": "RON",
    "basis": "transaction_date"
  },
  "total": "-1250.00",
  "accounts": [
    {
      "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "ING Curent",
      "native_currency": "RON",
      "native_balance": "-1250.00",
      "balance": "-1250.00"
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Query Parameters

as_of · string<date>

Compute balances as of the end of this day. Defaults to today in UTC. A future date is rejected, because a balance is only ever historical.

currency · string

Currency to report totals in. Defaults to the workspace currency. The conversion object on the response says whether conversion happened and on what basis.

ISO 4217 alphabetic currency code.

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

Example:

"RON"

Response

200

application/json

Balances per account and in total.

object · string · required

Allowed value: "balances"

as_of · string<date> · required

The day whose end-of-day position is reported.

conversion · object · required

What was done to make amounts comparable.

Show child attributes

total · string · required

Every account added together, in the requested currency.

Pattern: ^-?[0-9]+(\.[0-9]+)?$

Example:

"-1250.00"

accounts · object[] · required

Show child attributes