Service Directory > v32.1 > Revenue_Management > Get_Sales_Items
 

Operation: Get_Sales_Items

This service operation will add or update Sales Items. Sales items are goods and services which a company sells. Sales Item data includes Sales Item ID, Item Name, Revenue Category, Item Description, Item Identifier, Unit of Measure, Unit Price, Currency, Tax Applicability, Sales Item Group. The request criteria can be for a single transaction based on Reference, or all transaction can be retrieved if no criteria is specified.


@ - A parameter name with this symbol denotes an XML attribute within the document instead of an XML element.


Contents

 

Web Service

 

Request

 

Response

 

Element(s)

 

Request Element: Get_Sales_Items_Request

Contains request reference, criteria, filter and response group for getting Sales Item data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Sales_Item_Request_References  [0..1]  Get Sales Items Request References   
Request_Criteria [Choice]   Sales_Item_Request_Criteria  [0..1]  Get Sales Items Request Criteria   
Response_Filter  Response_Filter  [0..1]  Get Sales Items Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Sales_Item_Response_Group  [0..1]  Get Sales Items Response Group   
top
 

Response Element: Get_Sales_Items_Response

Element containing Sales Item response elements including received criteria, references, data based on criteria and grouping, results filter and result summary
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Sales_Item_Request_References  [0..1]  Get Sales Items Request References   
Request_Criteria  Sales_Item_Request_Criteria  [0..1]  Get Sales Items Request Criteria   
Response_Filter  Response_Filter  [0..1]  Get Sales Items Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Sales_Item_Response_Group  [0..1]  Get Sales Items Response Group   
Response_Results  Response_Results  [0..1]  Get Sales Items Response Results   
Response_Data  Sales_Item_Response_Data  [0..1]  Get Sales Items Response Data   
top
 

Sales_Item_Request_References

part of: Get_Sales_Items_Request, Get_Sales_Items_Response
Element containing reference instances for a Sales Item
 
Parameter name Type/Value Cardinality Description Validations
Sales_Item_Reference  Sales_ItemObject  [1..*]  This is the reference id value of the sales item. If a value is provided for sales item, revenue category will default so it is recommended to provide a value for either sales item or revenue category but not both.   
top
 

Sales_ItemObject

part of: Sales_Item_Data, Sales_Item_Data, Sales_Item_Request_References, Sales_Item
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Sales_ItemObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Sales_ItemObjectID

part of: Sales_ItemObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Sales_Item_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Sales_Item_Request_Criteria

part of: Get_Sales_Items_Request, Get_Sales_Items_Response
Element containing Sales Item request criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Sales_Items_Request, Get_Sales_Items_Response
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.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Sales_Item_Response_Group

part of: Get_Sales_Items_Request, Get_Sales_Items_Response
Element containing Sales Item response grouping options
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

part of: Get_Sales_Items_Response
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.   
Page_Results  decimal (12, 0) >0   [0..1]  Number of Results in current page.   
Page  decimal (12, 0) >0   [0..1]  The page of data that has been returned for the given request.   
top
 

Sales_Item_Response_Data

part of: Get_Sales_Items_Response
Wrapper Element that includes Sales Item Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Sales_Item  Sales_Item  [0..*]  Sales Item   
top
 

Sales_Item

