Skip to content

Mass Update Invoice Status

Bulk-sets the status of a batch of invoices in one call — the API behind the admin Invoices datagrid's "Update Status" bulk action. Requires the sales.invoices.view permission.

This is a manual status override

Setting an invoice to paid here does not capture a payment, and setting it to pending / overdue does not reverse one. It only changes the stored status flag. Use it to correct or annotate invoice states — not as a payment operation.

Endpoint

EndpointMethod
/api/admin/invoices/mass-update-statusPOST

Request body

FieldTypeDescription
indicesinteger[]Ids of the invoices to update. Must be non-empty.
valuestringNew status — one of pending, paid, overdue.

Response

FieldTypeDescription
updatedinteger[]Ids that were updated.
messagestringSuccess message.

Ids in indices that don't exist are silently skipped — updated lists only the ids that were actually changed.

Released under the MIT License.