org.mule.modules

mule-module-workday

config

Namespace	http://www.mulesoft.org/schema/mule/wd-payroll
Schema Location	http://www.mulesoft.org/schema/mule/wd-payroll/current/mule-wd-payroll.xsd (View Schema)
Schema Version	2.0
Minimum Mule Version	3.4

Module Overview

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

Summary

Configuration
<wd-payroll:config> Configure an instance of this module

Message Processors
<wd-payroll: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.
<wd-payroll:change-no-retro-processing-prior-to> Allows clients to push out the "No Retro Processing Prior to" dates for workers.
<wd-payroll:get-canadian-record-of-employment-data> Return Approved Canadian Record of Employment records for outbound ROE processing.
<wd-payroll:get-company-payment-dates> Returns a list of Payment Dates for a given Company and Date Range parms.
<wd-payroll:get-multiple-worksite-report> Retrieves multiple worksite report data for a company and quarter.
<wd-payroll:get-payroll-balances> Return Payroll Balances for selected Workers, Companies, Pay Calculations for specified Balance Periods.
<wd-payroll:get-payroll-federal-w4-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.
<wd-payroll:get-payroll-history-payments> Retrieves Workday History Payments.
<wd-payroll: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.
<wd-payroll: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.
<wd-payroll:get-payroll-offcycle-payments> This operation returns Payroll Off-cycle Payments (Manual and On-demand) for either a list of references or request criteria.
<wd-payroll:get-payroll-payee-ficas> Returns FICA data for a Worker and Position.
<wd-payroll: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.
<wd-payroll:get-payroll-payslips> Return payroll payslips for an outsourced payment group that was generated by a settlement run.
<wd-payroll:get-payroll-results> Return Payroll Results for selected Workers, Companies, Pay Calculations for specified Date Range.
<wd-payroll:get-payroll-usa-state-and-local-tax-elections> 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.
<wd-payroll:get-payroll-worker-tax-treaties> Allows an external client to retrieve Worker Tax Treaty data.
<wd-payroll:get-period-schedules> Returns Period Schedules
<wd-payroll:get-periodic-company-tax-filing-data> Retrieves periodic tax filing data for a company.
<wd-payroll:get-periodic-worker-tax-filing-data> Returns periodic tax filing data based on specified criteria.
<wd-payroll:get-quarterly-worker-tax-filing-data> Returns quarterly tax filing data based on specified criteria.
<wd-payroll:get-submit-payroll-inputs> Retrieves Payroll Input data from the Workday system.
<wd-payroll:get-worker-costing-allocations> Get Worker- or Position Restrictions-based costing allocations, either for specific criteria or for all workers or positions.
<wd-payroll:put-canadian-record-of-employment-data> Updates the ROE instances statuses, issued date, and issued number when the file is imported from Service Canada into Workday System.
<wd-payroll:put-payroll-federal-w4-tax-election> Put worker federal W-4 tax election data.
<wd-payroll:put-payroll-history-payment> Adds/updates historical payroll payments from external systems into Workday Payroll.
<wd-payroll:put-payroll-involuntary-withholding-order> 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.
<wd-payroll:put-payroll-limit-override> Adds or updates Payroll Limit Override for Worker.
<wd-payroll:put-payroll-offcycle-payment> Adds/updates off cycle payments from external systems into Workday.
<wd-payroll:put-payroll-payee-fica> Updates Payroll Payee FICA Withholdings for specific worker.
<wd-payroll: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
<wd-payroll: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.
<wd-payroll:put-payroll-worker-tax-treaty> Allows external clients to add or update a Payroll Worker Tax Treaty
<wd-payroll:put-period-schedule> Adds/updates Period Schedules
<wd-payroll:submit-payroll-input> Adds/updates Payroll Input data from external systems into Workday.

Configuration

To use the this module within a flow the namespace to the module must be included. The resulting flow will look similar to the following:

