Service Directory > v32.1 > Payroll_GBR > Get_Worker_Pensions_Auto_Enrolment_Details
 

Operation: Get_Worker_Pensions_Auto_Enrolment_Details

Provides the ability to retrieve all or some of worker's Pensions Auto Enrolment Details bases on Criteria (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_Worker_Pensions_Auto_Enrolment_Details_Request

Get Worker Pensions Auto Enrolment Details Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Worker_Pensions_Auto_Enrolment_Details_Request_References  [0..1]  Worker Pensions Auto Enrolment Details References   
Request_Criteria [Choice]   Worker_Pensions_Auto_Enrolment_Details_Request_Criteria  [0..1]  Worker Pensions Auto Enrolment Details 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  Worker_Pensions_Auto_Enrolment_Details_Response_Group  [0..1]  Worker Pensions Auto Enrolment Details Response Group   
top
 

Response Element: Get_Worker_Pensions_Auto_Enrolment_Details_Response

Get Worker Pensions Auto Enrolment Details Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Worker_Pensions_Auto_Enrolment_Details_Request_References  [0..1]  Worker Pensions Auto Enrolment Details References   
Request_Criteria  Worker_Pensions_Auto_Enrolment_Details_Request_Criteria  [0..1]  Worker Pensions Auto Enrolment Details 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  Worker_Pensions_Auto_Enrolment_Details_Response_Group  [0..1]  Worker Pensions Auto Enrolment Details 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  Worker_Pensions_Auto_Enrolment_Details_Response_Data  [0..1]  Get Worker Pensions Auto Enrolment Details Response   
top
 

Worker_Pensions_Auto_Enrolment_Details_Request_References

part of: Get_Worker_Pensions_Auto_Enrolment_Details_Request, Get_Worker_Pensions_Auto_Enrolment_Details_Response
Worker Pensions Auto Enrolment Details Reference
 
Parameter name Type/Value Cardinality Description Validations
Worker_Pensions_Auto_Enrolment_Details_Reference  Payroll_Payee_Pensions_Auto_EnrolmentObject  [1..*]  Worker Pensions Auto Enrolment Details References   
top
 

Payroll_Payee_Pensions_Auto_EnrolmentObject

part of: Worker_Pensions_Auto_Enrolment_Details_Request_References, Worker_Pensions_Auto_Enrolment_Details
 
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_Request_Criteria

part of: Get_Worker_Pensions_Auto_Enrolment_Details_Request, Get_Worker_Pensions_Auto_Enrolment_Details_Response
Worker Pensions Auto Enrolment Details Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference [Choice]   WorkerObject  [1..*]  Worker Pensions Auto Enrolment Details Request Workers   
Company_Reference [Choice]   CompanyObject  [1..*]  Worker Pensions Auto Enrolment Details Request Companies   
Effective_As_Of  date  [0..1]  Worker Pensions Auto Enrolment Details Request Effective Date   
top
 

WorkerObject

part of: Worker_Pensions_Auto_Enrolment_Details_Data, Worker_Pensions_Auto_Enrolment_Details_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: Worker_Pensions_Auto_Enrolment_Details_Data, Worker_Pensions_Auto_Enrolment_Details_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_Worker_Pensions_Auto_Enrolment_Details_Request, Get_Worker_Pensions_Auto_Enrolment_Details_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
 

Worker_Pensions_Auto_Enrolment_Details_Response_Group

part of: Get_Worker_Pensions_Auto_Enrolment_Details_Request, Get_Worker_Pensions_Auto_Enrolment_Details_Response
Worker Pensions Auto Enrolment Details Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Worker Pensions Auto Enrolment Details Reference in the Response   
top
 

Response_Results

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

Worker_Pensions_Auto_Enrolment_Details_Response_Data

part of: Get_Worker_Pensions_Auto_Enrolment_Details_Response
Get Worker Pensions Auto Enrolment Details Response
 
Parameter name Type/Value Cardinality Description Validations
Worker_Pensions_Auto_Enrolment_Details  Worker_Pensions_Auto_Enrolment_Details  [0..*]  Worker Pensions Auto Enrolment Details Data   
top
 

Worker_Pensions_Auto_Enrolment_Details

part of: Worker_Pensions_Auto_Enrolment_Details_Response_Data
Worker Pensions Auto Enrolment Details Data
 
Parameter name Type/Value Cardinality Description Validations
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  [0..*]  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.   
 
top
 

Worker_Pensions_Auto_Enrolment_Details_Data

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

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