Service Directory > v31.2 > Payroll > Change_No_Retro_Processing_Prior_To
 

Operation: Change_No_Retro_Processing_Prior_To

This Web Service is to allow clients to push out the "No Retro Processing Prior to" dates for 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: Change_No_Retro_Processing_Prior_To_Request

Change No Retro Processing Prior To Request.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Business_Process_Parameters  Business_Process_Parameters  [0..1]  Container for the processing options for a business process. If no options are submitted (or the options are submitted as 'false') then the business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.   
Change_No_Retro_Processing_Prior_To_Data  Change_No_Retro_Processing_Prior_To_Data  [1..1]  Change No Retro Processing Prior to Data 
Validation Description
You cannot initiate this action because there are other pending or completed actions for the employee that conflict with this one.   
You cannot initiate this action because Retro Processing is in Progress.   
You cannot initiate this action because there is a retro calculation in Progress.   
No Retro Processing Prior to Date is prior to the start date of the first processing period for ~worker’s~ pay group.   
No completed payrolls exist for the pay group assigned to the worker. No Retro Processing Prior To Date must be equal to or greater than the start date of the first processing period for worker’s pay group.   
No Retro Processing Prior to Date is prior to the start date of the first processing period for ~worker’s~ pay group.   
The proposed No Retro Prior To Date is less than or equal to a date for which an unsupported event exists on - ([Earliest available NRPPTD - EIB])   
No Retro Processing Prior to Date is prior to the start date of the first processing period for ~worker’s~ pay group.   
 
top
 

Response Element: Change_No_Retro_Processing_Prior_To_Response

Put No Retro Processing Prior to date for worker Response.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Payroll_Retro_Worker_Data_Event_Reference  Unique_IdentifierObject  [0..1]  No Retro Processing Prior to date reference   
top
 

Business_Process_Parameters

part of: Change_No_Retro_Processing_Prior_To_Request
Container for the processing options for a business process. If no options are submitted (or the options are submitted as 'false') then the business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.
 
Parameter name Type/Value Cardinality Description Validations
Auto_Complete  boolean  [0..1]  When set to "true" or "1", the business process is automatically processed. This means that all approvals will be automatically approved in the system, all reviews and to-do's will be automatically by-passed, and all notifications will be automatically suppressed.   
Run_Now  boolean  [0..1]  Indicates the transaction should process to completion before the response is generated. Note: All < v12 operations will process with Run_Now = True for backwards compatibility but please review this setting in your environment for performance conditions.   
Comment_Data  Business_Process_Comment_Data  [0..1]  Captures a comment for the Business Process.   
Business_Process_Attachment_Data  Business_Process_Attachment_Data  [0..*]  Element for the attachments pertaining to a Event entered through a web service. 
Validation Description
This Business Process Type has been configured to not accept Event Attachments.   
 
top
 

Business_Process_Comment_Data

part of: Business_Process_Parameters
Captures a comment for the Business Process.
 
Parameter name Type/Value Cardinality Description Validations
Comment  string  [0..1]  Free form comment regarding the business process. 
Validation Description
This Business Process has been configured to disable comment. Please remove the comment or change the setting in the Business Process Policy or tenant setup.   
 
Worker_Reference  WorkerObject  [0..1]  Default the Person making the comment to the processing person if not submitted via the web service.   
top
 

WorkerObject

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

Business_Process_Attachment_Data

part of: Business_Process_Parameters
Element for the attachments pertaining to a Event entered through a web service.
 
Parameter name Type/Value Cardinality Description Validations
File_Name  string (255)   [1..1]  Filename for the attachment.   
Event_Attachment_Description  string  [0..1]  Free form text comment about the attachment.   
Event_Attachment_Category_Reference  Event_Attachment_CategoryObject  [0..1]  Category of attachment. 
Validation Description
This Business Process Type has been configured to not accept Attachment Categories.   
 
File  base64Binary  [0..1]  Binary file contents.   
Content_Type  string (80)   [0..1]  Text attribute identifying Content Type of the Attachment.   
top
 

Event_Attachment_CategoryObject

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

Event_Attachment_CategoryObjectID

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

Change_No_Retro_Processing_Prior_To_Data

part of: Change_No_Retro_Processing_Prior_To_Request
Change No Retro Processing Prior to Data
 
Parameter name Type/Value Cardinality Description Validations
Employee_Reference  EmployeeObject  [1..1]  Worker who has the No Retro Processing Prior to date.   
Proposed_No_Retro_Processing_Prior_To  date  [0..1]  The No Retro Processing Prior to date for the Worker. This is optional. When the date is not provided, the system will use the most recent result end date + 1.   
Validation Description
You cannot initiate this action because there are other pending or completed actions for the employee that conflict with this one.   
You cannot initiate this action because Retro Processing is in Progress.   
You cannot initiate this action because there is a retro calculation in Progress.   
No Retro Processing Prior to Date is prior to the start date of the first processing period for ~worker’s~ pay group.   
No completed payrolls exist for the pay group assigned to the worker. No Retro Processing Prior To Date must be equal to or greater than the start date of the first processing period for worker’s pay group.   
No Retro Processing Prior to Date is prior to the start date of the first processing period for ~worker’s~ pay group.   
The proposed No Retro Prior To Date is less than or equal to a date for which an unsupported event exists on - ([Earliest available NRPPTD - EIB])   
No Retro Processing Prior to Date is prior to the start date of the first processing period for ~worker’s~ pay group.   
top
 

EmployeeObject

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

EmployeeObjectID

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

Unique_IdentifierObject

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

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Event_Attachment_CategoryReferenceEnumeration

part of: Event_Attachment_CategoryObjectID
Base Type
string
top
 

EmployeeReferenceEnumeration

part of: EmployeeObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top