Service Directory > v31.2 > Payroll > Get_Payroll_Pre-Printed_Payslips
 

Operation: Get_Payroll_Pre-Printed_Payslips

Public web service that returns Pre-Printed Payslip repository documents


@ - 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_Pre-Printed_Payslips_Request

Get Payroll Pre-Printed Payslips Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Reference [Choice]   Payroll_Pre-Printed_Payslips_Request_Reference  [1..1]  Get Payroll Pre-Printed Payslips Request Reference   
Request_Criteria [Choice]   Payroll_Pre-Printed_Payslips_Request_Criteria  [1..1]  Get Payroll Pre-Printed Payslips Request Criteria 
Validation Description
To Moment must be greater than or equal to From Moment  To Moment must be greater than or equal to From Moment 
 
Response_Filter  Response_Filter  [0..1]  Get Payroll Pre-Printed Payslips Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Payroll_Pre-Printed_Payslips_Response_Group  [0..1]  Get Payroll Pre-Printed Payslips Response Group   
top
 

Response Element: Get_Payroll_Pre-Printed_Payslips_Response

Get Payroll Pre-Printed Payslips Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Payroll_Pre-Printed_Payslips_Request_Reference  [0..*]  Get Payroll Pre-Printed Payslips Request Reference   
Request_Criteria  Payroll_Pre-Printed_Payslips_Request_Criteria  [0..*]  Utilize the following element to find Pre-Printed Payslips in the Workday system. 
Validation Description
To Moment must be greater than or equal to From Moment  To Moment must be greater than or equal to From Moment 
 
Response_Group  Payroll_Pre-Printed_Payslips_Response_Group  [0..*]  Response Group   
Request_Filter  Response_Filter  [0..*]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..*]  Response Results   
Response_Data  Get_Payroll_Pre-Printed_Payslips_Response_Data  [0..*]  Worker Document Response Data containing the retrieved Worker Document information.   
top
 

Payroll_Pre-Printed_Payslips_Request_Reference

part of: Get_Payroll_Pre-Printed_Payslips_Request, Get_Payroll_Pre-Printed_Payslips_Response
Get Payroll Pre-Printed Payslips Request Reference
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Pre-Printed_Payslips_Request_Reference  Repository_DocumentObject  [1..*]  Reference to an existing Payroll Pre-Printed Payslip   
top
 

Repository_DocumentObject

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

Repository_DocumentObjectID

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

part of: Get_Payroll_Pre-Printed_Payslips_Request, Get_Payroll_Pre-Printed_Payslips_Response
Utilize the following element to find Pre-Printed Payslips in the Workday system.
 
Parameter name Type/Value Cardinality Description Validations
Pre-Printed_Payslip_Creation_From_Moment  dateTime  [1..1]  Start Date of Pre-Printed Payslip Creation Date Range   
Pre-Printed_Payslip_Creation_To_Moment  dateTime  [1..1]  End Date of Pre-Printed Payslip Creation Date Range   
Pay_Run_Group_Selection_Reference  Pay_Run_Group_SelectionObject  [0..*]  Reference to an existing Pay Group or Pay Run Group the Payroll Pre-Printed Payslip should belong to   
Validation Description
To Moment must be greater than or equal to From Moment  To Moment must be greater than or equal to From Moment 
top
 

Pay_Run_Group_SelectionObject

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

Pay_Run_Group_SelectionObjectID

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

Payroll_Pre-Printed_Payslips_Response_Group

part of: Get_Payroll_Pre-Printed_Payslips_Request, Get_Payroll_Pre-Printed_Payslips_Response
Response Group
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Results

part of: Get_Payroll_Pre-Printed_Payslips_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
 

Get_Payroll_Pre-Printed_Payslips_Response_Data

part of: Get_Payroll_Pre-Printed_Payslips_Response
Wrapper element that includes the Repository Document instance and data
 
Parameter name Type/Value Cardinality Description Validations
Employee_Name_Reference  WorkerObject  [0..1]  Reference to the Worker belonging to the Pre-Printed Payslip   
Pay_Group_Detail_Reference  Pay_Group_DetailObject  [0..1]  Reference to an existing Pay Group Detail the Payroll Result related to the Pre-Printed Payslip belongs to   
Company_Reference  CompanyObject  [0..1]  Reference to an existing Company which the Pre-Printed Payslip belongs to   
Payroll_Result_Reference  Unique_IdentifierObject  [0..1]  Reference to an existing Payroll Result related to the Pre-Printed Payslip   
Period_Start_Date  date  [0..1]  Period Start Date of the Payroll Result related to the Pre-Printed Payslip.   
Period_End_Date  date  [0..1]  Period End Date of the Payroll Result related to the Pre-Printed Payslip.   
Payment_Date  date  [0..1]  Payment Date of the Payroll Result related to the Pre-Printed Payslip.   
Gross_Amount  decimal (26, 6)   [0..1]  Gross Amount of the Payroll Result related to the Pre-Printed Payslip.   
Net_Amount  decimal (26, 6)   [0..1]  Net Amount of the Payroll Result related to the Pre-Printed Payslip.   
Payroll_Pre-Printed_Payslip_Document_ID  string (513)   [0..1]  Document ID of the Pre-Printed Payslip   
Payroll_Pre-Printed_Payslip_Document_Reference  Repository_Document_Metadata  [0..*]  Wrapper Element containing details about the Pre-Printed Payslip   
File_Content  base64Binary  [0..1]  Pre-Printed Payslip File content in base64 encoding.   
top
 

WorkerObject

part of: Get_Payroll_Pre-Printed_Payslips_Response_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
 

Pay_Group_DetailObject

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

Pay_Group_DetailObjectID

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

Unique_IdentifierObject

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

Unique_IdentifierObjectID

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

Repository_Document_Metadata

part of: Get_Payroll_Pre-Printed_Payslips_Response_Data
Data Element for Repository Document Metadata
 
Parameter name Type/Value Cardinality Description Validations
File_Name  string  [0..1]  File Name   
Created_by  string  [0..1]  Name of the Creator   
Date_and_Time_Created  dateTime  [0..1]  Date and Time Created   
Report_Tag_Reference  Report_Output_TagObject  [0..*]  Report Tag Reference   
top
 

Report_Output_TagObject

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

Report_Output_TagObjectID

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

Repository_DocumentReferenceEnumeration

part of: Repository_DocumentObjectID
Base Type
string
top
 

Pay_Run_Group_SelectionReferenceEnumeration

part of: Pay_Run_Group_SelectionObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Pay_Group_DetailReferenceEnumeration

part of: Pay_Group_DetailObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

Report_Output_TagReferenceEnumeration

part of: Report_Output_TagObjectID
Base Type
string
top