Service Directory > v25.1 > Compensation_Review > Import_Employee_Awards
 

Operation: Import_Employee_Awards

This operation updates Employee Awards for a specific employee or employees in the specified organization for the Compensation Review Process


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

Import Employee Award Request Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Compensation_Review_Event_Reference  Compensation_Review_EventObject  [1..1]  Compensation Review Event 
Validation Description
Please confirm the Compensation Review Process is in progress and Launch Awards Task is completed   
 
Employee_Award_Data  Employee_Award_Data__HV_  [0..*]  Employee Award Data   
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
 

Compensation_Review_EventObject

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

Compensation_Review_EventObjectID

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

Employee_Award_Data__HV_

part of: Import_Employee_Awards_Request
Employee Award Data
 
Parameter name Type/Value Cardinality Description Validations
Employee_Award_Identification  Employee_Award_Identification_Data  [0..1]  Employee Award Identification   
Employee_Award_Merit_Data  Employee_Award_Merit_Data__HV_  [0..1]  Employee Award Merit Data   
Employee_Award_Promotion_Data  Employee_Award_Promotion_Data__HV_  [0..1]  Employee Award Promotion Data   
Employee_Award_Additional_Adjustment_Data  Employee_Award_Additional_Adjustment_Data__HV_  [0..1]  Employee Award Additional Adjustment Data   
Employee_Award_Bonus_Data  Employee_Award_Bonus_Data__HV_  [0..*]  Employee Award Bonus Data   
Employee_Award_Lump_Sum_Data  Employee_Award_Lump_Sum_Data__HV_  [0..1]  Employee Award Lump Sum Data   
Employee_Award_Stock_Data  Employee_Award_Stock_Data__HV_  [0..*]  Employee Award Stock Data 
Validation Description
Stock Grant Amount cannot be empty   
 
top
 

Employee_Award_Identification_Data

part of: Employee_Award_Data__HV_
Employee Award Identification
 
Parameter name Type/Value Cardinality Description Validations
Employee_Reference  WorkerObject  [1..1]  Reference to an Employee 
Validation Description
Worker has more than one Employment. Please provide Position information   
 
Position_Reference  Position_ElementObject  [0..1]  Reference element representing a unique instance of a Position Element.   
top
 

WorkerObject

part of: Employee_Award_Identification_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: Employee_Award_Promotion_Data__HV_, Employee_Award_Identification_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
 

Employee_Award_Merit_Data__HV_

part of: Employee_Award_Data__HV_
Employee Award Merit Data
 
Parameter name Type/Value Cardinality Description Validations
Merit_Increase_Percent [Choice]   decimal (18, 6)   [0..1]  Increase Percent that will be applied in calculating a merit award amount 
Validation Description
Merit Increase proposed is less than Statutory Minimum   
 
Merit_Increase_Weighted_Percent [Choice]   decimal (18, 6)   [0..1]  The Factor that will be applied to the merit target in calculating a merit award amount 
Validation Description
Merit Increase proposed is less than Statutory Minimum   
 
Merit_New_Pay_Amount [Choice]   decimal (26, 6)   [0..1]  New pay for an employee in a currency amount 
Validation Description
Merit Increase proposed is less than Statutory Minimum   
 
Merit_Amount [Choice]   decimal (26, 6)   [0..1]  Merit increase in a currency amount 
Validation Description
Merit Increase proposed is less than Statutory Minimum   
 
Merit_Adjustment_Comment  string  [0..1]  Notes about a merit award   
top
 

Employee_Award_Promotion_Data__HV_

part of: Employee_Award_Data__HV_
Employee Award Promotion Data
 
Parameter name Type/Value Cardinality Description Validations
Promote  boolean  [0..1]  Promote flag indicating promotion   
Promotion_Amount [Choice]   decimal (26, 6)   [0..1]  Promotion increase amount in merit   
Promotion_New_Pay_Amount [Choice]   decimal (26, 6)   [0..1]  Promotion new pay amount in merit   
Promotion_Percent [Choice]   decimal (18, 6)   [0..1]  Promotion Percent in Merit   
Promotion_Reason_Reference  Event_Classification_SubcategoryObject  [0..1]  Promotion reason   
Compensation_Grade_Reference  Compensation_GradeObject  [0..1]  Compensation grade for a promotion in merit   
Grade_Profile_Reference  Compensation_Grade_ProfileObject  [0..1]  Grade profile for a promotion in merit   
Job_Profile_Reference  Job_ProfileObject  [0..1]  Job profile for a promotion in merit   
Position_Reference  Position_ElementObject  [0..1]  Reference to a new position for a promotion in merit   
Location_Reference  LocationObject  [0..1]  Location for promotion in merit   
Scheduled_Weekly_Hours  decimal (5, 2)   [0..1]  Scheduled weekly hours for promotion in merit   
Promotion_Notes  string  [0..1]  Promotion Comment   
Business_Title  string  [0..1]  Business Title   
Job_Title  string  [0..1]  Position Title current or from future fill   
Pay_Rate_Type_Reference  Pay_Rate_TypeObject  [0..1]  Pay Rate Type Reference   
Workspace_Reference  LocationObject  [0..1]  Workspace Reference   
top
 

Event_Classification_SubcategoryObject

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

Event_Classification_SubcategoryObjectID

