Sign in
Receiving Receipt

Get a list of receipts for purchase and sales orders

post/api/receiving/receipts/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

salesOrderIdsstring[] nullable

Include receipts for specific sales order ids

purchaseOrderIdsstring[] nullable

Include receipts for specific purchase order ids

receiptIdsstring[] nullable

Include receipts with specific ids

includeReceiptLinesboolean

If set to true, receipt line items will be included in the results

receivedDateFromstring date-time nullable

Inclusive lower bound on the receipt's effective received date, which is its received-date override when one is set and its recorded received date otherwise. A whole day in the shop's timezone; any time of day supplied is ignored.

receivedDateTostring date-time nullable

Inclusive upper bound on that same effective received date. A whole day in the shop's timezone; any time of day supplied is ignored.

Response

List of receipts

idstring required

Unique id associated to this entity.

receivedBystring nullable

Id of the user who received the item(s)

numbernumber double nullable

Number

datestring date-time nullable

Received date

dateOriginalstring date-time nullable

Original received date

dateOverridestring date-time nullable

Override received date

accountingHeldUtcstring date-time nullable

Set while the receipt's accounting events are withheld because it contains material held for incoming inspection (tenant invoice timing = after-inspection). Held receipts are excluded from the receipt list until their inspections resolve; cleared when the deferred events fire.

orderType'purchaseOrder' | 'salesOrder'

Order type enum

orderIdstring nullable

Id of parent order to which this receipt belongs

externalReferencesobject nullable

Arbitrary key-value-pair like data that can be used to later on search for this receipt object.

customFieldsobject nullable

Custom fields that have been defined on this entity.

invoiceNumberstring nullable

The vendor invoice invoice number associated to the receipt.

Changes