Service Directory > v31.2 > Workforce_Planning > Get_Headcount_Plan_Templates__Do_Not_Use_
 

Operation: Get_Headcount_Plan_Templates__Do_Not_Use_

Returns the Headcount Plan Templates based on criteria specified.


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

Top element that contains information for get headcount plan templates.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Headcount_Plan_Template_Request_References  [0..1]  References to headcount plan templates. 
Validation Description
The following headcount plan template(s) are inactive: [inactive]. You cannot submit a request for an inactive headcount plan template.   
 
Request_Criteria  Headcount_Plan_Template_Request_Criteria  [0..1]  Criteria you can specify on how to retrieve headcount plan templates.   
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. 
 
top
 

Response Element: Get_Headcount_Plan_Templates_Response

Top element that contains response elements for get headcount plan templates.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Headcount_Plan_Template_Request_References  [0..1]  This element contains references to headcount plan templates. 
Validation Description
The following headcount plan template(s) are inactive: [inactive]. You cannot submit a request for an inactive headcount plan template.   
 
Request_Criteria  Headcount_Plan_Template_Request_Criteria  [0..1]  Contains criteria that you can specify in order to filter the headcount plan templates returned.   
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_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  Headcount_Plan_Template_Response_Data  [0..1]  Element that contains headcount plan template element.   
top
 

Headcount_Plan_Template_Request_References

part of: Get_Headcount_Plan_Templates_Request, Get_Headcount_Plan_Templates_Response
This element contains references to headcount plan templates.
 
Parameter name Type/Value Cardinality Description Validations
Headcount_Plan_Template_Reference  Headcount_Plan_TemplateObject  [1..*]  References to headcount plan templates.   
Validation Description
The following headcount plan template(s) are inactive: [inactive]. You cannot submit a request for an inactive headcount plan template.   
top
 

Headcount_Plan_TemplateObject

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

Headcount_Plan_TemplateObjectID

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

Headcount_Plan_Template_Request_Criteria

part of: Get_Headcount_Plan_Templates_Request, Get_Headcount_Plan_Templates_Response
Contains criteria that you can specify in order to filter the headcount plan templates returned.
 
Parameter name Type/Value Cardinality Description Validations
Organization_Reference  OrganizationObject  [0..*]  Reference for the top level organization that owns the headcount plan template   
Include_Subordinate_Organizations  boolean  [0..1]  When this boolean value is set to true, indicates to include all subordinate organizations to the Organization Reference in the response.   
top
 

OrganizationObject

part of: Headcount_Plan_Template_Request_Criteria, Headcount_Plan_Template_Data, Organization_Management_Data, Organizations_to_Exclude_Data, Headcount_Plan_Dimension_Restriction_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
 

Response_Filter

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

Response_Results

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

Headcount_Plan_Template_Response_Data

part of: Get_Headcount_Plan_Templates_Response
Element that contains headcount plan template element.
 
Parameter name Type/Value Cardinality Description Validations
Headcount_Plan_Template  Headcount_Plan_Template  [0..*]  Element that contains the Headcount Plan Template information.   
top
 

Headcount_Plan_Template

part of: Headcount_Plan_Template_Response_Data
Response element that contains headcount plan template.
 
Parameter name Type/Value Cardinality Description Validations
Headcount_Plan_Template_Reference  Headcount_Plan_TemplateObject  [0..1]  Reference to headcount plan template.   
Headcount_Plan_Template_Data  Headcount_Plan_Template_Data  [1..1]  Element that contains the Headcount Plan Template information. 
Validation Description
Pre-population information is not allowed for this Headcount Plan Template.   
Select a different Headcount Plan Structure or create a new one. [headcount plan structure] is already in use. You can only attach a headcount plan structure to 1 headcount plan template if it's linked to a financial budget.   
Select an active Top Level Organization.   
The current number of headcount plan periods ([number]) exceeds the maximum of 36. Reduce the number of periods by selecting a shorter custom time frame.   
Select a top level organization that isn't a [org type]. The headcount plan structure already includes [dim] as a dimension. Alternatively, select a headcount plan structure that doesn't use [dim] as a dimension.   
 
