API Documentation

Void an invoice

post
https://api.bitwave.io/v1/invoices/:void

Cancels a committed invoice but keeps it on record (including its number) for audit — sets lifecycle: voided and propagates a retraction to any sync points. This is the correction path for an issued invoice: void, then issue a replacement.

Preconditions (otherwise 409 precondition_failed): the invoice must be issued (a draft is removed with :delete, not voided) and settlement: unpaid — reverse payments or issue a credit note before voiding a partially/fully paid invoice. Send the current version; a stale value is refused with 409 version_mismatch.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The invoice id.

Body Params

Body for a version-only lifecycle command (:issue / :sync / :void / :delete). Carries the version you last read via GET; a stale value is refused with 409 version_mismatch and nothing changes.

int64
required
≥ 0

The invoice version you last read (via GET).

Headers
string
length ≤ 255

Optional idempotency key (a UUID is ideal). Retrying a command with the same key applies the action at most once and returns the original result, so a network retry can't double-apply. Complements version (which guards concurrent writes).

Responses

Updated about 1 hour ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 hour ago