Maintains records of service-based line items in purchase orders, supporting procurement tracking and contract management.

Workday Resource Information

Retrieves a purchase order with the specified ID.

Secured by: Process: Purchase Order - View, Process: Supplier Invoice (OLD)+TG, Process: Supplier Invoice - View, Self-Service: Purchase Order, Self-Service: Supplier Contact Tasks, View: Organization Purchase Order

Scope: Procurement, Supplier Accounts

Aggregate Fields

The add-in represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.

This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.

Splits_Aggregate

[{
  amount: Currency /* The amount on the purchase order transaction line split. */
  descriptor: Text /* A preview of the instance */
  id: Text /* Id of the instance */
  location: { /* The location worktag for a purchase order line split. */
     -descriptor: Text /* A description of the instance */
     -href: Text /* A link to the instance */
     *id: Text /* wid / id / reference id */
  }
  memo: Text /* The memo for a purchase order line split. */
  percent: Numeric /* The percentage for a purchase order line split. */
  quantity: Numeric /* The quantity for the purchase order line split. */
  worktags: [{
      descriptor: Text /* A preview of the instance */
      href: Text /* A link to the instance */
      id: Text /* Id of the instance */
      worktagType: { /* The worktag type for the worktag. */
         -descriptor: Text /* A description of the instance */
         -href: Text /* A link to the instance */
         *id: Text /* wid / id / reference id */
      }
  }]
}]

TaxRecoverability_Aggregate

[{
  descriptor: Text /* A preview of the instance */
  id: Text /* Id of the instance */
  percentRecoverable: Numeric /* The tax recoverable percentage for tax recoverability. */
}]

Worktags_Aggregate

[{
  descriptor: Text /* A preview of the instance */
  href: Text /* A link to the instance */
  id: Text /* Id of the instance */
  worktagType: { /* The worktag type for the worktag. */
     -descriptor: Text /* A description of the instance */
     -href: Text /* A link to the instance */
     *id: Text /* wid / id / reference id */
  }
}]

Columns

