Update invoice status

PATCH https://app.speybooks.com/api/v1/invoices/{id}/status

Transitions an invoice to a new status. Not all transitions are valid — the API enforces a state machine.

Valid transitions:

  • draftsent, cancelled
  • sentpaid, partial, overdue, cancelled, written_off
  • partialpaid, overdue, cancelled, written_off
  • overduepaid, partial, cancelled, written_off

Terminal states (paid, cancelled, written_off) cannot be transitioned further.

For payment-driven transitions, use the Record Payment endpoint instead — it automatically sets the status to paid or partial based on the cumulative amount.

Path parameters

id string required

Body parameters

status string required
draftsentpaidpartialoverduecancelledwritten_off

Response

200 Default Response
Show response fields
status string

Error codes

400 Default Response
404 Invoice not found.