Service Directory > v32.1 > Compensation > Put_Enhanced_Severance_Matrix
 

Operation: Put_Enhanced_Severance_Matrix

Create or modify data for an Enhanced Severance Matrix.


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

The element containing the Put Enhanced Severance Matrix web service sent.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Enhanced_Severance_Matrix_Reference  Severance_Matrix__abstract_Object  [0..1]  The instance of severance matrix that the data will be applied to.   
Enhanced_Severance_Matrix_Data  Enhanced_Severance_Matrix_Data  [1..1]  Element to specify the data for the type of severance matrix to put/update. 
Validation Description
Select a Duration Unit of Day, Week, or Month for the severance matrix.   
 
Validation Description
This matrix is no longer supported. Update the Reference ID with [newmatrix] - [ID] and re-execute the web service call.   
top
 

Response Element: Put_Enhanced_Severance_Matrix_Response

The response for the Put Enhanced Severance Matrix web service.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Severance_Matrix__abstract__Reference  Severance_Matrix__abstract_Object  [0..1]  The Enhanced Severance Matrix created or updated by the Put Enhanced Severance Matrix web service.   
top
 

Severance_Matrix__abstract_Object

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

Severance_Matrix__abstract_ObjectID

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

Enhanced_Severance_Matrix_Data

part of: Put_Enhanced_Severance_Matrix_Request
Element to specify the data for the type of severance matrix to put/update.
 
Parameter name Type/Value Cardinality Description Validations
Enhanced_Severance_Matrix_ID  string  [0..1]  The reference ID for the Severance Matrix.   
Effective_Date  date  [1..1]  The effective date for which the data in this web service will take take effect. 
Validation Description
The effective date must be greater than or equal to [date], because this was the effective date used at creation.   
 
Enhanced_Severance_Matrix_Name  string  [1..1]  The name of the Severance Matrix. Shows up when selecting a matrix in prompts. 
Validation Description
Enter a unique name for the Severance Matrix. The name [name] is already in use.   
 
Inactive  boolean  [0..1]  If true, the matrix is considered inactive and won't show up as an option to select in Severance Packages.   
Duration_Unit_Reference  Compensation_PeriodObject  [1..1]  Days, Weeks, or Months depending on the units used to define notice or severance payment durations.   
Service_Duration_Severance_Matrix_Data [Choice]   Service_Duration_Severance_Matrix_Data  [0..1]  The service length specific duration severance matrix data element.   
Service_Length_Severance_Matrix_Data [Choice]   Service_Length_Severance_Matrix_Data  [0..1]  The Service Length Severance Matrix data element.   
Compensation_Duration_Severance_Matrix_Data [Choice]   Compensation_Duration_Severance_Matrix_Data  [0..1]  The compensation duration severance matrix data element.   
Compensation_Length_of_Service_Severance_Matrix_Data [Choice]   Compensation_Length_of_Service_Severance_Matrix_Data  [0..1]  The compensation length of service severance matrix data element.   
Validation Description
Select a Duration Unit of Day, Week, or Month for the severance matrix.   
top
 

Compensation_PeriodObject

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

Compensation_PeriodObjectID

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

Service_Duration_Severance_Matrix_Data

part of: Enhanced_Severance_Matrix_Data
The service length specific duration severance matrix data element.
 
Parameter name Type/Value Cardinality Description Validations
Length_of_Service_Unit_Reference  Compensation_PeriodObject  [1..1]  Days, Weeks, Months, or Years depending on the units used to define minimum and maximum length of service.   
Service_Duration_Severance_Matrix_Entry_Data  Service_Duration_Severance_Matrix_Entry_Data  [0..*]  The data for each entry in the matrix. 
Validation Description
One or more Service Length ranges overlap.   
The duration must be greater than or equal to minimum: [min] and less than or equal to maximum: [max].   
Maximum Length of Service value must be greater than Minimum Length of Service value   
Maximum duration must be greater than or equal to Minimum duration   
Minimum and Maximum Length of Service values cannot both be blank or zero.   
 