top
 

Headcount_Plan_Template_Data

part of: Headcount_Plan_Template
Element that contains the Headcount Plan Template information.
 
Parameter name Type/Value Cardinality Description Validations
Headcount_Plan_Template_ID  string  [0..1]  Reference to headcount plan template.   
Headcount_Plan_Template_Name  string  [0..1]  Name used to identify headcount plan template. 
Validation Description
Headcount Plan Template Name is Required if Add Only is True.  Headcount Plan Template Name is Required if Add Only is True. 
Enter a unique Name. The name [name] is already in use.   
 
Headcount_Plan_Structure_Reference  Headcount_Plan_StructureObject  [0..1]  Reference to the headcount plan structure associated with the headcount plan template. 
Validation Description
Headcount Plan Structure is Required if Add Only is True.   
 
Top_Level_Organization_Reference  OrganizationObject  [0..1]  Reference to the top level organization that drives the headcount plan template. 
Validation Description
Top Level Organization is Required if Add Only is True.  Top Level Organization is Required if Add Only is True. 
Select a Top Level Organization that has an Organization Type that is allowed for a Headcount Plan.  Validation that restricts Headcount Plan Template creation to allowable driving organization types. 
 
Additional_Organizational_Levels_in_Plan  decimal (12, 0) >0   [0..1]  Number of levels is used to identify how many subordinate supervisory organizations will be included in the headcount plan template.   
Organizations_Effective_As_Of_Date  date  [0..1]  Date used to determine the organizations to plan for that are effective as of the date selected. 
Validation Description
Organization Effective As Of Date is Required if Add Only is True.  Organization Effective As Of Date is Required if Add Only is True. 
 
Start_Year_Reference  Fiscal_YearObject  [0..1]  The first fiscal year for the Headcount Plan Template. 
Validation Description
Start Year is Required if Add Only is True.   
Start Year [start year] must be a valid year for Schedule [schedule]   
You must choose an earlier Fiscal Year; The ending Fiscal Year with the one you specified is unavailable   
 
Start_Period_Reference  Fiscal_Time_IntervalObject  [0..1]  The first period for the Headcount Plan Template with a custom entry period. 
Validation Description
Start Period is Required if Add Only is True and Custom Entry Period is True for the Headcount Plan Structure Reference.   
Start Period is should not be provided if Custom Entry Period is False for the Headcount Plan Structure for this Headcount Plan Template.   
Start Period [Fiscal Period or Summary Interval Start] must be valid for Schedule [schedule].   
 
End_Year_Reference  Fiscal_YearObject  [0..1]  The end fiscal year for the Headcount Plan Template. 
Validation Description
End Year should not be provided if Custom Entry Period is False for the Headcount Plan Structure for this Headcount Plan Template.   
End Year is Required if Custom Entry Period is True for the Headcount Plan Structure for this Headcount Plan Template.   
Custom End Year must be equal to or after Custom Start Year.   
Custom End Year [end year] must be a valid year for Schedule [schedule]   
 
End_Period_Reference  Fiscal_Time_IntervalObject  [0..1]  The end period for the Headcount Plan Template. 
Validation Description
End Period is Required if Add Only is True and Custom Entry Period is True for the Headcount Plan Structure Reference.   
End Period is should not be provided if Custom Entry Period is False for the Headcount Plan Structure for this Headcount Plan Template.   
Entry Period End must be after Entry Period Start if Start Year equals End Year.   
End Period [Fiscal Period or Summary Interval End] must be valid for Schedule [schedule].   
 
Pre-Population_Data  Pre-Population_Data  [0..1]  Element that contains pre-population information for a headcount plan template. 
Validation Description
A Baseline Date is required if Include Baseline Column is selected.   
A Baseline Date is required if Populate with Existing Dimensions is selected.   
A Baseline Date is required if Populate with Actual Headcount is selected.   
A Baseline Date is required if Populate with Actual FTE is selected.   
Populate with Existing Dimensions is not allowed for a Headcount Plan Structure with no Dimensions.   
Populate with Actual FTE requires Populate with Existing Dimensions unless the Headcount Plan Structure does not include any dimensions.   
Populate with Actual Headcount requires Populate with Existing Dimensions unless the Headcount Plan Structure does not include any dimensions.   
 
