Service Directory > v31.2 > Payroll_Interface > Put_External_Payroll_Results
 

Operation: Put_External_Payroll_Results

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


@ - A parameter name with this symbol denotes an XML attribute within the document instead of an XML element.


Contents

 

Web Service

 

Request

 

Response

 

Element(s)

 

Request Element: Put_External_Payroll_Results_Request

External Payroll Result Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
External_Payroll_Result_Data  External_Payroll_Result_Data__DO_NOT_USE_  [1..*]  Put External Payroll Results Request 
Validation Description
Country is required for payroll pay group.   
 
top
 

Response Element: Put_External_Payroll_Results_Response

Put External Payroll Results Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
External_Payroll_Results_Reference  Unique_IdentifierObject  [0..*]  External Payroll Results Reference   
top
 

External_Payroll_Result_Data__DO_NOT_USE_

part of: Put_External_Payroll_Results_Request
External Payroll Result Data
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [1..1]  If Worker Reference, Pay Group Reference, Period Date, Payment Date, Sequence, and Batch ID are provided, then it will be used to look up an existing External Payroll Result instance to update.   
Pay_Group_Reference  Pay_GroupObject  [1..1]  If Worker Reference, Pay Group Reference, Period Date, Payment Date, Sequence, and Batch ID are provided, then it will be used to look up an existing External Payroll Result instance to update.   
Period_Date  date  [1..1]  The Period Date is used to identify a Period by the Period's start and end date range. If Worker Reference, Pay Group Reference, Period Date, Payment Date, Sequence, and Batch ID are provided, then it will be used to look up an existing External Payroll Result instance to update. 
Validation Description
Invalid Pay Period. The provided "[pay group]" Pay Group and [period date] Period Date does not return a valid Pay Period.   
 
