Service Directory > v31.2 > Benefits_Administration > Enroll_in_Retirement_Savings_Plans
 

Operation: Enroll_in_Retirement_Savings_Plans

This service operation allows for enrollment into Retirement Savings Plans. It updates incrementally from existing elections and carries forward prior elections unless they are explicitly changed or waived.


@ - 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: Enroll_in_Retirement_Savings_Plans_Request

Enroll in Retirement Savings Plans Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Business_Process_Parameters  Business_Process_Parameters  [0..1]  Container for the processing options for a business process. If no options are submitted (or the options are submitted as 'false') then the business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.   
Enroll_in_Retirement_Savings_Plans_Data  Enroll_in_Retirement_Savings_Plans_Data  [0..1]  Enroll in Retirement Savings Plans 
Validation Description
You already have an election on this day. You may change your election for a different day or contact your Benefit Administrator for assistance.   
 
top
 

Response Element: Enroll_in_Retirement_Savings_Plans_Response

Enroll in Retirement Savings Plans Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Enroll_in_Retirement_Savings_Plans_Reference  Unique_IdentifierObject  [0..1]  Enroll in Retirement Savings Plans ReferenceEnroll in Retirement Savings Plans Reference   
top
 

Business_Process_Parameters

part of: Enroll_in_Retirement_Savings_Plans_Request
Container for the processing options for a business process. If no options are submitted (or the options are submitted as 'false') then the business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.
 
Parameter name Type/Value Cardinality Description Validations
Auto_Complete  boolean  [0..1]  When set to "true" or "1", the business process is automatically processed. This means that all approvals will be automatically approved in the system, all reviews and to-do's will be automatically by-passed, and all notifications will be automatically suppressed.   
Run_Now  boolean  [0..1]  Indicates the transaction should process to completion before the response is generated. Note: All < v12 operations will process with Run_Now = True for backwards compatibility but please review this setting in your environment for performance conditions.   
Comment_Data  Business_Process_Comment_Data  [0..1]  Captures a comment for the Business Process.   
Business_Process_Attachment_Data  Business_Process_Attachment_Data  [0..*]  Element for the attachments pertaining to a Event entered through a web service. 
Validation Description
This Business Process Type has been configured to not accept Event Attachments.   
 
top
 

Business_Process_Comment_Data

part of: Business_Process_Parameters
Captures a comment for the Business Process.
 
Parameter name Type/Value Cardinality Description Validations
Comment  string  [0..1]  Free form comment regarding the business process. 
Validation Description
This Business Process has been configured to disable comment. Please remove the comment or change the setting in the Business Process Policy or tenant setup.   
 
Worker_Reference  WorkerObject  [0..1]  Default the Person making the comment to the processing person if not submitted via the web service.   
top
 

WorkerObject

part of: Business_Process_Comment_Data, Enroll_in_Retirement_Savings_Plans_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
 

Business_Process_Attachment_Data

part of: Business_Process_Parameters
Element for the attachments pertaining to a Event entered through a web service.
 
Parameter name Type/Value Cardinality Description Validations
File_Name  string (255)   [1..1]  Filename for the attachment.   
Event_Attachment_Description  string  [0..1]  Free form text comment about the attachment.   
Event_Attachment_Category_Reference  Event_Attachment_CategoryObject  [0..1]  Category of attachment. 
Validation Description
This Business Process Type has been configured to not accept Attachment Categories.   
 
File  base64Binary  [0..1]  Binary file contents.   
Content_Type  string (80)   [0..1]  Text attribute identifying Content Type of the Attachment.   
top
 

Event_Attachment_CategoryObject

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

Event_Attachment_CategoryObjectID

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

Enroll_in_Retirement_Savings_Plans_Data

part of: Enroll_in_Retirement_Savings_Plans_Request
Enroll in Retirement Savings Plans Data
 
Parameter name Type/Value Cardinality Description Validations
Employee_Reference  WorkerObject  [1..1]  Employee Reference   
Event_Date  date  [1..1]  Event Date   
Retirement_Savings_Election_Data  Retirement_Savings_Election_Data_for_Change_Retirement_Savings_Plans  [0..*]  Retirement Savings Election Data 
Validation Description
[worker] is not eligible for [plan]   
Beneficiary Allocation must sum to 100 or 0   
Beneficiary Allocation must sum to 100 or 0   
[plan] requires a beneficiary designation   
[plan] does not allow percentage elections   
[plan] does not allow amount elections   
Election values out of range   
The following Beneficiaries are not related to [worker]: [beneficiaries]   
You must elect one or more Primary Beneficiaries totaling 100%.   
[plan] elections should be grouped by coverage type.   
Loaded Original Coverage Begin Date must be equal to or before the Benefit Event Date.   
Retirement Savings Coverage Type "[plan cov type]" is not part of the Event Type "[event type]".   
 
