Service Directory > v31.2 > Compensation > Get_Compensation_Plans
 

Operation: Get_Compensation_Plans

This operation allows the retrieval of detailed compensation plan 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: Get_Compensation_Plans_Request

Request element to get compensation plan information. If no criteria is specified in the compensation plan request references or compensaiton plan request criteria elements, all compensation plans will be returned.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Compensation_Plan_Request_References  [0..1]  Request References   
Request_Criteria [Choice]   Compensation_Plan_Request_Criteria  [0..1]  Request Criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Compensation_Plan_Response_Group  [0..1]  Response Group   
top
 

Response Element: Get_Compensation_Plans_Response

Response element containing instances of compensation plans and the associated data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Compensation_Plan_Request_References  [0..1]  Request References   
Request_Criteria  Compensation_Plan_Request_Criteria  [0..1]  Request Criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Compensation_Plan_Response_Group  [0..1]  Response Group   
Response_Results  Response_Results  [0..1]  Response Results   
Response_Data  Compensation_Plan_Response_Data  [0..1]  Response Data   
top
 

Compensation_Plan_Request_References

part of: Get_Compensation_Plans_Request, Get_Compensation_Plans_Response
Use this element to request specific Compensation Plans given the reference ID values
 
Parameter name Type/Value Cardinality Description Validations
Compensation_Plan_Reference  Compensation_Assignable_PlanObject  [1..*]  Compensation Plan Reference   
top
 

Compensation_Assignable_PlanObject

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

Compensation_Assignable_PlanObjectID

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

Compensation_Plan_Request_Criteria

part of: Get_Compensation_Plans_Request, Get_Compensation_Plans_Response
Values in this element can be used to filter the types of Compensation Plans returned
 
Parameter name Type/Value Cardinality Description Validations
Plan_Type_Reference  Compensation_Assignable_Component_TypeObject  [0..*]  Plan Type Reference elements are used to limit the compensation plans returned by a type. The ID identifier attribute is "Compensation_Plan_Type_ID". The supported type values are BONUS, FUTURE.   
Include_Inactive  boolean  [0..1]  Include Inactive indicates the response will also include inactive Compensation Plans and Guideline components.   
top
 

Compensation_Assignable_Component_TypeObject

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

Compensation_Assignable_Component_TypeObjectID

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

Response_Filter

part of: Get_Compensation_Plans_Request, Get_Compensation_Plans_Response
Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.
 
Parameter name Type/Value Cardinality Description Validations
As_Of_Effective_Date  date  [0..1]  Indicates the date when application data, such as benefits and compensation, are deemed effective in the Workday system. (Also referred to as the "Effective Moment".) If not specified, this date defaults to TODAY.   
As_Of_Entry_DateTime  dateTime  [0..1]  Indicates the date and time that data was entered into the system. (This field is also referred to as the "Entry Moment".) If not specified, defaults to the CURRENT DATE/TIME.   
Page  decimal (12, 0) >0   [0..1]  Indicates the page of data to return in the response, and defaults to the first page (Page = 1). For responses that contain more than one page of data, use this parameter to retrieve the additional pages of data. For example, set Page = 2 to retrieve the second page of data. Note: If you set the page parameter, you must also specify the "As_Of_Entry_Date" to ensure that the result set remains the same between your requests.   
Count  decimal (3, 0) >0   [0..1]  Sets the number of objects to return within each response page (Min = 1, Max = 999, Default = 100 if not set). Any values you set must be between 1-999.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Compensation_Plan_Response_Group

part of: Get_Compensation_Plans_Request, Get_Compensation_Plans_Response
Use to limit the returned data for a given Compensation Plan
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

part of: Get_Compensation_Plans_Response
The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.
 
Parameter name Type/Value Cardinality Description Validations
Total_Results  decimal (12, 0) >0   [0..1]  The total number of results that have been returned from your request.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages that exist for your request. A page of data in WWS contains a maximum of 100 entries. So, if you have exactly 1,000 employees returned in a request, then you will have 10 pages of data that will need to be retrieved to build your complete dataset. Each page contains a maximum of 100 entries.   
Page_Results  decimal (12, 0) >0   [0..1]  Number of Results in current page.   
Page  decimal (12, 0) >0   [0..1]  The page of data that has been returned for the given request.   
top
 

Compensation_Plan_Response_Data

part of: Get_Compensation_Plans_Response
Response element containing instances of compensation plans and the associated data.
 
Parameter name Type/Value Cardinality Description Validations
Compensation_Plan  Compensation_Plan  [1..*]  Compensation Plan   
top
 

Compensation_Plan

part of: Compensation_Plan_Response_Data
An instance of a compensation plan and associated data.
 
Parameter name Type/Value Cardinality Description Validations
Compensation_Plan_Reference  Compensation_Assignable_PlanObject  [0..1]  Compensation Plan Reference   
Compensation_Plan_Data  Compensation_Plan_Data  [0..1]  Compensation Plan Data   
top
 

Compensation_Plan_Data

part of: Compensation_Plan
Contains common information for the following Compensation Plans: Future Payment, Bonus, Merit, Allowance, Commission, and Base Pay. It also must contain a Future Play, Bonus, Merit, Allowance, Commission, or Bay Pay Plan data.
 
Parameter name Type/Value Cardinality Description Validations
Compensation_Plan_ID  string  [0..1]  Unique attribute name/description identifying a valid instance of Compensation Plan. 
Validation Description
Compensation Elements configured for Period Activity Pay are not allowed for use on Compensation Plans.   
 
Effective_Date  date  [0..1]  The effective date of the compensation plan. It is recommended to use 1900-01-01.   
Name  string  [1..1]  Unique attribute name/description identifying a valid instance of Compensation Plan. 
Validation Description
The compensation plan name provided has already been used.  The compensation plan name provided has already been used. 
 
Description  string  [0..1]  Unique attribute name/description identifying a valid instance of Compensation Plan.   
Eligibility_Rule_Reference  Condition_RuleObject  [0..*]  Eligibility Rules to establish who is eligible for this compensation component. If you select multiple eligibility rules, Workday evaluates each rule independently to determine employee eligibility for the compensation component. Employees are eligible if they meet the qualifications of any one rule.   
Inactive  boolean  [0..1]  Inactive status indicator for Compensation Plans and Guideline components.   
Future_Payment_Plan_Data [Choice]   Future_Payment_Plan_Data  [1..1]  Future Payment Plan Data   
Bonus_Plan_Data [Choice]   Bonus_Plan_Data  [1..1]  Bonus Plan Data consists of common information from the following Bonus Plans: Amount and Percent. 
Validation Description
The sum of Tranche Target Percents must be 100%   
 
Merit_Plan_Data [Choice]   Merit_Plan_Data  [1..1]  Merit Plan Data 
Validation Description
Duplicate compensation plan name. The compensation plan name has already been used by a different compensation plan type (i.e. salary, hourly, allowance, bonus, merit, or commission plan). Therefore, it cannot be used as an add or update for this compensation plan type.   
Either Amount Data or Percent Data must be specified.   
A Merit Plan can use a Percent or Weighted Compensation Matrix, not an Amount Compensation Matrix.   
 
Stock_Plan_Data [Choice]   Stock_Plan_Data  [1..1]  Stock Plan Data   
Allowance_Plan_Data [Choice]   Allowance_Plan_Data  [1..1]  Allowance Plan Data consists of common information from the following Allowance Plans: Amount, Percent, and Unit. It also must contain specific Amount, Percent, or Unit data information. 
Validation Description
Currency value is not allowed for Allowance Percent Plans   
Workday does not allow the Apply FTE field to be selected for percent-based allowance plans.   
 
Commission_Plan_Data [Choice]   Commission_Plan_Data  [1..1]  Commission Plan Data 
Validation Description
Target Amount for Comission Plan has to be greater than zero. If you do not wish to use Target Amount, leave the field blank.   
 
Base_Pay_Plan_Data [Choice]   Base_Pay_Plan_Data  [1..1]  Base Pay Plan Data consists of common information from the following Base Pay Plans: Salary, Hourly, and Unit.   
Period_Plan_Data [Choice]   Period_Plan_Data  [1..1]  Period Plan Data   
Calculated_Plan_Data [Choice]   Calculated_Plan_Data  [1..1]  Data for the creation of a Calculated Plan   
top
 

Condition_RuleObject

part of: Compensation_Plan_Data, Merit_Plan_Profile_Percent_Replacement_Data, Bonus_Plan_Profile_Replacement_Amount_Data, Bonus_Plan_Percent_Plan_Profile_Replacement_Data, Stock_Plan_Unit_Profile_Replacement_Data, Stock_Plan_Amount_Profile_Replacement_Data, Stock_Plan_Percent_Profile_Replacement_Data, Commission_Plan_Profile_Replacement_Data, Allowance_Plan_Amount_Based_Profile_Replacement_Data, Allowance_Plan_Percent_Based_Profile_Replacement_Data, Allowance_Plan_Unit_Based_Profile_Replacement_Data, Period_Plan_Profile_Replacement_Data, Merit_Plan_Profile_Amount_Replacement_Data, Deferred_Compensation_Profiles_Data, Deferred_Compensation_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
 

