PurchaseOrder
/api/v1/finance/purchase-ordersA purchase order issued to a vendor.
listgetcreateupdateapproveSchema
| Field | Type | Notes |
|---|---|---|
| id* | uuid | Server-assigned ULID with type prefix (e.g. per_…). |
| tenant_id* | string | Tenant scope — auto-stamped from the caller's JWT. |
| app_id | string | App scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present. |
| created_at* | date-time | Server stamp. |
| updated_at* | date-time | Server stamp; updated on every patch. |
| created_by | uuid | Person id from the caller's JWT (sub). |
| updated_by | uuid | Person id from the last writer's JWT (sub). |
| source | string | Provenance tag — defaults to 'edm'. |
| source_type | enum | frontend | backend | server | system | apiWhere the write originated. Defaults to 'api'. |
| is_deleted | boolean | Soft-delete flag. Excluded from default list queries. |
| deleted_at | date-time | Stamped when soft-deleted; null otherwise. |
| deleted_by | uuid | Person id who soft-deleted; null otherwise. |
| schema_version | number | Document schema version. Bumped on incompatible writes. |
| number | string | Human-readable unique purchase order number (e.g. 'PO-2026-0018'). |
| vendor_id | uuid | UUID of the Vendor this PO is raised against. |
| status | string | Lifecycle status of the purchase order. |
| requested_by_id | uuid | UUID of the Person who raised this purchase order. |
| approved_by_id | uuid | UUID of the Person who approved this purchase order. Null until approved. |
| issued_date | date-time | ISO 8601 date the PO was formally issued to the vendor. |
| expected_delivery_date | date-time | ISO 8601 expected date for delivery or fulfilment. |
| currency | string | ISO 4217 three-character currency code. |
| total | number | Total value of the purchase order. |
| line_items | json | Ordered list of line items for this purchase order. |
| notes | string | Free-form notes or delivery instructions. |
| linked_contract_id | uuid | UUID of the Contract that covers this PO. |
| cost_center_id | uuid | UUID of the CostCenter to which this PO is charged. |
| supplier_id | uuid | Supplier / vendor the PO is raised against. |
| amount | number | PO total value. |
| order_date | date-time | ISO 8601 date the PO was placed. |
| budget_id | uuid | Budget this PO draws down. |
| requested_by | uuid | Person who raised this purchase order. |
| approved_by | uuid | Person who approved this purchase order. |
| tags | json | Free-form tags for grouping and filtering. |
API
client.finance.purchaseOrders.*Loading manifest…