Skip to main content
PATCH
Update invoice custom fields

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Invoice ID

Body

application/json
values
object
required

Custom fields to write, keyed by definition id (or, on the public API, by definition key). Only the fields present here are touched; omitted fields keep their current value. Pass null, an empty string or an empty array to clear a field. Select fields take an option id, multi-select fields a list of option ids, checkboxes a boolean.

Example:

Response

200 - application/json
customFieldValues
object
required

Custom field values of the entity, keyed by definition id. Each entry carries the definition key and label alongside the raw value and its human readable display value.

Example: