public class

PayrollModule

extends AbstractWorkdayModule
java.lang.Object
   ↳ org.mule.modules.workday.AbstractWorkdayModule
     ↳ org.mule.modules.workday.payroll.PayrollModule
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

The Workday Payroll Web Service contains operations that expose Workday Payroll data for integration with third parties (such as time and attendance).

Summary

Fields
private PayrollPort client The client, mainly for mocking purposes.
private String username The Workday account's username
Public Constructors
PayrollModule()
Public Methods
AssignCostingAllocationResponseType assignCostingAllocation(AssignCostingAllocationRequestType costingAllocation)
This service operation will submit requests to replace, add, update or delete costing allocations (distributions) for worker/position/earning and position restrictions criteria.
ChangeNoRetroProcessingPriorToResponseType changeNoRetroProcessingPriorTo(ChangeNoRetroProcessingPriorToRequestType noRetroProcessingPriorTo)
Allows clients to push out the "No Retro Processing Prior to" dates for workers.
void connect(String payrollUser, String payrollPassword, String payrollEndpoint, String payrollWsdlLocation)
Connects to Workday
void disconnect()
Disconnects
GetCanadianRecordOfEmploymentDataResponseType getCanadianRecordOfEmploymentData(GetCanadianRecordOfEmploymentDataRequestType canadianRecordOfEmploymentDataRequest)
Return Approved Canadian Record of Employment records for outbound ROE processing.
PayrollPort getClient()
GetCompanyPaymentDatesResponseType getCompanyPaymentDates(GetCompanyPaymentDatesRequestType companyPaymentDatesRequest)
Returns a list of Payment Dates for a given Company and Date Range parms.
String getConnectionIdentifier()
Connection identifier
GetMultipleWorksiteReportResponseType getMultipleWorksiteReport(GetMultipleWorksiteReportRequestType multipleWorksiteReportRequest)
Retrieves multiple worksite report data for a company and quarter.
GetPayrollBalancesResponseType getPayrollBalances(GetPayrollBalancesRequestType payrollBalancesRequest)
Return Payroll Balances for selected Workers, Companies, Pay Calculations for specified Balance Periods.
GetPayrollFederalW4TaxElectionsResponseType getPayrollFederalW4TaxElection(GetPayrollFederalW4TaxElectionsRequestType payrollFederalW4TaxElectionRequest)
This web service operation is designed to get worker federal W-4 tax election data from either the Reference ID or the Worker Reference/Company Reference/Effective Date.
GetPayrollHistoryPaymentsResponseType getPayrollHistoryPayments(GetPayrollHistoryPaymentsRequestType getPayrollHistoryPaymentsRequest)
Retrieves Workday History Payments.
GetPayrollInvoluntaryWithholdingOrdersResponseType getPayrollInvoluntaryWithholdingOrders(GetPayrollInvoluntaryWithholdingOrdersRequestType payrollInvoluntaryWithholdingOrdersRequest)
This web service will extract all types of Involuntary Withholding Orders: 1-Bankruptcy Order 2-Creditor Garnishment 3-Federal Administrative Wage Garnishment 4-Federal Student Loan 5-Federal Tax Levy 6-State Tax Levy 7-Wage Assignment 8-Support Order 9-Support Order (Lump Sum) For loading the above Withholding Orders, there is a corresponding web service: Put Payroll Involuntary Withholding Order.
GetPayrollLimitOverridesResponseType getPayrollLimitOverrides(GetPayrollLimitOverridesRequestType payrollLimitOverridesRequest)
This web service will return Payroll Limit Override from either Payroll Limit Override Reference, or Worker Reference/Pay Component/Start Date/End Date filter criteria.
GetPayrollOffCyclePaymentsResponseType getPayrollOffcyclePayments(GetPayrollOffCyclePaymentsRequestType payrollOffcyclePaymentsRequest)
This operation returns Payroll Off-cycle Payments (Manual and On-demand) for either a list of references or request criteria.
GetPayrollPayeeFICAsResponseType getPayrollPayeeFicas(GetPayrollPayeeFICAsRequestType payrollPayeeFicasRequest)
Returns FICA data for a Worker and Position.
GetPayrollPayeeOngoingWorkJurisdictionTaxElectionResponseType getPayrollPayeeOngoingWorkJurisdictionTaxElection(GetPayrollPayeeOngoingWorkJurisdictionTaxElectionRequestType getPayrollPayeeOngoingWorkJurisdictionTaxElectionRequest)
This web service operation is designed to get worker ongoing work jurisdiction tax election data from either the Reference ID or the Worker Reference/Company Reference/Effective Date.
GetPayrollPayslipsResponseType getPayrollPayslips(GetPayrollPayslipsRequestType payrollPayslipsRequest)
Return payroll payslips for an outsourced payment group that was generated by a settlement run.
GetPayrollResultsResponseType getPayrollResults(GetPayrollResultsRequestType payrollResultsRequest)
Return Payroll Results for selected Workers, Companies, Pay Calculations for specified Date Range.
GetPayrollUSAStateAndLocalTaxElectionsResponseType getPayrollUsaStateAndLocalTaxElections(GetPayrollUSAStateAndLocalTaxElectionsRequestType payrollUsaStateAndLocalTaxElectionsRequest)
Retrieve Worker Tax Elections for State and Local Tax Authorities The operation does not support criteria based requests with an As_Of_Entry_DateTime in the past, unless for paging consistency the As_Of_Entry_DateTime matches the page 1 request.
GetWorkerTaxTreatiesResponseType getPayrollWorkerTaxTreaties(GetPayrollWorkerTaxTreatiesRequestType payrollWorkerTaxTreatiesRequest)
Allows an external client to retrieve Worker Tax Treaty data.
GetPeriodSchedulesResponseType getPeriodSchedules(GetPeriodSchedulesRequestType periodSchedulesRequest)
Returns Period Schedules
GetPeriodicCompanyTaxFilingDataResponseType getPeriodicCompanyTaxFilingData(GetPeriodicCompanyTaxFilingDataRequestType periodicCompanyTaxFilingDataRequest)
Retrieves periodic tax filing data for a company.
GetPeriodicWorkerTaxFilingDataResponseType getPeriodicWorkerTaxFilingData(GetPeriodicWorkerTaxFilingDataRequestType periodicWorkerTaxFilingDataRequest)
Returns periodic tax filing data based on specified criteria.
GetQuarterlyWorkerTaxDataResponseType getQuarterlyWorkerTaxFilingData(GetQuarterlyWorkerTaxDataRequestType quarterlyWorkerTaxFilingDataRequest)
Returns quarterly tax filing data based on specified criteria.
GetSubmitPayrollInputsResponseType getSubmitPayrollInputs(GetSubmitPayrollInputsRequestType submitPayrollInputsRequest)
Retrieves Payroll Input data from the Workday system.
String getUsername()
GetWorkerCostingAllocationsResponseType getWorkerCostingAllocations(GetWorkerCostingAllocationsRequestType workerCostingAllocationsRequest)
Get Worker- or Position Restrictions-based costing allocations, either for specific criteria or for all workers or positions.
PutCanadianRecordOfEmploymentDataResponseType putCanadianRecordOfEmploymentData(PutCanadianRecordOfEmploymentDataRequestType canadianRecordOfEmploymentData)
Updates the ROE instances statuses, issued date, and issued number when the file is imported from Service Canada into Workday System.
PutPayrollFederalW4TaxElectionResponseType putPayrollFederalW4TaxElection(PutPayrollFederalW4TaxElectionRequestType payrollFederalW4TaxElection)
Put worker federal W-4 tax election data.
PutPayrollHistoryPaymentResponseType putPayrollHistoryPayment(PutPayrollHistoryPaymentRequestType payrollHistoryPayment)
Adds/updates historical payroll payments from external systems into Workday Payroll.
PutPayrollInvoluntaryWithholdingOrderResponseType putPayrollInvoluntaryWithholdingOrder(PutPayrollInvoluntaryWithholdingOrderRequestType putPayrollInvoluntaryWithholdingOrderRequest)
Loads all types of Withholding Orders: 1-Bankruptcy Order 2-Creditor Garnishment 3-Federal Administrative Wage Garnishment 4-Federal Student Loan 5-Federal Tax Levy 6-State Tax Levy 7-Wage Assignment 8-Support Order (Lump Sum) 9-Support Order This method also supports Amend/Terminate Support Order.
PutPayrollLimitOverrideResponseType putPayrollLimitOverride(PutPayrollLimitOverrideRequestType payrollLimitOverride)
Adds or updates Payroll Limit Override for Worker.
PutPayrollOffCyclePaymentResponseType putPayrollOffcyclePayment(PutPayrollOffCyclePaymentRequestType payrollOffcyclePayment)
Adds/updates off cycle payments from external systems into Workday.
PutPayrollPayeeFICAResponseType putPayrollPayeeFica(PutPayrollPayeeFICARequestType payrollPayeeFica)
Updates Payroll Payee FICA Withholdings for specific worker.
PutPayrollPayeeOngoingWorkJurisdictionTaxElectionResponseType putPayrollPayeeOngoingWorkJurisdictionTaxElection(PutPayrollPayeeOngoingWorkJurisdictionTaxElectionRequestType putPayrollPayeeOngoingWorkJurisdictionTaxElectionRequest)
This web service operation is designed to put worker ongoing work jurisdiction tax election data into Workday Payroll
PutPayrollUSAStateAndLocalTaxElectionResponseType putPayrollUsaStateAndLocalTaxElection(PutPayrollUSAStateAndLocalTaxElectionRequestType payrollUsaStateAndLocalTaxElection)
Create Worker Tax Elections for State and Local Tax Authorities The operation does not support criteria based requests with an As_Of_Entry_DateTime in the past, unless for paging consistency the As_Of_Entry_DateTime matches the page 1 request.
PutWorkerTaxTreatyResponseType putPayrollWorkerTaxTreaty(PutPayrollWorkerTaxTreatyRequestType payrollWorkerTaxTreaty)
Allows external clients to add or update a Payroll Worker Tax Treaty
PutPeriodScheduleResponseType putPeriodSchedule(PutPeriodScheduleRequestType periodSchedule)
Adds/updates Period Schedules
void setClient(PayrollPort client)
void setUsername(String username)
SubmitPayrollInputResponseType submitPayrollInput(SubmitPayrollInputRequestType payrollInputRequest)
Adds/updates Payroll Input data from external systems into Workday.
boolean validateConnection()
Validate connection
Protected Methods
void setClient(Object client)
[Expand]
Inherited Methods
From class org.mule.modules.workday.AbstractWorkdayModule
From class java.lang.Object

