Service Directory > v32.1 > Payroll > Get_Run_Pay_Calculation
 

Operation: Get_Run_Pay_Calculation

Web Service to get Pay Calculation Background Processes.


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

Get Run Pay Calculation Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Run_Pay_Calculation_Request_References  [0..1]  Run Pay Calculation Request References   
Request_Criteria [Choice]   Run_Pay_Calculation_Request_Criteria  [0..1]  Criteria used to identify calculation process if Process Integration ID is not used 
Validation Description
Enter a valid run category, or enter a payroll calculation job process ID.   
Enter one or more statuses, or enter a payroll calculation job process ID.   
You can't process pay groups configured to be used in a payroll interface. Remove pay groups, or enter a payroll calculation job process ID.   
No run pay calculation job process matching the selection criteria provided exists. Please provide criteria matching a calculation process or enter a valid payroll calculation job process ID.   
The selected pay groups and pay run groups have multiple current or next periods. Please provide pay groups or pay run groups with the same current period or next period. Alternatively provide a payroll calculation job process ID.   
Enter pay run groups that correspond to the selected run category. To process all pay run groups, leave the run category blank. To reference an existing run pay calculation, enter a payroll calculation job process ID.   
The pay groups and pay run groups do not contain any details that match the run category provided. Please select pay groups and pay run groups that correspond to the run category, omit the run category or provide a payroll calculation job process ID.   
 
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  Run_Pay_Calculation_Response_Group  [0..1]  Used to specify what groups of information are provided in the response   
top
 

Response Element: Get_Run_Pay_Calculation_Response

Run Pay Calculation Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Run_Pay_Calculation_Request_References  [0..1]  Pay Calculation Request References   
Request_Criteria  Run_Pay_Calculation_Request_Criteria  [0..1]  Criteria used to identify calculation process if Process Integration ID is not used 
Validation Description
Enter a valid run category, or enter a payroll calculation job process ID.   
Enter one or more statuses, or enter a payroll calculation job process ID.   
You can't process pay groups configured to be used in a payroll interface. Remove pay groups, or enter a payroll calculation job process ID.   
No run pay calculation job process matching the selection criteria provided exists. Please provide criteria matching a calculation process or enter a valid payroll calculation job process ID.   
The selected pay groups and pay run groups have multiple current or next periods. Please provide pay groups or pay run groups with the same current period or next period. Alternatively provide a payroll calculation job process ID.   
Enter pay run groups that correspond to the selected run category. To process all pay run groups, leave the run category blank. To reference an existing run pay calculation, enter a payroll calculation job process ID.   
The pay groups and pay run groups do not contain any details that match the run category provided. Please select pay groups and pay run groups that correspond to the run category, omit the run category or provide a payroll calculation job process ID.   
 
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  Run_Pay_Calculation_Response_Group  [0..1]  Used to specify what groups of information are provided in the response   
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  Run_Pay_Calculation_Response_Data  [0..1]  Pay Calculation Response   
top
 

Run_Pay_Calculation_Request_References

part of: Get_Run_Pay_Calculation_Request, Get_Run_Pay_Calculation_Response
Pay Calculation Request References
 
Parameter name Type/Value Cardinality Description Validations
Run_Pay_Calculation_Reference  Background_Process_RuntimeObject  [1..*]  Used to identify particular Pay Run Calculation processes   
top
 

Background_Process_RuntimeObject

part of: Run_Pay_Calculation_Request_References, Run_Pay_Calculation, Run_Pay_Calculation_Message
 
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  Background_Process_RuntimeObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Background_Process_RuntimeObjectID

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

Run_Pay_Calculation_Request_Criteria

part of: Get_Run_Pay_Calculation_Request, Get_Run_Pay_Calculation_Response
Criteria used to identify calculation process if Process Integration ID is not used
 
