Get the next check number for this entity (optionally per bank account)
Returns the next available check number without reserving it. Use this to display the
expected check number to the user before they initiate a check run. The actual next number
is reserved and incremented when POST /ap-payments or POST /printed-checks/batch-print
is called.
Pass the optional bank_account_id query parameter to peek a specific bank account’s own
check sequence (per-bank numbering). When the bank has its own configured starting number
the response returns that bank’s next number with per_bank_override: true; otherwise the
entity-global sequence is returned. Requires purchasing:read scope.
Authorizations
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
Optional bank account UUID. When set and that bank has its own check counter, returns the bank's own next number and per_bank_override: true.
Response
Next check number

