---
title: "List purchase orders"
method: GET
path: "/api/v1/purchaseOrders"
tags: ["Purchase Order"]
---

# List purchase orders

`GET /api/v1/purchaseOrders`

Lists all available purchase orders.

## Query parameters

- `filter` object[]
  - `key` 'id' | 'status' | 'date' | 'supplier' | 'documentNumber' | 'project' | 'createdAt' | 'updatedAt' | 'salesOrderConfirmationReference' | 'suppliersOfferReference'
  - `op` 'equals' | 'notEquals' | 'in' | 'notIn' | 'exactlyIn' | 'allIn' | 'allNotIn' | 'contains' | 'notContains' | 'startsWith' | 'endsWith' | 'greaterThan' | 'lessThan' | 'is' | 'lessThanOrEquals' | 'greaterThanOrEquals'
  - `value` union
    - string — Used for the operations 'equals', 'notEquals', 'contains', 'notContains', 'startsWith', 'endsWith' and 'is'.
    - string[] — Used for the operations 'in', 'notIn', 'exactlyIn', 'allIn' and 'allNotIn'.
- `page` object
  - `number` string, required — Page number should be an integer greater than or equal to 1
  - `size` string, required — Page size should usually be an integer between 10 and 50.
- `order` object[]
  - `field` 'id' | 'date' | 'project' | 'status' | 'documentNumber'
  - `dir` 'asc' | 'desc'

## Response `200`

Operation completed successfully.

- object — List information of the purchase order.
  - `data` object[]
    - `id` string — Resource identifier.
    - `date` string, date — Date of the purchase order.
    - `project` object — Reference to another resource
      - `id` string, required — Resource identifier.
    - `status` string — Current status of the purchase order.
    - `documentNumber` string — Document number of the purchase order.
    - `supplier` object — Information about the supplier of the purchase order.
      - `id` string — Resource identifier.
      - `number` string
      - `customerNumberAtSupplier` string
      - `honorific` string — Honorific of the billing address.
      - `name` string — Name of the billing address.
      - `department` string — Department of the billing address.
      - `subDepartment` string — Subdepartment of the billing address.
      - `extraAddressLine` string — Extra address line of the billing address.
      - `street` string — Street of the billing address.
      - `zipCode` string — Zip code of the billing address.
      - `city` string — City of the billing address.
      - `state` string — State of the billing address.
      - `country` string — Country of the billing address.
      - `contactPerson` string — Contact person of the billing address.
      - `telephone` string — Telephone of the billing address.
      - `telefax` string — Telefax of the billing address.
      - `email` string — E-mail of the billing address.
    - `requestForQuotation` object, nullable — Nullable reference to another resource
      - `id` string, required — Resource identifier.
    - `bodyIntroduction` string — Text above the position table in the PDF.
    - `bodyOutroduction` string — Text below the position table in the PDF.
    - `salesOrderConfirmationReference` string — Reference of the sales order confirmation.
    - `isConfirmationRequested` boolean — Shows if a confirmation is requested.
    - `suppliersOfferReference` string — Offer reference of the supplier.
    - `internalDesignation` string — Internal designation of the purchase order.
    - `language` object — Language of the purchase order.
      - `iso2` string
    - `isConfirmed` boolean — Shows if the purchase order is confirmed.
    - `confirmedVia` string — Shows via the purchase order was confirmed.
    - `differingDesignation` boolean — Shows if differing designation is enabled.
    - `financials` object — Financial information about the purchase order.
      - `paymentMethod` object, nullable — Nullable reference to another resource
        - `id` string, required — Resource identifier.
      - `total` object — Money object with amount and currency
        - `amount` string, float — A string representing the amount
        - `currency` 'EUR' | 'USD' | 'JPY' | 'BGN' | 'CZK' | 'DKK' | 'GBP' | 'HUF' | 'PLN' | 'RON' | 'SEK' | 'CHF' | 'ISK' | 'NOK' | 'HRK' | 'RUB' | 'TRY' | 'AUD' | 'BRL' | 'CAD' | 'CNY' | 'HKD' | 'IDR' | 'ILS' | 'INR' | 'KRW' | 'MXN' | 'MYR' | 'NZD' | 'PHP' | 'SGD' | 'THB' | 'ZAR' | 'ARS' | 'CLP' | 'SAR' | 'AED' | 'QAR' — Currency matches one of currency values as specified in ISO-4217.
      - `paymentTerms` object — Information about payment terms of the purchase order.
        - `paymentTargetDiscount` number, float
        - `paymentTargetDays` number
        - `paymentTargetDiscountDays` number
        - `paymentTargetDiscountAmount` number, float
        - `isPaymentTargetDiscountApplied` boolean
      - `costCenter` string — The assigned cost center for the purchase order.
      - `tax` object — Tax information of the purchase order.
        - `taxation` string
        - `vatId` string
        - `taxDisplay` string
    - `delivery` object — Delivery information of the purchase order.
      - `deliveryTerms` object, nullable — Nullable reference to another resource
        - `id` string, required — Resource identifier.
      - `hasDifferentDeliveryAddress` boolean
      - `deliveryAddress` object — Delivery address of the purchase order.
        - `honorific` string
        - `name` string
        - `department` string
        - `subDepartment` string
        - `extraAddressLine` string
        - `street` string
        - `zipCode` string
        - `city` string
        - `state` string
        - `country` string
        - `contactPerson` string
      - `dates` object — Delivery dates of the purchase order.
        - `desiredDeliveryDate` string, date, nullable
        - `confirmedDeliveryDate` string, date, nullable
    - `formatting` object — Formatting settings for the PDF of a purchase order.
      - `hideLetterHead` boolean
      - `hidePrices` boolean
      - `hideProductNumbers` boolean
      - `showLongProductNumbers` boolean
      - `hideProductDescriptions` boolean
      - `showOwnProductNumberInColumn` boolean
    - `internalComment` string — Internal Comment about the purchase order.
    - `liabilitiesInfo` string — Information for liabilities.
  - `extra` object
    - `totalCount` integer, required — the total count of all items
    - `page` object, required — The pagination object containing the current page number and size
      - `number` integer, required — The current page number
      - `size` integer, required — The size of the pages

## Other responses

- `401` — Unable to authenticate the client
- `403` — Unable to authorize the client
- `406` — Requested resource representation does not exist.
- `429` — Too many API calls made.

---

[API](https://skmtc.net/xentral/apis/xentral-api.md) · [All operations](https://skmtc.net/xentral/apis/xentral-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/xentral/xentral-api/revisions/8a27ba392442/schema)