Service Directory > v32.1 > Payroll > Get_Canadian_Record_of_Employment_Data
 

Operation: Get_Canadian_Record_of_Employment_Data

Return Approved Canadian Record of Employment records for outbound 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: Get_Canadian_Record_of_Employment_Data_Request

Get Canadian Record of Employment Data Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Canadian_Record_of_Employment_Data_Request_References  [0..1]  ROE Data References 
Validation Description
You are attempting to send ROE Data with Version 1 codes which is an unsupported format for new Service Canada Version 2 requirements. Prior to recreating the ROE, unapprove any ROE's in approved status, recreate the ROE(s) to uptake Service Canada Version 2 codes and resubmit the ROE(s).   
 
Request_Criteria [Choice]   Canadian_Record_of_Employment_Data_Request_Criteria  [0..1]  ROE Data Request Criteria.   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Canadian_Record_of_Employment_Data_Response_Group  [0..1]  ROE Data Response Group   
top
 

Response Element: Get_Canadian_Record_of_Employment_Data_Response

Get Canadian Record of Employment Data Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Canadian_Record_of_Employment_Data_Request_References  [0..1]  Get ROE Data Request References 
Validation Description
You are attempting to send ROE Data with Version 1 codes which is an unsupported format for new Service Canada Version 2 requirements. Prior to recreating the ROE, unapprove any ROE's in approved status, recreate the ROE(s) to uptake Service Canada Version 2 codes and resubmit the ROE(s).   
 
Request_Criteria  Canadian_Record_of_Employment_Data_Request_Criteria  [0..1]  ROE Data Request Criteria   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Canadian_Record_of_Employment_Data_Response_Group  [0..1]  ROE Data Response Group   
Response_Results  Response_Results  [0..1]  The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.   
Response_Data  Canadian_Record_of_Employment_Data_Response_Data  [0..1]  Get ROE Data Response   
top
 

Canadian_Record_of_Employment_Data_Request_References

part of: Get_Canadian_Record_of_Employment_Data_Request, Get_Canadian_Record_of_Employment_Data_Response
Canadian Record of Employment Data Request References
 
Parameter name Type/Value Cardinality Description Validations
Canadian_Record_of_Employment_Data_Reference  Payroll_ROE_Data_AllObject  [0..*]  ROE Data Request References   
Validation Description
You are attempting to send ROE Data with Version 1 codes which is an unsupported format for new Service Canada Version 2 requirements. Prior to recreating the ROE, unapprove any ROE's in approved status, recreate the ROE(s) to uptake Service Canada Version 2 codes and resubmit the ROE(s).   
top
 

Payroll_ROE_Data_AllObject

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

Payroll_ROE_Data_AllObjectID

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

Canadian_Record_of_Employment_Data_Request_Criteria

part of: Get_Canadian_Record_of_Employment_Data_Request, Get_Canadian_Record_of_Employment_Data_Response
Get Canadian Record of Employment Data Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Canadian_Record_of_Employment_Data_Request, Get_Canadian_Record_of_Employment_Data_Response
Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.
 
Parameter name Type/Value Cardinality Description Validations
As_Of_Effective_Date  date  [0..1]  Indicates the date when application data, such as benefits and compensation, are deemed effective in the Workday system. (Also referred to as the "Effective Moment".) If not specified, this date defaults to TODAY.   
As_Of_Entry_DateTime  dateTime  [0..1]  Indicates the date and time that data was entered into the system. (This field is also referred to as the "Entry Moment".) If not specified, defaults to the CURRENT DATE/TIME.   
Page  decimal (12, 0) >0   [0..1]  Indicates the page of data to return in the response, and defaults to the first page (Page = 1). For responses that contain more than one page of data, use this parameter to retrieve the additional pages of data. For example, set Page = 2 to retrieve the second page of data. Note: If you set the page parameter, you must also specify the "As_Of_Entry_Date" to ensure that the result set remains the same between your requests.   
Count  decimal (3, 0) >0   [0..1]  Sets the number of objects to return within each response page (Min = 1, Max = 999, Default = 100 if not set). Any values you set must be between 1-999.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Canadian_Record_of_Employment_Data_Response_Group