Parameter name Type/Value Cardinality Description Validations
Period_Reference  PeriodObject  [0..1]  Should only be used if no value provided for Payroll Run Pay Calculation Process   
Pay_Groups_or_Pay_Run_Groups_Selection_Reference  Pay_Group_Pay_Run_Group_SelectionObject  [1..*]  Pay Groups/Pay Run Groups   
Run_Category_Reference  Run_CategoryObject  [0..1]  Run Category   
Include_Requires_Recalculation  boolean  [0..1]  Include Pay Calculations with a status of Requires Recalculation   
Include_Error  boolean  [0..1]  Include Pay Calculations with a status of Error   
Include_Not_Yet_Started  boolean  [0..1]  Include Pay Calculations with a status of Not Yet Started   
Include_In_Progress  boolean  [0..1]  Include Pay Calculations with a status of In Progress   
Accounting_Only_for_Calculation_Criteria  boolean  [0..1]  Accounting Only   
Include_Queued_Proesses  boolean  [0..1]  Include Queued Processes   
Validation Description
Enter a valid run category, or enter a payroll calculation job process ID.   
Enter one or more statuses, or enter a payroll calculation job process ID.   
You can't process pay groups configured to be used in a payroll interface. Remove pay groups, or enter a payroll calculation job process ID.   
No run pay calculation job process matching the selection criteria provided exists. Please provide criteria matching a calculation process or enter a valid payroll calculation job process ID.   
The selected pay groups and pay run groups have multiple current or next periods. Please provide pay groups or pay run groups with the same current period or next period. Alternatively provide a payroll calculation job process ID.   
Enter pay run groups that correspond to the selected run category. To process all pay run groups, leave the run category blank. To reference an existing run pay calculation, enter a payroll calculation job process ID.   
The pay groups and pay run groups do not contain any details that match the run category provided. Please select pay groups and pay run groups that correspond to the run category, omit the run category or provide a payroll calculation job process ID.   
top
 

PeriodObject

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

PeriodObjectID

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

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

Pay_Group_Pay_Run_Group_SelectionObjectID

part of: Pay_Group_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, Organization_Reference_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
 

Run_CategoryObject

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

Run_CategoryObjectID

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

Response_Filter

part of: Get_Run_Pay_Calculation_Request, Get_Run_Pay_Calculation_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
 

Run_Pay_Calculation_Response_Group

part of: Get_Run_Pay_Calculation_Request, Get_Run_Pay_Calculation_Response
Used to specify what groups of information are provided in the response
 
Parameter name Type/Value Cardinality Description Validations
Include_Process_Calculation_Criteria  boolean  [0..1]  Include Process Criteria in response   
Include_Pay_Groups_Being_Calculated  boolean  [0..1]  Include Pay Groups being calculated in response   
Include_Process_Information  boolean  [0..1]  Include Process Information in response   
Include_Process_History  boolean  [0..1]  Include Process History in response   
Include_Messages  boolean  [0..1]  Include Messages in response   
top
 

Response_Results

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

Run_Pay_Calculation_Response_Data

part of: Get_Run_Pay_Calculation_Response
Pay Calculation Response
 
Parameter name Type/Value Cardinality Description Validations
Run_Pay_Calculation  Run_Pay_Calculation  [0..*]  Pay Calculation   
top
 

Run_Pay_Calculation

part of: Run_Pay_Calculation_Response_Data
Pay Calculation Response Data
 
Parameter name Type/Value Cardinality Description Validations
Run_Pay_Calculation_Reference  Background_Process_RuntimeObject  [0..1]  Pay Calculation Response Data   
Process_Reference  Background_ProcessObject  [0..1]  Process   
Status_Reference  Background_Process_Runtime_StatusObject  [0..1]  Status   
Current_Processing_Time  string  [0..1]  Current Processing Time   
Average_Processing_Time  string  [0..1]  Average Processing Time   
Run_Pay_Calculation_Process_Criteria  Run_Pay_Calculation_Process_Calculation_Criteria  [0..1]  Calculation Criteria   
Pay_Groups_Being_Calculated  Pay_Groups_Being_Calculated  [0..1]  Pay Groups being Calculated   
Run_Pay_Calculation_Process_Information  Run_Pay_Calculation_Process_Information  [0..1]  Process Information   
Run_Pay_Calculation_Process_History  Run_Pay_Calculation_Process_History  [0..1]  Process History   
Run_Pay_Calculation_Messages  Run_Pay_Calculation_Messages  [0..1]  Messages   
top
 

Background_ProcessObject

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

Background_ProcessObjectID

part of: Background_ProcessObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Custom_Report_ID, Data_Set_ID, Integration_System_ID, Partitioned_Background_Process_ID, Report_Group_ID, Saved_Parameters_ID, Web_Service_Operation_Name, Workday_Integration_System_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".   
@parent_id  string  [1..1]  Contains a unique identifier for an instance of a parent object   
@parent_type  WID, System_User_ID, System_User_OpenID, System_User_OpenID_Connect_Internal, System_User_OpenID_Internal, WorkdayUserName  [1..1]  The unique identifier type of a parent object   
top
 

Background_Process_Runtime_StatusObject

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

Background_Process_Runtime_StatusObjectID

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

Run_Pay_Calculation_Process_Calculation_Criteria

part of: Run_Pay_Calculation
Calculation Criteria
 
Parameter name Type/Value Cardinality Description Validations
Period_Reference  PeriodObject  [0..1]  Period for Payroll Run   
Pay_Run_Group_Selection_Reference  Pay_Run_Group_SelectionObject  [0..*]  Pay Run Group for Payroll Run   
Calculation_Options  Run_Pay_Calculation_Statuses  [0..*]  Statuses for Payroll Run   
Limit_Accounting_Population_Based_on_Calculation_Criteria  boolean  [0..1]  Boolean to Limit Accounting Population Based on Calculation Criteria   
top
 

