Service Directory > v32.1 > Payroll > Get_Payroll_Payee_PT1s
 

Operation: Get_Payroll_Payee_PT1s

This web service is used to return Payroll Payee PT1s


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

Get Payroll Payee PT1s Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Payroll_Payee_PT1_Request_References  [0..1]  Payroll Payee PT1 Request References   
Request_Criteria [Choice]   Payroll_Payee_PT1_Request_Criteria  [0..1]  Payroll Payee PT1 Request Criteria [EL]   
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_PT1_Response_Group  [0..1]  Payroll Payee PT1 Response Group   
top
 

Response Element: Get_Payroll_Payee_PT1s_Response

Get Payroll Payee PT1s Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Payroll_Payee_PT1_Request_References  [0..1]  Payroll Payee PT1 Request References   
Request_Criteria  Payroll_Payee_PT1_Request_Criteria  [0..1]  Payroll Payee PT1 Request Criteria [EL]   
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_PT1_Response_Group  [0..1]  Payroll Payee PT1 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_PT1_Response_Data  [0..1]  Payroll Payee PT1 Response Data   
top
 

Payroll_Payee_PT1_Request_References

part of: Get_Payroll_Payee_PT1s_Request, Get_Payroll_Payee_PT1s_Response
Payroll Payee PT1 Request References
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Payee_PT1_Reference  Payroll_Payee_PT1Object  [1..*]  Payroll Payee PT1 Request Reference   
top
 

Payroll_Payee_PT1Object

part of: Payroll_Payee_PT1_Request_References, Payroll_Payee_PT1, Payroll_Payee_PT1_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_PT1ObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Payroll_Payee_PT1ObjectID

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

part of: Get_Payroll_Payee_PT1s_Request, Get_Payroll_Payee_PT1s_Response
Payroll Payee PT1 Request Criteria [EL]
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Payroll_Payee_PT1s_Request, Get_Payroll_Payee_PT1s_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_Payee_PT1_Response_Group

part of: Get_Payroll_Payee_PT1s_Request, Get_Payroll_Payee_PT1s_Response
Payroll Payee PT1 Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

part of: Get_Payroll_Payee_PT1s_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_PT1_Response_Data

part of: Get_Payroll_Payee_PT1s_Response
Payroll Payee PT1 Response Data
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Payee_PT1  Payroll_Payee_PT1  [0..*]  Payroll Payee PT1 Record Data   
top
 

Payroll_Payee_PT1

part of: Payroll_Payee_PT1_Response_Data
Payroll Payee PT1 Record Data
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Payee_PT1_Reference  Payroll_Payee_PT1Object  [0..1]  Payroll Payee PT1 Reference   
Payroll_Payee_PT1_Data  Payroll_Payee_PT1_Data  [0..*]  The Data Related to Payroll Payee PT1 Tax Election 
Validation Description
The Manitoba Family Tax Benefit Amount can only be entered when province is Manitoba.   
The allowance for Dependents Under Age 19 can only be entered for Ontario.   
The allowance for Disabled Dependents can only be entered when the province is Ontario.   
The Senior Supplementary Amount for Withholding can only be entered when province is Saskatchewan.   
The Exempt indicator can only be selected when the province is Quebec.   
The Deduction for Living in a Prescribed Zone amount can only be entered when the province is Quebec.   
The Additional Amount can only be entered when the province is Quebec or the province is Newfoundland and Labrador and the effective date is less that January 1, 2012.   
Age 65 or older applies to Quebec only. This was added to the TP-1015.3-V for the 2012 tax year and is only valid on or after this date.   
Worker has no Position within this company. Tax Elections can only be created for Companies for which the Worker has a Position.   
The Exempt Health Contribution indicator can only be selected when the province is Quebec.   
The Child Amount for Withholding can only be entered when province is Saskatchewan, Quebec or Yukon.   
The Basic Personal Amount entered does not fall within the permitted range for the tax year selected.   
The Age Amount Supplement, Spouse or Common-Law Partner Amount Supplement, and Amount for an Eligible Dependant Supplement fields are not available for the tax year or province selected.   
 
top
 

Payroll_Payee_PT1_Data

