Service Directory > v32.1 > Payroll_GBR > Put_Worker_Pensions_Auto_Enrolment_Details
 

Operation: Put_Worker_Pensions_Auto_Enrolment_Details

Provides the ability to load one worker's UK Pensions Auto Enrolment Details.


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

This request holds one Worker Pensions Auto Enrolment Details record.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Worker_Pensions_Auto_Enrolment_Details_Reference  Payroll_Payee_Pensions_Auto_EnrolmentObject  [0..1]  Worker Pensions Auto Enrolment Details Reference   
Worker_Pensions_Auto_Enrolment_Details_Data  Worker_Pensions_Auto_Enrolment_Details_Data  [1..1]  Worker Pensions Auto Enrolment Details Data 
Validation Description
The Company specified is not valid for the Worker.   
Deferral Date should be greater than or equal to Effective Date.   
Deferral Date for the Worker cannot be before the Pensions Auto Enrolment Company Details Deferral Date.   
No Pensions Auto Enrolment Details have been added for this Company.   
You can only enter a Reason for exception when Exception from employer duties is selected.   
You cannot enter a Reason for exception if Exception removed is selected.   
You cannot select Exception from employer duties and Exception removed at the same time.   
The Effective Date should be on or after the Company Staging Date/Duties Start Date.   
 
Validation Description
If a Worker Pensions Auto Enrolment Details Reference is supplied to edit a record, you cannot edit the Worker, Company or Effective Date.   
To ensure accurate results in pensions auto enrolment assessment, you can’t edit Worker Pensions Auto Enrolment Details if payroll has been processed for the pay period.   
top
 

Response Element: Put_Worker_Pensions_Auto_Enrolment_Details_Response

Put Worker Pensions Auto Enrolment Details Response Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Worker_Pensions_Auto_Enrolment_Details_Reference  Payroll_Payee_Pensions_Auto_EnrolmentObject  [1..1]  The record ID.   
top
 

Payroll_Payee_Pensions_Auto_EnrolmentObject

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

Payroll_Payee_Pensions_Auto_EnrolmentObjectID

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

Worker_Pensions_Auto_Enrolment_Details_Data

part of: Put_Worker_Pensions_Auto_Enrolment_Details_Request
Worker Pensions Auto Enrolment Details Data
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [1..1]  Worker Reference   
Effective_Date  date  [1..1]  Effective Date   
Company_Reference  CompanyObject  [1..1]  Company Reference   
Deferral_Date  date  [0..1]  Deferral Date   
Eligible_for_Tax_Relief  boolean  [0..1]  Eligible for Tax Relief   
Opt_In [Choice]   boolean  [0..1]  Opt In   
Opt_Out_during_Postponement [Choice]   boolean  [0..1]  Opt Out during Postponement   
Exception_from_Employer_Duties  boolean  [0..1]  Exception from Employer Duties   
Reason_for_Exception  string  [0..1]  Reason for Exception   
Exception_Removed  boolean  [0..1]  Exception Removed   
Validation Description
The Company specified is not valid for the Worker.   
Deferral Date should be greater than or equal to Effective Date.   
Deferral Date for the Worker cannot be before the Pensions Auto Enrolment Company Details Deferral Date.   
No Pensions Auto Enrolment Details have been added for this Company.   
You can only enter a Reason for exception when Exception from employer duties is selected.   
You cannot enter a Reason for exception if Exception removed is selected.   
You cannot select Exception from employer duties and Exception removed at the same time.   
The Effective Date should be on or after the Company Staging Date/Duties Start Date.   
top
 

WorkerObject

part of: Worker_Pensions_Auto_Enrolment_Details_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: Worker_Pensions_Auto_Enrolment_Details_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_Payee_Pensions_Auto_EnrolmentReferenceEnumeration

part of: Payroll_Payee_Pensions_Auto_EnrolmentObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top