part of: Sales_Item_Response_Data
Wrapper Element that includes Sales Item Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Sales_Item_Reference  Sales_ItemObject  [0..1]  This is the reference id value of the sales item. If a value is provided for sales item, revenue category will default so it is recommended to provide a value for either sales item or revenue category but not both.   
Sales_Item_Data  Sales_Item_Data  [0..1]  Sales Item Data 
Validation Description
If the Item Unit Price, VSOE Price, Esitmated Selling Price, or Third Party Evidence is specified, then the Currency must also be specified.   
Revenue Category is required field except for Sales Item that is a basic worktag only.   
Only the Sales Item Name, Inactive, and Basic Worktag Only attributes can be entered for a Sales Item that is a basic worktag only.   
Can not update an existing Sales Item with detail information to be a basic worktag only Sales Item.   
Only one of VSOE Price, Third Party Evidence, or Estimated Selling Price may be populated.  Only one of VSOE Price, Third Party Evidence, or Estimated Selling Price may be populated. 
Some of the Worktag Types of the Worktags selected are not valid for Sales Item.   
Only one worktag of each type is allowed   
Cannot use inactive Revenue Category   
An inactive purchase item cannot map to a sales item.   
Purchase Item is already mapped by another Sales Item.   
An inactive sales item cannot map to a purchase item.   
Remove the Purchase item mapping before you inactivate the item   
Required worktag type(s) are missing.  Required worktag type(s) are missing. 
You can’t enter a Sales Item Bundle as part of this bundle.   
Sales Items To Include In Bundle must have at least 1 sales item.   
You can't delete these sales items because they are in use on one or more active or complete contract lines: [sales items].   
For sales item bundles, the Contract Line Type must be Fixed Amount – Billing Only.   
You can't have a value in the Sales Item to Include In Bundle field unless you select the Is a Bundle flag.   
You can't mark a sales item bundle as Fulfillment Required.   
When you select the Fulfillment Required check box, you can only select [lines]   
You can't remove the Order Fulfillment flag for the sales item because it is in use on one or more active or completed customer contract lines.   
For the [types] Sales Item Group Type(s), the sales item can’t belong to multiple groups within the same group type. The following sales item groups belong to the same group type: [groups].   
Select a Revenue Treatment of Deferred or Accrued if the Contract Line Type is Fixed Amount - Billing Only or Fixed Amount - Revenue Only.   
Enter a valid Revenue Treatment of Invoice, Deferred, or Accrued.   
Select a Revenue Treatment of Deferred or Accrued for your sales item bundle.   
 
top
 

Sales_Item_Data

part of: Sales_Item
Element containing all Sales Item data
 
Parameter name Type/Value Cardinality Description Validations
Sales_Item_ID  string  [0..1]  Sales Item ID. This is the Sales Item unique identifier   
Item_Name  string  [1..1]  Free form text for a meaningful Sales Item Name   
Alternate_Name  string  [0..1]  Free form text to provide Alternate Name for Sales Item   
Inactive  boolean  [0..1]  Boolean to indicate a Sales Item that is Inactive.   
Worktag_Only  boolean  [0..1]  Boolean to indicate if the sales item is only used as a worktag value. If set to true, the sales item will not be available as a selection in sales item fields on financial transactions like Customer Invoices.   
Revenue_Category_Reference  Revenue_CategoryObject  [0..1]  Reference to an existing Spend Category. A Spend Category is a classification of items and services that drive the accounting. All sales items are associated with a Revenue Category and expense items are associated with a Spend Category.   
Item_Description  string  [0..1]  Free form text providing a detailed Item Description   
Item_Identifier  string  [0..1]  Free form text for an Item Identifier. This is not a Workday Reference ID   
Unit_of_Measure_Reference  Unit_of_MeasureObject  [0..1]  Reference to an existing Unit of Measure   
Unit_of_Measure_2_Reference  Unit_of_MeasureObject  [0..1]  Reference to an existing Unit of Measure. This reference is for the secondary Unit of Measure for the item, usually a measure of time, such as hours or months. 
Validation Description
Unit of Measure 2 can only be provided if the first Unit of Measure is provided.  Unit of Measure 2 can only be provided if the first Unit of Measure is provided. 
 
Enable_Bulk_Quantity_Pricing  boolean  [0..1]  Enable Bulk Pricing Flag.Possible Values Y/N.   
Item_Unit_Price  decimal (26, 6)   [0..1]  Item Unit Price 
Validation Description
When Contract Line Type is Variable and there is a Unit Price, Unit of Measure is not expected to be blank.  When Contract Line Type is Variable and there is a Unit Price, Unit of Measure is not expected to be blank. 
Unit Price must be greater than or equal to zero.   
 
