Skip to content

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:

Terminal window
curl -X PUT "https://$HOST/invoices/$INVOICE_ID/actions/pause" \
-H "Authorization: Bearer $JWT" -H "Content-Type: application/json" \
-d '{ "pausedUntilDate": "2026-09-01" }'
ActionEndpointRightWhat it does
PausePUT /invoices/<id>/actions/pausePauseInvoicesSuspend collection until a date (or forever)
ResumePUT /invoices/<id>/actions/resumeResumeInvoicesResume a paused or disputed invoice
StopPUT /invoices/<id>/actions/stopStopInvoicesStop collection permanently
Register paymentPUT /invoices/<id>/actions/paymentRegisterPaymentOnInvoicesRecord a payment against the invoice
Direct paymentPUT /invoices/<id>/actions/direct-paymentRegisterDirectPaymentOnInvoicesRecord a payment received outside the system
CreditPUT /invoices/<id>/actions/creditCreditInvoicesIssue a credit invoice for the amount
Write off reminderPUT /invoices/<id>/actions/writeoff-reminderWriteOffReminderOnInvoicesWrite off reminder/interest charges
Write off capitalPUT /invoices/<id>/actions/writeoff-capitalWriteOffCapitalOnInvoicesWrite off principal
DisputePUT /invoices/<id>/actions/disputeDisputeInvoicesMark the invoice disputed
SendPUT /invoices/<id>/actions/sendSendInvoices(Re)send the invoice to the debtor
RecoursePUT /invoices/<id>/actions/recourseRecourseOnInvoicesReverse financing on a factored invoice
ArchivePUT /invoices/<id>/archive/addAddToArchiveInvoicesMove 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.