Skip to main content
GET
The reconciliation audit of one bank account, with the door for each finding

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.

month_ends
integer

How many month ends before as_of to test, 1 to 36.

Required range: 1 <= x <= 36
since
string<date>

YYYY-MM-DD. Limits the clearing and error-class answers to activity on or after this day.

pairing_window_days
integer

How many days apart an unpaired bank row and an unpaired book line of the same amount may be and still be offered as a pair.

error_window_days
integer

How many days apart two same-amount vendor payments may be and still be reported as a possible double payment.

row_limit
integer

The most rows any one list returns. Each list still publishes its unbounded total.

Response

The audit of that bank account

object
enum<string>
Available options:
reconciliation_account_audit
entity_id
string<uuid>
bank_account
object

The account audited, its mapped general ledger account and the bank's last persisted balance.

as_of
string<date>
month_ends
string<date>[]
since
string<date> | null
method
object

The audit method's steps, and which of them this read answers.

answers
object

The five answers, each with its own figures, rows and findings.

findings
object[]
finding_count
integer
blocking_count
integer
next_step
string
writes_nothing
boolean