Currency_Reference  CurrencyObject  [0..1]  Reference to the currency of the company. If entered, this field is not processed on inbound Workday Web Services requests.   
UOM_Priced_at_Quantities_of  decimal (18, 0) >0   [0..1]  Bulk Quantity Divisor for Quantity   
Tax_Applicability_Reference  Tax_ApplicabilityObject  [0..1]  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.   
Sales_Item_Group_Reference  Sales_Item_GroupObject  [0..*]  Reference to an existing Sales Item Group   
Project_Template_Reference  Project_TemplateObject  [0..1]  Reference to an existing Project Template.   
Revenue_Treatment_Reference  Revenue_TreatmentObject  [0..1]  Revenue Treatment (Invoice, Deferred, or Accrued) on Customer Contract Line.   
Revenue_Recognition_Schedule_Template_Reference  Revenue_Recognition_Schedule_TemplateObject  [0..1]  Reference to an existing Revenue Recognition Schedule Template. 
Validation Description
Select a Revenue Treatment of Deferred or Accrued if a Revenue Recognition Schedule Template.   
 
Revenue_Recognition_Method_Reference  Schedule_Distribution_MethodObject  [0..1]  Returns the Revenue Recognition Method related to the Sales Item.   
VSOE_Price  decimal (26, 6) >0   [0..1]  The amount for VSOE Price for the Sales Item.   
Third_Party_Evidence  decimal (26, 6) >0   [0..1]  The amount for Third Party Evidence for the Sales Item.   
Estimated_Selling_Price  decimal (26, 6) >0   [0..1]  The amount for Esitmated Selling Price for the Sales Item.   
Price_Type_Reference  Contract_Line_TypeObject  [0..1]  References the amount type of the Sales Item. Indicates if it is a Fixed Amount, Recurring, or Activity-Based.   
Related_Worktags_Data  Related_Worktag_Widget_Data  [0..1]  Reference to the existing Allowed or Default Related Worktags. 
Validation Description
[missing required worktag types]   
[One of Project OR Project Plan Phase OR Project Plan Task Allowed]   
 
Maps_to_Purchase_Item_Reference  Purchase_ItemObject  [0..1]  Reference to Purchase Item being mapped.   
Is_a_Bundle  boolean  [0..1]  Sales Item Bundle Flag 
Validation Description
This sales item can’t be a bundle because it’s already part of another bundle.   
 
Sales_Item_To_Include_In_Bundle_Reference  Sales_ItemObject  [0..*]  Sales Item bundle   
Sales_Item_Bundle_Reference  Sales_ItemObject  [0..*]  Bundled Sales Item   
Fulfillment_Required  boolean  [0..1]  Fulfillment Required   
Renewable  boolean  [0..1]  Sales Item Renewable   
Validation Description
If the Item Unit Price, VSOE Price, Esitmated Selling Price, or Third Party Evidence is specified, then the Currency must also be specified.   
Revenue Category is required field except for Sales Item that is a basic worktag only.   
Only the Sales Item Name, Inactive, and Basic Worktag Only attributes can be entered for a Sales Item that is a basic worktag only.   
Can not update an existing Sales Item with detail information to be a basic worktag only Sales Item.   
Only one of VSOE Price, Third Party Evidence, or Estimated Selling Price may be populated.  Only one of VSOE Price, Third Party Evidence, or Estimated Selling Price may be populated. 
Some of the Worktag Types of the Worktags selected are not valid for Sales Item.   
Only one worktag of each type is allowed   
Cannot use inactive Revenue Category   
An inactive purchase item cannot map to a sales item.   
Purchase Item is already mapped by another Sales Item.   
An inactive sales item cannot map to a purchase item.   
Remove the Purchase item mapping before you inactivate the item   
Required worktag type(s) are missing.  Required worktag type(s) are missing. 
You can’t enter a Sales Item Bundle as part of this bundle.   
Sales Items To Include In Bundle must have at least 1 sales item.   
You can't delete these sales items because they are in use on one or more active or complete contract lines: [sales items].   
For sales item bundles, the Contract Line Type must be Fixed Amount – Billing Only.   
You can't have a value in the Sales Item to Include In Bundle field unless you select the Is a Bundle flag.   
You can't mark a sales item bundle as Fulfillment Required.   
When you select the Fulfillment Required check box, you can only select [lines]   
You can't remove the Order Fulfillment flag for the sales item because it is in use on one or more active or completed customer contract lines.   
For the [types] Sales Item Group Type(s), the sales item can’t belong to multiple groups within the same group type. The following sales item groups belong to the same group type: [groups].   
Select a Revenue Treatment of Deferred or Accrued if the Contract Line Type is Fixed Amount - Billing Only or Fixed Amount - Revenue Only.   
Enter a valid Revenue Treatment of Invoice, Deferred, or Accrued.   
Select a Revenue Treatment of Deferred or Accrued for your sales item bundle.   
top
 

