Service Directory > v31.2 > Benefits_Administration > Put_Health_Care_Rate
 

Operation: Put_Health_Care_Rate

This Web Service puts Health Care Rates.


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

Put Health Care Rate Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Health_Care_Rate_Reference  Health_Care_Banded_RateObject  [0..1]  Health Care Banded Rate   
Health_Care_Rate_Data  Health_Care_Rate_Data  [1..1]  Health Care Rate Data for Put Health Care Rate Request   
top
 

Response Element: Put_Health_Care_Rate_Response

Health Care Rate Response EL
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Health_Care_Rate_Reference  Health_Care_Banded_RateObject  [0..1]  Health Care Banded Rate for Health Care Rate Response   
top
 

Health_Care_Banded_RateObject

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

Health_Care_Banded_RateObjectID

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

part of: Put_Health_Care_Rate_Request
Contains Health Care Rate Data
 
Parameter name Type/Value Cardinality Description Validations
@Effective_Date  date  [1..1]  Effective Date of Health Care Rate   
Health_Care_Rate_ID  string  [0..1]  Reference ID For Health Care Rate Data   
Name  string  [1..1]  Benefit Name of the Health Care Rate 
Validation Description
Benefit Rate Name already in use: [name]   
 
Description  string  [0..1]  Description of the Benefit Rate   
Use_Minimum_Cost  boolean  [0..1]  Minimum Cost of Health Care Rate   
Use_Maximum_Cost  boolean  [0..1]  Maximum Cost of Health Care Rate   
Frequency_Reference  FrequencyObject  [1..1]  Frequency of Health Care Rate   
Currency_Reference  CurrencyObject  [1..1]  Currency for Health Care Rate   
Health_Care_Coverage_Target_Reference  Health_Care_Coverage_TargetObject  [0..*]  Health Care Coverage Target for Health Care Rate   
Age_in_Years_Data [Choice]   Age_in_Years_Data  [0..1]  Age in Years for Health Care Banded Data   
Length_of_Service_Data [Choice]   Length_of_Service_Data  [0..1]  Service Length of Health Care Rate   
Salary_Data [Choice]   Salary_Data  [0..1]  Salary for Health Care Rate   
Health_Care_Rate_Flat_Data [Choice]   Health_Care_Rate_Flat_Data  [0..*]  Flat Health Care Rate   
Health_Care_Rate_Percent_Salary_Data [Choice]   Health_Care_Rate_Percent_Salary_Data  [0..*]  Health Care Rate Percent Salary Data for Health Care Rate Data   
Consider_Tobacco  boolean  [0..1]  Consider Tobacco for Health Care Rate Data   
top
 

FrequencyObject

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

CurrencyObject

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

CurrencyObjectID

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

Age_in_Years_Data

part of: Health_Care_Rate_Data
Age in Years
 
Parameter name Type/Value Cardinality Description Validations
As_Of_Date_Data  As_Of_Date_Data  [1..1]  Age in Years   
top
 

As_Of_Date_Data

part of: Age_in_Years_Data, Length_of_Service_Data, Salary_Data
As of Date
 
Parameter name Type/Value Cardinality Description Validations
Specific_Month  decimal (2, 0) >0   [0..1]  Specific Month As of Date   
Specific_Day  decimal (2, 0) >0   [0..1]  Specific Day As of Date   
Of_Prior_Plan_Year  boolean  [0..1]  Prior Plan Year As of Date   
Benefit_As_Of_Rule_Reference  Benefit_As_Of_RuleObject  [1..1]  As of Date based on Benefit As Of Rule   
top
 

Benefit_As_Of_RuleObject

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

Benefit_As_Of_RuleObjectID

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

Length_of_Service_Data

part of: Health_Care_Rate_Data
Service Length of Health Care Rate
 
Parameter name Type/Value Cardinality Description Validations
As_Of_Date_Data  As_Of_Date_Data  [1..1]  As of Date   
top
 

