Skip to main content
Purchase Order List API
curl --request GET \
  --url https://api.pazy.io/v1.0/procurement/purchase-orders

Documentation Index

Fetch the complete documentation index at: https://docs.pazy.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Authentication

All requests require an API key in the request headers. Headers: 
Authorization: Api-Key YOUR_API_KEY

​
Request

​
Query Parameters

ParameterTypeRequiredDescription
limitintNoThe max number of rows to be returned. Max 100, Default 30.
cursorstringNoThe pagination cursor, rows to offset/skip. Default 0.

​
Code Examples

curl -X GET https://api.pazy.io/v1.0/procurement/purchase-orders \
  -H "Authorization: Api-Key YOUR_API_KEY"

​
Success Response

HTTP Status: 200 OK Response Fields:
FieldTypeDescription
okbooleanIndicates whether the request was successful
dataobjectContains the purchase order details
data.purchaseOrdersarrayList of purchase orders
data.purchaseOrders[].poIdstringUnique slug identifier for the purchase order
data.purchaseOrders[].poNumberstringPurchase order number assigned to the document
data.purchaseOrders[].statestringCurrent state of the PO. Possible values: DRAFTED, PENDING, APPROVED, DECLINED, CLOSED, ARCHIVED
data.purchaseOrders[].poTypestringPurchase order type. Possible values: GOODS, SERVICES
data.purchaseOrders[].matchingTypestringMatching type. Possible values: TWO_WAY, THREE_WAY
data.purchaseOrders[].currencystringISO 4217 currency code (e.g., INR)
data.purchaseOrders[].amountnumberTotal purchase order amount
data.purchaseOrders[].descriptionstringShort description for the purchase order
data.purchaseOrders[].poDatestringPurchase order date (ISO 8601 format, YYYY-MM-DD)
data.purchaseOrders[].deliveryDatestringRequested delivery date (ISO 8601 format, YYYY-MM-DD)
data.purchaseOrders[].termsAndConditionsstringTerms and conditions for the purchase order
data.purchaseOrders[].additionalNotesstringAdditional notes for delivery or special requirements
data.purchaseOrders[].paymentTermsstringAgreed payment terms
data.purchaseOrders[].vendorobjectLinked vendor information (null if no vendor linked)
data.purchaseOrders[].vendor.displayNamestringVendor display name
data.purchaseOrders[].vendor.legalNamestringVendor legal name
data.purchaseOrders[].lineItemsarrayList of line items on the purchase order
data.purchaseOrders[].lineItems[].identifierstringSKU or identifier for the line item
data.purchaseOrders[].lineItems[].quantitynumberQuantity requested
data.purchaseOrders[].lineItems[].ratenumberUnit rate
data.purchaseOrders[].lineItems[].amountnumberTotal amount for this line item (quantity × rate)
data.purchaseOrders[].matchedInvoicesarrayList of invoices matched against this purchase order
data.purchaseOrders[].matchedInvoices[].invoiceIdstringUnique identifier of the matched invoice
data.purchaseOrders[].matchedInvoices[].invoiceNumberstringInvoice number
data.purchaseOrders[].matchedInvoices[].statestringCurrent state of the invoice
data.purchaseOrders[].matchedInvoices[].amountnumberInvoice amount
data.purchaseOrders[].matchedInvoices[].currencystringInvoice currency
data.purchaseOrders[].matchedInvoices[].invoiceDatestringInvoice date (ISO 8601 format)
data.purchaseOrders[].matchedGrnsarrayList of Goods Receipt Notes matched against this purchase order
data.purchaseOrders[].matchedGrns[].grnIdstringUnique identifier of the matched GRN
data.purchaseOrders[].matchedGrns[].grnNumberstringGRN number
data.purchaseOrders[].matchedGrns[].statestringCurrent state of the GRN
data.purchaseOrders[].matchedGrns[].amountnumberGRN total amount
data.purchaseOrders[].matchedGrns[].totalQuantitynumberTotal quantity received in the GRN
data.purchaseOrders[].matchedGrns[].createdAtstringDate the GRN was created (ISO 8601 format)
data.context.countnumberTotal number of vendor payments
data.context.hasMorebooleanIf there is more Purchase Order
data.context.countnumberTotal number of vendor payments

​
PO State Values

ValueDescription
DRAFTEDPO is in draft state and can be edited
PENDINGPO is pending approval
APPROVEDPO has been approved
DECLINEDPO was declined and can be edited
CLOSEDPO has been closed
ARCHIVEDPO has been archived

​
Response Example

{
    "ok": true,
    "data": {
        "purchaseOrders": [
            {
                "poId": "po-id",
                "poNumber": null,
                "state": "CREATED",
                "poType": null,
                "matchingType": null,
                "currency": "INR",
                "amount": null,
                "description": null,
                "poDate": "2026-01-13T10:32:19.526Z",
                "deliveryDate": null,
                "termsAndConditions": null,
                "additionalNotes": null,
                "vendor": null,
                "lineItems": [],
                "matchedInvoices": [],
                "matchedGrns": []
            },
            {
                "poId": "po-id",
                "poNumber": "PO123456",
                "state": "ARCHIVED",
                "poType": "GOODS",
                "matchingType": "TWO_WAY",
                "currency": "INR",
                "amount": null,
                "description": "Purchase order with SKU",
                "poDate": "2025-04-28T05:13:47.507Z",
                "deliveryDate": null,
                "termsAndConditions": null,
                "additionalNotes": null,
                "vendor": {
                    "displayName": "Acme Suppliers",
                    "legalName": "ACME SUPPLIERS PRIVATE LIMITED"
                },
                "lineItems": [
                    {
                        "identifier": "item1",
                        "quantity": 10,
                        "rate": 100,
                        "amount": 1000,
                        "taxId": "132",
                        "taxAmount": 100
                    },
                    {
                        "identifier": "Item 1",
                        "quantity": 10,
                        "rate": 100,
                        "amount": 1000,
                        "taxId": "132",
                        "taxAmount": 100
                    }
                ],
                "matchedInvoices": [],
                "matchedGrns": []
            },
            ...
        ],
        "context": {
            "count": 100,
            "hasMore": true,
            "nextCursor": "100"
        }
    }
}

​
Error Responses

​
Purchase Order Not Found

HTTP Status: 404 Not Found 
{
  "ok": false,
  "error": {
    "code": "PURCHASE_ORDER_NOT_FOUND",
    "message": "Purchase order not found"
  }
}

​
Authentication Errors

HTTP Status: 401 Unauthorized 
{
  "ok": false,
  "error": {
    "code": "MISSING_CREDENTIALS",
    "message": "Missing Credentials"
  }
}

{
  "ok": false,
  "error": {
    "code": "INVALID_API_KEY",
    "message": "Invalid API Key"
  }
}

​
Permission Errors

HTTP Status: 403 Forbidden 
{
  "ok": false,
  "error": {
    "code": "INSUFFICIENT_PERMISSIONS",
    "message": "Permission check failed - PERMISSION_CHECK_FAILED"
  }
}

​
Internal Error

HTTP Status: 500 Internal Server Error 
{
  "ok": false,
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal error"
  }
}

​
Best Practices

  • The matchedInvoices array is populated when invoices are linked to the PO (TWO_WAY or THREE_WAY matching)
  • The matchedGrns array is populated only for THREE_WAY matching POs
  • Check state to understand where the PO is in the approval workflow before taking further actions