Service Directory > v31.2 > Compensation > Import_Eligible_Earnings_Override
 

Operation: Import_Eligible_Earnings_Override

This operation adds or updates eligible earnings override information for a given employee. If there is an in-progress Bonus Process with configured Participation Rules, then that process will react to the eligible earnings in this operation.


@ - 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: Import_Eligible_Earnings_Override_Request

Loads eligible earnings overrides for a specific period. To apply the override to a specific bonus plan, add the bonus plan to the operation filter. To apply the override to all current and future bonus plans, select "Apply to All Bonus Plans”. An in-progress Compensation Review Process immediately implements these overrides if the Participation Options are configured to support this. Unlike the Put Eligible Earnings operation, if the input template contains any errors, the entire operation fails.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Eligible_Earnings_Override_Period_Reference  Eligible_Earnings_Override_PeriodObject  [1..1]  The Eligible Earnings Override Period which all the Eligible Earnings Overrides belong to. 
Validation Description
The Eligible Earnings Override Period is currently in use by another Import Web Service. Please wait for that one to finish before starting another.   
 
Eligible_Earnings  Import_Eligible_Earnings_Override__HV__Request  [0..*]  Contains an Eligible Earning.   
top
 

Response Element: Put_Import_Process_Response

Put Import Process Response element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Import_Process_Reference  Web_Service_Background_Process_RuntimeObject  [0..1]  Web Service Background Process Runtime element   
Header_Instance_Reference  InstanceObject  [0..1]  Header Instance element   
top
 

Eligible_Earnings_Override_PeriodObject

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

Import_Eligible_Earnings_Override__HV__Request

part of: Import_Eligible_Earnings_Override_Request
This element contains an Eligible Earnings Override.
 
Parameter name Type/Value Cardinality Description Validations
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 or reference ID of the Eligible Earnings Override in order to update an existing instance.   
Eligible_Earnings_Data  Eligible_Earnings_Override__HV__Data  [1..1]  Wrapper element for the Eligible Earnings Request data.   
top
 

Eligible_Earnings_OverrideObject

part of: Import_Eligible_Earnings_Override__HV__Request
 
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_Override__HV__Data

part of: Import_Eligible_Earnings_Override__HV__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]  An optional reference element indicating the Position/Job the transaction will be processed against. 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.   
 
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  [1..1]  Reference element representing a unique instance of Currency.   
top
 

WorkerObject

part of: Eligible_Earnings_Override__HV__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_Override__HV__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
 

Bonus_Percent_PlanObject

part of: Eligible_Earnings_Override__HV__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_Override__HV__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
 

Web_Service_Background_Process_RuntimeObject

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

Web_Service_Background_Process_RuntimeObjectID

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

InstanceObject

part of: Put_Import_Process_Response
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]     
ID  Instance_ID  [0..*]     
top
 

Instance_ID

part of: InstanceObject
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@parent_id  string  [1..1]     
@parent_type  string  [1..1]     
@type  string  [1..1]     
top
 

Eligible_Earnings_Override_PeriodReferenceEnumeration

part of: Eligible_Earnings_Override_PeriodObjectID
Base Type
string
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
 

Bonus_Percent_PlanReferenceEnumeration

part of: Bonus_Percent_PlanObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Web_Service_Background_Process_RuntimeReferenceEnumeration

part of: Web_Service_Background_Process_RuntimeObjectID
Base Type
string
top