public interface

PayrollPort

com.workday.payroll.PayrollPort
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). This class was generated by Apache CXF 2.5.1 2014-02-28T19:23:40.926-03:00 Generated source version: 2.5.1

Summary

Public Methods
abstract 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.
abstract ChangeNoRetroProcessingPriorToResponseType changeNoRetroProcessingPriorTo(ChangeNoRetroProcessingPriorToRequestType body)
This Web Service is to allow clients to push out the "No Retro Processing Prior to" dates for workers.
abstract GetCanadianRecordOfEmploymentDataResponseType getCanadianRecordOfEmploymentData(GetCanadianRecordOfEmploymentDataRequestType body)
Return Approved Canadian Record of Employment records for outbound ROE processing.
abstract GetCompanyPaymentDatesResponseType getCompanyPaymentDates(GetCompanyPaymentDatesRequestType body)
This operation returns a list of Payment Dates for a given Company and Date Range parms.
abstract GetMultipleWorksiteReportResponseType getMultipleWorksiteReport(GetMultipleWorksiteReportRequestType body)
This web service retrieves multiple worksite report data for a company and quarter.
abstract GetPayrollBalancesResponseType getPayrollBalances(GetPayrollBalancesRequestType body)
Return Payroll Balances for selected Workers, Companies, Pay Calculations for specified Balance Periods.
abstract 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.
abstract GetPayrollHistoryPaymentsResponseType getPayrollHistoryPayments(GetPayrollHistoryPaymentsRequestType body)
Retrieves Workday History Payments.
abstract GetPayrollInputsResponseType getPayrollInputs(GetPayrollInputsRequestType body)
DEPRECATED: Please use the "Get Submit Payroll Inputs" operation instead.
abstract 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.
abstract 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.
abstract GetPayrollOffCyclePaymentsResponseType getPayrollOffCyclePayments(GetPayrollOffCyclePaymentsRequestType body)
This operation returns Payroll Off-cycle Payments (Manual and On-demand) for either a list of references or request criteria.
abstract GetPayrollPayeeFICAsResponseType getPayrollPayeeFICAs(GetPayrollPayeeFICAsRequestType body)
This operation returns FICA data for a Worker and Position.
abstract 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.
abstract GetPayrollPayslipsResponseType getPayrollPayslips(GetPayrollPayslipsRequestType body)
Return payroll payslips for an outsourced payment group that was generated by a settlement run.
abstract GetPayrollResultsResponseType getPayrollResults(GetPayrollResultsRequestType body)
Return Payroll Results for selected Workers, Companies, Pay Calculations for specified Date Range.
abstract 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.
abstract GetWorkerTaxTreatiesResponseType getPayrollWorkerTaxTreaties(GetPayrollWorkerTaxTreatiesRequestType body)
Allows an external client to retrieve Worker Tax Treaty data.
abstract GetPeriodSchedulesResponseType getPeriodSchedules(GetPeriodSchedulesRequestType body)
Return Period Schedules
abstract GetPeriodicCompanyTaxFilingDataResponseType getPeriodicCompanyTaxFilingData(GetPeriodicCompanyTaxFilingDataRequestType body)
This web service operation retrieves periodic tax filing data for a company.
abstract GetPeriodicWorkerTaxFilingDataResponseType getPeriodicWorkerTaxFilingData(GetPeriodicWorkerTaxFilingDataRequestType body)
This web service operation returns periodic tax filing data based on specified criteria.
abstract GetQuarterlyWorkerTaxDataResponseType getQuarterlyWorkerTaxFilingData(GetQuarterlyWorkerTaxDataRequestType body)
This web service operation returns quarterly tax filing data based on specified criteria.
abstract GetSubmitPayrollInputsResponseType getSubmitPayrollInputs(GetSubmitPayrollInputsRequestType body)
This public web service operation is designed to retrieve Payroll Input data from the Workday system.
abstract GetWorkerCostingAllocationsResponseType getWorkerCostingAllocations(GetWorkerCostingAllocationsRequestType body)
Get Worker- or Position Restrictions-based costing allocations, either for specific criteria or for all workers or positions.
abstract 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.
abstract PutPayrollFederalW4TaxElectionResponseType putPayrollFederalW4TaxElection(PutPayrollFederalW4TaxElectionRequestType body)
This web service operation is designed to put worker federal W-4 tax election data.
abstract PutPayrollHistoryPaymentResponseType putPayrollHistoryPayment(PutPayrollHistoryPaymentRequestType body)
This public web service operation is designed to add/update historical payroll payments from external systems into Workday Payroll.
abstract PutPayrollInputResponseType putPayrollInput(PutPayrollInputRequestType body)
DEPRECATED: Please use the "Submit Payroll Input" operation instead.
abstract 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.
abstract PutPayrollLimitOverrideResponseType putPayrollLimitOverride(PutPayrollLimitOverrideRequestType body)
This web service is for adding or updating Payroll Limit Override for Worker.
abstract PutPayrollOffCyclePaymentResponseType putPayrollOffCyclePayment(PutPayrollOffCyclePaymentRequestType body)
This public web service operation is designed to add/update off cycle payments from external systems into Workday.
abstract PutPayrollPayeeFICAResponseType putPayrollPayeeFICA(PutPayrollPayeeFICARequestType body)
Public Web Service for updating Payroll Payee FICA Withholdings for specific worker.
abstract PutPayrollPayeeOngoingWorkJurisdictionTaxElectionResponseType putPayrollPayeeOngoingWorkJurisdictionTaxElection(PutPayrollPayeeOngoingWorkJurisdictionTaxElectionRequestType body)
This web service operation is designed to put worker ongoing work jurisdiction tax election data into Workday Payroll
abstract 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.
abstract PutWorkerTaxTreatyResponseType putPayrollWorkerTaxTreaty(PutPayrollWorkerTaxTreatyRequestType body)
This web service method allows external clients to add or update a Payroll Worker Tax Treaty
abstract PutPeriodScheduleResponseType putPeriodSchedule(PutPeriodScheduleRequestType body)
This public web service operation is designed to add/update Period Schedules
abstract SubmitPayrollInputResponseType submitPayrollInput(SubmitPayrollInputRequestType body)
This public web service operation is designed to add/update Payroll Input data from external systems into Workday.

