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 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

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]+)?$
Example:

"-1250.00"

accounts
object[]
required