Headcount_Plan_Filter_Data  Headcount_Plan_Filter_Data  [0..*]  Element that contains filter information. 
Validation Description
Headcount Plan Filter Detail Data should not be provided if Delete is True.   
Headcount Plan Filter Detail Data is Required if Delete is False.   
You can only check either "Add Only" or "Delete" flag.   
[dimension] can only be used for one Headcount Plan Filter Data Element.   
[dimension] is not valid for headcount plan filtering.   
You can't filter by cost center because your top-level organization is a cost center.   
 
Organization_Management_Data  Organization_Management_Data  [0..*]  Element that contains the Organization Management 
Validation Description
[element] is Required if Delete is False.   
[element] should not be provided if Delete is True.   
You can only check either "Add Only" or "Delete" flag.  You can only check either "Add Only" or "Delete" 
[organization] cannot be used for more than one [element] Element.   
[organization] is invalid for dimension management because it not part of the included organizations for this headcount plan template.   
 
Organizations_to_Exclude_Data  Organizations_to_Exclude_Data  [0..*]  Element that contains the organizations to exclude data. 
Validation Description
Organizations to Exclude Detail Data should not be provided if Delete is True.   
You can only check either "Add Only" or "Delete" flag.  You can only check either "Add Only" or "Delete" 
[organization] cannot be used for more than one Organizations to Exclude Data Element.   
Organizations to Exclude Detail Data is Required if Delete is False.   
[organization] is invalid to be excluded because it not part of the included organizations for this headcount plan.   
 
Headcount_Plan_Dimension_Management_Data  Headcount_Plan_Dimension_Management_Data  [0..*]  Element that contains dimension management 
Validation Description
[dimension] can be used for only one Headcount Plan Dimension Management Data Element.   
 
Validation Description
Pre-population information is not allowed for this Headcount Plan Template.   
Select a different Headcount Plan Structure or create a new one. [headcount plan structure] is already in use. You can only attach a headcount plan structure to 1 headcount plan template if it's linked to a financial budget.   
Select an active Top Level Organization.   
The current number of headcount plan periods ([number]) exceeds the maximum of 36. Reduce the number of periods by selecting a shorter custom time frame.   
Select a top level organization that isn't a [org type]. The headcount plan structure already includes [dim] as a dimension. Alternatively, select a headcount plan structure that doesn't use [dim] as a dimension.   
top
 

Headcount_Plan_StructureObject

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

Headcount_Plan_StructureObjectID

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

Fiscal_YearObject

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

Fiscal_YearObjectID

part of: Fiscal_YearObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Fiscal_Year_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".   
@parent_id  string  [1..1]  Contains a unique identifier for an instance of a parent object   
@parent_type  WID, Fiscal_Schedule_ID  [1..1]  The unique identifier type of a parent object   
top
 

Fiscal_Time_IntervalObject

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

Fiscal_Time_IntervalObjectID

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

Pre-Population_Data

part of: Headcount_Plan_Template_Data
Element containing headcount plan template pre-population information.
 
Parameter name Type/Value Cardinality Description Validations
Populate_with_Existing_Dimensions  boolean  [0..1]  Specifies that a headcount plan template will be pre-populated with existing dimensions.   
Populate_with_Actual_Headcount  boolean  [0..1]  Specifies that this headcount plan template should pre-populate the planned headcount with existing values.   
Populate_with_Actual_FTE  boolean  [0..1]  Specifies that this headcount plan template should pre-populate planned FTE with existing values.   
Baseline_Date  date  [0..1]  Specifies the date for which to calculate existing values for headcount plan pre-population.   
Include_Baseline_Column  boolean  [0..1]  Specifies a reference column should be included to show what the existing values for headcount and FTE were at the baseline date.   
Validation Description
A Baseline Date is required if Include Baseline Column is selected.   
A Baseline Date is required if Populate with Existing Dimensions is selected.   
A Baseline Date is required if Populate with Actual Headcount is selected.   
A Baseline Date is required if Populate with Actual FTE is selected.   
Populate with Existing Dimensions is not allowed for a Headcount Plan Structure with no Dimensions.   
Populate with Actual FTE requires Populate with Existing Dimensions unless the Headcount Plan Structure does not include any dimensions.   
Populate with Actual Headcount requires Populate with Existing Dimensions unless the Headcount Plan Structure does not include any dimensions.   
top
 

