Service Directory > v31.2 > Payroll_GBR > Put_Payroll_Payee_NI
 

Operation: Put_Payroll_Payee_NI

Provides the ability to load one worker's UK PAYE NI 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_Payroll_Payee_NI_Request

The request holds one Payee NI record.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Payroll_Payee_NI_Reference  Unique_IdentifierObject  [0..1]  Payroll Payee NI Reference   
Payroll_Payee_NI_Data  Payroll_Payee_NI_Data  [0..1]  Payroll Payee NI Data 
Validation Description
Invalid SCON. SCON is nine characters in length and is formatted as follows: 1. Character 1 must be alpha -"S". 2. Characters 2 - 8 must be numeric. 3. Character 9 must be Alpha but may not be "G", "I", "O", "S", "U", "V" or "Z". 4. The 9th character must pass the modulus 19 check.   
The Company specified is not valid for the Worker.   
Payroll configuration does not support Position on NI. Please remove the Position and re-try or enable Position for NI.   
Position is not valid for the Worker.   
The field SCON is required and must have a value.   
NI Category is invalid as of Effective Date supplied.   
A record already exists for this Worker, Company and Effective Date (and Position if applicable).   
Worker reaches State Pension Age on [SPA date], NI Category C cannot be applied   
Worker reached State Pension Age on [SPA date], NI Category C must be applied.   
Worker is aged 21 or over, selected NI Category cannot be applied.   
Worker is aged under 21, selected NI Category cannot be applied.   
Date of Birth does not exist, selected NI Category cannot be applied.   
Certificate of Election is only valid when NI Category is either B or E.   
Proof of Age Exemption is only valid when NI Category is C.   
CA2700 fields are only valid when NI Category is J, K, L or Z   
NI Category B and E are only valid for Female Employee   
Where CA2700 is received, both CA2700 checkbox and the tax year to which it applies must be selected.   
SCON is not applicable for NI Category.   
A Proof of Age Exemption selection is required for NI Category C   
A Certificate of Election selection is required for NI Category B or E   
NI calculation method can not be changed from Directors to Standard during the tax year. Please change at the start of the next tax year.   
For Directors NI, select Directors NI and perform cumulative calculation. Directors NI Alternative Arrangement is not supported.   
Worker is aged [age_max] or over, selected NI Category cannot be applied   
 
Validation Description
If a Payroll Payee NI Reference is supplied to edit a record, you cannot edit the Worker, Company or Effective Date.   
top
 

Response Element: Put_Payroll_Payee_NI_Response

Put Payroll Payee NI Response Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Payroll_Payee_NI_Reference  Unique_IdentifierObject  [1..1]  The record ID.   
top
 

Unique_IdentifierObject

part of: Put_Payroll_Payee_NI_Request, Put_Payroll_Payee_NI_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
 

Payroll_Payee_NI_Data

part of: Put_Payroll_Payee_NI_Request
Payroll Payee NI Data
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [1..1]  Worker Reference   
Effective_As_Of  date  [1..1]  Effective date NI category assigned to employee   
Company_Reference  CompanyObject  [1..1]  Company for employee   
NI_Category_Reference  NI_CategoryObject  [1..1]  NI category (as defined by the HMRC such as A, B, C, etc) for employee   
Position_Reference  PositionObject  [0..1]  Position for employee - only if position for NI configured at company level   
Calculation_Method_Reference  Payroll_Constant_TextObject  [1..1]  NI calculation method (Standard NI or Directors NI) for employee.   
SCON  string (9)   [0..1]  Scheme contracted out number (SCON) for employee (only required for NI categories D, E, I, K, L) and must pass modulus 19 validation   
Proof_of_Age_Exemption_Reference  Payroll_Constant_TextObject  [0..1]  Proof of Age Exemption (Certificate of Age Exception, ID: Birth Certificate, ID: Driving Licence, ID: Passport, None Selected) for employee (only for NI category C)   
CA2700  boolean  [0..1]  CA2700 certificate for employee (only for NI categories J, K, L, Z)   
CA2700_Valid_for_Tax_Year_Ending_Reference  Calendar_YearObject  [0..1]  Tax year end for valid CA2700 certificate for employee (required if CA2700 certificate is indicated)   
Certificate_of_Election_Reference  Payroll_Constant_TextObject  [0..1]  Certificate of Election (CA4139, CF380A, CF383, None Selected) for employee (required only for NI categories B, E)   
Validation Description
Invalid SCON. SCON is nine characters in length and is formatted as follows: 1. Character 1 must be alpha -"S". 2. Characters 2 - 8 must be numeric. 3. Character 9 must be Alpha but may not be "G", "I", "O", "S", "U", "V" or "Z". 4. The 9th character must pass the modulus 19 check.   
The Company specified is not valid for the Worker.   
Payroll configuration does not support Position on NI. Please remove the Position and re-try or enable Position for NI.   
Position is not valid for the Worker.   
The field SCON is required and must have a value.   
NI Category is invalid as of Effective Date supplied.   
A record already exists for this Worker, Company and Effective Date (and Position if applicable).   
Worker reaches State Pension Age on [SPA date], NI Category C cannot be applied   
Worker reached State Pension Age on [SPA date], NI Category C must be applied.   
Worker is aged 21 or over, selected NI Category cannot be applied.   
Worker is aged under 21, selected NI Category cannot be applied.   
Date of Birth does not exist, selected NI Category cannot be applied.   
Certificate of Election is only valid when NI Category is either B or E.   
Proof of Age Exemption is only valid when NI Category is C.   
CA2700 fields are only valid when NI Category is J, K, L or Z   
NI Category B and E are only valid for Female Employee   
Where CA2700 is received, both CA2700 checkbox and the tax year to which it applies must be selected.   
SCON is not applicable for NI Category.   
A Proof of Age Exemption selection is required for NI Category C   
A Certificate of Election selection is required for NI Category B or E   
NI calculation method can not be changed from Directors to Standard during the tax year. Please change at the start of the next tax year.   
For Directors NI, select Directors NI and perform cumulative calculation. Directors NI Alternative Arrangement is not supported.   
Worker is aged [age_max] or over, selected NI Category cannot be applied   
top
 

WorkerObject

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

NI_CategoryObject

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

NI_CategoryObjectID

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

PositionObject

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

PositionObjectID

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

NI_CategoryReferenceEnumeration

part of: NI_CategoryObjectID
Base Type
string
top
 

PositionReferenceEnumeration

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