Service Directory > v32.1 > Payroll > Get_Multiple_Worksite_Report
 

Operation: Get_Multiple_Worksite_Report

This web service retrieves multiple worksite report data for a company and quarter. The report is used to collect statistical information to supplement statewide data provided through employer's SUI reports.


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

Request for a multiple worksite report.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  Multiple_Worksite_Report_Request_Criteria  [1..1]  Contains request criteria for the multiple worksite report.   
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_Multiple_Worksite_Report_Response

Response for a Get Multiple Worksites Report request.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  Multiple_Worksite_Report_Request_Criteria  [1..1]  Contains request criteria for the multiple worksite report.   
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  Multiple_Worksite_Report_Response_Data  [0..1]  Contains the data for the multiple worksite report response.   
top
 

Multiple_Worksite_Report_Request_Criteria

part of: Get_Multiple_Worksite_Report_Request, Get_Multiple_Worksite_Report_Response
Contains request criteria for the multiple worksite report.
 
Parameter name Type/Value Cardinality Description Validations
Company_Reference  CompanyObject  [1..1]  Reference to the company that the report is for.   
Calendar_Quarter_Reference  Calendar_QuarterObject  [1..1]  Reference to the calendar quarter covered by the report.   
Payroll_Tax_Authority_Reference  Payroll_State_AuthorityObject  [0..*]  Reference to state tax authorities to be included in the multiple worksite report. (Optional criteria)   
top
 

CompanyObject

part of: Multiple_Worksite_Report_Request_Criteria, Multiple_Worksite_Report_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_QuarterObject

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

Calendar_QuarterObjectID

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

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

Payroll_State_AuthorityObjectID

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

Response_Filter

part of: Get_Multiple_Worksite_Report_Request, Get_Multiple_Worksite_Report_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_Multiple_Worksite_Report_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
 

Multiple_Worksite_Report_Response_Data

part of: Get_Multiple_Worksite_Report_Response
Contains the data for the multiple worksite report response.
 
Parameter name Type/Value Cardinality Description Validations
Multiple_Worksite_Report_Data  Multiple_Worksite_Report_Data  [0..1]  Data for the multiple worksite report.   
top
 

Multiple_Worksite_Report_Data

part of: Multiple_Worksite_Report_Response_Data
Data for the multiple worksite report.
 
Parameter name Type/Value Cardinality Description Validations
Company_Reference  CompanyObject  [0..1]  Reference to the company that the report is for.   
Company_Legal_Name  string  [0..1]  Legal or corporate name of the company.   
Company_FEIN  string  [0..1]  The federal employer identification number.   
Calendar_Year_Reference  Calendar_YearObject  [0..1]  Reference to the calendar year for the calendar quarter covered by the report.   
Calendar_Quarter_Reference  Calendar_QuarterObject  [0..1]  Reference to the calendar quarter covered by the report.   
Quarter_Number  decimal (1, 0) >0   [0..1]  1-digit number indicating the reference calendar quarter.   
Multiple_Worksite_Report_State_Data  Multiple_Worksite_Report_State_Data  [0..*]  Data for the state tax authority which has Locations (Business Sites) with workers who receive wages subject to unemployment insurance.   
top
 

Calendar_YearObject

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

Multiple_Worksite_Report_State_Data

part of: Multiple_Worksite_Report_Data
Data for the state tax authority which has Locations (Business Sites) with workers who receive wages subject to unemployment insurance.
 
Parameter name Type/Value Cardinality Description Validations
State_Tax_Authority_Reference  Payroll_Tax_AuthorityObject  [0..1]  Reference to state tax authority which receives the state unemployment insurance paid by the employer.   
State_UI_Account_Number  string  [0..1]  Unemployment Insurance account number assigned to the employer by the state.   
Worksite_Data  Worksite_Data  [0..*]  Data for Location (Business Site). Includes identification, address, number of employees, and wages.   
top
 

Payroll_Tax_AuthorityObject

part of: Multiple_Worksite_Report_State_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_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
 

Worksite_Data

part of: Multiple_Worksite_Report_State_Data
Data for Location (Business Site). Includes identification, address, number of employees, and wages.
 
Parameter name Type/Value Cardinality Description Validations
Worksite_Reference  LocationObject  [0..1]  Location (Business Site) reference   
Trade_Name  string (35)   [0..1]  Division or subsidiary name of the Location (Business Site).   
Worksite_Street_Address  string  [0..1]  Physical street address from the primary address of the Location (Business Site).   
Worksite_City  string  [0..1]  City from the primary address of the Location (Business Site).   
Worksite_State  string  [0..1]  State (ISO 3166-2 code) from the primary address of the Location (Business Site).   
Worksite_Zip_Code  string  [0..1]  First 5 digits of the zip code from the primary address of the Location (Business Site).   
Worksite_Expanded_Zip_Code  string  [0..1]  Last 4 digits of the zip code from the primary address of the Location (Business Site).   
Worksite_Identification_Code  string (21)   [0..1]  Alphanumeric indicator that uniquely identifies this Location (Business Site).   
Worksite_Description  string  [0..1]  Name or description of the Location (Business Site).   
Employees_Active_Month_1_Day_12  decimal (12, 0) >0   [0..1]  Number of all full- and part-time employees who worked during or received pay (subject to UI wages) for the pay period that includes the 12th of the month. Additional positions of employees are not included in this number, to avoid double-counting.   
Employees_Active_Month_2_Day_12  decimal (12, 0) >0   [0..1]  Number of all full- and part-time employees who worked during or received pay (subject to UI wages) for the pay period that includes the 12th of the month. Additional positions of employees are not included in this number, to avoid double-counting.   
Employees_Active_Month_3_Day_12  decimal (12, 0) >0   [0..1]  Number of all full- and part-time employees who worked during or received pay (subject to UI wages) for the pay period that includes the 12th of the month. Additional positions of employees are not included in this number, to avoid double-counting.   
Wages  decimal (26, 6)   [0..1]  The total amount of wages (both taxable and non-taxable) paid to employees during the entire reference quarter that are subject to Unemployment Insurance taxes. The amount is rounded to the nearest dollar.   
top
 

LocationObject

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

LocationObjectID

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

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Calendar_QuarterReferenceEnumeration

part of: Calendar_QuarterObjectID
Base Type
string
top
 

Payroll_State_AuthorityReferenceEnumeration

part of: Payroll_State_AuthorityObjectID
Base Type
string
top
 

Calendar_YearReferenceEnumeration

part of: Calendar_YearObjectID
Base Type
string
top
 

Payroll_Tax_AuthorityReferenceEnumeration

part of: Payroll_Tax_AuthorityObjectID
Base Type
string
top
 

LocationReferenceEnumeration

part of: LocationObjectID
Base Type
string
top