Payment_Date  date  [1..1]  The Payment Date is when the check was paid to the worker. If Worker Reference, Pay Group Reference, Period Date, Payment Date, Sequence, and Batch ID are provided, then it will be used to look up an existing External Payroll Result instance to update.   
Check_Number  string  [1..1]  If Worker Reference, Pay Group Reference, Period Date, Payment Date, Check Number, and Batch ID are provided, then it will be used to look up an existing External Payroll Result instance to update.   
Batch_ID  string  [1..1]  The Batch ID can be assigned to a set of External Payroll Results to enable the external system to manage External Payroll Results data by Batch ID. There are transactions in Workday Payroll that let the user maintain External Payroll Results data by Batch ID (e.g. Delete Payroll Input by Batch ID).   
Gross_Amount  decimal (23, 3)   [0..1]  This is an amount value for a Pay Component Group (Workday Owned) that has a category "Inbound Payroll Interface".   
Net_Amount  decimal (23, 3)   [0..1]  This is an amount value for a Pay Component Group (Workday Owned) that has a category "Inbound Payroll Interface".   
Allowance_Plan_1_Amount  decimal (23, 3)   [0..1]  This is an amount value for a Pay Component Group (Workday Owned) that has a category "Inbound Payroll Interface".   
Allowance_Plan_2_Amount  decimal (23, 3)   [0..1]  This is an amount value for a Pay Component Group (Workday Owned) that has a category "Inbound Payroll Interface".   
Bonus_Plan_1_Amount  decimal (23, 3)   [0..1]  This is an amount value for a Pay Component Group (Workday Owned) that has a category "Inbound Payroll Interface".   
Bonus_Plan_2_Amount  decimal (23, 3)   [0..1]  This is an amount value for a Pay Component Group (Workday Owned) that has a category "Inbound Payroll Interface".   
Commission_Plan_1_Amount  decimal (23, 3)   [0..1]  This is an amount value for a Pay Component Group (Workday Owned) that has a category "Inbound Payroll Interface".   
Commission_Plan_2_Amount  decimal (23, 3)   [0..1]  This is an amount value for a Pay Component Group (Workday Owned) that has a category "Inbound Payroll Interface".   
ER_Paid_Deductions_1_Amount  decimal (23, 3)   [0..1]  This is an amount value for a Pay Component Group (Workday Owned) that has a category "Inbound Payroll Interface".   
ER_Paid_Deductions_2_Amount  decimal (23, 3)   [0..1]  This is an amount value for a Pay Component Group (Workday Owned) that has a category "Inbound Payroll Interface".   
Imputed_Income_1_Amount  decimal (23, 3)   [0..1]  This is an amount value for a Pay Component Group (Workday Owned) that has a category "Inbound Payroll Interface".   
Imputed_Income_2_Amount  decimal (23, 3)   [0..1]  This is an amount value for a Pay Component Group (Workday Owned) that has a category "Inbound Payroll Interface".   
Merit_Plan_1_Amount  decimal (23, 3)   [0..1]  This is an amount value for a Pay Component Group (Workday Owned) that has a category "Inbound Payroll Interface".   
Merit_Plan_2_Amount  decimal (23, 3)   [0..1]  This is an amount value for a Pay Component Group (Workday Owned) that has a category "Inbound Payroll Interface".   
Non_Cash_Taxable_Benefits_Amount  decimal (23, 3)   [0..1]  This is an amount value for a Pay Component Group (Workday Owned) that has a category "Inbound Payroll Interface".   
Overtime_Amount_1  decimal (23, 3)   [0..1]  This is an amount value for a Pay Component Group (Workday Owned) that has a category "Inbound Payroll Interface".   
Overtime_Hours_1  decimal (15, 3)   [0..1]  This is a value for a Pay Component Group (Workday Owned) that has a category "Inbound Payroll Interface".   
Overtime_Amount_2  decimal (23, 3)   [0..1]  This is an amount value for a Pay Component Group (Workday Owned) that has a category "Inbound Payroll Interface".   
Overtime_Hours_2  decimal (15, 3)   [0..1]  This is a value for a Pay Component Group (Workday Owned) that has a category "Inbound Payroll Interface".   
Post_Tax_Deductions_Amount  decimal (23, 3)   [0..1]  This is an amount value for a Pay Component Group (Workday Owned) that has a category "Inbound Payroll Interface".   
Post_Tax_Deductions_2_Amount  decimal (23, 3)   [0..1]  This is an amount value for a Pay Component Group (Workday Owned) that has a category "Inbound Payroll Interface".   
Post_Tax_Deductions_3_Amount  decimal (23, 3)   [0..1]  This is an amount value for a Pay Component Group (Workday Owned) that has a category "Inbound Payroll Interface".   
Post_Tax_Deductions_4_Amount  decimal (23, 3)   [0..1]  This is an amount value for a Pay Component Group (Workday Owned) that has a category "Inbound Payroll Interface".   
Pre_Tax_Deductions_Amount  decimal (23, 3)   [0..1]  This is an amount value for a Pay Component Group (Workday Owned) that has a category "Inbound Payroll Interface".   
Pre_Tax_Deductions_2_Amount  decimal (23, 3)   [0..1]  This is an amount value for a Pay Component Group (Workday Owned) that has a category "Inbound Payroll Interface".   
Pre_Tax_Deductions_3_Amount  decimal (23, 3)   [0..1]  This is an amount value for a Pay Component Group (Workday Owned) that has a category "Inbound Payroll Interface".   
Pre_Tax_Deductions_4_Amount  decimal (23, 3)   [0..1]  This is an amount value for a Pay Component Group (Workday Owned) that has a category "Inbound Payroll Interface".   
Salary_Plan_1_Amount  decimal (23, 3)   [0..1]  This is an amount value for a Pay Component Group (Workday Owned) that has a category "Inbound Payroll Interface".   
Salary_Plan_2_Amount  decimal (23, 3)   [0..1]  This is an amount value for a Pay Component Group (Workday Owned) that has a category "Inbound Payroll Interface".   
Statutory_Taxes_Employee_Amount  decimal (23, 3)   [0..1]  This is an amount value for a Pay Component Group (Workday Owned) that has a category "Inbound Payroll Interface".   
Statutory_Taxes_Employer_Amount  decimal (23, 3)   [0..1]  This is an amount value for a Pay Component Group (Workday Owned) that has a category "Inbound Payroll Interface".   
Stock_Plan_1_Amount  decimal (23, 3)   [0..1]  This is an amount value for a Pay Component Group (Workday Owned) that has a category "Inbound Payroll Interface".   
Stock_Plan_2_Amount  decimal (23, 3)   [0..1]  This is an amount value for a Pay Component Group (Workday Owned) that has a category "Inbound Payroll Interface".   
Validation Description
Country is required for payroll pay group.   
top
 

WorkerObject

part of: External_Payroll_Result_Data__DO_NOT_USE_
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  WorkerObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

WorkerObjectID

part of: WorkerObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Contingent_Worker_ID, Employee_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Pay_GroupObject

part of: External_Payroll_Result_Data__DO_NOT_USE_
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Pay_GroupObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Pay_GroupObjectID

part of: Pay_GroupObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Organization_Reference_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Unique_IdentifierObject

part of: Put_External_Payroll_Results_Response
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Unique_IdentifierObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Unique_IdentifierObjectID

part of: Unique_IdentifierObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  IID, WID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Pay_GroupReferenceEnumeration

part of: Pay_GroupObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top