Headcount_Plan_Filter_Data

part of: Headcount_Plan_Template_Data
Element that contains filter information.
 
Parameter name Type/Value Cardinality Description Validations
@Add_Only  boolean  [1..1]  Add Only Flag. Indicates that the service is an add only, not an update. 
Validation Description
All Filters must be Add Only because this Headcount Plan Template is Add Only.   
 
@Delete  boolean  [1..1]  Flag indicating that the referenced data should be deleted.   
Dimension_Reference  Worktag_and_Aggregation_TypeObject  [1..1]  Reference to the filtering dimension. 
Validation Description
[dimension] already exists as a filter for this Headcount Plan Template so Add Only cannot be True.   
[dimension] is not an existing filter so Add Only must be True.   
 
Headcount_Plan_Filter_Detail_Data  Headcount_Plan_Filter_Detail_Data  [0..1]  Element that contains filter detail information.   
Validation Description
Headcount Plan Filter Detail Data should not be provided if Delete is True.   
Headcount Plan Filter Detail Data is Required if Delete is False.   
You can only check either "Add Only" or "Delete" flag.   
[dimension] can only be used for one Headcount Plan Filter Data Element.   
[dimension] is not valid for headcount plan filtering.   
You can't filter by cost center because your top-level organization is a cost center.   
top
 

Worktag_and_Aggregation_TypeObject

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

Worktag_and_Aggregation_TypeObjectID

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

Headcount_Plan_Filter_Detail_Data

part of: Headcount_Plan_Filter_Data
Element that contains filter detail information.
 
Parameter name Type/Value Cardinality Description Validations
Worktag_Reference  Accounting_Worktag_and_Aggregation_DimensionObject  [1..*]  Reference to Worktags for the filtering dimension. 
Validation Description
The following worktags are not valid for [dimension] filter dimension: [worktags].   
 
top
 

Accounting_Worktag_and_Aggregation_DimensionObject

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

Accounting_Worktag_and_Aggregation_DimensionObjectID