Future_Payment_Plan_Data

part of: Compensation_Plan_Data
Future Payment Plan Data
 
Parameter name Type/Value Cardinality Description Validations
Compensation_Element_Reference  Compensation_Pay_EarningObject  [1..1]  Compensation Element Reference 
Validation Description
Compensation Elements configured for Period Activity Pay are not allowed for use on Compensation Plans.   
 
Setup_Security_Segment_Reference  Compensation_Setup_Security_SegmentObject  [0..*]  The Setup Security Segment the Compensation Plan is assigned to.   
Currency_Reference  CurrencyObject  [0..1]  The future payment plan currency. If none is provide, the tenant default is used.   
Frequency_Reference  FrequencyObject  [0..1]  The future payment plan frequency. If none is provide, the tenant default is used.   
Allow_Individual_Targets  boolean  [0..1]  Allow Target Override indicator is used to permit the entry of a target number or percent for an individual employee assigned to this plan.   
Include_All_Bonus_Compensation_Plans [Choice]   boolean  [0..1]  Include All Bonus Plans   
Bonus_Compensation_Plan_Reference [Choice]   Bonus_PlanObject  [0..*]  Bonus Plan Reference   
Include_All_One-Time_Payment_Compensation_Plans [Choice]   boolean  [0..1]  Include All One-Time Payment Plans   
One-Time_Payment_Compensation_Plan_Reference [Choice]   One-Time_Payment_PlanObject  [0..*]  One-Time Payment Plan Reference   
Amount  decimal (26, 6) >0   [1..1]  Amount   
top
 

Compensation_Pay_EarningObject

part of: Future_Payment_Plan_Data, Bonus_Plan_Data, Allowance_Plan_Data, Commission_Plan_Data, Base_Pay_Plan_Data, Period_Plan_Data, Calculated_Plan_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
 

Compensation_Setup_Security_SegmentObject

part of: Merit_Plan_Data, Future_Payment_Plan_Data, Bonus_Plan_Data, Allowance_Plan_Data, Commission_Plan_Data, Base_Pay_Plan_Data, Period_Plan_Data, Calculated_Plan_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_Setup_Security_SegmentObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Compensation_Setup_Security_SegmentObjectID

part of: Compensation_Setup_Security_SegmentObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Setup_Security_Segment_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: Merit_Plan_Data, Future_Payment_Plan_Data, Bonus_Plan_Data, Allowance_Plan_Data, Allowance_Plan_Percent_Data, Commission_Plan_Data, Base_Pay_Plan_Data, Bonus_Plan_Profile_Replacement_Amount_Data, Stock_Plan_Amount_Data, Stock_Plan_Amount_Profile_Replacement_Data, Commission_Plan_Profile_Replacement_Data, Allowance_Plan_Amount_Based_Profile_Replacement_Data, Allowance_Plan_Percent_Based_Profile_Replacement_Data, Allowance_Plan_Unit_Based_Profile_Replacement_Data, Merit_Plan_Profile_Amount_Replacement_Data, Calculated_Plan_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: Merit_Plan_Data, Future_Payment_Plan_Data, Bonus_Plan_Data, Allowance_Plan_Data, Commission_Plan_Data, Commission_Plan_Data, Base_Pay_Plan_Data, Calculated_Plan_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
 

Bonus_PlanObject

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

Bonus_PlanObjectID

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

One-Time_Payment_PlanObject

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

One-Time_Payment_PlanObjectID

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

Bonus_Plan_Data

part of: Compensation_Plan_Data
Bonus Plan Data consists of common information from the following Bonus Plans: Amount and Percent.
 
Parameter name Type/Value Cardinality Description Validations
Compensation_Element_Reference  Compensation_Pay_EarningObject  [1..1]  Compensation Plan Default Compensation Element for a Bonus Plan. 
Validation Description
Compensation Elements configured for Period Activity Pay are not allowed for use on Compensation Plans.   
 
Setup_Security_Segment_Reference  Compensation_Setup_Security_SegmentObject  [0..*]  The Setup Security Segment the Compensation Plan is assigned to. 
Validation Description
A Setup Security Segments cannot be referenced when this feature has been disabled in the Tenant Setup. Remove this reference from your request and resubmit.  A Setup Security Segments cannot be referenced when this feature has been disabled in the Tenant Setup. Remove this reference from your request and resubmit. 
 
Currency_Reference  CurrencyObject  [0..1]  The compensation plan currency. If none is provided, the tenant default is used.   
Frequency_Reference  FrequencyObject  [0..1]  The compensation plan frequency. If none is provided, the tenant default is used.   
Allow_Individual_Targets  boolean  [0..1]  Defines whether an employee can have an individual target or if the target is defined by the bonus plan. 1 or true = Individual Target.   
Waiting_Period_Reference  Eligibility_Waiting_PeriodObject  [0..1]  Waiting Period is used to restrict employee eligibility for the bonus plan until after the employee has satisfied the waiting period criteria. By using waiting periods, you can assign the bonus plan to employees at any time, relying on the waiting period to control plan eligibility.   
Time_Proration_Rule_Reference  Time_Proration_RuleObject  [0..1]  Select a rule to prorate employees' target compensation in a compensation event for this plan according to time-based criteria such as leave of absence or time since hire.   
Include_Active_Employees_in_Waiting_Period  boolean  [0..1]  When this box is checked, employees in a waiting period will be included in a process and will appear with a default target of zero. 
Validation Description
Cannot check Include Active Employees in Waiting Period unless a Waiting Period is provided.   
 
Rounding_Rule_Reference  Compensation_Rounding_RuleObject  [0..1]  Rounding Rule for Bonus Amount or Percent Plan   
Company_Performance_Scorecard_Reference  Default_ScorecardObject  [0..1]  Company Performance Scorecard is used to determine the funding of the target bonus pool. The bonus process factors company performance into the bonus pool only if you add the scorecard to the bonus plan and you have a qualifying performance results set.   
Bonus_Modifier_Reference  Default_ScorecardObject  [0..1]  This is the Bonus Modifier defined at the plan level. This impacts the bonus amount awarded.   
Include_Active_Employees_Assigned_Plan_During_Process_Period  boolean  [0..1]  When this box is checked, employees who were assigned this plan at any time during the process period will be included in the process. The process period is derived based on the Process Period End Date defined for the process and the Plan Reference Frequency.   
Performance_Matrix_Data [Choice]   Performance_Matrix_Data  [0..1]  This is a wrapper for the Bonus Plan Performance Matrix and is mutually exclusive with Performance Factors Data. 
Validation Description
Amount Bonus Plan can only use an Amount or Weighted Compensation Matrix. Percent Bonus Plan can only use a Percent or Weighted Compensation Matrix.   
Either Compensation Matrix must have a value or Apply Net Attainment must be selected.  Compensation Performance Matrix Package is required when Compensation Performance Matrix Data is provided. 
A modifier scorecard can only be selected when a Compensation Matrix is selected.   
 
Performance_Factors_Data [Choice]   Performance_Factors_Data  [0..1]  This is a wrapper for Bonus Plan Performance Factors. 
Validation Description
Performance Factors Weight must equal 100.   
Must enter at least one compensation scorecard.   
 
Compensation_Tranche_Replacement_Data  Compensation_Tranche_Replacement_Data  [0..*]  This is a wrapper for the Compensation Tranche Replacement Data which is used to display and replace Compensation Tranche Data within Bonus Plan; it is optional.   
Amount_Data [Choice]   Bonus_Plan_Amount_Data  [1..1]  This is a wrapper for the Bonus Plan Amount; this is required and is mutually exclusive with Bonus Plan Percentage.   
Percent_Data [Choice]   Bonus_Plan_Percent_Data  [1..1]  This is a wrapper for the Bonus Plan Percentage; this is required and is mutually exclusive with Bonus Plan Amount.   
Hide_Target  boolean  [0..1]  Indicates whether or not the target should be hidden.   
Deferred_Compensation  Deferred_Compensation_Data  [0..1]  Deferred Compensation 
Validation Description
Calculations selected must have the same currency as the bonus plan reference currency   
 
Validation Description
The sum of Tranche Target Percents must be 100%   
top
 

Eligibility_Waiting_PeriodObject

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

Eligibility_Waiting_PeriodObjectID

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

Time_Proration_RuleObject

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

Time_Proration_RuleObjectID

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

Compensation_Rounding_RuleObject

part of: Merit_Plan_Data, Bonus_Plan_Data, Stock_Plan_Amount_Data, Stock_Plan_Percent_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
 

