Perform Action on Invoice
Once an invoice is booked you act on it
through PUT /invoices/<id>/actions/<action>. Each action needs its own right
and most require the invoice to be in an open status (ACTIVATED, PAUSED, or
DISPUTED). Example - pause an invoice until a date:
curl -X PUT "https://$HOST/invoices/$INVOICE_ID/actions/pause" \ -H "Authorization: Bearer $JWT" -H "Content-Type: application/json" \ -d '{ "pausedUntilDate": "2026-09-01" }'Common actions
Section titled “Common actions”| Action | Endpoint | Right | What it does |
|---|---|---|---|
| Pause | PUT /invoices/<id>/actions/pause | PauseInvoices | Suspend collection until a date (or forever) |
| Resume | PUT /invoices/<id>/actions/resume | ResumeInvoices | Resume a paused or disputed invoice |
| Stop | PUT /invoices/<id>/actions/stop | StopInvoices | Stop collection permanently |
| Register payment | PUT /invoices/<id>/actions/payment | RegisterPaymentOnInvoices | Record a payment against the invoice |
| Direct payment | PUT /invoices/<id>/actions/direct-payment | RegisterDirectPaymentOnInvoices | Record a payment received outside the system |
| Credit | PUT /invoices/<id>/actions/credit | CreditInvoices | Issue a credit invoice for the amount |
| Write off reminder | PUT /invoices/<id>/actions/writeoff-reminder | WriteOffReminderOnInvoices | Write off reminder/interest charges |
| Write off capital | PUT /invoices/<id>/actions/writeoff-capital | WriteOffCapitalOnInvoices | Write off principal |
| Dispute | PUT /invoices/<id>/actions/dispute | DisputeInvoices | Mark the invoice disputed |
| Send | PUT /invoices/<id>/actions/send | SendInvoices | (Re)send the invoice to the debtor |
| Recourse | PUT /invoices/<id>/actions/recourse | RecourseOnInvoices | Reverse financing on a factored invoice |
| Archive | PUT /invoices/<id>/archive/add | AddToArchiveInvoices | Move the invoice to the archive |
Payment-posting and write-off actions take amount and chargeReminder /
chargeInterest / bookkeep flags; see the body schema in the
API reference. Bulk variants exist under
PUT /invoices/actions/bulk-update.