Service Directory > v32.1 > Payroll > Get_EFW2_Year_End_Employer_Filing_Data
 

Operation: Get_EFW2_Year_End_Employer_Filing_Data

Exposes the employer-level W-2 year end data for integration with the Social Security Administration (SSA) or other filing system. This includes employer totals for the W-2 box amounts as well as submitter information.


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

EFW2 Year End Employer Filing Data Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  EFW2_Year_End_Employer_Filing_Data_Request_Criteria  [1..1]  Request Criteria   
top
 

Response Element: Get_EFW2_Year_End_Employer_Filing_Data_Response

Response Data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  EFW2_Year_End_Employer_Filing_Data_Request_Criteria  [1..1]  Request Criteria   
Response_Data  EFW2_Year_End_Employer_Filing_Response_Data  [0..1]  Response Data   
top
 

EFW2_Year_End_Employer_Filing_Data_Request_Criteria

part of: Get_EFW2_Year_End_Employer_Filing_Data_Request, Get_EFW2_Year_End_Employer_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_Employer_Filing_Data_Request_Criteria, EFW2_Year_End_Employer_Filing
 
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_Employer_Filing_Data_Request_Criteria, EFW2_Year_End_Employer_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  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
 

EFW2_Year_End_Employer_Filing_Response_Data

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

EFW2_Year_End_Employer_Filing

part of: EFW2_Year_End_Employer_Filing_Response_Data
Response data for Employer W-2 totals.
 
Parameter name Type/Value Cardinality Description Validations
Company_Reference  CompanyObject  [0..1]  Company Reference   
EFW2_Year_End_Employer_Filing_Data  EFW2_Year_End_Employer_Filing_Data  [0..1]  This element contains the employer details for the W-2 data.   
top
 

EFW2_Year_End_Employer_Filing_Data

part of: EFW2_Year_End_Employer_Filing
This element contains the employer details for the W-2 data.
 
Parameter name Type/Value Cardinality Description Validations
Calendar_Year_Reference  Calendar_YearObject  [0..1]  Calendar Year   
EIN  string  [0..1]  The federal employer identification number either for the employer or for the agent, if there is one.   
Company_Name  string  [0..1]  Name of the company associated with the EIN in the response, either an employer or the agent.   
Kind_of_Employer_Reference  Kind_of_Employer_for_Payroll_Tax_FilingObject  [0..1]  Identifies the kind of employer that the company is.   
Third_Party_Sick_Pay_Indicator  boolean  [0..1]  Indicates whether Third Party provides W-2 for Sick Pay   
EFW2_Year_End_Submitter_Data  EFW2_Year_End_Submitter_Data  [0..*]  This element contains information about the submitter of the data and contact information if there are processing problems.   
EFW2_Year_End_Employer_Box_Data  EFW2_Year_End_Employer_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_Employer_Deferred_and_Other_Compensation_Data  [0..*]  This element contains the company W-2 total amounts for box 12.   
top
 

Kind_of_Employer_for_Payroll_Tax_FilingObject

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

Kind_of_Employer_for_Payroll_Tax_FilingObjectID

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

part of: EFW2_Year_End_Employer_Filing_Data
This element contains information about the submitter of the data and contact information if there are processing problems.
 
Parameter name Type/Value Cardinality Description Validations
EIN  string  [0..1]  Submitter's Employer Identification Number (EIN).   
Company_Name  string  [0..1]  Name of the company to be contacted concerning processing problems.   
Address_Line_1  string  [0..1]  Line 1 of the submitter's address.   
Address_Line_2  string  [0..1]  Line 2 of the submitter's address.   
City  string  [0..1]  City of the submitter's address.   
State  string  [0..1]  Two-letter postal abbreviation of the state of the submitter's address.   
Postal_Code  string  [0..1]  Postal code of the submitter's address. Includes the zip code and zip code extension if any (example: 94588-3260).   
Contact_Name  string  [0..1]  Name of the person to be contacted concerning processing problems.   
Contact_Phone_Number  string  [0..1]  Phone number of the person to be contacted concerning processing problems.   
Contact_Email_Address  string  [0..1]  Email address of the person to be contacted concerning processing problems.   
top
 

EFW2_Year_End_Employer_Box_Data

part of: EFW2_Year_End_Employer_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]  Company totals for the W-2 box.   
top
 

EFW2_Employer_Deferred_and_Other_Compensation_Data

part of: EFW2_Year_End_Employer_Filing_Data
This element contains the company W-2 total 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]  Employer total amount for the W-2 box.   
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Calendar_YearReferenceEnumeration

part of: Calendar_YearObjectID
Base Type
string
top
 

Kind_of_Employer_for_Payroll_Tax_FilingReferenceEnumeration

part of: Kind_of_Employer_for_Payroll_Tax_FilingObjectID
Base Type
string
top