Service Directory > v32.1 > Payroll > Get_Periodic_Worker_Tax_Filing_Data
 

Operation: Get_Periodic_Worker_Tax_Filing_Data

This web service operation returns periodic tax filing data based on specified criteria.


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

Get Periodic Worker Tax Filing Data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  Periodic_Tax_Filing_Data_Request_Criteria  [1..1]  Request Criteria 
Validation Description
None of the Pay Groups selected belongs to the Company selected. Please select a new set of Pay Groups from within the specified Company.   
 
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  Periodic_Tax_Filing_Data_Response_Group  [0..1]  Response Group   
top
 

Response Element: Get_Periodic_Worker_Tax_Filing_Data_Response

Get Periodic Worker Tax Filing Data Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  Periodic_Tax_Filing_Data_Request_Criteria  [1..1]  Request Criteria for Periodic Worker Tax Filing Data 
Validation Description
None of the Pay Groups selected belongs to the Company selected. Please select a new set of Pay Groups from within the specified Company.   
 
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  Periodic_Tax_Filing_Data_Response_Group  [0..1]  Response Group for Periodic Worker Tax Filing Response Group   
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  Periodic_Worker_Tax_Filing_Data_Response_Data  [0..1]  Get Periodic Worker Tax Filing Data Response   
top
 

Periodic_Tax_Filing_Data_Request_Criteria

part of: Get_Periodic_Worker_Tax_Filing_Data_Request, Get_Periodic_Worker_Tax_Filing_Data_Response
Request Criteria for Periodic Worker Tax Filing Data
 
Parameter name Type/Value Cardinality Description Validations
Company_Reference  CompanyObject  [1..1]  Company selected for tax filing data.   
Include_Related_Companies_for_Legal_Entity  boolean  [0..1]  If the requested company is a single legal entity, the response will include results from other companies in the relationship when this flag is true.   
Result_Completed_From  dateTime  [0..1]  Start Date Time stamp for when payroll results were completed as part of the selection criteria.   
Result_Completed_To  dateTime  [0..1]  End Date Time stamp for when payroll results were completed as part of the selection criteria.   
Pay_Group_Reference  Pay_GroupObject  [0..*]  Valid Pay Groups for selected Company.   
Period_Reference  PeriodObject  [0..*]  Valid Periods for selected Company and Pay Groups.   
Payment_Date  date  [0..1]  Payment Date.   
YTD_Tax_Filter  YTD_Tax_Filter  [0..*]  YTD Tax Filter is used to filter YTD results for particular Payroll Tax Authorities and Payroll Deductions. 
Validation Description
The field Include_YTD_Data is required and must have a value if Payroll_Tax_Authority_Reference is entered.   
The field Payroll_Tax_Authority_Reference is required and must have a value if Deduction_Reference is entered.   
YTD tip taxes can not be returned by the filter because tip taxes are not reported separately (Invalid value [deduction]:[ded_code] specified for Deduction_Reference).   
 
Validation Description
None of the Pay Groups selected belongs to the Company selected. Please select a new set of Pay Groups from within the specified Company.   
top
 

CompanyObject

part of: Periodic_Tax_Filing_Data_Request_Criteria, Peridoic_Worker_Tax_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  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
 

Pay_GroupObject

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

Pay_GroupObjectID

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

PeriodObject

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

PeriodObjectID

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

YTD_Tax_Filter

part of: Periodic_Tax_Filing_Data_Request_Criteria
Filter to be used for YTD Results when Payroll Tax Authority and Deductions are specified.
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Tax_Authority_Reference  Payroll_Tax_AuthorityObject  [0..*]  Payroll Tax Authority reference to be used with YTD filter.   
Deduction_Reference  Deduction__Workday_Owned_Object  [0..*]  Deduction reference can only be specified if a Payroll Tax Authority reference is also specified.   
Validation Description
The field Include_YTD_Data is required and must have a value if Payroll_Tax_Authority_Reference is entered.   
The field Payroll_Tax_Authority_Reference is required and must have a value if Deduction_Reference is entered.   
YTD tip taxes can not be returned by the filter because tip taxes are not reported separately (Invalid value [deduction]:[ded_code] specified for Deduction_Reference).   
top
 

Payroll_Tax_AuthorityObject

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

Payroll_Tax_AuthorityObjectID

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

Deduction__Workday_Owned_Object

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

Deduction__Workday_Owned_ObjectID

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

Response_Filter

part of: Get_Periodic_Worker_Tax_Filing_Data_Request, Get_Periodic_Worker_Tax_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
 

Periodic_Tax_Filing_Data_Response_Group

part of: Get_Periodic_Worker_Tax_Filing_Data_Request, Get_Periodic_Worker_Tax_Filing_Data_Response
Response Group for Periodic Worker Tax Filing Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_QTD_Data  boolean  [0..1]  Indicate whether QTD Data element will be included in the response.   
Include_YTD_Data  boolean  [0..1]  Indicate whether YTD Data element will be included in the response.   
top
 

Response_Results

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

Periodic_Worker_Tax_Filing_Data_Response_Data

part of: Get_Periodic_Worker_Tax_Filing_Data_Response
Get Periodic Worker Tax Filing Data Response
 
Parameter name Type/Value Cardinality Description Validations
Periodic_Worker_Tax_Filing_Data  Peridoic_Worker_Tax_Filing_Data  [0..*]  Peridoic Worker Tax Filing Data   
top
 

Peridoic_Worker_Tax_Filing_Data

part of: Periodic_Worker_Tax_Filing_Data_Response_Data
Peridoic Worker Tax Filing Data
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [1..1]  Worker Reference   
Company_Reference  CompanyObject  [1..1]  Company reference.   
Third_Party_Provides_Sick_Pay_W-2  boolean  [0..1]  Indicates whether Third Party Provides W-2 for Sick Pay   
Payroll_Result_Data  Payroll_Result_Data  [0..*]  Payroll Result Data element   
top
 

