Service Directory > v23.0 > Benefits_Administration > Change_Benefits
 

Operation: Change_Benefits

This service operation initiates the "Change Benefits for Life Event" business process allowing changes to benefit elections for an employee. This service does not support incremental updates or defaults.


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

Change benefits request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  If this is true, then multiple change benefit events on the same day, with the same employee, of the same type will not be allowed. Otherwise they will be processed as a correction.   
Business_Process_Parameters  Business_Process_Parameters  [0..1]  Business process parameters   
Change_Benefits_Data  Change_Benefits_Data  [0..1]  Change benefit elections request. 
Validation Description
Benefit Plans selected of same Benefit Coverage Type where Only One Election is true   
Enrollment submissions can only contain one Benefit Event Type   
Enrollment doesn't cover following coverage types, where Must Elect Coverage is true: [coverage types]   
There is an enrollment event currently in progress with overlapping coverage types   
Overlapping coverage types with different benefit event types, so cannot create or correct new Employee Enrollment Event   
Coverage Targets are not the same for Health Care Coverage Plans that are Cross Plans. Cross Plan Enrollment Prerequisites require that defined Health Care Coverage Plans have the same Coverage Target.   
 
top
 

Response Element: Change_Benefits_Response

Response for a Change Benefits for Life Event web service request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Change_Benefits_Reference  Unique_IdentifierObject  [0..1]  Instance of the Employee Enrollment Event   
top
 

Business_Process_Parameters

part of: Change_Benefits_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.
 
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.   
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, 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  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
 

Change_Benefits_Data

part of: Change_Benefits_Request
Data for life change events
 
Parameter name Type/Value Cardinality Description Validations
Employee_Reference  WorkerObject  [1..1]  The worker this event applies to   
Benefit_Event_Type_Reference  Benefit_Event_TypeObject  [1..*]  Benefit event types for the enrollment event. When submitted, this must be singular, but upon retrieval it is possible to be non-singular   
Event_Date  date  [1..1]  The date this event occurs   
Benefit_Deduction_Periods_Remaining  decimal (3, 0) >0   [0..1]  Remaining deduction periods.   
Remaining_Period_Frequency_Reference  FrequencyObject  [0..1]  Frequency of Benefit Deduction.   
Excess_Credits_to_HSA  decimal (26, 6) >0   [0..1]  Excess credits to HSA from the benefit package   
Has_Existing_Medical_Coverage  boolean  [0..1]  Set to true if the Vermont Employee waived medical but has existing medical coverage elsewhere.   
Benefit_Election_Data  Benefit_Election_Change_Benefits_Data  [0..*]  Election data for benefit elections in this event 
Validation Description
[worker] is not eligible for [plan]   
[plan] is not available under [bet]   
[plan] does not allow individual rates   
Coverage Begin Date must be on or after the Benefit Event Date   
The following Beneficiaries are not related to [worker]: [beneficiaries]   
Loaded Original Coverage Begin Date must be equal to or before the Benefit Event Date.   
 
Retirement_Savings_Coverage_Type_Data  Benefit_Coverage_Type_for_Retirement_Savings_Elections_Data  [0..*]  Retirement Savings Coverage level values for Retirement Savings Elections. 
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   
 
Biographic_Data  Biographic_Data  [0..*]  Encapsulating element for all Biographical data (e.g. DOB, Gender, etc.) associated with a person.   
Validation Description
Benefit Plans selected of same Benefit Coverage Type where Only One Election is true   
Enrollment submissions can only contain one Benefit Event Type   
Enrollment doesn't cover following coverage types, where Must Elect Coverage is true: [coverage types]   
There is an enrollment event currently in progress with overlapping coverage types   
Overlapping coverage types with different benefit event types, so cannot create or correct new Employee Enrollment Event   
Coverage Targets are not the same for Health Care Coverage Plans that are Cross Plans. Cross Plan Enrollment Prerequisites require that defined Health Care Coverage Plans have the same Coverage Target.   
top
 

Benefit_Event_TypeObject

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