Pay_Run_Group_SelectionObject

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

Run_Pay_Calculation_Statuses

part of: Run_Pay_Calculation_Process_Calculation_Criteria
Statuses for Payroll Run
 
Parameter name Type/Value Cardinality Description Validations
Pay_Calculation_Status_Reference  Unique_IdentifierObject  [0..*]  Calculation Status for Payroll Run   
top
 

Unique_IdentifierObject

part of: Run_Pay_Calculation_Process_Information, Run_Pay_Calculation_Process_Information, Run_Pay_Calculation_Statuses, Run_Pay_Calculation_Step_Detail, Run_Pay_Calculation_Step_Detail, Pay_Group_Period_Pay_Calculation_Status_As_Of_Now
 
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
 

Pay_Groups_Being_Calculated

part of: Run_Pay_Calculation
Pay Groups being Calculated
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Run_Detail_Pay_Calc_Status  Payroll_Run_Detail_Pay_Calc_Status  [0..*]  Contains Pay Groups being calculated as part of running a payroll calculation   
top
 

Payroll_Run_Detail_Pay_Calc_Status

part of: Pay_Groups_Being_Calculated
Contains Pay Groups being calculated as part of running a payroll calculation
 
Parameter name Type/Value Cardinality Description Validations
Pay_Group_Reference  Pay_GroupObject  [0..1]  The Pay Group   
Run_Category_Reference  Run_CategoryObject  [0..1]  The Run Category   
Calc_Status  Calc_Status  [0..*]  Contains sets of status counts of Payroll Results   
top
 

Pay_GroupObject

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

Pay_GroupObjectID

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

Calc_Status

part of: Payroll_Run_Detail_Pay_Calc_Status
Contains sets of status counts of Payroll Results
 
Parameter name Type/Value Cardinality Description Validations
Pay_Group_Period_Pay_Calculation_Status_As_Of_Now  Pay_Group_Period_Pay_Calculation_Status_As_Of_Now  [0..*]  Contains counts of Pay Results in different states along with the Pay Cycle Type and Action Reason   
top
 

Pay_Group_Period_Pay_Calculation_Status_As_Of_Now

part of: Calc_Status
Contains counts of Pay Results in different states along with the Pay Cycle Type and Action Reason
 
Parameter name Type/Value Cardinality Description Validations
Pay_Cycle_Type_Reference  Unique_IdentifierObject  [0..1]  Whether these results are from an On Cycle or Off Cycle run.   
Action_Reason  string  [0..1]  Action Reason that was given when an action was taken to adjust a Payroll Result   
In_Progress  decimal (12, 0) >0   [0..1]  Number of Payroll Results that are in In Progress status   
Requires_Recalculation  decimal (12, 0) >0   [0..1]  Number of Payroll Results that are in Requires Recalc status   
Pending_Completion  decimal (12, 0) >0   [0..1]  Number of Payroll Results that are in Pending Completion status   
In_Error  decimal (12, 0) >0   [0..1]  Number of Payroll Results that are in In Error status   
On_Hold  decimal (12, 0) >0   [0..1]  Number of Payroll Results that are in On Hold status   
Completed  decimal (12, 0) >0   [0..1]  Number of Payroll Results that are in Completed status   
Total  decimal (12, 0) >0   [0..1]  Total number of Payroll Results   
top
 

Run_Pay_Calculation_Process_Information

part of: Run_Pay_Calculation
Process Information
 
Parameter name Type/Value Cardinality Description Validations
Process_Type_Reference  Background_Process_TypeObject  [0..1]  Background Process   
Scheduled_Start_Date_and_Time  dateTime  [0..1]  Scheduled Start Date and Time   
Actual_Start_Date_and_Time  dateTime  [0..1]  Actual Start Date and Time in Minutes   
Completed_Date_and_Time  dateTime  [0..1]  Completed Date and Time in Minutes   
Submitted_By_Reference  InstanceObject  [0..1]  Created By   
Total_Processing_Time  string  [0..1]  Total Processing Time   
Job_Definition_Reference  Unique_IdentifierObject  [0..1]  Job Definition   
Job_Mode_Reference  Unique_IdentifierObject  [0..1]  Job Mode   
Job_Size  decimal (12, 0)   [0..1]  Job Size   
Job_Parameters  decimal (30, 10)   [0..1]  Job Parameters   
Application_Keys  decimal (26, 6)   [0..1]  Application Keys   
Run_Pay_Calculation_Technical_Details  Run_Pay_Calculation_Technical_Details  [0..*]  Run Pay Calculation Technical Details   
Run_Pay_Calculation_Step_Details  Run_Pay_Calculation_Step_Details  [0..*]  Step Details   
top
 

