Skip to main content

PurchaseOrder

A purchase order raised with a supplier.

type PurchaseOrder {
alternativeTaxRate: String
approvedAt: DateTime
approvedBy: String
canceledQuantityTotal: Float
costTier: String
createdAt: DateTime!
createdBy: String!
creatorName: String!
creditLimitOverride: CreditLimitOverride
customFields: JSON
deletedAt: DateTime
deliveryAddress: JSON
deliveryInstructions: String
discountAmount: Float!
etd: DateTime
exchangeRate: Float!
expectedDate: DateTime
freightAmount: Float!
fullyReceivedDate: DateTime
id: ID!
internalComments: String
invoiceDate: DateTime
itemCount: Int!
items: [PurchaseOrderItem!]!
lineReturns: [OrderLineReturns!]!
metadata: JSON
netTotalAmount: Float
notes: String
orderCurrency: String!
orderDate: DateTime!
orderNumber: String!
organizationId: String!
paymentStatus: PaymentStatus!
paymentTerms: String!
projectName: String
receivedBy: String
receivedDate: DateTime
receiverName: String
shippingAddress: JSON
shippingAmount: Float!
sourceSalesOrder: LinkedSalesOrderRef
sourceSalesOrderId: String
status: PurchaseOrderStatus!
subtotal: Float!
supplierAcceptanceDate: DateTime
supplierCode: String
supplierDisplayName: String
supplierEmail: String
supplierId: String!
supplierInvoiceNo: String
supplierName: String
supplierPhone: String
surchargeAmount: Float!
taxAmount: Float!
totalAmount: Float!
trackingCode: String
updatedAt: DateTime!
version: Int!
warehouseId: String
}

Fields​

PurchaseOrder.alternativeTaxRate ● String scalar​

Alternative tax rate applied to the order, when it differs from the per-line rates.

PurchaseOrder.approvedAt ● DateTime scalar​

When the order was approved. Null until approved.

PurchaseOrder.approvedBy ● String scalar​

The ID of the user who approved the order.

PurchaseOrder.canceledQuantityTotal ● Float scalar​

Total quantity cancelled across the lines when the unreceived balance was cancelled; 0 when none. Null when the lines were not loaded.

PurchaseOrder.costTier ● String scalar​

Cost tier the supplier prices were taken from.

PurchaseOrder.createdAt ● DateTime! non-null scalar​

When the record was created.

PurchaseOrder.createdBy ● String! non-null scalar​

The ID of the user who created the order.

PurchaseOrder.creatorName ● String! non-null scalar​

Display name of the user who created the order.

PurchaseOrder.creditLimitOverride ● CreditLimitOverride object​

Set when this save or confirmation went over the partner's credit limit and was allowed by the user's override permission, so the screen can warn. Null otherwise, and always null when the document is read later.

PurchaseOrder.customFields ● JSON scalar​

The organization's own fields on this purchase order, keyed by field key. Only fields the caller may see are returned; null when the values were not loaded.

PurchaseOrder.deletedAt ● DateTime scalar​

When the record was deleted. Empty while the record is live.

PurchaseOrder.deliveryAddress ● JSON scalar​

Address the supplier delivers to, as a JSON address object.

PurchaseOrder.deliveryInstructions ● String scalar​

Free-text delivery instructions for the supplier.

PurchaseOrder.discountAmount ● Float! non-null scalar​

Order-level discount, in the order currency.

PurchaseOrder.etd ● DateTime scalar​

Estimated date the supplier ships the goods.

PurchaseOrder.exchangeRate ● Float! non-null scalar​

Exchange rate between the order currency and the organization's base currency.

PurchaseOrder.expectedDate ● DateTime scalar​

Date the goods are expected to arrive.

PurchaseOrder.freightAmount ● Float! non-null scalar​

Freight charge for the order, in the order currency.

PurchaseOrder.fullyReceivedDate ● DateTime scalar​

When the last outstanding line was received. Null until the order is fully received.

PurchaseOrder.id ● ID! non-null scalar​

The unique ID of this record.

PurchaseOrder.internalComments ● String scalar​

Comments for your team only; never shown to the supplier.

PurchaseOrder.invoiceDate ● DateTime scalar​

Date on the supplier's invoice.

PurchaseOrder.itemCount ● Int! non-null scalar​

Number of lines on the order.

