Service Directory > v31.2 > Workforce_Planning > Maintain_Headcount_Plan
 

Operation: Maintain_Headcount_Plan

Creates a new Headcount Plan Version.


@ - 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: Maintain_Headcount_Plan_Request

Wrapper element for the creation of a new Headcount Plan Version.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Business_Process_Parameters  Business_Process_Parameters  [0..1]  Container for the processing options for a business process. If no options are submitted (or the options are submitted as 'false') then the business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.   
Maintain_Headcount_Plan_Data  Maintain_Headcount_Plan_Data  [1..1]  Contains the data for a new Headcount Plan Version created by a Headcount Plan Version Event. 
Validation Description
The headcount plan template specified has been inactivated. You cannot submit using an inactivated headcount plan template.   
[hpt] has been marked to be pre-populated but has not yet been pre-populated. Use the Pre-Populate Headcount Plan task to pre-populate the selected Headcount Plan Template.   
 
top
 

Response Element: Maintain_Headcount_Plan_Response

Response with the Event id for the Create Job Requsition Event and the Headcount Plan Version Reference.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Headcount_Plan_Version_Event_Reference  Unique_IdentifierObject  [0..1]  A unique identifier for a Headcount Plan Version Event.   
Headcount_Plan_Version_Reference  Headcount_Plan_VersionObject  [0..1]  A unique identifier for a Headcount Plan Version.   
top
 

Business_Process_Parameters

part of: Maintain_Headcount_Plan_Request
Container for the processing options for a business process. If no options are submitted (or the options are submitted as 'false') then the business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.
 
Parameter name Type/Value Cardinality Description Validations
Auto_Complete  boolean  [0..1]  When set to "true" or "1", the business process is automatically processed. This means that all approvals will be automatically approved in the system, all reviews and to-do's will be automatically by-passed, and all notifications will be automatically suppressed.   
Run_Now  boolean  [0..1]  Indicates the transaction should process to completion before the response is generated. Note: All < v12 operations will process with Run_Now = True for backwards compatibility but please review this setting in your environment for performance conditions.   
Comment_Data  Business_Process_Comment_Data  [0..1]  Captures a comment for the Business Process.   
Business_Process_Attachment_Data  Business_Process_Attachment_Data  [0..*]  Element for the attachments pertaining to a Event entered through a web service. 
Validation Description
This Business Process Type has been configured to not accept Event Attachments.   
 
top
 

Business_Process_Comment_Data

part of: Business_Sub_Process_Parameters, Business_Process_Parameters
Captures a comment for the Business Process.
 
Parameter name Type/Value Cardinality Description Validations
Comment  string  [0..1]  Free form comment regarding the business process. 
Validation Description
This Business Process has been configured to disable comment. Please remove the comment or change the setting in the Business Process Policy or tenant setup.   
 
Worker_Reference  WorkerObject  [0..1]  Default the Person making the comment to the processing person if not submitted via the web service.   
top
 

WorkerObject

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

WorkerObjectID

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

Business_Process_Attachment_Data

part of: Business_Sub_Process_Parameters, Business_Process_Parameters
Element for the attachments pertaining to a Event entered through a web service.
 
Parameter name Type/Value Cardinality Description Validations
File_Name  string (255)   [1..1]  Filename for the attachment.   
Event_Attachment_Description  string  [0..1]  Free form text comment about the attachment.   
Event_Attachment_Category_Reference  Event_Attachment_CategoryObject  [0..1]  Category of attachment. 
Validation Description
This Business Process Type has been configured to not accept Attachment Categories.   
 
File  base64Binary  [0..1]  Binary file contents.   
Content_Type  string (80)   [0..1]  Text attribute identifying Content Type of the Attachment.   
top
 

Event_Attachment_CategoryObject

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

Event_Attachment_CategoryObjectID

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

Maintain_Headcount_Plan_Data

part of: Maintain_Headcount_Plan_Request
Contains the data for a new Headcount Plan Version created by a Headcount Plan Version Event.
 
Parameter name Type/Value Cardinality Description Validations
Headcount_Plan_Template_Reference  Headcount_Plan_TemplateObject  [1..1]  A unique identifier for a Headcount Plan Template. 
Validation Description
Selected Headcount Plan Template cannot have any In Progress Maintain Headcount Plan events.   
 