Fields

private PayrollPort client

The client, mainly for mocking purposes. *

private String username

The Workday account's username

Public Constructors

public PayrollModule ()

Public Methods

public AssignCostingAllocationResponseType assignCostingAllocation (AssignCostingAllocationRequestType costingAllocation)

This service operation will submit requests to replace, add, update or delete costing allocations (distributions) for worker/position/earning and position restrictions criteria. This service does not manage strictly earning-level costing overrides.

Parameters
costingAllocation Specifies the options for the business process, as well as the data for the Costing Allocation
Returns
  • element containing the Event and Costing data that was created by this request
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public ChangeNoRetroProcessingPriorToResponseType changeNoRetroProcessingPriorTo (ChangeNoRetroProcessingPriorToRequestType noRetroProcessingPriorTo)

Allows clients to push out the "No Retro Processing Prior to" dates for workers.

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

public void connect (String payrollUser, String payrollPassword, String payrollEndpoint, String payrollWsdlLocation)

Connects to Workday

Parameters
payrollUser Workday user
payrollPassword Workday password
payrollEndpoint Workday endpoint
payrollWsdlLocation Workday WSDL location
Throws
ConnectionException

public void disconnect ()

Disconnects

public GetCanadianRecordOfEmploymentDataResponseType getCanadianRecordOfEmploymentData (GetCanadianRecordOfEmploymentDataRequestType canadianRecordOfEmploymentDataRequest)