Retirement_Savings_Coverage_Type_Data  Benefit_Coverage_Type_for_Retirement_Savings_Elections_Data  [0..*]  Benefit coverage type level values 
Validation Description
Employee Contribution Percent or Employee Contribution Amount has entry but no Employee Contribution Allocation was set up for the Coverage Type.   
Employee Contribution Percent must be less than or equal to the maximum.   
Employee Contribution Amount must be less than or equal to the maximum.   
Enter a whole number for the Employee Contribution Percent for [Coverage Type].   
Employee Contribution Allocation must total 100%.   
Employer Contribution Allocation must equal 100%.   
Employee Contribution Percentage not allowed because none of the plans under the coverage type have Contribution Percentage Maximum defined.   
Employee Contribution Amount not allowed because none of the plans under the coverage type have Contribution Amount Maximum defined.   
[coverage type] coverage type has not been set up with Retirement Savings Allocation.   
Employer Retirement Savings Allocation must be zero because a contribution was entered and the Allocation Rule is Allocate Only If No Contribution Made   
 
Validation Description
You already have an election on this day. You may change your election for a different day or contact your Benefit Administrator for assistance.   
top
 

Retirement_Savings_Election_Data_for_Change_Retirement_Savings_Plans

part of: Enroll_in_Retirement_Savings_Plans_Data
Retirement Savings Election Data
 
Parameter name Type/Value Cardinality Description Validations
Coverage_Begin_Date  date  [1..1]  Coverage start date. Workday overwrites if the date doesn't meet the Coverage Begin Date rules.   
Original_Coverage_Begin_Date  date  [0..1]  Original Coverage Begin Date   
Deduction_Begin_Date  date  [0..1]  Deduction start date. Workday overwrites if the date doesn't meet the Deduction Begin Date rules.   
Loaded_Original_Deduction_Begin_Date  date  [0..1]  Start date for when the deduction first occurred for this benefit coverage plan. Example: Loading a worker into Workday from a third-party application. Only use this field the first time you load the original benefit package of this coverage type for a worker.   
Elect  boolean  [0..1]  Elect   
Retirement_Savings_Plan_Reference  Retirement_Savings_PlanObject  [1..1]  Retirement Savings Plan Reference   
Election_Percentage [Choice]   decimal (5, 2) >0   [0..1]  Election PercentageElection Percentage   
Election_Amount [Choice]   decimal (26, 6)   [0..1]  Election Amount   
Beneficiary_Allocation_Data  Beneficiary_Allocation_for_Change_Benefits_Data  [0..*]  Beneficiary Allocation Data   
Validation Description
[worker] is not eligible for [plan]   
Beneficiary Allocation must sum to 100 or 0   
Beneficiary Allocation must sum to 100 or 0   
[plan] requires a beneficiary designation   
[plan] does not allow percentage elections   
[plan] does not allow amount elections   
Election values out of range   
The following Beneficiaries are not related to [worker]: [beneficiaries]   
You must elect one or more Primary Beneficiaries totaling 100%.   
[plan] elections should be grouped by coverage type.   
Loaded Original Coverage Begin Date must be equal to or before the Benefit Event Date.   
Retirement Savings Coverage Type "[plan cov type]" is not part of the Event Type "[event type]".   
top
 

Retirement_Savings_PlanObject

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

Retirement_Savings_PlanObjectID

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

Beneficiary_Allocation_for_Change_Benefits_Data

part of: Retirement_Savings_Election_Data_for_Change_Retirement_Savings_Plans, Retirement_Savings_Election_for_Coverage_Type_Data
Beneficiary Allocation data
 
Parameter name Type/Value Cardinality Description Validations
Beneficiary_Reference  BeneficiaryObject  [1..1]  Unique identifier of the person designated to receive the Beneficiary Allocation.   
Primary_Percentage [Choice]   decimal (5, 2) >0   [1..1]  The allocated percentage of the primary type.   
Contingent_Percentage [Choice]   decimal (5, 2) >0   [1..1]  The allocated percentage of the contingent type.   
top
 

BeneficiaryObject

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

BeneficiaryObjectID

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

Benefit_Coverage_Type_for_Retirement_Savings_Elections_Data

part of: Enroll_in_Retirement_Savings_Plans_Data
Benefit coverage type level values
 
Parameter name Type/Value Cardinality Description Validations
Benefit_Coverage_Type_Reference  Benefit_Coverage_TypeObject  [1..1]  Unique identifier for the benefit coverage type.   
Employee_Contribution_Percentage [Choice]   decimal (5, 2) >0   [0..1]  The percentage contribution of the employee's salary.   
Employee_Contribution_Amount [Choice]   decimal (21, 6) >0   [0..1]  The contribution amount, in currency, of the employee's salary.   
Do_not_auto_enroll_in_unspecified_plans  boolean  [0..1]  Employees will not be auto enrolled through the Change Benefits (Web Service) and Enroll in Retirement Savings Plans (Web Service) for eligible plans unless they specify a nonzero election.   
Retirement_Savings_Election_for_Coverage_Type_Data  Retirement_Savings_Election_for_Coverage_Type_Data  [0..*]  Retirement Savings Elections under coverage type 
Validation Description
Beneficiary Allocation must sum to 100 or 0   
Beneficiary Allocation must sum to 100 or 0   
[worker] is not eligible for [plan]   
Coverage Begin Date must be on or after the Benefit Event Date   
[plan] requires a beneficiary designation   
The following Beneficiaries are not related to [worker]: [beneficiaries]   
Employee Contribution Allocation Percent has entry but no Employee Contribution Allocation was set up for the Coverage Type.   
Employer Contribution Allocation Percent has entry but no Employer Contribution Allocation was set up for the Coverage Type.   
Election values out of range   
Employee Contribution Allocation has entry but there is no Employee Contribution Percent or Employee Contribution Amount.   
[plan] plan is not available under coverage type [coverage type].   
Decimals are not allowed in Employee Contribution Allocation Percent.   
Loaded Original Coverage Begin Date must be equal to or before the Benefit Event Date.   
Retirement Savings Coverage Type "[plan cov type]" is not part of the Event Type "[event type]".   
 