Benefit_Event_TypeObjectID

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

FrequencyObject

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

FrequencyObjectID

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

part of: Change_Benefits_Data
Generic benefit election data for this election
 
Parameter name Type/Value Cardinality Description Validations
Coverage_Begin_Date  date  [0..1]  The date that coverage begins for the election. Note that the Coverage Begin Date entered is ignored. The system calculates Coverage Begin Date based on the setup in Enrollment Event Rules. 
Validation Description
Coverage begin date [begin] cannot be greater than plan year end date [end]   
 
Original_Coverage_Begin_Date  date  [0..1]  The original coverage begin date for this election (derived from election history or the loaded original coverage begin date) 
Validation Description
Loaded original coverage begin date [begin] cannot be greater than plan year end date [end]   
 
Deduction_Begin_Date  date  [0..1]  The date that deduction begins for the election. Note that the Dedution Begin Date entered is ignored. The system calculates Deduction Begin Date based on the setup in Enrollment Event Rules. 
Validation Description
The Deduction Begin Date is ignored.   
 
Original_Deduction_Begin_Date  date  [0..1]  Original Deduction Begin Date   
Health_Care_Election_Data [Choice]   Health_Care_Election_Change_Benefits_Data  [1..1]  Health Care Election data for this election 
Validation Description
Dependents with the relationship type(s) of [relationships] must be selected.   
Dependents not valid for health care target   
Provider ID is not required and has a value   
Too many dependents selected for coverage level   
Too few dependents selected for coverage level   
Provider ID required and is not entered   
A unique dependent is entered more than once in Dependent Election Data   
The following dependents are not related to [worker] and can't be included in an enrollment: [dependents]   
The following dependents are not eligible for [plan] and can't be included in an enrollment: [dependents].  Validates the Dependents selected for benefit elections against the Dependent Eligibility Rules for the Benefit Plan Selected. 
 
Health_Savings_Account_Election_Data [Choice]   Health_Savings_Account_Election_Data  [1..1]  Health Savings Account Election data for this election 
Validation Description
Beneficiary Allocation must sum to 100 or 0   
Beneficiary Allocation must sum to 100 or 0   
Beneficiary allocation is required for this plan   
If Health Care Savings Account Elections or Spending Account Elections are selected, then Benefit Deduction Periods Remaining must be specified.   
If Health Care Savings Account Elections or Spending Account Elections are selected then Remaining Period Frequency must be specified.   
You must elect a corresponding health care plan in order to enroll in this HSA plan.   
 
Spending_Account_Election_Data [Choice]   Spending_Account_Election_Data  [1..1]  Spending Account Election data for this election 
Validation Description
Beneficiary Allocation must sum to 100 or 0   
Beneficiary Allocation must sum to 100 or 0   
Beneficiary allocation is required for this plan   
If Health Care Savings Account Elections or Spending Account Elections are selected then Remaining Period Frequency must be specified.   
If Health Care Savings Account Elections or Spending Account Elections are selected, then Benefit Deduction Periods Remaining must be specified.   
Employee contribution less than minimum amount   
 
Insurance_Election_Data [Choice]   Insurance_Election_Data_Change_Benefits  [1..1]  Insurance Election data for this election 
Validation Description
Beneficiary allocation must total 100%   
Contingent beneficiary allocation must total 0% or 100%   
Beneficiary allocation is required for this plan   
Dependents are not valid for this plan   
Dependents are required for this plan   
Plan has a greater number of dependents covered than is allowed   
The following dependents are not related to [worker] and can't be included in an enrollment: [dependents]   
Coverage amount must be one of the coverage amounts offered by the benefit plan.   
The following dependents are not eligible for [plan] and can't be included in an enrollment: [dependents].  Validates the Dependents selected for benefit elections against the Dependent Eligibility Rules for the Benefit Plan Selected. 
 
Retirement_Savings_Election_Data [Choice]   Retirement_Savings_Election_Data  [1..1]  Retirement Savings Election data for this election 
Validation Description
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   
[plan] elections should be grouped by coverage type.   
 
