Skip to main content
GET
Get balances

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 at the end of this day. Defaults to today: the UTC day on /accounts/{id}, the workspace's local day on /balances. A future date is rejected with as_of_in_future.

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"

Response

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.

total
string
required

Every account added together, in the requested currency.

Pattern: ^-?[0-9]+\.[0-9]{2}$
Example:

"-1250.00"

accounts
object[]
required