Purchase order line items

A line of a purchase order for a product item or custom item, with quantity and negotiated unit cost.

API name: purchaseorderitems
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
Order	`purchaseorderId`	Reference	Yes
Position	`rank`	Order rank	Yes
Item	`productitemId`	Reference
Quantity	`quantity`	Quantity		Quantity in the catalog unit after any unit conversion on the line.
Quantity received	`quantityReceived`	Quantity	Yes	Sum received on the receipt lines of this order line; recalculated when receipts are received, adjusted or removed.
Quantity returned	`quantityReturned`	Quantity	Yes	Sum returned to the supplier on processed, non-canceled returns of this order line.
Quantity billed	`quantityBilled`	Quantity	Yes	Sum billed on approved bill lines with inventory destination whose bill is still active.
Received not billed	`quantityGrni`	Quantity	Yes	Received minus returned that is not billed yet. While above zero the order cannot be closed.
Material	`materialId`	Reference
Item	`customitemId`	Reference
Catalog	`catalog`	Constant
Unit	`catalogunit`	Unit
Quote line	`purchasequoteitemId`	Reference
Line item	`purchaserequisitionitemId`	Reference
Line item	`salesorderitemId`	Reference
Budget line	`projectbudgetlineId`	Reference
Dimensions	`dimensions`	Dimensions		Size of the piece sold or bought when the catalog is a material.
Unit price	`unitPrice`	Unit price		Price for one unit, before line discount. Includes tax only when the document price basis is gross.
Discount	`discount`	Unit price	Yes	Amount in the document or line currency.
Amount	`amount`	Unit price		Monetary amount in the applicable currency for this record.
Header discount	`amountHeaderDiscount`	Unit price	Yes	Amount in the document or line currency.
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.
Promised date	`datePromised`	Date		Calendar date without time of date.
Description	`description`	Text Area
Created by	`createdBy`	User
Created at	`createdAt`	Date and Time	Yes
Updated by	`updatedBy`	User
Updated at	`updatedAt`	Date and Time	Yes
Approved by	`approvedBy`	User
Approved at	`approvedAt`	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
Order `purchaseorderId`	Purchase orders	owned by
Quote line `purchasequoteitemId`	Purchase quote line items	reference
Line item `purchaserequisitionitemId`	Purchase requisition line items	reference
Line item `salesorderitemId`	Sales order line items	reference
Budget line `projectbudgetlineId`	Project budget lines	reference

Actions

What you can do with a record. Every action also sends the webhook event purchaseorderitems.<action>. Reads (find, get, count) work on every table.

Name	API name	Description	Where
Create	`create`	Add a new line item.	App · API · MCP · CLI
Edit	`update`	Save changes to this line item.	App · API · MCP · CLI
Delete	`delete`	Delete this line item and the data that belongs with it. This cannot be undone.	App · API · MCP · CLI