Service Directory > v32.1 > Compensation_Review > Import_Compensation_Review_Budget_Pools
 

Operation: Import_Compensation_Review_Budget_Pools

This operation updates budget pool, holdback, and reserve information for all Supervisory Organizations in processes launched after Workday 29.


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

Import Compensation Review Pool Request
 
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
An Import Compensation Review Budget Pool web service has not completed for this Compensation Review Process.   
Please confirm the Compensation Review Process is in progress and Manage Impacted Employees Task is completed   
Please confirm the Compensation Review Process uses Employee Level Pools.   
There is a current Compensation Review Maintain Pools session open. Please submit the session prior to using this Web Service.   
There is a current Bonus Pool and Award Recalculation session open. Please submit the session prior to using this Web Service.   
This web service is only available after Configure Pools Step.   
 
Update_All_Organizations  boolean  [0..1]  Note: Select Y if all organizations in the process will be updated. This will replace all pools, holdbacks, and adjustments accordingly with the entered values (and all blanks are equal to 0). If N is selected, neither the organizations in the web service nor their superior organizations can have any organization adjustments such as Pool Reserves or Holdbacks. A blank entry when this is set to N will NOT replace the current field with 0.   
Organization_Pool_Data  Organization_Pool_Data  [0..*]  Organization Pool Data 
Validation Description
For each organization in the process, duplicate award type is not allowed.   
For each organization in the process, duplicate plan row is not allowed.   
 
Validation Description
For each organization in the process, only one org row is allowed.   
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_Compensation_Review_Budget_Pools_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
 

Organization_Pool_Data

part of: Import_Compensation_Review_Budget_Pools_Request
Organization Pool Data
 
Parameter name Type/Value Cardinality Description Validations
Organization_Reference  OrganizationObject  [1..1]  Organization Reference 
Validation Description
This organization ([org name]) is not in the process   
 
Apply_Holdbacks_to_this_Organization_Reference  OrganizationObject  [0..1]  The organization to which the holdbacks from this organization pools are applied. 
Validation Description
Apply Holdbacks to Organization must be a superior of the Organization   
 
Budget_Pools  Budget_Pool_Data  [0..*]  Budget Pool Data 
Validation Description
Unit-based Plans cannot use Amount field.   
Stock Units may only be entered if the Stock Plan is a Unit Plan.   
 
Other_Pools  Other_Pool_Data  [0..*]  Other Pools   
Validation Description
For each organization in the process, duplicate award type is not allowed.   
For each organization in the process, duplicate plan row is not allowed.   
top
 

OrganizationObject

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

OrganizationObjectID

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

Budget_Pool_Data

part of: Organization_Pool_Data
Budget Pool Data
 
Parameter name Type/Value Cardinality Description Validations
Award_Type_Reference  Award_TypeObject  [0..1]  Award type for a compensation plan   
Compensation_Plan_Reference  Compensation_PlanObject  [1..1]  Compensation Plan Reference 
Validation Description
[plan] was not configured. Please remove.   
The organization ([org]) has an impactful holdback applied ([awardType]/[compensationPlan]). Please add all organizations to the integration, or use Maintain Pools to adjust the organization.   
 
Pool_Amount [Choice]   decimal (18, 6)   [0..1]  The total of employee contributions distributed to this organization. This number represents the pool regardless without holdbacks taken or applied. 
Validation Description
Unit-based Plans cannot use Amount field.   
Pool cannot be negative.   
 
Unit_Pool_Allocated [Choice]   decimal (12, 0)   [0..1]  The total stock units of employee contributions distributed to this organization. This number represents the pool regardless without holdbacks taken or applied. 
Validation Description
Pool cannot be negative.   
 
Remove_Pool_Amount_for_Holdback [Choice]   decimal (18, 6)   [0..1]  The amount of the pool to be removed and placed as a holdback on the specified organization. 
Validation Description
The holdback cannot be more than organization's available pool   
Apply Holdbacks to Organization must be a superior of the Organization   
Holdbacks were included in the web service prior to the Distribute Pools step. Please remove any holdbacks.   
Holdback cannot be negative.   
Holdbacks are not allowed in this process. Please relaunch process and check Allow Holdbacks during Configure Pools.   
 
Remove_Pool_Units_for_Holdback [Choice]   decimal (12, 0)   [0..1]  The pool to be removed and placed as a holdback on the specified organization. 
Validation Description
The holdback cannot be more than organization's available pool   
Holdbacks were included in the web service prior to the Distribute Pools step. Please remove any holdbacks.   
Holdback cannot be negative.   
Holdbacks are not allowed in this process. Please relaunch process and check Allow Holdbacks during Configure Pools.   
Apply Holdbacks to Organization must be a superior of the Organization   
 
Add_Pool_Amount_for_Reserve [Choice]   decimal (18, 6)   [0..1]  The additional reserve amount to be added to this organization and plan's pool. 
Validation Description
Reserve cannot be negative.   
 
Add_Pool_Units_for_Reserve [Choice]   decimal (12, 0)   [0..1]  The additional reserve amount to be added to this organization and plan's pool. 
Validation Description
Stock Units may only be entered if the Stock Plan is a Unit Plan.   
Reserve cannot be negative.   
 
Validation Description
Unit-based Plans cannot use Amount field.   
Stock Units may only be entered if the Stock Plan is a Unit Plan.   
top
 

Award_TypeObject

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

Award_TypeObjectID

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

Compensation_PlanObject

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

Compensation_PlanObjectID

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

Other_Pool_Data

part of: Organization_Pool_Data
Other Pools
 
Parameter name Type/Value Cardinality Description Validations
Award_Type_Reference  Award_TypeObject  [1..1]  This contains "Additional Adjustment","Promotion", "Allowance" and "Lump Sum." 
Validation Description
[award type] was not configured. Please remove.   
The organization ([org]) has an impactful holdback applied ([awardType]). Please add all organizations to the integration, or use Maintain Pools to adjust the organization.   
 
Pool_Amount  decimal (18, 6)   [0..1]  The total pool distributed to this organization for this award type. This number represents the total pool before holdbacks are removed. 
Validation Description
Pool cannot be negative.   
 
Remove_Pool_Amount_for_Holdback  decimal (18, 6)   [0..1]  The amount of this award type's pool to be removed and placed as a holdback on the specified organization. 
Validation Description
Holdback cannot be negative.   
Holdbacks are not allowed in this process. Please relaunch process and check Allow Holdbacks during Configure Pools.   
Holdbacks were included in the web service prior to the Distribute Pools step. Please remove any holdbacks.   
The holdback cannot be more than organization's available pool   
Apply Holdbacks to Organization must be a superior of the Organization   
 
Add_Pool_Amount_for_Reserve  decimal (18, 6)   [0..1]  The additional reserve amount to be added to this organization's pool for this award type. 
Validation Description
Reserve cannot be negative.   
 
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
 

OrganizationReferenceEnumeration

part of: OrganizationObjectID
Base Type
string
top
 

Award_TypeReferenceEnumeration

part of: Award_TypeObjectID
Base Type
string
top
 

Compensation_PlanReferenceEnumeration

part of: Compensation_PlanObjectID
Base Type
string
top
 

Web_Service_Background_Process_RuntimeReferenceEnumeration

part of: Web_Service_Background_Process_RuntimeObjectID
Base Type
string
top