Service Directory > v31.2 > Payroll > Get_Payroll_Reporting_Codes_for_Workers
 

Operation: Get_Payroll_Reporting_Codes_for_Workers

Returns effective payroll reporting codes associated with multiple workers.


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

Request Element to return workers and their associated payroll reporting codes as of an effective date.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Payroll_Reporting_Code_For_Workers_Request_References  [0..1]  Header element of the Get Payroll Reporting Codes for Workers web service task. 
Validation Description
The Company Reference cannot be requested with the Workers Reference. Include only the Company Reference or the Workers Reference.   
Either Company Reference or Worker Reference must be specified.   
 
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_Payroll_Reporting_Codes_for_Workers_Response

Element containing request response, including paging details and request references.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Payroll_Reporting_Code_For_Workers_Request_References  [0..*]  Element containing the Worker(s), Company, and Effective Date for the web service request. Either Worker or Company fields need to be populated. If both are supplied, the response will default to returning the workers supplied and Company will be ignored. 
Validation Description
The Company Reference cannot be requested with the Workers Reference. Include only the Company Reference or the Workers Reference.   
Either Company Reference or Worker Reference must be specified.   
 
Response_Filter  Response_Filter  [0..*]  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..*]  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  Payroll_Reporting_Codes_for_Workers_Response_Data  [0..*]  Contains response data containing Worker and their associated payroll reporting codes as of the effective date passed in by the request references.   
top
 

Payroll_Reporting_Code_For_Workers_Request_References

part of: Get_Payroll_Reporting_Codes_for_Workers_Request, Get_Payroll_Reporting_Codes_for_Workers_Response
Element containing the Worker(s), Company, and Effective Date for the web service request. Either Worker or Company fields need to be populated. If both are supplied, the response will default to returning the workers supplied and Company will be ignored.
 
Parameter name Type/Value Cardinality Description Validations
Workers_Reference  WorkerObject  [0..*]  Worker(s) that will have their payroll reporting codes returned as of the effective date.   
Company_Reference  CompanyObject  [0..1]  Company used to retrieve all active workers (to be used if worker field is not populated).   
Effective_Date  date  [0..1]  Only payroll reporting codes effective for worker on this date will be returned. If left blank, will default to current date.   
Validation Description
The Company Reference cannot be requested with the Workers Reference. Include only the Company Reference or the Workers Reference.   
Either Company Reference or Worker Reference must be specified.   
top
 

WorkerObject

part of: Payroll_Reporting_Codes_for_Worker, Payroll_Reporting_Code_For_Workers_Request_References
 
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
 

CompanyObject

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

Response_Filter

part of: Get_Payroll_Reporting_Codes_for_Workers_Request, Get_Payroll_Reporting_Codes_for_Workers_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_Payroll_Reporting_Codes_for_Workers_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
 

Payroll_Reporting_Codes_for_Workers_Response_Data

part of: Get_Payroll_Reporting_Codes_for_Workers_Response
Wrapper element for containing multiple Payroll Reporting Codes for Worker elements.
 
Parameter name Type/Value Cardinality Description Validations
Worker_Payroll_Codes_Data  Payroll_Reporting_Codes_for_Worker  [0..*]  Element containing one worker and the worker's associated payroll reporting codes as of the effective date.   
top
 

Payroll_Reporting_Codes_for_Worker

part of: Payroll_Reporting_Codes_for_Workers_Response_Data
Element containing one worker and the worker's associated payroll reporting codes as of the effective date.
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [0..1]  Reference to a Worker sent in by the request element.   
Position_and_Payroll_Reporting_Codes_Data  Payroll_Reporting_Codes_for_Position  [0..*]  Contains Position and associated Payroll Reporting Codes for that Position as of Effective Date. If Company was passed into the web service request, then only Positions within that Company are returned for the Worker.   
top
 

Payroll_Reporting_Codes_for_Position

part of: Payroll_Reporting_Codes_for_Worker
Contains Position and associated Payroll Reporting Codes for that Position as of Effective Date. If Company was passed into the web service request, then only Positions within that Company are returned for the Worker.
 
Parameter name Type/Value Cardinality Description Validations
Position_Reference  PositionObject  [0..1]  Worker's Position with Effective Payroll Reporting Codes   
Payroll_Reporting_Codes_Reference  Payroll_Reporting_Code__All_Object  [0..*]  Payroll Reporting Codes as of Effective Date for Position   
top
 

PositionObject

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

PositionObjectID

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

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

Payroll_Reporting_Code__All_ObjectID

part of: Payroll_Reporting_Code__All_Object
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Payroll_Reporting_Code, Workday_Payroll_Reporting_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".   
@parent_id  string  [1..1]  Contains a unique identifier for an instance of a parent object   
@parent_type  WID, Payroll_Reporting_Type_Code  [1..1]  The unique identifier type of a parent object   
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

PositionReferenceEnumeration

part of: PositionObjectID
Base Type
string
top
 

Payroll_Reporting_Code__All_ReferenceEnumeration

part of: Payroll_Reporting_Code__All_ObjectID
Base Type
string
top
 

Base Type
string

top