API Documentation

Delete a draft invoice (soft)

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

Discards a draft before it is committed — sets lifecycle: deleted. The record is retained and still returned by GET /v1/invoices/{invoiceId} (and by list with lifecycle=deleted); it is not destroyed.

Drafts only: refused with 409 precondition_failed if the invoice has already been issued (void an issued invoice instead). 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