part of: Accounting_Worktag_and_Aggregation_DimensionObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Academic_Level_ID, Academic_Period_ID, Academic_Person_ID, Academic_Unit_ID, Ad_hoc_Payee_ID, Applicant_ID, Asset_Adjustment_Reason_Reference_ID, Asset_Adjustment_Type_Reference_ID, Asset_Impairment_Reason_ID, Bank_Account_ID, Business_Asset_Cost_Adjustment_Reason_ID, Business_Unit_Hierarchy_ID, Business_Unit_ID, Calculation_Compensation_Basis_ID, Cash_Activity_Category_ID, Catalog_Item_ID, Company_Reference_ID, Compensation_Basis_ID, Compensation_Grade_ID, Contingent_Worker_ID, Contingent_Worker_Type_ID, Corporate_Credit_Card_Account_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Custom_Worktag_06_ID, Custom_Worktag_07_ID, Custom_Worktag_08_ID, Custom_Worktag_09_ID, Custom_Worktag_1_ID, Custom_Worktag_10_ID, Custom_Worktag_11_ID, Custom_Worktag_12_ID, Custom_Worktag_13_ID, Custom_Worktag_14_ID, Custom_Worktag_15_ID, Custom_Worktag_2_ID, Custom_Worktag_3_ID, Custom_Worktag_4_ID, Custom_Worktag_5_ID, Customer_Category_ID, Customer_Contract_Alternate_Reference_ID, Customer_Contract_Reference_ID, Customer_Group_ID, Customer_ID, Customer_Reference_ID, Deduction_Code, Deduction_Recipient_ID, Donor_ID, Earning_Code, Employee_ID, Employee_Type_ID, Ethnicity_ID, Expense_Item_Group_ID, Expense_Item_ID, External_Committee_Member_ID, Financial_Aid_Award_Year_ID, Financial_Institution_ID, Financial_Institution_Reference_ID, Fund_Hierarchy_ID, Fund_ID, Funding_Source_Name, Gender_Code, Gift_Hierarchy_ID, Gift_Reference_ID, Grant_Hierarchy_ID, Grant_ID, Internal_Service_Provider_ID, Internal_Service_Provider_Reference_ID, Investment_Pool_ID, Investment_Profile_ID, Investor_ID, Is_Manager_ID, Is_People_Manager, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_Code, Job_Category_ID, Job_Family_Group_ID, Job_Family_ID, Job_Level_ID, Job_Profile_ID, Job_Requisition_ID, Loan_ID, Location_ID, Management_Level_ID, NI_Category_Letter, Object_Class_ID, Opportunity_Reference_ID, Organization_Reference_ID, Pay_Rate_Type_ID, Payroll_Federal_Authority_Tax_Code, Payroll_Income_Code, Payroll_Local_City_Authority_Tax_Code, Payroll_Local_County_Authority_Tax_Code, Payroll_Local_Other_Authority_Tax_Code, Payroll_Local_School_District_Authority_Tax_Code, Payroll_State_Authority_Tax_Code, Petty_Cash_Account_ID, Position_ID, Position_Time_Type_ID, Program_Hierarchy_ID, Program_ID, Program_of_Study_ID, Project_Hierarchy_ID, Project_ID, Project_Plan_ID, Proposal_Grant_ID, Prospect_ID, Prospect_Reference_ID, Purchase_Item_Group_ID, Purchase_Item_ID, Receivable_Writeoff_Reason_ID, Region_Reference_ID, Resource_Category_Hierarchy_ID, Revenue_Category_Hierarchy_ID, Revenue_Category_ID, Rubric_Value_ID, Run_Category_ID, Salary_Over_The_Cap_Type_ID, Sales_Item_Group_ID, Sales_Item_ID, Spend_Category_ID, Sponsor_ID, Sponsor_Reference_ID, Sponsor_Type_ID, Student_Application_Residency_Status_ID, Student_Award_Item_ID, Student_Charge_Item_ID, Student_Course_ID, Student_Course_Section_ID, Student_ID, Student_Recruiting_Campaign_ID, Student_Recruiting_Event_ID, Student_Sponsor_Contract_ID, Student_Waiver_Item_ID, Supplier_Category_ID, Supplier_Contract_ID, Supplier_Group_ID, Supplier_ID, Supplier_Reference_ID, Tax_Applicability_ID, Tax_Authority_ID, Tax_Authority_Reference_ID, Tax_Category_ID, Tax_Code_ID, Tax_Point_Date_Type_ID, Tax_Rate_ID, Tax_Recoverability_Object_ID, Third_Party_ID, Withholding_Order_Case_ID, Withholding_Tax_Code_ID, Withholding_Tax_Rate_ID, Work_Function_ID, Work_Shift_ID, Workday_Deduction_Code, Workday_Earning_Code, Worker_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
 

Organization_Management_Data

part of: Headcount_Plan_Template_Data
Element that contains the Additional Levels for a Supervisory Organizations information.
 
Parameter name Type/Value Cardinality Description Validations
@Add_Only  boolean  [1..1]  Add Only Flag. Indicates that the service is an add only, not an update.   
@Delete  boolean  [1..1]  Flag indicating that the referenced data should be deleted.   
Organization_Reference  OrganizationObject  [1..1]  Reference to the Organization in the plan with organization management data. 
Validation Description
Delete cannot be true for [organization] because this Organization does not have an existing row for Headcount Plan Organization Management.   
Add Only cannot be true for [organization] for Headcount Plan Organization Management Data because this organization already has a row for Organization Management Data.   
 
