---
title: "List purchase orders"
method: GET
path: "/purchase-orders/"
tags: ["Purchase Orders"]
---

# List purchase orders

`GET /purchase-orders/`

Endpoint for retrieving a list of purchase orders.

## Query parameters

- `branch` string
- `contact` string
- `created_ts_after` string, date-time
- `created_ts_before` string, date-time
- `external_id` string
- `modified_ts_after` string, date-time
- `modified_ts_before` string, date-time
- `page` integer
- `page_size` integer
- `project` string
- `purchase_order_date` string, date
- `reference` string
- `status` string

## Response `200`

- PaginatedPurchaseOrderList
  - `count` integer, required
  - `next` string, uri, nullable
  - `previous` string, uri, nullable
  - `results` PurchaseOrder[], required
    - `amount` number, double, required — The total amount of the purchase order, including taxes and discounts.
    - `attachments` string[] — List of attachments linked to this purchase order.
    - `branch` string, nullable — The branch associated with this purchase order, if applicable.
    - `contact` string — The contact (vendor) associated with this purchase order.
    - `created_ts` string, date-time, required — The timestamp in UTC when the purchase order was created.
    - `currency` 'AED' | 'SAR' | 'USD' | 'EUR' | 'CAD' | 'AFN' | 'ALL' | 'AMD' | 'ARS' | 'AUD' | 'AZN' | 'BAM' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BND' | 'BOB' | 'BRL' | 'BWP' | 'BYN' | 'BZD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'GBP' | 'GEL' | 'GHS' | 'GNF' | 'GTQ' | 'HKD' | 'HNL' | 'HRK' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KZT' | 'LBP' | 'LKR' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MOP' | 'MUR' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SDG' | 'SEK' | 'SGD' | 'SOS' | 'SYP' | 'THB' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'XAF' | 'XOF' | 'YER' | 'ZAR' | 'ZMW', required — * `AED` - AED ⃱ * `SAR` - SAR ⃁ * `USD` - USD $ * `EUR` - EUR € * `CAD` - CAD $ * `AFN` - AFN ؋ * `ALL` - ALL Lek * `AMD` - AMD դր. * `ARS` - ARS $ * `AUD` - AUD $ * `...` Full information for [CurrencyEnum](currencyenum)
    - `custom_fields` object — A mapping of custom field IDs to their values.
    - `exchange_rate` number, double, nullable — The exchange rate to the organization base currency at the time of the document.
    - `external_id` string — External identifier for the purchase order.
    - `id` string, required — The unique identifier of the purchase order.
    - `language` 'ar' | 'en' — * `ar` - Arabic * `en` - English Full information for [LanguageEnum](languageenum)
    - `legacy_id` string, required — [Deprecated] The legacy identifier of the purchase order.
    - `line_items` PurchaseOrderLineItem[], required — The individual line items that make up the purchase order.
      - `account` string — The account associated with this line item.
      - `cost_center` string — The cost center associated with this line item, if any.
      - `created_ts` string, date-time, required — The timestamp in UTC when the line item was created.
      - `custom_fields` object — A mapping of custom field IDs to their values.
      - `description` string, required — The detailed description of the line item.
      - `discount` number, double, nullable — The discount as the percentage.
      - `id` string, required — The unique identifier of the line item.
      - `item` string — The item associated with this line item.
      - `item_unit_of_measure` string, nullable — The item unit of measure for this line item.
      - `legacy_id` string, required — [Deprecated] The legacy identifier of the line item.
      - `line_amount` number, double, required — The total amount for this line item, calculated as quantity * unit_amount - discount.
      - `modified_ts` string, date-time, required — The timestamp in UTC when the line item was last modified.
      - `order` integer
      - `quantity` number, double, required — The quantity of the item or service.
      - `tax_amount` number, double, required — The total tax amount for this line item.
      - `tax_rate` string — The tax rate applied to this line item, if any.
      - `unit_amount` number, double, required — The price per unit of the item or service.
    - `modified_ts` string, date-time, required — The timestamp in UTC when the purchase order was last modified.
    - `notes` string — Any additional notes or comments related to the purchase order.
    - `project` string, nullable — The project associated with this purchase order, if any.
    - `purchase_order_date` string, date, nullable — The date when the purchase order was issued.
    - `purchase_order_number` string — The unique identifier or number assigned to this purchase order.
    - `reference` string — Any additional reference information for this purchase order.
    - `status` 'DRAFT' | 'SENT' | 'BILLED' | 'VOIDED' — * `DRAFT` - DRAFT * `SENT` - SENT * `BILLED` - BILLED * `VOIDED` - VOIDED Full information for [PurchaseOrderStatusEnum](purchaseorderstatusenum)
    - `tax_amount` number, double, required — The total tax amount applied to the purchase order.
    - `tax_amount_type` 'TAX_INCLUSIVE' | 'TAX_EXCLUSIVE' — * `TAX_INCLUSIVE` - inc. tax * `TAX_EXCLUSIVE` - exc. tax Full information for [TaxAmountTypeEnum](taxamounttypeenum)
    - `terms` string — The terms and conditions of the purchase order.

---

[API](https://skmtc.net/wafeq/apis/wafeq-public-api.md) · [All operations](https://skmtc.net/wafeq/apis/wafeq-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/wafeq/wafeq-public-api/versions/36816b4fce7f/schema)