Default_ScorecardObject

part of: Bonus_Plan_Data, Bonus_Plan_Data, Performance_Matrix_Data, Performance_Factor_Compensation_Matrix_Weighted_Data, Performance_Factor_Scorecard_Data, Performance_Factor_Scorecard_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  Default_ScorecardObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Default_ScorecardObjectID

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

Performance_Matrix_Data

part of: Bonus_Plan_Data
This is a wrapper for the Bonus Plan Performance Matrix and is mutually exclusive with Performance Factors Data.
 
Parameter name Type/Value Cardinality Description Validations
Compensation_Matrix_Reference  Compensation_MatrixObject  [0..1]  Identifies the compensation matrix used to calculate the employee's target amount during the bonus process.   
Use_Matrix_as_Reference_Only  boolean  [0..1]  Select if you do not want the bonus process to use the compensation matrix to calculate pools, but display the ranges only for reference. When setting up the bonus process for the bonus plan, Workday displays the bonus pool based on the matrix side-by-side with the bonus pool, which reflects the budget from an executive level. You can then compare the two pools to figure out whether the money you've received to fund the bonus event can cover the published matrix requirements, or whether the guidelines exceed the allowed budget. 
Validation Description
Indicating a compensation matrix is for reference calculations only requires that a compensation matrix be specified.   
 
Apply_Net_Attainment  boolean  [0..1]  Indicates that Net Attainment is an input to employee bonus targets.   
Bonus_Modifier_Reference  Default_ScorecardObject  [0..1]  This is the Bonus Modifier defined for the compensation matrix. This impacts the bonus amount awarded.   
Validation Description
Amount Bonus Plan can only use an Amount or Weighted Compensation Matrix. Percent Bonus Plan can only use a Percent or Weighted Compensation Matrix.   
Either Compensation Matrix must have a value or Apply Net Attainment must be selected.  Compensation Performance Matrix Package is required when Compensation Performance Matrix Data is provided. 
A modifier scorecard can only be selected when a Compensation Matrix is selected.   
top
 

Compensation_MatrixObject

part of: Merit_Plan_Data, Performance_Matrix_Data, Stock_Plan_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_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
 

Performance_Factors_Data

part of: Bonus_Plan_Data
Performance Factors Data is part of Bonus Plan and is mutually exclusive with Performance Matrix Data. It consists of one or more Performance Factor Scorecard Data and one Performance Factor Compensation Matrix Weighted Data.
 
Parameter name Type/Value Cardinality Description Validations
Performance_Factor_Scorecard_Data  Performance_Factor_Scorecard_Data  [0..*]  Performance Factor Scorecard Data is part of Performance Factors Data within a Bonus Plan. There must be at least one Performance Factor Scorecard Data within the Performance Factors Data.   
Performance_Factor_Compensation_Matrix_Weighted_Data  Performance_Factor_Compensation_Matrix_Weighted_Data  [0..1]  Performance Factor Compensation Matrix Weighted Data is part of Performance Factors Data within a Bonus Plan; there must be one Performance Factor Compensation Matrix Weighted Data for a Performance Factors Data. 
Validation Description
Either Compensation Matrix must have a value or Apply Net Attainment must be selected.   
A modifier scorecard can only be selected when a Compensation Matrix is selected.   
 
Validation Description
Performance Factors Weight must equal 100.   
Must enter at least one compensation scorecard.   
top
 

Performance_Factor_Scorecard_Data

part of: Performance_Factors_Data
Performance Factor Scorecard Data is part of Performance Factors Data within a Bonus Plan. There must be at least one Performance Factor Scorecard Data within the Performance Factors Data.
 
Parameter name Type/Value Cardinality Description Validations
Scorecard_Reference  Default_ScorecardObject  [1..1]  Identifies the scorecards used to calculate the employee's target amount during the bonus process. You must enter at least one.   
Weight  decimal (10, 4) >0   [1..1]  The total weight between all compensation matrices and scorecards must total 100 percent.   
Bonus_Modifier_Reference  Default_ScorecardObject  [0..1]  This is the Bonus Modifier defined for the compensation scorecard. This impacts the bonus amount awarded.   
top
 

Performance_Factor_Compensation_Matrix_Weighted_Data

part of: Performance_Factors_Data
Performance Factor Compensation Matrix Weighted Data is part of Performance Factors Data within a Bonus Plan; there must be one Performance Factor Compensation Matrix Weighted Data for a Performance Factors Data.
 
Parameter name Type/Value Cardinality Description Validations
Compensation_Matrix_Weighted_Reference  Compensation_Weighted_Percent_MatrixObject  [0..1]  Identifies the compensation matrix used to calculate the employee's target amount during the bonus process. You must enter at least one compensation matrix.   
Apply_Net_Attainment  boolean  [0..1]  Indicates that Net Attainment is an input to employee bonus targets.   
Weight  decimal (10, 4) >0   [1..1]  The total weight between all compensation matrices and scorecards must total 100 percent.   
Bonus_Modifier_Reference  Default_ScorecardObject  [0..1]  This is the Bonus Modifier defined for the compensation matrix. This impacts the bonus amount awarded.   
Validation Description
Either Compensation Matrix must have a value or Apply Net Attainment must be selected.   
A modifier scorecard can only be selected when a Compensation Matrix is selected.   
top
 

Compensation_Weighted_Percent_MatrixObject

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

Compensation_Weighted_Percent_MatrixObjectID

part of: Compensation_Weighted_Percent_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_Tranche_Replacement_Data

part of: Bonus_Plan_Data
This is a wrapper for the Compensation Tranche Replacement Data which is used to display and replace Compensation Tranche Data within Bonus Plan; it is optional.
 
Parameter name Type/Value Cardinality Description Validations
Name  decimal (12, 0) >0   [1..1]  Tranche Name   
Percentage  decimal (18, 6) >0   [1..1]  Tranche Percentage   
top
 

Bonus_Plan_Amount_Data

part of: Bonus_Plan_Data
Contains Bonus Plan Amount data.
 
Parameter name Type/Value Cardinality Description Validations
Amount  decimal (26, 6)   [0..1]  Enter the amount of the target bonus amount. Workday uses this value if it can find no other target value for the employee. This can happen when employees have no individual target, are not eligible for any of the multiple plan profile targets, or are eligible for multiple plan profile targets. This is optional for single target bonus plans so that you have the option to create a bonus plan without using it to budget for bonuses. The default, however, is required for all bonus plans that use multiple targets.   
Amount_Plan_Profile_Replacement_Data  Bonus_Plan_Profile_Replacement_Amount_Data  [0..*]  This is a wrapper for the Bonus Plan Amount; this is used to display or replace Amount Plan Profile Data; it is required and mutually exclusive with Bonus Plan Percentage.   
top
 

Bonus_Plan_Profile_Replacement_Amount_Data

part of: Bonus_Plan_Amount_Data
This is a wrapper for the Bonus Plan Amount; this is used to display or replace Amount Plan Profile Data; it is required and mutually exclusive with Bonus Plan Percentage.
 
Parameter name Type/Value Cardinality Description Validations
Eligibility_Rule_Reference  Condition_RuleObject  [1..1]  Eligibility Rule to establish who is eligible for this compensation component.   
Amount  decimal (26, 6)   [0..1]  Enter the amount of the target bonus amount. Workday uses this value if it can find no other target value for the employee. This can happen when employees have no individual target, are not eligible for any of the multiple plan profile targets, or are eligible for multiple plan profile targets. This is optional for single target bonus plans so that you have the option to create a bonus plan without using it to budget for bonuses. The default, however, is required for all bonus plans that use multiple targets.   
Currency_Reference  CurrencyObject  [1..1]  Currency   
top
 

Bonus_Plan_Percent_Data

part of: Bonus_Plan_Data
Contains Bonus Plan Percent data.
 
Parameter name Type/Value Cardinality Description Validations
Percentage  decimal (14, 4)   [0..1]  Enter the percent of the target bonus amount. Workday uses this value if it can find no other target value for the employee. This can happen when employees have no individual target, are not eligible for any of the multiple plan profile targets, or are eligible for multiple plan profile targets. This is optional for single target bonus plans so that you have the option to create a bonus plan without using it to budget for bonuses. The default, however, is required for all bonus plans that use multiple targets.   
Compensation_Basis_Reference [Choice]   Compensation_BasisObject  [1..1]  Compensation Basis to calculate target amounts for that employee. 
Validation Description
An invalid Compensation Basis Reference has been submitted for this compensation plan. Specify a valid compensation basis and re-submit.   
 
Percent_Plan_Profile_Replacement_Data  Bonus_Plan_Percent_Plan_Profile_Replacement_Data  [0..*]  Used to display or replace Percent Plan Profile Data for a Percent Bonus Plan.   
top
 

Compensation_BasisObject

