Service Directory > v31.2 > Payroll_Interface > Import_External_Payroll_Results
 

Operation: Import_External_Payroll_Results

This background service operation will add, update or delete External Payroll Result(s), External Payroll Result Line(s), External Payroll Run Detail(s) and Application Batch (which is used to uniquely identify External Payroll Run Detail(s)) into Workday. This import service is intended only to be invoked from an integration process. This import is asynchronous and the response will only be an acknowledgement or receipt.


@ - 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: Import_External_Payroll_Result_Request

Import External Payroll Result Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Batch_ID  string  [0..1]  Batch ID   
Pay_Group_Reference  Pay_GroupObject  [1..1]  Pay Group Detail Reference   
Period_End_Date  date  [1..1]  Period End Date   
Pay_Group_Currency_Reference  CurrencyObject  [0..1]  Pay Group Currency Reference   
External_Payroll_Result_Data  External_Payroll_Result_Data  [0..*]  External Payroll Result Data 
Validation Description
Invalid combination for [worker] in Pay Group ([payGroup]) with Period End Date ([periodEndDate]), Payment Date ([paymentDate]) and Check Number ([checkNumber]). Worker/Position must be in Pay Group for Pay Period with End Date ([periodEndDate]).   
Result for [worker] in Pay Group ([payGroup]) with Period End Date ([periodEndDate]), Payment Date ([paymentDate]) and Check Number ([checkNumber]) cannot have more than [limit] Result Lines.   
 
Validation Description
Invalid Period End Date ([periodEndDate]) provided for Pay Group '[payGroup]' in Batch ID '[batchID]'.   
top
 

Response Element: Put_Import_Process_Response

Put Import Process Response element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Import_Process_Reference  Web_Service_Background_Process_RuntimeObject  [0..1]  Web Service Background Process Runtime element   
Header_Instance_Reference  InstanceObject  [0..1]  Header Instance element   
top
 

Pay_GroupObject

part of: Import_External_Payroll_Result_Request
 
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
 

CurrencyObject

part of: External_Payroll_Result_Data, External_Payroll_Result_Line_Data, Import_External_Payroll_Result_Request
 
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  CurrencyObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

CurrencyObjectID

part of: CurrencyObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Currency_ID, Currency_Numeric_Code  [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
 

External_Payroll_Result_Data

part of: Import_External_Payroll_Result_Request
External Payroll Result Data
 
Parameter name Type/Value Cardinality Description Validations
Delete_External_Payroll_Result  boolean  [0..1]  Delete External Payroll Result   
Worker_Reference  WorkerObject  [1..1]  Worker Reference   
Position_Reference  Position_ElementObject  [0..1]  Position Reference   
Company_Reference  CompanyObject  [0..1]  Company Reference   
Company_Currency_Reference  CurrencyObject  [0..1]  Company Currency Reference   
Payment_Date  date  [1..1]  Payment Date   
Check_Number  string  [1..1]  Check Number   
Gross_Amount  decimal (18, 6)   [0..1]  Gross Amount   
Net_Amount  decimal (18, 6)   [0..1]  Net Amount   
External_Payroll_Result_Line_Data  External_Payroll_Result_Line_Data  [0..*]  External Payroll Result Line Data   
Validation Description
Invalid combination for [worker] in Pay Group ([payGroup]) with Period End Date ([periodEndDate]), Payment Date ([paymentDate]) and Check Number ([checkNumber]). Worker/Position must be in Pay Group for Pay Period with End Date ([periodEndDate]).   
Result for [worker] in Pay Group ([payGroup]) with Period End Date ([periodEndDate]), Payment Date ([paymentDate]) and Check Number ([checkNumber]) cannot have more than [limit] Result Lines.   
top
 

WorkerObject

part of: External_Payroll_Result_Data
 
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
 

Position_ElementObject

part of: External_Payroll_Result_Data
 
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  Position_ElementObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Position_ElementObjectID

part of: Position_ElementObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Position_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
 

CompanyObject

part of: External_Payroll_Result_Data
 
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  CompanyObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

CompanyObjectID

part of: CompanyObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Company_Reference_ID, 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
 

External_Payroll_Result_Line_Data

part of: External_Payroll_Result_Data
External Payroll Result Line Data
 
Parameter name Type/Value Cardinality Description Validations
Pay_Component_Reference  Pay_ComponentObject  [1..1]  Pay Component Reference   
Recorded_Currency_Reference  CurrencyObject  [0..1]  Recorded Currency Reference   
Amount  decimal (18, 6)   [0..1]  Amount   
Hours  decimal (18, 6)   [0..1]  Hours   
Rate  decimal (18, 6)   [0..1]  Rate   
Amount_in_Company_Currency  decimal (18, 6)   [0..1]  Amount in Company Currency   
Amount_in_Pay_Group_Currency  decimal (18, 6)   [0..1]  Amount in Pay Group Currency   
top
 

Pay_ComponentObject

part of: External_Payroll_Result_Line_Data
 
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_ComponentObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Pay_ComponentObjectID

part of: Pay_ComponentObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Deduction_Code, Earning_Code, Workday_Deduction_Code, Workday_Earning_Code  [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
 

Web_Service_Background_Process_RuntimeObject

part of: Put_Import_Process_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  Web_Service_Background_Process_RuntimeObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Web_Service_Background_Process_RuntimeObjectID

part of: Web_Service_Background_Process_RuntimeObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Background_Process_Instance_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
 

InstanceObject

part of: Put_Import_Process_Response
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]     
ID  Instance_ID  [0..*]     
top
 

Instance_ID

part of: InstanceObject
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@parent_id  string  [1..1]     
@parent_type  string  [1..1]     
@type  string  [1..1]     
top
 

Pay_GroupReferenceEnumeration

part of: Pay_GroupObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Position_ElementReferenceEnumeration

part of: Position_ElementObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Pay_ComponentReferenceEnumeration

part of: Pay_ComponentObjectID
Base Type
string
top
 

Web_Service_Background_Process_RuntimeReferenceEnumeration

part of: Web_Service_Background_Process_RuntimeObjectID
Base Type
string
top