Service Directory > v25.1 > Payroll

 

Web Service: Payroll (v25.1)

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

Version

Operations

Operation Description
Assign_Costing_Allocation 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. 
Change_No_Retro_Processing_Prior_To This Web Service is to allow clients to push out the "No Retro Processing Prior to" dates for workers. 
Get_Canadian_Record_of_Employment_Data Return Approved Canadian Record of Employment records for outbound ROE processing. 
Get_Company_Payment_Dates This operation returns a list of Payment Dates for a given Company and Date Range parms. 
Get_Multiple_Worksite_Report 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. 
Get_Paycheck_Deliveries The Paycheck Deliveries operation returns all the Paycheck delivery information for Workers. Includes the Delivery Method, and also how to receive copies of their payslips (Electronic/Paper etc). 
Get_Payroll_Balances Return Payroll Balances for selected Workers, Companies, Pay Calculations for specified Balance Periods. 
Get_Payroll_Deduction_Recipients This web service operation is designed to retrieve all the Payroll Deduction Recipients matching the specified criteria. The request criteria can be for a single transaction based on Reference, or all Deduction Recipients can be retrieved if no criteria is specified. 
Get_Payroll_Federal_W-4_Tax_Election 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. 
Get_Payroll_History_Payments Retrieves Workday History Payments. History Payments in Workday are historical payments imported from external and/or legacy payroll systems. 
Get_Payroll_Involuntary_Withholding_Orders 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. 
Get_Payroll_Limit_Overrides 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. 
Get_Payroll_Off-cycle_Payments 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. 
Get_Payroll_Payee_FICAs This operation returns FICA data for a Worker and Position. 
Get_Payroll_Payee_FUTAs This web service operation is designed to get worker FUTA tax election data from either the Reference ID or the Worker Reference/Company Reference/Effective Date. 
Get_Payroll_Payee_Ongoing_Work_Jurisdiction_Tax_Election 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. 
Get_Payroll_Payee_PT1s This web service is used to return Payroll Payee PT1s 
Get_Payroll_Payee_RPP_or_DPSP_Registration_Numbers This web service is used to return RPP and DPSP registration numbers 
Get_Payroll_Payee_TD1s This web service is used to return Payroll Payee TD1s 
Get_Payroll_Payslips Return payroll payslips for an outsourced payment group that was generated by a settlement run. 
Get_Payroll_Results Return Payroll Results for selected Workers, Companies, Pay Calculations for specified Date Range. 
Get_Payroll_USA_State_and_Local_Tax_Elections 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. 
Get_Payroll_Worker_Tax_Treaties Allows an external client to retrieve Worker Tax Treaty data. 
Get_Period_Schedules Return Period Schedules 
Get_Periodic_Company_Tax_Filing_Data 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. 
Get_Periodic_Worker_Tax_Filing_Data This web service operation returns periodic tax filing data based on specified criteria. 
Get_Quarterly_Worker_Tax_Filing_Data This web service operation returns quarterly tax filing data based on specified criteria. 
Get_Single_Legal_Entities This web service retrieves Single Legal Entity company relationships. 
Get_Submit_Payroll_Inputs This public web service operation is designed to retrieve Payroll Input data from the Workday system. 
Get_Successor_Employers This public web service operation is designed to retrieve Successor Employer relationships. If an effective date is provided, it will retrieve Successor Employer relationships that are active as of the effective date. Otherwise, all Successor Employer relationships will be retrieved. 
Get_Tax_Levy_Deduction_Restrictions This web service will extract all tax levy deduction restrictions. For loading the above tax levy deduction restrictions, there is a corresponding web service: Put Tax Levy Deduction Restriction. 
Get_W-2_W-2C_Printing_Election This web service operation is designed to get worker W-2/W-2C printing elections from either the Reference ID or the Worker Reference/Company Reference 
Get_Worker_Costing_Allocations 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. 
Import_Payroll_Input This public web service operation is designed to bulk add/update Payroll Input data from external systems into Workday. 
Put_Canadian_Record_of_Employment_Data 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. 
Put_Paycheck_Delivery__Public_ This operation allows the entry of a workers Paycheck Delivery and Payslip Printing options. 
Put_Payroll_Deduction_Recipient This web service operation is designed to put Deduction Recipient data into Workday Payroll 
Put_Payroll_Federal_W-4_Tax_Election This web service operation is designed to put worker federal W-4 tax election data. 
Put_Payroll_History_Payment This public web service operation is designed to add/update historical payroll payments from external systems into Workday Payroll. 
Put_Payroll_Involuntary_Withholding_Order 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. 
Put_Payroll_Limit_Override This web service is for adding or updating Payroll Limit Override for Worker. 
Put_Payroll_Off-cycle_Payment This public web service operation is designed to add/update off cycle payments from external systems into Workday. 
Put_Payroll_Payee_FICA Public Web Service for updating Payroll Payee FICA Withholdings for specific worker. 
Put_Payroll_Payee_FUTA Web Service for entering and modifying FUTA records 
Put_Payroll_Payee_Ongoing_Work_Jurisdiction_Tax_Election This web service operation is designed to put worker ongoing work jurisdiction tax election data into Workday Payroll 
Put_Payroll_Payee_PT1 This web service is used to load PT1's 
Put_Payroll_Payee_RPP_or_DPSP_Registration_Number This web service is used to load RPP and DPSP Registration Numbers 
Put_Payroll_Payee_TD1 This web service is used to load TD1's 
Put_Payroll_ROE_Prior_Period_History_Results END OF LIFE This Web Service is used to load the Canadian Employee Prior History Results for ROE processing. 
Put_Payroll_USA_State_and_Local_Tax_Election 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. 
Put_Payroll_Worker_Tax_Treaty This web service method allows external clients to add or update a Payroll Worker Tax Treaty 
Put_Period_Schedule This public web service operation is designed to add/update Period Schedules 
Put_Single_Legal_Entity This web service is designed to add or update Single Legal Entity company relationships 
Put_Successor_Employer This public web service operation is designed to add/update Successor Employer relationships. 
Put_Tax_Levy_Deduction_Restriction This web service will load tax levy deduction restrictions. For extracting the above deduction restrictions, there is a corresponding web service: Get Tax Levy Deduction Restrictions. 
Put_W-2_W-2C_Printing_Election This web service operation is designed to put W-2/W-2C Printing Election data. 
Submit_Payroll_Input This public web service operation is designed to add/update Payroll Input data from external systems into Workday.