Skip to main content
POST
Void a posted customer receipt

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.

Headers

Idempotency-Key
string

Client-generated unique key for idempotent POST/PATCH/DELETE operations. Alias for the Idempotency parameter. Max 255 chars. On retry with the same key, the original response is returned without re-executing the operation. Keys expire after 24 hours.

Maximum string length: 255

Path Parameters

id
string<uuid>
required

The order_payments id of the receipt to void.

Body

application/json
reason
string
required

REQUIRED. Why the receipt is being voided. Recorded on the receipt, on every invoice that gets its balance back, and on the reversing journal entry. Omitting it answers 422 void_reason_required.

relief_entry_date
string<date> | null

OPTIONAL explicit date for the reversing entry. Leave it out and the reversal takes the original entry's own date, which is what keeps a reconciled month tied. Whatever date is used must fall in an open period.

Response

The receipt was voided, with the full unwind summary

data
object