public class

CxfPayrollClient

extends AbstractCxfWorkdayClient<A>
implements PayrollPort
java.lang.Object
   ↳ org.mule.modules.workday.api.AbstractCxfWorkdayClient<A>
     ↳ org.mule.modules.workday.payroll.CxfPayrollClient

Summary

[Expand]
Inherited Fields
From class org.mule.modules.workday.api.AbstractCxfWorkdayClient
Public Constructors
CxfPayrollClient(String username, String password, String endpoint, String wsdlLocation)
Public Methods
AssignCostingAllocationResponseType assignCostingAllocation(AssignCostingAllocationRequestType body)
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 body)
This Web Service is to allow clients to push out the "No Retro Processing Prior to" dates for workers.
GetCanadianRecordOfEmploymentDataResponseType getCanadianRecordOfEmploymentData(GetCanadianRecordOfEmploymentDataRequestType body)
Return Approved Canadian Record of Employment records for outbound ROE processing.
GetCompanyPaymentDatesResponseType getCompanyPaymentDates(GetCompanyPaymentDatesRequestType body)
This operation returns a list of Payment Dates for a given Company and Date Range parms.
GetMultipleWorksiteReportResponseType getMultipleWorksiteReport(GetMultipleWorksiteReportRequestType body)
This web service retrieves multiple worksite report data for a company and quarter.
GetPayrollBalancesResponseType getPayrollBalances(GetPayrollBalancesRequestType body)
Return Payroll Balances for selected Workers, Companies, Pay Calculations for specified Balance Periods.
GetPayrollFederalW4TaxElectionsResponseType getPayrollFederalW4TaxElection(GetPayrollFederalW4TaxElectionsRequestType body)
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 body)
Retrieves Workday History Payments.
GetPayrollInputsResponseType getPayrollInputs(GetPayrollInputsRequestType body)
DEPRECATED: Please use the "Get Submit Payroll Inputs" operation instead.
GetPayrollInvoluntaryWithholdingOrdersResponseType getPayrollInvoluntaryWithholdingOrders(GetPayrollInvoluntaryWithholdingOrdersRequestType body)
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 body)
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 body)
This operation returns Payroll Off-cycle Payments (Manual and On-demand) for either a list of references or request criteria.
GetPayrollPayeeFICAsResponseType getPayrollPayeeFICAs(GetPayrollPayeeFICAsRequestType body)
This operation returns FICA data for a Worker and Position.
GetPayrollPayeeOngoingWorkJurisdictionTaxElectionResponseType getPayrollPayeeOngoingWorkJurisdictionTaxElection(GetPayrollPayeeOngoingWorkJurisdictionTaxElectionRequestType body)
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 body)
Return payroll payslips for an outsourced payment group that was generated by a settlement run.
GetPayrollResultsResponseType getPayrollResults(GetPayrollResultsRequestType body)
Return Payroll Results for selected Workers, Companies, Pay Calculations for specified Date Range.
GetPayrollUSAStateAndLocalTaxElectionsResponseType getPayrollUSAStateAndLocalTaxElections(GetPayrollUSAStateAndLocalTaxElectionsRequestType body)
Retrieve Worker Tax Elections for State and Local Tax Authorities NOTE: The As Of Entry Moment and As Of Effective date fields in the Response Filter are not supported by this method - any values you pass in via these fields will be ignored.
GetWorkerTaxTreatiesResponseType getPayrollWorkerTaxTreaties(GetPayrollWorkerTaxTreatiesRequestType body)
Allows an external client to retrieve Worker Tax Treaty data.
GetPeriodSchedulesResponseType getPeriodSchedules(GetPeriodSchedulesRequestType body)
Return Period Schedules
GetPeriodicCompanyTaxFilingDataResponseType getPeriodicCompanyTaxFilingData(GetPeriodicCompanyTaxFilingDataRequestType body)
This web service operation retrieves periodic tax filing data for a company.
GetPeriodicWorkerTaxFilingDataResponseType getPeriodicWorkerTaxFilingData(GetPeriodicWorkerTaxFilingDataRequestType body)
This web service operation returns periodic tax filing data based on specified criteria.
GetQuarterlyWorkerTaxDataResponseType getQuarterlyWorkerTaxFilingData(GetQuarterlyWorkerTaxDataRequestType body)
This web service operation returns quarterly tax filing data based on specified criteria.
GetSubmitPayrollInputsResponseType getSubmitPayrollInputs(GetSubmitPayrollInputsRequestType body)
This public web service operation is designed to retrieve Payroll Input data from the Workday system.
GetWorkerCostingAllocationsResponseType getWorkerCostingAllocations(GetWorkerCostingAllocationsRequestType body)
Get Worker- or Position Restrictions-based costing allocations, either for specific criteria or for all workers or positions.
PutCanadianRecordOfEmploymentDataResponseType putCanadianRecordOfEmploymentData(PutCanadianRecordOfEmploymentDataRequestType body)
The Web services is used to update the ROE instances statuses, issued date, and issued number when the file is imported from Service Canada into Workday System.
PutPayrollFederalW4TaxElectionResponseType putPayrollFederalW4TaxElection(PutPayrollFederalW4TaxElectionRequestType body)
This web service operation is designed to put worker federal W-4 tax election data.
PutPayrollHistoryPaymentResponseType putPayrollHistoryPayment(PutPayrollHistoryPaymentRequestType body)
This public web service operation is designed to add/update historical payroll payments from external systems into Workday Payroll.
PutPayrollInputResponseType putPayrollInput(PutPayrollInputRequestType body)
DEPRECATED: Please use the "Submit Payroll Input" operation instead.
PutPayrollInvoluntaryWithholdingOrderResponseType putPayrollInvoluntaryWithholdingOrder(PutPayrollInvoluntaryWithholdingOrderRequestType body)
This web service will load 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 body)
This web service is for adding or updating Payroll Limit Override for Worker.
PutPayrollOffCyclePaymentResponseType putPayrollOffCyclePayment(PutPayrollOffCyclePaymentRequestType body)
This public web service operation is designed to add/update off cycle payments from external systems into Workday.
PutPayrollPayeeFICAResponseType putPayrollPayeeFICA(PutPayrollPayeeFICARequestType body)
Public Web Service for updating Payroll Payee FICA Withholdings for specific worker.
PutPayrollPayeeOngoingWorkJurisdictionTaxElectionResponseType putPayrollPayeeOngoingWorkJurisdictionTaxElection(PutPayrollPayeeOngoingWorkJurisdictionTaxElectionRequestType body)
This web service operation is designed to put worker ongoing work jurisdiction tax election data into Workday Payroll
PutPayrollUSAStateAndLocalTaxElectionResponseType putPayrollUSAStateAndLocalTaxElection(PutPayrollUSAStateAndLocalTaxElectionRequestType body)
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 body)
This web service method allows external clients to add or update a Payroll Worker Tax Treaty
PutPeriodScheduleResponseType putPeriodSchedule(PutPeriodScheduleRequestType body)
This public web service operation is designed to add/update Period Schedules
SubmitPayrollInputResponseType submitPayrollInput(SubmitPayrollInputRequestType body)
This public web service operation is designed to add/update Payroll Input data from external systems into Workday.
Protected Methods
Class<PayrollPort> portType()
Class<? extends Service> serviceType()
[Expand]
Inherited Methods
From class org.mule.modules.workday.api.AbstractCxfWorkdayClient
From class java.lang.Object
From interface com.workday.payroll.PayrollPort