Return Approved Canadian Record of Employment records for outbound ROE processing.

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

public PayrollPort getClient ()

public GetCompanyPaymentDatesResponseType getCompanyPaymentDates (GetCompanyPaymentDatesRequestType companyPaymentDatesRequest)

Returns a list of Payment Dates for a given Company and Date Range parms.

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

public String getConnectionIdentifier ()

Connection identifier

Returns
  • connection identifier

public GetMultipleWorksiteReportResponseType getMultipleWorksiteReport (GetMultipleWorksiteReportRequestType multipleWorksiteReportRequest)

Retrieves multiple worksite report data for a company and quarter. The report is used to collect statistical information to supplement statewide data provided through employer's SUI reports.

Parameters
multipleWorksiteReportRequest Request for a multiple worksite report.
Returns
  • Response for a Get Multiple Worksites Report request.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public GetPayrollBalancesResponseType getPayrollBalances (GetPayrollBalancesRequestType payrollBalancesRequest)

Return Payroll Balances for selected Workers, Companies, Pay Calculations for specified Balance Periods.

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

public GetPayrollFederalW4TaxElectionsResponseType getPayrollFederalW4TaxElection (GetPayrollFederalW4TaxElectionsRequestType payrollFederalW4TaxElectionRequest)

This web service operation is designed to get worker federal W-4 tax election data from either the Reference ID or the Worker Reference/Company Reference/Effective Date.

