v2

latestOpenAPI 3.0.42026-08-084694591.6 MB
Reporting

Lists report-ready invoice-line rows from the invoice reporting view, including line type, pricing, tax, and aging detail joined to sales-order and shipment context so callers do not need to hand-join invoices to invoice line items, sales orders, and shipments.

post/api/reporting/invoice/list

Query parameters

Sort.Fieldstring

Sort field

Sort.Dir'ascending' | 'descending'

Specify sorting direction.

Sort direction

Skipinteger

Number of records to skip.

Takeinteger

Number of records to return (maximum)

Request body

issuedDateFromstring date-time nullable

Inclusive lower bound applied to the invoice's Issued Date. Null means no lower bound.

issuedDateTostring date-time nullable

Inclusive upper bound applied to the invoice's Issued Date (the whole to day is included). Null means no upper bound.

invoiceStatusstring nullable

Optional exact-match filter on the invoice lifecycle status (e.g. "Issued", "Paid"). Null means no status filter.

lineTypestring nullable

Optional exact-match filter on the line type (Part, Shipping, Fee, Deposit, Discount, Refund, Tax, or NA). Null means no line-type filter.

Response

A page of invoice report rows with the total matching count.

pageinteger required

The 1-indexed page

pageSizeinteger required

The page size

totalCountinteger required

The total count of records

totalPagesinteger required

The total pages

hasPreviousPageboolean required

True if there is a previous page

hasNextPageboolean required

True if there is a next page