part of: Get_Canadian_Record_of_Employment_Data_Request, Get_Canadian_Record_of_Employment_Data_Response
Canadian Record of Employment Data Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include ROE Data Reference in the Response.   
top
 

Response_Results

part of: Get_Canadian_Record_of_Employment_Data_Response
The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.
 
Parameter name Type/Value Cardinality Description Validations
Total_Results  decimal (12, 0) >0   [0..1]  The total number of results that have been returned from your request.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages that exist for your request. A page of data in WWS contains a maximum of 100 entries. So, if you have exactly 1,000 employees returned in a request, then you will have 10 pages of data that will need to be retrieved to build your complete dataset. Each page contains a maximum of 100 entries.   
Page_Results  decimal (12, 0) >0   [0..1]  Number of Results in current page.   
Page  decimal (12, 0) >0   [0..1]  The page of data that has been returned for the given request.   
top
 

Canadian_Record_of_Employment_Data_Response_Data

part of: Get_Canadian_Record_of_Employment_Data_Response
Get Canadian Record of Employment Data Response
 
Parameter name Type/Value Cardinality Description Validations
Canadian_Record_of_Employment_Data  Canadian_Record_of_Employment_Data  [0..*]  ROE Data   
top
 

Canadian_Record_of_Employment_Data

part of: Canadian_Record_of_Employment_Data_Response_Data
Canadian Record of Employment Data
 
Parameter name Type/Value Cardinality Description Validations
Printing_Language  string  [0..1]  English or French depending on user preference   
Issue_Type  string  [0..1]  Issue Type for this ROE, D (Draft) or S (Submit)   
ROE_Data_Reference  Payroll_ROE_Data_AllObject  [0..1]  ROE Data Reference   
ROE_Serial_Number  string (9)   [0..1]  Serial Number of ROE Amended or replaced   
Employee_ID  string  [0..1]  Employer’s payroll reference number   
Employer_Payroll_Reference_Number  string  [1..1]  Canada Revenue Agency Business Number   
Organization_Number  string (15)   [0..1]  Organization Number for this ROE Configuration   
Folder_CD  string (30)   [0..1]  Folder CD specified for ROE Configuration   
Pay_Period_Type  string (1)   [1..1]  Pay period type   
Social_Insurance_Number  string  [0..1]  Social Insurance Number of the employee for whom the ROE will be issued   
ROE_Address_Line_1  string  [1..1]  Line 1 of the address of the employee for whom the ROE will be issued - Number and street name   
ROE_Address_Line_2  string  [0..1]  Line 2 of the address of the employee for whom the ROE will be issued - Place, City and Municipality   
ROE_Address_Line_3  string  [0..1]  Line 3 of the address of the employee for whom the ROE will be issued - Province, Country and Postal Code   
Postal_Code  string  [0..1]  Postal Code of the address of the employee for whole the ROE will be issued.   
Legal_First_Name  string  [1..1]  First name of the employee for whom the ROE will be issued   
Legal_Last_Name  string  [1..1]  Last name of the employee for whom the ROE will be issued   
Legal_Middle_Name  string  [0..1]  Middle name of the employee for whom the ROE will be issued   
First_Day_Worked  date  [1..1]  First Day Worked   
Last_Day_For_Which_Paid  date  [1..1]  Last day for which paid   
Final_Pay_Period_End_Date  date  [1..1]  Final Pay Period Ending Date   
Employee_Occupation  string  [0..1]  Employee Occupation   
ROE_Expected_Recall_Code  string (1)   [0..1]  Expected recall code   
Expected_Date_of_Return  date  [0..1]  Expected date of recall   
Total_Insurable_Hours  decimal (18, 6)   [1..1]  Total insurable hours   
Total_Insurable_Earnings  decimal (26, 6)   [1..1]  Total insurable earnings   
ROE_Insurable_Earnings_By_Period_Data  Canadian_Record_of_Employment_Insurable_Earnings_By_Period_Data  [1..*]  Insurable Earnings by Period   
ROE_Reason_Contact_Area_Code_Number  string  [1..1]  Phone area code for the ROE Issuer contact person   
ROE_Reason_Code_for_ROE_Reason  string  [1..1]  Reason for issuing this ROE   
ROE_Reason_Phone_Extension_Number  string  [0..1]  Phone Extension number for the contact person   
ROE_Reason_Contact_First_Name  string  [1..1]  First name for the contact person   
ROE_Reason_Contact_Last_Name  string  [1..1]  Last name for the contact person   
ROE_Reason_Contact_Phone_Number  string  [1..1]  Phone number for the contact person   
Vacation_Pay_Amount  decimal (36, 6)   [0..1]  Vacation Pay amount   
Vacation_Pay_Data  ROE_Vacation_Pay_Data  [0..*]  Vacation Pay Data - b17a   
Statutory_Holiday_Data  Canadian_Record_of_Employment_Statutory_Holiday_Detail_Data  [0..*]  Canadian Record of Employment Data   
Other_Monies_Data  Other_Monies_Data  [0..*]  Other Monies   
Comments  string (160)   [0..1]  Comments   
Special_Payment_Data  Canadian_Record_of_Employment_Paid_Sick_Leave__Maternity_and_Wage_Loss_Detail_Data  [0..*]  Special Payment Information   
Preferred_User_Language  string (1)   [0..1]  Communication Preferred In   
top
 

