Service Directory > v32.1 > Payroll_Interface > Put_External_Payroll_Actuals
 

Operation: Put_External_Payroll_Actuals

This operation, designed to support eligibility, gives you the ability to import third-party payroll actual hours worked into Workday.


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

Payroll Actuals Data allows for Hours worked from an External Payroll System to be loaded into Workday. Each Actual coming in must be associated with an External Payroll Earning or Deduction Code.We recommend aggregating Hours worked into a single value for each period and loading one "value" per Pay Component per Pay Period if possible (as long as there are no overriding requirements for more frequent values, such as for eligibility, etc.). Note: It is possible to load Hours Worked for different days though if needed.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
External_Payroll_Actuals_Data  External_Payroll_Actuals_Employee_Data  [1..1]  Payroll Actuals Data allows for Hours worked from an External Payroll System to be loaded into Workday. Each Actual coming in must be associated with an External Payroll Earning or Deduction Code.We recommend aggregating Hours worked into a single value for each period and loading one "value" per Pay Component per Pay Period if possible (as long as there are no overriding requirements for more frequent values, such as for eligibility, etc.). Note: It is possible to load Hours Worked for different days though if needed.   
top
 

Response Element: External_Pay_Actual_Response

Put External Pay Actuals Web Service Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Employee_Reference  EmployeeObject  [0..1]  Employee reference of updated Employee   
top
 

External_Payroll_Actuals_Employee_Data

part of: Put_External_Payroll_Actuals_Request
Payroll Actuals Data allows for Hours worked from an External Payroll System to be loaded into Workday. Each Actual coming in must be associated with an External Payroll Earning or Deduction Code.We recommend aggregating Hours worked into a single value for each period and loading one "value" per Pay Component per Pay Period if possible (as long as there are no overriding requirements for more frequent values, such as for eligibility, etc.). Note: It is possible to load Hours Worked for different days though if needed.
 
Parameter name Type/Value Cardinality Description Validations
Employee_Reference  EmployeeObject  [1..1]  Worker Reference   
Actuals_Data  External_Payroll_Actuals_Data  [1..*]  Payroll Actuals Data allows for Hours worked from an External Payroll System to be loaded into Workday. Each Actual coming in must be associated with an External Payroll Earning or Deduction Code.We recommend aggregating Hours worked into a single value for each period and loading one "value" per Pay Component per Pay Period if possible (as long as there are no overriding requirements for more frequent values, such as for eligibility, etc.). Note: It is possible to load Hours Worked for different days though if needed. 
Validation Description
No valid Pay Group exists for Position as of Date.   
This is not a valid external Pay Component.   
 
top
 

EmployeeObject

part of: External_Payroll_Actuals_Employee_Data, External_Pay_Actual_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  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
 

External_Payroll_Actuals_Data

part of: External_Payroll_Actuals_Employee_Data
Payroll Actuals Data allows for Hours worked from an External Payroll System to be loaded into Workday. Each Actual coming in must be associated with an External Payroll Earning or Deduction Code.We recommend aggregating Hours worked into a single value for each period and loading one "value" per Pay Component per Pay Period if possible (as long as there are no overriding requirements for more frequent values, such as for eligibility, etc.). Note: It is possible to load Hours Worked for different days though if needed.
 
Parameter name Type/Value Cardinality Description Validations
Date  date  [1..1]  The reference date (typically end date) for the period for which the Hours are being reported (or aggregated). If no data exists for the Date/Pay Component/Position, this will be considered an Add. If data already exists for the Date/Pay Component/Position, this will be considered an Update and the existing Hours will be replaced by the incoming Hours value.   
Pay_Component_Workday_Reference  Pay_ComponentObject  [1..1]  The External Payroll Earning or Deduction Reference associated with the Actuals worked. No Workday Earning/Deduction Codes will be accepted as an External Pay Component.   
External_Payroll_Code  string  [0..1]  A non-unique code used by some Payroll Interface customers. External Payroll Code is available in Workday 13 if the customer has enabled it via the Tenant Setup page.   
Position_Reference  Position_ElementObject  [0..1]  Position Reference (as of Date specified). If the worker only has a single position, the Position Reference is not required, as Hours will be automatically loaded to that position. If the worker has multiple positions, but the System User loading data only has access to one of those positions, the Position Reference is not required as Hours will be loaded to the position the user has access to. If worker has multiple positions and user loading data has access to multiple positions, Position Reference is required. 
Validation Description
Position must be submitted. If you submitted only a Worker reference, then this worker has more than one position you have access to. If you submitted a Position Management Position ID, and more than one worker is filling that position (it has been overlapped) - please submit the worker reference as well so we can identify which worker to process.   
Position [position] is not valid for the worker [worker].   
 
Hours  decimal (18, 6)   [0..1]  The hours worked for the specified Pay Component within the reporting period. Zero is a valid entry.   
Validation Description
No valid Pay Group exists for Position as of Date.   
This is not a valid external Pay Component.   
top
 

Pay_ComponentObject

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

Pay_ComponentObjectID

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

Position_ElementObject

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

Position_ElementObjectID

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

EmployeeReferenceEnumeration

part of: EmployeeObjectID
Base Type
string
top
 

Pay_ComponentReferenceEnumeration

part of: Pay_ComponentObjectID
Base Type
string
top
 

Position_ElementReferenceEnumeration

part of: Position_ElementObjectID
Base Type
string
top