Service Directory > v32.1 > Compensation > Put_Compensation_Matrix
 

Operation: Put_Compensation_Matrix

This operation adds or updates compensation matrix information.


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

A request object to put Compensation Matrix data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Compensation_Matrix_Reference  Compensation_MatrixObject  [0..1]  A reference to a current or new compensation matrix.   
Compensation_Matrix_Data  Compensation_Matrix_Data  [1..1]  All data for this compensation matrix.   
top
 

Response Element: Put_Compensation_Matrix_Response

The response to a request to modify or create Compensation Matrix data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Merit_Increase_Matrix_Reference  Compensation_MatrixObject  [0..1]  A reference to the created or modified compensation matrix.   
top
 

Compensation_MatrixObject

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

Compensation_MatrixObjectID

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

Compensation_Matrix_Data

part of: Put_Compensation_Matrix_Request
All data for this compensation matrix.
 
Parameter name Type/Value Cardinality Description Validations
Compensation_Matrix_Matrix_ID  string  [0..1]  The unique ID of this Compensation Matrix.   
Effective_Date  date  [0..1]  The effective date of this merit increase matrix. If no date is provided, this will default to 1900-01-01.   
Compensation_Matrix_Name  string  [1..1]  The name of this Compensation Matrix. This will be displayed throughout the Workday system.   
Compensation_Matrix_Description  string  [0..1]  The description, including purpose and application, of this Compensation Matrix.   
Rating_Scale_Reference  Review_Rating_ScaleObject  [0..1]  The Rating Scale used by this Compensation Matrix. 
Validation Description
Rating Scale may be inactive or not valid for Compensation Matrix.   
 
Compensation_Matrix_Non-weighted_Percent_Based_Data [Choice]   Compensation_Matrix_Non-weighted_Percent_Based_Data  [1..*]  The Data for this compensation matrix, if it is to be based on non-weighted percentages.   
Compensation_Matrix_Amount_Based_Data [Choice]   Compensation_Matrix_Amount_Based_Data  [1..*]  The Data for this compensation matrix, if it is to be amount based.   
Compensation_Matrix_for_Weighted_Percent_Based_Data [Choice]   Compensation_Matrix_Weighted_Percent_Based_Data  [1..*]  The Data for this compensation matrix, if it is to be based on weighted percentages.   
top
 

Review_Rating_ScaleObject

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

Review_Rating_ScaleObjectID

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

part of: Compensation_Matrix_Data
Data for a non-weighted percent based compensation matrix.
 
Parameter name Type/Value Cardinality Description Validations
Compensation_Matrix_Target_Rules_Reference  Condition_RuleObject  [0..*]  Specifying a target rule means that the merit increase matrix (MIM) only applies to employees that fall within that target rule. Specifying two or more target rules results in multiple-target MIMs with target ranges applicable to those employees that fall within the target rule. Leaving the Target Rule Reference empty will result in a single-target MIM that can be used for across the entire organization.   
Compensation_Matrix_Entry_Percent_Based_Data  Compensation_Matrix_Entry_Percent_Based_Data  [0..*]  Data for a single entry in a percent based compensation matrix. 
Validation Description
The maximum value must be greater than or equal to the minimum value for the evaluation rating ([rating]), segment ([quartile]), compa ratio segment([compa]). potential rating([potential]) and target ([rule]).   
 
top
 

Condition_RuleObject

part of: Compensation_Matrix_Entry_Percent_Based_Data, Compensation_Matrix_Entry_Amount_Based_Data, Compensation_Matrix_Non-weighted_Percent_Based_Data, Compensation_Matrix_Amount_Based_Data, Compensation_Matrix_Weighted_Percent_Based_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
 

Compensation_Matrix_Entry_Percent_Based_Data

part of: Compensation_Matrix_Non-weighted_Percent_Based_Data, Compensation_Matrix_Weighted_Percent_Based_Data
Data for a single entry in a percent based compensation matrix.
 
