Service Directory > v31.2 > Compensation_Review > Get_Budget_Pools
 

Operation: Get_Budget_Pools

GET Budget Pools for Single or multiple Organizations by Comp Review Event and Supervisory Organizations with or without including subordinate Organizations and or by Compensation Plan Type


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

Request to retrieve Organization Budget Pool data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  Budget_Pools_Request_Criteria  [0..1]  Request to retrieve Organization Budget Pool data   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Budget_Pools_Response_Group  [0..1]  Budget Pool Response Group   
top
 

Response Element: Get_Budget_Pools_Response

Response Element holding the Budget Pools Data of Organizations for a Compensation Review Event
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  Budget_Pools_Request_Criteria  [0..1]  Budget Pools Request Criteria   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Budget_Pools_Response_Group  [0..1]  Budget Pools Response Group   
Response_Results  Response_Results  [0..1]  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.   
Response_Data  Budget_Pools_Response_Data  [0..1]  Budget Pool Response Data   
top
 

Budget_Pools_Request_Criteria

part of: Get_Budget_Pools_Request, Get_Budget_Pools_Response
Budget Pools Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
Compensation_Review_Event_Reference  Compensation_Review_EventObject  [1..1]  Compensation Review Event 
Validation Description
Please confirm that 'Manage Impacted Employees' task is completed for the process   
 
Supervisory_Organization_and_Subordinates  Supervisory_Organization_and_Subordinates  [0..*]  Supervisory Organizations with SubOrdinates   
Award_Type_Reference  Award_TypeObject  [0..1]  Award Type   
top
 

Compensation_Review_EventObject

part of: Budget_Pools_Request_Criteria, Budget_Pools_Response_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_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_and_Subordinates

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

OrganizationObject

part of: Supervisory_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: Budget_Pools_Request_Criteria
 
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_Budget_Pools_Request, Get_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
 

Budget_Pools_Response_Group

part of: Get_Budget_Pools_Request, Get_Budget_Pools_Response
Budget Pools Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

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

Budget_Pools_Response_Data

part of: Get_Budget_Pools_Response
Budget Pool Response Data
 
Parameter name Type/Value Cardinality Description Validations
Compensation_Review_Event_Reference  Compensation_Review_EventObject  [0..1]  Compensation Review Event   
Supervisory_Organization_Pool_Data  Supervisory_Organization_Pool_Data  [0..*]  Budget Pool Data   
top
 

Supervisory_Organization_Pool_Data

part of: Budget_Pools_Response_Data
Budget Pool Response Data
 
Parameter name Type/Value Cardinality Description Validations
Supervisory_Organization_Reference  Supervisory_OrganizationObject  [0..1]  Supervisory Organization   
Budget_Pool  Supervisory_Organization_Pool_Allocation  [0..*]  Supervisory Organization Allocation   
Holdback  Supervisory_Organization_Holdback  [0..*]  Supervisory Organization Holdback   
top
 

Supervisory_OrganizationObject

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

Supervisory_OrganizationObjectID

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

part of: Supervisory_Organization_Pool_Data
Pool Allocated for a Supervisory Organization
 
Parameter name Type/Value Cardinality Description Validations
Supervisory_Organization_Allocation_Reference  Unique_IdentifierObject  [0..1]  Supervisory Org Allocation   
Compensation_Plan_Reference  Compensation_PlanObject  [0..1]  Compensation Plan   
Pool_Amount  decimal (26, 6)   [0..1]  Pool Amount   
top
 

Unique_IdentifierObject

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

Unique_IdentifierObjectID

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

part of: Supervisory_Organization_Pool_Data
Supervisory Organization Holdback
 
Parameter name Type/Value Cardinality Description Validations
Award_Type  string  [0..1]  The name of the Award Type for the Holdback   
Holdback_Amount  decimal (26, 6)   [0..1]  Amount Pool Holdback   
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
 

Supervisory_OrganizationReferenceEnumeration

part of: Supervisory_OrganizationObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

Compensation_PlanReferenceEnumeration

part of: Compensation_PlanObjectID
Base Type
string
top