Service Directory > v31.2 > Payroll > Get_Monthly_Worker_Tax_Filing_Data
 

Operation: Get_Monthly_Worker_Tax_Filing_Data

This web service operation returns monthly tax filing data based on request 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_Monthly_Worker_Tax_Filing_Data_Request

Get Monthly Worker Tax Filing Data Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  Monthly_Worker_Tax_Filing_Data_Criteria  [1..1]  Monthly Worker Tax Filing Data 
Validation Description
The As Of Date must be a date that is valid in the Month and Year selected.   
 
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  Monthly_Worker_Tax_Filing_Data_Response_Group  [0..1]  Monthly Worker Tax Filing Data Response Group   
top
 

Response Element: Get_Monthly_Worker_Tax_Filing_Data_Response

Get Monthly Worker Tax Filing Data Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  Monthly_Worker_Tax_Filing_Data_Criteria  [1..1]  Monthly Worker Tax Filing Data 
Validation Description
The As Of Date must be a date that is valid in the Month and Year selected.   
 
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  Monthly_Worker_Tax_Filing_Data_Response_Group  [0..1]  Monthly Worker Tax Filing Data Response Group   
Response_Results  Response_Results  [0..*]  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  Monthly_Worker_Tax_Filing_Data_Response_Data  [0..*]  Get Monthly Worker Tax Filing Data Response   
top
 

Monthly_Worker_Tax_Filing_Data_Criteria

part of: Get_Monthly_Worker_Tax_Filing_Data_Request, Get_Monthly_Worker_Tax_Filing_Data_Response
Monthly Worker Tax Filing Data
 
Parameter name Type/Value Cardinality Description Validations
Company_Reference  CompanyObject  [1..1]  Company selected for tax filing data.   
Calendar_Year_Reference  Calendar_YearObject  [1..1]  Calendar Year   
Month_Reference  MonthObject  [1..1]  Month for Tax Filing   
As_Of_Date  date  [0..1]  As Of Date   
Validation Description
The As Of Date must be a date that is valid in the Month and Year selected.   
top
 

CompanyObject

part of: Monthly_Worker_Tax_Filing_Data_Criteria, Monthly_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
 

Calendar_YearObject

part of: Monthly_Worker_Tax_Filing_Data_Criteria, Monthly_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  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
 

MonthObject

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

MonthObjectID

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

Monthly_Worker_Tax_Filing_Data_Response_Group

part of: Get_Monthly_Worker_Tax_Filing_Data_Request, Get_Monthly_Worker_Tax_Filing_Data_Response
Monthly Worker Tax Filing Data Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_YTD_Data  boolean  [0..1]  Include Year To Date Tax Data   
top
 

Response_Results

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

Monthly_Worker_Tax_Filing_Data_Response_Data

part of: Get_Monthly_Worker_Tax_Filing_Data_Response
Get Monthly Worker Tax Filing Data Response
 
Parameter name Type/Value Cardinality Description Validations
Monthly_Worker_Tax_Filing_Data  Monthly_Worker_Tax_Filing_Data  [0..*]  Monthly Worker Tax Filing Data   
top
 

Monthly_Worker_Tax_Filing_Data

part of: Monthly_Worker_Tax_Filing_Data_Response_Data
Monthly Worker Tax Filing Data
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [0..1]  Worker Reference   
Company_Reference  CompanyObject  [0..1]  Company selected for tax filing data.   
Calendar_Year_Reference  Calendar_YearObject  [0..1]  Calendar Year   
Month_Reference  MonthObject  [0..1]  Month for Tax Filing   
Start_Date  date  [0..1]  Start Date of the Tax Filing Period   
End_Date  date  [0..1]  End Date of the Tax Filing Period   
Currency_Reference  CurrencyObject  [0..1]  Currency Reference   
Weeks_Worked  decimal (6, 0)   [0..1]  Number of Weeks Worked   
Hours_Worked  decimal (14, 2)   [0..1]  Number of Hours Worked   
Seasonal_Worker  boolean  [0..1]  Seasonal Worker   
Corporate_Officer  boolean  [0..1]  Corporate Officer   
Payroll_Reporting_Code_Data  Worker_Payroll_Reporting_Code_Data  [0..*]  Payroll Reporting Code.   
Monthly_Deduction_Tax_Data  Monthly_Tax_Filing_Deduction_Data  [0..*]  Monthly Tax Filing Deduction Data   
top
 

WorkerObject

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

CurrencyObject

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

Worker_Payroll_Reporting_Code_Data

part of: Monthly_Worker_Tax_Filing_Data
This element contains Worker Payroll Reporting Code Data.
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Reporting_Type_Reference  Payroll_Reporting_TypeObject  [0..1]  Payroll Reporting Type.   
Payroll_Reporting_Code  string  [0..1]  Payroll Reporting Code.   
Formatted_Payroll_Reporting_Code  string  [0..1]  Formatted Payroll Reporting Code.   
top
 

Payroll_Reporting_TypeObject

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

Payroll_Reporting_TypeObjectID

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

Monthly_Tax_Filing_Deduction_Data

part of: Monthly_Worker_Tax_Filing_Data
Monthly Worker Tax Filing Data
 
Parameter name Type/Value Cardinality Description Validations
Deduction_Reference  Payroll_CalculationObject  [1..1]  Deduction Reference   
Payroll_Tax_Authority_Reference  Metadata_Payroll_WorktagObject  [1..*]  Payroll Tax Authority Reference   
Tax_Filing_Code  string  [0..1]  Tax Filing Code   
MTD_Data  MTD_Tax_Filing_Data  [0..1]  Month To Date Tax Filing Data   
YTD_Data  YTD_Tax_Filing_Data  [0..1]  Year To Date Tax Filing Data   
top
 

Payroll_CalculationObject

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

Metadata_Payroll_WorktagObject

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

Metadata_Payroll_WorktagObjectID

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

MTD_Tax_Filing_Data

part of: Monthly_Tax_Filing_Deduction_Data
Monthly Tax Filing Deduction Data
 
Parameter name Type/Value Cardinality Description Validations
Tax_Withheld  decimal (26, 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 Amount for the Deduction   
top
 

YTD_Tax_Filing_Data

part of: Monthly_Tax_Filing_Deduction_Data
Monthly Tax Filing Deduction Data
 
Parameter name Type/Value Cardinality Description Validations
Tax_Withheld  decimal (26, 6)   [0..1]  Year To Date Tax Withheld   
Taxable_Wages  decimal (32, 6)   [0..1]  Year To Date Taxable Wages   
Subject_Wages  decimal (26, 6)   [0..1]  Year To Date Subject Wages   
Gross_Wages  decimal (26, 6)   [0..1]  Year To Date Gross Wages   
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Calendar_YearReferenceEnumeration

part of: Calendar_YearObjectID
Base Type
string
top
 

MonthReferenceEnumeration

part of: MonthObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Payroll_Reporting_TypeReferenceEnumeration

part of: Payroll_Reporting_TypeObjectID
Base Type
string
top
 

Payroll_CalculationReferenceEnumeration

part of: Payroll_CalculationObjectID
Base Type
string
top
 

Metadata_Payroll_WorktagReferenceEnumeration

part of: Metadata_Payroll_WorktagObjectID
Base Type
string
top