Additional_Benefits_Election_Data [Choice]   Additional_Benefits_Election_Data  [1..1]  Additional Benefits Election data   
Validation Description
[worker] is not eligible for [plan]   
[plan] is not available under [bet]   
[plan] does not allow individual rates   
Coverage Begin Date must be on or after the Benefit Event Date   
The following Beneficiaries are not related to [worker]: [beneficiaries]   
Loaded Original Coverage Begin Date must be equal to or before the Benefit Event Date.   
top
 

Health_Care_Election_Change_Benefits_Data

part of: Benefit_Election_Change_Benefits_Data
Health Care Election data for the Change Benefits web services
 
Parameter name Type/Value Cardinality Description Validations
Health_Care_Coverage_Plan_Reference  Health_Care_Coverage_PlanObject  [1..1]  Health Care Coverage Plan for this election   
Health_Care_Coverage_Target_Reference  Health_Care_Coverage_TargetObject  [1..1]  Health Care Coverage Target for this election   
Provider_ID  string  [0..1]  Provider ID for this election   
Dependent_Election_Data  Dependent_Election_Data  [0..*]  Dependent Election Data for all Dependent Elections for this Election 
Validation Description
Provider ID should not be populated when the Benefit Plan elected does not require a Provider ID.   
Provider ID is required when a Benefit Plan is elected and the plan requires a Provider ID.   
 
Benefit_Individual_Rate_Data  Benefit_Individual_Rate_Data_for_Change_Benefits_for_Life_Event  [0..1]  Data for Benefit Individual Rate   
Validation Description
Dependents with the relationship type(s) of [relationships] must be selected.   
Dependents not valid for health care target   
Provider ID is not required and has a value   
Too many dependents selected for coverage level   
Too few dependents selected for coverage level   
Provider ID required and is not entered   
A unique dependent is entered more than once in Dependent Election Data   
The following dependents are not related to [worker] and can't be included in an enrollment: [dependents]   
The following dependents are not eligible for [plan] and can't be included in an enrollment: [dependents].  Validates the Dependents selected for benefit elections against the Dependent Eligibility Rules for the Benefit Plan Selected. 
top
 

Health_Care_Coverage_PlanObject

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

Health_Care_Coverage_PlanObjectID

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

Health_Care_Coverage_TargetObject

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

Health_Care_Coverage_TargetObjectID

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

Dependent_Election_Data

part of: Health_Care_Election_Change_Benefits_Data
Contains the Data for the Dependent Election
 
Parameter name Type/Value Cardinality Description Validations
Dependent_Reference  DependentObject  [1..1]  Dependent for Dependent Election   
Provider_ID  string  [0..1]  Provider ID for Dependent on this election   
Original_Coverage_Begin_Date  date  [0..1]  Original Coverage begin date. If this is entered on an enrollment, it must be on the original package during implementation.   
Validation Description
Provider ID should not be populated when the Benefit Plan elected does not require a Provider ID.   
Provider ID is required when a Benefit Plan is elected and the plan requires a Provider ID.   
top
 

DependentObject

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

DependentObjectID

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

part of: Health_Care_Election_Change_Benefits_Data, Insurance_Election_Data_Change_Benefits, Additional_Benefits_Election_Data
Data for Benefit Individual Rate
 
Parameter name Type/Value Cardinality Description Validations
Benefit_Individual_Rate_ID  string  [0..1]  ID for this Benefit Individual Rate   
Employee_Cost_PreTax  decimal (21, 6)   [0..1]  Employee cost, pre tax, for this Benefit Individual Rate   
Employee_Cost_PostTax  decimal (21, 6)   [0..1]  Employee cost, post tax, for this Benefit Individual Rate   
Employer_Cost_NonTaxable  decimal (21, 6) >0   [0..1]  Employer cost, non taxable, for this Benefit Individual Rate   
Employer_Cost_Taxable  decimal (21, 6) >0   [0..1]  Employer cost, taxable, for this Benefit Individual Rate   
top
 

Health_Savings_Account_Election_Data

