Service Directory > v32.1 > Payroll > Get_EFW2_Year_End_Worker_Filing_Data
 

Operation: Get_EFW2_Year_End_Worker_Filing_Data

Exposes the worker W-2 year end data for integration with the Social Security Administration (SSA) or other filing system. It is recommended that integrations do not reference box numbers when searching for specific box amounts. For example, search on the string "Allocated tips" instead of the string "8 - Allocated tips". This is because over time box numbers may change.


@ - 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_EFW2_Year_End_Worker_Filing_Data_Request

EFW2 Year End Worker Filing Data Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  EFW2_Year_End_Worker_Filing_Data_Request_Criteria  [1..1]  Request Criteria   
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. 
 
top
 

Response Element: Get_EFW2_Year_End_Worker_Filing_Data_Response

Response Data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  EFW2_Year_End_Worker_Filing_Data_Request_Criteria  [1..1]  Request Criteria   
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_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  EFW2_Year_End_Worker_Filing_Response_Data  [0..1]  Response Data   
top
 

EFW2_Year_End_Worker_Filing_Data_Request_Criteria

part of: Get_EFW2_Year_End_Worker_Filing_Data_Request, Get_EFW2_Year_End_Worker_Filing_Data_Response
Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
Company_Reference  CompanyObject  [1..1]  Company Reference   
Calendar_Year_Reference  Calendar_YearObject  [1..1]  Calendar Year   
Include_All_Workers  boolean  [0..1]  When set to 1, data for all workers will be included in the response. When set to 0, data for workers who haven't opted in of having their data automatically sent to tax preparation vendors will not be included in the response. This boolean value should be set to 1 when the data from this web service is being sent to the Social Security Administration. It should be set to 0 when the data is being sent to tax preparation vendors.   
top
 

CompanyObject

part of: EFW2_Year_End_Worker_Filing_Data_Request_Criteria
 
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
 

Calendar_YearObject

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

Calendar_YearObjectID

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

Response_Results

part of: Get_EFW2_Year_End_Worker_Filing_Data_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
 

EFW2_Year_End_Worker_Filing_Response_Data

part of: Get_EFW2_Year_End_Worker_Filing_Data_Response
Response Data
 
Parameter name Type/Value Cardinality Description Validations
EFW2_Year_End_Worker_Filing  EFW2_Year_End_Worker_Filing  [0..*]  Response data for W-2   
top
 

EFW2_Year_End_Worker_Filing

part of: EFW2_Year_End_Worker_Filing_Response_Data
Response data for W-2
 
Parameter name Type/Value Cardinality Description Validations
W-2_Instance_ID  string  [0..1]  W-2 Instance ID   
Completed_Moment  dateTime  [0..1]  This is the timestamp of when the W-2 was created for the worker.   
EFW2_Year_End_Worker_Filing_Data  EFW2_Year_End_Worker_Filing_Data  [0..1]  This element contains the details of the W-2 for a worker.   
top
 

EFW2_Year_End_Worker_Filing_Data

part of: EFW2_Year_End_Worker_Filing
This element contains the details of the W-2 for a worker.
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [0..1]  Worker Reference   
SSN  string  [0..1]  Social Security Number   
Employee_First_Name  string  [0..1]  Employee First Name   
Employee_Middle_Initial  string  [0..1]  Middle initial   
Employee_Last_Name  string  [0..1]  Employee Last Name   
Suffix  string  [0..1]  Employee Suffix   
Address_Line_1  string  [0..1]  Line 1 of the employee's address.   
Address_Line_2  string  [0..1]  Line 2 of the employee's address.   
City  string  [0..1]  City of the employee's address.   
State  string  [0..1]  Two-letter postal abbreviation of the state of the employee's address.   
Postal_Code  string  [0..1]  Postal code of the employee's address. Includes the zip code and zip code extension if any (example: 94588-3260).   
Country_Name  string  [0..1]  Country name of the employee's address.   
EFW2_Year_End_Worker_Box_Data  EFW2_Year_End_Worker_Box_Data  [0..*]  This element contains the W-2 amounts for boxes 1 through 11. Box 1 search string: Wages, tips, and other compensation Box 2 search string: Federal income tax withheld Box 3 search string: Social security wages Box 4 search string: Social security tax withheld Box 5 search string: Medicare wages and tips Box 6 search string: Medicare tax withheld Box 7 search string: Social security tips Box 8 search string: Allocated tips Box 10 search string: Dependent care benefits Box 11 NQPS search string: Non-Qualified Pension-Section 457 Dist YTD Box 11 NQPNS search string: Non-Qualified Pension-Non-section 457 Dist YTD Box 11 NQPSC search string: Non-Qualified Pension-Section 457 Contrib YTD Box 11 NQPNSC search string: Non-Qualified Pension-Non-section 457 Contrib YTD   
EFW2_Deferred_and_Other_Compensation_Data  EFW2_Deferred_and_Other_Compensation_Data  [0..*]  This element contains the worker W-2 amounts for box 12.   
EFW2_Additional_Data  EFW2_Additional_Data  [0..*]  This is the wrapper element for Box 13 W-2 Additional Data.   
EFW2_Other_Data  EFW2_Other_Data  [0..*]  This element contains the worker W-2 amounts for box 14.   
EFW2_Year_End_Worker_State_Data  EFW2_Year_End_Worker_State_Data  [0..*]  This element contains the state and local data for the W-2.   
top
 

