Skip to main content
PATCH
/
invoices
/
{id}
Update invoice metadata or status
curl --request PATCH \
  --url https://api.antei.com/invoices/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata": {},
  "internal_notes": "<string>",
  "status": "draft"
}
'
{
  "invoice_number": "<string>",
  "status": "draft",
  "contact_id": "<string>",
  "currency": "<string>",
  "amount": 123,
  "id": "<string>",
  "transaction_ids": [
    "<string>"
  ],
  "issue_date": "2023-12-25",
  "due_date": "2023-12-25",
  "metadata": {}
}
This endpoint allows partial updates to an invoice. Common fields that can be updated:
  • status (e.g., to mark as paid or void)
  • metadata or internal tags
  • due_date
⚠️ You cannot update financial fields like line items or tax amounts after creation. For corrections, use credit notes or cancel-and-recreate strategy.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Body

application/json
​
metadata
object
​
internal_notes
string
​
status
enum<string>
Available options:
draft,
sent,
paid,
void

Response

200 - application/json

Invoice updated

​
invoice_number
string
required
​
status
enum<string>
required
Available options:
draft,
sent,
paid,
void
​
contact_id
string
required
​
currency
string
required
​
amount
number<float>
required
​
id
string
​
transaction_ids
string[]
​
issue_date
string<date>
​
due_date
string<date>
​
metadata
object