Revenue_CategoryObject

part of: Sales_Item_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Revenue_CategoryObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Revenue_CategoryObjectID

part of: Revenue_CategoryObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Revenue_Category_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Unit_of_MeasureObject

part of: Sales_Item_Data, Sales_Item_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Unit_of_MeasureObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Unit_of_MeasureObjectID

part of: Unit_of_MeasureObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, UN_CEFACT_Common_Code_ID, UOM_EDI_Code_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

CurrencyObject

part of: Sales_Item_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  CurrencyObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

CurrencyObjectID

part of: CurrencyObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Currency_ID, Currency_Numeric_Code  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Tax_ApplicabilityObject

part of: Sales_Item_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Tax_ApplicabilityObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Tax_ApplicabilityObjectID

part of: Tax_ApplicabilityObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Tax_Applicability_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Sales_Item_GroupObject

part of: Sales_Item_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Sales_Item_GroupObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Sales_Item_GroupObjectID

part of: Sales_Item_GroupObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Sales_Item_Group_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Project_TemplateObject

part of: Sales_Item_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Project_TemplateObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Project_TemplateObjectID

part of: Project_TemplateObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Project_Template_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Revenue_TreatmentObject

part of: Sales_Item_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Revenue_TreatmentObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Revenue_TreatmentObjectID

part of: Revenue_TreatmentObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Revenue_Treatment_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Revenue_Recognition_Schedule_TemplateObject

part of: Sales_Item_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Revenue_Recognition_Schedule_TemplateObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Revenue_Recognition_Schedule_TemplateObjectID

part of: Revenue_Recognition_Schedule_TemplateObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Revenue_Recognition_Schedule_Template_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Schedule_Distribution_MethodObject

part of: Sales_Item_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Schedule_Distribution_MethodObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Schedule_Distribution_MethodObjectID

part of: Schedule_Distribution_MethodObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Schedule_Distribution_Method_Reference_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Contract_Line_TypeObject

part of: Sales_Item_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Contract_Line_TypeObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Contract_Line_TypeObjectID

part of: Contract_Line_TypeObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Contract_Line_Type_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Related_Worktag_Widget_Data

part of: Sales_Item_Data
Reference to the existing Allowed or Default Related Worktags.
 