Public Methods

public abstract 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 abstract 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 abstract GetCanadianRecordOfEmploymentDataResponseType getCanadianRecordOfEmploymentData (GetCanadianRecordOfEmploymentDataRequestType body)

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

Parameters
body

public abstract GetCompanyPaymentDatesResponseType getCompanyPaymentDates (GetCompanyPaymentDatesRequestType body)

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

Parameters
body

public abstract 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 abstract GetPayrollBalancesResponseType getPayrollBalances (GetPayrollBalancesRequestType body)

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

Parameters
body

public abstract 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 abstract 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 abstract GetPayrollInputsResponseType getPayrollInputs (GetPayrollInputsRequestType body)

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

Parameters
body

public abstract 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 abstract 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 abstract 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 abstract GetPayrollPayeeFICAsResponseType getPayrollPayeeFICAs (GetPayrollPayeeFICAsRequestType body)

This operation returns FICA data for a Worker and Position.

Parameters
body

public abstract 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 abstract GetPayrollPayslipsResponseType getPayrollPayslips (GetPayrollPayslipsRequestType body)

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

Parameters
body

public abstract GetPayrollResultsResponseType getPayrollResults (GetPayrollResultsRequestType body)

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

Parameters
body

public abstract 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 abstract GetWorkerTaxTreatiesResponseType getPayrollWorkerTaxTreaties (GetPayrollWorkerTaxTreatiesRequestType body)

Allows an external client to retrieve Worker Tax Treaty data.

Parameters
body

public abstract GetPeriodSchedulesResponseType getPeriodSchedules (GetPeriodSchedulesRequestType body)

Return Period Schedules

Parameters
body

public abstract 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 abstract GetPeriodicWorkerTaxFilingDataResponseType getPeriodicWorkerTaxFilingData (GetPeriodicWorkerTaxFilingDataRequestType body)

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

Parameters
body

public abstract GetQuarterlyWorkerTaxDataResponseType getQuarterlyWorkerTaxFilingData (GetQuarterlyWorkerTaxDataRequestType body)

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

Parameters
body

public abstract GetSubmitPayrollInputsResponseType getSubmitPayrollInputs (GetSubmitPayrollInputsRequestType body)

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

Parameters
body

public abstract 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 abstract 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 abstract PutPayrollFederalW4TaxElectionResponseType putPayrollFederalW4TaxElection (PutPayrollFederalW4TaxElectionRequestType body)

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

Parameters
body

public abstract 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 abstract 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 abstract 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 abstract PutPayrollLimitOverrideResponseType putPayrollLimitOverride (PutPayrollLimitOverrideRequestType body)

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

Parameters
body

public abstract 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 abstract PutPayrollPayeeFICAResponseType putPayrollPayeeFICA (PutPayrollPayeeFICARequestType body)

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

Parameters
body

public abstract 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 abstract 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 abstract PutWorkerTaxTreatyResponseType putPayrollWorkerTaxTreaty (PutPayrollWorkerTaxTreatyRequestType body)

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

Parameters
body

public abstract PutPeriodScheduleResponseType putPeriodSchedule (PutPeriodScheduleRequestType body)

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

Parameters
body

public abstract SubmitPayrollInputResponseType submitPayrollInput (SubmitPayrollInputRequestType body)

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

Parameters
body