Service Directory > v31.2 > Payroll_GBR > Put_Payee_Tax_Code
 

Operation: Put_Payee_Tax_Code

Provides the ability to load one worker's UK PAYE Tax information.


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

The request holds one Payee Tax record.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Payee_Tax_Code_Data  Payee_Tax_Code_Data  [1..1]  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
 

Response Element: Put_Payee_Tax_Code_Response

Put Payroll PAYE Record Response Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Payee_Tax_Code_Reference  Unique_IdentifierObject  [0..1]  The record ID.   
Put_Payee_Tax_Code_Response_Data  Put_Payee_Tax_Code_Response_Data  [0..1]  Response review of PUT request for PAYE record.   
top
 

Payee_Tax_Code_Data

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

WorkerObject

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

CompanyObject

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

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_IdentifierObject

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

Put_Payee_Tax_Code_Response_Data

part of: Put_Payee_Tax_Code_Response
Response review of PUT request for PAYE record.
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [1..1]  The Worker for this Record that was created.   
Effective_As_Of  date  [1..1]  The Effective Date for this Record that was created.   
Company_Reference  CompanyObject  [1..1]  The Company for this Record that was created.   
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
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top