<mule xmlns="http://www.mulesoft.org/schema/mule/core"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xmlns:wd-payroll="http://www.mulesoft.org/schema/mule/wd-payroll"
      xsi:schemaLocation="
               http://www.mulesoft.org/schema/mule/core
               http://www.mulesoft.org/schema/mule/core/current/mule.xsd
               http://www.mulesoft.org/schema/mule/wd-payroll
               http://www.mulesoft.org/schema/mule/wd-payroll/current/mule-wd-payroll.xsd">

      <!-- here goes your flows and configuration elements -->

</mule>

Connection Pool

This connector offers automatic connection management via the use of a connection pool. The pool will act a storage mechanism for all the connections that are in-use by the user of this connector.

Prior to execution of a processor, the connector will attempt to lookup an already established connection and if one doesn't exists it will create one. That lookup mechanism is done in the connection pool via the use of connection variables declared as keys.

The user of the connector can configure the pool by adding a connection-pooling-profile to the connector configuration like this:

    <wd-payroll:connection-pooling-profile maxActive="10" maxIdle="10"
                             exhaustedAction="WHEN_EXHAUSTED_GROW" maxWait="120" minEvictionMillis="60000" evictionCheckIntervalMillis="30000"/>

The following is a list of connection attributes, each connection attribute can be configured at the config element level or they can also be added to each processor. If they are used at the processor level they get the benefit of full expression resolution.

Connection Attributes
Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
payrollUser		Workday user	String	/	UTF-8
payrollPassword		Workday password	String	/	UTF-8
payrollEndpoint		Workday endpoint	String	/	UTF-8
payrollWsdlLocation	https://community.workday.com/custom/developer/API/Payroll/v20/Payroll.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Reconnection Strategies

Reconnection Strategies specify how a connector behaves when its connection fails. You can control how Mule attempts to reconnect by specifying a number of criteria:

The type of exception
Number and frequency of reconnection attempts
The notifications generated, and more

With a reconnection strategy, you can better control the behavior of a failed connection, by configuring it, for example, to re-attempt the connection only once every 15 minutes, and to give up after 30 attempts. You can also send an automatic notification to your IT administrator whenever this reconnection strategy goes into effect. You can even define a strategy that attempts to reconnect only during business hours. Such a setting can prove useful if your server is frequently shut down for nightly maintenance.

Configuration

A reconnection strategy that allows the user to configure how many times a reconnection should be attempted and how long to wait between attempts.

    <wd-payroll:config>
         <reconnect count="5" frequency="1000"/>
    </wd-payroll:config>

Reconnect Attributes
Name	Default Value	Description
frequency	2000	Optional. How often (in ms) to reconnect
count	2	Optional. How many reconnection attempts to make

For more information about reconnection strategies in Mule, or even how to write your own custom reconnection strategy please check this section.

Message Processors

