Purchase orders
An authorization to buy stocked products or engineered goods from a supplier.
- API name:
purchaseorders - Domain: Purchases
- Modules: Purchasing analytics, Purchasing
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| Name | label | Text | ||
| PO number | uid | Text | The number is a human-readable, unique identifier for the record. | |
| Day | date | Date | Yes | |
| Quote (source) | purchasequoteId | Reference | ||
| Requisition | purchaserequisitionId | Reference | ||
| Deal | purchasedealId | Reference | ||
| Project | projectId | Reference | ||
| Supplier | supplierId | Reference | Yes | |
| Contact | suppliercontactId | Reference | ||
| Owner | userId | User | ||
| Supplier reference | supplierReference | Text | The supplier's quote or order number. | |
| Allow over-receipt | allowOverReceipt | Boolean | Yes | When enabled, the related rule or behavior applies to this record. |
| Quote currency | currency | Constant | Yes | |
| Short close note | shortCloseNote | Text Area | ||
| Exchange rate date | dateFxrateSource | Date | Date of the exchange rate applied to this document. | |
| Delivery date | dateDelivery | Date | Date the supplier is expected to deliver. | |
| Delivery | delivery | Constant | Delivery address, method, and schedule for fulfillment. | |
| Incoterm | incoterm | Constant | ||
| Payment term | financespaymenttermId | Reference | ||
| Exchange rate | fxrate | Decimal | Yes | Accounting-currency units per 1 unit of the document currency. Use 1 when both currencies are the same. |
| Price basis | priceBasis | Constant | Yes | Whether unit prices include tax (gross) or exclude tax (net). |
| Subtotal | subtotal | Unit price | Yes | Sum of line amounts before tax and withholding on this document. |
| Fiscal compliance | tax | Unit price | Yes | Tax amount for this scope, in document currency, from the configured tax engine. |
| Withholding | withholding | Unit price | Yes | Withholding tax amount retained on this scope, in document currency. |
| Total | total | Unit price | Yes | Document total after discounts, tax, and withholding in document currency. |
| Short close reason | shortCloseReason | Constant | ||
| Cancel reason | cancelReason | Text Area | Required explanation when canceling this record. | |
| Tags | tagIds | Tags | ||
| Comments | comments | Text Area | ||
| Data | data | Data | ||
| Created by | createdBy | User | ||
| Created at | createdAt | Date and Time | Yes | |
| Updated by | updatedBy | User | ||
| Updated at | updatedAt | Date and Time | Yes | |
| Ended by | endedBy | User | ||
| Ended at | endedAt | Date and Time | ||
| Approved by | approvedBy | User | ||
| Approved at | approvedAt | Date and Time | ||
| Closed by | closedBy | User | ||
| Closed at | closedAt | Date and Time | ||
| Canceled by | canceledBy | User | ||
| Canceled at | canceledAt | Date and Time | ||
| Blocked by | blockedBy | User | ||
| Blocked at | blockedAt | Date and Time | ||
| Archived by | archivedBy | User | ||
| Archived at | archivedAt | Date and Time |
Relations
Owned records (solid line) are deleted with their owner. Grouped records (dashed line) can exist alone.
| Field | Points to | Kind |
|---|---|---|
Quote (source) purchasequoteId | Purchase quotes | reference |
Requisition purchaserequisitionId | Purchase requisitions | reference |
Deal purchasedealId | Purchase deals | reference |
Project projectId | Projects | reference |
Supplier supplierId | Suppliers | reference |
Contact suppliercontactId | Supplier contacts | reference |
Owner userId | Users | reference |
Payment term financespaymenttermId | Payment terms | reference |
Tags tagIds | Tags | reference |
Actions
What you can do with a record. Every action also sends the webhook event purchaseorders.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add an new order. | App · API · MCP · CLI |
| Edit | update | Save changes to this order. | App · API · MCP · CLI |
| Approve | approve | Approve this order so the next step can run. | App · API · MCP · CLI |
| Short close | end | Closes unreceived quantity and leaves received-not-billed quantity open for billing. | App · API · MCP · CLI |
| Close | close | Stop new references to this order. It stays, and existing documents stay. Unclose to allow new references again. | App · API · MCP · CLI |
| Reopen | unclose | Allow new references to this order again. | App · API · MCP · CLI |
| Cancel | cancel | Reverse the posted effect of this order. | App · API · MCP · CLI |
| Block | block | Stop edits and deletion of this order. It stays visible and can still appear on existing documents. Unblock to edit again. | App · API · MCP · CLI |
| Unblock | unblock | Allow edits and deletion of this order again. | App · API · MCP · CLI |
| Archive | archive | Retire this order from daily use. It leaves active lists and pickers, and most actions stop. Unarchive to restore it. | App · API · MCP · CLI |
| Restore | unarchive | Return this order to active lists and actions. | App · API · MCP · CLI |
| Delete | delete | Delete this order and the data that belongs with it. This cannot be undone. | App · API · MCP · CLI |
States
How a record moves from state to state. Archive and block can happen in any state.