Skip to main content
PATCH
Update an invoice

Authorizations

Authorization
string
header
required

Bearer authentication using your BookingShake API key. Retrieve your API key from Settings > Integrations in your BookingShake dashboard.

Path Parameters

id
string
required

Invoice document ID (the id field carried by the invoice.created webhook).

Body

application/json

The only writable part of an issued invoice. The legal invoice (amounts, lines, snapshots) is immutable; sending any field other than metadata returns 422.

metadata
object
required

Free-form integration key/value pairs. Merged per key into the existing metadata; pass null as a value to delete that key. Up to 50 keys per invoice, key ≤ 40 chars, value ≤ 500 chars.

Example:

Response

Invoice metadata updated successfully. Returns the full invoice in its post-update state.

message
string
Example:

"success"

data
object

An issued invoice. Identical to the data block of the invoice.created webhook. All amounts are integer cents; dates are YYYY-MM-DD strings in the Europe/Paris timezone; missing values are explicit null.