Canadian_Record_of_Employment_Insurable_Earnings_By_Period_Data

part of: Canadian_Record_of_Employment_Data
Insurable Earnings by Period
 
Parameter name Type/Value Cardinality Description Validations
Payroll_ROE_Period_Number  decimal (12, 0) >0   [1..1]  Insurable Earnings Pay Period Number   
EI_Earning_Value  decimal (36, 6)   [1..1]  Insurable Earnings Pay Period Amount   
top
 

ROE_Vacation_Pay_Data

part of: Canadian_Record_of_Employment_Data
Vacation Pay Data - b17a
 
Parameter name Type/Value Cardinality Description Validations
Vacation_Pay_Code  string  [0..1]  Vacation Pay Code   
Vacation_Pay_Start_Date  date  [0..1]  Vacation Pay Start Date   
Vacation_Pay_End_Date  date  [0..1]  Vacation Pay End Date   
Vacation_Pay_Amount  decimal (36, 6)   [0..1]  Vacation Pay Amount   
top
 

Canadian_Record_of_Employment_Statutory_Holiday_Detail_Data

part of: Canadian_Record_of_Employment_Data
This is the parent tag for the list of Statutory Holiday information
 
Parameter name Type/Value Cardinality Description Validations
ROE_Detail_Date  date  [0..1]  Statutory Holiday Payment Date   
ROE_Detail_Amount  decimal (36, 6)   [0..1]  Statutory Holiday Payment Amount   
top
 

Other_Monies_Data

part of: Canadian_Record_of_Employment_Data
Other Monies Information
 
Parameter name Type/Value Cardinality Description Validations
ROE_Other_Monies_Code  string  [0..1]  Other monies code   
ROE_Other_Monies_Start_Date  date  [0..1]  Other monies start date   
ROE_Other_Monies_End_Date  date  [0..1]  Other monies end date   
ROE_Other_Monies_Amount  decimal (36, 6)   [0..1]  Other monies amount   
top
 

Canadian_Record_of_Employment_Paid_Sick_Leave__Maternity_and_Wage_Loss_Detail_Data

part of: Canadian_Record_of_Employment_Data
Special Payment information
 
Parameter name Type/Value Cardinality Description Validations
ROE_Special_Payment_Code  string  [0..1]  Special Payment Code   
Special_Payment_Date  date  [0..1]  Special Payment Date   
Special_Payment_Start_Date  date  [0..1]  Special Payment Start Date   
Special_Payment_End_Date  date  [0..1]  Special Payment End Date   
Special_Payment_Amount  decimal (36, 6)   [0..1]  Special Payment Amount   
Per_Day  boolean  [0..1]  Special Payment Period - Per Day   
Per_Week  boolean  [0..1]  Special Payment Period - Per Week   
top
 

Payroll_ROE_Data_AllReferenceEnumeration

part of: Payroll_ROE_Data_AllObjectID
Base Type
string
top