<wd-payroll: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.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
costingAllocation	#[payload]	Optional. Specifies the options for the business process, as well as the data for the Costing Allocation	AssignCostingAllocationRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
payrollUser		Optional. Workday user	String	/	UTF-8
payrollPassword		Optional. Workday password	String	/	UTF-8
payrollEndpoint		Optional. Workday endpoint	String	/	UTF-8
payrollWsdlLocation	https://community.workday.com/custom/developer/API/Payroll/v20/Payroll.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
AssignCostingAllocationResponseType	element containing the Event and Costing data that was created by this request

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-payroll:change-no-retro-processing-prior-to>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
noRetroProcessingPriorTo	#[payload]	Optional. Request object	ChangeNoRetroProcessingPriorToRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
payrollUser		Optional. Workday user	String	/	UTF-8
payrollPassword		Optional. Workday password	String	/	UTF-8
payrollEndpoint		Optional. Workday endpoint	String	/	UTF-8
payrollWsdlLocation	https://community.workday.com/custom/developer/API/Payroll/v20/Payroll.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
ChangeNoRetroProcessingPriorToResponseType	response object

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-payroll:get-canadian-record-of-employment-data>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
canadianRecordOfEmploymentDataRequest	#[payload]	Optional. Request	GetCanadianRecordOfEmploymentDataRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
payrollUser		Optional. Workday user	String	/	UTF-8
payrollPassword		Optional. Workday password	String	/	UTF-8
payrollEndpoint		Optional. Workday endpoint	String	/	UTF-8
payrollWsdlLocation	https://community.workday.com/custom/developer/API/Payroll/v20/Payroll.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetCanadianRecordOfEmploymentDataResponseType	response object

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-payroll:get-company-payment-dates>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
companyPaymentDatesRequest	#[payload]	Optional. Request element	GetCompanyPaymentDatesRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
payrollUser		Optional. Workday user	String	/	UTF-8
payrollPassword		Optional. Workday password	String	/	UTF-8
payrollEndpoint		Optional. Workday endpoint	String	/	UTF-8
payrollWsdlLocation	https://community.workday.com/custom/developer/API/Payroll/v20/Payroll.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetCompanyPaymentDatesResponseType	response object

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-payroll:get-multiple-worksite-report>

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.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
multipleWorksiteReportRequest	#[payload]	Optional. Request for a multiple worksite report.	GetMultipleWorksiteReportRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
payrollUser		Optional. Workday user	String	/	UTF-8
payrollPassword		Optional. Workday password	String	/	UTF-8
payrollEndpoint		Optional. Workday endpoint	String	/	UTF-8
payrollWsdlLocation	https://community.workday.com/custom/developer/API/Payroll/v20/Payroll.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetMultipleWorksiteReportResponseType	Response for a Get Multiple Worksites Report request.

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-payroll:get-payroll-balances>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
payrollBalancesRequest	#[payload]	Optional. Request	GetPayrollBalancesRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
payrollUser		Optional. Workday user	String	/	UTF-8
payrollPassword		Optional. Workday password	String	/	UTF-8
payrollEndpoint		Optional. Workday endpoint	String	/	UTF-8
payrollWsdlLocation	https://community.workday.com/custom/developer/API/Payroll/v20/Payroll.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetPayrollBalancesResponseType	response object

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-payroll:get-payroll-federal-w4-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.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
payrollFederalW4TaxElectionRequest	#[payload]	Optional. Element to hold all Payroll Payee W-4 Request Information	GetPayrollFederalW4TaxElectionsRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
payrollUser		Optional. Workday user	String	/	UTF-8
payrollPassword		Optional. Workday password	String	/	UTF-8
payrollEndpoint		Optional. Workday endpoint	String	/	UTF-8
payrollWsdlLocation	https://community.workday.com/custom/developer/API/Payroll/v20/Payroll.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetPayrollFederalW4TaxElectionsResponseType	Get Payroll Payee W-4s Response Element

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-payroll:get-payroll-history-payments>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
getPayrollHistoryPaymentsRequest	#[payload]	Optional. The request object for the operation	GetPayrollHistoryPaymentsRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
payrollUser		Optional. Workday user	String	/	UTF-8
payrollPassword		Optional. Workday password	String	/	UTF-8
payrollEndpoint		Optional. Workday endpoint	String	/	UTF-8
payrollWsdlLocation	https://community.workday.com/custom/developer/API/Payroll/v20/Payroll.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetPayrollHistoryPaymentsResponseType	The response from the operation

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-payroll: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.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
payrollInvoluntaryWithholdingOrdersRequest	#[payload]	Optional. Get Payroll Involuntary Withholding Orders Request	GetPayrollInvoluntaryWithholdingOrdersRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
payrollUser		Optional. Workday user	String	/	UTF-8
payrollPassword		Optional. Workday password	String	/	UTF-8
payrollEndpoint		Optional. Workday endpoint	String	/	UTF-8
payrollWsdlLocation	https://community.workday.com/custom/developer/API/Payroll/v20/Payroll.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetPayrollInvoluntaryWithholdingOrdersResponseType	Get Payroll Involuntary Withholding Orders Response

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-payroll: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.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
payrollLimitOverridesRequest	#[payload]	Optional. Element to hold all Payroll Limit Override Request Information	GetPayrollLimitOverridesRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
payrollUser		Optional. Workday user	String	/	UTF-8
payrollPassword		Optional. Workday password	String	/	UTF-8
payrollEndpoint		Optional. Workday endpoint	String	/	UTF-8
payrollWsdlLocation	https://community.workday.com/custom/developer/API/Payroll/v20/Payroll.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetPayrollLimitOverridesResponseType	Element to hold the Payroll Limit Override Response.

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-payroll:get-payroll-offcycle-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.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
payrollOffcyclePaymentsRequest	#[payload]	Optional. Get Payroll Off-cycle Payments Request element	GetPayrollOffCyclePaymentsRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
payrollUser		Optional. Workday user	String	/	UTF-8
payrollPassword		Optional. Workday password	String	/	UTF-8
payrollEndpoint		Optional. Workday endpoint	String	/	UTF-8
payrollWsdlLocation	https://community.workday.com/custom/developer/API/Payroll/v20/Payroll.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetPayrollOffCyclePaymentsResponseType	Get Payroll Off-cycle Payments Response element

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-payroll:get-payroll-payee-ficas>

