Service Directory > v25.1 > Payroll > Put_Payroll_ROE_Prior_Period_History_Results
 

Operation: Put_Payroll_ROE_Prior_Period_History_Results

This Web Service is used to load the Canadian Employee Prior History Results for ROE processing.


@ - 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_Payroll_ROE_Prior_Period_History_Results_Request

This is the Canadian ROE Prior History Results Request Element that contains the Data element for the web service requests.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Payroll_ROE_Prior_Period_History_Results_Data  Payroll_ROE_Prior_History_Results_Data  [0..1]  Payroll ROE Prior History Results Data Element. 
Validation Description
Company[comp] entered is invalid as the company is not a Canadian company.   
Invalid Payroll Reference Number [ref num] for the company [comp] and Payroll Reporting Period [rep period].   
Invalid Reporting Period entered.   
The ROE Prior History Result already exists for Company:[company], Worker:[worker], Payroll Reference Number:[ref number] and Reporting period:[rp]   
EI Wages cannot be negative.   
EI Hour Value cannot be Negative.   
EI Wages are required when EI Hours are greater than 0.00   
 
top
 

Response Element: Put_Payroll_ROE_Prior_Period_History_Results_Response

This is the Canadian Payroll ROE Prior History Results Response Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Payroll_ROE_Prior_Period_History_Results_Reference  Unique_IdentifierObject  [0..1]  Payroll ROE Prior History Results Response Instance   
top
 

Payroll_ROE_Prior_History_Results_Data

part of: Put_Payroll_ROE_Prior_Period_History_Results_Request
This is the Canadian Payroll ROE Prior History Results Data Element that contains the attributes and instances to be loaded into Workday system for ROE processing.
 
Parameter name Type/Value Cardinality Description Validations
Employee_Reference  EmployeeObject  [1..1]  Employee Reference of the Employee.   
Company_Reference  CompanyObject  [1..1]  Company Reference of the Employee Company.   
Payroll_Reference_Number_Reference  Payroll_Reference_NumberObject  [1..1]  Payroll Reference Number of the Employee Company.   
Reporting_Period_Reference  PeriodObject  [1..1]  Reporting Period.   
EI_Wages  decimal (36, 6)   [0..1]  EI Insurable Wages   
EI_Hours  decimal (26, 6)   [0..1]  EI Insurable Hours   
Validation Description
Company[comp] entered is invalid as the company is not a Canadian company.   
Invalid Payroll Reference Number [ref num] for the company [comp] and Payroll Reporting Period [rep period].   
Invalid Reporting Period entered.   
The ROE Prior History Result already exists for Company:[company], Worker:[worker], Payroll Reference Number:[ref number] and Reporting period:[rp]   
EI Wages cannot be negative.   
EI Hour Value cannot be Negative.   
EI Wages are required when EI Hours are greater than 0.00   
top
 

EmployeeObject

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

EmployeeObjectID

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

CompanyObject

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

Payroll_Reference_NumberObject

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

Payroll_Reference_NumberObjectID

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

PeriodObject

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

PeriodObjectID

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

EmployeeReferenceEnumeration

part of: EmployeeObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Payroll_Reference_NumberReferenceEnumeration

part of: Payroll_Reference_NumberObjectID
Base Type
string
top
 

PeriodReferenceEnumeration

part of: PeriodObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top