Organization_Management_Detail_Data  Organization_Management_Detail_Data  [0..*]  Element that contains the organization management detail data.   
Validation Description
[element] is Required if Delete is False.   
[element] should not be provided if Delete is True.   
You can only check either "Add Only" or "Delete" flag.  You can only check either "Add Only" or "Delete" 
[organization] cannot be used for more than one [element] Element.   
[organization] is invalid for dimension management because it not part of the included organizations for this headcount plan template.   
top
 

Organization_Management_Detail_Data

part of: Organization_Management_Data
Element that contains the Additional organizational levels for the Supervisory Organization reference.
 
Parameter name Type/Value Cardinality Description Validations
Additional_Organizational_Levels [Choice]   decimal (12, 0) >0   [1..1]  Additional organizational levels for the Organization reference. 
Validation Description
[organization] cannot have Additional Organizational Levels because it does not have children.   
 
Organization_Type_Reference [Choice]   Organization_TypeObject  [1..1]  Reference to the organization type to plan by for the organization reference. 
Validation Description
[organization] cannot have an Organization Type selected.   
Select a valid Organization Type for [organization].   
 
top
 

Organization_TypeObject

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

Organization_TypeObjectID

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

Organizations_to_Exclude_Data

part of: Headcount_Plan_Template_Data
Element that contains the Supervisory Organizations to Exclude information.
 
Parameter name Type/Value Cardinality Description Validations
@Add_Only  boolean  [1..1]  Add Only Flag. Indicates that the service is an add only, not an update.   
@Delete  boolean  [1..1]  Flag indicating that the referenced data should be deleted.   
Organization_Reference  OrganizationObject  [1..1]  Reference to the Organization to be excluded. 
Validation Description
Delete cannot be true for [organization] because this Organization does not have an existing row for Organizations to Exclude Data.   
Add Only cannot be true for [organization] for Organizations to Exclude Data because this organization already has a row for Organizations to Exclude Data   
 
Organizations_to_Exclude_Detail_Data  Organizations_to_Exclude_Detail_Data  [0..*]  Element that includes the option to promote or exclude subordinate organizations   
Validation Description
Organizations to Exclude Detail Data should not be provided if Delete is True.   
You can only check either "Add Only" or "Delete" flag.  You can only check either "Add Only" or "Delete" 
[organization] cannot be used for more than one Organizations to Exclude Data Element.   
Organizations to Exclude Detail Data is Required if Delete is False.   
[organization] is invalid to be excluded because it not part of the included organizations for this headcount plan.   
top
 

Organizations_to_Exclude_Detail_Data

part of: Organizations_to_Exclude_Data
Element that includes the option to also exclude Subordinate Organizations of the Supervisory Organization Reference.
 
Parameter name Type/Value Cardinality Description Validations
Exclude_Subordinate_Organizations  boolean  [0..1]  Also exclude Subordinate Organizations of the Supervisory Organization Reference.   
Promote_Subordinate_Organizations  boolean  [0..1]  Option to Promote the subordinate organizations for excluded organizations   
top
 

Headcount_Plan_Dimension_Management_Data

part of: Headcount_Plan_Template_Data
Element that contains dimension management information.
 
Parameter name Type/Value Cardinality Description Validations
Dimension_Reference  Worktag_and_Aggregation_TypeObject  [1..1]  Reference to the dimension from the associating headcount plan structure that is being managed. 
Validation Description
[dimension] is not a valid Dimension for the Headcount Plan Structure for this Headcount Plan Template.   
 
Headcount_Plan_Dimension_Restriction_Data  Headcount_Plan_Dimension_Restriction_Data  [0..*]  Element that contains information about a headcount plan dimension restriction row. 
Validation Description
Headcount Plan Dimension Restriction Detail Data is Required if Delete is False.   
Headcount Plan Dimension Restriction Detail Data should not be provided if Delete is True.   
You can only check either "Add Only" or "Delete"   
The following Organizations are not valid for this Headcount Plan Template so they cannot be used in a Dimension Restriction [organizations].   
The following Organizations can only be used for in one Headcount Plan Dimension Restriction Data Element for [dimension]: [organizations].   
The following Organizations are already part of an existing Dimension Management Row for [dimension] for this Headcount Plan Template: [organizations].   
The Dimension Restriction Detail Data for [organizations][default] has values for Required, Allow All, and Worktag References that are duplicates of an existing Dimension Restriction Detail Data Element for this Dimension.   
 