Returns FICA data for a Worker and Position.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
payrollPayeeFicasRequest	#[payload]	Optional. Get Payroll Payee FICAs Request element	GetPayrollPayeeFICAsRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
payrollUser		Optional. Workday user	String	/	UTF-8
payrollPassword		Optional. Workday password	String	/	UTF-8
payrollEndpoint		Optional. Workday endpoint	String	/	UTF-8
payrollWsdlLocation	https://community.workday.com/custom/developer/API/Payroll/v20/Payroll.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetPayrollPayeeFICAsResponseType	Get Payroll Payee FICAs Response element

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-payroll: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.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
getPayrollPayeeOngoingWorkJurisdictionTaxElectionRequest	#[payload]	Optional. The request object for the operation	GetPayrollPayeeOngoingWorkJurisdictionTaxElectionRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
payrollUser		Optional. Workday user	String	/	UTF-8
payrollPassword		Optional. Workday password	String	/	UTF-8
payrollEndpoint		Optional. Workday endpoint	String	/	UTF-8
payrollWsdlLocation	https://community.workday.com/custom/developer/API/Payroll/v20/Payroll.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetPayrollPayeeOngoingWorkJurisdictionTaxElectionResponseType	The response from the operation

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-payroll:get-payroll-payslips>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
payrollPayslipsRequest	#[payload]	Optional. Get Payroll Payslips Request	GetPayrollPayslipsRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
payrollUser		Optional. Workday user	String	/	UTF-8
payrollPassword		Optional. Workday password	String	/	UTF-8
payrollEndpoint		Optional. Workday endpoint	String	/	UTF-8
payrollWsdlLocation	https://community.workday.com/custom/developer/API/Payroll/v20/Payroll.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetPayrollPayslipsResponseType	Get Payroll Payslips Response

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-payroll:get-payroll-results>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
payrollResultsRequest	#[payload]	Optional. Get Payroll Results Request	GetPayrollResultsRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
payrollUser		Optional. Workday user	String	/	UTF-8
payrollPassword		Optional. Workday password	String	/	UTF-8
payrollEndpoint		Optional. Workday endpoint	String	/	UTF-8
payrollWsdlLocation	https://community.workday.com/custom/developer/API/Payroll/v20/Payroll.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetPayrollResultsResponseType	Get Payroll Results Response

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-payroll:get-payroll-usa-state-and-local-tax-elections>

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.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
payrollUsaStateAndLocalTaxElectionsRequest	#[payload]	Optional. Request for Get Payroll USA State and Local Tax Elections	GetPayrollUSAStateAndLocalTaxElectionsRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
payrollUser		Optional. Workday user	String	/	UTF-8
payrollPassword		Optional. Workday password	String	/	UTF-8
payrollEndpoint		Optional. Workday endpoint	String	/	UTF-8
payrollWsdlLocation	https://community.workday.com/custom/developer/API/Payroll/v20/Payroll.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetPayrollUSAStateAndLocalTaxElectionsResponseType	response element

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-payroll:get-payroll-worker-tax-treaties>

