Service Directory > v31.2 > Payroll_GBR > Get_Payroll_Payee_NIs
 

Operation: Get_Payroll_Payee_NIs

Provides the ability to retrieve all or some worker's PAYE NI 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_Payroll_Payee_NIs_Request

Get Payroll Payee NIs Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Payroll_Payee_NI_Request_References  [0..1]  Payroll Payee NI References   
Request_Criteria [Choice]   Payroll_Payee_NI_Request_Criteria  [0..1]  Payroll Payee NI 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_NI_Response_Group  [0..1]  Payroll Payee NI Response Group   
top
 

Response Element: Get_Payroll_Payee_NIs_Response

Get Payroll Payee NI Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Payroll_Payee_NI_Request_References  [0..1]  Payroll Payee NI References   
Request_Criteria  Payroll_Payee_NI_Request_Criteria  [0..1]  Payroll Payee NI 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_NI_Response_Group  [0..1]  Payroll Payee NI 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_NI_Response_Data  [0..1]  Get Payroll Payee NI Response   
top
 

Payroll_Payee_NI_Request_References

part of: Get_Payroll_Payee_NIs_Request, Get_Payroll_Payee_NIs_Response
Payroll Payee NI References
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Payee_NI_Reference  Unique_IdentifierObject  [1..*]  Payroll Payee NI References   
top
 

Unique_IdentifierObject

part of: Payroll_Payee_NI_Request_References, Payroll_Payee_NI
 
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_Request_Criteria

part of: Get_Payroll_Payee_NIs_Request, Get_Payroll_Payee_NIs_Response
Payroll Payee NI Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference [Choice]   WorkerObject  [1..*]  Payroll Payee NI Request Worker   
Company_Reference [Choice]   CompanyObject  [1..*]  Payroll Payee NI Request Companies   
Effective_As_Of  date  [0..1]  Payroll Payee NI Request Effective Date   
top
 

WorkerObject

part of: Payroll_Payee_NI_Data, Payroll_Payee_NI_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: Payroll_Payee_NI_Data, Payroll_Payee_NI_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_Payroll_Payee_NIs_Request, Get_Payroll_Payee_NIs_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_NI_Response_Group

part of: Get_Payroll_Payee_NIs_Request, Get_Payroll_Payee_NIs_Response
Payroll Payee NI Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Payroll Payee NI Reference in the Response   
top
 

Response_Results

part of: Get_Payroll_Payee_NIs_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_NI_Response_Data

part of: Get_Payroll_Payee_NIs_Response
Get Payroll Payee NI Response
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Payee_NI  Payroll_Payee_NI  [0..*]  Payroll Payee NI Data   
top
 

Payroll_Payee_NI

part of: Payroll_Payee_NI_Response_Data
Payroll Payee NI Data
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Payee_NI_Reference  Unique_IdentifierObject  [0..1]  Payroll Payee NI Reference   
Payroll_Payee_NI_Data  Payroll_Payee_NI_Data  [0..*]  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   
 
top
 

Payroll_Payee_NI_Data

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

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