---
title: "Get a list of purchase orders"
method: GET
path: "/v1/finance/purchaseOrders"
tags: ["PurchaseOrders"]
---

# Get a list of purchase orders

`GET /v1/finance/purchaseOrders`

Retrieve a paged collection of purchase orders (required scope finance:read)

## Query parameters

- `sortBy` 'createdAt' | 'reference' — Represents the fields that can be used to sort purchase orders.<p>Possible values:</p><ul><li><b>createdAt</b>: The date and time when the purchase order was created.</li><li><b>reference</b>: Represents a reference to an external resource or entity.</li></ul>
- `direction` 'ascending' | 'descending' — Represents the direction in which sorting should be applied<p>Possible values:</p><ul><li><b>ascending</b>: Indicates ascending sorting order</li><li><b>descending</b>: Indicates descending sorting order</li></ul>
- `id` integer[]
- `jobId` integer[]
- `jobGroupId` integer[]
- `contactId` integer[]
- `reference` string[]
- `createdAtFrom` string, date-time
- `createdAtTo` string, date-time
- `pageNumber` integer
- `pageSize` integer

## Headers

- `Customer-Id` integer, required

## Response `200`

OK

- PagedResponseReadPurchaseOrderModel — A paged collection of items
  - `items` ReadPurchaseOrderModel[] — The items returned for the requested page
    - `id` integer — The unique identifier of the purchase order
    - `jobId` integer, nullable — The unique identifier of the job associated with this purchase order, if applicable
    - `jobGroupId` integer, nullable — The unique identifier of the job group associated with this purchase order, if applicable
    - `contactId` integer — The unique identifier of the contact associated with this purchase order
    - `seriesId` integer, nullable — The unique identifier of the purchase order series
    - `contractId` integer, nullable — The unique identifier of the contract associated with this purchase order, if applicable.<br/>Shown even if the contract has been soft deleted
    - `supplierId` integer, nullable — The unique identifier of the supplier associated with the purchase order
    - `createdAt` string, date-time — The dateTime the purchase order was created
    - `reference` string — The reference of the purchase order
    - `currencyCode` 'EUR' | 'AUD' | 'GBP' | 'BGN' | 'CAD' | 'CZK' | 'DKK' | 'HUF' | 'ILS' | 'LVL' | 'LTL' | 'MXN' | 'NZD' | 'NOK' | 'PLN' | 'RON' | 'RUB' | 'ZAR' | 'SEK' | 'CHF' | 'AED' | 'USD' | 'UNKNOWN' — CurrencyCode definitions enum, matches currencies available in the BigChange Client Site with an unknown value to handle unrecognised currencies returned from the database<p>Possible values:</p><ul><li><b>EUR</b>: Euro</li><li><b>AUD</b>: Australian Dollar</li><li><b>GBP</b>: Pound Sterling</li><li><b>BGN</b>: Bulgarian Lev</li><li><b>CAD</b>: Canadian Dollar</li><li><b>CZK</b>: Czech Koruna</li><li><b>DKK</b>: Danish Krone</li><li><b>HUF</b>: Forint</li><li><b>ILS</b>: New Israeli Sheqel</li><li><b>LVL</b>: Latvian Lats - replaced by Euro</li><li><b>LTL</b>: Lithuanian Litas - replaced by Euro</li><li><b>MXN</b>: Mexican Peso</li><li><b>NZD</b>: New Zealand Dollar</li><li><b>NOK</b>: Norwegian Krone</li><li><b>PLN</b>: Zloty</li><li><b>RON</b>: Romanian Leu</li><li><b>RUB</b>: Russian Ruble</li><li><b>ZAR</b>: Rand</li><li><b>SEK</b>: Swedish Krona</li><li><b>CHF</b>: Swiss Franc</li><li><b>AED</b>: UAE Dirham</li><li><b>USD</b>: US Dollar</li><li><b>UNKNOWN</b>: Unknown currency</li></ul>
    - `deliverySiteContactId` integer, nullable — The unique identifier of the delivery site contact associated with this purchase order, if applicable
    - `clientNotes` string — Notes on the purchase order
    - `internalNotes` string — Internal notes not visible to the client
    - `sentAt` string, date-time, nullable — The date and time when the purchase order was sent, if applicable
    - `cancelledAt` string, date-time, nullable — The date and time when the purchase order was cancelled, if applicable
    - `receivedAt` string, date-time, nullable — The date and time when the purchase order was received, if applicable
    - `cost` number, double, nullable — The cost of the purchase order
    - `totalExclTax` number, double — The total amount excluding tax
    - `totalInclTax` number, double — The total amount including tax
    - `totalPaid` number, double — The total amount paid
    - `customFields` CustomFieldReadModel[] — Custom fields associated with the purchase order
      - `definitionId` integer — The unique identifier of the associated custom field definition
      - `value` string, nullable — The current value set for the custom field
      - `definition` CustomFieldEmbeddedDefinitionModel — Represents the definition of a custom field
        - `caption` string — The caption of a custom field
        - `type` 'boolean' | 'integer' | 'decimal' | 'text' | 'list' | 'statement' | 'date' | 'note' | 'time' | 'systemList' — The type of the custom field. New field types may be added in the future, so integrations should be resilient to this<p>Possible values:</p><ul><li><b>boolean</b>: Indicates a boolean field <i>(Example: "false")</i></li><li><b>integer</b>: Indicates an integer numeric field <i>(Example: "1001")</i></li><li><b>decimal</b>: Indicates a floating point numeric field <i>(Example: "1.42")</i></li><li><b>text</b>: Indicates an editable text field <i>(Example: "Purple")</i></li><li><b>list</b>: Indicates a field with a single value from a predefined list of options <i>(Example: "Purple")</i></li><li><b>statement</b>: Indicates a text field that cannot be edited. The value is always equal to the default value <i>(Example: "By signing this you agree to the following...")</i></li><li><b>date</b>: Indicates a date field, which will be represented as an RFC3339 formatted date string. The default value is not supported for this type and will always be null <i>(Example: "2024-01-31")</i></li><li><b>note</b>: Indicates a multiline, editable text field. Lines are seperated with a line feed character <i>(Example: "This is a note.")</i></li><li><b>time</b>: Indicates a time field, formatted as HH:mm. The default value is not supported for this type and will always be null <i>(Example: "10:30")</i></li><li><b>systemList</b>: Indicates the ID of a related resource, vehicle or web user <i>(Example: "228007")</i></li></ul>
        - `listOptions` string[], nullable — Shows the possible values for a list type custom field. Value will be null if type is not list
        - `isRequired` boolean — Indicates if the field is required in the UI. This is NOT enforced in the API
        - `isEditable` boolean — Indicates if the field is editable
        - `default` string, nullable — The default value of a custom field. Formatted in accordance with the rules of the field type
      - `systemListValueMetadata` SystemListValueMetadataModel — Represents details of custom field value of type system list
        - `label` string, nullable — A descriptive label for the specific resource, vehicle or web user that this system list value relates to
        - `entityType` 'resource' | 'vehicle' | 'webUser' — The type of entity used for custom field value of type system list<p>Possible values:</p><ul><li><b>resource</b></li><li><b>vehicle</b></li><li><b>webUser</b></li></ul>
  - `pageNumber` integer — The page number of the response where 1 is the first page
  - `pageSize` integer — The number of items requested for the current page
  - `pageItemCount` integer — The number of items returned in the current page

## Other responses

- `400` — Bad Request
- `500` — Internal Server Error

---

[API](https://skmtc.net/bigchange/apis/bigchange-dx.md) · [All operations](https://skmtc.net/bigchange/apis/bigchange-dx/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bigchange/bigchange-dx/revisions/916e669fc527/schema)