Name	Type	Description
Id [KEY]	String	A unique identifier for the purchase order service line instance within Workday.
PurchaseOrders_Id [KEY]	String	The unique Workday ID (WID) for the purchase order that includes this service line. Used to establish relationships between orders and their corresponding service lines.
AmountInvoiced_Currency	String	The currency in which the total extended line amount of all invoice lines for the purchase order line is denominated. This applies to both Goods and Service lines and follows the currency set for the purchase order.
AmountInvoiced_Value	Decimal	The total value of all invoice lines associated with this purchase order line, calculated based on the extended amounts. This field applies to both Goods and Service lines and is expressed in the purchase order's currency.
AmountOrdered_Currency	String	The currency in which the extended amount for the purchase order line is recorded. This excludes any tax amounts from Tax Only Invoices.
AmountOrdered_Value	Decimal	The extended monetary value for this purchase order line, excluding any tax-only amounts. This value represents the cost committed at the time of order placement.
AmountReceived_Currency	String	The currency of the total extended line amount for all receipt lines linked to this purchase order line.
AmountReceived_Value	Decimal	The cumulative extended amount of all receipt lines for the purchase order line, reflecting the received portion of the order.
DeliverTo_Descriptor	String	A textual representation describing the intended delivery recipient or location for the purchase order line.
DeliverTo_Href	String	A URL reference linking to detailed information about the delivery recipient or location for this purchase order line.
DeliverTo_Id	String	The unique identifier (WID, ID, or reference ID) associated with the delivery destination of the purchase order line.
Descriptor	String	A brief summary or preview text describing the purchase order service line instance.
DueDate	Datetime	The date when the items or services for this purchase order line are expected to be delivered, based on the order creation date and predefined lead time.
EndDate	Datetime	The final date applicable for the simple service order line, marking the completion of the service period.
ExtendedAmount_Currency	String	The currency in which the extended amount for the purchase order line is recorded. This excludes any tax amounts from tax-only invoices.
ExtendedAmount_Value	Decimal	The total cost for the purchase order line after factoring in quantity and unit price, excluding tax amounts from tax-only invoices.
ItemDescription	String	A detailed description of the item or service specified in the purchase order line, providing clarity on its nature and intended use.
ItemName_Descriptor	String	A textual representation describing the item or service associated with this purchase order line.
ItemName_Href	String	A hyperlink reference pointing to additional details about the item or service listed in the purchase order line.
ItemName_Id	String	The unique Workday identifier (WID, ID, or reference ID) assigned to the item or service in the purchase order line.
Location_Descriptor	String	A descriptive name or label for the physical or virtual location associated with this purchase order line.
Location_Href	String	A hyperlink pointing to more information about the location relevant to the purchase order line.
Location_Id	String	The Workday identifier (WID, ID, or reference ID) associated with the location specified for this purchase order line.
Memo	String	Additional notes or comments provided for this purchase order line, often used to include supplementary details or special instructions.
Prepaid	Bool	Indicates whether this purchase order line is prepaid. If the value is 'true,' the amount has been paid in advance.
Retention	Bool	Indicates whether a retention amount applies to this purchase order line. If the value is 'true,' a portion of the payment can be withheld until conditions are met.
ShipToAddress_Descriptor	String	A textual description of the shipping address where the goods or services should be delivered.
ShipToAddress_Href	String	A hyperlink reference to the detailed information regarding the shipping address for this purchase order line.
ShipToAddress_Id	String	The unique Workday identifier (WID, ID, or reference ID) associated with the shipping address.
ShipToContact_Descriptor	String	A textual representation of the designated contact person or entity for the shipping destination.
ShipToContact_Href	String	A hyperlink reference providing more details about the contact person or entity handling shipment reception.
ShipToContact_Id	String	The Workday identifier (WID, ID, or reference ID) associated with the shipping contact.
SpendCategory_Descriptor	String	A textual description of the spend category assigned to this purchase order line, which classifies expenditures.
SpendCategory_Href	String	A hyperlink leading to more details about the spend category associated with this purchase order line.
SpendCategory_Id	String	The Workday identifier (WID, ID, or reference ID) corresponding to the spend category for this purchase order line.
Splits_Aggregate	String	Contains information about the cost splits applied to this purchase order line. If empty, no splits exist for this line.
StartDate	Datetime	The beginning date for the simple service order line, marking when the service delivery starts.
TaxApplicability_Descriptor	String	A textual description of the tax applicability status for this purchase order line, indicating whether and how taxes apply.
TaxApplicability_Href	String	A hyperlink reference for additional details regarding the tax applicability of this purchase order line.
TaxApplicability_Id	String	The Workday identifier (WID, ID, or reference ID) associated with the tax applicability classification.
TaxCode_Descriptor	String	A summary description of the tax code applied to this purchase order line, specifying tax treatment.
TaxCode_Id	String	The unique identifier of the tax code applicable to this purchase order line.
TaxRecoverability_Aggregate	String	Indicates the recoverable tax percentage on taxable items within this purchase order line, affecting cost calculations.
Worktags_Aggregate	String	A collection of Worktags linked to this purchase order line, providing additional categorization and reporting attributes.
Buyer_Prompt	String	Filters purchase orders based on the buyer. Specify the WID of the buyer assigned to the purchase order. Multiple buyer IDs can be specified.
Company_Prompt	String	Filters purchase orders by company. Specify the WID of the company. Multiple company IDs can be provided.
ExcludeCanceled_Prompt	Bool	If the value is 'true,' it excludes purchase orders with a status of Canceled. The default value is 'false.'
ExcludeClosed_Prompt	Bool	If the value is 'true,' it excludes purchase orders that have been marked as Closed. The default value is 'false.'
FromDate_Prompt	Date	Filters purchase orders to include only those with a document date on or after the specified date. Format: YYYY-MM-DD.
OrderFromConnection_Prompt	String	Filters purchase orders based on supplier order-from connections. Specify the WID of the order-from connection. Multiple IDs can be used.
Status_Prompt	String	Filters purchase orders by their status. Specify the WID representing the status. Multiple status IDs can be included.
SubmittedBy_Prompt	String	Filters purchase orders based on the worker who submitted them. Specify the WID of the submitting worker. Multiple IDs can be provided.
Supplier_Prompt	String	Filters purchase orders by supplier. Specify the WID of the supplier. Multiple supplier IDs can be included.
ToDate_Prompt	Date	Filters purchase orders to include only those with a document date on or before the specified date. Format: YYYY-MM-DD.