Sync an invoice to external sync points

Explicitly (re)triggers convergence of this invoice to its external sync points (e.g. ERP, on-chain). Valid only once the invoice is issued (drafts are never synced); otherwise 409 precondition_failed.

Sync is eventual and per-target — a 200 here means the sync was accepted, not that any target has converged. The outcome is not represented on the invoice resource; observe it via events / the integration log. Whether sync runs automatically after :share is an account-level setting, not a per-request flag. 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

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