Response_Filter

Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.

Parameter name

Type/Value

Cardinality

Description

Validations

As_Of_Effective_Date

date

[0..1]

Indicates the date when application data, such as benefits and compensation, are deemed effective in the Workday system. (Also referred to as the "Effective Moment".) If not specified, this date defaults to TODAY.

As_Of_Entry_DateTime

dateTime

[0..1]

Indicates the date and time that data was entered into the system. (This field is also referred to as the "Entry Moment".) If not specified, defaults to the CURRENT DATE/TIME.

Page

decimal (12, 0) >0

[0..1]

Indicates the page of data to return in the response, and defaults to the first page (Page = 1). For responses that contain more than one page of data, use this parameter to retrieve the additional pages of data. For example, set Page = 2 to retrieve the second page of data.
Note: If you set the page parameter, you must also specify the "As_Of_Entry_Date" to ensure that the result set remains the same between your requests.

Count

decimal (3, 0) >0

[0..1]

Sets the number of objects to return within each response page (Min = 1, Max = 999, Default = 100 if not set). Any values you set must be between 1-999.

Response_Results

The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.

Parameter name

Type/Value

Cardinality

Description

Validations

Total_Results

decimal (12, 0) >0

[0..1]

The total number of results that have been returned from your request.

Total_Pages

decimal (12, 0) >0

[0..1]

The total number of pages that exist for your request. A page of data in WWS contains a maximum of 100 entries. So, if you have exactly 1,000 employees returned in a request, then you will have 10 pages of data that will need to be retrieved to build your complete dataset.
Each page contains a maximum of 100 entries.

Reference to an existing Issue Option. If not entered, this will be defaulted to XML if the selected Supplier has a Supplier Link and Print otherwise. If Purchase Order Issue Option is External, the Purchase Order will automatically be submitted and marked as Issued.

The Supplier Contract field is required if there are any Contract Lines referenced.

Provide a default tax recoverability for the tax applicability

Supplier Item Identifier cannot be changed for catalog items.

Supplier Item Identifiers can be set or updated for lines with no items or having non-catalog items. Catalog Items also have Supplier Item Identifiers, but we cannot change the existing value using this web service. For this web service, the value will be ignored (but will not fire an error) if there is a Web Item (punchout item) associated with the Requisition Line Reference; we will store the Supplier Item Identifier from the Web Item instead.

The Item Reference cannot be entered if the Requisition Line Reference is for a Web Item.

Item Reference is not allowed if there is a Requisition Line Reference for a Web Item. This is because characteristics such as Supplier Item Identifier will be coming from the Web Item and not the Item Reference.

Spend category must have a Spend Category Usage type of Procurement.

Please Enable Multi-Company on Purchase Orders.

The Company on the Requisition Line Reference for this Purchase Order Line must be a valid company for the Purchase Order.

Please enter a company that is in the intercompany profile of the company on the purchase order header.

Lot Serial information on goods lines is supported only for Bill Only purchase orders.

Prepaid, Retention, Due Date and Delivery Type aren't supported on Bill Only Purchase Order Goods lines.

Spend category "[spend category]" is inactive.

For Bill Only purchase orders, if there's a Ship-To Address on the line, it must match the header Ship-To Address, otherwise leave it blank on the line. If there is no header Ship-To Address, then the line Ship-To Address must match the company default shipping address.

Element containing Simple Service Purchase Order Line data. A Purchase Order may have multiple simple service purchase order lines.

Validation

Description

The Requisition Line referenced is from a Requisition that is Closed or Pending Close.

The Requisition Line referenced is from a Requisition that is Closed or Pending Close.

For purchase order lines tagged with a capital project worktag, the company of the purchase order must equal the company on the capital project.

The Supplier Contract Line supplier is On Hold and may not be used.

The Supplier Contract Line has been Canceled and cannot be used.

Item is from a Supplier Contract that does not accept Manual Purchase Orders.

Item is from a Supplier Contract that does not accept Manual Purchase Orders.

The sum of the extended amounts on the split lines ([split amt]) must equal the extended amount of the summary line: [amt]

Please specify an Item or an Item Description.

Please specify an Item or an Item Description.

Please specify an Item or a Spend Category.

Please specify an Item or a Spend Category.

The Item Reference on the Item Order Line does not match the Procurement Item on the Supplier Contract Line.

Can not have any combination of Project, Project Phase or Project Task worktags for the same line.

