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.

Changed on
post/api/reporting/inventory/list

Request

  • Base URL
    https://api.fulcrumpro.com
  • URL
    https://api.fulcrumpro.com/api/reporting/inventory/list
  • Auth
    none declared

Query parameters

Sort.Fieldstring

Sort field

Sort.Dir'ascending' | 'descending'

Specify sorting direction.

Sort direction

Skipinteger

Number of records to skip. Defaults to 0. Combine with FulcrumProduct.PublicApi.Dto.Common.PagingDto.Take to page through a result set larger than one page.

Takeinteger

Number of records to return. Validation accepts 0 through 5000, but 0 is not a page size and what an endpoint does with it varies, so send a value from 1 to 5000.

Two cases differ. A request that supplies paging but leaves this field out takes this field's default of <b>50</b>. A request that supplies no paging at all is endpoint-specific — some define their own fallback — so it does not reliably mean any particular number of records. Either way the response says nothing about records it did not return, so send this explicitly whenever the size of the answer matters. Endpoints returning a paged envelope report totalCount and hasNextPage alongside the records; endpoints returning a bare array report neither, so page those with FulcrumProduct.PublicApi.Dto.Common.PagingDto.Skip until a page comes back shorter than the value requested.

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

Changes