WorkerObject

part of: EFW2_Year_End_Worker_Filing_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
 

EFW2_Year_End_Worker_Box_Data

part of: EFW2_Year_End_Worker_Filing_Data
This element contains the W-2 amounts for boxes 1 through 11. Box 1 search string: Wages, tips, and other compensation Box 2 search string: Federal income tax withheld Box 3 search string: Social security wages Box 4 search string: Social security tax withheld Box 5 search string: Medicare wages and tips Box 6 search string: Medicare tax withheld Box 7 search string: Social security tips Box 8 search string: Allocated tips Box 10 search string: Dependent care benefits Box 11 NQPS search string: Non-Qualified Pension-Section 457 Dist YTD Box 11 NQPNS search string: Non-Qualified Pension-Non-section 457 Dist YTD Box 11 NQPSC search string: Non-Qualified Pension-Section 457 Contrib YTD Box 11 NQPNSC search string: Non-Qualified Pension-Non-section 457 Contrib YTD
 
Parameter name Type/Value Cardinality Description Validations
Box_Description  string  [0..1]  Box description.   
Amount  decimal (26, 6)   [0..1]  Dollar amount for the W-2 box.   
top
 

EFW2_Deferred_and_Other_Compensation_Data

part of: EFW2_Year_End_Worker_Filing_Data
This element contains the worker W-2 amounts for box 12.
 
Parameter name Type/Value Cardinality Description Validations
Code  string  [0..1]  Box description.   
Year  string (4)   [0..1]  W-2 - Box 12 - 4 Digit Year for Prior Year - Blank for Current Year.   
Amount  decimal (26, 6)   [0..1]  Dollar amount for the W-2 box.   
top
 

EFW2_Additional_Data

part of: EFW2_Year_End_Worker_Filing_Data
This is the wrapper element for Box 13 W-2 Additional Data.
 
Parameter name Type/Value Cardinality Description Validations
Statutory_Employee  boolean  [0..1]  True if Statutory Employee - Box 13 - W-2 Box Configuration.   
Retirement_Plan  boolean  [0..1]  True if Statutory Employee - Box 13 - W-2 Box Configuration.   
Third_Party_Sick_Pay  boolean  [0..1]  True if 3PSP - Box 13 - W-2 Box Configuration.   
top
 

EFW2_Other_Data

part of: EFW2_Year_End_Worker_Filing_Data
This element contains the worker W-2 amounts for box 14.
 
Parameter name Type/Value Cardinality Description Validations
Label  string  [0..1]  Box 14 Label   
Amount  decimal (26, 6)   [0..1]  Dollar amount for the W-2 box.   
Plan_Number  string  [0..1]  Display the Plan Number for New Jersey Voluntary Disability Insurance and Private Family Leave Insurance.   
top
 

EFW2_Year_End_Worker_State_Data

part of: EFW2_Year_End_Worker_Filing_Data
This element contains the state and local data for the W-2.
 
Parameter name Type/Value Cardinality Description Validations
State_EIN  string  [0..1]  State/Employer’s state ID number.   
State  string  [0..1]  Two-letter abbreviation for state.   
State_FIPS_Code  string  [0..1]  State FIPS Code   
State_Taxable_Wages  decimal (26, 6)   [0..1]  State wages, tips, etc.   
State_Tax_Withheld  decimal (26, 6)   [0..1]  State income tax.   
EFW2_Year_End_Worker_Local_Data  EFW2_Year_End_Worker_Local_Data  [0..*]  This element contains the local data for the W-2.   
top
 

EFW2_Year_End_Worker_Local_Data

part of: EFW2_Year_End_Worker_State_Data
This element contains the local data for the W-2.
 
Parameter name Type/Value Cardinality Description Validations
Locality  string  [0..1]  Locality name of the local tax.   
Tax_Type_Code  string  [0..1]  C = City Income Tax; D = County Income Tax; E = School District Income Tax; F = Other Income Tax   
Local_Taxable_Wages  decimal (26, 6)   [0..1]  Local Taxable Wages.   
Local_Tax_Withheld  decimal (26, 6)   [0..1]  Local Income Tax Withheld.   
Other_Information  string  [0..1]  NJ Plan Number or other information.   
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Calendar_YearReferenceEnumeration

part of: Calendar_YearObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top