Only one worktag for each type is allowed for each document line.

The End Date must be on or after the Start Date

The Supplier Contract Line Reference for this Service Order Line is not for a Service line.

The Requisition Line Reference for this Service Order Line must be for a Service Line.

Catalog items are not allowed on Service Lines.

The Requisition Line Reference requires a RFQ and can not be sourced to Purchase Order.

The Deliver-To Location is invalid for the selected Delivery Type and/or Company.

The Supplier Contract field is required if there are any Contract Lines referenced.

Provide a default tax recoverability for the tax applicability

Extended Amount must be the same sign as the Requisition Line Reference's Extended Amount.

Extended Amount must be greater than zero if from a Service Contract Line Reference.

Please enter a company that is in the intercompany profile of the company on the purchase order header.

Please Enable Multi-Company on Purchase Orders.

The Company on the Requisition Line Reference for this Purchase Order Line must be a valid company for the Purchase Order.

Prepaid, Retention and Due Date aren't supported on Bill Only Purchase Order Service lines.

Spend category "[spend category]" is inactive.

For Bill Only purchase orders, if there's a Ship-To Address on the line, it must match the header Ship-To Address, otherwise leave it blank on the line. If there is no header Ship-To Address, then the line Ship-To Address must match the company default shipping address.

Reference to an existing purchase item. Specifying the purchase item will default values for the Item Description, Spend Category, Tax Applicability, Unit of Measure, and Unit Cost if these options are defined on the purchase item itself.

Validation

Description

The Supplier Contract field on the line is required and must match the Contract for the Catalog Item. Supplier Contract on the line: ([line contract]) is different than the expected Catalog Item's Contract: ([item contract]).

The Supplier Contract field is required and must match the Contract for the Catalog Item. Supplier Contract: ([header contract]) is different than the expected Catalog Item's Contract: ([item contract]).

The Supplier Item Identifier for a Goods Order Line. If the Item Reference is for a Catalog Item or the Requisition Line Reference is for a Web Item, the entered value will be ignored and Supplier Item Identifier from that Item will be used (even if it is blank)

Item_Description

string

[0..1]

Free form text description of the purchase item. The description will default from the item if the description is left blank.

This field is only enabled for Companies and Tenants which are Opted-In to Consolidate Requisition Lines by Supplier regardless of Supplier Contract.
Use this field to assign a specific Supplier Contract to this Spend Line.

Validation

Description

The Supplier Contract selected on the Document Line must be for the Supplier on the Document Header.

Currency for the Supplier Contract on the Purchase Order Line must match Currency for the Purchase Order.

The Supplier Contract on the Document Line is Closed or Pending Close.

The Supplier Contract on the Purchase Order Line is invalid. The contract may not allow Manual Purchase Orders, or the Contract is pending changes.

Reference to existing worktags. Worktags are a way to mark tasks and business objects to make them easier to access and summarize. Each transaction can include one value for each worktag type and is subject to configurable validation when submitted for approval.

Validation

Description

[list of worktag types] not valid for this transaction.

The Worktags provided are not valid for this transaction

Worktags are not allowed when there are split lines.

[not allowed worktag types on Spend Transactions]

The [type] is/are not available for use with the company/s: [partitionable] [company]

[worktag value] is not permitted as an allowed value for worktag type: [worktag type], because it is inactive.

Select a balancing worktag for Worktags of the following type: [type]

The following Accounting Worktags are required but have not been assigned: [missing].

[missing required worktag types on Spend Transactions]

Enter a company that matches on the award line in effect for grant: [grant]. This company doesn't match the grant on the award line: [comp].

Either Quantity must equal zero or not be present or the Extended Amount must equal Quantity * Unit Cost. Currently [Quantity] * [Unit Cost] does not equal [Extended].

Only one worktag for each type is allowed for each document line.

[not allowed worktag types on Business Document Line Split for Spend Transactions]

For requisition line splits tagged with a capital project worktag, the company of the requisition must equal the company on the capital project.

For purchase order line splits tagged with a capital project worktag, the company of the purchase order must equal the company on the capital project.

The Line Split Allocation Reference field should only be used when submitting a purchase order or a procurement card transaction verification. When submitting a purchase order, a Purchase Order Line Split must only reference Requisition Line Splits from the Requisition Line that is related to the current Purchase Order Line.

