Service Directory > v32.1 > Payroll_CAN > Put_Payroll_CAN_Worker_Tax_Treaty
 

Operation: Put_Payroll_CAN_Worker_Tax_Treaty

This web service method allows external clients to add or update a Payroll Payee Tax Treaty CAN


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

Create or Update a Tax Treaty CAN for a Worker.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Payroll_Payee_Tax_Treaty_CAN_Data  Payroll_Payee_Tax_Treaty_CAN_Data  [0..1]  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
 

Response Element: Put_Payroll_CAN_Worker_Tax_Treaty_Response

Put Payroll Payee Tax Treaty CAN Response.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Payroll_Payee_Tax_Treaty_CAN_Reference  Payroll_Payee_Tax_Treaty_CANObject  [0..1]  Payroll Payee Tax Treaty CAN.   
Payroll_Payee_Tax_Treaty_CAN_Response_Data  Put_Payroll_Payee_Tax_Treaty_CAN_Response_Data  [0..*]  Put Payroll Payee Tax Treaty CAN Response Data.   
top
 

Payroll_Payee_Tax_Treaty_CAN_Data

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

Payroll_Payee_Tax_Treaty_CANObject

part of: Put_Payroll_CAN_Worker_Tax_Treaty_Response, 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_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
 

WorkerObject

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

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_Exemption_CodeObject

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

Put_Payroll_Payee_Tax_Treaty_CAN_Response_Data

part of: Put_Payroll_CAN_Worker_Tax_Treaty_Response
Put Payroll Payee Tax Treaty CAN Response Data.
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [0..1]  Worker to whom the Tax Treaty CAN applies.   
Payroll_Income_Code_Reference  Payroll_Income_CodeObject  [0..1]  Income Code for CAN Tax Treaty.   
Payroll_Exemption_Code_Reference  Payroll_Exemption_CodeObject  [0..1]  Exemption Code for CAN Tax Treaty.   
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
 

CountryReferenceEnumeration

part of: CountryObjectID
Base Type
string
top
 

Payroll_Exemption_CodeReferenceEnumeration

part of: Payroll_Exemption_CodeObjectID
Base Type
string
top