Service Directory > v32.1 > Compensation > Put_Eligible_Earnings
 

Operation: Put_Eligible_Earnings

Adds or updates eligible earnings override information for an employee. This operation doesn’t follow participation rules. Use Import Eligible Earnings instead to follow those rules. This operation might affect in-progress bonus reviews.


@ - A parameter name with this symbol denotes an XML attribute within the document instead of an XML element.


Contents

 

Web Service

 

Request

 

Response

 

Element(s)

 

Request Element: Put_Eligible_Earnings_Request

This web service operation is designed to load eligible earnings overrides for an employee for a specified eligible earnings override period. If bonus plans are specified, then the eligible earnings override will apply only to those specific bonus plans. Alternatively, selecting "Apply to All Bonus Plans" option will enable the eligible earnings override to be applied to all current and future bonus plans assigned to the employee for the specified period.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only Flag. Indicates that the service is an add only, not an update.   
Eligible_Earnings_Reference  Eligible_Earnings_OverrideObject  [0..1]  Reference element representing a unique instance of Eligible Earnings Override. You will need to provide the Workday ID of the Eligible Earnings Override in order to update an existing instance.   
Eligible_Earnings_Data  Eligible_Earnings_Data  [1..1]  Wrapper element for the Put Eligible Earnings Request data.   
Validation Description
[worker] already has eligible earnings defined that applies to all bonus plans for the period ([period]). You may edit the eligible earnings ([earnings]) to restrict it to specific bonus plans or create new eligible earnings for a different period.   
Cannot add or update eligible earnings for [worker] to apply to all bonus plans because another eligible earnings exists which has bonus plan restrictions for the same period [period].   
[worker] has another eligible earnings in the same period ([period]) which has the same bonus plan restrictions as the ones being assigned.   
Eligible Earnings Override ID already exists.   
top
 

Response Element: Put_Eligible_Earnings_Response

Responds with the reference ID for the Eligible Earnings
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Eligible_Earnings_Reference  Eligible_Earnings_OverrideObject  [0..1]  Reference element representing a unique instance of Eligible Earnings Override.   
top
 

Eligible_Earnings_OverrideObject

part of: Put_Eligible_Earnings_Request, Put_Eligible_Earnings_Response
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Eligible_Earnings_OverrideObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Eligible_Earnings_OverrideObjectID

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

Eligible_Earnings_Data

part of: Put_Eligible_Earnings_Request
Data element for the Put Eligible Earnings.
 
Parameter name Type/Value Cardinality Description Validations
Eligible_Earnings_ID  string  [0..1]  The integration ID used to reference the Eligible Earnings Override. If the ID for the Eligible Earnings Override is found, the web service will update the existing data. Otherwise, a new Eligible Earnings Override will be created.   
Employee_Reference  WorkerObject  [1..1]  Reference element representing a unique instance of Employee.   
Position_Reference  Position_ElementObject  [0..1]  Employee's current position. Used in multiple-job scenarios. 
Validation Description
Position submitted is not filled as of the effective date.   
The employee you have selected has more than one job. You must supply the job to which this operation applies.   
The job is not valid for the employee.   
 
Period_Reference  Eligible_Earnings_Override_PeriodObject  [1..1]  Reference element representing a unique instance of Eligible Earnings Override Period.   
Apply_to_All_Bonus_Plans [Choice]   boolean  [1..1]  Eligible Earnings Override applies to all Bonus Plans.   
Restrict_to_Bonus_Plans_Reference [Choice]   Bonus_Percent_PlanObject  [1..*]  Eligible Earnings Override is restricted to the specified Bonus Plans.   
Amount  decimal (21, 6) >0   [0..1]  Amount for the Eligible Earnings Override.   
Currency_Reference  CurrencyObject  [0..1]  Reference element representing a unique instance of Currency.   
top
 

WorkerObject

part of: Eligible_Earnings_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  WorkerObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

WorkerObjectID

part of: WorkerObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Contingent_Worker_ID, Employee_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Position_ElementObject

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

Position_ElementObjectID

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

Eligible_Earnings_Override_PeriodObject

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

Eligible_Earnings_Override_PeriodObjectID

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

Bonus_Percent_PlanObject

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

Bonus_Percent_PlanObjectID

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

CurrencyObject

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

Eligible_Earnings_OverrideReferenceEnumeration

part of: Eligible_Earnings_OverrideObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Position_ElementReferenceEnumeration

part of: Position_ElementObjectID
Base Type
string
top
 

Eligible_Earnings_Override_PeriodReferenceEnumeration

part of: Eligible_Earnings_Override_PeriodObjectID
Base Type
string
top
 

Bonus_Percent_PlanReferenceEnumeration

part of: Bonus_Percent_PlanObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top