Service Directory > v32.1 > Payroll_CAN > Get_Payroll_CAN_Year_End_Forms
 

Operation: Get_Payroll_CAN_Year_End_Forms

Public Web Service that Gets Canadian Year End Forms.


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

Get Payroll CAN Year End Forms Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Payroll_CAN_Year_End_Form_Request_References  [0..1]  Payroll CAN Year End Form Request References   
Request_Criteria [Choice]   Payroll_CAN_Year_End_Form_Request_Criteria  [0..1]  Get Payroll CAN Year End Forms 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  Payroll_CAN_Year_End_Form_Response_Group  [0..1]  Payroll CAN Year End Form Response Group   
top
 

Response Element: Get_Payroll_CAN_Year_End_Forms_Response

Get Payroll CAN Year End Forms Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Payroll_CAN_Year_End_Form_Request_References  [0..1]  Payroll CAN Year End Form Request References   
Request_Criteria  Payroll_CAN_Year_End_Form_Request_Criteria  [0..1]  Get Payroll CAN Year End Forms 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  Payroll_CAN_Year_End_Form_Response_Group  [0..1]  Payroll CAN Year End Form 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  Payroll_CAN_Year_End_Form_Response_Data  [0..1]  Payroll CAN Year End Form Response Data   
top
 

Payroll_CAN_Year_End_Form_Request_References

part of: Get_Payroll_CAN_Year_End_Forms_Request, Get_Payroll_CAN_Year_End_Forms_Response
Payroll CAN Year End Form Request References
 
Parameter name Type/Value Cardinality Description Validations
Payroll_CAN_Year_End_Form_Reference  Unique_IdentifierObject  [1..*]  Payroll CAN Year End Form Request References   
top
 

Unique_IdentifierObject

part of: Payroll_Year_End_Form, Payroll_CAN_Year_End_Form_Request_References, Payroll_CAN_Year_End_Form_Request_Criteria
 
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
 

Payroll_CAN_Year_End_Form_Request_Criteria

part of: Get_Payroll_CAN_Year_End_Forms_Request, Get_Payroll_CAN_Year_End_Forms_Response
Get Payroll CAN Year End Forms Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Year_End_Form_Type_Reference  Payroll_Payee_Tax_Report_TypeObject  [0..1]  Type of form to get (T4, RL-1, or T4A)   
Tax_Year  decimal (4, 0) >0   [1..1]  Forms created for this tax year. Required.   
Worker_Reference  WorkerObject  [0..*]  Forms for these workers.   
Company_Reference  CompanyObject  [1..*]  Forms for these companies. At least one company is required.   
Payroll_Account_Number [Choice]   string  [0..1]  Filter by Payroll Account Number or Identification Number. Only one is allowed.   
Identification_Number [Choice]   string (16)   [0..1]  Filter by Identification Number or Payroll Account Number . Only one is allowed.   
Payroll_Year_End_Form_Subtype_Reference  Unique_IdentifierObject  [0..1]  Forms matching this subtype.   
Completed_Moment  dateTime  [0..1]  Forms completed after this moment.   
top
 

Payroll_Payee_Tax_Report_TypeObject

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

Payroll_Payee_Tax_Report_TypeObjectID

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

WorkerObject

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

CompanyObject

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

Response_Filter

part of: Get_Payroll_CAN_Year_End_Forms_Request, Get_Payroll_CAN_Year_End_Forms_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
 

Payroll_CAN_Year_End_Form_Response_Group

part of: Get_Payroll_CAN_Year_End_Forms_Request, Get_Payroll_CAN_Year_End_Forms_Response
Payroll CAN Year End Form Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Payroll CAN Year End Form Response Group Include Reference   
top
 

Response_Results

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

Payroll_CAN_Year_End_Form_Response_Data

part of: Get_Payroll_CAN_Year_End_Forms_Response
Payroll CAN Year End Form Response Data
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Year_End_Form  Payroll_Year_End_Form  [0..*]  Payroll Year End Form   
top
 

Payroll_Year_End_Form

part of: Payroll_CAN_Year_End_Form_Response_Data
Payroll Year End Form
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Year_End_Form_Reference  Unique_IdentifierObject  [0..1]  Payroll Year End Form Reference   
Payroll_Year_End_Form_Data  Payroll_Year_End_Form_Data  [0..*]  Payroll Year End Form Data   
top
 

Payroll_Year_End_Form_Data

part of: Payroll_Year_End_Form
Payroll Year End Form Data
 
Parameter name Type/Value Cardinality Description Validations
Employee_ID  string  [0..1]  Employee ID Reference   
Worker_Address_Data  Payroll_Year_End_Worker_Address_Data  [0..*]  Worker Address Data   
Employer_Name  string  [0..1]  Employer Name   
Employer_Address_Data  Employer_Address_Data  [0..*]  Employer Address Data   
Employer_Contact_Info  Payroll_Year_End_Form_Employer_Contact_Info  [0..*]  Employer Contact Info   
Company_Business_Number  string  [0..1]  Company Business Number   
Box_Info  Payroll_Year_End_CRF_Info  [0..*]  Contains the detail values and codes for the current form.   
Other_Information  Payroll_Year_End_Form_Other_Information  [0..*]  Detail values and codes in the other information section.   
RPP_or_DPSP_Registration_Number  string (7)   [0..1]  RPP or DPSP Registration Number   
top
 

