Service Directory > v31.2 > Compensation_Review > Get_Import_Compensation_Review_Budget_Pools
 

Operation: Get_Import_Compensation_Review_Budget_Pools

GET Import Comp Review Budget Pools for Single or multiple Organizations by Comp Review Event and Organization with or without including subordinate Organizations and or by Compensation Plan Type for use on compensation review processes after WD29


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

Get Import Compensation Review Pool Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  Compensation_Review_Process_Request_Criteria  [0..1]  Request Criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Compensation_Review_Process_Response_Group  [0..1]  Response Group   
top
 

Response Element: Get_Import_Compensation_Review_Budget_Pools_Response

Response for Get of Review Pools
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  Compensation_Review_Process_Request_Criteria  [0..1]  Request Criteria (ignore)   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Compensation_Review_Process_Response_Group  [0..1]  Response Group   
Response_Results  Response_Results  [0..1]  Response Result   
Response_Data  Imported_Compensation_Review_Pools_Response_Data  [0..1]  Response Data   
top
 

Compensation_Review_Process_Request_Criteria

part of: Get_Import_Compensation_Review_Budget_Pools_Request, Get_Import_Compensation_Review_Budget_Pools_Response
Response showing existing pool values
 
Parameter name Type/Value Cardinality Description Validations
Compensation_Review_Event_Reference  Compensation_Review_EventObject  [1..1]  Compensation Review Event for which pools are to be retrieved.   
Organization_and_Subordinates  Organization_and_Subordinates  [0..*]  Supervisory Organizations with SubOrdinates   
Award_Type_Reference  Award_TypeObject  [0..1]  Award Type   
top
 

Compensation_Review_EventObject

part of: Compensation_Review_Process_Request_Criteria, Imported_Compensation_Review_Pools
 
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_and_Subordinates

part of: Compensation_Review_Process_Request_Criteria
Organization and Subordinates Element
 
Parameter name Type/Value Cardinality Description Validations
Organization_Reference  OrganizationObject  [0..*]  Organization   
Include_Subordinate_Organizations  boolean  [0..1]  Include Subordinate Organizations flag   
top
 

OrganizationObject

part of: Organization_Pool_Data, Organization_Pool_Data, Organization_and_Subordinates
 
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
 

Award_TypeObject

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

Response_Filter

part of: Get_Import_Compensation_Review_Budget_Pools_Request, Get_Import_Compensation_Review_Budget_Pools_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
 

Compensation_Review_Process_Response_Group

part of: Get_Import_Compensation_Review_Budget_Pools_Request, Get_Import_Compensation_Review_Budget_Pools_Response
Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Compensation Review Event in output. Recommend to say Yes.   
top
 

Response_Results

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

Imported_Compensation_Review_Pools_Response_Data

part of: Get_Import_Compensation_Review_Budget_Pools_Response
Compensation Review Pools for each Organization by Award Type and by Compensation Plan
 
Parameter name Type/Value Cardinality Description Validations
Compensation_Review_Process  Imported_Compensation_Review_Pools  [0..*]  Compensation Review Pools for each Organization by Award Type and by Compensation Plan   
top
 

Imported_Compensation_Review_Pools

part of: Imported_Compensation_Review_Pools_Response_Data
Response Data
 
Parameter name Type/Value Cardinality Description Validations
Compensation_Review_Event_Reference  Compensation_Review_EventObject  [1..1]  Compensation Review Event   
Update_All_Organizations  boolean  [0..1]  Always set to Y (for now).   
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.   
 
top
 

Organization_Pool_Data

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

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
 

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
 

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