part of: Payroll_Payee_PT1
Payroll Payee PT1 Data
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Payee_PT1_Reference  Payroll_Payee_PT1Object  [0..1]  Payroll Payee PT1 Reference   
Company_Reference  CompanyObject  [1..1]  Company reference.   
Worker_Reference  WorkerObject  [1..1]  Worker Reference   
Effective_As_Of  date  [1..1]  Effective As of Date   
Payroll_State_Authority_Reference  Payroll_State_AuthorityObject  [1..1]  Payroll State Authority Reference   
Basic_Personal_Amount  decimal (12, 0) >0   [0..1]  PT1 Basic Personal Amount   
Child_Amount  decimal (12, 0) >0   [0..1]  PT1 Child Amount   
Age_Amount  decimal (12, 0) >0   [0..1]  PT1 Age Amount   
Age_Amount_Supplement  decimal (12, 0) >0   [0..1]  PT1 Age Amount Supplement   
Senior_Supplementary_Amount_for_Withholding  decimal (12, 0) >0   [0..1]  PT1 Senior Supplementary Amount for Withholding   
Amount_for_Workers_65_or_Older  decimal (12, 0) >0   [0..1]  PT1 Amount for Workers 65 or Older   
Pension_Income_Amount  decimal (12, 0) >0   [0..1]  PT1 Pension Income Amount   
Tuition__Education_and_Textbook_Amounts  decimal (12, 0) >0   [0..1]  PT1 Tuition, Education and Textbook Amounts   
Disability_Amount  decimal (12, 0) >0   [0..1]  PT1 Disability Amount   
Spouse_or_Common-law_Partner_Amount  decimal (12, 0) >0   [0..1]  PT1 Spouse or Common-law Partner Amount   
Spouse_or_Common-law_Partner_Amount_Supplement  decimal (12, 0) >0   [0..1]  PT1 Spouse or Common-law Partner Amount Supplement   
Additional_Amount  decimal (8, 2) >0   [0..1]  PT1 Additional Amount   
Deduction_for_Living_in_a_Prescribed_Zone  decimal (12, 0) >0   [0..1]  PT1 Deduction for Living in a Prescribed Zone   
Amount_for_an_Eligible_Dependant  decimal (12, 0) >0   [0..1]  PT1 Amount for an Eligible Dependant   
Amount_for_an_Eligible_Dependant_Supplement  decimal (12, 0) >0   [0..1]  PT1 Amount for an Eligible Dependant Supplement   
Caregiver_Amount  decimal (12, 0) >0   [0..1]  PT! Caregiver Amount   
Amount_for_Infirm_Dependants_Age_18_or_Older  decimal (12, 0) >0   [0..1]  PT1 Amount for Infirm Dependants Age 18 or Older   
Amounts_Transferred_from_your_Spouse_or_Common-law_Partner  decimal (12, 0) >0   [0..1]  PT1 Amounts Transferred from your Spouse or Common-law Partner   
Amounts_Transferred_from_a_Dependant  decimal (12, 0) >0   [0..1]  PT1 Amounts Transferred from a Dependant   
Manitoba_Family_Tax_Benefit_Amount  decimal (12, 0) >0   [0..1]  PT1 Manitoba Family Tax Benefit Amount   
Total_Income_less_than_Total_Claim_Amount  boolean  [0..1]  PT1 Total Income less than Total Claim Amount   
More_than_One_Employer_Reference  boolean  [0..1]  PT1 More than One Employer Reference   
Dependents_Under_Age_19  decimal (2, 0) >0   [0..1]  PT1 Dependents Under Age 19   
Disabled_Dependents  decimal (2, 0) >0   [0..1]  PT1 Disabled Dependents   
Exempt  boolean  [0..1]  PT1 Exempt   
Exempt_from_Health_Contribution  boolean  [0..1]  PT1 Exempt from Health Contribution   
Last_Updated  dateTime  [0..1]  PT1 Last Updated   
Validation Description
The Manitoba Family Tax Benefit Amount can only be entered when province is Manitoba.   
The allowance for Dependents Under Age 19 can only be entered for Ontario.   
The allowance for Disabled Dependents can only be entered when the province is Ontario.   
The Senior Supplementary Amount for Withholding can only be entered when province is Saskatchewan.   
The Exempt indicator can only be selected when the province is Quebec.   
The Deduction for Living in a Prescribed Zone amount can only be entered when the province is Quebec.   
The Additional Amount can only be entered when the province is Quebec or the province is Newfoundland and Labrador and the effective date is less that January 1, 2012.   
Age 65 or older applies to Quebec only. This was added to the TP-1015.3-V for the 2012 tax year and is only valid on or after this date.   
Worker has no Position within this company. Tax Elections can only be created for Companies for which the Worker has a Position.   
The Exempt Health Contribution indicator can only be selected when the province is Quebec.   
The Child Amount for Withholding can only be entered when province is Saskatchewan, Quebec or Yukon.   
The Basic Personal Amount entered does not fall within the permitted range for the tax year selected.   
The Age Amount Supplement, Spouse or Common-Law Partner Amount Supplement, and Amount for an Eligible Dependant Supplement fields are not available for the tax year or province selected.   
top
 

CompanyObject

part of: Payroll_Payee_PT1_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_PT1_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_State_AuthorityObject

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

Payroll_State_AuthorityObjectID

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

part of: Payroll_Payee_PT1ObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Payroll_State_AuthorityReferenceEnumeration

part of: Payroll_State_AuthorityObjectID
Base Type
string
top