Service Directory > v32.1 > Payroll_CAN > Get_Payroll_CAN_Worker_Tax_Treaties
 

Operation: Get_Payroll_CAN_Worker_Tax_Treaties

Allows an external client to retrieve Payroll Payee Tax Treaty CAN data.


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

Get Worker Tax Treaties CAN Request.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Payroll_Payee_Tax_Treaty_CAN_Request_References  [0..1]  Provide one or more Worker Tax Treaty CAN references to retrieve a specific set of Worker Tax Treaties for Canada.   
Request_Criteria [Choice]   Payroll_Payee_Tax_Treaty_CAN_Request_Criteria  [0..1]  Get Payroll Payee Tax Treaty CAN Request Criteria. The values in this element are used to filter the list of Payroll Payee Tax Treaty CAN instances returned by the Get Payroll Payee Tax Treaties CAN Request.   
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. 
 
top
 

Response Element: Get_Payroll_CAN_Worker_Tax_Treaties_Response

Get Payroll Payee Tax Treaties CAN Response.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Payroll_Payee_Tax_Treaty_CAN_Request_References  [0..1]  Provide one or more Payroll Payee Tax Treaty CAN References to retrieve a specific set of CAN Payroll Payee Tax Treaties.   
Request_Criteria  Payroll_Payee_Tax_Treaty_CAN_Request_Criteria  [0..1]  Get Payroll Payee Tax Treaty CAN Request Criteria. The values in this element are used to filter the list of Payroll Payee Tax Treaty CAN instances returned by the Get Payroll Payee Tax Treaties CAN Request.   
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_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_Payee_Tax_Treaty_CAN_Response_Data  [0..1]  Returns a list of CAN Payroll Payee Tax Treaties matching the References or Criteria provided in the Get Payroll Payee Tax Treaties CAN Request.   
top
 

Payroll_Payee_Tax_Treaty_CAN_Request_References

part of: Get_Payroll_CAN_Worker_Tax_Treaties_Response, Get_Payroll_CAN_Worker_Tax_Treaties_Request
Provide one or more Worker Tax Treaty CAN references to retrieve a specific set of Worker Tax Treaties for Canada.
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Payee_Tax_Treaty_CAN_Reference  Payroll_Payee_Tax_Treaty_CANObject  [1..*]  Worker Tax Treaty CAN references provided in the Web Service Request.   
top
 

Payroll_Payee_Tax_Treaty_CANObject

part of: Payroll_Payee_Tax_Treaty_CAN_Data, Payroll_Payee_Tax_Treaty_CAN, Payroll_Payee_Tax_Treaty_CAN_Request_References
 
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_Treaty_CANObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Payroll_Payee_Tax_Treaty_CANObjectID

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

part of: Get_Payroll_CAN_Worker_Tax_Treaties_Response, Get_Payroll_CAN_Worker_Tax_Treaties_Request
Get Worker Tax Treaty CAN Request Criteria. The values in this element are used to filter the list of Worker Tax Treaty CAN instances returned by the Get Worker Tax Treaty CAN Request.
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [0..*]  Provide one or more Worker References to filter the Get Worker Tax Treaty CAN Response by Worker.   
Payroll_Income_Code_Reference  Payroll_Income_CodeObject  [0..1]  If present, limits the response to Worker Tax Treaties CAN using the specified Payroll Income Code.   
Payroll_Exemption_Code_Reference  Payroll_Exemption_CodeObject  [0..1]  If present, limits the response to Worker Tax Treaties CAN using the specified Payroll Exemption Code.   
top
 

WorkerObject

part of: Payroll_Payee_Tax_Treaty_CAN_Request_Criteria, Payroll_Payee_Tax_Treaty_CAN_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
 

Payroll_Income_CodeObject

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

Payroll_Income_CodeObjectID

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

Payroll_Exemption_CodeObject

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

Payroll_Exemption_CodeObjectID

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

Response_Filter

part of: Get_Payroll_CAN_Worker_Tax_Treaties_Response, Get_Payroll_CAN_Worker_Tax_Treaties_Request
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
 

Response_Results

part of: Get_Payroll_CAN_Worker_Tax_Treaties_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_Payee_Tax_Treaty_CAN_Response_Data

part of: Get_Payroll_CAN_Worker_Tax_Treaties_Response
Payroll Payee Tax Treaty CAN Response Data.
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Payee_Tax_Treaty_CAN  Payroll_Payee_Tax_Treaty_CAN  [0..*]  Payroll Payee Tax Treaty CAN.   
top
 

Payroll_Payee_Tax_Treaty_CAN

part of: Payroll_Payee_Tax_Treaty_CAN_Response_Data
Payroll Payee Tax Treaty CAN.
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Payee_Tax_Treaty_CAN_Reference  Payroll_Payee_Tax_Treaty_CANObject  [0..1]  Payroll Payee Tax Treaty CAN Reference.   
Payroll_Payee_Tax_Treaty_CAN_Data  Payroll_Payee_Tax_Treaty_CAN_Data  [0..*]  Payroll Payee Tax Treaty CAN Data. 
Validation Description
Use a valid Canadian Income Code.   
End Date cannot be prior to Start Date.   
Select only 1 Tax Residency Country.   
Select different Income Codes for the same Tax Residency Country.   
 
top
 

Payroll_Payee_Tax_Treaty_CAN_Data

part of: Payroll_Payee_Tax_Treaty_CAN
Payroll Payee Tax Treaty CAN Data.
 
Parameter name Type/Value Cardinality Description Validations
CAN_Worker_Tax_Treaty_Reference  Payroll_Payee_Tax_Treaty_CANObject  [0..1]  Payroll Payee Tax Treaty CAN Reference.   
Worker_Reference  WorkerObject  [1..1]  Worker to whom the Tax Treaty CAN applies.   
Start_Date  date  [1..1]  Indicates the date when Tax Treaty CAN starts.   
End_Date  date  [0..1]  Indicates the date when Tax Treaty CAN ends.   
Payroll_Income_Code_Reference  Payroll_Income_CodeObject  [1..1]  Income Code for CAN Tax Treaty.   
Tax_Treaty_Country_Reference  CountryObject  [1..1]  Tax Residency Country for CAN Tax Treaty.   
Payroll_Exemption_Code_Reference  Payroll_Exemption_CodeObject  [0..1]  Exemption Code for CAN Tax Treaty.   
Withholding_Rate  decimal (9, 6) >0   [0..1]  Indicates the tax withholding percentage rate for earnings associated with the CAN Tax Treaty.   
Validation Description
Use a valid Canadian Income Code.   
End Date cannot be prior to Start Date.   
Select only 1 Tax Residency Country.   
Select different Income Codes for the same Tax Residency Country.   
top
 

CountryObject

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

CountryObjectID

part of: CountryObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_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
 

Payroll_Payee_Tax_Treaty_CANReferenceEnumeration

part of: Payroll_Payee_Tax_Treaty_CANObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Payroll_Income_CodeReferenceEnumeration

part of: Payroll_Income_CodeObjectID
Base Type
string
top
 

Payroll_Exemption_CodeReferenceEnumeration

part of: Payroll_Exemption_CodeObjectID
Base Type
string
top
 

CountryReferenceEnumeration

part of: CountryObjectID
Base Type
string
top