PurchaseOrder Resource
Purchase Orders Module
Purchase orders to suppliers. Product language: PO, purchase orders. Supports /report aggregates such as grand_total_sum.
| Endpoints | URI | Access Control | Description |
|---|---|---|---|
| save | POST /api/PurchaseOrder/save |
Admin or Module WRITE | |
GET /api/PurchaseOrder/pdf |
Allowed with an active employment connection | ||
| get-attached-files | GET /api/PurchaseOrder/get-attached-files |
Endpoint level permissions | |
| send | GET /api/PurchaseOrder/send |
Endpoint level permissions | |
| find | GET /api/PurchaseOrder/find |
Admin or Module READ | |
| get | GET /api/PurchaseOrder/get |
Admin or Module READ | |
| report | GET /api/PurchaseOrder/report |
Endpoint level permissions |
Server-side aggregates over filtered rows (same-table filters only). Response
|
| save-batch | POST /api/PurchaseOrder/save-batch |
Admin or Module WRITE | |
| delete | POST /api/PurchaseOrder/delete |
Admin or Module WRITE |
| Property | Type | Description |
|---|---|---|
id |
number | |
slug |
string | |
job_id |
number | |
service_id |
number | |
po_num |
number | |
line_items_json |
string | Purchase order line items as JSON (materials/lines on the PO). Prefer dedicated line APIs when available; this is the stored document payload. |
grand_total |
number | |
subject |
string | |
attached_files_json |
string | |
po_date |
date | |
supplier_id |
number | |
supplier_location_id |
number | |
supplier_contact_id |
number | |
supplier_quote_id |
number | |
site_contact_id |
number | |
issued_by_id |
number | |
attn_contact_id |
number | |
ship_to_address_json |
string | Ship-to address for the purchase order as a JSON object (suite, street, city, province, country, postal code, etc.). |
instructions |
string | |
terms |
string | |
status |
string | |
is_finalized |
boolean | |
is_closed |
boolean | |
last_emailed |
datetime | |
settings_override_json |
string | Document settings override for this purchase order as JSON. |
message_thread_id |
number | |
created_at |
datetime | |
updated_at |
datetime | |
updated_by |
number |
| Setting | |
|---|---|
Pagination Limit (when page parameter is set) |
50 per page |
| Default Sort Order | By insertion order |
| Related Resource | Key | Relationship to PurchaseOrder | Property |
|---|---|---|---|
| JobEstimate | estimate_id |
Belongs To | JobEstimate |
| Contact | supplier_id |
Belongs To | Supplier |
| ContactLocation | supplier_location_id |
Belongs To | SupplierLocation |
| Contact | supplier_contact_id |
Belongs To | SupplierContact |
| User | site_contact_id |
Belongs To | SiteContact |
| User | issued_by_id |
Belongs To | IssuedBy |
| PurchaseOrderFile | po_id |
Owns Many | PurchaseOrderFile |
| Job | job_id |
Belongs To | Job |
| Service | service_id |
Belongs To | Service |
| MessageThread | message_thread_id |
Belongs To | MessageThread |
| Expense | purchase_order_id |
Owns Many | Expense |
| JobBidComponentObject | supplier_quote_id |
Belongs To | SupplierQuote |