Allows an external client to retrieve Worker Tax Treaty data.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
payrollWorkerTaxTreatiesRequest	#[payload]	Optional. Get Worker Tax Treaties Request	GetPayrollWorkerTaxTreatiesRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
payrollUser		Optional. Workday user	String	/	UTF-8
payrollPassword		Optional. Workday password	String	/	UTF-8
payrollEndpoint		Optional. Workday endpoint	String	/	UTF-8
payrollWsdlLocation	https://community.workday.com/custom/developer/API/Payroll/v20/Payroll.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetWorkerTaxTreatiesResponseType	Get Worker Tax Treaties Response

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-payroll:get-period-schedules>

Returns Period Schedules

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
periodSchedulesRequest	#[payload]	Optional. Get Period Schedules Request	GetPeriodSchedulesRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
payrollUser		Optional. Workday user	String	/	UTF-8
payrollPassword		Optional. Workday password	String	/	UTF-8
payrollEndpoint		Optional. Workday endpoint	String	/	UTF-8
payrollWsdlLocation	https://community.workday.com/custom/developer/API/Payroll/v20/Payroll.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetPeriodSchedulesResponseType	Get Period Schedules Response

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-payroll:get-periodic-company-tax-filing-data>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
periodicCompanyTaxFilingDataRequest	#[payload]	Optional. Get Periodic Company Tax Filing Data Request element	GetPeriodicCompanyTaxFilingDataRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
payrollUser		Optional. Workday user	String	/	UTF-8
payrollPassword		Optional. Workday password	String	/	UTF-8
payrollEndpoint		Optional. Workday endpoint	String	/	UTF-8
payrollWsdlLocation	https://community.workday.com/custom/developer/API/Payroll/v20/Payroll.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetPeriodicCompanyTaxFilingDataResponseType	Get Periodic Company Tax Filing Data Response element

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-payroll:get-periodic-worker-tax-filing-data>

Returns periodic tax filing data based on specified criteria.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
periodicWorkerTaxFilingDataRequest	#[payload]	Optional. Request object	GetPeriodicWorkerTaxFilingDataRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
payrollUser		Optional. Workday user	String	/	UTF-8
payrollPassword		Optional. Workday password	String	/	UTF-8
payrollEndpoint		Optional. Workday endpoint	String	/	UTF-8
payrollWsdlLocation	https://community.workday.com/custom/developer/API/Payroll/v20/Payroll.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetPeriodicWorkerTaxFilingDataResponseType	response object

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-payroll:get-quarterly-worker-tax-filing-data>

Returns quarterly tax filing data based on specified criteria.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
quarterlyWorkerTaxFilingDataRequest	#[payload]	Optional. Request	GetQuarterlyWorkerTaxDataRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
payrollUser		Optional. Workday user	String	/	UTF-8
payrollPassword		Optional. Workday password	String	/	UTF-8
payrollEndpoint		Optional. Workday endpoint	String	/	UTF-8
payrollWsdlLocation	https://community.workday.com/custom/developer/API/Payroll/v20/Payroll.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetQuarterlyWorkerTaxDataResponseType	response element

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-payroll:get-submit-payroll-inputs>

