v2

latestOpenAPI 3.0.42026-08-084694591.6 MB
Reporting

Lists report-ready on-hand inventory rows from the inventory reporting view, including per-unit and extended valuation (material/labor/machine/OP), lot and location context, and item categorization so callers do not need to hand-join inventory to lots, items, and their details. Returns exactly one row per (item, lot, location), so summing on-hand quantity or value across the rows does not over-count a lot.

post/api/reporting/inventory/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

itemNumberstring nullable

Optional exact-match filter on the item number (the user-facing item identifier). Null means no item filter.

locationNamestring nullable

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

categorystring nullable

Optional exact-match filter on the item category. Null means no category filter.

Response

A page of inventory 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