part of: Bonus_Plan_Percent_Data, Merit_Plan_Percent_Data, Merit_Plan_Profile_Percent_Replacement_Data, Allowance_Plan_Percent_Data, Bonus_Plan_Percent_Plan_Profile_Replacement_Data, Stock_Plan_Percent_Data, Stock_Plan_Percent_Profile_Replacement_Data, Allowance_Plan_Percent_Based_Profile_Replacement_Data, Period_Plan_Profile_Replacement_Data, Period_Plan_Data, Merit_Plan_Amount_Data, Merit_Plan_Profile_Amount_Replacement_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
 

Bonus_Plan_Percent_Plan_Profile_Replacement_Data

part of: Bonus_Plan_Percent_Data
Used to display or replace Percent Plan Profile Data for a Percent Bonus Plan.
 
Parameter name Type/Value Cardinality Description Validations
Eligibility_Rule_Reference  Condition_RuleObject  [1..1]  Eligibility Rule to establish who is eligible for this compensation component.   
Percentage  decimal (16, 4) >0   [0..1]  Enter the percent of the target bonus amount.   
Compensation_Basis_Reference  Compensation_BasisObject  [1..1]  Compensation Basis to calculate target amounts for that employee. 
Validation Description
An invalid Compensation Basis Reference has been submitted for this compensation plan. Specify a valid compensation basis and re-submit.   
 
top
 

Deferred_Compensation_Data

part of: Bonus_Plan_Data
Deferred Compensation
 
Parameter name Type/Value Cardinality Description Validations
Deferred_Compensation_Eligibility_Reference  Condition_RuleObject  [1..*]  Deferred Compensation Eligibility   
Default_Calculation_Reference  Deferred_Bonus_CalculationObject  [1..1]  Default Calculation   
Default_Stock_Plan_Reference  Stock_Percent_PlanObject  [1..1]  Default Stock Plan   
Deferred_Compensation_Profiles  Deferred_Compensation_Profiles_Data  [0..*]  Deferred Compensation Profiles 
Validation Description
Calculations selected must have the same currency as the bonus plan reference currency   
 
Validation Description
Calculations selected must have the same currency as the bonus plan reference currency   
top
 

Deferred_Bonus_CalculationObject

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

Deferred_Bonus_CalculationObjectID

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

Stock_Percent_PlanObject

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

Stock_Percent_PlanObjectID

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

Deferred_Compensation_Profiles_Data

part of: Deferred_Compensation_Data
Deferred Compensation Profiles
 
Parameter name Type/Value Cardinality Description Validations
Eligibility_Rule_Reference  Condition_RuleObject  [1..*]  Eligibility Rule   
Calculation_Reference  Deferred_Bonus_CalculationObject  [1..1]  Calculation   
Stock_Plan_Reference  Stock_Percent_PlanObject  [1..1]  Stock Plan   
Validation Description
Calculations selected must have the same currency as the bonus plan reference currency   
top
 

Merit_Plan_Data

part of: Compensation_Plan_Data
Merit Plan Data
 
Parameter name Type/Value Cardinality Description Validations
Setup_Security_Segment_Reference  Compensation_Setup_Security_SegmentObject  [0..*]  The Setup Security Segment the Compensation Plan is assigned to. 
Validation Description
A Setup Security Segments cannot be referenced when this feature has been disabled in the Tenant Setup. Remove this reference from your request and resubmit.   
 
Currency_Reference  CurrencyObject  [0..1]  Currency reference. Defaults to the tenant currency if no value is provided.   
Frequency_Reference  FrequencyObject  [0..1]  Frequency for Merit Plan; default to "Annual" and is read-only.   
Subject_to_Statutory_Minimum  boolean  [0..1]  This box being checked indicates that the given Merit Plan is eligible for a Statutory Increase   
Allow_Individual_Targets  boolean  [0..1]  Allow Target Override indicator is used to permit the entry of a target number or percent for an individual employee assigned to this plan.   
Compensation_Matrix_Reference  Compensation_MatrixObject  [0..1]  If you want to base merit increases on results of completed performance reviews, select the Compensation Matrix for Performance Factors that you want to use to appropriately award your employees with merit increases based on their evaluation rating.   
Use_Matrix_As_Reference_Only  boolean  [0..1]  The "Use MIM as Reference Only" option is applicable only when Merit Increase Matrix is defined for the plan. 
Validation Description
Indicating a compensation matrix is for reference calculations only requires that a compensation matrix be specified.   
 
Waiting_Period_Reference  Eligibility_Waiting_PeriodObject  [0..1]  Waiting Period is used to restrict employee eligibility for the merit plan until after the employee has satisfied the waiting period criteria. By using waiting periods, you can assign the merit plan to employees at any time, relying on the waiting period to control plan eligibility. If you assign a waiting period to a merit plan and an individual employee is still in the waiting period on the effective date of the merit process event, Workday includes the employee as an exception and sets the suggested target percent (and prorated target increase percent, if applicable) for this employee to 0. In addition, the merit pool will not reflect the employee's target. If you launch the merit process with the exception employees, managers can override the zero target values if necessary.   
Include_Active_Employees_in_Waiting_Period  boolean  [0..1]  When this box is checked, employees in a waiting period will be included in a process and will appear with a default target of zero. 
Validation Description
Cannot check Include Active Employees in Waiting Period unless a Waiting Period is provided.   
 
Time_Proration_Rule_Reference  Time_Proration_RuleObject  [0..1]  Time Proration Rule is used to prorate employees' target compensation in a compensation event for this plan according to time-based criteria such as leave of absence or time since hire.   
Rounding_Rule_Reference  Compensation_Rounding_RuleObject  [0..1]  Rounding Rule for Compensation Plan to establish Rounding Options for calculated amount values.   
Include_Active_Employees_Assigned_Plan_During_Process_Period  boolean  [0..1]  When this box is checked, employees who were assigned this plan at any time during the process period will be included in the process. The process period is derived based on the Process Period End Date defined for the process and the Plan Reference Frequency.   
Percent_Data  Merit_Plan_Percent_Data  [0..1]  Required Percent Data for Merit Plan; consists of default percent and/or Merit Plan Profiles.   
Amount_Data  Merit_Plan_Amount_Data  [0..1]  Data for an Amount Based Merit Plan   
Hide_Target  boolean  [0..1]  Indicates whether or not the target should be hidden.   
Validation Description
Duplicate compensation plan name. The compensation plan name has already been used by a different compensation plan type (i.e. salary, hourly, allowance, bonus, merit, or commission plan). Therefore, it cannot be used as an add or update for this compensation plan type.   
Either Amount Data or Percent Data must be specified.   
A Merit Plan can use a Percent or Weighted Compensation Matrix, not an Amount Compensation Matrix.   
top
 

Merit_Plan_Percent_Data

part of: Merit_Plan_Data
Required Percent Data for Merit Plan; consists of default percent and/or Merit Plan Profiles.
 
Parameter name Type/Value Cardinality Description Validations
Percentage  decimal (16, 6)   [0..1]  Default target percent for the merit plan.   
Manage_By_Compensation_Basis_Rules  boolean  [0..1]  Indicates if Merit Amounts will be managed by the Compensation Basis Rules.   
Compensation_Basis_Reference  Compensation_BasisObject  [0..1]  Compensation Basis to calculate target amounts for that employee. 
Validation Description
The only valid Compensation Basis Reference for this compensation plan is Total Base Pay. Specify Total Base Pay or remove the currently selected reference to default to Total Base Pay.   
 
Merit_Plan_Profile_Percent_Replacement_Data  Merit_Plan_Profile_Percent_Replacement_Data  [0..*]  This is a wrapper for the Merit Plan Percent Plan Profile Percent Replacement; used to display or replace Percent Plan Profile Data.   
top
 

Merit_Plan_Profile_Percent_Replacement_Data

part of: Merit_Plan_Percent_Data
This is a wrapper for the Merit Plan Percent Plan Profile Percent Replacement; used to display or replace Percent Plan Profile Data.
 
Parameter name Type/Value Cardinality Description Validations
Eligibility_Rule_Reference  Condition_RuleObject  [1..1]  This is the eligibility rule associated to the Merit Plan Profile.   
Percentage  decimal (18, 6) >0   [0..1]  Target Percentage for a Merit Plan Profile.   
Compensation_Basis_Reference  Compensation_BasisObject  [0..1]  Compensation Basis to calculate target amounts for that employee. 
Validation Description
The only valid Compensation Basis Reference for this compensation plan is Total Base Pay. Specify Total Base Pay or remove the currently selected reference to default to Total Base Pay.   
 
top
 

Merit_Plan_Amount_Data

part of: Merit_Plan_Data
Data specific to a Merit Amount Plan
 