top
 

Service_Duration_Severance_Matrix_Entry_Data

part of: Service_Duration_Severance_Matrix_Data
The data for the matrix entry
 
Parameter name Type/Value Cardinality Description Validations
Minimum_Length_of_Service  decimal (22, 2) >0   [0..1]  This indicates the minimum years of service an employee must have to qualify for this entry.   
Maximum_Length_of_Service  decimal (22, 2) >0   [0..1]  This indicates the maximum years of service an employee must have to qualify for this entry.   
Eligibility_Rule_Reference  Condition_RuleObject  [1..1]  This indicates the Eligibility Rule that the employee must pass in order to qualify for this entry.   
Duration  decimal (20, 0) >0   [0..1]  This indicates the duration for a Duration type entry only.   
Minimum_Duration  decimal (12, 0) >0   [0..1]  This indicates the minimum recommendation for the duration or length of service for the entry.   
Maximum_Duration  decimal (12, 0) >0   [0..1]  This indicates the maximum recommendation for the duration/length of service for the entry.   
Validation Description
One or more Service Length ranges overlap.   
The duration must be greater than or equal to minimum: [min] and less than or equal to maximum: [max].   
Maximum Length of Service value must be greater than Minimum Length of Service value   
Maximum duration must be greater than or equal to Minimum duration   
Minimum and Maximum Length of Service values cannot both be blank or zero.   
top
 

Condition_RuleObject

part of: Compensation_Length_of_Service_Severance_Matrix_Entry_Data, Compensation_Duration_Severance_Matrix_Entry_Data, Service_Length_Severance_Matrix_Entry_Data, Service_Duration_Severance_Matrix_Entry_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  Condition_RuleObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Condition_RuleObjectID

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

Service_Length_Severance_Matrix_Data

part of: Enhanced_Severance_Matrix_Data
The Service Length Severance Matrix data element.
 
Parameter name Type/Value Cardinality Description Validations
Length_of_Service_Unit_Reference  Compensation_PeriodObject  [1..1]  Days, Weeks, Months, or Years depending on the units used to define minimum and maximum length of service.   
Compensation_Rounding_Rule_Reference  Compensation_Rounding_RuleObject  [1..1]  Enter the name of the Compensation Rounding Rule to be used with this matrix.   
Multiplier_Order_Reference  Benefit_Multiplier_OrderObject  [1..1]  Enter Multiply then round to multiply service duration and then apply the rounding rule. Enter Round then multiply to first apply the rounding rule to the service duration and then multiply that product by the length of service multiplier.   
Service_Length_Severance_Matrix_Entry_Data  Service_Length_Severance_Matrix_Entry_Data  [1..*]  The data for each entry in the matrix. 
Validation Description
Maximum duration must be greater than or equal to Minimum duration   
One or more Service Length ranges overlap.   
Maximum Length of Service value must be greater than Minimum Length of Service value   
Minimum and Maximum Length of Service values cannot both be blank or zero.   
 
top
 

Compensation_Rounding_RuleObject

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

Compensation_Rounding_RuleObjectID

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

Benefit_Multiplier_OrderObject

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

Benefit_Multiplier_OrderObjectID

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

Service_Length_Severance_Matrix_Entry_Data

part of: Service_Length_Severance_Matrix_Data
the data for the matrix entry.
 
