BAbagisto
Admin Sales: Invoices

List invoices (datagrid parity)

Changed on

Paginated invoices listing. Every invoice column + billing/shipping addresses are populated per row (line items are detail-only). Returns a { data, meta } envelope. Requires sales.invoices.view.

get/invoices

Request

Query parameters

pageinteger
Example:1

Page number (1-based).

per_pageinteger
Example:10

Items per page (default 10, max 50).

idstring
Example:12

Filter by invoice id (integer or comma-separated list).

customer_idinteger
Example:12

Only invoices of orders placed by this customer.

order_idstring
Example:00000

Partial order increment_id match.

state'pending' | 'pending_payment' | 'paid' | 'overdue'
Example:paid

Filter by invoice state.

base_grand_total_fromnumber

Minimum base grand total.

base_grand_total_tonumber
Example:1000

Maximum base grand total.

created_at_fromstring date
Example:2026-01-01

Created after (ISO date).

created_at_tostring date
Example:2026-12-31

Created before (ISO date).

sort'id' | 'increment_id' | 'order_id' | 'base_grand_total' | 'state' | 'created_at'
Example:id

Column to sort by.

order'asc' | 'desc'
Example:desc

Sort direction.

Response

AdminInvoice collection

idinteger nullable
incrementIdstring nullable
orderIdinteger nullable
orderIncrementIdstring nullable
statestring nullable
emailSentboolean nullable
totalQtyinteger nullable
orderCurrencyCodestring nullable
baseCurrencyCodestring nullable
channelCurrencyCodestring nullable
subTotalnumber nullable
formattedSubTotalstring nullable
baseSubTotalnumber nullable
formattedBaseSubTotalstring nullable
subTotalInclTaxnumber nullable
formattedSubTotalInclTaxstring nullable
baseSubTotalInclTaxnumber nullable
formattedBaseSubTotalInclTaxstring nullable
grandTotalnumber nullable
formattedGrandTotalstring nullable
baseGrandTotalnumber nullable
formattedBaseGrandTotalstring nullable
taxAmountnumber nullable
formattedTaxAmountstring nullable
baseTaxAmountnumber nullable
formattedBaseTaxAmountstring nullable
discountAmountnumber nullable
formattedDiscountAmountstring nullable
baseDiscountAmountnumber nullable
formattedBaseDiscountAmountstring nullable
shippingAmountnumber nullable
formattedShippingAmountstring nullable
baseShippingAmountnumber nullable
formattedBaseShippingAmountstring nullable
shippingAmountInclTaxnumber nullable
formattedShippingAmountInclTaxstring nullable
baseShippingAmountInclTaxnumber nullable
formattedBaseShippingAmountInclTaxstring nullable
shippingTaxAmountnumber nullable
formattedShippingTaxAmountstring nullable
baseShippingTaxAmountnumber nullable
formattedBaseShippingTaxAmountstring nullable
transactionIdstring nullable
remindersinteger nullable
nextReminderAtstring nullable
createdAtstring nullable
updatedAtstring nullable
orderStatusstring nullable
orderStatusLabelstring nullable
orderDatestring nullable
channelNamestring nullable
customerNamestring nullable
customerEmailstring nullable
itemsobject[]

Changes