Parameter name Type/Value Cardinality Description Validations
Amount  decimal (26, 6)   [0..1]  Required amount for an amount based merit plan   
Compensation_Basis_Reference  Compensation_BasisObject  [0..1]  Compensation Basis to calculate target amounts for that employee.   
Manage_By_Compensation_Basis_Rules  boolean  [0..1]  Indicates if Merit Amounts will be managed by the Compensation Basis Rules.   
Merit_Plan_Profile_Amount_Replacement_Data  Merit_Plan_Profile_Amount_Replacement_Data  [0..*]  Wrapper for Merit Amount Plan Profile Data.   
top
 

Merit_Plan_Profile_Amount_Replacement_Data

part of: Merit_Plan_Amount_Data
Data for a Merit Amount plan profile.
 
Parameter name Type/Value Cardinality Description Validations
Profile_Amount  decimal (26, 6)   [0..1]  Target Amount for this Plan Profile   
Currency_Reference  CurrencyObject  [1..1]  Currency for the Profile Amount   
Condition_Rule_Reference  Condition_RuleObject  [1..1]  Condition Rule for this Plan Profile   
Compensation_Basis_Reference  Compensation_BasisObject  [0..1]  Compensation Basis for this Plan Profile   
top
 

Stock_Plan_Data

part of: Compensation_Plan_Data
Data for Stock Plan.
 
Parameter name Type/Value Cardinality Description Validations
Allow_Target_Override  boolean  [0..1]  Allow target override.   
Compensation_Matrix_Reference  Compensation_MatrixObject  [0..1]  Compensation Matrix used by Stock Plan.   
Use_as_Reference_Only  boolean  [0..1]  Select if you do not want the stock process to use the compensation matrix to calculate pools, but display the ranges only for reference. 
Validation Description
Indicating a compensation matrix is for reference calculations only requires that a compensation matrix be specified.   
 
Stock_Plan_Unit_Data [Choice]   Stock_Plan_Unit_Data  [1..1]  Stock Plan Unit Data - use this when the stock target is expressed in terms of number of shares. 
Validation Description
Total Percent must equal 100.   
 
Stock_Plan_Percent_Data [Choice]   Stock_Plan_Percent_Data  [1..1]  Stock Plan Percent Data - use this when stock target is expressed in terms of percent of total base pay. 
Validation Description
Total Percent must equal 100.   
 
Stock_Plan_Amount_Data [Choice]   Stock_Plan_Amount_Data  [1..1]  Stock Plan Amount Data - use this when stock target is expressed in terms of monetary amount. 
Validation Description
Total Percent must equal 100.   
 
Hide_Target  boolean  [0..1]  Indicates whether or not the target should be hidden.   
top
 

Stock_Plan_Unit_Data

part of: Stock_Plan_Data
Data for Stock Unit Plan.
 
Parameter name Type/Value Cardinality Description Validations
Target_Shares  decimal (15, 0) >0   [0..1]  Target expressed as number of shares.   
Grant_Split_Replacement_Data  Grant_Type_Split_Replacement_Data  [1..*]  Default Grant Split for the Stock Plan.   
Stock_Plan_Unit_Profile_Replacement_Data  Stock_Plan_Unit_Profile_Replacement_Data  [0..*]  Profile Data used to override defaults in Stock Plan. 
Validation Description
Total Percent must equal 100.   
Invalid Grant Category in Profile. A Grant Category in a Profile must also be present at the Plan level.   
 
Validation Description
Total Percent must equal 100.   
top
 

Grant_Type_Split_Replacement_Data

part of: Stock_Plan_Unit_Data, Stock_Plan_Amount_Data, Stock_Plan_Percent_Data
Data for Grant Type Split.
 
Parameter name Type/Value Cardinality Description Validations
Stock_Grant_Type_Reference  Stock_Grant_TypeObject  [1..1]  Grant Type of the stock or option.   
Stock_Vesting_Schedule_Reference  Stock_Vesting_ScheduleObject  [0..1]  Vesting schedule of stock or option.   
Stock_Date_Rule_Reference  Stock_Date_RuleObject  [0..1]  The expiration rule for the stock or option.   
Grant_Split_Percent  decimal (10, 4) >0   [0..1]  Fractional proportion of the Grant. Must sum up to 1.   
top
 

Stock_Grant_TypeObject

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

Stock_Grant_TypeObjectID

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

Stock_Vesting_ScheduleObject

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

Stock_Vesting_ScheduleObjectID

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

Stock_Date_RuleObject

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

Stock_Date_RuleObjectID

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

Stock_Plan_Unit_Profile_Replacement_Data

part of: Stock_Plan_Unit_Data
Profile data for Stock Unit Plan.
 
Parameter name Type/Value Cardinality Description Validations
Target_Shares  decimal (21, 6) >0   [0..1]  Target expressed as number of shares.   
Eligibility_Rule_Reference  Condition_RuleObject  [1..1]  Eligibility Rule to establish who is eligible for this compensation component.   
Stock_Profile_Grant_Split_Replacement_Data  Stock_Profile_Grant_Split_Replacement_Data  [1..*]  Grant Split data for Stock Plan Profile.   
Validation Description
Total Percent must equal 100.   
Invalid Grant Category in Profile. A Grant Category in a Profile must also be present at the Plan level.   
top
 

Stock_Profile_Grant_Split_Replacement_Data

part of: Stock_Plan_Unit_Profile_Replacement_Data, Stock_Plan_Amount_Profile_Replacement_Data, Stock_Plan_Percent_Profile_Replacement_Data
Grant Split Data for Stock Profile
 
Parameter name Type/Value Cardinality Description Validations
Stock_Grant_Type_Reference  Stock_Grant_TypeObject  [1..1]  Grant Type of the stock or option.   
Stock_Vesting_Schedule_Reference  Stock_Vesting_ScheduleObject  [0..1]  Vesting schedule of stock or option.   
Stock_Date_Rule_Reference  Stock_Date_RuleObject  [0..1]  The expiration rule for the stock or option.   
Grant_Split_Percent  decimal (10, 4) >0   [0..1]  The expiration rule for the stock or option.   
top
 

Stock_Plan_Percent_Data

part of: Stock_Plan_Data
Data for Stock Percent Plan.
 
Parameter name Type/Value Cardinality Description Validations
Rounding_Rule_Reference  Compensation_Rounding_RuleObject  [0..1]  Compensation Rounding Rule to be used for Amount and Percent Stock Plans.   
Target_Percent  decimal (19, 4) >0   [0..1]  Target Percent for the Stock Plan.   
Compensation_Basis_Reference  Compensation_BasisObject  [0..1]  Compensation Basis to calculate target amounts for that employee. 
Validation Description
An invalid Compensation Basis Reference has been submitted for this compensation plan. Specify a valid compensation basis and re-submit.   
 
Grant_Split_Replacement_Data  Grant_Type_Split_Replacement_Data  [1..*]  Grant Type Splits for the Stock Plan.   
Stock_Plan_Percent_Profile_Default_Replacement_Data  Stock_Plan_Percent_Profile_Replacement_Data  [0..*]  Profiles for Stock Plan. 
Validation Description
Total Percent must equal 100.   
Invalid Grant Category in Profile. A Grant Category in a Profile must also be present at the Plan level.   
 
Validation Description
Total Percent must equal 100.   
top
 

Stock_Plan_Percent_Profile_Replacement_Data

part of: Stock_Plan_Percent_Data
Data for Stock Percent Plan.
 
Parameter name Type/Value Cardinality Description Validations
Target_Percent  decimal (16, 4) >0   [0..1]  Target Percent for Stock Plan Profile.   
Eligibility_Rule_Reference  Condition_RuleObject  [1..1]  Eligibility Rule for Plan Profile.   
Compensation_Basis_Reference  Compensation_BasisObject  [0..1]  Compensation Basis to calculate target amounts for that employee. 
Validation Description
An invalid Compensation Basis Reference has been submitted for this compensation plan. Specify a valid compensation basis and re-submit.   
 
Stock_Profile_Grant_Split_Replacement_Data  Stock_Profile_Grant_Split_Replacement_Data  [1..*]  Grant Splits for the Stock Profile.   
Validation Description
Total Percent must equal 100.   
Invalid Grant Category in Profile. A Grant Category in a Profile must also be present at the Plan level.   
top
 

Stock_Plan_Amount_Data

part of: Stock_Plan_Data
Data for Stock Amount Plan.
 
Parameter name Type/Value Cardinality Description Validations
Rounding_Rule_Reference  Compensation_Rounding_RuleObject  [0..1]  Rounding Rule for Stock Amount or Percent Plan.   
Use_Target_Currency  boolean  [0..1]  Flag to indicate that a grant stock will be in the currency on this amount based stock plan   
Target_Amount  decimal (21, 6)   [0..1]  Target Amount for Stock Plan.   
Currency_Reference  CurrencyObject  [1..1]  Currency of Target Amount.   
Grant_Split_Replacement_Data  Grant_Type_Split_Replacement_Data  [1..*]  Grant Splits for Stock Plan.   
Stock_Plan_Amount_Profile_Replacement_Data  Stock_Plan_Amount_Profile_Replacement_Data  [0..*]  Profiles for Stock Plan. 
Validation Description
Total Percent must equal 100.   
Invalid Grant Category in Profile. A Grant Category in a Profile must also be present at the Plan level.   
 
