public class

PayrollInterfaceModule

extends AbstractWorkdayModule
java.lang.Object
   ↳ org.mule.modules.workday.AbstractWorkdayModule
     ↳ org.mule.modules.workday.payrollinterface.PayrollInterfaceModule
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

The Payroll Interface Web Service contains operations that expose Workday Human Capital Management Business Services data for integration with external payroll systems.

Summary

Fields
private PayrollInterfacePort client The client, mainly for mocking purposes.
private String username The Workday account's username
Public Constructors
PayrollInterfaceModule()
Public Methods
void connect(String payrollInterfaceUser, String payrollInterfacePassword, String payrollInterfaceEndpoint, String payrollInterfaceWsdlLocation)
Connects to Workday
void disconnect()
Disconnects
GetBatchesResponseType getBatches(GetBatchesRequestType batchesRequest)
Retrieves data related to an externally loaded Batch and its associated Application Input (e.g.
PayrollInterfacePort getClient()
String getConnectionIdentifier()
Connection identifier
GetExternalPayGroupsResponseType getExternalPayGroups(GetExternalPayGroupsRequestType externalPayGroupsRequest)
This operation retrieves data related to an External Pay Group (e.g.
GetExternalPayrollInputsResponseType getExternalPayrollInputs(GetExternalPayrollInputsRequestType externalPayrollInputsRequest)
Retrieves data related to External Payroll Inputs (e.g.
GetPayeesResponseType getPayees(GetPayeesRequestType payeesRequest)
Retrieves data related to Payees (e.g.
GetPeriodSchedulesResponseType getPeriodSchedulesPayrollInterface(GetPeriodSchedulesRequestType getPeriodSchedulesRequest)
Return Period Schedules
String getUsername()
GetWorkerCostingAllocationsResponseType getWorkerCostingAllocationsPayrollInterface(GetWorkerCostingAllocationsRequestType getWorkerCostingAllocationsRequest)
Get Worker- or Position Restrictions-based costing allocations, either for specific criteria or for all workers or positions.
PutExternalPayGroupResponseType putExternalPayGroup(PutExternalPayGroupRequestType externalPayGroup)
This web service operation allows the user to do the following: 1 - Update Last Extract Created for External Pay Group by providing External Pay Group Reference, Integration System Reference, and Date Time.
ExternalPayActualResponseType putExternalPayrollActuals(PutExternalPayrollActualsRequestType externalPayrollActuals)
Gives you the ability to import third-party payroll actual hours worked into Workday.
PutExternalPayrollInputResponseType putExternalPayrollInput(PutExternalPayrollInputRequestType externalPayrollInput)
Accepts periodic employee pay data from an external partner for use in Payroll Interface web service APIs.
PutExternalPayrollResultsResponseType putExternalPayrollResults(PutExternalPayrollResultsRequestType externalPayrollResults)
Allows the input of multiple payroll results from external systems into Workday.
PutPeriodScheduleResponseType putPeriodSchedulePayrollInterface(PutPeriodScheduleRequestType putPeriodScheduleRequest)
This public web service operation is designed to add/update Period Schedules
void setClient(Object client)
void setClient(PayrollInterfacePort client)
void setUsername(String username)
boolean validateConnection()
Validate connection
[Expand]
Inherited Methods
From class org.mule.modules.workday.AbstractWorkdayModule
From class java.lang.Object

Fields

private PayrollInterfacePort client

The client, mainly for mocking purposes. *

private String username

The Workday account's username

Public Constructors

public PayrollInterfaceModule ()

Public Methods

public void connect (String payrollInterfaceUser, String payrollInterfacePassword, String payrollInterfaceEndpoint, String payrollInterfaceWsdlLocation)

Connects to Workday

Parameters
payrollInterfaceUser Workday user
payrollInterfacePassword Workday password
payrollInterfaceEndpoint Workday endpoint
payrollInterfaceWsdlLocation Workday WSDL location
Throws
ConnectionException

public void disconnect ()

Disconnects

public GetBatchesResponseType getBatches (GetBatchesRequestType batchesRequest)

Retrieves data related to an externally loaded Batch and its associated Application Input (e.g. Payroll, External Payroll, Absence).

Parameters
batchesRequest Request element used to find and get Batches and their associated data.
Returns
  • element containing instances of Batch and each of its associated data.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public PayrollInterfacePort getClient ()

public String getConnectionIdentifier ()

Connection identifier

Returns
  • connection identifier

public GetExternalPayGroupsResponseType getExternalPayGroups (GetExternalPayGroupsRequestType externalPayGroupsRequest)

This operation retrieves data related to an External Pay Group (e.g. Pay Group expected to have Payroll processed on an external non-Workday system).

Parameters
externalPayGroupsRequest Request element used to find and get External Pay Groups and their associated data.
Returns
  • element containing instances of External Pay Group and each of its associated data.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public GetExternalPayrollInputsResponseType getExternalPayrollInputs (GetExternalPayrollInputsRequestType externalPayrollInputsRequest)

Retrieves data related to External Payroll Inputs (e.g. associated with an External Earning/Deduction).

Parameters
externalPayrollInputsRequest Request element used to find and get External Payroll Input entries and their associated data.
Returns
  • element containing instances of External Payroll Inputs and each of its associated data.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public GetPayeesResponseType getPayees (GetPayeesRequestType payeesRequest)

Retrieves data related to Payees (e.g. Employees) that belong to an External Pay Group (e.g. Pay Group expected to have Payroll processed on an external non-Workday system). Data returned includes Employment, Personal, Earnings and Deductions.

Parameters
payeesRequest Request element used to find and get Payees and their associated data.
Returns
  • element containing instances of Payees and each of his/her associated data.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public GetPeriodSchedulesResponseType getPeriodSchedulesPayrollInterface (GetPeriodSchedulesRequestType getPeriodSchedulesRequest)

Return Period Schedules

Parameters
getPeriodSchedulesRequest The request object for the operation
Returns
  • The response from the operation
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public String getUsername ()

public GetWorkerCostingAllocationsResponseType getWorkerCostingAllocationsPayrollInterface (GetWorkerCostingAllocationsRequestType getWorkerCostingAllocationsRequest)

Get Worker- or Position Restrictions-based costing allocations, either for specific criteria or for all workers or positions. Can include only the external integration references or the full allocation details.

Parameters
getWorkerCostingAllocationsRequest The request object for the operation
Returns
  • The response from the operation
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public PutExternalPayGroupResponseType putExternalPayGroup (PutExternalPayGroupRequestType externalPayGroup)

This web service operation allows the user to do the following: 1 - Update Last Extract Created for External Pay Group by providing External Pay Group Reference, Integration System Reference, and Date Time. 2 - Update External Payroll Period Status by providing Pay Group Reference, Period Reference, and Period Status Reference. Note: Put Pay Group (Web Service) allows the user to add/update the full External Pay Group instance with all required details.

Parameters
externalPayGroup Put External Pay Group Request element
Returns
  • response element
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public ExternalPayActualResponseType putExternalPayrollActuals (PutExternalPayrollActualsRequestType externalPayrollActuals)

Gives you the ability to import third-party payroll actual hours worked into Workday.

Parameters
externalPayrollActuals Request element
Returns
  • response element
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public PutExternalPayrollInputResponseType putExternalPayrollInput (PutExternalPayrollInputRequestType externalPayrollInput)

Accepts periodic employee pay data from an external partner for use in Payroll Interface web service APIs.

Parameters
externalPayrollInput Request element used to load/update an instance of an External Payroll Input entry
Returns
  • Response element from load/update of an instance of External Payroll Input
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public PutExternalPayrollResultsResponseType putExternalPayrollResults (PutExternalPayrollResultsRequestType externalPayrollResults)

Allows the input of multiple payroll results from external systems into Workday.

Parameters
externalPayrollResults External Payroll Result Request
Returns
  • Put External Payroll Results Response
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public PutPeriodScheduleResponseType putPeriodSchedulePayrollInterface (PutPeriodScheduleRequestType putPeriodScheduleRequest)

This public web service operation is designed to add/update Period Schedules

Parameters
putPeriodScheduleRequest The request object for the operation
Returns
  • The response from the operation
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public void setClient (Object client)

Parameters
client

public void setClient (PayrollInterfacePort client)

Parameters
client

public void setUsername (String username)

Parameters
username

public boolean validateConnection ()

Validate connection

Returns
  • true if the connector is connected