PurchaseOrders
Retrieves a purchase order.
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
Columns
| Name | Type | Description |
| Id [KEY] | String | Id of the instance |
| BillToContactDetail | String | The bill-to contact information for the purchase order. |
| BillToContact_Descriptor | String | A description of the instance |
| BillToContact_Href | String | A link to the instance |
| BillToContact_Id | String | wid / id / reference id |
| Buyer_Descriptor | String | A description of the instance |
| Buyer_Href | String | A link to the instance |
| Buyer_Id | String | wid / id / reference id |
| Company_Descriptor | String | A description of the instance |
| Company_Href | String | A link to the instance |
| Company_Id | String | wid / id / reference id |
| CreditCard_Descriptor | String | A description of the instance |
| CreditCard_Href | String | A link to the instance |
| CreditCard_Id | String | wid / id / reference id |
| Currency_Descriptor | String | A description of the instance |
| Currency_Href | String | A link to the instance |
| Currency_Id | String | wid / id / reference id |
| Descriptor | String | A preview of the instance |
| DocumentDate | Datetime | The date of the purchase order. Users can manually update this value on the purchase order during creation. |
| DueDate | Datetime | The due date for the purchase order. |
| ExcludeFromMassClose | Bool | If true, indicates that the purchase order is manually excluded from mass close operations. |
| FreightAmount_Currency | String | The total amount of freight charges that are applicable for the taxable document. |
| FreightAmount_Value | Decimal | The total amount of freight charges that are applicable for the taxable document. |
| InternalMemo | String | The internal memo on a document. This type of memo is viewable by only internal workers of your company, and not any outside party. |
| IssueOption_Descriptor | String | A description of the instance |
| IssueOption_Href | String | A link to the instance |
| IssueOption_Id | String | wid / id / reference id |
| LineTotalAmount_Currency | String | The total extended amount for all purchase order lines. |
| LineTotalAmount_Value | Decimal | The total extended amount for all purchase order lines. |
| Memo | String | The memo on the purchase order. This field contains internal notes or reference text. |
| OrderFromConnection_Descriptor | String | A description of the instance |
| OrderFromConnection_Href | String | A link to the instance |
| OrderFromConnection_Id | String | wid / id / reference id |
| OtherCharges_Currency | String | The total amount of other charges that are applicable to the taxable document. |
| OtherCharges_Value | Decimal | The total amount of other charges that are applicable to the taxable document. |
| PaymentTerms_Descriptor | String | A description of the instance |
| PaymentTerms_Href | String | A link to the instance |
| PaymentTerms_Id | String | wid / id / reference id |
| PaymentType_Descriptor | String | A description of the instance |
| PaymentType_Href | String | A link to the instance |
| PaymentType_Id | String | wid / id / reference id |
| ShipToAddress_Descriptor | String | A description of the instance |
| ShipToAddress_Href | String | A link to the instance |
| ShipToAddress_Id | String | wid / id / reference id |
| ShipToContactDetail | String | The ship-to contact for the purchase order. This field contains the contact information for questions on orders, such as expected shipment date. |
| ShipToContact_Descriptor | String | A description of the instance |
| ShipToContact_Href | String | A link to the instance |
| ShipToContact_Id | String | wid / id / reference id |
| ShippingInstructions | String | The shipping instructions on the purchase order. |
| ShippingMethod_Descriptor | String | A description of the instance |
| ShippingMethod_Href | String | A link to the instance |
| ShippingMethod_Id | String | wid / id / reference id |
| ShippingTerms_Descriptor | String | A description of the instance |
| ShippingTerms_Href | String | A link to the instance |
| ShippingTerms_Id | String | wid / id / reference id |
| Status_Descriptor | String | A description of the instance |
| Status_Href | String | A link to the instance |
| Status_Id | String | wid / id / reference id |
| SubmittedBy_Descriptor | String | A description of the instance |
| SubmittedBy_Href | String | A link to the instance |
| SubmittedBy_Id | String | wid / id / reference id |
| SupplierContract_Descriptor | String | A description of the instance |
| SupplierContract_Href | String | A link to the instance |
| SupplierContract_Id | String | wid / id / reference id |
| Supplier_Descriptor | String | A description of the instance |
| Supplier_Href | String | A link to the instance |
| Supplier_Id | String | wid / id / reference id |
| TaxAmount_Currency | String | The total tax amount for the document. |
| TaxAmount_Value | Decimal | The total tax amount for the document. |
| TaxOption_Descriptor | String | A description of the instance |
| TaxOption_Href | String | A link to the instance |
| TaxOption_Id | String | wid / id / reference id |
| TotalAmount_Currency | String | The total extended amount of all purchase order lines for the purchase order. |
| TotalAmount_Value | Decimal | The total extended amount of all purchase order lines for the purchase order. |
| Buyer_Prompt | String | Filters the purchase orders by buyer. Specify the Workday ID of the worker assigned as buyer on the purchase order. You can specify multiple buyer query parameters. |
| Company_Prompt | String | Filters the purchase orders by company. Specify the Workday ID of the company. You can specify multiple company query parameters. |
| ExcludeCanceled_Prompt | Bool | If true, this method excludes the purchase orders with Canceled status. The default is false. |
| ExcludeClosed_Prompt | Bool | If true, this method excludes the purchase orders with Closed status. The default is false. |
| FromDate_Prompt | Date | Filters the purchase orders with document date on or after the specified date. Use the yyyy-mm-dd format. |
| OrderFromConnection_Prompt | String | Filters the purchase orders by supplier order-from connections. Specify the Workday ID of the order-from connection. You can specify multiple order-from connection query parameters. |
| Status_Prompt | String | Filters the purchase orders by status. Specify the Workday ID of the status. You can specify multiple status query parameters. |
| SubmittedBy_Prompt | String | Filters the purchase orders by the worker who submitted the purchase order. Specify the Workday ID of the worker. You can specify multiple submittedBy query parameters. You can use a returned id from GET /workers in the Staffing REST web service. |
| Supplier_Prompt | String | Filters the purchase orders by supplier. Specify the Workday ID of the supplier. You can specify multiple supplier query parameters. |
| ToDate_Prompt | Date | Filters the purchase orders with document date on or before the specified date. Use the yyyy-mm-dd format. |