Validation Description
Total Percent must equal 100.   
top
 

Stock_Plan_Amount_Profile_Replacement_Data

part of: Stock_Plan_Amount_Data
Profile data for Stock Amount Plan.
 
Parameter name Type/Value Cardinality Description Validations
Target_Amount  decimal (26, 6)   [0..1]  Target Amount for the Stock Plan Profile.   
Currency_Reference  CurrencyObject  [1..1]  Currency of the Target Amount.   
Eligibility_Rule_Reference  Condition_RuleObject  [1..1]  Eligibility Rule for the Stock Plan Profile.   
Stock_Profile_Grant_Split_Replacement_Data  Stock_Profile_Grant_Split_Replacement_Data  [1..*]  Grant Splits for the Stock Plan Profile.   
Validation Description
Total Percent must equal 100.   
Invalid Grant Category in Profile. A Grant Category in a Profile must also be present at the Plan level.   
top
 

Allowance_Plan_Data

part of: Compensation_Plan_Data
Allowance Plan Data consists of common information from the following Allowance Plans: Amount, Percent, and Unit. It also must contain specific Amount, Percent, or Unit data information.
 
Parameter name Type/Value Cardinality Description Validations
Compensation_Element_Reference  Compensation_Pay_EarningObject  [0..1]  Compensation Plan Default Compensation Element for an Allowance Plan. This is required for non-reimbursable allowance plans. It must be empty for reimbursable allowance plans. 
Validation Description
Compensation Element Reference must be empty for reimbursable allowance plans.   
Compensation Element Reference is required for non-reimbursable allowance plans.   
Compensation Elements configured for Period Activity Pay are not allowed for use on Compensation Plans.   
 
Setup_Security_Segment_Reference  Compensation_Setup_Security_SegmentObject  [0..*]  The Setup Security Segment the Compensation Plan is assigned to. 
Validation Description
A Setup Security Segments cannot be referenced when this feature has been disabled in the Tenant Setup. Remove this reference from your request and resubmit.  A Setup Security Segments cannot be referenced when this feature has been disabled in the Tenant Setup. Remove this reference from your request and resubmit. 
 
Currency_Reference  CurrencyObject  [0..1]  The compensation plan currency. If none is provided, the tenant default is used.   
Frequency_Reference  FrequencyObject  [0..1]  The compensation plan frequency. If none is provided, the tenant default is used.   
No_Individual_Override  boolean  [0..1]  No Individual Override indicator prevents default values from being overridden for specific employees assigned to an Allowance Plan; if the value is True, then Amount, Percent, or Unit Data is required for Amount, Percent, and Unit Allowance Plans respectively.   
Apply_Full_Time_Equivalent  boolean  [0..1]  Use Apply FTE% to prorate compensation for employees assigned to this plan based on their full-time equivalent hours percentage.   
Exclude_from_Merit  boolean  [0..1]  Indicates if the allowance plan is eligible for the merit process.   
Amount_Data [Choice]   Allowance_Plan_Amount_Data  [1..1]  Amount Data is part of an Allowance Plan and is mutually exclusive with Percent and Unit Data. 
Validation Description
Amount for Allowance Plan has to be greater than zero. If you do not wish to use amount, leave the field blank.   
 
Percent_Data [Choice]   Allowance_Plan_Percent_Data  [1..1]  Percent Data is part of an Allowance Plan and is mutually exclusive with Amount and Unit Data.   
Unit_Data [Choice]   Allowance_Plan_Unit_Data  [1..1]  Unit Data is part of an Allowance Plan and is mutually exclusive with Amount and Percent Data. 
Validation Description
Per Unit Amount for Allowance Plan has to be greater than zero. If you do not wish to use Per Unit Amount, leave the field blank.   
 
Reimbursable_Data  Allowance_Plan_Reimbursable_Data  [0..1]  Reimbursable Data is part of an Allowance Plan and applies only to Reimbursable Allowance Plans.   
Validation Description
Currency value is not allowed for Allowance Percent Plans   
Workday does not allow the Apply FTE field to be selected for percent-based allowance plans.   
top
 

Allowance_Plan_Amount_Data

part of: Allowance_Plan_Data
Contains Allowance Plan Amount Data.
 
Parameter name Type/Value Cardinality Description Validations
Amount  decimal (26, 6)   [0..1]  Amount for Amount Allowance Plan; required if No Individual Override is True.   
Allowance_Plan_Amount_Based_Profile_Replacement_Data  Allowance_Plan_Amount_Based_Profile_Replacement_Data  [0..*]  This is a wrapper for the Allowance Plan Amount Based Profile Data; this is used to display or replace Allowance Plan Amount Based Profile Data. 
Validation Description
Amount for Allowance Plan Amount Based Profile has to be greater than zero. If you do not wish to use Amount, leave the field blank.   
 
Validation Description
Amount for Allowance Plan has to be greater than zero. If you do not wish to use amount, leave the field blank.   
top
 

Allowance_Plan_Amount_Based_Profile_Replacement_Data

part of: Allowance_Plan_Amount_Data
This is a wrapper for the Allowance Plan Amount Based Profile Data; this is used to display or replace Allowance Plan Amount Based Profile Data.
 
Parameter name Type/Value Cardinality Description Validations
Eligibility_Rule_Reference  Condition_RuleObject  [1..1]  Eligibility Rule to establish who is eligible for this compensation component.   
Amount  decimal (26, 6)   [0..1]  Enter the amount of the target allowance amount. Workday uses this value if it can find no other target value for the employee. This can happen when employees are not eligible for any of the multiple plan targets, or are eligible for multiple plan profile targets.   
Currency_Reference  CurrencyObject  [1..1]  Currency   
Validation Description
Amount for Allowance Plan Amount Based Profile has to be greater than zero. If you do not wish to use Amount, leave the field blank.   
top
 

Allowance_Plan_Percent_Data

part of: Allowance_Plan_Data
Contains Allowance Plan Percent data.
 
Parameter name Type/Value Cardinality Description Validations
Percentage  decimal (16, 6)   [0..1]  Percentage for Percent Allowance Plan; required if No Individual Override is True.   
Compensation_Basis_Reference  Compensation_BasisObject  [0..1]  Compensation Basis to calculate target amounts for that employee. 
Validation Description
An invalid Compensation Basis Reference has been submitted for this compensation plan. Specify a valid compensation basis and re-submit.   
 
Ceiling_Amount  decimal (26, 6) >0   [0..1]  The Ceiling Amount for the Allowance Percent Plan. 
Validation Description
The Ceiling Amount cannot be negative.   
 
Ceiling_Currency_Reference  CurrencyObject  [0..1]  The Ceiling Currency for the Allowance Percent Plan. 
Validation Description
The Ceiling Currency Reference is required since a Ceiling Amount is specified.   
 
Allowance_Plan_Percent_Based_Profile_Replacement_Data  Allowance_Plan_Percent_Based_Profile_Replacement_Data  [0..*]  This is a wrapper for the Allowance Plan Percent Based Profile Data; this is used to display or replace Allowance Plan Percent Based Profile Data.   
top
 

Allowance_Plan_Percent_Based_Profile_Replacement_Data

part of: Allowance_Plan_Percent_Data
This is a wrapper for the Allowance Plan Percent Based Profile Data; this is used to display or replace Allowance Plan Percent Based Profile Data.
 
Parameter name Type/Value Cardinality Description Validations
Eligibility_Rule_Reference  Condition_RuleObject  [1..1]  Eligibility Rule to establish who is eligible for this compensation component.   
Percent  decimal (18, 6) >0   [0..1]  Enter the amount of the target allowance percent. Workday uses this value if it can find no other target value for the employee. This can happen when employees are not eligible for any of the multiple plan targets, or are eligible for multiple plan profile targets.   
Compensation_Basis_Reference  Compensation_BasisObject  [0..1]  Compensation Basis to calculate target amounts for that employee. 
Validation Description
An invalid Compensation Basis Reference has been submitted for this compensation plan. Specify a valid compensation basis and re-submit.   
 
Ceiling_Amount  decimal (26, 6) >0   [0..1]  The Ceiling Amount for the Allowance Percent Plan Profile. 
Validation Description
The Ceiling Amount cannot be negative.   
 
Ceiling_Currency_Reference  CurrencyObject  [0..1]  The Ceiling Currency for the Allowance Percent Plan Profile. 
Validation Description
The Ceiling Currency Reference is required since a Ceiling Amount is specified.   
 
top
 