part of: Benefit_Election_Change_Benefits_Data
Election data for a health savings account
 
Parameter name Type/Value Cardinality Description Validations
Health_Savings_Account_Plan_Reference  Health_Savings_Account_PlanObject  [1..1]  The plan for the benefit election   
YTD_Contribution_Amount  decimal (21, 6) >0   [0..1]  The year to date contribution amount for this election   
Annual_Contribution  decimal (21, 6) >0   [0..1]  Total contribution for the year. This is not the employee cost annualized, but the amount the employee is expecting to contribute for the year. 
Validation Description
Your HSA Contribution is below the minimum for the plan.   
 
Employee_Cost  decimal (21, 6) >0   [0..1]  The employee cost for the election, at the employee's benefit group's frequency   
Beneficiary_Allocation_Data  Beneficiary_Allocation_for_Change_Benefits_Data  [0..*]  Data for this election's beneficiary allocations   
Validation Description
Beneficiary Allocation must sum to 100 or 0   
Beneficiary Allocation must sum to 100 or 0   
Beneficiary allocation is required for this plan   
If Health Care Savings Account Elections or Spending Account Elections are selected, then Benefit Deduction Periods Remaining must be specified.   
If Health Care Savings Account Elections or Spending Account Elections are selected then Remaining Period Frequency must be specified.   
You must elect a corresponding health care plan in order to enroll in this HSA plan.   
top
 

Health_Savings_Account_PlanObject

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

Health_Savings_Account_PlanObjectID

part of: Health_Savings_Account_PlanObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Health_Savings_Account_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: Health_Savings_Account_Election_Data, Spending_Account_Election_Data, Insurance_Election_Data_Change_Benefits, Retirement_Savings_Election_Data, Retirement_Savings_Election_for_Coverage_Type_Data
Beneficiary Allocation data
 
