Service Directory > v31.2 > Payroll > Get_Payroll_Federal_W-4_Tax_Election
 

Operation: Get_Payroll_Federal_W-4_Tax_Election

This web service operation is designed to get worker federal W-4 tax election data from either the Reference ID or the Worker Reference/Company Reference/Effective Date.


@ - 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_Payroll_Federal_W-4_Tax_Elections_Request

Element to hold all Payroll Payee W-4 Request Information
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Payroll_Federal_W-4_Tax_Election_Request_References  [0..1]  Element to hold all Payroll Payee Request References   
Request_Criteria [Choice]   Payroll_Federal_W-4_Tax_Election_Request_Criteria  [0..1]  Element to hold all criteria used to select which W-4s to return   
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  Payroll_Federal_W-4_Tax_Election_Response_Group  [0..1]  Element to hold all information about the Payroll Payee W-4 Response Group   
top
 

Response Element: Get_Payroll_Federal_W-4_Tax_Elections_Response

Get Payroll Payee W-4s Response Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Payroll_Federal_W-4_Tax_Election_Request_References  [0..1]  All W-4s to get from their References   
Request_Criteria  Payroll_Federal_W-4_Tax_Election_Request_Criteria  [0..1]  All criteria used to specify which W-4(s) to get   
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  Payroll_Federal_W-4_Tax_Election_Response_Group  [0..1]  Specifies how to group the W-4s that are returned   
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  Payroll_Federal_W-4_Tax_Election_Response_Data  [0..1]  Information to show for each W-4 returned   
top
 

Payroll_Federal_W-4_Tax_Election_Request_References

part of: Get_Payroll_Federal_W-4_Tax_Elections_Request, Get_Payroll_Federal_W-4_Tax_Elections_Response
Element to hold all Payroll Payee Request References
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Payee_W-4_Reference  Unique_IdentifierObject  [1..*]  All Payroll Payee W-4s from the references given   
top
 

Unique_IdentifierObject

part of: Payroll_Federal_W-4_Tax_Election_Request_References, Payroll_Federal_W-4_Tax_Election
 
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  Unique_IdentifierObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Unique_IdentifierObjectID

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

Payroll_Federal_W-4_Tax_Election_Request_Criteria

part of: Get_Payroll_Federal_W-4_Tax_Elections_Request, Get_Payroll_Federal_W-4_Tax_Elections_Response
Element to hold all criteria used to select which W-4s to return
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [0..*]  a) If no Worker, it would return data for ALL workers for the specified company. b) Or they could do a multi on worker and get data for multiple workers at once.   
Company_Reference  CompanyObject  [0..1]  If specified, only Federal W-4 Tax Elections for this Company will be returned. If not specified, elections for each Company (that exists) will be returned.   
Effective_As_Of  date  [0..1]  Effective Date of the Federal W-4 Tax Election. The Tax Election that is in Effect as of the Effective As Of (for specified Company if entered, else all Companies) will be returned. If no Effective As Of date specified, all tax elections will be returned.   
top
 

WorkerObject

part of: Payroll_Federal_W-4_Tax_Election_Request_Criteria, Payroll_Federal_W-4_Tax_Election_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  WorkerObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

WorkerObjectID

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

CompanyObject

part of: Payroll_Federal_W-4_Tax_Election_Request_Criteria, Payroll_Federal_W-4_Tax_Election_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  CompanyObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

CompanyObjectID

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

Response_Filter

part of: Get_Payroll_Federal_W-4_Tax_Elections_Request, Get_Payroll_Federal_W-4_Tax_Elections_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
 

Payroll_Federal_W-4_Tax_Election_Response_Group

part of: Get_Payroll_Federal_W-4_Tax_Elections_Request, Get_Payroll_Federal_W-4_Tax_Elections_Response
Element to hold all information about the Payroll Payee W-4 Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference Boolean   
top
 

Response_Results

part of: Get_Payroll_Federal_W-4_Tax_Elections_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
 

Payroll_Federal_W-4_Tax_Election_Response_Data

part of: Get_Payroll_Federal_W-4_Tax_Elections_Response
Element to hold all data to Respond with about the Payroll Payee W-4s
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Federal_W-4_Tax_Election  Payroll_Federal_W-4_Tax_Election  [0..*]  Element to hold all information about a Payroll Payee W-4   
top
 

Payroll_Federal_W-4_Tax_Election

part of: Payroll_Federal_W-4_Tax_Election_Response_Data
Element to hold all information about a Payroll Payee W-4
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Payee_W-4_Reference  Unique_IdentifierObject  [0..1]  "This" instance of the W-4 returned   
Payroll_Federal_W-4_Tax_Election_Data  Payroll_Federal_W-4_Tax_Election_Data  [0..1]  Element to hold all of the Data to Put or Get for a W-4 
Validation Description
Marital Status must be valid for Payroll Tax Authority.   
Exempt from NRA Additional Amount may only be True if Nonresident Alien is also True.   
Assign the worker to a pay group before adding tax elections.   
The Company specified is not valid for the Worker.   
 
top
 

Payroll_Federal_W-4_Tax_Election_Data

part of: Payroll_Federal_W-4_Tax_Election
Element to hold all of the Data to Put or Get for a W-4
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [1..1]  Worker the W-4 is for   
Effective_as_of  date  [1..1]  The Effective date of the W-4   
Company_Reference  CompanyObject  [1..1]  The Company the W-4 is for   
Marital_Status_Reference  Payroll_Withholding_StatusObject  [0..1]  The Marital Status of the Worker that the W-4 is for   
Number_of_Allowances  decimal (5, 0) >0   [0..1]  The Number of Allowances on the W-4   
Additional_Amount  decimal (8, 2) >0   [0..1]  Additional Amount on the W-4   
Exempt  boolean  [0..1]  Exempt Indicator on the W-4   
Nonresident_Alien  boolean  [0..1]  Nonresident Alien Indicator on the W-4   
Exempt_from_NRA_Additional_Amount  boolean  [0..1]  New attribute, Exempt from NRA Additional Amount, added in W19. If worker is a Nonresident Alien, use this attribute to indicate whether the worker is subject to NRA Additional Amount.   
Lock_In_Letter  boolean  [0..1]  Lock in Letter Indicator on the W-4   
No_Wage_No_Tax  boolean  [0..1]  No Wage/No Tax Indicator on the W-4   
Validation Description
Marital Status must be valid for Payroll Tax Authority.   
Exempt from NRA Additional Amount may only be True if Nonresident Alien is also True.   
Assign the worker to a pay group before adding tax elections.   
The Company specified is not valid for the Worker.   
top
 

Payroll_Withholding_StatusObject

part of: Payroll_Federal_W-4_Tax_Election_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  Payroll_Withholding_StatusObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Payroll_Withholding_StatusObjectID

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

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Payroll_Withholding_StatusReferenceEnumeration

part of: Payroll_Withholding_StatusObjectID
Base Type
string
top