Public Constructors

public CxfPayrollClient (String username, String password, String endpoint, String wsdlLocation)

Parameters
username
password
endpoint
wsdlLocation

Public Methods

public AssignCostingAllocationResponseType assignCostingAllocation (AssignCostingAllocationRequestType body)

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
body

public ChangeNoRetroProcessingPriorToResponseType changeNoRetroProcessingPriorTo (ChangeNoRetroProcessingPriorToRequestType body)

This Web Service is to allow clients to push out the "No Retro Processing Prior to" dates for workers.

Parameters
body

public GetCanadianRecordOfEmploymentDataResponseType getCanadianRecordOfEmploymentData (GetCanadianRecordOfEmploymentDataRequestType body)

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

Parameters
body

public GetCompanyPaymentDatesResponseType getCompanyPaymentDates (GetCompanyPaymentDatesRequestType body)

This operation returns a list of Payment Dates for a given Company and Date Range parms.

Parameters
body

public GetMultipleWorksiteReportResponseType getMultipleWorksiteReport (GetMultipleWorksiteReportRequestType body)

This web service 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
body

public GetPayrollBalancesResponseType getPayrollBalances (GetPayrollBalancesRequestType body)

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

Parameters
body

public GetPayrollFederalW4TaxElectionsResponseType getPayrollFederalW4TaxElection (GetPayrollFederalW4TaxElectionsRequestType body)

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
body