Parameter name Type/Value Cardinality Description Validations
Minimum_Length_of_Service  decimal (22, 2) >0   [0..1]  This indicates the minimum years of service an employee must have to qualify for this entry.   
Maximum_Length_of_Service  decimal (22, 2) >0   [0..1]  This indicates the maximum years of service an employee must have to qualify for this entry.   
Eligibility_Rule_Reference  Condition_RuleObject  [1..1]  This indicates the Eligibility Rule that the employee must pass in order to qualify for this entry.   
Length_of_Service_Multiplier  decimal (22, 2) >0   [0..1]  This indicates the length of service factor for a Length of Service type entry only.   
Minimum_Duration  decimal (12, 0) >0   [0..1]  This indicates the minimum recommendation for the duration or length of service for the entry.   
Maximum_Duration  decimal (12, 0) >0   [0..1]  This indicates the maximum recommendation for the duration/length of service for the entry.   
Validation Description
Maximum duration must be greater than or equal to Minimum duration   
One or more Service Length ranges overlap.   
Maximum Length of Service value must be greater than Minimum Length of Service value   
Minimum and Maximum Length of Service values cannot both be blank or zero.   
top
 

Compensation_Duration_Severance_Matrix_Data

part of: Enhanced_Severance_Matrix_Data
The compensation duration severance matrix data element.
 
Parameter name Type/Value Cardinality Description Validations
Compensation_Basis_Reference  Compensation_BasisObject  [1..1]  Enter the name of the Compensation Basis used to define the range of the minimum and maximum values.   
Calculate_Compensation_Basis_As_Of_Date_Reference  Severance_Service_DateObject  [1..1]  X, Y, or Z, depending on if the worker's compensation as of the Target Termination Date, Last Day Worked, or the Beginning of Current Year will be used to determine matrix band eligibility.   
Currency_Reference  CurrencyObject  [1..1]  Enter the three character currency code used to define the range of the minimum and maximum values.   
Frequency_Reference  FrequencyObject  [1..1]  Enter the frequency, Weekly, Biweekly, Semimonthly, Monthly, or Annual used to define the minimum and maximum compensation basis range values.   
Compensation_Duration_Severance_Matrix_Entry_Data  Compensation_Duration_Severance_Matrix_Entry_Data  [1..*]  The data for each entry in the matrix. 
Validation Description
Maximum duration must be greater than or equal to Minimum duration   
Maximum compensation basis range must be greater or equal to minimum compensation basis range.   
One or more Compensation Ranges Overlap   
Severance Duration must be between minimum duration and maximum duration.   
 
top
 

Compensation_BasisObject

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

Compensation_BasisObjectID

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

Severance_Service_DateObject

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

Severance_Service_DateObjectID

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

FrequencyObject

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

Compensation_Duration_Severance_Matrix_Entry_Data

part of: Compensation_Duration_Severance_Matrix_Data
The data for the matrix entry.
 
Parameter name Type/Value Cardinality Description Validations
Minimum_Compensation_Basis_Range  decimal (26, 6) >0   [0..1]  Indicates the minimum value of the compensation basis range to determine eligibility for this matrix band.   
Maximum_Compensation_Basis_Range  decimal (26, 6) >0   [0..1]  Indicates the maximum value of the compensation basis range to determine eligibility for this matrix band.   
Eligibility_Rule_Reference  Condition_RuleObject  [1..1]  This indicates the Eligibility Rule that the employee must pass in order to qualify for this entry.   
Duration  decimal (20, 0) >0   [0..1]  This indicates the duration for a Duration type entry only.   
Minimum_Duration  decimal (12, 0) >0   [0..1]  This indicates the minimum recommendation for the duration or length of service for the entry.   
Maximum_Duration  decimal (12, 0) >0   [0..1]  This indicates the maximum recommendation for the duration/length of service for the entry.   
Validation Description
Maximum duration must be greater than or equal to Minimum duration   
Maximum compensation basis range must be greater or equal to minimum compensation basis range.   
One or more Compensation Ranges Overlap   
Severance Duration must be between minimum duration and maximum duration.   
top
 

Compensation_Length_of_Service_Severance_Matrix_Data

part of: Enhanced_Severance_Matrix_Data
The compensation length of service severance matrix data element.
 