Validation Description
[dimension] can be used for only one Headcount Plan Dimension Management Data Element.   
top
 

Headcount_Plan_Dimension_Restriction_Data

part of: Headcount_Plan_Dimension_Management_Data
Element that contains information about a headcount plan dimension restriction row.
 
Parameter name Type/Value Cardinality Description Validations
@Add_Only  boolean  [1..1]  Add Only Flag. Indicates that the service is an add only, not an update. 
Validation Description
All Dimension Restrictions must be Add Only because this Headcount Plan Template is Add Only.   
 
@Delete  boolean  [1..1]  Flag indicating that the referenced data should be deleted.   
Default [Choice]   boolean  [1..1]  Indicates that the headcount plan dimension restriction is for the default behavior of the dimension. 
Validation Description
The default row for [dimension] cannot be deleted. There must be default behavior defined for each Headcount Plan Dimension.   
A default row for [dimension] cannot be added if the Headcount Plan Template is being edited. Please edit the existing default row.   
 
Organization_Reference [Choice]   OrganizationObject  [1..*]  Reference to the organization that the dimension restriction applies for. 
Validation Description
The following Organization references to not exist for a Headcount Plan Dimension Restriction [organizations].   
 
Headcount_Plan_Dimension_Restriction_Detail_Data  Headcount_Plan_Dimension_Restriction_Detail_Data  [0..1]  Element that contains the detailed information for the dimension restriction row.   
Validation Description
Headcount Plan Dimension Restriction Detail Data is Required if Delete is False.   
Headcount Plan Dimension Restriction Detail Data should not be provided if Delete is True.   
You can only check either "Add Only" or "Delete"   
The following Organizations are not valid for this Headcount Plan Template so they cannot be used in a Dimension Restriction [organizations].   
The following Organizations can only be used for in one Headcount Plan Dimension Restriction Data Element for [dimension]: [organizations].   
The following Organizations are already part of an existing Dimension Management Row for [dimension] for this Headcount Plan Template: [organizations].   
The Dimension Restriction Detail Data for [organizations][default] has values for Required, Allow All, and Worktag References that are duplicates of an existing Dimension Restriction Detail Data Element for this Dimension.   
top
 

Headcount_Plan_Dimension_Restriction_Detail_Data

part of: Headcount_Plan_Dimension_Restriction_Data
Element that contains the detailed information for the dimension restriction row.
 
Parameter name Type/Value Cardinality Description Validations
Required  boolean  [0..1]  Flag that indicates the dimension is required.   
Allow_All [Choice]   boolean  [0..1]  Flag that indicates all dimension values are allowed in the plan.   
Worktag_Reference [Choice]   Accounting_Worktag_and_Aggregation_DimensionObject  [0..*]  Reference to the dimension values for the headcount plan line 
Validation Description
The following worktags are not valid for this [dimension] dimension restriction: [worktags].   
 
top
 

Headcount_Plan_TemplateReferenceEnumeration

part of: Headcount_Plan_TemplateObjectID
Base Type
string
top
 

OrganizationReferenceEnumeration

part of: OrganizationObjectID
Base Type
string
top
 

Headcount_Plan_StructureReferenceEnumeration

part of: Headcount_Plan_StructureObjectID
Base Type
string
top
 

Fiscal_YearReferenceEnumeration

part of: Fiscal_YearObjectID
Base Type
string
top
 

Base Type
string

top
 

Fiscal_Time_IntervalReferenceEnumeration

part of: Fiscal_Time_IntervalObjectID
Base Type
string
top
 

Worktag_and_Aggregation_TypeReferenceEnumeration

part of: Worktag_and_Aggregation_TypeObjectID
Base Type
string
top
 

Accounting_Worktag_and_Aggregation_DimensionReferenceEnumeration

part of: Accounting_Worktag_and_Aggregation_DimensionObjectID
Base Type
string
top
 

Organization_TypeReferenceEnumeration

part of: Organization_TypeObjectID
Base Type
string
top