Gallery Platform API
Reference

Void an invoice

Voids an invoice. It stays in the history as `void` and no longer counts toward its sale's balance. A void invoice cannot be reopened; voiding one again answers 409.

POST
/gallery/invoices/{id}/void

Voids an invoice. It stays in the history as void and no longer counts toward its sale's balance. A void invoice cannot be reopened; voiding one again answers 409.

Authorization

bearerAuth sales:update, gallery:read
AuthorizationBearer <token>

A gallery API key, sent as Authorization: Bearer gpk_… (or the x-api-key header).

In: header

Scope: sales:update, gallery:read

Path Parameters

id*string

The invoice id.

Query Parameters

dry_run?boolean

Preview this operation without committing it. When true, the request is authenticated, scoped, and validated, but no side effect runs — no write, no idempotency claim, no audit event, no outbound delivery. The response is HTTP 200 with an X-Dry-Run: true header and a body of { "dry_run": true }, plus an effect object describing what the real call would change when this operation can resolve one.

Header Parameters

Idempotency-Key?string

Optional. Send a unique key per logical operation to make retries safe: a retry with the same key replays the stored success for 14 days instead of re-running the write. Reusing a key with a different body returns 400.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Void an invoice.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

{  "id": "string",  "sale_id": "string",  "invoice_number": "string",  "status": "unpaid",  "issued_date": "string",  "due_date": "string",  "subtotal_cents": -9007199254740991,  "discount_cents": -9007199254740991,  "discount_bps": -9007199254740991,  "tax_cents": -9007199254740991,  "shipping_cents": -9007199254740991,  "shipping_tax_cents": -9007199254740991,  "total_cents": -9007199254740991,  "amount_paid_cents": -9007199254740991,  "accepted_payment_methods": [    "card"  ],  "currency": "string",  "fx_as_of": "string",  "fx_usd_per_unit": 0,  "fx_base_currency": "string",  "fx_base_usd_per_unit": 0,  "base_amount_cents": -9007199254740991,  "billing_name": "string",  "billing_address": "string",  "shipping_name": "string",  "shipping_address": "string",  "tax_address_line1": "string",  "tax_address_city": "string",  "tax_address_state": "string",  "tax_address_postal_code": "string",  "tax_address_country": "string",  "tax_calculated_at": "string",  "taxability_override": "none",  "notes": "string",  "archived_at": "string",  "document_preset_id": "string",  "metadata": {    "property1": "string",    "property2": "string"  },  "created_at": "string",  "updated_at": "string"}