Parameter name Type/Value Cardinality Description Validations
Compensation_Matrix_Entry_Eligibility_Rule_Reference  Condition_RuleObject  [0..1]  The condition rules for this Compensation Matrix. Condition rules determine when the modifications defined in the matrix apply. 
Validation Description
The MIM Entry Target Rule Reference ([rule]) does not match any of the MIM Target Rule References for the merit increase matrix, [matrix].   
 
Performance_Evaluation_Rating_Reference  Review_RatingObject  [0..1]  The performance evaulation rating to which this compensation matrix entry applies.   
Quartile_Placement_Reference  Pay_Range_QuartileObject  [0..1]  The pay range quartile to which this compensation matrix entry applies.   
Retention_Reference  RetentionObject  [0..1]  The retention value to which this compensation matrix entry applies. 
Validation Description
Retention with name = [retention] is inactive and cannot be used in Compensation Matrix.   
 
Compa_Ratio_Range_Segment_Reference  Compa_Ratio_Range_SegmentObject  [0..1]  The Compa Ratio value to which this compensation matrix entry applies.   
Pay_Range_Segment_Reference  Pay_Range_Segment_TypeObject  [0..1]  The Pay Range Segment value to which this compensation matrix entry applies.   
Potential_Reference  PotentialObject  [0..1]  The Potential value to which this compensation matrix entry applies.   
Minimum_Percent  decimal (16, 6) >0   [0..1]  The minimum value for this compensation matrix entry.   
Maximum_Percent  decimal (16, 6) >0   [0..1]  The maximum value for this compensation matrix entry.   
Validation Description
The maximum value must be greater than or equal to the minimum value for the evaluation rating ([rating]), segment ([quartile]), compa ratio segment([compa]). potential rating([potential]) and target ([rule]).   
top
 

Review_RatingObject

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

Review_RatingObjectID

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

Pay_Range_QuartileObject

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

Pay_Range_QuartileObjectID

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

RetentionObject

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

RetentionObjectID

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

Compa_Ratio_Range_SegmentObject

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

Compa_Ratio_Range_SegmentObjectID

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

Pay_Range_Segment_TypeObject

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

Pay_Range_Segment_TypeObjectID

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

PotentialObject

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

PotentialObjectID

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

Compensation_Matrix_Amount_Based_Data

part of: Compensation_Matrix_Data
The amount based data for this compensation matrix.
 
Parameter name Type/Value Cardinality Description Validations
Default_Frequency_Reference  FrequencyObject  [1..1]  The default frequency for this compensation matrix.   
Default_Currency_Reference  CurrencyObject  [0..1]  The default currency for this compensation matrix.   
Compensation_Matrix_Target_Rules_Reference  Condition_RuleObject  [0..*]  Specifying a target rule means that the merit increase matrix (MIM) only applies to employees that fall within that target rule. Specifying two or more target rules results in multiple-target MIMs with target ranges applicable to those employees that fall within the target rule. Leaving the Target Rule Reference empty will result in a single-target MIM that can be used for across the entire organization.   
Compensation_Matrix_Entry_Amount_Based_Data  Compensation_Matrix_Entry_Amount_Based_Data  [0..*]  Entry data for this amount based compensation matrix. 
Validation Description
The maximum value must be greater than or equal to the minimum value for the evaluation rating ([rating]), segment ([quartile]), compa ratio segment([compa]). potential rating([potential]) and target ([rule]).   
 
top
 

FrequencyObject

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

Compensation_Matrix_Entry_Amount_Based_Data

part of: Compensation_Matrix_Amount_Based_Data
Data for a single compensation matrix entry.
 
Parameter name Type/Value Cardinality Description Validations
Compensation_Entry_Target_Rule_Reference  Condition_RuleObject  [0..1]  Condition rules for this compensation matrix entry. This determins when this entry applies itself. 
Validation Description
The MIM Entry Target Rule Reference ([rule]) does not match any of the MIM Target Rule References for the merit increase matrix, [matrix].   
 