Parameter name Type/Value Cardinality Description Validations
@Replace_All  boolean  [1..1]  All existing related worktags (both allowed and default) are replaced with the ones specified in the request. It will supersede any "remove all" or delete option set to True by worktag type. When True, a default value must be provided for all worktag types that are configured with 'Default Required' in the 'Maintain Related Worktag Usage'.   
Related_Worktags_by_Type_Data  Related_Worktags_by_Worktag_Type_Data  [0..*]  Allowed and Default Related Worktags Data by Worktag Type. 
Validation Description
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote] you cannot specify allowed values as they are not enabled in ‘Maintain Related Worktag Usage’.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], Default Worktag field is "Required".   
Worktag Type: [AWT] is not allowed for Taggable Type: [TT]   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], Delete Allowed Value cannot be 'Y' when all allowed values are being replaced.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], when default value and allowed values are being replaced, allowed values in file must be empty or include default value specified in file.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], when allowed values are being replaced but existing default value is not being replaced or deleted, allowed values in file must be empty or include existing default value.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], you cannot have a 'Default Value' on more than one row.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], when default value is being replaced, persisted allowed values must be empty or include default value specified in file.   
 
Validation Description
[missing required worktag types]   
[One of Project OR Project Plan Phase OR Project Plan Task Allowed]   
top
 

Related_Worktags_by_Worktag_Type_Data

part of: Related_Worktag_Widget_Data
Allowed and Default Related Worktags Data by Worktag Type.
 
Parameter name Type/Value Cardinality Description Validations
Worktag_Type_Reference  Accounting_Worktag_TypeObject  [0..1]  The Worktag Type Reference ID cannot be duplicated within one request. Valid ID types for all worktag types that can be configured for a related worktag taggable type may include: BUSINESS_SITE, BUSINESS_UNIT, COST_CENTER, CUSTOM_ORGANIZATION_01-10, CUSTOM_WORKTAG_1-10, FUND, GIFT, GRANT, INVESTOR, OPPORTUNITY, PROGRAM, PROJECT, PROJECT_PHASE, PROJECT_TASK, REGION, SALES_ITEM.   
Required_On_Transaction  boolean  [0..1]  Boolean to indicate if the Worktag Type will be required on a transaction when a value for the worktag type that has related values is entered.   
Required_On_Transaction_For_Validation  boolean  [0..1]  Boolean to indicate if 'Required on Transaction' is enabled in either 'Maintain Related Worktag Usage' or on the Worktag instance. When you generate an EIB template with data, 'y' is returned when either boolean is true. This boolean is informational only in the 'Put' operation.   
Default_Worktag_Data  Default_Worktag_Data  [0..1]  Reference to existing Default Realted Worktag or Add new Default Related Worktag 
Validation Description
Worktag Type of Default Worktag "[AW]" does not match the Worktag Type: "[WT]".   
Worktag Aggregation Dimension: '[wt]' is not allowed in the default worktag field.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], Delete Default Value cannot be 'Y' when a default is required or the default value is not the existing value or if its blank.   
For [T-New Instance] '[TT]'[colon] [squote][T][squote]: Default value "[AWT]:[AW]" does not allow [Default Text Singular or Plural]: [Target Worktags].   
'[worktag value]' is not permitted as the default value for worktag type: [worktag type] because it is inactive.   
[concatenated validation message for constraint provider]   
 
Replace_All_Allowed_Values  boolean  [0..1]  Boolean to indicate that all existing allowed values are to be deleted. When set to true ('y' in EIB), if allowed values are also specified, they will become the new set of allowed values.   
Allowed_Worktag_Data  Allowed_Worktag_Data  [0..*]  Reference to existing Allowed Related Worktags or Add new Allowed Related Worktags 
Validation Description
Worktag Type of Allowed Worktag "[AW]" does not match the Worktag Type: "[WT]"   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], an allowed value must be specified when Delete Allowed Value = 'Y'.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], specified default value must match an existing allowed value.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], when existing default value is being replaced, default value in file must match an allowed value in file or an existing allowed value   
'[worktag value]' is not permitted as an allowed value for worktag type: [worktag type] because it is inactive.   
[concatenated validation message for constraint provider]   
 
