Skip to main content
Update an invoice

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Idempotency-Key
string

Optional protection for safely retrying a request after a timeout or lost response. Choose a unique value (for example, a UUID) for each action and reuse it with the same input when retrying. Omit it for a normal request.

Required string length: 1 - 200
Pattern: ^[\x21-\x7e]+$

Path Parameters

id
string<uuid>
required

Body

application/json

At most 2 MiB, including all lines.

supplier
object
recipient
object
category
enum<string>
Available options:
invoice,
credit_note,
self_billed_invoice
invoice_number
string
Required string length: 1 - 255
title
string | null
Maximum string length: 2000
issued_date
string
Pattern: ^\d{4}-\d{2}-\d{2}$
due_date
string | null
Pattern: ^\d{4}-\d{2}-\d{2}$
amounts
object
payment
object
delivery
object | null
references
object
review
object

Set confirmed to true when a person has checked the extracted data, or false to clear it.

line_item_changes
object
matched_invoice_ids
string<uuid>[]
Maximum array length: 50

Response

The updated invoice.

id
string<uuid>
required
url
string<uri>
required

The invoice in the Watchdog app.

invoice_number
string | null
required
title
string | null
required
category
enum<string>
required
Available options:
invoice,
credit_note,
self_billed_invoice
issued_date
string<date> | null
required
due_date
string<date> | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
deleted_at
string<date-time> | null
required
supplier
object
required
recipient
object
required
amounts
object
required
review
object
required
read-only
workflows
object
required

Processing that follows import, such as matching and compliance checks. Poll until settled, then read alerts.

alerts
object
required
relationships
object
required
note
string | null
required

The invoice-wide note in its original wording. Null means unavailable; empty text stays empty.

payment
object
required
delivery
object
required
references
object
required
additional_properties
object[] | null
required

Other named details found in the source, with where they were found. Null when not available; empty when none were found.

origin
object
required