public GetPayrollHistoryPaymentsResponseType getPayrollHistoryPayments (GetPayrollHistoryPaymentsRequestType body)

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

Parameters
body

public GetPayrollInputsResponseType getPayrollInputs (GetPayrollInputsRequestType body)

DEPRECATED: Please use the "Get Submit Payroll Inputs" operation instead.

Parameters
body

public GetPayrollInvoluntaryWithholdingOrdersResponseType getPayrollInvoluntaryWithholdingOrders (GetPayrollInvoluntaryWithholdingOrdersRequestType body)

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
body

public GetPayrollLimitOverridesResponseType getPayrollLimitOverrides (GetPayrollLimitOverridesRequestType body)

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
body

public GetPayrollOffCyclePaymentsResponseType getPayrollOffCyclePayments (GetPayrollOffCyclePaymentsRequestType body)

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
body

public GetPayrollPayeeFICAsResponseType getPayrollPayeeFICAs (GetPayrollPayeeFICAsRequestType body)

This operation returns FICA data for a Worker and Position.

Parameters
body

public GetPayrollPayeeOngoingWorkJurisdictionTaxElectionResponseType getPayrollPayeeOngoingWorkJurisdictionTaxElection (GetPayrollPayeeOngoingWorkJurisdictionTaxElectionRequestType body)

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
body

public GetPayrollPayslipsResponseType getPayrollPayslips (GetPayrollPayslipsRequestType body)

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

Parameters
body

public GetPayrollResultsResponseType getPayrollResults (GetPayrollResultsRequestType body)

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

Parameters
body

public GetPayrollUSAStateAndLocalTaxElectionsResponseType getPayrollUSAStateAndLocalTaxElections (GetPayrollUSAStateAndLocalTaxElectionsRequestType body)

Retrieve Worker Tax Elections for State and Local Tax Authorities NOTE: The As Of Entry Moment and As Of Effective date fields in the Response Filter are not supported by this method - any values you pass in via these fields will be ignored. Use the Effective Date field in the Request Criteria instead to retrieve elections effective as of a given date. 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
body

public GetWorkerTaxTreatiesResponseType getPayrollWorkerTaxTreaties (GetPayrollWorkerTaxTreatiesRequestType body)

Allows an external client to retrieve Worker Tax Treaty data.

Parameters
body

public GetPeriodSchedulesResponseType getPeriodSchedules (GetPeriodSchedulesRequestType body)

Return Period Schedules

Parameters
body

public GetPeriodicCompanyTaxFilingDataResponseType getPeriodicCompanyTaxFilingData (GetPeriodicCompanyTaxFilingDataRequestType body)

This web service operation retrieves periodic tax filing data for a company. Tax filing data is aggregated by Payment Date and Third Party Sick Pay indicator.

Parameters
body