Salary_Data

part of: Health_Care_Rate_Data, Health_Care_Rate_Salary_Source_Data
Salary for Health Care Rate
 
Parameter name Type/Value Cardinality Description Validations
Combine_All_Jobs_for_Salary_Source  boolean  [0..1]  Combine all jobs for Salary Source   
Benefit_Salary_Source_Reference  Benefit_Salary_SourceObject  [1..1]  Salary Source from Benefit Salary Source   
Compensation_Element_Reference  Compensation_Pay_EarningObject  [0..*]  Salary Calculated by Compensation Pay Earning   
Frequency_Reference  FrequencyObject  [1..1]  Benefit Salary Frequency   
Benefit_Annual_Rate_Type_Reference  Benefit_Annual_Rate_TypeObject  [0..1]  Differentiates using Benefit Annual Rate Type   
As_Of_Date_Data  As_Of_Date_Data  [1..1]  As of Date   
top
 

Benefit_Salary_SourceObject

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

Benefit_Salary_SourceObjectID

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

Compensation_Pay_EarningObject

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

Compensation_Pay_EarningObjectID

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

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

Benefit_Annual_Rate_TypeObjectID

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

Health_Care_Rate_Flat_Data

part of: Health_Care_Rate_Data
Flat Health Care Rate
 
Parameter name Type/Value Cardinality Description Validations
Benefit_Rate_ID  string  [0..1]  Reference ID for Health Care Rate Flat Data   
Minimum  decimal (12, 0) >0   [0..1]  Minimum Benefit Rate Band   
Maximum  decimal (12, 0) >0   [0..1]  Maximum Benefit Rate Band   
Salary_Minimum  decimal (21, 6) >0   [0..1]  Minimum Salary for Benefit Rate Band   
Salary_Maximum  decimal (21, 6) >0   [0..1]  Maximum Salary for Benefit Rate Band   
Health_Care_Coverage_Target_Reference  Health_Care_Coverage_TargetObject  [1..1]  Criteria may be Health Care Coverage Target   
Rate_Value_Flat_Data  Benefit_Rate_Value_Flat_Data  [0..*]  Benefit Rate Flat Value Data   
Tobacco_Use_Reference  Benefit_Rate_Band_Tobacco_UseObject  [0..1]  Criteria May Be Benefit Rate Band Tobacco Use   
top
 

Benefit_Rate_Value_Flat_Data

part of: Health_Care_Rate_Flat_Data
Benefit Rate Flat Value Data
 
Parameter name Type/Value Cardinality Description Validations
Employee_Cost_Amount  decimal (21, 6)   [0..1]  Amount of Employee Cost   
Employee_Cost_Amount_Min  decimal (21, 6) >0   [0..1]  Minimum Employee Cost Amount   
Employee_Cost_Amount_Max  decimal (21, 6) >0   [0..1]  Maximum Employee Cost Amount   
Employee_Cost_Amount_PostTax  decimal (21, 6)   [0..1]  Post Tax Employee Cost Amount   
Employee_Cost_Amount_Min_PostTax  decimal (21, 6) >0   [0..1]  Post Tax Minimum Employee Cost Amount   
Employee_Cost_Amount_Max_PostTax  decimal (21, 6) >0   [0..1]  Post Tax Maximum Employee Cost Amount   
Employer_Contribution_Amount  decimal (21, 6) >0   [0..1]  Amount of Employer Contribution   
Employer_Contribution_Amount_Taxable  decimal (21, 6) >0   [0..1]  Amount of Taxable Employee Contribution   
Flex_Credit_Amount  decimal (21, 6) >0   [0..1]  Amount of Flex Credit   
Fair_Market_Value_per_Dependent  decimal (21, 6) >0   [0..1]  Value of Dependent Fair Market   
Benefit_Credit_Reference  Benefits_Calculable_CreditObject  [0..*]  Credit Calculated from Benefits Calculable Credit   
Benefit_Surcharge_Reference  Benefits_Calculable_CreditObject  [0..*]  Surcharges Calculated from Benefits Calculable Credit   
top
 