Validation Description
Employee Contribution Percent or Employee Contribution Amount has entry but no Employee Contribution Allocation was set up for the Coverage Type.   
Employee Contribution Percent must be less than or equal to the maximum.   
Employee Contribution Amount must be less than or equal to the maximum.   
Enter a whole number for the Employee Contribution Percent for [Coverage Type].   
Employee Contribution Allocation must total 100%.   
Employer Contribution Allocation must equal 100%.   
Employee Contribution Percentage not allowed because none of the plans under the coverage type have Contribution Percentage Maximum defined.   
Employee Contribution Amount not allowed because none of the plans under the coverage type have Contribution Amount Maximum defined.   
[coverage type] coverage type has not been set up with Retirement Savings Allocation.   
Employer Retirement Savings Allocation must be zero because a contribution was entered and the Allocation Rule is Allocate Only If No Contribution Made   
top
 

Benefit_Coverage_TypeObject

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

Benefit_Coverage_TypeObjectID

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

Retirement_Savings_Election_for_Coverage_Type_Data

part of: Benefit_Coverage_Type_for_Retirement_Savings_Elections_Data
Benefit Coverage Type level values
 
Parameter name Type/Value Cardinality Description Validations
Coverage_Begin_Date  date  [1..1]  Coverage start date. Workday overwrites if the date doesn't meet the Coverage Begin Date rules.   
Original_Coverage_Begin_Date  date  [0..1]  Start date for when the worker first elected the benefit coverage plan. Example: Loading a worker into Workday from a third-party application. Only use this field the first time you load the original benefit package of this coverage type for a worker.   
Deduction_Begin_Date  date  [0..1]  Deduction start date. Workday overwrites if the date doesn't meet the Deduction Begin Date rules.   
Original_Deduction_Begin_Date  date  [0..1]  Start date for when the deduction first occurred for this benefit coverage plan. Example: Loading a worker into Workday from a third-party application. Only use this field the first time you load the original benefit package of this coverage type for a worker.   
Retirement_Savings_Plan_Reference  Retirement_Savings_PlanObject  [1..1]  Unique identifier for the retirement savings plan. Ensure that you include all benefit plans listed for the event type listed on the EIB.   
Employee_Contribution_Allocation_Percent  decimal (5, 2) >0   [0..1]  The percentage amount of the employee's total contribution that the employee allocates for each retirement plan.   
Employer_Contribution_Allocation_Percent  decimal (12, 0) >0   [0..1]  The percentage amount of the employee's total contribution that the employer allocates for each retirement plan .   
Beneficiary_Allocation_Data  Beneficiary_Allocation_for_Change_Benefits_Data  [0..*]  Beneficiary data.   
Validation Description
Beneficiary Allocation must sum to 100 or 0   
Beneficiary Allocation must sum to 100 or 0   
[worker] is not eligible for [plan]   
Coverage Begin Date must be on or after the Benefit Event Date   
[plan] requires a beneficiary designation   
The following Beneficiaries are not related to [worker]: [beneficiaries]   
Employee Contribution Allocation Percent has entry but no Employee Contribution Allocation was set up for the Coverage Type.   
Employer Contribution Allocation Percent has entry but no Employer Contribution Allocation was set up for the Coverage Type.   
Election values out of range   
Employee Contribution Allocation has entry but there is no Employee Contribution Percent or Employee Contribution Amount.   
[plan] plan is not available under coverage type [coverage type].   
Decimals are not allowed in Employee Contribution Allocation Percent.   
Loaded Original Coverage Begin Date must be equal to or before the Benefit Event Date.   
Retirement Savings Coverage Type "[plan cov type]" is not part of the Event Type "[event type]".   
top
 

Unique_IdentifierObject

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

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Event_Attachment_CategoryReferenceEnumeration

part of: Event_Attachment_CategoryObjectID
Base Type
string
top
 

Retirement_Savings_PlanReferenceEnumeration

part of: Retirement_Savings_PlanObjectID
Base Type
string
top
 

BeneficiaryReferenceEnumeration

part of: BeneficiaryObjectID
Base Type
string
top
 

Benefit_Coverage_TypeReferenceEnumeration

part of: Benefit_Coverage_TypeObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top