Retrieves Payroll Input data from the Workday system.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
submitPayrollInputsRequest	#[payload]	Optional. Request element	GetSubmitPayrollInputsRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
payrollUser		Optional. Workday user	String	/	UTF-8
payrollPassword		Optional. Workday password	String	/	UTF-8
payrollEndpoint		Optional. Workday endpoint	String	/	UTF-8
payrollWsdlLocation	https://community.workday.com/custom/developer/API/Payroll/v20/Payroll.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetSubmitPayrollInputsResponseType	response element

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-payroll: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.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
workerCostingAllocationsRequest	#[payload]	Optional. Request criteria (specific and universal) for the Get Worker Costing Allocations service.	GetWorkerCostingAllocationsRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
payrollUser		Optional. Workday user	String	/	UTF-8
payrollPassword		Optional. Workday password	String	/	UTF-8
payrollEndpoint		Optional. Workday endpoint	String	/	UTF-8
payrollWsdlLocation	https://community.workday.com/custom/developer/API/Payroll/v20/Payroll.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetWorkerCostingAllocationsResponseType	Wrapper for the data returned by the Get Worker Costing Allocations service.

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-payroll:put-canadian-record-of-employment-data>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
canadianRecordOfEmploymentData	#[payload]	Optional. Canadian Record of Employment Request element that contains the Canadian Record of Employment attributes to be updated.	PutCanadianRecordOfEmploymentDataRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
payrollUser		Optional. Workday user	String	/	UTF-8
payrollPassword		Optional. Workday password	String	/	UTF-8
payrollEndpoint		Optional. Workday endpoint	String	/	UTF-8
payrollWsdlLocation	https://community.workday.com/custom/developer/API/Payroll/v20/Payroll.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutCanadianRecordOfEmploymentDataResponseType	Canadian Record of Employment Data Response element

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-payroll:put-payroll-federal-w4-tax-election>

Put worker federal W-4 tax election data.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
payrollFederalW4TaxElection	#[payload]	Optional. Worker federal W-4 object	PutPayrollFederalW4TaxElectionRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
payrollUser		Optional. Workday user	String	/	UTF-8
payrollPassword		Optional. Workday password	String	/	UTF-8
payrollEndpoint		Optional. Workday endpoint	String	/	UTF-8
payrollWsdlLocation	https://community.workday.com/custom/developer/API/Payroll/v20/Payroll.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutPayrollFederalW4TaxElectionResponseType	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

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-payroll:put-payroll-history-payment>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
payrollHistoryPayment	#[payload]	Optional. Request element carrying all information necessary to make a Put Payroll History Payment service request.	PutPayrollHistoryPaymentRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
payrollUser		Optional. Workday user	String	/	UTF-8
payrollPassword		Optional. Workday password	String	/	UTF-8
payrollEndpoint		Optional. Workday endpoint	String	/	UTF-8
payrollWsdlLocation	https://community.workday.com/custom/developer/API/Payroll/v20/Payroll.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutPayrollHistoryPaymentResponseType	contains the reference to the Payroll History Payment added or updated

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-payroll:put-payroll-involuntary-withholding-order>

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.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
putPayrollInvoluntaryWithholdingOrderRequest	#[payload]	Optional. Request object	PutPayrollInvoluntaryWithholdingOrderRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
payrollUser		Optional. Workday user	String	/	UTF-8
payrollPassword		Optional. Workday password	String	/	UTF-8
payrollEndpoint		Optional. Workday endpoint	String	/	UTF-8
payrollWsdlLocation	https://community.workday.com/custom/developer/API/Payroll/v20/Payroll.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutPayrollInvoluntaryWithholdingOrderResponseType	response object

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-payroll:put-payroll-limit-override>

Adds or updates Payroll Limit Override for Worker.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
payrollLimitOverride	#[payload]	Optional. Request object	PutPayrollLimitOverrideRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
payrollUser		Optional. Workday user	String	/	UTF-8
payrollPassword		Optional. Workday password	String	/	UTF-8
payrollEndpoint		Optional. Workday endpoint	String	/	UTF-8
payrollWsdlLocation	https://community.workday.com/custom/developer/API/Payroll/v20/Payroll.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutPayrollLimitOverrideResponseType	response object

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-payroll:put-payroll-offcycle-payment>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
payrollOffcyclePayment	#[payload]	Optional. Request object	PutPayrollOffCyclePaymentRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
payrollUser		Optional. Workday user	String	/	UTF-8
payrollPassword		Optional. Workday password	String	/	UTF-8
payrollEndpoint		Optional. Workday endpoint	String	/	UTF-8
payrollWsdlLocation	https://community.workday.com/custom/developer/API/Payroll/v20/Payroll.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutPayrollOffCyclePaymentResponseType	response object

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-payroll:put-payroll-payee-fica>

