Skip to main content
POST
Void a printed check

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

Body

application/json
void_reason
string

Response

Voided check

A check printed by Arcus (paper AP payment).

id
string<uuid>
object
enum<string>
Available options:
printed_check
entity_id
string<uuid>
read-only
check_number
integer
read-only

Sequential per bank account.

bank_account_id
string<uuid>
vendor_id
string<uuid>
amount
number
memo
string | null
status
enum<string>
read-only
Available options:
printed,
reprinted,
voided,
cleared
printed_at
string<date-time>
read-only
voided_at
string<date-time> | null
read-only
cleared_at
string<date-time> | null
read-only
cleared_source
enum<string> | null
read-only

The EVIDENCE CLASS behind status=cleared. register_only means the payment leg already credited a bank account and no journal entry was posted for the clear, so the row is a register truth and NOT a bank fact. Null on a check cleared before migration 20260915a, when nothing recorded the class.

Available options:
bank_match,
manual_clear,
register_only,
migrated
cleared_bank_transaction_id
string<uuid> | null
read-only

The bank line that paid this check. Written when the clear is driven by a matched bank row; null for a manual clear and for every check cleared before 2026-09-18. When it is null the pairing may still be recorded on the bank side.