Skip to main content
PATCH
Cancel or edit an in-progress reconciliation session

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

id
string<uuid>
required

Reconciliation session UUID.

Body

application/json
status
enum<string>

The only settable status; completion goes through POST /accounting/reconciliations/{id}/complete (Cognito surface).

Available options:
cancelled
opening_balance
number | null
statement_ending_balance
number | null
statement_date
string<date>

YYYY-MM-DD; must fall in an open accounting period.

notes
string | null
Maximum string length: 5000

Response

The updated (or cancelled) session row; cancel responses add matches_reverted + gl_lines_unreconciled counts

data
object