Parameter name Type/Value Cardinality Description Validations
Beneficiary_Reference  BeneficiaryObject  [1..1]  Beneficiary for the Beneficiary Allocation   
Primary_Percentage [Choice]   decimal (5, 2) >0   [1..1]  The primary allocation percentage (if a primary type)   
Contingent_Percentage [Choice]   decimal (5, 2) >0   [1..1]  The contingent allocation percentage (if a 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
 

Spending_Account_Election_Data

part of: Benefit_Election_Change_Benefits_Data
Election data for spending account elections
 
Parameter name Type/Value Cardinality Description Validations
Spending_Account_Plan_Reference  Spending_Account_PlanObject  [1..1]  Plan for the spending account election   
YTD_Contribution_Amount  decimal (21, 6) >0   [0..1]  Year to date amount for the spending account election   
Annual_Contribution  decimal (21, 6) >0   [0..1]  Total contribution for the year. This is not the employee cost annualized, but the amount the employee is expecting to contribute for the year. 
Validation Description
Employee contribution exceeds cap amount   
 
Employee_Cost  decimal (21, 6) >0   [0..1]  Employee cost for the spending account election   
Beneficiary_Allocation_Data  Beneficiary_Allocation_for_Change_Benefits_Data  [0..*]  Beneficiary Allocation data   
Validation Description
Beneficiary Allocation must sum to 100 or 0   
Beneficiary Allocation must sum to 100 or 0   
Beneficiary allocation is required for this plan   
If Health Care Savings Account Elections or Spending Account Elections are selected then Remaining Period Frequency must be specified.   
If Health Care Savings Account Elections or Spending Account Elections are selected, then Benefit Deduction Periods Remaining must be specified.   
Employee contribution less than minimum amount   
top
 

Spending_Account_PlanObject

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

Spending_Account_PlanObjectID

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

Insurance_Election_Data_Change_Benefits

part of: Benefit_Election_Change_Benefits_Data
Insurance election data
 
Parameter name Type/Value Cardinality Description Validations
Insurance_Coverage_Plan_Reference  Insurance_Coverage_PlanObject  [1..1]  Insurance coverage plan for this election   
Dependent_Reference  DependentObject  [0..*]  Dependents that are covered by this plan   
Coverage_Amount_Reference  Insurance_Coverage_Master_AmountObject  [1..1]  Coverage amount for this plan   
Beneficiary_Allocation_Data  Beneficiary_Allocation_for_Change_Benefits_Data  [0..*]  Beneficiary Allocation data   
Benefit_Individual_Rate_Data  Benefit_Individual_Rate_Data_for_Change_Benefits_for_Life_Event  [0..1]  Data for Benefit Individual Rate   
Validation Description
Beneficiary allocation must total 100%   
Contingent beneficiary allocation must total 0% or 100%   
Beneficiary allocation is required for this plan   
Dependents are not valid for this plan   
Dependents are required for this plan   
Plan has a greater number of dependents covered than is allowed   
The following dependents are not related to [worker] and can't be included in an enrollment: [dependents]   
Coverage amount must be one of the coverage amounts offered by the benefit plan.   
The following dependents are not eligible for [plan] and can't be included in an enrollment: [dependents].  Validates the Dependents selected for benefit elections against the Dependent Eligibility Rules for the Benefit Plan Selected. 
top
 

Insurance_Coverage_PlanObject

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

Insurance_Coverage_PlanObjectID

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

Insurance_Coverage_Master_AmountObject

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

Insurance_Coverage_Master_AmountObjectID

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

part of: Benefit_Election_Change_Benefits_Data
Retirement Savings Election data
 
Parameter name Type/Value Cardinality Description Validations
Retirement_Savings_Plan_Reference  Retirement_Savings_PlanObject  [1..1]  Retirement Savings Plan for election   
Election_Percentage [Choice]   decimal (5, 2) >0   [0..1]  Percent of salary allocated to election   
Election_Amount [Choice]   decimal (26, 6)   [0..1]  Flat amount allocated to election   
Beneficiary_Allocation_Data  Beneficiary_Allocation_for_Change_Benefits_Data  [0..*]  Beneficiary Allocation data   
Validation Description
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   
[plan] elections should be grouped by coverage type.   
top
 

Retirement_Savings_PlanObject

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

Additional_Benefits_Election_Data

part of: Benefit_Election_Change_Benefits_Data
Additional Benefits Election data
 
Parameter name Type/Value Cardinality Description Validations
Additional_Benefits_Plan_Reference  Additional_Benefits_PlanObject  [1..1]  Additional Benefits plan for election   
Additional_Benefits_Coverage_Target_Reference  Additional_Benefits_Coverage_TargetObject  [0..1]  Additional Benefits Coverage Target for this election 
Validation Description
The additional benefits coverage target is not valid for the additional benefits plan.   
This plan's additional benefits coverage type does not use additional benefits coverage targets.   
An additional benefits coverage target reference is required for this plan.   
 
Additional_Benefits_Percentage_Contribution_Value [Choice]   decimal (5, 2) >0   [0..1]  The contribution percentage for this election. 
Validation Description
Contribution for "[plan]" must be [msg_bw][msg_gte][msg_amnt].   
Percent contribution must be less than or equal to 100.   
 
Additional_Benefits_Flat_Contribution_Amount [Choice]   decimal (18, 6) >0   [0..1]  The contribution amount for this election. 
Validation Description
Contribution for "[plan]" must be [msg_bw][msg_gte][msg_amnt].   
 
Benefit_Individual_Rate_Data  Benefit_Individual_Rate_Data_for_Change_Benefits_for_Life_Event  [0..1]  Data for Benefit Individual Rate   
top
 

Additional_Benefits_PlanObject

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

Additional_Benefits_PlanObjectID

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

Additional_Benefits_Coverage_TargetObject

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

Additional_Benefits_Coverage_TargetObjectID

part of: Additional_Benefits_Coverage_TargetObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Additional_Benefits_Coverage_Target_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: Change_Benefits_Data
Benefit coverage type level values
 
Parameter name Type/Value Cardinality Description Validations
Benefit_Coverage_Type_Reference  Benefit_Coverage_TypeObject  [1..1]  Benefit Coverage Type identifier.   
Employee_Contribution_Percentage [Choice]   decimal (5, 2) >0   [0..1]  Employee contribution in percentage   
Employee_Contribution_Amount [Choice]   decimal (21, 6) >0   [0..1]  Employee Contribution in amount   
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]  The date that coverage begins for the election. Note that the Coverage Begin Date entered is ignored. The system calculates Coverage Begin Date based on the setup in Enrollment Event Rules.   
Original_Coverage_Begin_Date  date  [0..1]  Original Coverage Begin Date   
Deduction_Begin_Date  date  [0..1]  The date that deduction begins for the election. Note that the Dedution Begin Date entered is ignored. The system calculates Deduction Begin Date based on the setup in Enrollment Event Rules.   
Original_Deduction_Begin_Date  date  [0..1]  Original Deduction Begin Date   
Retirement_Savings_Plan_Reference  Retirement_Savings_PlanObject  [1..1]  Retirement Savings Plan identifier   
Employee_Contribution_Allocation_Percent  decimal (5, 2) >0   [0..1]  Employee contribution allocation as percentage of 100.   
Employer_Contribution_Allocation_Percent  decimal (12, 0) >0   [0..1]  Employer contribution allocation as percentage of 100.   
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
 

