PurchaseOrder

Represents the Purchase Order entity that captures a formal request from a Buyer to a Supplier to supply goods or services. It is identified by a unique PurchaseOrderNumber and tracks the order's lifecycle via a StatusCode. It defines commercial terms like the TotalAmount, BillingAccount, and the governing PriceBook. This object is available in API version 65.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

Field Details
PurchaseOrderNumber
Type
autonumber
Properties
Filter, Group, idLookup, Sort
Description
A unique identifier for the purchase order.
PurchaseOrderDate
Type
datetime
Properties
Filter, Group, Nillable, Sort
Description
The date and time when the purchase order was created.
PurchaseOrderType
Type
picklist
Properties
Filter, Group, Nillable, Sort
Description
The type of the purchase order such as standard, blanket, and contract.
Possible values are:
  • Standard Purchase Order
  • Blanket Purchase Order
BuyerAccount
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The buyer account that initiated the purchase order.
This field is a relationship field.
Relationship Name
BuyerAccount
Refers To
Account
SupplierAccount
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The supplier account that received the purchase order.
This field is a relationship field.
Relationship Name
SupplierAccount
Refers To
Account
BuyerContact
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The primary contact person associated with the buyer account.
This field is a relationship field.
Relationship Name
BuyerContact
Refers To
Contact
SupplierContact
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The primary contact person associated with the supplier account.
This field is a relationship field.
Relationship Name
SupplierContact
Refers To
Contact
StatusCode
Type
picklist
Properties
Filter, Group, Nillable, Sort
Description
The current status of the product in the purchase order.
Possible values are:
  • Approved
  • AwaitingApproval
  • Cancelled
  • Closed
  • Delivered
  • Draft
  • Invoiced
  • PartiallyReceived
  • Received
  • Shipped
  • Submitted
BillingAccount
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The account to which invoices are issued for the purchase order.
This field is a relationship field.
Relationship Name
BillingAccount
Refers To
Account
BillToContact
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The contact associated with the billing account.
This field is a relationship field.
Relationship Name
BillToContact
Refers To
Contact
PriceBook
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The price book that specifies the item prices applicable to the purchase order.
This field is a relationship field.
AdditionalInfo
Type
text
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Additional notes or remarks related to the purchase order.
TotalAmount
Type
text
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Sum of all total amounts from the PO Lines.
ExternalPurchaseOrderNumber
Type
text
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The reference number associated with the purchase order.
UsageType
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specify the context in which the Purchase Order is created.
Possible values are:
  • DistributorManagement
  • PurchaseOrderManagement
RequestedDeliveryDate
Type
datetime
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The requested delivery date for the product.
ShippingLocation
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The location to which the product is to be shipped.
This field is a relationship field.
ShippingAddress
Type
address
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The address to which the product is to be shipped.
ShipToContact
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The contact associated with the shipping location.
This field is a relationship field.
ShipToAccount
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The account associated with the shipping location.
This field is a relationship field.