part of: Event_Classification_SubcategoryObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Benefits_Event_Subcategory_ID, Change_Job_Subcategory_ID, End_Additional_Job_Subcategory_ID, Event_Classification_Subcategory_ID, General_Event_Subcategory_ID, Leave_of_Absence_Type_ID, Termination_Subcategory_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_GradeObject

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

Compensation_GradeObjectID

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

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

Compensation_Grade_ProfileObjectID

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

Job_ProfileObject

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

Job_ProfileObjectID

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

LocationObject

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

LocationObjectID

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

Pay_Rate_TypeObject

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

Pay_Rate_TypeObjectID

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

Employee_Award_Additional_Adjustment_Data__HV_

part of: Employee_Award_Data__HV_
Employee Award Additional Adjustment Data
 
Parameter name Type/Value Cardinality Description Validations
Additional_Adjustment_Percent [Choice]   decimal (18, 6)   [0..1]  Additional adjustment award in a percent   
Additional_Adjustment_Amount [Choice]   decimal (26, 6)   [0..1]  Additional adjustment award in a currency amount   
Additional_Adjustment_New_Pay_Amount [Choice]   decimal (26, 6)   [0..1]  New Pay Amount for Additional Adjustment in Adjustment Currency   
Additional_Adjustment_Notes  string  [0..1]  Additional Adjustment Notes   
Additional_Adjustment_Reason_Reference  Event_Classification_SubcategoryObject  [0..1]  Additional Adjustment Reason Reference   
top
 

Employee_Award_Bonus_Data__HV_

part of: Employee_Award_Data__HV_
Employee Award Bonus Data
 
Parameter name Type/Value Cardinality Description Validations
Bonus_Plan_Reference  Bonus_PlanObject  [0..1]  Bonus Plan   
Bonus_Percent [Choice]   decimal (18, 6)   [0..1]  Bonus Percent   
Bonus_Amount [Choice]   decimal (26, 6)   [0..1]  Bonus Amount   
Bonus_Factor_Percent [Choice]   decimal (18, 6)   [0..1]  Bonus Factor Percent   
Bonus_Notes  string  [0..1]  Bonus Notes   
top
 

Bonus_PlanObject

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

Employee_Award_Lump_Sum_Data__HV_

part of: Employee_Award_Data__HV_
Employee Award Lump Sum Data
 
Parameter name Type/Value Cardinality Description Validations
Lump_Sum_Percent [Choice]   decimal (18, 6)   [0..1]  Lump Sum Percent   
Lump_Sum_Amount [Choice]   decimal (42, 12)   [0..1]  Lump Sum Amount   
Lump_Sum_Notes  string  [0..1]  Lump Sum Notes   
top
 

Employee_Award_Stock_Data__HV_

part of: Employee_Award_Data__HV_
Employee Award Stock Data
 
Parameter name Type/Value Cardinality Description Validations
Stock_Plan_Reference  Stock_PlanObject  [1..1]  Stock Plan Reference 
Validation Description
This web service operation is supported for Stock award types only if the selected compensation review process includes a single pool for all stock categories (options and stock).   
 
Stock_Amount [Choice]   decimal (26, 6) >0   [1..1]  Stock Amount Awarded 
Validation Description
Amount cannot be negative.   
Amount may only be entered if the Stock Plan is either a Percent or Amount Plan.   
 
Stock_Units [Choice]   decimal (12, 0) >0   [1..1]  Stock Unit Awarded 
Validation Description
Number Of Units cannot be negative.   
Stock Units may only be entered if the Stock Plan is a Unit Plan.   
 
Stock_Percent [Choice]   decimal (24, 4) >0   [1..1]  Stock Percent Awarded 
Validation Description
Percent cannot be negative.   
Percent may only be entered if the Stock Plan is either a Percent or Amount Plan.   
 
Stock_Factor_Percent [Choice]   decimal (18, 6) >0   [1..1]  Stock Factor Awarded 
Validation Description
Percent cannot be negative.   
 
Stock_Notes  string  [0..1]  Stock Notes   
Validation Description
Stock Grant Amount cannot be empty   
top
 

Stock_PlanObject

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

Stock_PlanObjectID

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

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
 

Compensation_Review_EventReferenceEnumeration

part of: Compensation_Review_EventObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Position_ElementReferenceEnumeration

part of: Position_ElementObjectID
Base Type
string
top
 

Event_Classification_SubcategoryReferenceEnumeration

part of: Event_Classification_SubcategoryObjectID
Base Type
string
top
 

Compensation_GradeReferenceEnumeration

part of: Compensation_GradeObjectID
Base Type
string
top
 

Compensation_Grade_ProfileReferenceEnumeration

part of: Compensation_Grade_ProfileObjectID
Base Type
string
top
 

Job_ProfileReferenceEnumeration

part of: Job_ProfileObjectID
Base Type
string
top
 

LocationReferenceEnumeration

part of: LocationObjectID
Base Type
string
top
 

Pay_Rate_TypeReferenceEnumeration

part of: Pay_Rate_TypeObjectID
Base Type
string
top
 

Bonus_PlanReferenceEnumeration

part of: Bonus_PlanObjectID
Base Type
string
top
 

Stock_PlanReferenceEnumeration

part of: Stock_PlanObjectID
Base Type
string
top
 

Web_Service_Background_Process_RuntimeReferenceEnumeration

part of: Web_Service_Background_Process_RuntimeObjectID
Base Type
string
top