PurchaseOrder.items ● [PurchaseOrderItem!]! non-null object​

The lines on the order.

PurchaseOrder.lineReturns ● [OrderLineReturns!]! non-null object​

Per order line: units already on returns made against this order, and units a new return may still take (received less returned). Creating a return refuses more.

PurchaseOrder.metadata ● JSON scalar​

Additional data attached to the record, as JSON.

PurchaseOrder.netTotalAmount ● Float scalar​

The order total net of any quantity cancelled short, in the order currency. Equals totalAmount when nothing was cancelled, and is null when the lines were not loaded.

PurchaseOrder.notes ● String scalar​

Notes on the order, visible to the supplier.

PurchaseOrder.orderCurrency ● String! non-null scalar​

Currency code of the order's amounts.

PurchaseOrder.orderDate ● DateTime! non-null scalar​

Date the order was placed.

PurchaseOrder.orderNumber ● String! non-null scalar​

The order's number, unique within your organization.

PurchaseOrder.organizationId ● String! non-null scalar​

The ID of the organization the record belongs to.

PurchaseOrder.paymentStatus ● PaymentStatus! non-null enum​

How much of the order has been paid.

PurchaseOrder.paymentTerms ● String! non-null scalar​

Payment terms agreed with the supplier.

PurchaseOrder.projectName ● String scalar​

Project the purchase is for, if any.

PurchaseOrder.receivedBy ● String scalar​

The ID of the user who received the goods.

PurchaseOrder.receivedDate ● DateTime scalar​

When goods were first received against the order.

PurchaseOrder.receiverName ● String scalar​

Display name of the user who received the goods.

PurchaseOrder.shippingAddress ● JSON scalar​

Address the order is shipped from or billed to, as a JSON address object.

PurchaseOrder.shippingAmount ● Float! non-null scalar​

Shipping charge for the order, in the order currency.

PurchaseOrder.sourceSalesOrder ● LinkedSalesOrderRef object​

The sales order this PO supplies (number + status for the header chip). Only populated on the single-PO read.

PurchaseOrder.sourceSalesOrderId ● String scalar​

Id of the customer sales order this purchase order was raised to supply. Null for a stock-replenishment PO.

PurchaseOrder.status ● PurchaseOrderStatus! non-null enum​

Where the order is in its lifecycle.

PurchaseOrder.subtotal ● Float! non-null scalar​

Sum of the line totals before order-level charges, in the order currency.

PurchaseOrder.supplierAcceptanceDate ● DateTime scalar​

When the supplier accepted the order.

PurchaseOrder.supplierCode ● String scalar​

The supplier's code.

PurchaseOrder.supplierDisplayName ● String scalar​

The supplier's display name.

PurchaseOrder.supplierEmail ● String scalar​

The supplier's email address.

PurchaseOrder.supplierId ● String! non-null scalar​

The ID of the supplier.

PurchaseOrder.supplierInvoiceNo ● String scalar​

Number on the supplier's invoice.

PurchaseOrder.supplierName ● String scalar​

The supplier's legal name.

PurchaseOrder.supplierPhone ● String scalar​

The supplier's phone number.

PurchaseOrder.surchargeAmount ● Float! non-null scalar​

Surcharge on the order, in the order currency.

PurchaseOrder.taxAmount ● Float! non-null scalar​

Total tax on the order, in the order currency.

PurchaseOrder.totalAmount ● Float! non-null scalar​

Grand total of the order, in the order currency.

PurchaseOrder.trackingCode ● String scalar​

Carrier tracking code for the shipment.

PurchaseOrder.updatedAt ● DateTime! non-null scalar​

When the record was last changed.

PurchaseOrder.version ● Int! non-null scalar​

Optimistic-concurrency counter — pass back as expectedVersion on the next mutation.

PurchaseOrder.warehouseId ● String scalar​

The ID of the warehouse.

Returned By​

appCreatePurchaseOrder mutation ● approvePurchaseOrder mutation ● appUpdatePurchaseOrder mutation ● cancelPurchaseOrder mutation ● createPurchaseOrder mutation ● forceUpdatePurchaseOrder mutation ● purchaseOrder query ● purchaseOrders query ● receivePurchaseOrder mutation ● removePurchaseOrder mutation

Member Of​

ProductReturn object ● PurchaseOrderSummary object