Biographic_Data

part of: Change_Benefits_Data
Encapsulating element for all Biographical data (e.g. DOB, Gender, etc.) associated with a person.
 
Parameter name Type/Value Cardinality Description Validations
Country_Of_Birth_Reference  Country_Of_Birth_Reference  [0..1]  Reference element representing a unique instance of Country of Birth.   
Place_Of_Birth  string  [0..1]  Text attribute identifying Place of Birth.   
Date_Of_Birth  date  [0..1]  Date of Birth.   
Gender_Reference  Gender_Reference  [0..1]  Reference element representing a unique instance of Gender.   
Disability_Reference  Disability_Reference  [0..*]  Reference element representing a unique instance of Disability. Does not support the update of Disability Status. Use Put Applicant web service to update the Disability Status for a Person. 
Validation Description
The Disability Name does not exist in the person's location. Additionally, it must not be Inactive.  A valid instance of Disability must exist for the given value of Disability Name and the person's location. 
 
Uses_Tobacco  boolean  [0..1]  Boolean attribute identifying Tobacco usage.   
top
 

Country_Of_Birth_Reference

part of: Biographic_Data
Reference element representing a unique instance of Country of Birth.
 
Parameter name Type/Value Cardinality Description Validations
Country_Reference  Country_Reference  [1..1]  Country ISO code. If the Country ISO code is specified, then this ISO code will be used to determine the Country Phone Code f or the phone. Pass this ISO code to distinguish between multiple countries sharing the same Country Phone Code. (For example, Country Phone Code '1' is shared by USA, Canada, Dominican Republic, Bermuda, Jamaica and Puerto Rico)   
top
 

Country_Reference

part of: Country_Of_Birth_Reference
Country ISO code. If the Country ISO code is specified, then this ISO code will be used to determine the Country Phone Code f or the phone. Pass this ISO code to distinguish between multiple countries sharing the same Country Phone Code. (For example, Country Phone Code '1' is shared by USA, Canada, Dominican Republic, Bermuda, Jamaica and Puerto Rico)
 
Parameter name Type/Value Cardinality Description Validations
Country_ISO_Code  string  [1..1]  ISO Code identifying the country where the naming rules for this name are defined. Workday provides the ability for a customer to specify an ISO Code at the country level. Each customer can also define various rules around names, required fields for names, labels for name fields at the Country level. http://en.wikipedia.org/wiki/ISO_3166-1_alpha-3 
Validation Description
No Country with that Country Code Exists.  A valid instance of Country must exist for the value of Country ISO Code. 
 
top
 

Gender_Reference

part of: Biographic_Data
Reference element representing a unique instance of Gender.
 