Parameters
payrollFederalW4TaxElectionRequest Element to hold all Payroll Payee W-4 Request Information
Returns
  • Get Payroll Payee W-4s Response Element
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public GetPayrollHistoryPaymentsResponseType getPayrollHistoryPayments (GetPayrollHistoryPaymentsRequestType getPayrollHistoryPaymentsRequest)

Retrieves Workday History Payments. History Payments in Workday are historical payments imported from external and/or legacy payroll systems.

Parameters
getPayrollHistoryPaymentsRequest 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 GetPayrollInvoluntaryWithholdingOrdersResponseType getPayrollInvoluntaryWithholdingOrders (GetPayrollInvoluntaryWithholdingOrdersRequestType payrollInvoluntaryWithholdingOrdersRequest)

This web service will extract all types of Involuntary Withholding Orders: 1-Bankruptcy Order 2-Creditor Garnishment 3-Federal Administrative Wage Garnishment 4-Federal Student Loan 5-Federal Tax Levy 6-State Tax Levy 7-Wage Assignment 8-Support Order 9-Support Order (Lump Sum) For loading the above Withholding Orders, there is a corresponding web service: Put Payroll Involuntary Withholding Order.

Parameters
payrollInvoluntaryWithholdingOrdersRequest Get Payroll Involuntary Withholding Orders Request
Returns
  • Get Payroll Involuntary Withholding Orders Response
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public GetPayrollLimitOverridesResponseType getPayrollLimitOverrides (GetPayrollLimitOverridesRequestType payrollLimitOverridesRequest)

This web service will return Payroll Limit Override from either Payroll Limit Override Reference, or Worker Reference/Pay Component/Start Date/End Date filter criteria.

Parameters
payrollLimitOverridesRequest Element to hold all Payroll Limit Override Request Information
Returns
  • Element to hold the Payroll Limit Override Response.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public GetPayrollOffCyclePaymentsResponseType getPayrollOffcyclePayments (GetPayrollOffCyclePaymentsRequestType payrollOffcyclePaymentsRequest)

This operation returns Payroll Off-cycle Payments (Manual and On-demand) for either a list of references or request criteria. The user can specify the following request criteria: 1 - Payment ID When specified, Payment ID alone will be used as a key to retrieve the off-cycle payment. All other optional criteria will be ignored. 2 - Employee Reference When specified, it will be used along with other optional criteria (except Payment ID) to return off-cycle payments. 3 - Pay Group Reference When specified, it will be used along with other optional criteria (except Payment ID and Employee Reference) to return off-cycle payments. All other optional criteria will be used with either Employee Reference or Pay Group Reference to retrieve off-cycle payments.

Parameters
payrollOffcyclePaymentsRequest Get Payroll Off-cycle Payments Request element
Returns
  • Get Payroll Off-cycle Payments Response element
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public GetPayrollPayeeFICAsResponseType getPayrollPayeeFicas (GetPayrollPayeeFICAsRequestType payrollPayeeFicasRequest)

Returns FICA data for a Worker and Position.

Parameters
payrollPayeeFicasRequest Get Payroll Payee FICAs Request element
Returns
  • Get Payroll Payee FICAs Response element
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public GetPayrollPayeeOngoingWorkJurisdictionTaxElectionResponseType getPayrollPayeeOngoingWorkJurisdictionTaxElection (GetPayrollPayeeOngoingWorkJurisdictionTaxElectionRequestType getPayrollPayeeOngoingWorkJurisdictionTaxElectionRequest)

