public interface

PayrollInterfacePort

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

Summary

Public Methods
abstract GetBatchesResponseType getBatches(GetBatchesRequestType body)
This operation retrieves data related to an externally loaded Batch and its associated Application Input (e.g.
abstract GetExternalPayGroupsResponseType getExternalPayGroups(GetExternalPayGroupsRequestType body)
This operation retrieves data related to an External Pay Group (e.g.
abstract GetExternalPayrollInputsResponseType getExternalPayrollInputs(GetExternalPayrollInputsRequestType body)
This operation retrieves data related to External Payroll Inputs (e.g.
abstract GetPayeesResponseType getPayees(GetPayeesRequestType body)
This operation retrieves data related to Payees (e.g.
abstract GetPeriodSchedulesResponseType getPeriodSchedules(GetPeriodSchedulesRequestType body)
Return Period Schedules
abstract GetWorkerCostingAllocationsResponseType getWorkerCostingAllocations(GetWorkerCostingAllocationsRequestType body)
Get Worker- or Position Restrictions-based costing allocations, either for specific criteria or for all workers or positions.
abstract PutBatchResponseType putBatch(PutBatchRequestType body)
This operation allows for the loading/updating of a Batch.
abstract PutExternalPayGroupResponseType putExternalPayGroup(PutExternalPayGroupRequestType body)
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.
abstract ExternalPayActualResponseType putExternalPayrollActuals(PutExternalPayrollActualsRequestType body)
This operation, designed to support eligibility, gives you the ability to import third-party payroll actual hours worked into Workday.
abstract PutExternalPayrollInputResponseType putExternalPayrollInput(PutExternalPayrollInputRequestType body)
This operation accepts periodic employee pay data from an external partner for use in Payroll Interface web service APIs.
abstract PutExternalPayrollResultsResponseType putExternalPayrollResults(PutExternalPayrollResultsRequestType body)
This public web service operation allows the input of multiple payroll results from external systems into Workday.
abstract PutPeriodScheduleResponseType putPeriodSchedule(PutPeriodScheduleRequestType body)
This public web service operation is designed to add/update Period Schedules

Public Methods

public abstract GetBatchesResponseType getBatches (GetBatchesRequestType body)

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

Parameters
body

public abstract GetExternalPayGroupsResponseType getExternalPayGroups (GetExternalPayGroupsRequestType body)

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
body

public abstract GetExternalPayrollInputsResponseType getExternalPayrollInputs (GetExternalPayrollInputsRequestType body)

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

Parameters
body

public abstract GetPayeesResponseType getPayees (GetPayeesRequestType body)

This operation 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
body

public abstract GetPeriodSchedulesResponseType getPeriodSchedules (GetPeriodSchedulesRequestType body)

Return Period Schedules

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 PutBatchResponseType putBatch (PutBatchRequestType body)

This operation allows for the loading/updating of a Batch.

Parameters
body

public abstract PutExternalPayGroupResponseType putExternalPayGroup (PutExternalPayGroupRequestType body)

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
body

public abstract ExternalPayActualResponseType putExternalPayrollActuals (PutExternalPayrollActualsRequestType body)

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

Parameters
body

public abstract PutExternalPayrollInputResponseType putExternalPayrollInput (PutExternalPayrollInputRequestType body)

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

Parameters
body

public abstract PutExternalPayrollResultsResponseType putExternalPayrollResults (PutExternalPayrollResultsRequestType body)

This public web service operation allows the input of multiple payroll results from external systems into Workday.

Parameters
body

public abstract PutPeriodScheduleResponseType putPeriodSchedule (PutPeriodScheduleRequestType body)

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

Parameters
body