Skip to content

List Invoices

Listing of every invoice across all orders, matching the admin Invoices grid. Every invoice field plus the billingAddress / shippingAddress objects are populated on each row — only the line items are left empty on the listing. Requires the sales.invoices.view permission.

How this menu works

For the invoice state semantics, why a paid order can read "pending", the red payment-due countdown, and the print / send-duplicate / mass-status actions, see the Invoices overview.

Endpoint

EndpointMethod
/api/admin/invoicesGET

Query Parameters

ParameterTypeDescription
pageintegerPage number (1-based).
per_pageintegerItems per page (default 10, cap 50).
idstringFilter by invoice id (integer or comma-separated list).
order_idstringPartial match on the parent order number.
statestringpending, pending_payment, paid, overdue.
base_grand_total_fromnumberMin grand total.
base_grand_total_tonumberMax grand total.
created_at_fromdateCreated after (ISO date).
created_at_todateCreated before (ISO date).
sortstringid (default desc), increment_id, order_id, base_grand_total, state, created_at.
orderstringasc or desc.

Row shape

Each row carries the full invoice column set, order/customer context, and the billing & shipping addresses. The field reference is identical to Get Invoice — the only difference is that the line items are empty ([]) on the listing.

GroupFields
Identityid, incrementId, orderId, orderIncrementId, state, emailSent, totalQty
Currency codesorderCurrencyCode, baseCurrencyCode, channelCurrencyCode
TotalssubTotal*, grandTotal*, taxAmount*, discountAmount*, shippingAmount* — each in order + base currency, with formatted* and incl-tax variants
Status & timestampstransactionId, reminders, nextReminderAt, createdAt, updatedAt
Order & customerorderStatus, orderStatusLabel, orderDate, channelName, customerName, customerEmail
AddressesbillingAddress, shippingAddress (objects)
Line items (empty on listing)items ([])

A null here means the DB is genuinely empty

Listing rows return the actual stored value for every column. A null (e.g. transactionId, customerName, baseCurrencyCode) means that row has no value stored for it — not that the listing is withholding data. Only the line items are deliberately omitted on the listing.

INFO

For invoice detail + PDF + create, see the per-order endpoints under Orders.

Released under the MIT License.