Payroll_Year_End_Worker_Address_Data

part of: Payroll_Year_End_Form_Data
Payroll Year End Worker Address Data
 
Parameter name Type/Value Cardinality Description Validations
Address_Line_1  string  [0..1]  Address Line 1   
Address_Line_2  string  [0..1]  Address Line 2   
City  string  [0..1]  City   
Province_Code  string  [0..1]  Province Code   
Country_Code  string (3)   [0..1]  Country Code   
Postal_Code  string  [0..1]  Postal Code   
top
 

Employer_Address_Data

part of: Payroll_Year_End_Form_Data
Employer Address Data
 
Parameter name Type/Value Cardinality Description Validations
Address_Line_1  string  [0..1]  Address Line 1   
Address_Line_2  string  [0..1]  Address Line 2   
City  string  [0..1]  City   
Province_Code  string  [0..1]  Province Code   
Country_Code  string (3)   [0..1]  Country Code   
Postal_Code  string  [0..1]  Postal Code   
top
 

Payroll_Year_End_Form_Employer_Contact_Info

part of: Payroll_Year_End_Form_Data
Payroll Year End Form Employer Contact Info
 
Parameter name Type/Value Cardinality Description Validations
T4_Contact_Information  T4_Contact_Information  [0..*]  T4 Contact Information   
T4A_Contact_Information  T4A_Contact_Information  [0..*]  T4A Contact Information   
RL-1_Contact_Information  RL-1_Contact_Information  [0..*]  RL-1 Contact Information   
RL-2_Contact_Information  RL-2_Contact_Information  [0..*]  RL-2 Contact Information   
top
 

T4_Contact_Information

part of: Payroll_Year_End_Form_Employer_Contact_Info
T4 Contact Information
 
Parameter name Type/Value Cardinality Description Validations
T4_Contact_Name  string  [0..1]  T4 Contact Name   
T4_Contact_Phone_Number  string  [0..1]  T4 Contact Phone Number   
T4_Contact_Email_Address  string  [0..1]  T4 Contact Email Address   
top
 

T4A_Contact_Information

part of: Payroll_Year_End_Form_Employer_Contact_Info
T4A Contact Information
 
Parameter name Type/Value Cardinality Description Validations
T4A_Contact_Name  string  [0..1]  T4A Contact Name   
T4A_Contact_Phone_Number  string  [0..1]  T4A Contact Phone Number   
T4A_Contact_Email_Address  string  [0..1]  T4A Contact Email Address   
top
 

RL-1_Contact_Information

part of: Payroll_Year_End_Form_Employer_Contact_Info
RL-1 Contact Information
 
Parameter name Type/Value Cardinality Description Validations
RL-1_Contact_Name  string  [0..1]  RL-1 Contact Name   
RL-1_Contact_Phone_Number  string  [0..1]  RL-1 Contact Phone Number   
top
 

RL-2_Contact_Information

part of: Payroll_Year_End_Form_Employer_Contact_Info
RL-2 Contact Information
 
Parameter name Type/Value Cardinality Description Validations
RL-2_Contact_Name  string  [0..1]  RL-2 Contact Name   
RL-2_Contact_Phone_Number  string  [0..1]  RL-2 Contact Phone Number   
RL-2_Contact_Language_of_Communication  string  [0..1]  RL-2 Contact Language of Communication   
top
 

Payroll_Year_End_CRF_Info

part of: Payroll_Year_End_Form_Data
Payroll Year End CRF Info
 
Parameter name Type/Value Cardinality Description Validations
Year_End_Box_Name  string  [0..1]  Year End Box Name   
Year_End_Box_Value  string  [0..1]  Year End Box Value   
top
 

Payroll_Year_End_Form_Other_Information

part of: Payroll_Year_End_Form_Data
Payroll Year End Form Other InformationPayroll Year End Form Other Information
 
Parameter name Type/Value Cardinality Description Validations
Box_Info  Payroll_Year_End_Detail_Info  [0..*]  Box Info   
top
 

Payroll_Year_End_Detail_Info

part of: Payroll_Year_End_Form_Other_Information
Payroll Year End Detail Info
 
Parameter name Type/Value Cardinality Description Validations
Reporting_Code_Name  string  [0..1]  Reporting Code Name   
Year_End_Form_Detail_Value  string  [0..1]  Year End Form Detail Value   
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

Payroll_Payee_Tax_Report_TypeReferenceEnumeration

part of: Payroll_Payee_Tax_Report_TypeObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top