Validation Description
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote] you cannot specify allowed values as they are not enabled in ‘Maintain Related Worktag Usage’.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], Default Worktag field is "Required".   
Worktag Type: [AWT] is not allowed for Taggable Type: [TT]   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], Delete Allowed Value cannot be 'Y' when all allowed values are being replaced.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], when default value and allowed values are being replaced, allowed values in file must be empty or include default value specified in file.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], when allowed values are being replaced but existing default value is not being replaced or deleted, allowed values in file must be empty or include existing default value.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], you cannot have a 'Default Value' on more than one row.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], when default value is being replaced, persisted allowed values must be empty or include default value specified in file.   
top
 

Accounting_Worktag_TypeObject

part of: Related_Worktags_by_Worktag_Type_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Accounting_Worktag_TypeObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Accounting_Worktag_TypeObjectID

part of: Accounting_Worktag_TypeObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Accounting_Worktag_Type_ID, Worktag_Type_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Default_Worktag_Data

part of: Related_Worktags_by_Worktag_Type_Data
Reference to existing Default Realted Worktag or Add new Default Related Worktag
 
Parameter name Type/Value Cardinality Description Validations
@Delete_Default_Value  boolean  [1..1]  Boolean to indicate if existing default value is to be deleted. The existing default value must be correctly specified. Do not set to true (or 'y' in EIB) to replace the existing default value.   
Default_Worktag_Reference  Accounting_Worktag_and_Aggregation_DimensionObject  [0..1]  IMPORTANT: You must check 'Separate Type Column' for this field in your EIB template to see values when you generate a template with data or to configure related worktags for multiple worktag types. The list of valid ID types for this column exceeds the size limit of an Excel validation list so ID types must be entered as text. Valid ID types for this column may include: Business_Unit_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Custom_Worktag_1-5_ID, Custom_Worktag_06-15_ID, Fund_ID, Gift_Reference_ID, Grant_ID, Investor_ID, Location_ID, Opportunity_Reference_ID, Organization_Reference_ID, Program_ID, Project_ID, Project_Phase_Name_ID, Project_Task_Name_ID, Region_Reference_ID, Sales_Item_Group_ID, Sales_Item_ID.   
Validation Description
Worktag Type of Default Worktag "[AW]" does not match the Worktag Type: "[WT]".   
Worktag Aggregation Dimension: '[wt]' is not allowed in the default worktag field.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], Delete Default Value cannot be 'Y' when a default is required or the default value is not the existing value or if its blank.   
For [T-New Instance] '[TT]'[colon] [squote][T][squote]: Default value "[AWT]:[AW]" does not allow [Default Text Singular or Plural]: [Target Worktags].   
'[worktag value]' is not permitted as the default value for worktag type: [worktag type] because it is inactive.   
[concatenated validation message for constraint provider]   
top
 

Accounting_Worktag_and_Aggregation_DimensionObject

part of: Allowed_Worktag_Data, Default_Worktag_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Accounting_Worktag_and_Aggregation_DimensionObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Accounting_Worktag_and_Aggregation_DimensionObjectID

