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. 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

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

Changes