Use Budget Date on line splits to override the defaulted budget date on procurement card transaction verifications and purchase order goods and service lines.

The Supplier Contract field is required if there are any Contract Lines referenced.

Provide a default tax recoverability for the tax applicability

Supplier Item Identifier cannot be changed for catalog items.

Supplier Item Identifiers can be set or updated for lines with no items or having non-catalog items. Catalog Items also have Supplier Item Identifiers, but we cannot change the existing value using this web service. For this web service, the value will be ignored (but will not fire an error) if there is a Web Item (punchout item) associated with the Requisition Line Reference; we will store the Supplier Item Identifier from the Web Item instead.

The Item Reference cannot be entered if the Requisition Line Reference is for a Web Item.

Item Reference is not allowed if there is a Requisition Line Reference for a Web Item. This is because characteristics such as Supplier Item Identifier will be coming from the Web Item and not the Item Reference.

Spend category must have a Spend Category Usage type of Procurement.

Please Enable Multi-Company on Purchase Orders.

The Company on the Requisition Line Reference for this Purchase Order Line must be a valid company for the Purchase Order.

Please enter a company that is in the intercompany profile of the company on the purchase order header.

Lot Serial information on goods lines is supported only for Bill Only purchase orders.

Prepaid, Retention, Due Date and Delivery Type aren't supported on Bill Only Purchase Order Goods lines.

Spend category "[spend category]" is inactive.

For Bill Only purchase orders, if there's a Ship-To Address on the line, it must match the header Ship-To Address, otherwise leave it blank on the line. If there is no header Ship-To Address, then the line Ship-To Address must match the company default shipping address.

Reference to existing worktags. Worktags are a way to mark tasks and business objects to make them easier to access and summarize.

Validation

Description

The following Accounting Worktag types are invalid: [invalid].

The following Accounting Worktag types are invalid: [invalid].

The following Accounting Worktag types are invalid: [invalid].

The [type] is/are not available for use with the company/s: [partitionable] [company]

[worktag value] is not permitted as an allowed value for worktag type: [worktag type], because it is inactive.

The following Accounting Worktags are required but have not been assigned: [missing].

[missing required worktag types on Spend Transactions]

[missing required worktag types on Spend Transactions]

The following Accounting Worktags are required but have not been assigned: [missing].

[missing required worktag types on Spend Transactions]

Select a balancing worktag for Worktags of the following type: [type]

Select a balancing worktag for Worktags of the following type: [type]

The following Accounting Worktags are required but have not been assigned: [missing].

Select a balancing worktag for Worktags of the following type: [type]

Enter a company that matches on the award line in effect for grant: [grant]. This company doesn't match the grant on the award line: [comp].

Validation

Description

Either Quantity must equal zero or not be present or the Extended Amount must equal Quantity * Unit Cost. Currently [Quantity] * [Unit Cost] does not equal [Extended].

Only one worktag for each type is allowed for each document line.

[not allowed worktag types on Business Document Line Split for Spend Transactions]

For requisition line splits tagged with a capital project worktag, the company of the requisition must equal the company on the capital project.

For purchase order line splits tagged with a capital project worktag, the company of the purchase order must equal the company on the capital project.

The Line Split Allocation Reference field should only be used when submitting a purchase order or a procurement card transaction verification. When submitting a purchase order, a Purchase Order Line Split must only reference Requisition Line Splits from the Requisition Line that is related to the current Purchase Order Line.

Use Budget Date on line splits to override the defaulted budget date on procurement card transaction verifications and purchase order goods and service lines.

Reference to existing worktags. Worktags are a way to mark tasks and business objects to make them easier to access and summarize. Each transaction can include one value for each worktag type and is subject to configurable validation when submitted for approval.

Validation

Description

Worktags are not allowed when there are split lines.

The following Accounting Worktag types are invalid: [invalid].

[not allowed worktag types on Spend Transactions]

The [type] is/are not available for use with the company/s: [partitionable] [company]

[worktag value] is not permitted as an allowed value for worktag type: [worktag type], because it is inactive.

Select a balancing worktag for Worktags of the following type: [type]

[missing required worktag types on Spend Transactions]

The following Accounting Worktags are required but have not been assigned: [missing].

Enter a company that matches on the award line in effect for grant: [grant]. This company doesn't match the grant on the award line: [comp].

