PurchaseOrdersGoodsLines
Reads /goodsLines entries from the PurchaseOrders table.
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 本製品 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.
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 as a worktag. */ 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. */ 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. */ 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 | Id of the instance |
PurchaseOrders_Id [KEY] | String | The Workday ID of the PurchaseOrders that contains this. |
DeliverTo_Descriptor | String | Supported for: SELECT. A description of the instance |
DeliverTo_Href | String | Supported for: SELECT. A link to the instance |
DeliverTo_Id | String | Supported for: SELECT. wid / id / reference id |
DeliveryType_Descriptor | String | Supported for: SELECT. A description of the instance |
DeliveryType_Href | String | Supported for: SELECT. A link to the instance |
DeliveryType_Id | String | Supported for: SELECT. wid / id / reference id |
Descriptor | String | Supported for: SELECT. A preview of the instance |
DueDate | Datetime | Supported for: SELECT. The date when the purchase order line is due for delivery. This value is based on the creation date of the purchase order and lead time for the item. |
ExtendedAmount_Currency | String | Supported for: SELECT. The extended amount for the purchase order line. Excludes the extended amounts on Tax Only Invoices. (Currency name) |
ExtendedAmount_Value | Decimal | Supported for: SELECT. The extended amount for the purchase order line. Excludes the extended amounts on Tax Only Invoices. (Value) |
ItemDescription | String | Supported for: SELECT. The line item description for the purchase order line. |
ItemName_Descriptor | String | Supported for: SELECT. A description of the instance |
ItemName_Href | String | Supported for: SELECT. A link to the instance |
ItemName_Id | String | Supported for: SELECT. wid / id / reference id |
LeadTime | Decimal | Supported for: SELECT. The lead time for the purchase order goods line. |
Location_Descriptor | String | Supported for: SELECT. A description of the instance |
Location_Href | String | Supported for: SELECT. A link to the instance |
Location_Id | String | Supported for: SELECT. wid / id / reference id |
Memo | String | Supported for: SELECT. The memo on the purchase order line. This field contains internal notes or reference text. |
Prepaid | Bool | Supported for: SELECT. If true, the purchase order line is prepaid. |
QuantityInvoiced | Decimal | Supported for: SELECT. The quantity on a document line associated to 1 or more supplier invoice lines. You can use this field to identify fully invoiced purchase orders with 2 or more separate invoice lines that partially fulfill the quantity on the purchase order. |
QuantityOrdered | Decimal | Supported for: SELECT. The quantity on the purchase order line. |
QuantityReceived | Decimal | Supported for: SELECT. The quantity received. If a Return exists, the quantity returned is deducted from the quantity received. |
QuantityShipped | Decimal | Supported for: SELECT. The total quantity shipped for the purchase order line. |
RequestedAsNoCharge | Bool | Supported for: SELECT. If true, the document line is associated to a No Charge requisition line. Requesters select No Charge when there is no expected cost for the requisition line. |
Retention | Bool | Supported for: SELECT. If true, the purchase order line has retention. |
ShipToAddress_Descriptor | String | Supported for: SELECT. A preview of the instance |
ShipToAddress_Id | String | Supported for: SELECT. Id of the instance |
ShipToContact_Descriptor | String | Supported for: SELECT. A description of the instance |
ShipToContact_Href | String | Supported for: SELECT. A link to the instance |
ShipToContact_Id | String | Supported for: SELECT. wid / id / reference id |
SpendCategory_Descriptor | String | Supported for: SELECT. A description of the instance |
SpendCategory_Href | String | Supported for: SELECT. A link to the instance |
SpendCategory_Id | String | Supported for: SELECT. wid / id / reference id |
Splits_Aggregate | String | Supported for: SELECT. A JSON aggregate. The line splits on the purchase order. This field contains details of the line splits. This field is empty when the purchase order doesn't have line splits. |
SupplierItemIdentifier | String | Supported for: SELECT. The alphanumeric identifier assigned by a supplier to an item. This value can be unique for each supplier of the item, and is different from the manufacturer identification number. |
TaxApplicability_Descriptor | String | Supported for: SELECT. A description of the instance |
TaxApplicability_Href | String | Supported for: SELECT. A link to the instance |
TaxApplicability_Id | String | Supported for: SELECT. wid / id / reference id |
TaxCode_Descriptor | String | Supported for: SELECT. A preview of the instance |
TaxCode_Id | String | Supported for: SELECT. Id of the instance |
TaxRecoverability_Aggregate | String | Supported for: SELECT. A JSON aggregate. The tax recoverability percentage on a taxable purchase order line. |
UnitCost_Currency | String | Supported for: SELECT. The unit cost for the purchase order line. (Currency name) |
UnitCost_Value | Decimal | Supported for: SELECT. The unit cost for the purchase order line. (Value) |
UnitOfMeasure_Descriptor | String | Supported for: SELECT. A description of the instance |
UnitOfMeasure_Href | String | Supported for: SELECT. A link to the instance |
UnitOfMeasure_Id | String | Supported for: SELECT. wid / id / reference id |
Worktags_Aggregate | String | Supported for: SELECT. A JSON aggregate. The Worktags for the purchase order line. |
Buyer_Prompt | String | Accepts multiple inputs. 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 | Accepts multiple inputs. 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 | Accepts multiple inputs. 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 | Accepts multiple inputs. Filters the purchase orders by status. Specify the Workday ID of the status. You can specify multiple status query parameters. |
SubmittedBy_Prompt | String | Accepts multiple inputs. 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 | Accepts multiple inputs. 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. |