Skip to main content
GET
The bank's balance on a date, with its basis named

Authorizations

Authorization
string
header
required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.

Path Parameters

entity_id
string<uuid>
required

Query Parameters

bank_account_id
string<uuid>
required
as_of
string<date>

YYYY-MM-DD. Defaults to today.

Response

The bank's balance on that date, under both readings

object
enum<string>
Available options:
reconciliation_bank_balance_as_of
entity_id
string<uuid>
as_of
string<date>
basis
enum<string>
Available options:
anchored,
bank_current,
none
balance_state
enum<string>
Available options:
verified,
computed,
bank_current,
none
anchor_date
string<date> | null
verified_through
string<date> | null
period_gap_count
integer
account_kind
enum<string>
Available options:
asset,
liability
balance_label
string
balance_if_pending_excluded
number<double> | null
balance_if_pending_included
number<double> | null
pending_after_count
integer
pending_after_amount
number<double>
bases_agree
boolean
bank_stated_balance
number<double> | null
bank_stated_as_of
string<date-time> | null
bank_stated_reason
string | null
bank_stated_pending_treatment
string