This field is only enabled for Companies and Tenants which are Opted-In to Consolidate Requisition Lines by Supplier regardless of Supplier Contract.
Use this field to assign a specific Supplier Contract to this Spend Line.

Validation

Description

The Supplier Contract on the Purchase Order Line is invalid. The contract may not allow Manual Purchase Orders, or the Contract is pending changes.

The Supplier Contract on the Document Line is Closed or Pending Close.

Currency for the Supplier Contract on the Purchase Order Line must match Currency for the Purchase Order.

The Supplier Contract selected on the Document Line must be for the Supplier on the Document Header.

Either Quantity must equal zero or not be present or the Extended Amount must equal Quantity * Unit Cost. Currently [Quantity] * [Unit Cost] does not equal [Extended].

Only one worktag for each type is allowed for each document line.

[not allowed worktag types on Business Document Line Split for Spend Transactions]

For requisition line splits tagged with a capital project worktag, the company of the requisition must equal the company on the capital project.

For purchase order line splits tagged with a capital project worktag, the company of the purchase order must equal the company on the capital project.

The Line Split Allocation Reference field should only be used when submitting a purchase order or a procurement card transaction verification. When submitting a purchase order, a Purchase Order Line Split must only reference Requisition Line Splits from the Requisition Line that is related to the current Purchase Order Line.

Use Budget Date on line splits to override the defaulted budget date on procurement card transaction verifications and purchase order goods and service lines.

Validation

Description

Only one worktag for each type is allowed for each document line.

Only one worktag for each type is allowed for each document line.

Project reference is for a project that can be used as a basic worktag only.

Can not have any combination of Project, Project Phase or Project Task worktags for the same line.

The sum of the quantities on the split lines ([split qty]) must equal the quantity of the summary line: [qty]

The sum of the extended amounts on the split lines ([split amt]) must equal the extended amount of the summary line: [amt]

The Supplier Contract Line Reference for this Project-Based Order Line is not for a Project-Based Line.

The Supplier Contract Line has been Canceled and cannot be used.

The Project for the Supplier Contract Line does not match the Project-Based Order Line Project.

The Supplier Contract Line supplier is On Hold and may not be used.

For purchase order lines tagged with a capital project worktag, the company of the purchase order must equal the company on the capital project.

The Requisition Line referenced is from a Requisition that is Closed or Pending Close.

The Requisition Line referenced is from a Requisition that is Closed or Pending Close.

The Supplier Contract field is required if there are any Contract Lines referenced.

The Company on the Requisition Line Reference for this Purchase Order Line must be a valid company for the Purchase Order.

Please Enable Multi-Company on Purchase Orders.

Please enter a company that is in the intercompany profile of the company on the purchase order header.

Reference to an existing purchase item. Specifying the purchase item will default values for the Item Description, Spend Category, Tax Applicability, Unit of Measure, and Unit Cost if these options are defined on the purchase item itself.

Must select a Tax Recoverability for each Tax Rate in the selected Tax Code

Cannot select Recoverable Recoverabilities when using a Non-Taxable Applicability, [applicability]. [SUBJECT TO CHANGE]

Extended_Amount

decimal (18, 3)

[0..1]

The Extended Amount for the Service Order Line. This value must be the same sign as the Requisition Line Reference or zero, if present, and must be positive if there is a Supplier Contract Line Reference, if present.

Due_Date

date

[0..1]

The anticipated date by which the Purchase Order Line should be fulfilled.

Start_Date

date

[0..1]

Start Date

End_Date

date

[0..1]

End Date

Prepaid

boolean

[0..1]

Prepaid flag at the Line level

Validation

Description

The Prepaid Amortization Type is required when the prepaid boolean is set.

This field is only enabled for Companies and Tenants which are Opted-In to Consolidate Requisition Lines by Supplier regardless of Supplier Contract.
Use this field to assign a specific Supplier Contract to this Spend Line.

Validation

Description

The Supplier Contract on the Purchase Order Line is invalid. The contract may not allow Manual Purchase Orders, or the Contract is pending changes.

The Supplier Contract on the Document Line is Closed or Pending Close.

Currency for the Supplier Contract on the Purchase Order Line must match Currency for the Purchase Order.

The Supplier Contract selected on the Document Line must be for the Supplier on the Document Header.

Reference to existing worktags. Worktags are a way to mark tasks and business objects to make them easier to access and summarize. Each transaction can include one value for each worktag type and is subject to configurable validation when submitted for approval.

