Service Directory > v32.1 > Payroll > Get_Payroll_Worker_Tax_Treaties
 

Operation: Get_Payroll_Worker_Tax_Treaties

Allows an external client to retrieve Worker Tax Treaty 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_Worker_Tax_Treaties_Request

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

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

Worker_Tax_Treaties_Request_References

part of: Get_Payroll_Worker_Tax_Treaties_Request, Get_Worker_Tax_Treaties_Response
Provide one or more Worker tax Treaty References to retrieve a specific set of Worker Tax Treaties
 
Parameter name Type/Value Cardinality Description Validations
Worker_Tax_Treaty_Reference  Payroll_Payee_Tax_Treaty_USAObject  [1..*]  Worker Tax Treaty References provided in the Web Service Request.   
top
 

Payroll_Payee_Tax_Treaty_USAObject

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

Payroll_Payee_Tax_Treaty_USAObjectID

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

Worker_Tax_Treaties_Request_Criteria

part of: Get_Payroll_Worker_Tax_Treaties_Request, Get_Worker_Tax_Treaties_Response
Get Worker Tax Treaty Request Criteria. The values in this element are used to filter the list of Worker Tax Treaty instances returned by the Get Worker Tax Treaty 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 Response by Worker.   
Tax_Year_Reference  Calendar_YearObject  [0..1]  If present, limits the response to Worker Tax Treaties for the specified Calendar Year   
Income_Code_Reference  Payroll_Income_CodeObject  [0..1]  If present, limits the response to Worker Tax Treaties using the specified Payroll Income Code   
Income_Code_Subtype_Reference  Payroll_Income_Code_SubtypeObject  [0..1]  If present, limits the response to Worker Tax Treaties using the specified Payroll Income Code Subtype   
top
 

WorkerObject

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

Calendar_YearObject

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

Calendar_YearObjectID

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

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

Payroll_Income_Code_SubtypeObjectID

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

Response_Results

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

Worker_Tax_Treaties_Response_Data

part of: Get_Worker_Tax_Treaties_Response
Get Worker Tax Treaties Response Data
 
Parameter name Type/Value Cardinality Description Validations
Worker_Tax_Treaty  Worker_Tax_Treaty  [0..*]  Worker Tax Treaty   
top
 

Worker_Tax_Treaty

part of: Worker_Tax_Treaties_Response_Data
Worker Tax Treaty
 
Parameter name Type/Value Cardinality Description Validations
Worker_Tax_Treaty_Reference  Payroll_Payee_Tax_Treaty_USAObject  [0..1]  Worker Tax Treaty Reference   
Worker_Tax_Treaty_Data  Worker_Tax_Treaty_Data  [0..*]  Worker Tax Treaty Data 
Validation Description
The Treaty Benefit End Date ([end]) must be greater than or equal to the Treaty Benefit Start Date ([start]).   
The Treaty Benefit Start Date's ([date]) year must be the same as the Tax Year ([taxYear]).   
The Treaty Benefit End Date's ([date]) year must be the same as the Tax Year ([taxYear]).   
Payroll Income Code is invalid. Payroll Income Code must be one of the following: [valid codes]   
Worker Tax Treaties associated with income codes ([codes]) cannot have overlapping dates   
Tax Year Reference must be greater than or equal to 2011.   
Treaty Benefits Start date must be after Treaty Eligibility Begin date.   
The Treaty Eligibility End Date ([end]) must be greater than or equal to the Treaty Eligibility Begin Date ([start]).   
Eligibility End date cannot be entered without an Eligibility Begin date.   
Treaty Benefits End date must be before Treaty Eligibility End date.   
Income Code Subtype is required if Income Code is [code]. Income Code Subtype must be blank if Income Code is not [code].   
Eligible for Withholding Allowance and Withholding Rate can only be entered if Income Code [code] Non Qualified   
Maximum Benefit Amount is not allowed when No Treaty Maximum is true   
 
top
 

Worker_Tax_Treaty_Data

part of: Worker_Tax_Treaty
Worker Tax Treaty Data
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [1..1]  Worker for whom the Tax Treaty applies   
Tax_Year_Reference  Calendar_YearObject  [1..1]  Calendar Reference. Tax year for treaty benefits. If Year, Income Code and Worker combination already exist in the system, treaty data will be Updated. If Year, Income Code and Worker combination does not exist in the system, tax treaty data will be Added.   
Treaty_Benefit_Start_Date  date  [1..1]  Indicates the date when treaty benefits start   
Treaty_Benefit_End_Date  date  [1..1]  Indicates the date when treaty benefits end   
Maximum_Benefit_Amount  decimal (21, 6) >0   [0..1]  Indicates the maximum benefit amount covered by treaty   
No_Treaty_Maximum  boolean  [0..1]  Indicates whether or not there is a maximum benefit amount covered by treaty   
Treaty_Eligibility_Begin  date  [0..1]  Indicates the date when the Worker is first eligible for Benefits   
Treaty_Eligibility_End  date  [0..1]  Indicates the date when the Worker is no longer eligible for Benefits   
Income_Code_Reference  Payroll_Income_CodeObject  [1..1]  Income code for treaty benefits   
Income_Code_Subtype_Reference  Payroll_Income_Code_SubtypeObject  [0..1]  Subtype of Income Code for treaty benefits - Qualified or Non Qualified   
Eligible_for_Withholding_Allowance  boolean  [0..1]  Indicates whether earnings associated with the tax treaty are Eligible for Withholding Allowance   
Withholding_Rate  decimal (9, 6) >0   [0..1]  Indicates the tax withholding percentage rate for earnings associated with the tax treaty   
Tax_Residency_Country_Code_Reference  Payroll_IRS_CountryObject  [1..1]  Two digit country code used by the IRS to identify the country for tax treaty benefits   
Validation Description
The Treaty Benefit End Date ([end]) must be greater than or equal to the Treaty Benefit Start Date ([start]).   
The Treaty Benefit Start Date's ([date]) year must be the same as the Tax Year ([taxYear]).   
The Treaty Benefit End Date's ([date]) year must be the same as the Tax Year ([taxYear]).   
Payroll Income Code is invalid. Payroll Income Code must be one of the following: [valid codes]   
Worker Tax Treaties associated with income codes ([codes]) cannot have overlapping dates   
Tax Year Reference must be greater than or equal to 2011.   
Treaty Benefits Start date must be after Treaty Eligibility Begin date.   
The Treaty Eligibility End Date ([end]) must be greater than or equal to the Treaty Eligibility Begin Date ([start]).   
Eligibility End date cannot be entered without an Eligibility Begin date.   
Treaty Benefits End date must be before Treaty Eligibility End date.   
Income Code Subtype is required if Income Code is [code]. Income Code Subtype must be blank if Income Code is not [code].   
Eligible for Withholding Allowance and Withholding Rate can only be entered if Income Code [code] Non Qualified   
Maximum Benefit Amount is not allowed when No Treaty Maximum is true   
top
 

Payroll_IRS_CountryObject

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

Payroll_IRS_CountryObjectID

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

part of: Payroll_Payee_Tax_Treaty_USAObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Calendar_YearReferenceEnumeration

part of: Calendar_YearObjectID
Base Type
string
top
 

Payroll_Income_CodeReferenceEnumeration

part of: Payroll_Income_CodeObjectID
Base Type
string
top
 

Payroll_Income_Code_SubtypeReferenceEnumeration

part of: Payroll_Income_Code_SubtypeObjectID
Base Type
string
top
 

Payroll_IRS_CountryReferenceEnumeration

part of: Payroll_IRS_CountryObjectID
Base Type
string
top