Service Directory > v31.2 > Payroll_GBR > Get_Payee_Tax_Codes
 

Operation: Get_Payee_Tax_Codes

Provides the ability to retrieve all or some worker's PAYE Tax information based on Critiera (Company/Worker).


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

Main Request information to retrieve records
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Payee_Tax_Code_Request_References  [0..1]  Used to locate a PAYE Record by ID   
Request_Criteria [Choice]   Payee_Tax_Code_Request_Criteria  [0..1]  Element to select PAYE Records by 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  Payee_Tax_Code_Response_Group  [0..1]  Payee Tax Code Response Group   
top
 

Response Element: Get_Payee_Tax_Codes_Response

PAYE Tax Record GET Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Payee_Tax_Code_Request_References  [0..1]  Used to locate a PAYE Record by ID   
Request_Criteria  Payee_Tax_Code_Request_Criteria  [0..1]  Element to select PAYE Records by 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  Payee_Tax_Code_Response_Group  [0..1]  Payee Tax Code 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  Payee_Tax_Code_Response_Data  [0..1]  Main PAYE Tax Response Element for GET   
top
 

Payee_Tax_Code_Request_References

part of: Get_Payee_Tax_Codes_Request, Get_Payee_Tax_Codes_Response
Used to locate a PAYE Record by ID
 
Parameter name Type/Value Cardinality Description Validations
Payee_Tax_Code_Reference  Unique_IdentifierObject  [1..*]  The PAYE Record to return (by ID).   
top
 

Unique_IdentifierObject

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

Unique_IdentifierObjectID

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

Payee_Tax_Code_Request_Criteria

part of: Get_Payee_Tax_Codes_Request, Get_Payee_Tax_Codes_Response
Element to select PAYE Records by Criteria
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference [Choice]   WorkerObject  [1..*]  None, One or More workers to return PAYE Records for.   
Company_Reference [Choice]   CompanyObject  [1..*]  None, or One Company to return PAYE records for.   
Effective_As_Of  date  [0..1]  Will return one record per worker, such that the effective date of the record is less than or equal to the Effective As Of. Will return all records if no date specified for the Worker(s).   
top
 

WorkerObject

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

CompanyObject

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

Response_Filter

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

Payee_Tax_Code_Response_Group

part of: Get_Payee_Tax_Codes_Request, Get_Payee_Tax_Codes_Response
Payee Tax Code Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include the Reference check   
top
 

Response_Results

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

Payee_Tax_Code_Response_Data

part of: Get_Payee_Tax_Codes_Response
Main PAYE Tax Response Element for GET
 
Parameter name Type/Value Cardinality Description Validations
Payee_Tax_Code  Payee_Tax_Code  [0..*]  PAYE Tax Record information   
top
 

Payee_Tax_Code

part of: Payee_Tax_Code_Response_Data
PAYE Tax Record information
 
Parameter name Type/Value Cardinality Description Validations
Payee_Tax_Code_Reference  Unique_IdentifierObject  [0..1]  Reference for the PAYE Tax Record.   
Payee_Tax_Code_Data  Payee_Tax_Code_Data  [0..*]  Main data associated with a Worker's PAYE Record 
Validation Description
Invalid tax code format, please submit valid tax code.   
The Company specified is not valid for the Worker.   
If Tax Code Notification Source is Starter Checklist, a Starter Checklist Box must be Checked or set as "No Box".   
If Tax Code Notification Source is NOT Starter Checklist, the Starter Checklist Statement field cannot have a value.   
A P45 form should not be issued to deceased workers.   
The P45 Leaver Issue Date cannot be a future date.   
The P45 Leaver Issue Date cannot be less than the worker's Hire Date.   
The [notif_source] Tax Year End cannot be greater than the tax year end of the Tax Code Effective Date.   
The P45 Leaving Date should not be later than the Effective Date.   
The Leaving Date added has no associated Tax Calendar Year   
A P45 Leaving Date is required for a P45 Starter Notification Source.   
Previous Employment Tax amount entered, Previous Employment Pay must have a value.   
Tax Regime [Regime] is not valid with the Tax Code supplied. Please select a valid Tax Regime or enter a valid Tax Code.   
Tax Regime [Regime] is not valid with the Notification Details selected. HMRC determine Scottish Rate Tax Payers.   
Previous Employment values can not be applied to W1/M1 tax codes, or Starter Checklist, P7X, P9X, P9 sources.   
Provide a Tax Year End when Previous Employment Pay is greater than zero.   
Provide a Previous Employment Pay value that is greater than zero when Previous Employment Tax is greater than zero.   
The P45 Leaver Issue Date can only be entered if the worker has been terminated or transferred.   
Tax Regime [Regime] is not valid with the Tax Code supplied. Please select a valid Tax Regime or enter a valid Tax Code.   
D2 is not a valid Tax Code before the 6th April 2018   
 
