Sign in

v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB
Procurement > PurchaseOrder

Reads a single Purchase order

Fetch one or all purchase orders for the company.

get/api/2026-07-01/resources/procurement/purchase_orders/{id}

Path parameters

idstring required

An array of purchase order IDs to filter by.

Response

OK

idstring required

Unique identifier of the purchase order

po_numberinteger required

Purchase order number assigned to this order

descriptionstring required

Description or notes about the purchase order

status'processing' | 'draft' | 'pending' | 'ordered' | 'partial' | 'received' | 'closed' required

Current status of the purchase order

costobject required

Total cost of the purchase order

datestring required

Date when the purchase order was created

vendor_idstring

Identifier of the vendor (contact) associated with this purchase order

purchase_request_idstring

Identifier of the purchase request that generated this purchase order, if any. Externally-created purchase orders (e.g. synced from an ERP) have no purchase request.

legal_entity_idstring required

Identifier of the legal entity that owns this purchase order

company_idstring required

Identifier of the company that owns this purchase order

formatted_po_numberstring required

Formatted purchase order number with prefix (e.g., PO-00001)

Example response

{
  "id": "678432",
  "po_number": 2131,
  "description": "Office supplies for Q1 2025",
  "status": "pending",
  "cost": {
    "cents": 10000,
    "currency": "EUR"
  },
  "date": "2025-01-15",
  "vendor_id": "9012",
  "purchase_request_id": "5678",
  "legal_entity_id": "3456",
  "company_id": "1",
  "formatted_po_number": "PO-02131"
}