part of: Accounting_Worktag_and_Aggregation_DimensionObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Academic_Level_ID, Academic_Period_ID, Academic_Person_ID, Academic_Unit_ID, Ad_hoc_Payee_ID, Alternate_Supplier_Contract_ID, Applicant_ID, Asset_Adjustment_Reason_Reference_ID, Asset_Adjustment_Type_Reference_ID, Asset_Impairment_Reason_ID, Bank_Account_ID, Business_Asset_Cost_Adjustment_Reason_ID, Business_Unit_Hierarchy_ID, Business_Unit_ID, Calculation_Compensation_Basis_ID, Cash_Activity_Category_ID, Catalog_Item_ID, Company_Reference_ID, Compensation_Basis_ID, Compensation_Grade_ID, Contingent_Worker_ID, Contingent_Worker_Type_ID, Corporate_Credit_Card_Account_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Custom_Worktag_06_ID, Custom_Worktag_07_ID, Custom_Worktag_08_ID, Custom_Worktag_09_ID, Custom_Worktag_1_ID, Custom_Worktag_10_ID, Custom_Worktag_11_ID, Custom_Worktag_12_ID, Custom_Worktag_13_ID, Custom_Worktag_14_ID, Custom_Worktag_15_ID, Custom_Worktag_2_ID, Custom_Worktag_3_ID, Custom_Worktag_4_ID, Custom_Worktag_5_ID, Customer_Category_ID, Customer_Contract_Alternate_Reference_ID, Customer_Contract_Reference_ID, Customer_Group_ID, Customer_ID, Customer_Reference_ID, Deduction_Code, Deduction_Recipient_ID, Donor_ID, Earning_Code, Employee_ID, Employee_Type_ID, Ethnicity_ID, Expense_Item_Group_ID, Expense_Item_ID, External_Committee_Member_ID, Financial_Aid_Award_Year_ID, Financial_Institution_ID, Financial_Institution_Reference_ID, Fund_Hierarchy_ID, Fund_ID, Funding_Source_Name, Gender_Code, Gift_Hierarchy_ID, Gift_Reference_ID, Grant_Hierarchy_ID, Grant_ID, Internal_Service_Provider_ID, Internal_Service_Provider_Reference_ID, Investment_Pool_ID, Investment_Profile_ID, Investor_ID, Is_Manager_ID, Is_People_Manager, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_Code, Job_Category_ID, Job_Family_Group_ID, Job_Family_ID, Job_Level_ID, Job_Profile_ID, Job_Requisition_ID, Lease_Expense_Recognition_ID, Loan_ID, Location_ID, Management_Level_ID, NI_Category_Letter, Object_Class_ID, Opportunity_Reference_ID, Organization_Reference_ID, Pay_Rate_Type_ID, Payroll_Federal_Authority_Tax_Code, Payroll_Income_Code, Payroll_Local_City_Authority_Tax_Code, Payroll_Local_County_Authority_Tax_Code, Payroll_Local_Other_Authority_Tax_Code, Payroll_Local_School_District_Authority_Tax_Code, Payroll_State_Authority_Tax_Code, Petty_Cash_Account_ID, Position_ID, Position_Time_Type_ID, Program_Hierarchy_ID, Program_ID, Program_of_Study_ID, Project_Hierarchy_ID, Project_ID, Project_Plan_ID, Proposal_Grant_ID, Prospect_ID, Prospect_Reference_ID, Purchase_Item_Group_ID, Purchase_Item_ID, Receivable_Writeoff_Reason_ID, Region_Reference_ID, Resource_Category_Hierarchy_ID, Revenue_Category_Hierarchy_ID, Revenue_Category_ID, Rubric_Value_ID, Run_Category_ID, Salary_Over_The_Cap_Type_ID, Sales_Item_Group_ID, Sales_Item_ID, Spend_Category_ID, Sponsor_ID, Sponsor_Reference_ID, Sponsor_Type_ID, Student_Application_Residency_Status_ID, Student_Award_Item_ID, Student_Charge_Item_ID, Student_Course_ID, Student_Course_Section_ID, Student_ID, Student_Recruiting_Campaign_ID, Student_Recruiting_Event_ID, Student_Sponsor_Contract_ID, Student_Waiver_Item_ID, Supplier_Category_ID, Supplier_Contract_ID, Supplier_Group_ID, Supplier_ID, Supplier_Reference_ID, Tax_Applicability_ID, Tax_Authority_ID, Tax_Authority_Reference_ID, Tax_Category_ID, Tax_Code_ID, Tax_Point_Date_Type_ID, Tax_Rate_ID, Tax_Recoverability_Object_ID, Third_Party_ID, Withholding_Order_Case_ID, Withholding_Tax_Code_ID, Withholding_Tax_Rate_ID, Work_Function_ID, Work_Shift_ID, Workday_Deduction_Code, Workday_Earning_Code, Worker_Type_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Allowed_Worktag_Data