top
 

Payee_Tax_Code_Data

part of: Payee_Tax_Code
Main data associated with a Worker's PAYE Record
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [1..1]  The Worker for this record. This is required.   
Effective_As_Of  date  [1..1]  The effective date of this record. This is required.   
Company_Reference  CompanyObject  [1..1]  The Company the Worker is employed in for this record. This is required.   
Tax_Code_Notification_Source_Reference  Payroll_Constant_TextObject  [1..1]  The Notification Source of this PAYE record. See HMRC notes for valid values.   
Tax_Year_End_Reference  Calendar_YearObject  [0..1]  The Tax Year that this record applies to.   
P45_Leaving_Date  date  [0..1]  The leaving date for this P45 Starter Notification record.   
Previous_Employment_Pay  decimal (14, 2) >0   [0..1]  The Workers previous employment pay.   
Previous_Employment_Tax  decimal (14, 2) >0   [0..1]  The Workers previous employment tax paid.   
Starter_Checklist_Statement_Reference  Payroll_Constant_TextObject  [0..1]  If the worker has a notification source of Starter Checklist, this field should be completed with either None Selected, Statement A, Statement B or Statement C.   
Tax_Regime_Reference  Payroll_Constant_TextObject  [0..1]  Code to indicate worker's tax regime (blank or S for Scotland)   
Tax_Code  string  [1..1]  The Workers PAYE Tax Code. This is required.   
W1_M1_Tax_Basis  boolean  [0..1]  The Workers Tax Basis (True/False).   
P45_Leaver_Issue_Date  date  [0..1]  The date Terminated Worker was issued a P45.   
Validation Description
Invalid tax code format, please submit valid tax code.   
The Company specified is not valid for the Worker.   
If Tax Code Notification Source is Starter Checklist, a Starter Checklist Box must be Checked or set as "No Box".   
If Tax Code Notification Source is NOT Starter Checklist, the Starter Checklist Statement field cannot have a value.   
A P45 form should not be issued to deceased workers.   
The P45 Leaver Issue Date cannot be a future date.   
The P45 Leaver Issue Date cannot be less than the worker's Hire Date.   
The [notif_source] Tax Year End cannot be greater than the tax year end of the Tax Code Effective Date.   
The P45 Leaving Date should not be later than the Effective Date.   
The Leaving Date added has no associated Tax Calendar Year   
A P45 Leaving Date is required for a P45 Starter Notification Source.   
Previous Employment Tax amount entered, Previous Employment Pay must have a value.   
Tax Regime [Regime] is not valid with the Tax Code supplied. Please select a valid Tax Regime or enter a valid Tax Code.   
Tax Regime [Regime] is not valid with the Notification Details selected. HMRC determine Scottish Rate Tax Payers.   
Previous Employment values can not be applied to W1/M1 tax codes, or Starter Checklist, P7X, P9X, P9 sources.   
Provide a Tax Year End when Previous Employment Pay is greater than zero.   
Provide a Previous Employment Pay value that is greater than zero when Previous Employment Tax is greater than zero.   
The P45 Leaver Issue Date can only be entered if the worker has been terminated or transferred.   
Tax Regime [Regime] is not valid with the Tax Code supplied. Please select a valid Tax Regime or enter a valid Tax Code.   
D2 is not a valid Tax Code before the 6th April 2018   
top
 

Payroll_Constant_TextObject

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

Payroll_Constant_TextObjectID

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

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Payroll_Constant_TextReferenceEnumeration

part of: Payroll_Constant_TextObjectID
Base Type
string
top
 

Calendar_YearReferenceEnumeration

part of: Calendar_YearObjectID
Base Type
string
top