Parameter name Type/Value Cardinality Description Validations
Gender_Description  string  [1..1]  Unique attribute name/description identifying a valid instance of Gender. 
Validation Description
Gender Description does not exist!  A valid instance of Gender must exist for the given value of Gender Description. 
 
top
 

Disability_Reference

part of: Biographic_Data
Reference element representing a unique instance of Disability. Does not support the update of Disability Status. Use Put Applicant web service to update the Disability Status for a Person.
 
Parameter name Type/Value Cardinality Description Validations
Disability_Name  string  [1..1]  Disability for a Person. Creates a new Disability Status without a Disability Status Date. To update the Disability Status Date for a Person, use the Put Applicant web service.   
Regulatory_Region_Organization_Reference  Organization_Reference  [0..*]  Reference element representing a unique instance of Organization. 
Validation Description
Organization Reference Integration ID does not exist!  A valid instance of Organization must exist for the given Integration ID Reference. 
Organization Reference references an Inactive Organization.  A valid instance of Organization also infers that the Organization is in an Active status. 
 
Validation Description
The Disability Name does not exist in the person's location. Additionally, it must not be Inactive.  A valid instance of Disability must exist for the given value of Disability Name and the person's location. 
top
 

Organization_Reference

part of: Disability_Reference
Reference element representing a unique instance of Organization.
 
Parameter name Type/Value Cardinality Description Validations
Integration_ID_Reference  External_Integration_ID_Reference_Data  [1..1]  Integration ID reference is used as a unique identifier for integratable objects in the Workday system.   
Validation Description
Organization Reference Integration ID does not exist!  A valid instance of Organization must exist for the given Integration ID Reference. 
Organization Reference references an Inactive Organization.  A valid instance of Organization also infers that the Organization is in an Active status. 
top
 

External_Integration_ID_Reference_Data

part of: Organization_Reference
Integration ID reference is used as a unique identifier for integratable objects in the Workday system.
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display name inside the Workday system.   
ID  ID  [1..1]  External ID that uniquely identifies the integratable object within the context of the integration system identified by the System ID attribute.   
top
 

ID

part of: External_Integration_ID_Reference_Data
External ID that uniquely identifies the integratable object within the context of the integration system identified by the System ID attribute.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@System_ID  string  [1..1]  Integration system identifier, part of a two part key (including the text value of the ID element) that uniquely identify integratable object. 
Validation Description
Integration System ID does not exist.  A valid instance of Integration ID must exist for the given System ID. 
 
top
 

Unique_IdentifierObject

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

Benefit_Event_TypeReferenceEnumeration

part of: Benefit_Event_TypeObjectID
Base Type
string
top
 

FrequencyReferenceEnumeration

part of: FrequencyObjectID
Base Type
string
top
 

Health_Care_Coverage_PlanReferenceEnumeration

part of: Health_Care_Coverage_PlanObjectID
Base Type
string
top
 

Health_Care_Coverage_TargetReferenceEnumeration

part of: Health_Care_Coverage_TargetObjectID
Base Type
string
top
 

DependentReferenceEnumeration

part of: DependentObjectID
Base Type
string
top
 

Health_Savings_Account_PlanReferenceEnumeration

part of: Health_Savings_Account_PlanObjectID
Base Type
string
top
 

BeneficiaryReferenceEnumeration

part of: BeneficiaryObjectID
Base Type
string
top
 

Spending_Account_PlanReferenceEnumeration

part of: Spending_Account_PlanObjectID
Base Type
string
top
 

Insurance_Coverage_PlanReferenceEnumeration

part of: Insurance_Coverage_PlanObjectID
Base Type
string
top
 

Insurance_Coverage_Master_AmountReferenceEnumeration

part of: Insurance_Coverage_Master_AmountObjectID
Base Type
string
top
 

Retirement_Savings_PlanReferenceEnumeration

part of: Retirement_Savings_PlanObjectID
Base Type
string
top
 

Additional_Benefits_PlanReferenceEnumeration

part of: Additional_Benefits_PlanObjectID
Base Type
string
top
 

Additional_Benefits_Coverage_TargetReferenceEnumeration

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