Skip to main content
PATCH
/
api
/
v1
/
invoices
/
{id}
Update an invoice (partial)
curl --request PATCH \
  --url https://integrations.polinate.ai/api/v1/invoices/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --header 'X-Business-Id: <x-business-id>' \
  --data '
{
  "status": "PAID",
  "reference": "PO-123",
  "notes": "Thanks!"
}
'
{
  "id": "inv_123",
  "status": "PAID"
}

Headers

​
X-Business-Id
string
required

Business identifier for external auth. Find in Polinate app → Business Settings → Integrations.

Example:

"{{businessId}}"

​
X-API-Key
string
required

Per-business API key for external auth. Find in Polinate app → Business Settings → Integrations.

Example:

"{{apiKey}}"

​
Idempotency-Key
string

Idempotency key for POST operations

Example:

"{{idempotencyKey}}"

Path Parameters

​
id
string
required
Example:

"inv_123"

Body

application/json
​
status
string
​
reference
string | null
​
notes
string | null
​
properties
object

Response

OK

​
id
string
required
​
status
enum<string>
Available options:
DELETED,
DRAFT,
AUTHORISED,
PARTIALLY_PAID,
PAID,
OVERPAID,
OVERDUE,
VOIDED,
DEFAULTED,
CREDITED,
REFUNDED
​
reference
string
​
notes
string
​
createdAt
string
​
updatedAt
string
​
properties
object
​
invoiceLineItems
object[]