Updates Payroll Payee FICA Withholdings for specific worker.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
payrollPayeeFica	#[payload]	Optional. Request object	PutPayrollPayeeFICARequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
payrollUser		Optional. Workday user	String	/	UTF-8
payrollPassword		Optional. Workday password	String	/	UTF-8
payrollEndpoint		Optional. Workday endpoint	String	/	UTF-8
payrollWsdlLocation	https://community.workday.com/custom/developer/API/Payroll/v20/Payroll.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutPayrollPayeeFICAResponseType	response object

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-payroll: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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
putPayrollPayeeOngoingWorkJurisdictionTaxElectionRequest	#[payload]	Optional. The request object for the operation	PutPayrollPayeeOngoingWorkJurisdictionTaxElectionRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
payrollUser		Optional. Workday user	String	/	UTF-8
payrollPassword		Optional. Workday password	String	/	UTF-8
payrollEndpoint		Optional. Workday endpoint	String	/	UTF-8
payrollWsdlLocation	https://community.workday.com/custom/developer/API/Payroll/v20/Payroll.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutPayrollPayeeOngoingWorkJurisdictionTaxElectionResponseType	The response from the operation

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-payroll: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.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
payrollUsaStateAndLocalTaxElection	#[payload]	Optional. State and Local Tax Elections for USA Payroll State Authorities	PutPayrollUSAStateAndLocalTaxElectionRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
payrollUser		Optional. Workday user	String	/	UTF-8
payrollPassword		Optional. Workday password	String	/	UTF-8
payrollEndpoint		Optional. Workday endpoint	String	/	UTF-8
payrollWsdlLocation	https://community.workday.com/custom/developer/API/Payroll/v20/Payroll.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutPayrollUSAStateAndLocalTaxElectionResponseType	The results of the last Put Payroll USA State and Local Tax Election Put Request

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-payroll:put-payroll-worker-tax-treaty>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
payrollWorkerTaxTreaty	#[payload]	Optional. Request object	PutPayrollWorkerTaxTreatyRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
payrollUser		Optional. Workday user	String	/	UTF-8
payrollPassword		Optional. Workday password	String	/	UTF-8
payrollEndpoint		Optional. Workday endpoint	String	/	UTF-8
payrollWsdlLocation	https://community.workday.com/custom/developer/API/Payroll/v20/Payroll.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutWorkerTaxTreatyResponseType	response object

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-payroll:put-period-schedule>

Adds/updates Period Schedules

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
periodSchedule	#[payload]	Optional. Request object	PutPeriodScheduleRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
payrollUser		Optional. Workday user	String	/	UTF-8
payrollPassword		Optional. Workday password	String	/	UTF-8
payrollEndpoint		Optional. Workday endpoint	String	/	UTF-8
payrollWsdlLocation	https://community.workday.com/custom/developer/API/Payroll/v20/Payroll.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutPeriodScheduleResponseType	response

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-payroll:submit-payroll-input>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
payrollInputRequest	#[payload]	Optional. Request object	SubmitPayrollInputRequestType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
payrollUser		Optional. Workday user	String	/	UTF-8
payrollPassword		Optional. Workday password	String	/	UTF-8
payrollEndpoint		Optional. Workday endpoint	String	/	UTF-8
payrollWsdlLocation	https://community.workday.com/custom/developer/API/Payroll/v20/Payroll.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
SubmitPayrollInputResponseType	response

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown