Skip to main content
GET
Match deposit tickets to one bank's lines for a month

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.

Query Parameters

account
string<uuid>
required
month
string
required
Pattern: ^\d{4}-(0[1-9]|1[0-2])$

Response

The month's bank match of deposit tickets

bank_account_id
string<uuid>
bank_account_name
string
bank_account
object

has_feed, feed_sentence, the GL account

month
string
as_of
string<date>
window_days
integer
ready
object

{ count, total, rows }: exact (ticket, line) pairs; a tie is one row per ticket with tie_count

near
object

{ count, total, rows }: pairs inside the near band, each with bank_line and the signed amount_delta

bank_only
object

{ count, total, rows }: inbound unclaimed lines no ticket pairs

arcus_only
object

{ count, total, rows }: tickets no line pairs; window_closed, bank_line_linked_to_receipt

in_transit
object

{ count, total, rows }: tickets whose current entry's bank leg is uncleared at the month end

matched
object

{ count, total }

undeposited
object

{ checks, drawer_cash }, each { count, total, rows }, entity-wide

tie_out
object | null

open_items, gl_side, bank_side, ties (boolean), ties_detail