WorkerObject

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

Payroll_Result_Data

part of: Peridoic_Worker_Tax_Filing_Data
Payroll Result Data element
 
Parameter name Type/Value Cardinality Description Validations
Payment_Date  date  [0..1]  Payment Date for the Payroll Result   
Result_Start_Date  date  [0..1]  Payroll Result Start Date   
Result_End_Date  date  [0..1]  Payroll Result End Date   
Result_Calculation_Moment  dateTime  [0..1]  Date Time Stamp when Payroll Result was completed.   
Currency_Reference  CurrencyObject  [0..1]  Currency Reference   
Pay_Group_Reference  Pay_GroupObject  [0..1]  Pay Group Reference   
Period_Reference  PeriodObject  [1..1]  Period Reference   
Period_Start_Date  date  [0..1]  Period Start Date   
Period_End_Date  date  [0..1]  Period End Date   
Third_Party_Sick_Pay  boolean  [0..1]  Indicates Deduction is for Third Party Sick Pay (if True).   
Payroll_Result_Detail_Data  Payroll_Result_Detail_Data  [0..*]  Payroll Result Line element   
top
 

CurrencyObject

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

Payroll_Result_Detail_Data

part of: Payroll_Result_Data
Payroll Result Detail Data element
 
Parameter name Type/Value Cardinality Description Validations
Employer_Paid  boolean  [0..1]  Indicates Deduction is paid by employer (if True).   
Deduction_Reference  Payroll_CalculationObject  [1..1]  Deduction Reference   
Payroll_Tax_Authority_Reference  Payroll_Tax_AuthorityObject  [1..1]  Tax Authority Reference   
Work_PSD_Code  string  [0..1]  PSD Code for City Withholding Work (PA only). Act 32 requires Political Subdivision Codes (PSD) for Pennsylvania City Withholding.   
Resident_PSD_Code  string  [0..1]  PSD Code for City Withholding Resident (PA only). Act 32 requires Political Subdivision Codes (PSD) for Pennsylvania City Withholding.   
Tax_Filing_Code  string  [0..1]  A concatenated code: Deduction Code + Payroll Tax Authority Code.   
SUI_Rate  decimal (26, 6)   [0..1]  SUI Rate - For SUI deductions only.   
Tax_Withheld  decimal (36, 6)   [0..1]  Tax Withheld Amount for the Deduction   
Taxable_Wages  decimal (26, 6)   [0..1]  Taxable Wages for the Deduction   
Subject_Wages  decimal (26, 6)   [0..1]  Subject Wages for the Deduction   
Gross_Wages  decimal (18, 6)   [0..1]  Gross Wages for the Deduction   
Tip_Wages  decimal (26, 6)   [0..1]  Employee Reported Tip Wages for the Deduction   
QTD_Data  QTD_Tax_Filing_Data_for_Periodic_Worker  [0..1]  Quarter To Date Data element   
YTD_Data  YTD_Tax_Filing_Data_for_Periodic_Worker  [0..1]  Year To Date Data element   
top
 

Payroll_CalculationObject

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

Payroll_CalculationObjectID

part of: Payroll_CalculationObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Deduction_Code, Earning_Code, Pay_Accumulation_Code, Pay_Balance_Code, Pay_Component_Group_Code, Pay_Component_Related_Calculation_Code, Workday_Deduction_Code, Workday_Earning_Code, Workday_Pay_Accumulation_Code, Workday_Pay_Balance_Code, Workday_Pay_Component_Group_Code, Workday_Pay_Component_Related_Calculation_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
 

QTD_Tax_Filing_Data_for_Periodic_Worker

part of: Payroll_Result_Detail_Data
QTD Tax Filing Data for Periodic Worker
 
Parameter name Type/Value Cardinality Description Validations
Tax_Withheld  decimal (26, 6)   [0..1]  QTD Tax Withheld Amount   
Taxable_Wages  decimal (26, 6)   [0..1]  QTD Taxable Wages Amount   
Subject_Wages  decimal (26, 6)   [0..1]  QTD Subject Wages Amount   
Gross_Wages  decimal (26, 6)   [0..1]  QTD Gross Wages Amount   
Tip_Wages  decimal (26, 6)   [0..1]  QTD Tip Wages   
top
 

YTD_Tax_Filing_Data_for_Periodic_Worker

part of: Payroll_Result_Detail_Data
YTD Tax Filing Data for Periodic Worker
 
Parameter name Type/Value Cardinality Description Validations
Tax_Withheld  decimal (26, 6)   [0..1]  YTD Tax Withheld Amount   
Taxable_Wages  decimal (32, 6)   [0..1]  YTD Taxable Wages Amount   
Subject_Wages  decimal (26, 6)   [0..1]  YTD Subject Wages Amount   
Gross_Amount  decimal (26, 6)   [0..1]  YTD Gross Wages Amount   
Tip_Wages  decimal (26, 6)   [0..1]  YTD Tip Wages   
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Pay_GroupReferenceEnumeration

part of: Pay_GroupObjectID
Base Type
string
top
 

PeriodReferenceEnumeration

part of: PeriodObjectID
Base Type
string
top
 

Payroll_Tax_AuthorityReferenceEnumeration

part of: Payroll_Tax_AuthorityObjectID
Base Type
string
top
 

Deduction__Workday_Owned_ReferenceEnumeration

part of: Deduction__Workday_Owned_ObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Payroll_CalculationReferenceEnumeration

part of: Payroll_CalculationObjectID
Base Type
string
top