Service Directory > v31.2 > Compensation_Review > Import_Budget_Pools
 

Operation: Import_Budget_Pools

This operation updates budget pool and holdback information for the specified Supervisory Organizations for processes launched prior to Workday 29. Please use Import Compensation Review Budget Pools for 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_Budget_Pool_Request

Import Budget 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
Please confirm the Compensation Review Process is in progress and Manage Impacted Employees Task is completed   
This web service has been deprecated. Please use Compensation Review Maintain Pools task to modify pools.   
 
Supervisory_Organization_Pool_Data  Supervisory_Organization_Pool_Data__HV_  [0..*]  Pool Allocated for a Supervisory Organization   
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_Budget_Pool_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
 

Supervisory_Organization_Pool_Data__HV_

part of: Import_Budget_Pool_Request
Pool Allocated for a Supervisory Organization
 
Parameter name Type/Value Cardinality Description Validations
Organization_Reference  OrganizationObject  [1..1]  Organization   
Budget_Pool  Supervisory_Organization_Pool_Allocation__HV_  [0..*]  Pool Allocated for a Supervisory Organization   
Holdback  Supervisory_Organization_Holdback__HV_  [0..*]  Element holding the data regarding Supervisory Organization Pool and Holdback Units or Amounts. 
Validation Description
Unit Pool Holdback Value cannot be empty   
 
top
 

OrganizationObject

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

Supervisory_Organization_Pool_Allocation__HV_

part of: Supervisory_Organization_Pool_Data__HV_
Pool Allocated for a Supervisory Organization
 
Parameter name Type/Value Cardinality Description Validations
Compensation_Plan_Reference  Compensation_PlanObject  [1..1]  Plan Type 
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).   
 
Pool_Amount [Choice]   decimal (26, 6)   [0..1]  Pool Amount 
Validation Description
Amount cannot be negative.   
Pool Amount cannot be less than the Statutory Minimum Amount   
Amount may only be entered if the Stock Plan is either a Percent or Amount Plan.   
 
Unit_Pool_Allocated [Choice]   decimal (12, 0)   [0..1]  Unit Pool 
Validation Description
Number Of Units cannot be negative.   
Stock Units may only be entered if the Stock Plan is a Unit Plan.   
 
top
 

Compensation_PlanObject

part of: Supervisory_Organization_Pool_Allocation__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_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
 

Supervisory_Organization_Holdback__HV_

part of: Supervisory_Organization_Pool_Data__HV_
Supervisory Organization Holdback
 
Parameter name Type/Value Cardinality Description Validations
Award_Type_Reference  Award_TypeObject  [1..1]  Award Type 
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).   
 
Amount_Pool_Holdback [Choice]   decimal (26, 6)   [0..1]  Amount Pool Holdback 
Validation Description
Amount cannot be negative.   
Stock Holdback Amount may only be entered if the Stock Plan is an Amount or Percent Plan   
 
Unit_Pool_Holdback [Choice]   decimal (20, 0)   [0..1]  Supervisory Organization Unit Holdback 
Validation Description
Number Of Units cannot be negative.   
Stock Holdback Units may only be entered if the Stock Plan is a Unit Plan   
 
Validation Description
Unit Pool Holdback Value cannot be empty   
top
 

Award_TypeObject

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

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
 

Compensation_PlanReferenceEnumeration

part of: Compensation_PlanObjectID
Base Type
string
top
 

Award_TypeReferenceEnumeration

part of: Award_TypeObjectID
Base Type
string
top
 

Web_Service_Background_Process_RuntimeReferenceEnumeration

part of: Web_Service_Background_Process_RuntimeObjectID
Base Type
string
top