Accounting API
Invoices

Mark Paid

This API endpoint (POST) marks an existing invoice as paid. If the request succeeds, it returns the ID of the invoice that was updated otherwise, it will return an error. Permissions: invoices.edit Webhook event: invoice-payment-confirmed

Upon a successful API request, we will start finalising the invoice and initiate any post-payment processing activities. Keep in mind that this is not instant, so it is advisable to listen for the invoice-payment-confirmed webhook event before triggering any additional processes in your systems.

The webhook triggers when the full invoice is marked as paid or when there are no more items that can be marked as paid.

Path Parameters

id * The ID of the invoice to update.

Body Parameters

products array of objects An array of objects each representing a product or invoice item that you wish to mark as paid. Leave empty if you are marking the full invoice as paid.

JSON