public GetPeriodicWorkerTaxFilingDataResponseType getPeriodicWorkerTaxFilingData (GetPeriodicWorkerTaxFilingDataRequestType body)

This web service operation returns periodic tax filing data based on specified criteria.

Parameters
body

public GetQuarterlyWorkerTaxDataResponseType getQuarterlyWorkerTaxFilingData (GetQuarterlyWorkerTaxDataRequestType body)

This web service operation returns quarterly tax filing data based on specified criteria.

Parameters
body

public GetSubmitPayrollInputsResponseType getSubmitPayrollInputs (GetSubmitPayrollInputsRequestType body)

This public web service operation is designed to retrieve Payroll Input data from the Workday system.

Parameters
body

public GetWorkerCostingAllocationsResponseType getWorkerCostingAllocations (GetWorkerCostingAllocationsRequestType body)

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
body

public PutCanadianRecordOfEmploymentDataResponseType putCanadianRecordOfEmploymentData (PutCanadianRecordOfEmploymentDataRequestType body)

The Web services is used to update the ROE instances statuses, issued date, and issued number when the file is imported from Service Canada into Workday System.

Parameters
body

public PutPayrollFederalW4TaxElectionResponseType putPayrollFederalW4TaxElection (PutPayrollFederalW4TaxElectionRequestType body)

This web service operation is designed to put worker federal W-4 tax election data.

Parameters
body

public PutPayrollHistoryPaymentResponseType putPayrollHistoryPayment (PutPayrollHistoryPaymentRequestType body)

This public web service operation is designed to add/update historical payroll payments from external systems into Workday Payroll.

Parameters
body

public PutPayrollInputResponseType putPayrollInput (PutPayrollInputRequestType body)

DEPRECATED: Please use the "Submit Payroll Input" operation instead. This public web service operation is designed to add/update Payroll Input data from external systems into Workday.

Parameters
body

public PutPayrollInvoluntaryWithholdingOrderResponseType putPayrollInvoluntaryWithholdingOrder (PutPayrollInvoluntaryWithholdingOrderRequestType body)

This web service will load 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 web service: Get Payroll Involuntary Withholding Orders.

Parameters
body

public PutPayrollLimitOverrideResponseType putPayrollLimitOverride (PutPayrollLimitOverrideRequestType body)

This web service is for adding or updating Payroll Limit Override for Worker.

Parameters
body

public PutPayrollOffCyclePaymentResponseType putPayrollOffCyclePayment (PutPayrollOffCyclePaymentRequestType body)

This public web service operation is designed to add/update off cycle payments from external systems into Workday.

Parameters
body

public PutPayrollPayeeFICAResponseType putPayrollPayeeFICA (PutPayrollPayeeFICARequestType body)

Public Web Service for updating Payroll Payee FICA Withholdings for specific worker.

Parameters
body

public PutPayrollPayeeOngoingWorkJurisdictionTaxElectionResponseType putPayrollPayeeOngoingWorkJurisdictionTaxElection (PutPayrollPayeeOngoingWorkJurisdictionTaxElectionRequestType body)

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

Parameters
body

public PutPayrollUSAStateAndLocalTaxElectionResponseType putPayrollUSAStateAndLocalTaxElection (PutPayrollUSAStateAndLocalTaxElectionRequestType body)

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
body

public PutWorkerTaxTreatyResponseType putPayrollWorkerTaxTreaty (PutPayrollWorkerTaxTreatyRequestType body)

This web service method allows external clients to add or update a Payroll Worker Tax Treaty

Parameters
body

public PutPeriodScheduleResponseType putPeriodSchedule (PutPeriodScheduleRequestType body)

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

Parameters
body

public SubmitPayrollInputResponseType submitPayrollInput (SubmitPayrollInputRequestType body)

This public web service operation is designed to add/update Payroll Input data from external systems into Workday.

Parameters
body

Protected Methods

protected Class<PayrollPort> portType ()

protected Class<? extends Service> serviceType ()