Service Directory > v33.1 > Payroll_CAN > Get_Payroll_Payee_TD1-INs
 

Operation: Get_Payroll_Payee_TD1-INs

This web service is used to return TD1-IN Exemption Percent for workers


@ - 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_Payee_TD1-INs_Request

Get Payroll Payee TD1-INs Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Payroll_Payee_TD1-IN_Request_References  [0..1]  Payroll Payee TD1-IN Request References   
Request_Criteria [Choice]   Payroll_Payee_TD1-IN_Request_Criteria  [0..1]  Payroll Payee TD1-IN 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_Payee_TD1-IN_Response_Group  [0..1]  Payroll Payee TD1-IN Response Group   
top
 

Response Element: Get_Payroll_Payee_TD1-INs_Response

Get Payroll Payee TD1-INs Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Payroll_Payee_TD1-IN_Request_References  [0..1]  Payroll Payee TD1-IN Request References   
Request_Criteria  Payroll_Payee_TD1-IN_Request_Criteria  [0..1]  Payroll Payee TD1-IN 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_Payee_TD1-IN_Response_Group  [0..1]  Payroll Payee TD1-IN 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_Payee_TD1-IN_Response_Data  [0..1]  Payroll Payee TD1-IN Response Data   
top
 

Payroll_Payee_TD1-IN_Request_References

part of: Get_Payroll_Payee_TD1-INs_Response, Get_Payroll_Payee_TD1-INs_Request
Payroll Payee TD1-IN Request References
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Payee_TD1-IN_Reference  Payroll_Payee_TD1-INObject  [1..*]  TD1-IN Election Reference   
top
 

Payroll_Payee_TD1-INObject

part of: Payroll_Payee_TD1-IN, Payroll_Payee_TD1-IN_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_TD1-INObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Payroll_Payee_TD1-INObjectID

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

Payroll_Payee_TD1-IN_Request_Criteria

part of: Get_Payroll_Payee_TD1-INs_Response, Get_Payroll_Payee_TD1-INs_Request
Payroll Payee TD1-IN Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Payroll_Payee_TD1-INs_Response, Get_Payroll_Payee_TD1-INs_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, become effective (Also referred to as the Effective Moment). If you don't specify a date, this date defaults to today.{+4}   
As_Of_Entry_DateTime  dateTime  [0..1]  The date and time the data was entered into the system. (This field is also referred to as the Entry Moment). If the date isn't specified, the default date is the current date and time.   
Page  decimal (12, 0) >0   [0..1]  The numbered page of data Workday returns in the response. The default page is 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. Set a value between 1 and 999. The default value is 100.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Payroll_Payee_TD1-IN_Response_Group

part of: Get_Payroll_Payee_TD1-INs_Response, Get_Payroll_Payee_TD1-INs_Request
Payroll Payee TD1-IN Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

part of: Get_Payroll_Payee_TD1-INs_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 your request returned.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages requested. A page of data in a WWS has a 100 entry maximum.   
Page_Results  decimal (12, 0) >0   [0..1]  The number of results in the current page.   
Page  decimal (12, 0) >0   [0..1]  The page number of the data the WWS returned for your request.   
top
 

Payroll_Payee_TD1-IN_Response_Data

part of: Get_Payroll_Payee_TD1-INs_Response
Payroll Payee TD1-IN Response Data
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Payee_TD1-IN  Payroll_Payee_TD1-IN  [0..*]  Payroll Payee TD1-IN   
top
 

Payroll_Payee_TD1-IN

part of: Payroll_Payee_TD1-IN_Response_Data
Payroll Payee TD1-IN
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Payee_TD1-IN_Reference  Payroll_Payee_TD1-INObject  [0..1]  Payroll Payee TD1-IN Reference   
Payroll_Payee_TD1-IN_Data  Payroll_Payee_TD1-IN_Data  [0..*]  Payroll Payee TD1-IN Data 
Validation Description
The Inactive check box is selected, so the Percent Exempt must be zero. To enter a Percent Exempt, deselect the Inactive check box on the worker tax election.   
Enter a Percent Exempt value greater than 0 and less than 1.   
 
top
 

Payroll_Payee_TD1-IN_Data

part of: Payroll_Payee_TD1-IN
Payroll Payee TD1-IN Data
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Payee_TD1-IN_ID  string  [0..1]  Payroll Payee TD1-IN ID   
Company_Reference  CompanyObject  [1..1]  Company Reference   
Worker_Reference  WorkerObject  [1..1]  Worker Reference   
Effective_Date  date  [1..1]  Effective Date   
Percent_Exempt  decimal (7, 4) >0   [0..1]  TD1-IN Percent Exempt   
Inactivate_State_Tax  boolean  [0..1]  TD1-IN Inactivate State Tax   
Last_Updated  dateTime  [0..1]  TD1-IN Last Updated   
Last_Updated_By_Reference  WorkerObject  [0..1]  Last Updated By Reference   
Validation Description
The Inactive check box is selected, so the Percent Exempt must be zero. To enter a Percent Exempt, deselect the Inactive check box on the worker tax election.   
Enter a Percent Exempt value greater than 0 and less than 1.   
top
 

CompanyObject

part of: Payroll_Payee_TD1-IN_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  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
 

WorkerObject

part of: Payroll_Payee_TD1-IN_Data, Payroll_Payee_TD1-IN_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_Payee_TD1-INReferenceEnumeration

part of: Payroll_Payee_TD1-INObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top