Headcount_Plan_Version_Reference  Headcount_Plan_VersionObject  [0..1]  A unique identifier for a Headcount Plan Version.   
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.   
Organization_Management_Data  Organization_Management_Data  [0..*]  Element that contains the Organization Management data information. 
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 information. 
Validation Description
[dimension] can be used for only one Headcount Plan Dimension Management Data Element.   
 
Edit_Headcount_Plan_Sub_Business_Process  Edit_Headcount_Plan_Sub_Business_Process  [1..1]  Run the Headcount Plan Org Event Sub Business Process to enter in data for the Headcount Plan Version.   
Validation Description
The headcount plan template specified has been inactivated. You cannot submit using an inactivated headcount plan template.   
[hpt] has been marked to be pre-populated but has not yet been pre-populated. Use the Pre-Populate Headcount Plan task to pre-populate the selected Headcount Plan Template.   
top
 

Headcount_Plan_TemplateObject

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

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

Headcount_Plan_VersionObjectID

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

OrganizationObject

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

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: Maintain_Headcount_Plan_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: Maintain_Headcount_Plan_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
 

Worktag_and_Aggregation_TypeObject

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

Accounting_Worktag_and_Aggregation_DimensionObject

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

Edit_Headcount_Plan_Sub_Business_Process

part of: Maintain_Headcount_Plan_Data
Wrapper element for the creation of a new Headcount Plan Version.
 
Parameter name Type/Value Cardinality Description Validations
Business_Sub_Process_Parameters  Business_Sub_Process_Parameters  [0..1]  Container for the processing options for sub-business processes within a business process. If no options are submitted (or the options are submitted as 'false') then the sub-business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.   
Edit_Headcount_Plan_Data  Edit_Headcount_Plan_Data  [0..1]  Contains data for the Headcount Plan.   
top
 

Business_Sub_Process_Parameters

part of: Edit_Headcount_Plan_Sub_Business_Process
Container for the processing options for sub-business processes within a business process. If no options are submitted (or the options are submitted as 'false') then the sub-business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.
 
Parameter name Type/Value Cardinality Description Validations
Auto_Complete [Choice]   boolean  [0..1]  When set to "true" or "1", the business process is automatically processed. This means that all approvals will be automatically approved in the system, all reviews and to-do's will be automatically by-passed, and all notifications will be automatically suppressed.   
Skip [Choice]   boolean  [0..1]  When set to "true" or "1", the business process is automatically skipped (if it is defined as "skippable" within the business process definition).   
Business_Process_Comment_Data  Business_Process_Comment_Data  [0..1]  Captures a comment for the Business Process.   
Business_Process_Attachment_Data  Business_Process_Attachment_Data  [0..*]  Element for the attachments pertaining to a Event entered through a web service.   
top
 

Edit_Headcount_Plan_Data

part of: Edit_Headcount_Plan_Sub_Business_Process
Contains data for the Headcount Plan.
 
Parameter name Type/Value Cardinality Description Validations
Headcount_Plan_Organization_Data  Headcount_Plan_Organization_Data  [0..*]  Contains data for the Headcount Plan. 
Validation Description
The Organization Reference: [organization reference] can be used for only one Headcount Plan Organization Data Element.   
[organization] is invalid for the Headcount Plan Template.   
 
top
 

Headcount_Plan_Organization_Data

part of: Edit_Headcount_Plan_Data
Contains data for the Headcount Plan.
 
Parameter name Type/Value Cardinality Description Validations
Organization_Reference  OrganizationObject  [1..1]  Unique Identifier for an Organization in the Headcount Plan.   
Headcount_Plan_Line_Data  Headcount_Plan_Line_Data  [1..*]  Contains detailed information about a Headcount Plan Line 
Validation Description
You can only check either "Add Only" or "Delete" flag.  You can only check either "Add Only" or "Delete" 
Headcount Plan Line Reference is Required unless "Add Only" is True.  Headcount Plan Line Reference is Required unless "Add Only" is True. 
Headcount Plan Line Reference should not be provided when "Add Only" is True.  Headcount Plan Line Reference should not be provided when "Add Only" is True. 
Headcount Plan Line Detail Data Element is Required if Add Only is True or if Add Only and Delete are False.  Headcount Plan Line Detail Data Element is Required if Add Only is True or if Add Only and Delete are False. 
Headcount Plan Line Detail Data Element should not be provided if Delete is True.  Headcount Plan Line Detail Data Element should not be provided if Delete is True. 
 