Benefits_Calculable_CreditObject

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

Benefits_Calculable_CreditObjectID

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

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

Benefit_Rate_Band_Tobacco_UseObjectID

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

part of: Health_Care_Rate_Data
Contains Health Care Rate Percent Salary Data
 
Parameter name Type/Value Cardinality Description Validations
Benefit_Rate_Salary_Source_Data  Health_Care_Rate_Salary_Source_Data  [1..*]  Health Care Rate Salary Source Data for Health Care Rate Percent Salary Data   
Benefit_Rounding_Rule_Final_Data  Benefit_Rounding_Rule_Final_Data  [0..*]  Benefit Rounding Rule Final Data for Health Care Rate Percent Salary Data   
Health_Care_Rate_Percent_of_Salary_Data  Health_Care_Rate_Percent_of_Salary_Data  [1..*]  Health Care Rate Percent of Salary Data for Health Care Rate Percent Salary Data   
top
 

Health_Care_Rate_Salary_Source_Data

part of: Health_Care_Rate_Percent_Salary_Data
Contains Health Care Rate Salary Source Data
 
Parameter name Type/Value Cardinality Description Validations
Salary_Data  Salary_Data  [0..*]  Health Care Salary Source   
top
 

Benefit_Rounding_Rule_Final_Data

part of: Health_Care_Rate_Percent_Salary_Data
Contains Benefit Rounding Rule Final Data
 
Parameter name Type/Value Cardinality Description Validations
Round_Amount_To  decimal (21, 6) >0   [0..1]  Round Amount To for Benefit Rounding Rule Final Data   
Rounding_Direction_Reference  Benefit_Round_DirectionObject  [0..1]  Benefit Rounding Rule Direction for Benefit Rounding Rule Final Data   
Round_on_Number  decimal (21, 6) >0   [0..1]  Round Amount On for Benefit Rounding Rule Final Data   
top
 

Benefit_Round_DirectionObject

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

Benefit_Round_DirectionObjectID

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

part of: Health_Care_Rate_Percent_Salary_Data
Contains Health Care Rate Percent of Salary Data
 
Parameter name Type/Value Cardinality Description Validations
Benefit_Rate_ID  string  [0..1]  ID for Health Care Rate Percent of Salary Data   
Minimum  decimal (12, 0) >0   [0..1]  Benefit Rate Band Minimum for Health Care Rate Percent of Salary Data   
Maximum  decimal (12, 0) >0   [0..1]  Benefit Rate Band Maximum for Health Care Rate Percent of Salary Data   
Salary_Minimum  decimal (21, 6) >0   [0..1]  Benefit Rate Plan Salary Minimum for Health Care Rate Percent of Salary Data   
Salary_Maximum  decimal (21, 6) >0   [0..1]  Benefit Rate Band Salary Maximum for Health Care Rate Percent of Salary Data   
Health_Care_Coverage_Target_Reference  Health_Care_Coverage_TargetObject  [0..1]  Health Care Coverage Target for Health Care Rate Percent of Salary Data   
Rate_Value_Percent_of_Salary_Data  Benefit_Rate_Value_Percent_of_Salary_Data  [1..*]  Benefit Rate Value Percent of Salary Data for Health Care Rate Percent of Salary Data   
Tobacco_Use_Reference  Benefit_Rate_Band_Tobacco_UseObject  [0..1]  Tobacco Use for Health Care Rate Percent of Salary Data   
top
 

Benefit_Rate_Value_Percent_of_Salary_Data

part of: Health_Care_Rate_Percent_of_Salary_Data
Benefit Rate Value Percent of Salary
 