Allowance_Plan_Unit_Data

part of: Allowance_Plan_Data
Contains Allowance Plan Unit data.
 
Parameter name Type/Value Cardinality Description Validations
Per_Unit_Amount  decimal (26, 6)   [0..1]  Per Unit Amount for Unit Allowance Plan; required if No Individual Override is True.   
Default_Units  decimal (21, 6) >0   [0..1]  Number of Units for which to pay an allowance; required if No Individual Override is True.   
Unit_Of_Measure_Reference  Unit_of_MeasureObject  [1..1]  Unit of measure for Unit Data of an Allowance Plan; required.   
Allowance_Plan_Unit_Based_Profile_Replacement_Data  Allowance_Plan_Unit_Based_Profile_Replacement_Data  [0..*]  This is a wrapper for the Allowance Plan Unit Based Profile Data; this is used to display or replace Allowance Plan Unit Based Profile Data. 
Validation Description
Per Unit Amount for Allowance Plan has to be greater than zero. If you do not wish to use Per Unit Amount, leave the field blank.   
 
Validation Description
Per Unit Amount for Allowance Plan has to be greater than zero. If you do not wish to use Per Unit Amount, leave the field blank.   
top
 

Unit_of_MeasureObject

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

Unit_of_MeasureObjectID

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

Allowance_Plan_Unit_Based_Profile_Replacement_Data

part of: Allowance_Plan_Unit_Data
This is a wrapper for the Allowance Plan Unit Based Profile Data; this is used to display or replace Allowance Plan Unit Based Profile Data.
 
Parameter name Type/Value Cardinality Description Validations
Eligibility_Rule_Reference  Condition_RuleObject  [1..1]  Eligibility Rule to establish who is eligible for this compensation component.   
Number_of_Units  decimal (21, 6) >0   [0..1]  Enter the number of the target allowance number of units. Workday uses this value if it can find no other target value for the employee. This can happen when employees are not eligible for any of the multiple plan targets, or are eligible for multiple plan profile targets.   
Per_Unit_Amount  decimal (26, 6)   [0..1]  Enter the amount of the target allowance amount per unit. Workday uses this value if it can find no other target value for the employee. This can happen when employees are not eligible for any of the multiple plan targets, or are eligible for multiple plan profile targets.   
Currency_Reference  CurrencyObject  [1..1]  Currency   
Validation Description
Per Unit Amount for Allowance Plan has to be greater than zero. If you do not wish to use Per Unit Amount, leave the field blank.   
top
 

Allowance_Plan_Reimbursable_Data

part of: Allowance_Plan_Data
Allowance Plan Reimbursable Data consists of information pertinent only to reimbursable allowance plans.
 
Parameter name Type/Value Cardinality Description Validations
Expense_Item_Reference  Expense_ItemObject  [1..1]  The expense item associated with the reimbursable allowance plan. 
Validation Description
Expense item is assigned to another reimbursable allowance plan. You must select an expense item that is already assigned to this allowance plan or one that is not yet assigned.   
 
Expense_Accumulator_Reference  Expense_AccumulatorObject  [1..1]  The expense accumulator associated with the reimbursable allowance plan.   
top
 

Expense_ItemObject

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

Expense_ItemObjectID

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

Expense_AccumulatorObject

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

Expense_AccumulatorObjectID

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

Commission_Plan_Data

part of: Compensation_Plan_Data
Commission Plan Data
 
Parameter name Type/Value Cardinality Description Validations
Compensation_Element_Reference  Compensation_Pay_EarningObject  [1..1]  Compensation Plan Default Compensation Element for a Commission Plan. 
Validation Description
Compensation Elements configured for Period Activity Pay are not allowed for use on Compensation Plans.   
 
Setup_Security_Segment_Reference  Compensation_Setup_Security_SegmentObject  [0..*]  The Setup Security Segment the Compensation Plan is assigned to.   
Currency_Reference  CurrencyObject  [0..1]  Currency reference. Defaults to the tenant currency if no value is provided.   
Frequency_Reference  FrequencyObject  [0..1]  The compensation plan frequency. If none is provided, the tenant default is used.   
Target_Amount  decimal (26, 6)   [0..1]  The Target Amount to default to an employee's compensation.   
Draw_Amount  decimal (21, 6) >0   [0..1]  The Draw Amount, Draw Frequency, and Draw Duration are for informational purposes and passing to a third-party commission system.   
Draw_Frequency_Reference  FrequencyObject  [0..1]  The Draw Amount, Draw Frequency, and Draw Duration are for informational purposes and passing to a third-party commission system. 
Validation Description
Draw Frequency Reference is required when a Draw Amount is provided.   
 
Draw_Duration  string  [0..1]  The Draw Amount, Draw Frequency, and Draw Duration are for informational purposes and passing to a third-party commission system.   
Recoverable  boolean  [0..1]  Indicates whether commission payments made for this plan are Recoverable by default.   
Commission_Plan_Profile_Replacement_Data  Commission_Plan_Profile_Replacement_Data  [0..*]  This is a wrapper for the Commission Plan Profile Data; this is used to display or replace Commission Plan Profile Data.   
Validation Description
Target Amount for Comission Plan has to be greater than zero. If you do not wish to use Target Amount, leave the field blank.   
top
 

Commission_Plan_Profile_Replacement_Data

part of: Commission_Plan_Data
This is a wrapper for the Commission Plan Profile Data; this is used to display or replace Commission Plan Profile Data.
 
Parameter name Type/Value Cardinality Description Validations
Eligibility_Rule_Reference  Condition_RuleObject  [1..1]  Eligibility Rule to establish who is eligible for this compensation component.   
Amount  decimal (26, 6)   [0..1]  Enter the amount of the target commission amount. Workday uses this value if it can find no other target value for the employee. This can happen when employees are not eligible for any of the multiple plan targets, or are eligible for multiple plan profile targets.   
Draw_Amount  decimal (21, 6) >0   [0..1]  Enter the amount of the target commission draw amount. Workday uses this value if it can find no other target value for the employee. This can happen when employees are not eligible for any of the multiple plan targets, or are eligible for multiple plan profile targets.   
Currency_Reference  CurrencyObject  [1..1]  Currency   
top
 

Base_Pay_Plan_Data

part of: Compensation_Plan_Data
Base Pay Plan Data consists of common information from the following Base Pay Plans: Salary, Hourly, and Unit.
 
Parameter name Type/Value Cardinality Description Validations
Compensation_Element_Reference  Compensation_Pay_EarningObject  [1..1]  Compensation Plan Default Compensation Element for a Base Pay Plan. 
Validation Description
Compensation Elements configured for Period Activity Pay are not allowed for use on Compensation Plans.   
 
Setup_Security_Segment_Reference  Compensation_Setup_Security_SegmentObject  [0..*]  The Setup Security Segment the Compensation Plan is assigned to.   
Currency_Reference  CurrencyObject  [0..1]  The compensation plan currency. If none is provided, the tenant default is used.   
Frequency_Reference  FrequencyObject  [0..1]  The compensation plan frequency. If none is provided, the tenant default is used.   
Exclude_from_Merit  boolean  [0..1]  Indicates if the base pay plan is eligible for the merit process.   
Salary_Data [Choice]   Salary_Plan_Data  [1..1]  This is a wrapper for Salary Plans.   
Hourly_Data [Choice]   Hourly_Plan_Data  [1..1]  This is a wrapper for the Hourly Data. 
Validation Description
Amount for Hourly Plan Data must be greater than zero. If you do not wish to use Amount, leave the field blank.   
 
Unit_Data [Choice]   Unit_Salary_Plan_Data  [1..1]  This is a wrapper for the Base Pay Unit Salaries. 
Validation Description
Per Unit Amount for Salary Unit Data must be greater than zero. If you do not wish to use Per Unit Amount, leave the field blank.   
 
top
 

Salary_Plan_Data

part of: Base_Pay_Plan_Data
This is a wrapper for Salary Plans.
 
Parameter name Type/Value Cardinality Description Validations
Apply_Full_Time_Equivalent  boolean  [0..1]  Apply FTE% indicator to prorate compensation for employees assigned to this plan based on their full-time equivalent hours percentage.   
top
 

Hourly_Plan_Data

part of: Base_Pay_Plan_Data
This is a wrapper for the Hourly Data.
 
Parameter name Type/Value Cardinality Description Validations
Amount  decimal (26, 6)   [0..1]  Amount for the Hourly Plan Compensation data.   
Minimum_Wage  boolean  [0..1]  Minimum wage indicator for the Hourly Plan Compensation data.   
Validation Description
Amount for Hourly Plan Data must be greater than zero. If you do not wish to use Amount, leave the field blank.   
top
 

Unit_Salary_Plan_Data

part of: Base_Pay_Plan_Data
This is a wrapper for the Base Pay Unit Salaries.
 
