---
title: "Find purchase orders based on search parameters."
method: POST
path: "/api/purchase-orders/list"
tags: ["Purchase Order"]
---

# Find purchase orders based on search parameters.

`POST /api/purchase-orders/list`

## Query parameters

- `Sort.Field` string
- `Sort.Dir` 'ascending' | 'descending' — Specify sorting direction.
- `Skip` integer
- `Take` integer

## Request body

- PurchaseOrderRequestFindParameters — Parameters used for searching/finding purchase orders.
  - `numbers` integer[], 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
  - `externalReference` CommonExternalReferenceFindDto — Search parameter for identifier record(s) via their external identifiers.
    - `key` string, required — Specifies the group name (key) that this external reference originates from (e.g. an external application name)
    - `type` string, nullable — Arbitrary sub-key that can be used to qualify the value
    - `externalId` string, nullable — The external identifier
  - `includeReceiptData` boolean — If set to true, receipt data will be included in the results
  - `vendorId` string, nullable — The vendor id.

## Response `200`

List of purchase orders matching the filters

- PurchaseOrderListDto[]
  - `id` string, required — Unique id associated to this entity.
  - `number` integer, required — Number
  - `issueDate` string, date-time, nullable — PO creation date
  - `orderDate` string, date-time, nullable — PO order date (null until status set to Ordered)
  - `vendorId` string, 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
  - `expectedReceiveDate` string, date-time, nullable — PO Expected receipt date
  - `customFieldData` object, nullable — Custom Fields
  - `externalReferences` object, nullable — External references associated with this entity.
  - `currencyCode` string, nullable — Currency code/denomination associated to this vendor. If not provided, default to the primary currency code for the organization.
  - `vendorOrderNumber` string, nullable — The vendor's purchase order number
  - `vendorNote` string, nullable — The vendor note is a string property that represents a note provided to the vendor.

---

[API](https://skmtc.net/fulcrumpro/apis/fulcrum-publicapi.md) · [All operations](https://skmtc.net/fulcrumpro/apis/fulcrum-publicapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fulcrumpro/fulcrum-publicapi/versions/1b5649cff14a/schema)