Skip to main content
PUT
Update open invoice

Authorizations

X-Auth-Token
string
header
required

Authentication token for API access

Path Parameters

clientId
string
required
invoiceId
string
required

Body

application/json

Request DTO for updating an open invoice (e.g. tags, due date, reference). Only open invoices can be updated.

tags
object[] | null

Tags (same as client/contact tags). When provided, replaces the invoice's tags.

dueDate
string | null

Due date (YYYY-MM-DD). When provided, updates the invoice due date.

invoiceNumber
string | null

Invoice number. When provided, updates the invoice number.

reference
string | null

Reference (e.g. PO number). When provided, updates the invoice reference.

currencyCode
string | null

Currency code (e.g. GBP, USD). When provided, updates the invoice currency.

lineAmountTypes
string | null

Line amount type (e.g. Exclusive, Inclusive). When provided, updates the invoice line amount type.

invoiceType
enum<string> | null

Invoice type (e.g. Sales, Purchase). When provided, updates the invoice type.

Available options:
Sales,
Purchase

Response

OK

Billing's response envelope: the platform's (message.text + message.token, content.data + content.metadata, validationIssues) plus the fields billing sent before it (PRODLAUNCH-416). Those are deprecated, removed on 31 December 2026, and are projections of their replacements so the two cannot disagree.

message
object
required

What happened, as English text and a stable snake_case token to translate from.

content
object
validationIssues
object[] | null
errors
object[] | null
deprecated
read-only

Deprecated: the same issues as validationIssues (reasonText is reason, reasonId is reasonToken, reasonParameters is reasonTokenArguments). Read validationIssues; this will be removed.

metadata
object
deprecated

Deprecated: the same values as content.metadata. Read that; this will be removed.