Parameter name Type/Value Cardinality Description Validations
Per_Unit_Amount  decimal (26, 6)   [0..1]  A Per Unit Amount to pay. Required if No Individual Override is True. 
Validation Description
Per Unit Amount is required if No Individual Override is True.  Per Unit Amount is required if No Individual Override is True. 
 
Default_Units  decimal (21, 6) >0   [0..1]  The Default Units, which is your best guess of the number of units an employee will work during the for the specified Frequency (time period). Units multiplied by per unit amount determines an employee's pay. An employee can ultimately work and be paid for a different number of units than this default. Required if No Individual Override is True. 
Validation Description
Default Units is required if No Individual Override is True.  Default Units is required if No Individual Override is True. 
 
Unit_Of_Measure_Reference  Unit_of_MeasureObject  [1..1]  A Unit of measure for the work performed. For example, a box of items packed.   
No_Individual_Override  boolean  [0..1]  No Individual Override indicator prevents default values from being overridden for specific employees assigned to a Unit Salary Plan; if the value is True, then Per Unit Amount and Default Units are required.   
Validation Description
Per Unit Amount for Salary Unit Data must be greater than zero. If you do not wish to use Per Unit Amount, leave the field blank.   
top
 

Period_Plan_Data

part of: Compensation_Plan_Data
Period Plan Data
 
Parameter name Type/Value Cardinality Description Validations
Compensation_Element_Reference  Compensation_Pay_EarningObject  [1..1]  Compensation Plan Default Compensation Element for a Period Salary Plan. 
Validation Description
Compensation Elements configured for Period Activity Pay are not allowed for use on Compensation Plans.   
 
Default_Compensation_Period_Multiplier  decimal (18, 6) >0   [0..1]  The multiplier for a Period Salary Plan. 
Validation Description
Default Compensation Period Multiplier is required.   
The Compensation Period Multiplier must be less than 1000.   
 
Unit_of_Duration_Reference  Compensation_PeriodObject  [1..1]  A Unit of time duration; for example, day, week, or month.   
Compensation_Basis_Reference  Compensation_BasisObject  [1..1]  Compensation Basis to calculate target amounts for that employee.   
Period_Plan_Profile_Replacement_Data  Period_Plan_Profile_Replacement_Data  [0..*]  This is a wrapper for the Period Salary Plan Profile Replacement; used to display or replace Period Plan Profile Data   
Compensation_Setup_Security_Segment_Reference  Compensation_Setup_Security_SegmentObject  [0..*]  The Setup Security Segment the Compensation Plan is assigned to. 
Validation Description
A Setup Security Segments cannot be referenced when this feature has been disabled in the Tenant Setup. Remove this reference from your request and resubmit.   
 
top
 

Compensation_PeriodObject

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

Period_Plan_Profile_Replacement_Data

part of: Period_Plan_Data
Profile data for Period Salary Plan.
 
Parameter name Type/Value Cardinality Description Validations
Eligibility_Rule_Reference  Condition_RuleObject  [1..1]  This is the eligibility rule associated to the Period Salary Plan Profile.   
Default_Compensation_Period_Multiplier  decimal (18, 6) >0   [1..1]  Target Number of Units for a Period Salary Plan Profile. 
Validation Description
Default Compensation Period Multiplier must be less than 1000.   
 
Compensation_Basis_Reference  Compensation_BasisObject  [1..1]  Compensation Basis to calculate target amounts for that employee.   
top
 

Calculated_Plan_Data

part of: Compensation_Plan_Data
Data for creation of a Calculated Plan
 
Parameter name Type/Value Cardinality Description Validations
Compensation_Element_Reference  Compensation_Pay_EarningObject  [0..1]  Compensation Element for a Calculated Plan   
Setup_Security_Segment_Reference  Compensation_Setup_Security_SegmentObject  [0..*]  The Setup Security Segment the Compensation Plan is assigned to. 
Validation Description
A Setup Security Segments cannot be referenced when this feature has been disabled in the Tenant Setup. Remove this reference from your request and resubmit.   
 
Calculation_Reference  CalculationObject  [0..1]  The Payroll Calculation Engine Calculation associated with this Calculated Plan.   
Currency_Reference  CurrencyObject  [0..1]  The default Currency for this plan.   
Frequency_Reference  FrequencyObject  [0..1]  The default Frequency for this plan.   
top
 

CalculationObject

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

CalculationObjectID

part of: CalculationObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Absence_Balance_ID, Absence_Component_Related_Calculation_ID, Absence_Plan_ID, Accrual_Code, Aggregate_Calculation_ID, Arithmetic_Calculation_ID, Build_Date_Calculation_ID, Calculation_Compensation_Basis_ID, Compensation_Basis_ID, Compensation_Plan_ID, Conditional_Calculation_ID, Constant_Date_Calculation_ID, Constant_Value_Calculation_ID, Date_Difference_Calculation_ID, Date_Extract_Calculation_ID, Date_Increment_Decrement_Calculation_ID, Deduction_Code, Earning_Code, Instance_Set_Comparison_Calculation, Instance_Value_Calculation_ID, Logic_Calculation_ID, Lookup_Calculation_ID, Pay_Accumulation_Code, Pay_Balance_Code, Pay_Component_Group_Code, Pay_Component_Related_Calculation_Code, Related_Calculation_ID, Time_Off_Code, Value_Comparison_Calculation_ID, Workday_Absence_Balance_ID, Workday_Absence_Code, Workday_Absence_Component_Related_Calculation_ID, Workday_Absence_Plan_ID, Workday_Accrual_Code, Workday_Deduction_Code, Workday_Earning_Code, Workday_Pay_Accumulation_Code, Workday_Pay_Balance_Code, Workday_Pay_Component_Group_Code, Workday_Pay_Component_Related_Calculation_Code, Workday_Related_Calculation_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_Assignable_PlanReferenceEnumeration

part of: Compensation_Assignable_PlanObjectID
Base Type
string
top
 

Compensation_Assignable_Component_TypeReferenceEnumeration

part of: Compensation_Assignable_Component_TypeObjectID
Base Type
string
top
 

Condition_RuleReferenceEnumeration

part of: Condition_RuleObjectID
Base Type
string
top
 

Compensation_Pay_EarningReferenceEnumeration

part of: Compensation_Pay_EarningObjectID
Base Type
string
top
 

Compensation_Setup_Security_SegmentReferenceEnumeration

part of: Compensation_Setup_Security_SegmentObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

FrequencyReferenceEnumeration

part of: FrequencyObjectID
Base Type
string
top
 

Bonus_PlanReferenceEnumeration

part of: Bonus_PlanObjectID
Base Type
string
top
 

One-Time_Payment_PlanReferenceEnumeration

part of: One-Time_Payment_PlanObjectID
Base Type
string
top
 

Eligibility_Waiting_PeriodReferenceEnumeration

part of: Eligibility_Waiting_PeriodObjectID
Base Type
string
top
 

Time_Proration_RuleReferenceEnumeration

part of: Time_Proration_RuleObjectID
Base Type
string
top
 

Compensation_Rounding_RuleReferenceEnumeration

part of: Compensation_Rounding_RuleObjectID
Base Type
string
top
 

Default_ScorecardReferenceEnumeration

part of: Default_ScorecardObjectID
Base Type
string
top
 

Compensation_MatrixReferenceEnumeration

part of: Compensation_MatrixObjectID
Base Type
string
top
 

Compensation_Weighted_Percent_MatrixReferenceEnumeration

part of: Compensation_Weighted_Percent_MatrixObjectID
Base Type
string
top
 

Compensation_BasisReferenceEnumeration

part of: Compensation_BasisObjectID
Base Type
string
top
 

Deferred_Bonus_CalculationReferenceEnumeration

part of: Deferred_Bonus_CalculationObjectID
Base Type
string
top
 

Stock_Percent_PlanReferenceEnumeration

part of: Stock_Percent_PlanObjectID
Base Type
string
top
 

Stock_Grant_TypeReferenceEnumeration

part of: Stock_Grant_TypeObjectID
Base Type
string
top
 

Stock_Vesting_ScheduleReferenceEnumeration

part of: Stock_Vesting_ScheduleObjectID
Base Type
string
top
 

Stock_Date_RuleReferenceEnumeration

part of: Stock_Date_RuleObjectID
Base Type
string
top
 

Unit_of_MeasureReferenceEnumeration

part of: Unit_of_MeasureObjectID
Base Type
string
top
 

Expense_ItemReferenceEnumeration

part of: Expense_ItemObjectID
Base Type
string
top
 

Expense_AccumulatorReferenceEnumeration

part of: Expense_AccumulatorObjectID
Base Type
string
top
 

Compensation_PeriodReferenceEnumeration

part of: Compensation_PeriodObjectID
Base Type
string
top
 

CalculationReferenceEnumeration

part of: CalculationObjectID
Base Type
string
top