part of: Related_Worktags_by_Worktag_Type_Data
Reference to existing Allowed Related Worktags or Add new Allowed Related Worktags
 
Parameter name Type/Value Cardinality Description Validations
@Delete_Allowed_Value  boolean  [1..1]  Boolean to indicate that specified allowed values are to be deleted. At least 1 existing allowed value must be specified When set to true (or 'y' in EIB). Cannot be set to true if 'Replace All Allowed Values' is set to true.   
Allowed_Worktag_Reference  Accounting_Worktag_and_Aggregation_DimensionObject  [0..1]  IMPORTANT: You must check 'Separate Type Column' for this field in your EIB template to see values when you generate a template with data or to configure related worktags for multiple worktag types. The list of valid ID types for this column exceeds the size limit of an Excel validation list so ID types must be entered as text. Valid ID types for this column may include: Business_Unit_Hierarchy_ID, Business_Unit_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Custom_Worktag_1-5_ID, Custom_Worktag_06-15_ID, Fund_Hierarchy_ID, Fund_ID, Gift_Hierarchy_ID, Gift_Reference_ID, Grant_Hierarchy_ID, Grant_ID, Investor_ID, Location_ID, Opportunity_Reference_ID, Organization_Reference_ID, Program_Hierarchy_ID, Program_ID, Project_Hierarchy_ID, Project_ID, Project_Phase_Name_ID, Project_Task_Name_ID, Region_Reference_ID, Sales_Item_Group_ID, Sales_Item_ID.   
Validation Description
Worktag Type of Allowed Worktag "[AW]" does not match the Worktag Type: "[WT]"   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], an allowed value must be specified when Delete Allowed Value = 'Y'.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], specified default value must match an existing allowed value.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], when existing default value is being replaced, default value in file must match an allowed value in file or an existing allowed value   
'[worktag value]' is not permitted as an allowed value for worktag type: [worktag type] because it is inactive.   
[concatenated validation message for constraint provider]   
top
 

Purchase_ItemObject

part of: Sales_Item_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Purchase_ItemObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Purchase_ItemObjectID

part of: Purchase_ItemObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Purchase_Item_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Sales_ItemReferenceEnumeration

part of: Sales_ItemObjectID
Base Type
string
top
 

Revenue_CategoryReferenceEnumeration

part of: Revenue_CategoryObjectID
Base Type
string
top
 

Unit_of_MeasureReferenceEnumeration

part of: Unit_of_MeasureObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Tax_ApplicabilityReferenceEnumeration

part of: Tax_ApplicabilityObjectID
Base Type
string
top
 

Sales_Item_GroupReferenceEnumeration

part of: Sales_Item_GroupObjectID
Base Type
string
top
 

Project_TemplateReferenceEnumeration

part of: Project_TemplateObjectID
Base Type
string
top
 

Revenue_TreatmentReferenceEnumeration

part of: Revenue_TreatmentObjectID
Base Type
string
top
 

Revenue_Recognition_Schedule_TemplateReferenceEnumeration

part of: Revenue_Recognition_Schedule_TemplateObjectID
Base Type
string
top
 

Schedule_Distribution_MethodReferenceEnumeration

part of: Schedule_Distribution_MethodObjectID
Base Type
string
top
 

Contract_Line_TypeReferenceEnumeration

part of: Contract_Line_TypeObjectID
Base Type
string
top
 

Accounting_Worktag_TypeReferenceEnumeration

part of: Accounting_Worktag_TypeObjectID
Base Type
string
top
 

Accounting_Worktag_and_Aggregation_DimensionReferenceEnumeration

part of: Accounting_Worktag_and_Aggregation_DimensionObjectID
Base Type
string
top
 

Purchase_ItemReferenceEnumeration

part of: Purchase_ItemObjectID
Base Type
string
top