Sign in
Purchase Order

Find purchase orders based on search parameters.

post/api/purchase-orders/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

numbersinteger[] nullable

Filter purchase orders to only given numbers

status'draft' | 'needsApproval' | 'approved' | 'ordered' | 'paid' | 'cancelled'

Purchase order status

receivingStatus'notReceived' | 'partiallyReceived' | 'received'

Purchase order receipt status

includeReceiptDataboolean

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

vendorIdstring nullable

The vendor id.

orderDateFromstring date-time nullable

Filter to purchase orders whose order date falls on or after this date. The whole day is included, so any time component is ignored.

orderDateTostring date-time nullable

Filter to purchase orders whose order date falls on or before this date. The whole day is included, so a purchase order ordered later that same day still matches.

jobIdstring nullable

Filter to purchase orders associated with this job — associated with the order itself, allocated to one of its part line items, or carried by an outside-processing line item.

Response

List of purchase orders matching the filters

idstring required

Unique id associated to this entity.

numberinteger required

Number

issueDatestring date-time nullable

PO creation date

orderDatestring date-time nullable

PO order date (null until status set to Ordered)

vendorIdstring required

Vendor Id

type'standard' | 'outsideProcessing' | 'vendorCredit' required

Purchase order type

status'draft' | 'needsApproval' | 'approved' | 'ordered' | 'paid' | 'cancelled' required

Purchase order status

receivingStatus'notReceived' | 'partiallyReceived' | 'received' required

Purchase order receipt status

expectedReceiveDatestring date-time nullable

PO Expected receipt date

customFieldDataobject nullable

Custom Fields

externalReferencesobject nullable

External references associated with this entity.

currencyCodestring nullable

Currency code/denomination associated to this vendor. If not provided, default to the primary currency code for the organization.

vendorOrderNumberstring nullable

The vendor's purchase order number

vendorNotestring nullable

The vendor note is a string property that represents a note provided to the vendor.

Changes

Changed in 2 of the 23 revisions of this API.12

  • d743ab8b105f8See the full diff
    • ○

      added the new optional request property (media type: application/json-patch+json)

      new-optional-request-property

    • ○

      added the new optional request property (media type: application/json)

      new-optional-request-property

    • ○

      added the new optional request property (media type: text/json)

      new-optional-request-property

    • ○

      added the new optional request property (media type: application/*+json)

      new-optional-request-property

    • ○

      added the new optional request property (media type: application/json-patch+json)

      new-optional-request-property

    • ○

      added the new optional request property (media type: application/json)

      new-optional-request-property

    • ○

      added the new optional request property (media type: text/json)

      new-optional-request-property

    • ○

      added the new optional request property (media type: application/*+json)

      new-optional-request-property

  • c002514312374See the full diff
    • ○

      added the new optional request property (media type: application/json-patch+json)

      new-optional-request-property

    • ○

      added the new optional request property (media type: application/json)

      new-optional-request-property

    • ○

      added the new optional request property (media type: text/json)

      new-optional-request-property

    • ○

      added the new optional request property (media type: application/*+json)

      new-optional-request-property