Skip to content

Mass Update Invoice Status

GraphQL counterpart of POST /api/admin/invoices/mass-update-status. Bulk-sets the status of a batch of invoices — the operation behind the admin Invoices datagrid's "Update Status" bulk action. Requires the sales.invoices.view permission. All admin endpoints require an admin Bearer token — see Authentication.

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.

Operation

OperationType
createAdminInvoiceMassUpdateStatus(input)Mutation

Input

FieldTypeDescription
indices[Int!]!Ids of the invoices to update. Must be non-empty.
valueString!New status — one of pending, paid, overdue.

Payload

message is the field to read for confirmation. The updated ids are also returned; over GraphQL this list is wrapped in a paginated envelope, so the REST response is the canonical place to read the flat updated array. Empty indices or an out-of-range value returns an error in errors[].

Released under the MIT License.