Service Directory > v31.2 > Financial_Management > Get_1042-S_Income_Codes
 

Operation: Get_1042-S_Income_Codes

This web service returns data for 1042-S Income Codes. Income Code for 1042-S data includes Withholding Spend Categories or Spend Category Hierarchies for all Income Codes, plus: Income Code, Description, Spend Categories or Spend Category Hierarchies. A single Investor can be returned by supplying a reference ID or Income Code, a number of Income codes by providing Spend Categories and/or Hierarchies or all 1042-S Income Codes can be returned if no criteria is provided.


@ - 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_1042-S_Income_Codes_Request

Contains request reference, criteria, filter for getting 1042-S Income code data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Income_Code_for_1042-S_Request_References  [0..1]  This element is a wrapper for references to 1042-S Income Codes   
Request_Criteria [Choice]   Income_Code_for_1042-S_Request_Criteria  [0..1]  This element contains criteria to find 1042-S Income Codes   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Income_Code_for_1042-S_Response_Group  [0..1]  This element is a wrapper for options to return different data elements in the Response.   
top
 

Response Element: Get_1042-S_Income_Codes_Response

Top-level element containing response data for 1042-S Income Codes meeting request criteria
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Income_Code_for_1042-S_Request_References  [0..1]  This element is a wrapper for references to 1042-S Income Codes   
Request_Criteria  Income_Code_for_1042-S_Request_Criteria  [0..1]  This element contains criteria to find 1042-S Income Codes   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Income_Code_for_1042-S_Response_Group  [0..1]  This element is a wrapper for options to return different data elements in the Response.   
Response_Results  Response_Results  [0..1]  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.   
Response_Data  Income_Code_for_1042-S_Response_Data  [0..1]  Get 1042-S Income Codes Response   
top
 

Income_Code_for_1042-S_Request_References

part of: Get_1042-S_Income_Codes_Request, Get_1042-S_Income_Codes_Response
This element is a wrapper for references to 1042-S Income Codes
 
Parameter name Type/Value Cardinality Description Validations
Income_Code_for_1042-S_Reference  Income_Code_for_1042-SObject  [1..*]  Reference to an Existing 1042-S Income Code   
top
 

Income_Code_for_1042-SObject

part of: Income_Code_for_1042-S_Request_References, Income_Code_for_1042-S
 
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  Income_Code_for_1042-SObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Income_Code_for_1042-SObjectID

part of: Income_Code_for_1042-SObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Income_Code_for_1042-S  [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
 

Income_Code_for_1042-S_Request_Criteria

part of: Get_1042-S_Income_Codes_Request, Get_1042-S_Income_Codes_Response
This element contains criteria to find 1042-S Income Codes
 
Parameter name Type/Value Cardinality Description Validations
Income_Code  string (2)   [0..1]  A 1042-S Income Code.   
Spend_Categories_or_Hierarchies_Reference  Spend_Category_or_HierarchyObject  [0..*]  A List of Spend Categories or Spend Category Hoerarchies attached to 1042-S Income Codes.   
top
 

Spend_Category_or_HierarchyObject

part of: Income_Code_for_1042-S_Request_Criteria, Income_Code_for_1042-S_Data, Income_Code_for_1042-S_Data, Income_Code_for_1042-S_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  Spend_Category_or_HierarchyObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Spend_Category_or_HierarchyObjectID

part of: Spend_Category_or_HierarchyObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Resource_Category_Hierarchy_ID, Spend_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
 

Response_Filter

part of: Get_1042-S_Income_Codes_Request, Get_1042-S_Income_Codes_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
 

Income_Code_for_1042-S_Response_Group

part of: Get_1042-S_Income_Codes_Request, Get_1042-S_Income_Codes_Response
This element is a wrapper for options to return different data elements in the Response.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Flag indicating if the 1042-S Income Code Reference data is to be included in the response.   
top
 

Response_Results

part of: Get_1042-S_Income_Codes_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
 

Income_Code_for_1042-S_Response_Data

part of: Get_1042-S_Income_Codes_Response
Get 1042-S Income Codes Response
 
Parameter name Type/Value Cardinality Description Validations
Income_Code_for_1042-S  Income_Code_for_1042-S  [0..*]  1042-S Income Code Response Data   
top
 

Income_Code_for_1042-S

part of: Income_Code_for_1042-S_Response_Data
1042-S Income Code Response Data
 
Parameter name Type/Value Cardinality Description Validations
Income_Code_for_1042-S_Reference  Income_Code_for_1042-SObject  [0..1]  Reference to an Existing 1042-S Income Code   
Income_Code_for_1042-S_Data  Income_Code_for_1042-S_Data  [0..*]  1042-S Income Code Data 
Validation Description
A Spend Category Hierarchy on this Income Code contains Spend Categories being used in another Income Code.   
 
top
 

Income_Code_for_1042-S_Data

part of: Income_Code_for_1042-S
1042-S Income Code Data
 
Parameter name Type/Value Cardinality Description Validations
Income_Code  string (2)   [0..1]  1042-S Income Code 
Validation Description
Income code must be two digits.   
 
Description  string  [0..1]  1042-S Income Code Description   
Spend_Categories_or_Hierarchies_Reference  Spend_Category_or_HierarchyObject  [0..*]  Spend Categories or Spend Category Hierarchies mapped for Spend to the 1042-S Income Code. 
Validation Description
A Spend Category selected is under a Spend Category Hierarchy also selected for this Income Code.   
A Spend Category for a Spend Category Hierarchy selected is used by an existing Income Code.   
A parent Spend Category Hierarchy for a Spend Category selected is used by an existing Income Code.   
A Spend Category selected is already used by an existing Income Code.   
A Spend Category Hierarchy selected is already used by an existing Income Code.   
Spend Categories or Hierarchies can't be simultaneously used for Income Code and Withholding Mapping.   
 
Federal_Withholding_Spend_Categories_or_Hierarchies_Reference  Spend_Category_or_HierarchyObject  [0..*]  Spend Categories or Spend Category Hierarchies mapped for Federal Withholding to the 1042-S Income Code. 
Validation Description
Spend Categories or Hierarchies may not be simultaneously mapped to State and Federal Withholding.   
 
State_Withholding_Spend_Categories_or_Hierarchies_Reference  Spend_Category_or_HierarchyObject  [0..*]  Spend Categories or Spend Category Hierarchies mapped for State Withholding to the 1042-S Income Code.   
Validation Description
A Spend Category Hierarchy on this Income Code contains Spend Categories being used in another Income Code.   
top
 

Income_Code_for_1042-SReferenceEnumeration

part of: Income_Code_for_1042-SObjectID
Base Type
string
top
 

Spend_Category_or_HierarchyReferenceEnumeration

part of: Spend_Category_or_HierarchyObjectID
Base Type
string
top