1b5649cff14a

latestOpenAPI 3.0.42026-08-084694591.6 MB
Reporting

Lists report-ready sales-order line rows from the sales-order line-items reporting view, including pre-computed cost, invoice, ship, and return columns so callers do not need to hand-join sales orders to line items, jobs, invoices, shipments, and returns.

post/api/reporting/sales-order-lines/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

orderedDateFromstring date-time nullable

Inclusive lower bound applied to the order's Ordered Date. Null means no lower bound.

orderedDateTostring date-time nullable

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

deliveryDueDateFromstring date-time nullable

Inclusive lower bound applied to the line's Delivery Due Date. Null means no lower bound.

deliveryDueDateTostring date-time nullable

Inclusive upper bound applied to the line's Delivery Due Date (the whole to day is included). Null means no upper bound.

salesOrderStatusstring nullable

Optional exact-match filter on the sales-order lifecycle status. Null means no status filter.

customerNamestring nullable

Optional exact-match filter on the customer name. Null means no customer filter.

accountingCodestring nullable

Optional exact-match filter on the accounting code mapped to the line. Null means no accounting code filter.

unshippedOnlyboolean nullable

When true, returns only lines with quantity remaining to ship (Quantity to Ship > 0). When false or null, no ship-status filter is applied.

Response

A page of sales-order line 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