PurchaseOrder

Represents a purchase order in the supply chain module.

Purchase orders are formal documents sent to suppliers to request materials, products, or services. They contain details about quantities, prices, delivery dates, and terms of the purchase agreement.

Core Information

• **PO Number**: Unique identifier for the purchase order
• **Status Management**: Tracks financial status and cost allocation status
• **Dates**: Issue date, expected dates, delivery dates, and payment due dates
• **Terms**: Payment terms, Incoterms, and special instructions

Relationships

Each purchase order is associated with a supplier, created by a party, and can be approved by another party. It contains multiple line items (POItems).

Status Tracking

• **Financial Status**: Tracks payment status (unpaid, partially paid, paid)
• **Cost Allocation Status**: Tracks if costs are complete or incomplete
• **Milestones**: Current milestone and status name for workflow tracking

type PurchaseOrder {
  approvedBy: Party
  approvedById: ID
  archivedAt: ISO8601DateTime
  attachments: [File!]
  brand: Brand @deprecated
  brandId: ID @deprecated
  cancelable: Boolean!
  closedAt: ISO8601DateTime
  confirmedDate: ISO8601DateTime
  contact: SupplySupplierContact
  contactId: ID
  costAllocationStatus: POCostAllocationStatusEnum
  countLines: Int
  countUnits: BigDecimal
  countUnitsAvailableToShip: BigDecimal
  createdAt: ISO8601DateTime!
  createdBy: Party!
  createdById: ID!
  currentMilestone: POMilestone
  deleteable: Boolean!
  deletedAt: ISO8601DateTime @deprecated
  deliveredDate: ISO8601DateTime
  expectedCompleteDate: ISO8601DateTime
  expectedDate: ISO8601DateTime
  financialStatus: POFinancialStatusEnum
  id: ID!
  incoterms: SupplyIncoterms
  issueDate: ISO8601DateTime
  milestoneName: POMilestoneEnum
  milestones: [POMilestone!]!
  nextMilestone: POMilestone
  paymentDueDate: ISO8601DateTime
  paymentTerms: String
  poItems: [POItem!]!
  poNumber: String!
  prodCompleteDate: ISO8601DateTime
  shipDate: ISO8601DateTime
  specialInstructions: String
  statusName: POStatusEnum
  supplier: SupplySupplier
  supplierId: ID
  totalExpectedDays: Int
  totalPayments: MonetaryValue
  totalProductCost: MonetaryValue
  updatedAt: ISO8601DateTime!
}

Fields

PurchaseOrder.approvedBy ● Party object common

Party who approved this purchase order

PurchaseOrder.approvedById ● ID scalar common

ID of the party who approved this purchase order

PurchaseOrder.archivedAt ● ISO8601DateTime scalar common

When the purchase order was archived, or null if not archived.

PurchaseOrder.attachments ● [File!] list object common

Attachments associated with this purchase order

PurchaseOrder.brand ● Brand deprecated object common

DEPRECATED

This field will be removed in the future. Brand is becoming a product-only attribute.

Brand associated with this purchase order.

PurchaseOrder.brandId ● ID deprecated scalar common

DEPRECATED

This field will be removed in the future. Brand is becoming a product-only attribute.

PurchaseOrder.cancelable ● Boolean! non-null scalar common

Indicates if the purchase order can be canceled

PurchaseOrder.closedAt ● ISO8601DateTime scalar common

Date when the purchase order was closed

PurchaseOrder.confirmedDate ● ISO8601DateTime scalar common

Date when the purchase order was confirmed

PurchaseOrder.contact ● SupplySupplierContact object suppliers

Contact person at the supplier

PurchaseOrder.contactId ● ID scalar common

PurchaseOrder.costAllocationStatus ● POCostAllocationStatusEnum enum purchase-orders

Cost allocation status of the purchase order

PurchaseOrder.countLines ● Int scalar common

Number of line items in this purchase order

PurchaseOrder.countUnits ● BigDecimal scalar common

Total number of units across all line items

PurchaseOrder.countUnitsAvailableToShip ● BigDecimal scalar common

Total units not yet assigned to shipments

PurchaseOrder.createdAt ● ISO8601DateTime! non-null scalar common

Creation timestamp

PurchaseOrder.createdBy ● Party! non-null object common

Party who created this purchase order

PurchaseOrder.createdById ● ID! non-null scalar common

ID of the party who created this purchase order

PurchaseOrder.currentMilestone ● POMilestone object purchase-orders

Current milestone in the purchase order workflow

PurchaseOrder.deleteable ● Boolean! non-null scalar common

Indicates if the purchase order can be deleted

PurchaseOrder.deletedAt ● ISO8601DateTime deprecated scalar common

DEPRECATED

Use archived_at instead. This field will be removed in the future.

Soft deletion timestamp

PurchaseOrder.deliveredDate ● ISO8601DateTime scalar common

Date when the order was delivered

PurchaseOrder.expectedCompleteDate ● ISO8601DateTime scalar common

Expected completion date

PurchaseOrder.expectedDate ● ISO8601DateTime scalar common

Expected delivery date

PurchaseOrder.financialStatus ● POFinancialStatusEnum enum purchase-orders

Financial status of the purchase order

PurchaseOrder.id ● ID! non-null scalar common

Unique identifier for the purchase order

PurchaseOrder.incoterms ● SupplyIncoterms object common

International Commercial Terms (Incoterms) for this purchase order

PurchaseOrder.issueDate ● ISO8601DateTime scalar common

Date when the purchase order was issued

PurchaseOrder.milestoneName ● POMilestoneEnum enum purchase-orders

Current milestone name in the purchase order workflow

PurchaseOrder.milestones ● [POMilestone!]! non-null object purchase-orders

Milestones associated with this purchase order

PurchaseOrder.nextMilestone ● POMilestone object purchase-orders

Next milestone in the purchase order workflow

PurchaseOrder.paymentDueDate ● ISO8601DateTime scalar common

Date when payment is due

PurchaseOrder.paymentTerms ● String scalar common

Payment terms for this purchase order

PurchaseOrder.poItems ● [POItem!]! non-null object purchase-orders

Purchase order line items

PurchaseOrder.poNumber ● String! non-null scalar common

Purchase order number

PurchaseOrder.prodCompleteDate ● ISO8601DateTime scalar common

Production completion date

PurchaseOrder.shipDate ● ISO8601DateTime scalar common

Date when the order was shipped

PurchaseOrder.specialInstructions ● String scalar common

Special instructions or notes for this purchase order

PurchaseOrder.statusName ● POStatusEnum enum purchase-orders

Current status name of the purchase order

PurchaseOrder.supplier ● SupplySupplier object suppliers

Supplier associated with this purchase order

PurchaseOrder.supplierId ● ID scalar common

PurchaseOrder.totalExpectedDays ● Int scalar common

Total expected days from issue to expected completion date

PurchaseOrder.totalPayments ● MonetaryValue object common

PurchaseOrder.totalProductCost ● MonetaryValue object common

PurchaseOrder.updatedAt ● ISO8601DateTime! non-null scalar common

Last update timestamp

Returned By

supplyCreatePurchaseOrder mutation ● supplyPurchaseOrder query ● supplyUpdatePurchaseOrder mutation

Member Of

POItem object ● PONote object ● PurchaseOrderConnection object ● PurchaseOrderEdge object ● SupplyShipment object