This web service operation is designed to get worker ongoing work jurisdiction tax election data from either the Reference ID or the Worker Reference/Company Reference/Effective Date.

Parameters
getPayrollPayeeOngoingWorkJurisdictionTaxElectionRequest 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 GetPayrollPayslipsResponseType getPayrollPayslips (GetPayrollPayslipsRequestType payrollPayslipsRequest)

Return payroll payslips for an outsourced payment group that was generated by a settlement run.

Parameters
payrollPayslipsRequest Get Payroll Payslips Request
Returns
  • Get Payroll Payslips Response
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public GetPayrollResultsResponseType getPayrollResults (GetPayrollResultsRequestType payrollResultsRequest)

Return Payroll Results for selected Workers, Companies, Pay Calculations for specified Date Range.

Parameters
payrollResultsRequest Get Payroll Results Request
Returns
  • Get Payroll Results Response
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public GetPayrollUSAStateAndLocalTaxElectionsResponseType getPayrollUsaStateAndLocalTaxElections (GetPayrollUSAStateAndLocalTaxElectionsRequestType payrollUsaStateAndLocalTaxElectionsRequest)

Retrieve Worker Tax Elections for State and Local Tax Authorities The operation does not support criteria based requests with an As_Of_Entry_DateTime in the past, unless for paging consistency the As_Of_Entry_DateTime matches the page 1 request.

Parameters
payrollUsaStateAndLocalTaxElectionsRequest Request for Get Payroll USA State and Local Tax Elections
Returns
  • response element
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public GetWorkerTaxTreatiesResponseType getPayrollWorkerTaxTreaties (GetPayrollWorkerTaxTreatiesRequestType payrollWorkerTaxTreatiesRequest)

Allows an external client to retrieve Worker Tax Treaty data.

Parameters
payrollWorkerTaxTreatiesRequest Get Worker Tax Treaties Request
Returns
  • Get Worker Tax Treaties Response
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public GetPeriodSchedulesResponseType getPeriodSchedules (GetPeriodSchedulesRequestType periodSchedulesRequest)

Returns Period Schedules

Parameters
periodSchedulesRequest Get Period Schedules Request
Returns
  • Get Period Schedules Response
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public GetPeriodicCompanyTaxFilingDataResponseType getPeriodicCompanyTaxFilingData (GetPeriodicCompanyTaxFilingDataRequestType periodicCompanyTaxFilingDataRequest)

Retrieves periodic tax filing data for a company. Tax filing data is aggregated by Payment Date and Third Party Sick Pay indicator.

Parameters
periodicCompanyTaxFilingDataRequest Get Periodic Company Tax Filing Data Request element
Returns
  • Get Periodic Company Tax Filing Data Response element
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public GetPeriodicWorkerTaxFilingDataResponseType getPeriodicWorkerTaxFilingData (GetPeriodicWorkerTaxFilingDataRequestType periodicWorkerTaxFilingDataRequest)

Returns periodic tax filing data based on specified criteria.

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

public GetQuarterlyWorkerTaxDataResponseType getQuarterlyWorkerTaxFilingData (GetQuarterlyWorkerTaxDataRequestType quarterlyWorkerTaxFilingDataRequest)

Returns quarterly tax filing data based on specified criteria.

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

public GetSubmitPayrollInputsResponseType getSubmitPayrollInputs (GetSubmitPayrollInputsRequestType submitPayrollInputsRequest)

Retrieves Payroll Input data from the Workday system.

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

public String getUsername ()

public GetWorkerCostingAllocationsResponseType getWorkerCostingAllocations (GetWorkerCostingAllocationsRequestType workerCostingAllocationsRequest)

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
workerCostingAllocationsRequest Request criteria (specific and universal) for the Get Worker Costing Allocations service.
Returns
  • Wrapper for the data returned by the Get Worker Costing Allocations service.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public PutCanadianRecordOfEmploymentDataResponseType putCanadianRecordOfEmploymentData (PutCanadianRecordOfEmploymentDataRequestType canadianRecordOfEmploymentData)

Updates the ROE instances statuses, issued date, and issued number when the file is imported from Service Canada into Workday System.

