Service Directory > v32.1 > Payroll > Put_Run_Pay_Calculation
 

Operation: Put_Run_Pay_Calculation

This Web service initiates a Run Pay Calculation Job and returns its Reference ID as a response.


@ - 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: Put_Run_Pay_Calculation_Request

Initial element for the Put Run Pay Calculation
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Run_Pay_Calculation_Data  Run_Pay_Calculation_Data  [1..1]  The element to provide all the variables for Run Pay Calculation. 
Validation Description
Run pay calculation does not process pay groups for external payroll providers. Remove any pay groups with external payroll providers.   
Pay groups require a run category to start a calculation. Provide a valid run category.   
The run category provided does not match any of the pay group details in the pay run groups. Select pay run groups that correspond to the run category or remove the run category to process the entire pay run groups.   
The pay groups and pay run groups do not contain any pay group details that match the run category provided. Select pay groups and pay run groups that correspond to the run category or remove the run category to process only the pay run groups.   
The selected pay groups and pay run groups have multiple current or next periods. Only one period can be processed in a calculation. Provide pay groups or pay run groups with the same current or next period.   
The selected pay groups and pay run groups share a current or next period date of [shared date] that does not match the period date of [period] provided. Provide a matching period date or remove it to use [shared date].   
You have selected more than one option for workers to process. Only one of the following options can be provided: Smart Calculation, Based on Events, or a Calculation Status.   
You have not provided a processing option. Please provide one of the following options:Smart Calculation, Based on Events, or a Calculation Status.   
None of the selected pay groups and pay run groups match the selected calculation status(es). Select a different combination of pay groups and pay run groups or select different status types.   
 
top
 

Response Element: Put_Run_Pay_Calculation_Response

Response Element for Put Pay Calculation
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Application_Instance_Related_Exceptions_Data  Application_Instance_Related_Exceptions_Data  [0..*]  Application Instance Related Exceptions Data.   
Background_Process_Runtime_Data  Background_Process_Runtime_Data  [0..*]  Data for the Background Process Runtime of the Job.   
top
 

Run_Pay_Calculation_Data

part of: Put_Run_Pay_Calculation_Request
The element to provide all the variables for Run Pay Calculation.
 
Parameter name Type/Value Cardinality Description Validations
Period_Reference  PeriodObject  [0..1]  Period.   
Pay_Group_or_Pay_Run_Group_Selection_Reference  Pay_Group_Pay_Run_Group_SelectionObject  [1..*]  Pay groups or Pay Run Groups.   
Run_Category_Reference  Run_CategoryObject  [0..1]  Run Category.   
Smart_Calculation_Reference  boolean  [0..1]  Smart Calculation   
Based_on_Events_Reference  Payroll_Event_CategoryObject  [0..*]  Based on Events   
Include_Requires_ReCalculation  boolean  [0..1]  Include Recalc Status   
Include_Error  boolean  [0..1]  Include Error Status   
Include_Not_Yet_Started  boolean  [0..1]  Include Not Yet Started Status   
Include_In_Progress  boolean  [0..1]  Include In Progress Status   
Accounting_Only_for_Calculation_Criteria  boolean  [0..1]  Accounting Only   
Validation Description
Run pay calculation does not process pay groups for external payroll providers. Remove any pay groups with external payroll providers.   
Pay groups require a run category to start a calculation. Provide a valid run category.   
The run category provided does not match any of the pay group details in the pay run groups. Select pay run groups that correspond to the run category or remove the run category to process the entire pay run groups.   
The pay groups and pay run groups do not contain any pay group details that match the run category provided. Select pay groups and pay run groups that correspond to the run category or remove the run category to process only the pay run groups.   
The selected pay groups and pay run groups have multiple current or next periods. Only one period can be processed in a calculation. Provide pay groups or pay run groups with the same current or next period.   
The selected pay groups and pay run groups share a current or next period date of [shared date] that does not match the period date of [period] provided. Provide a matching period date or remove it to use [shared date].   
You have selected more than one option for workers to process. Only one of the following options can be provided: Smart Calculation, Based on Events, or a Calculation Status.   
You have not provided a processing option. Please provide one of the following options:Smart Calculation, Based on Events, or a Calculation Status.   
None of the selected pay groups and pay run groups match the selected calculation status(es). Select a different combination of pay groups and pay run groups or select different status types.   
top
 

PeriodObject

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

Payroll_Event_CategoryObject

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

Payroll_Event_CategoryObjectID

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

Application_Instance_Related_Exceptions_Data

part of: Put_Run_Pay_Calculation_Response
Element containing Exceptions Data
 
Parameter name Type/Value Cardinality Description Validations
Exceptions_Data  Application_Instance_Exceptions_Data  [0..*]  Exceptions Data   
top
 

Application_Instance_Exceptions_Data

part of: Application_Instance_Related_Exceptions_Data
Element containing application related exceptions data
 
Parameter name Type/Value Cardinality Description Validations
Exception_Data  Exception_Data  [0..*]  Exception Data   
top
 

Exception_Data

part of: Application_Instance_Exceptions_Data
Exception (Errors and Warning) associated with the transaction.
 
Parameter name Type/Value Cardinality Description Validations
Classification  string  [0..1]  Exception Classification (Error or Warning)   
Message  string  [0..1]  Exception Detail   
top
 

Background_Process_Runtime_Data

part of: Put_Run_Pay_Calculation_Response
Background Process Runtime Data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  The Background Process Runtime Reference ID.   
Background_Process_Message_Data  Background_Process_Message_Data_WS  [0..*]  The Data element for Background Process messages.   
top
 

Background_Process_Message_Data_WS

part of: Background_Process_Runtime_Data
Message
 
Parameter name Type/Value Cardinality Description Validations
Timestamp  dateTime  [0..1]  Timestamp   
Severity  string  [0..1]  Message Severity Level   
Message_Summary  string  [0..1]  The text contents of the message   
Line_Number  decimal (12, 0) >0   [0..1]  Line Number   
Line_Identifier  string  [0..1]  Line Identifier   
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
 

Payroll_Event_CategoryReferenceEnumeration

part of: Payroll_Event_CategoryObjectID
Base Type
string
top