Service Directory > v32.1 > Compensation > Get_Eligible_Earnings
 

Operation: Get_Eligible_Earnings

This operation retrieves the eligible earnings override values that are associated with a given employee.


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

Request element to get eligible earnings override information for an employee, eligible earnings override period or percent based bonus plan. If no criteria are specified in either the Eligible Earnings Request References or Eligible Earnings Request Criteria elements, all instances of eligible earnings override will be returned.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Eligible_Earnings_Request_References  [0..1]  Utilize the Request References element to retrieve specific instance(s) of Eligible Earnings and its associated data.   
Request_Criteria  Eligible_Earning_Request_Criteria  [0..1]  Utilize the Request Criteria element to search for specific instance(s) of Eligible Earnings.   
Response_Filter  Response_Filter  [0..1]  The "Response_Filter" element contains common WWS information that allows you control the response data that you will be provided including As_Of_Date, As_Of_Entry_Moment, and Page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Eligible_Earnings_Response_Group  [0..1]  The response group allows for the response data to be tailored to only included elements that the user is looking for. If no response group is provided in the request the following elements will be returned: Reference, Eligible Earnings Data   
top
 

Response Element: Get_Eligible_Earnings_Response

Response element containing instances of Eligible Earnings and their associated data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Eligible_Earnings_Request_References  [0..*]  Utilize the Request References element to retrieve specific instance(s) of Eligible Earnings and its associated data.   
Request_Criteria  Eligible_Earning_Request_Criteria  [0..*]  Utilize the Request Criteria element to search for specific instance(s) of Eligible Earnings.   
Response_Filter  Response_Filter  [0..*]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Eligible_Earnings_Response_Group  [0..*]  The response group allows for the response data to be tailored to only included elements that the user is looking for. If no response group is provided in the request the following elements will be returned: Reference, Eligible Earnings Data   
Response_Results  Response_Results  [0..*]  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.   
Response_Data  Eligible_Earnings_Response_Data  [0..*]  Contains Eligible Earnings Override information based on Request References or Request Criteria.   
top
 

Eligible_Earnings_Request_References

part of: Get_Eligible_Earnings_Request, Get_Eligible_Earnings_Response
Utilize the Request References element to retrieve specific instance(s) of Eligible Earnings and its associated data.
 
Parameter name Type/Value Cardinality Description Validations
Eligible_Earnings_Reference  Eligible_Earnings_OverrideObject  [1..*]  A unique identifier for the Eligible Earnings requested.   
top
 

Eligible_Earnings_OverrideObject

part of: Eligible_Earnings_Request_References, Eligible_Earnings
 
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_Earning_Request_Criteria

part of: Get_Eligible_Earnings_Request, Get_Eligible_Earnings_Response
Utilize the Request Criteria element to search for specific instance(s) of Eligible Earnings.
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [0..1]  A unique identifier for the worker.   
Position_Reference  Position_ElementObject  [0..1]  Employee's current position. Used in multiple-job scenarios. 
Validation Description
The job is not valid for the employee.   
The employee you have selected has more than one job. You must supply the job to which this operation applies.   
Position submitted is not filled as of the effective date.   
 
Eligible_Earnings_Period_Reference  Eligible_Earnings_Override_PeriodObject  [0..1]  A unique identifier for the Eligible Earnings Override Period.   
Bonus_Plan_Reference  Bonus_Percent_PlanObject  [0..1]  A unique identifier for the bonus plan.   
top
 

WorkerObject

part of: Eligible_Earnings_Data, Eligible_Earning_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  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, Eligible_Earning_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  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, Eligible_Earning_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  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, Eligible_Earning_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  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
 

Response_Filter

part of: Get_Eligible_Earnings_Request, Get_Eligible_Earnings_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
 

Eligible_Earnings_Response_Group

part of: Get_Eligible_Earnings_Request, Get_Eligible_Earnings_Response
The response group allows for the response data to be tailored to only included elements that the user is looking for. If no response group is provided in the request the following elements will be returned: Reference, Eligible Earnings Data
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Indicates if the Reference for the Eligible Earnings is included in the response.   
Include_Eligible_Earnings_Data  boolean  [0..1]  Indicates if the details of the Eligible Earnings is included in the response.   
top
 

Response_Results

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

Eligible_Earnings_Response_Data

part of: Get_Eligible_Earnings_Response
Contains Eligible Earnings Override information based on Request References or Request Criteria.
 
Parameter name Type/Value Cardinality Description Validations
Eligible_Earnings  Eligible_Earnings  [0..*]  Contains Eligible Earnings Override information based on Request References or Request Criteria.   
top
 

Eligible_Earnings

part of: Eligible_Earnings_Response_Data
Contains Eligible Earnings Override information based on Request References or Request Criteria.
 
Parameter name Type/Value Cardinality Description Validations
Eligible_Earnings_Reference  Eligible_Earnings_OverrideObject  [0..1]  A unique identifier to reference an Eligible Earnings Override.   
Eligible_Earnings_Data  Eligible_Earnings_Data  [0..1]  Contains the detailed information about an employee's Eligible Earnings Override.   
top
 

Eligible_Earnings_Data

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

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