Validation Description
The Organization Reference: [organization reference] can be used for only one Headcount Plan Organization Data Element.   
[organization] is invalid for the Headcount Plan Template.   
top
 

Headcount_Plan_Line_Data

part of: Headcount_Plan_Organization_Data
Contains detailed information about a Headcount Plan Line
 
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. 
Validation Description
If Delete is True, then a Headcount Plan Entry for this Headcount Plan Line cannot be added or updated.  If Delete is True, then a Headcount Plan Entry for this Headcount Plan Line cannot be added or updated. 
 
Headcount_Plan_Line_Reference  Headcount_Plan_LineObject  [0..1]  Unique identifier for Headcount Plan Reference. 
Validation Description
Headcount Plan Line Reference must be valid for Headcount Plan Version [headcount plan version]  Headcount Plan Line Reference must be valid for Headcount Plan Version Reference. 
 
Headcount_Plan_Line_Detail_Data  Headcount_Plan_Line_Detail_Data  [0..1]  Contains the details of a Headcount Plan Line. 
Validation Description
Worktags are Required if Add Only is True.  Worktags are Required if Add Only is True. 
Worktags for a pre-populated line cannot be modified if a baseline column has been included in the template.  Worktags for a pre-populated line cannot be modified if a baseline column has been included in the template. 
 
Validation Description
You can only check either "Add Only" or "Delete" flag.  You can only check either "Add Only" or "Delete" 
Headcount Plan Line Reference is Required unless "Add Only" is True.  Headcount Plan Line Reference is Required unless "Add Only" is True. 
Headcount Plan Line Reference should not be provided when "Add Only" is True.  Headcount Plan Line Reference should not be provided when "Add Only" is True. 
Headcount Plan Line Detail Data Element is Required if Add Only is True or if Add Only and Delete are False.  Headcount Plan Line Detail Data Element is Required if Add Only is True or if Add Only and Delete are False. 
Headcount Plan Line Detail Data Element should not be provided if Delete is True.  Headcount Plan Line Detail Data Element should not be provided if Delete is True. 
top
 

Headcount_Plan_LineObject

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

Headcount_Plan_LineObjectID

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

part of: Headcount_Plan_Line_Data
Contains the details of a Headcount Plan Line.
 
Parameter name Type/Value Cardinality Description Validations
Comment  string  [0..1]  Comment for the Headcount Plan Line.   
Worktags_Reference  Accounting_Worktag_and_Aggregation_DimensionObject  [0..*]  Reference to existing worktags. Worktags are a way to mark tasks and business objects to make them easier to access and summarize. Each transaction can include one value for each worktag type and is subject to configurable validation when submitted for approval. 
Validation Description
There can only be one value for each of the following Dimensions: [dimensions].   
Worktags [worktags] are not valid for the selected template. See the dimension restrictions defined for [template].   
The following Dimensions are required to have a value: [dimensions]   
 
Headcount_Plan_Period_Data  Headcount_Plan_Period_Data  [0..*]  Contains the headcount plan data for headcount plan periods. 
Validation Description
The Headcount Plan Period Reference: [headcount plan period reference] can be used only once for the Headcount Plan Line: [headcount plan line].  A Headcount Plan Period Reference can be used only once for a Headcount Plan Line. 
 
Validation Description
Worktags are Required if Add Only is True.  Worktags are Required if Add Only is True. 
Worktags for a pre-populated line cannot be modified if a baseline column has been included in the template.  Worktags for a pre-populated line cannot be modified if a baseline column has been included in the template. 
top
 

Headcount_Plan_Period_Data

part of: Headcount_Plan_Line_Detail_Data
Contains data for a Headcount Plan Period.
 
Parameter name Type/Value Cardinality Description Validations
Headcount_Plan_Period_Reference  Headcount_Plan_PeriodObject  [1..1]  Unique identifier for a Headcount Plan Period. 
Validation Description
The Headcount Plan Period: [headcount plan period reference] is not valid for the Headcount Plan.  The Headcount Plan Period is not valid for the Headcount Plan. 
 