Parameter name Type/Value Cardinality Description Validations
Compensation_Basis_Reference  Compensation_BasisObject  [1..1]  Enter the name of the Compensation Basis used to define the range of the minimum and maximum values.   
Calculate_Compensation_Basis_As_Of_Date_Reference  Severance_Service_DateObject  [1..1]  X, Y, or Z, depending on if the worker's compensation as of the Target Termination Date, Last Day Worked, or the Beginning of Current Year will be used to determine matrix band eligibility.   
Currency_Reference  CurrencyObject  [1..1]  Enter the three character currency code used to define the range of the minimum and maximum values.   
Frequency_Reference  FrequencyObject  [1..1]  Enter the frequency, Weekly, Biweekly, Semimonthly, Monthly, or Annual used to define the minimum and maximum compensation basis range values.   
Compensation_Rounding_Rule_Reference  Compensation_Rounding_RuleObject  [1..1]  Enter the name of the Compensation Rounding Rule to be used with this matrix.   
Multiplier_Order_Reference  Benefit_Multiplier_OrderObject  [1..1]  Enter Multiply then round to multiply service duration and then apply the rounding rule. Enter Round then multiply to first apply the rounding rule to the service duration and then multiply that product by the length of service multiplier.   
Compensation_Length_of_Service_Severance_Matrix_Entry_Data  Compensation_Length_of_Service_Severance_Matrix_Entry_Data  [1..*]  The data for each entry in the matrix. 
Validation Description
Maximum compensation basis range must be greater or equal to minimum compensation basis range.   
Maximum duration must be greater than or equal to Minimum duration   
One or more Compensation Ranges Overlap   
 
top
 

Compensation_Length_of_Service_Severance_Matrix_Entry_Data

part of: Compensation_Length_of_Service_Severance_Matrix_Data
The data for the matrix entry.
 
Parameter name Type/Value Cardinality Description Validations
Minimum_Compensation_Basis_Range  decimal (26, 6) >0   [0..1]  Indicates the minimum value of the compensation basis range to determine eligibility for this matrix band.   
Maximum_Compensation_Basis_Range  decimal (26, 6) >0   [0..1]  Indicates the maximum value of the compensation basis range to determine eligibility for this matrix band.   
Eligibility_Rule_Reference  Condition_RuleObject  [1..1]  This indicates the Eligibility Rule that the employee must pass in order to qualify for this entry.   
Length_of_Service_Multiplier  decimal (22, 2) >0   [0..1]  This indicates the length of service factor for a Length of Service type entry only.   
Minimum_Duration  decimal (12, 0) >0   [0..1]  This indicates the minimum recommendation for the duration or length of service for the entry.   
Maximum_Duration  decimal (12, 0) >0   [0..1]  This indicates the maximum recommendation for the duration/length of service for the entry.   
Validation Description
Maximum compensation basis range must be greater or equal to minimum compensation basis range.   
Maximum duration must be greater than or equal to Minimum duration   
One or more Compensation Ranges Overlap   
top
 

Severance_Matrix__abstract_ReferenceEnumeration

part of: Severance_Matrix__abstract_ObjectID
Base Type
string
top
 

Compensation_PeriodReferenceEnumeration

part of: Compensation_PeriodObjectID
Base Type
string
top
 

Condition_RuleReferenceEnumeration

part of: Condition_RuleObjectID
Base Type
string
top
 

Compensation_Rounding_RuleReferenceEnumeration

part of: Compensation_Rounding_RuleObjectID
Base Type
string
top
 

Benefit_Multiplier_OrderReferenceEnumeration

part of: Benefit_Multiplier_OrderObjectID
Base Type
string
top
 

Compensation_BasisReferenceEnumeration

part of: Compensation_BasisObjectID
Base Type
string
top
 

Severance_Service_DateReferenceEnumeration

part of: Severance_Service_DateObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

FrequencyReferenceEnumeration

part of: FrequencyObjectID
Base Type
string
top