Validation

Description

[list of worktag types] not valid for this transaction.

The Worktags provided are not valid for this transaction

Worktags are not allowed when there are split lines.

[not allowed worktag types on Spend Transactions]

The [type] is/are not available for use with the company/s: [partitionable] [company]

[worktag value] is not permitted as an allowed value for worktag type: [worktag type], because it is inactive.

[missing required worktag types on Spend Transactions]

Select a balancing worktag for Worktags of the following type: [type]

The following Accounting Worktags are required but have not been assigned: [missing].

Enter a company that matches on the award line in effect for grant: [grant]. This company doesn't match the grant on the award line: [comp].

Either Quantity must equal zero or not be present or the Extended Amount must equal Quantity * Unit Cost. Currently [Quantity] * [Unit Cost] does not equal [Extended].

Only one worktag for each type is allowed for each document line.

[not allowed worktag types on Business Document Line Split for Spend Transactions]

For requisition line splits tagged with a capital project worktag, the company of the requisition must equal the company on the capital project.

For purchase order line splits tagged with a capital project worktag, the company of the purchase order must equal the company on the capital project.

The Line Split Allocation Reference field should only be used when submitting a purchase order or a procurement card transaction verification. When submitting a purchase order, a Purchase Order Line Split must only reference Requisition Line Splits from the Requisition Line that is related to the current Purchase Order Line.

Use Budget Date on line splits to override the defaulted budget date on procurement card transaction verifications and purchase order goods and service lines.

Validation

Description

The Requisition Line referenced is from a Requisition that is Closed or Pending Close.

The Requisition Line referenced is from a Requisition that is Closed or Pending Close.

For purchase order lines tagged with a capital project worktag, the company of the purchase order must equal the company on the capital project.

The Supplier Contract Line supplier is On Hold and may not be used.

The Supplier Contract Line has been Canceled and cannot be used.

Item is from a Supplier Contract that does not accept Manual Purchase Orders.

Item is from a Supplier Contract that does not accept Manual Purchase Orders.

The sum of the extended amounts on the split lines ([split amt]) must equal the extended amount of the summary line: [amt]

Please specify an Item or an Item Description.

Please specify an Item or an Item Description.

Please specify an Item or a Spend Category.

Please specify an Item or a Spend Category.

The Item Reference on the Item Order Line does not match the Procurement Item on the Supplier Contract Line.

Can not have any combination of Project, Project Phase or Project Task worktags for the same line.

Only one worktag for each type is allowed for each document line.

The End Date must be on or after the Start Date

The Supplier Contract Line Reference for this Service Order Line is not for a Service line.

The Requisition Line Reference for this Service Order Line must be for a Service Line.

Catalog items are not allowed on Service Lines.

The Requisition Line Reference requires a RFQ and can not be sourced to Purchase Order.

The Deliver-To Location is invalid for the selected Delivery Type and/or Company.

The Supplier Contract field is required if there are any Contract Lines referenced.

Provide a default tax recoverability for the tax applicability

Extended Amount must be the same sign as the Requisition Line Reference's Extended Amount.

Extended Amount must be greater than zero if from a Service Contract Line Reference.

Please enter a company that is in the intercompany profile of the company on the purchase order header.

Please Enable Multi-Company on Purchase Orders.

The Company on the Requisition Line Reference for this Purchase Order Line must be a valid company for the Purchase Order.

Prepaid, Retention and Due Date aren't supported on Bill Only Purchase Order Service lines.

Spend category "[spend category]" is inactive.

For Bill Only purchase orders, if there's a Ship-To Address on the line, it must match the header Ship-To Address, otherwise leave it blank on the line. If there is no header Ship-To Address, then the line Ship-To Address must match the company default shipping address.

Reference to existing worktags. Worktags are a way to mark tasks and business objects to make them easier to access and summarize. Each transaction can include one value for each worktag type and is subject to configurable validation when submitted for approval.

Taxable_Code_Application_NO_INPUT_Data

This is the reference id value of the tax applicability.
If this is blank and there invoice line has a sales item, Workday will default tax applicability from the sales item. If the invoice line has a tax code then tax applicability is required.

This is the reference id value of the tax code.
If this is blank, Workday will default in the default tax code from the invoice header if there is one. If the invoice line has a tax applicability value, Workday will validate that the invoice line also has a tax code.