Performance_Evaluation_Rating_Reference  Review_RatingObject  [0..1]  The performance evaulation rating to which this compensation matrix entry applies.   
Quartile_Placement_Reference  Pay_Range_QuartileObject  [0..1]  The pay range quartile to which this compensation matrix entry applies.   
Retention_Reference  RetentionObject  [0..1]  The retention value to which this compensation matrix entry applies. 
Validation Description
Retention with name = [retention] is inactive and cannot be used in Compensation Matrix.   
 
Compa_Ratio_Range_Segment_Reference  Compa_Ratio_Range_SegmentObject  [0..1]  The Compa Ratio value to which this compensation matrix entry applies.   
Pay_Range_Segment_Reference  Pay_Range_Segment_TypeObject  [0..1]  The Pay Range Segment value to which this compensation matrix entry applies.   
Potential_Reference  PotentialObject  [0..1]  The Potential value to which this compensation matrix entry applies.   
Minimum_Amount  decimal (21, 6)   [0..1]  The minimum modificatoin amount for this compensation matrix entry.   
Maximum_Amount  decimal (21, 6)   [0..1]  The maximum modification amount for this compensation matrix entry.   
Currency_Reference  CurrencyObject  [0..1]  The currency associated with the target rule for the minimum and maximum amount on the merit increase matrix. If no value is specified, a default currency will be assigned provided the Default Currency exists on the parent element "MIM for Amount Bonus Plan Data". Otherwise, you must enter a currency value. Note: For Single Target without any Target Rule, the currency is always set from the default currency.   
Validation Description
The maximum value must be greater than or equal to the minimum value for the evaluation rating ([rating]), segment ([quartile]), compa ratio segment([compa]). potential rating([potential]) and target ([rule]).   
top
 

Compensation_Matrix_Weighted_Percent_Based_Data

part of: Compensation_Matrix_Data
Data for this weight percent based compensation matrix.
 
Parameter name Type/Value Cardinality Description Validations
Compensation_Matrix_Target_Rules_Reference  Condition_RuleObject  [0..*]  Specifying a target rule means that the merit increase matrix (MIM) only applies to employees that fall within that target rule. Specifying two or more target rules results in multiple-target MIMs with target ranges applicable to those employees that fall within the target rule. Leaving the Target Rule Reference empty will result in a single-target MIM that can be used for across the entire organization.   
Compensation_Matrix_Entry_Percent_Based_Data  Compensation_Matrix_Entry_Percent_Based_Data  [0..*]  Data for a single entry in a percent based compensation matrix. 
Validation Description
The maximum value must be greater than or equal to the minimum value for the evaluation rating ([rating]), segment ([quartile]), compa ratio segment([compa]). potential rating([potential]) and target ([rule]).   
 
top
 

Compensation_MatrixReferenceEnumeration

part of: Compensation_MatrixObjectID
Base Type
string
top
 

Review_Rating_ScaleReferenceEnumeration

part of: Review_Rating_ScaleObjectID
Base Type
string
top
 

Condition_RuleReferenceEnumeration

part of: Condition_RuleObjectID
Base Type
string
top
 

Review_RatingReferenceEnumeration

part of: Review_RatingObjectID
Base Type
string
top
 

Pay_Range_QuartileReferenceEnumeration

part of: Pay_Range_QuartileObjectID
Base Type
string
top
 

RetentionReferenceEnumeration

part of: RetentionObjectID
Base Type
string
top
 

Compa_Ratio_Range_SegmentReferenceEnumeration

part of: Compa_Ratio_Range_SegmentObjectID
Base Type
string
top
 

Pay_Range_Segment_TypeReferenceEnumeration

part of: Pay_Range_Segment_TypeObjectID
Base Type
string
top
 

PotentialReferenceEnumeration

part of: PotentialObjectID
Base Type
string
top
 

FrequencyReferenceEnumeration

part of: FrequencyObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top