Headcount_Plan_Entry_Data  Headcount_Plan_Entry_Data  [0..1]  Contains data for a Headcount Plan Entry. 
Validation Description
Headcount Plan Entry Reference should not be provided when "Add Only" is True.  Headcount Plan Entry Reference should not be provided when "Add Only" is True. 
Headcount Plan Entry Reference is Required unless "Add Only" is True.  Headcount Plan Entry Reference is Required unless "Add Only" is True. 
You can only check either "Add Only" or "Delete" flag.  You can only check either "Add Only" or "Delete" flag. 
Headcount Plan Entry Detail Data Element should not be provided if Delete is True.  Headcount Plan Entry Detail Data Element should not be provided if Delete is True. 
Headcount Plan Entry Detail Data is Required if Add Only is True or if Add Only and Delete are False.  Headcount Plan Entry Detail Data is Required if Add Only is True or if Add Only and Delete are False. 
 
Validation Description
The Headcount Plan Period Reference: [headcount plan period reference] can be used only once for the Headcount Plan Line: [headcount plan line].  A Headcount Plan Period Reference can be used only once for a Headcount Plan Line. 
top
 

Headcount_Plan_PeriodObject

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

Headcount_Plan_PeriodObjectID

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

part of: Headcount_Plan_Period_Data
Contains data for a Headcount Plan Entry.
 
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.   
Headcount_Plan_Entry_Reference  Headcount_Plan_EntryObject  [0..1]  Unique identifier for a Headcount Plan Entry. 
Validation Description
Headcount Plan Entry is invalid for Headcount Plan Line: [headcount plan line].  Headcount Plan Entry is invalid for Headcount Plan Line. 
Headcount Plan Entry is invalid for Headcount Plan Period: [headcount plan period].  Headcount Plan Entry is invalid for Headcount Plan Period. 
 
Headcount_Plan_Entry_Detail_Data  Headcount_Plan_Entry_Detail_Data  [0..*]  Details for a Headcount Plan Entry.   
Validation Description
Headcount Plan Entry Reference should not be provided when "Add Only" is True.  Headcount Plan Entry Reference should not be provided when "Add Only" is True. 
Headcount Plan Entry Reference is Required unless "Add Only" is True.  Headcount Plan Entry Reference is Required unless "Add Only" is True. 
You can only check either "Add Only" or "Delete" flag.  You can only check either "Add Only" or "Delete" flag. 
Headcount Plan Entry Detail Data Element should not be provided if Delete is True.  Headcount Plan Entry Detail Data Element should not be provided if Delete is True. 
Headcount Plan Entry Detail Data is Required if Add Only is True or if Add Only and Delete are False.  Headcount Plan Entry Detail Data is Required if Add Only is True or if Add Only and Delete are False. 
top
 

Headcount_Plan_EntryObject

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

Headcount_Plan_EntryObjectID

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

part of: Headcount_Plan_Entry_Data
Details for a Headcount Plan Entry.
 
Parameter name Type/Value Cardinality Description Validations
Headcount_Amount  decimal (12, 0) >0   [0..1]  Headcount Amount.   
FTE_Amount  decimal (18, 6) >0   [0..1]  FTE Amount. 
Validation Description
FTE Amount cannot be entered because FTE is not included as a Dimension for this Headcount Plan.  FTE Amount cannot be entered because FTE is not included as a Dimension for this Headcount Plan. 
Headcount Amount cannot be entered because Headcount is not included as a Dimension for this Headcount Plan.  Headcount Amount cannot be entered because Headcount is not included as a Dimension for this Headcount Plan. 
 
top
 

Unique_IdentifierObject

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

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Event_Attachment_CategoryReferenceEnumeration

part of: Event_Attachment_CategoryObjectID
Base Type
string
top
 

Headcount_Plan_TemplateReferenceEnumeration

part of: Headcount_Plan_TemplateObjectID
Base Type
string
top
 

Headcount_Plan_VersionReferenceEnumeration

part of: Headcount_Plan_VersionObjectID
Base Type
string
top
 

OrganizationReferenceEnumeration

part of: OrganizationObjectID
Base Type
string
top
 

Organization_TypeReferenceEnumeration

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

Headcount_Plan_LineReferenceEnumeration

part of: Headcount_Plan_LineObjectID
Base Type
string
top
 

Headcount_Plan_PeriodReferenceEnumeration

part of: Headcount_Plan_PeriodObjectID
Base Type
string
top
 

Headcount_Plan_EntryReferenceEnumeration

part of: Headcount_Plan_EntryObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top