Update invoice

Update invoice in the credential-bound company. Send an optional Idempotency-Key to store the terminal response for safe retries for 24 hours. When supplied, If-Match must contain the latest ETag; stale versions return 412. Depending on the requested state, this may update a draft or post accounting effects. Requires the invoices:write OAuth scope. A foreign-currency document whose ECB exchange rate cannot be read in time is refused with 503 exchange_rate_unavailable (error.fields.currency and error.fields.date name the lookup, error.retryable is true) and a Retry-After: 30 header; nothing is written, so retry the same request, with the same Idempotency-Key, after that many seconds.

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

Fields accepted to update invoice. The schema identifies required and optional values.

uuid

A customer owned by an integration is refused.

date
uuid
string
enum
Allowed:
date | null
date | null
string | null
string | null
string | null
uuid | null
uuid | null

Ships from; the main warehouse when empty.

date | null
date | null
string | null
enum
Allowed:
boolean | null
boolean | null
integer | null
≥ 0
number | null
0 to 100
exchange_rate
object
line_items
array of objects
length ≥ 1
line_items
Headers
string
length ≤ 191

Optional unique key whose request hash and terminal response are stored durably for 24 hours.

string

Optional. ETag from the latest representation; a stale value returns 412 precondition_failed. Send this header, not the standard If-Match: some HTTP intermediaries evaluate a standard If-Match themselves and can answer 412 even though the change was applied. Never send both; both with different ETags returns 400 conflicting_precondition_headers.

string
deprecated

Accepted with the same value and meaning as Cybooks-If-Match, but do not send it: an intermediary can answer 412 to it after the change was applied. Send Cybooks-If-Match instead.

Responses

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