Background_Process_TypeObject

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

Background_Process_TypeObjectID

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

InstanceObject

part of: Run_Pay_Calculation_Process_Information
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]     
ID  Instance_ID  [0..*]     
top
 

Instance_ID

part of: InstanceObject
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@parent_id  string  [1..1]     
@parent_type  string  [1..1]     
@type  string  [1..1]     
top
 

Run_Pay_Calculation_Technical_Details

part of: Run_Pay_Calculation_Process_Information
Technical Details
 
Parameter name Type/Value Cardinality Description Validations
Workday_Integration_Cloud_Platform__ESB__Process_ID  string (36)   [0..1]  Workday Integration Cloud Platform (ESB) Process IDs   
top
 

Run_Pay_Calculation_Step_Details

part of: Run_Pay_Calculation_Process_Information
Step Details
 
Parameter name Type/Value Cardinality Description Validations
Run_Pay_Calculation_Step_Detail  Run_Pay_Calculation_Step_Detail  [0..*]  Process Information   
top
 

Run_Pay_Calculation_Step_Detail

part of: Run_Pay_Calculation_Step_Details
Process Information
 
Parameter name Type/Value Cardinality Description Validations
Job_Step_Runtime_Reference  Unique_IdentifierObject  [0..1]  Job Step Runtime   
Status_Reference  Unique_IdentifierObject  [0..1]  Status of Job Step Runtime   
Start_Date_Time  dateTime  [0..1]  Concurrent Job Start Date Time in Minutes   
End_Date_Time  dateTime  [0..1]  Concurrent Job End Date Time in Minutes   
Cumulative_Step_Time__min_  decimal (10, 0)   [0..1]  Cumulative Step Time   
Result_Count  decimal (12, 0) >0   [0..1]  Number of Concurrent Job Step Runtime Results   
Partitions_Completed  decimal (12, 0) >0   [0..1]  Partitions Completed   
Total_Partitions  decimal (12, 0) >0   [0..1]  Total Number of Partitions   
Runtime_Parameters  decimal (12, 0) >0   [0..1]  Job Step Runtime Parameters   
top
 

Run_Pay_Calculation_Process_History

part of: Run_Pay_Calculation
Process History
 
Parameter name Type/Value Cardinality Description Validations
Actual_Start_Date_and_Time  dateTime  [0..1]  Actual Start Date and Time (Minute)   
Completed_Date_and_Time  dateTime  [0..1]  Completed Date and Time (Minute)   
Total_Processing_Time__hour_min_sec_  string  [0..1]  Total Processing Time for Display (hh:mm:ss)   
top
 

Run_Pay_Calculation_Messages

part of: Run_Pay_Calculation
Run Pay Calculation Messages contains all the messages returned while executing the Run Payroll Calculation task
 
Parameter name Type/Value Cardinality Description Validations
Run_Pay_Calculation_Message  Run_Pay_Calculation_Message  [0..*]  Contains values for Pay Calculation Messages: - Date and Time - Severity - Message - Background Process   
top
 

Run_Pay_Calculation_Message

part of: Run_Pay_Calculation_Messages
Run Pay Calculation Message is created when there is information returned while executing Run Payroll Calculation
 
Parameter name Type/Value Cardinality Description Validations
Date_and_Time  dateTime  [0..1]  Date and Time of Error   
Severity  string  [0..1]  Error Severity   
Message  string  [0..1]  Error Message   
Background_Process_Reference  Background_Process_RuntimeObject  [0..1]  Background Process Reference   
top
 

Background_Process_RuntimeReferenceEnumeration

part of: Background_Process_RuntimeObjectID
Base Type
string
top
 

PeriodReferenceEnumeration

part of: PeriodObjectID
Base Type
string
top
 

Pay_Group_Pay_Run_Group_SelectionReferenceEnumeration

part of: Pay_Group_Pay_Run_Group_SelectionObjectID
Base Type
string
top
 

Run_CategoryReferenceEnumeration

part of: Run_CategoryObjectID
Base Type
string
top
 

Background_ProcessReferenceEnumeration

part of: Background_ProcessObjectID
Base Type
string
top
 

Base Type
string

top
 

Background_Process_Runtime_StatusReferenceEnumeration

part of: Background_Process_Runtime_StatusObjectID
Base Type
string
top
 

Pay_Run_Group_SelectionReferenceEnumeration

part of: Pay_Run_Group_SelectionObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

Pay_GroupReferenceEnumeration

part of: Pay_GroupObjectID
Base Type
string
top
 

Background_Process_TypeReferenceEnumeration

part of: Background_Process_TypeObjectID
Base Type
string
top