Parameter name Type/Value Cardinality Description Validations
Employee_Cost_Percentage  decimal (10, 5) >0   [0..1]  Employee Cost Percentage for Benefit Rate Value Percent of Salary Data   
Employee_Cost_Amount_Min  decimal (21, 6) >0   [0..1]  Employee Cost Amount Minimum for Benefit Rate Value Percent of Salary Data   
Employee_Cost_Amount_Max  decimal (21, 6) >0   [0..1]  Employee Cost Amount Maximum for Benefit Rate Value Percent of Salary Data   
Employee_Cost_Percentage_PostTax  decimal (10, 5) >0   [0..1]  Employee Cost Percentage Post Tax for Benefit Rate Value Percent of Salary Data   
Employee_Cost_Amount_Min_PostTax  decimal (21, 6) >0   [0..1]  Employee Cost Amount Min Post Tax for Benefit Rate Value Percent of Salary Data   
Employee_Cost_Amount_Max_PostTax  decimal (21, 6) >0   [0..1]  Employee Cost Amount Max Post Tax for Benefit Rate Value Percent of Salary Data   
Total_Cost_NonTaxable  decimal (21, 6) >0   [0..1]  Total Cost NonTaxable for Benefit Rate Value Percent of Salary Data   
Total_Cost_Taxable  decimal (21, 6) >0   [0..1]  Total Cost Taxable for Benefit Rate Value Percent of Salary Data   
Flex_Credit_Amount  decimal (21, 6) >0   [0..1]  Flex Credit Amount for Benefit Rate Value Percent of Salary Data   
Fair_Market_Value_per_Dependent  decimal (21, 6) >0   [0..1]  Dependent Fair Market Value for Benefit Rate Value Percent of Salary Data   
Flat_Amount_Data  Flat_Amount_Data  [0..*]  Flat Amount Data for Benefit Rate Value Percent of Salary Data   
Benefit_Credit_Reference  Benefits_Calculable_CreditObject  [0..*]  Benefit Credit Reference for Benefit Rate Value Percent of Salary Data   
Benefit_Surcharge_Reference  Benefits_Calculable_CreditObject  [0..*]  Benefit Surcharge Reference for Benefit Rate Value Percent of Salary Data   
top
 

Flat_Amount_Data

part of: Benefit_Rate_Value_Percent_of_Salary_Data
Flat Amount Data
 
Parameter name Type/Value Cardinality Description Validations
Employee_Cost_Amount  decimal (21, 6)   [0..1]  Employee Cost Amount   
Employee_Cost_Amount_PostTax  decimal (21, 6)   [0..1]  Post Tax Employee Cost Amount   
top
 

Health_Care_Banded_RateReferenceEnumeration

part of: Health_Care_Banded_RateObjectID
Base Type
string
top
 

FrequencyReferenceEnumeration

part of: FrequencyObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Health_Care_Coverage_TargetReferenceEnumeration

part of: Health_Care_Coverage_TargetObjectID
Base Type
string
top
 

Benefit_As_Of_RuleReferenceEnumeration

part of: Benefit_As_Of_RuleObjectID
Base Type
string
top
 

Benefit_Salary_SourceReferenceEnumeration

part of: Benefit_Salary_SourceObjectID
Base Type
string
top
 

Compensation_Pay_EarningReferenceEnumeration

part of: Compensation_Pay_EarningObjectID
Base Type
string
top
 

Benefit_Annual_Rate_TypeReferenceEnumeration

part of: Benefit_Annual_Rate_TypeObjectID
Base Type
string
top
 

Benefits_Calculable_CreditReferenceEnumeration

part of: Benefits_Calculable_CreditObjectID
Base Type
string
top
 

Benefit_Rate_Band_Tobacco_UseReferenceEnumeration

part of: Benefit_Rate_Band_Tobacco_UseObjectID
Base Type
string
top
 

Benefit_Round_DirectionReferenceEnumeration

part of: Benefit_Round_DirectionObjectID
Base Type
string
top