Parameters
canadianRecordOfEmploymentData Canadian Record of Employment Request element that contains the Canadian Record of Employment attributes to be updated.
Returns
  • Canadian Record of Employment Data Response element
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public PutPayrollFederalW4TaxElectionResponseType putPayrollFederalW4TaxElection (PutPayrollFederalW4TaxElectionRequestType payrollFederalW4TaxElection)

Put worker federal W-4 tax election data.

Parameters
payrollFederalW4TaxElection Worker federal W-4 object
Returns
  • a response with The Payroll Payee W-4 instance that is created and the data that should be displayed for the instance of the W-4
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public PutPayrollHistoryPaymentResponseType putPayrollHistoryPayment (PutPayrollHistoryPaymentRequestType payrollHistoryPayment)

Adds/updates historical payroll payments from external systems into Workday Payroll.

Parameters
payrollHistoryPayment Request element carrying all information necessary to make a Put Payroll History Payment service request.
Returns
  • contains the reference to the Payroll History Payment added or updated
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public PutPayrollInvoluntaryWithholdingOrderResponseType putPayrollInvoluntaryWithholdingOrder (PutPayrollInvoluntaryWithholdingOrderRequestType putPayrollInvoluntaryWithholdingOrderRequest)

Loads all types of Withholding Orders: 1-Bankruptcy Order 2-Creditor Garnishment 3-Federal Administrative Wage Garnishment 4-Federal Student Loan 5-Federal Tax Levy 6-State Tax Levy 7-Wage Assignment 8-Support Order (Lump Sum) 9-Support Order This method also supports Amend/Terminate Support Order. For extracting the above Withholding Orders, there is a corresponding operation: Get Payroll Involuntary Withholding Orders.

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

public PutPayrollLimitOverrideResponseType putPayrollLimitOverride (PutPayrollLimitOverrideRequestType payrollLimitOverride)

Adds or updates Payroll Limit Override for Worker.

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

public PutPayrollOffCyclePaymentResponseType putPayrollOffcyclePayment (PutPayrollOffCyclePaymentRequestType payrollOffcyclePayment)

Adds/updates off cycle payments from external systems into Workday.

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

public PutPayrollPayeeFICAResponseType putPayrollPayeeFica (PutPayrollPayeeFICARequestType payrollPayeeFica)

Updates Payroll Payee FICA Withholdings for specific worker.

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

public PutPayrollPayeeOngoingWorkJurisdictionTaxElectionResponseType putPayrollPayeeOngoingWorkJurisdictionTaxElection (PutPayrollPayeeOngoingWorkJurisdictionTaxElectionRequestType putPayrollPayeeOngoingWorkJurisdictionTaxElectionRequest)

This web service operation is designed to put worker ongoing work jurisdiction tax election data into Workday Payroll

Parameters
putPayrollPayeeOngoingWorkJurisdictionTaxElectionRequest 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 PutPayrollUSAStateAndLocalTaxElectionResponseType putPayrollUsaStateAndLocalTaxElection (PutPayrollUSAStateAndLocalTaxElectionRequestType payrollUsaStateAndLocalTaxElection)

Create Worker Tax Elections for State and Local Tax Authorities The operation does not support criteria based requests with an As_Of_Entry_DateTime in the past, unless for paging consistency the As_Of_Entry_DateTime matches the page 1 request.

Parameters
payrollUsaStateAndLocalTaxElection State and Local Tax Elections for USA Payroll State Authorities
Returns
  • The results of the last Put Payroll USA State and Local Tax Election Put Request
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public PutWorkerTaxTreatyResponseType putPayrollWorkerTaxTreaty (PutPayrollWorkerTaxTreatyRequestType payrollWorkerTaxTreaty)

Allows external clients to add or update a Payroll Worker Tax Treaty

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

public PutPeriodScheduleResponseType putPeriodSchedule (PutPeriodScheduleRequestType periodSchedule)

Adds/updates Period Schedules

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

public void setClient (PayrollPort client)

Parameters
client

public void setUsername (String username)

Parameters
username

public SubmitPayrollInputResponseType submitPayrollInput (SubmitPayrollInputRequestType payrollInputRequest)

Adds/updates Payroll Input data from external systems into Workday.

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

public boolean validateConnection ()

Validate connection

Returns
  • true if the connector is connected

Protected Methods

protected void setClient (Object client)

Parameters
client