Service Directory > v31.2 > Staffing > Set_Hiring_Restrictions
 

Operation: Set_Hiring_Restrictions

This operation will create the hiring restrictions for a job management supervisory organization.


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

Wrapper element for set hiring restrictions web service
 
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.   
Set_Hiring_Restrictions_Data  Set_Hiring_Restrictions_Data  [1..1]  Wrapper element for the creation of Hiring Restrictions   
top
 

Response Element: Set_Hiring_Restrictions_Response

Responds with the event id for the Job Restrictions Request Event, and the Supervisory Organization Reference.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Event_Reference  Unique_IdentifierObject  [0..1]  Reference to the Job Restrictions Request Event   
Supervisory_Organization_Reference  Supervisory_OrganizationObject  [0..1]  Reference to the Supervisory Organization   
top
 

Business_Process_Parameters

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

Set_Hiring_Restrictions_Data

part of: Set_Hiring_Restrictions_Request
Wrapper element for setting hiring restrictions
 
Parameter name Type/Value Cardinality Description Validations
Supervisory_Organization_Reference  Supervisory_OrganizationObject  [1..1]  Reference to the supervisory organization to set hiring restrictions for 
Validation Description
Supervisory Organization submitted is not valid. Verify that it is active, uses the Job Management Staffing Model and that the user has access to it.   
The submitted organization already has hiring restrictions. Use the edit hiring restrictions process to update the restrictions for this organization.   
 
Hiring_Restrictions_Request_Reason_Reference  Event_Classification_SubcategoryObject  [0..1]  Reference to the reason the hiring restrictions are being set   
Position_Group_Restrictions_Data  Position_Group_Restriction_Data  [1..1]  Wrapper for restriction data for openings for all staffing models. 
Validation Description
Availability Date is required for an opening or hiring restriction.   
Earliest hire date is required for an opening or hiring restriction.   
 
Request_Default_Compensation_Sub_Process  Request_Compensation_Default_Sub_Business_Process  [0..1]  Wrapper element for the Request Default Compensation sub business process.   
top
 

Supervisory_OrganizationObject

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

Event_Classification_SubcategoryObject

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

Event_Classification_SubcategoryObjectID

part of: Event_Classification_SubcategoryObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Benefits_Event_Subcategory_ID, Change_Job_Subcategory_ID, End_Additional_Job_Subcategory_ID, Event_Classification_Subcategory_ID, General_Event_Subcategory_ID, Leave_of_Absence_Type_ID, Termination_Subcategory_ID, Undo_Move_Subcategory_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
 

Position_Group_Restriction_Data

part of: Set_Hiring_Restrictions_Data
Wrapper for restriction data for openings for all staffing models.
 
Parameter name Type/Value Cardinality Description Validations
Availability_Date  date  [0..1]  Date the opening is available. On a create, this will default to current date if no date is provided. 
Validation Description
Enter an Availability Date that is on or after [date1], the date the hiring restrictions were created.   
 
Earliest_Hire_Date  date  [0..1]  Earliest date that a worker can be hired/contracted into this opening. This field is required to have a value. On creation it will default to the current date. On an edit, if not submitted the existing value will be retained. This date cannot be earlier than the Availability date. 
Validation Description
The earliest hire date cannot be before the availability date.   
 
Job_Family_Reference  Job_Family_BaseObject  [0..*]  Reference(s) to the job families that a worker being hired/contracted using this opening can use. On an edit, if not submitted the existing value(s) will be retained. If submitted with an empty value, the existing value(s) will be removed.   
Job_Profile_Reference  Job_ProfileObject  [0..*]  Reference(s) to the job profiles that a worker being hired/contracted using this opening can use. On an edit, if not submitted the existing value(s) will be retained. If submitted with an empty value, the existing value(s) will be removed.   
Location_Reference  LocationObject  [0..*]  Reference(s) to the location that a worker being hired/contracted using this opening can use. On an edit, if not submitted the existing value(s) will be retained. If submitted with an empty value, the existing value(s) will be removed.   
Worker_Type_Reference  Worker_TypeObject  [0..1]  Reference to the worker type that a worker being hired/contracted using this opening can use. On an edit, if not submitted the existing value will be retained. If submitted with an empty value, the existing value will be removed.   
Time_Type_Reference  Position_Time_TypeObject  [0..1]  Reference to the time type that a worker being hired/contracted using this opening can use. On an edit, if not submitted the existing value will be retained. If submitted with an empty value, the existing value will be removed.   
Position_Worker_Type_Reference  Position_Worker_TypeObject  [0..*]  Reference(s) to the Employee or Contingent Worker types that a worker being hired/contracted using this opening can use. Employee Type values are only valid if the Worker Type is Employee. Contingent Worker Types are only valid if Worker Type is Contingent Worker. On an edit, if not submitted the existing value(s) will be retained. If submitted with an empty value, the existing value(s) will be removed. 
Validation Description
Position Worker Type is only valid if Worker Type is entered.   
Only Contingent Worker Types are valid when the worker type is Contingent Worker.   
Only Employee Types are valid when the worker type is Employee.   
 
Validation Description
Availability Date is required for an opening or hiring restriction.   
Earliest hire date is required for an opening or hiring restriction.   
top
 

Job_Family_BaseObject

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

Job_Family_BaseObjectID

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

Job_ProfileObject

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

Job_ProfileObjectID

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

LocationObject

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

LocationObjectID

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

Worker_TypeObject

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

Worker_TypeObjectID

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

Position_Time_TypeObject

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

Position_Time_TypeObjectID

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

Position_Worker_TypeObject

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

Position_Worker_TypeObjectID

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

Request_Compensation_Default_Sub_Business_Process

part of: Set_Hiring_Restrictions_Data
Wrapper element for the Request Default Compensation sub business process.
 
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.   
Compensation_Default_Data  Compensation_Default_Data  [0..1]  Data element that contains the compensation default information. If a section is to be provided, it must be provided fully as it will fully replace the current default compensation.   
top
 

Business_Sub_Process_Parameters

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

Compensation_Default_Data

part of: Request_Compensation_Default_Sub_Business_Process
Data element that contains the compensation default information. If a section is to be provided, it must be provided fully as it will fully replace the current default compensation.
 
Parameter name Type/Value Cardinality Description Validations
Primary_Compensation_Basis [Choice]   decimal (26, 6)   [0..1]  Sum of the employee's plan assignments as defined by their primary compensation basis.   
Primary_Compensation_Basis_Amount_Change [Choice]   decimal (26, 6)   [0..1]  Amount you can change the primary compensation basis for employees managed by basis total. Mutually exclusive from the percent.   
Primary_Compensation_Basis_Percent_Change [Choice]   decimal (21, 6)   [0..1]  Percent you can change the primary compensation basis for employees managed by a compensation basis. Mutually exclusive from the amount.   
Guidelines_Data  Compensatable_Default_Guidelines_Data  [0..1]  Data element containing the compensation guidelines for a compensation change. 
Validation Description
Compensation grade profile is not valid for the compensation grade.  Compensation grade profile is not valid for the compensation grade. 
Compensation step is not valid for the compensation grade profile.  Compensation step is not valid for the compensation grade profile. 
Compensation Grade is required.  Compensation Grade is required. 
Compensation step is not valid for the compensation grade.  Compensation step is not valid for the compensation grade. 
Compensation package is required.  Compensation package is required. 
 
Pay_Plan_Data  Proposed_Base_Pay_Plan_Assignment_Container_Data  [0..1]  Encapsulating element containing all Salary or Hourly Plan Compensation data.   
Unit_Salary_Plan_Data  Proposed_Salary_Unit_Plan_Assignment_Container_Data  [0..1]  Encapsulating element containing all Unit Salary Plan Compensation data.   
Allowance_Plan_Non-Unit_Based_Data  Proposed_Allowance_Plan_Assignment_Container_Data  [0..1]  Encapsulating element containing all Allowance Plan Compensation data.   
Allowance_Plan_Unit_Based_Data  Proposed_Allowance_Unit_Plan_Assignment_Container_Data  [0..1]  Encapsulating element containing all Unit Allowance Plan Compensation data.   
Bonus_Plan_Data  Proposed_Bonus_Plan_Assignment_Container_Data  [0..1]  Encapsulating element containing all Bonus Plan Compensation data.   
Merit_Plan_Data  Proposed_Merit_Plan_Assignment_Container_Data  [0..1]  Encapsulating element containing all Merit Plan Compensation data.   
Commission_Plan_Data  Proposed_Commission_Plan_Assignment_Container_Data  [0..1]  Encapsulating element containing all Commission Plan Compensation data.   
Stock_Plan_Data  Proposed_Stock_Plan_Assignment_Container_Data  [0..1]  Encapsulating element containing all Stock Plan Compensation data.   
Period_Salary_Plan_Data  Proposed_Period_Salary_Plan_Assignment_Container_Data  [0..1]  Encapsulating element containing all Period Salary Plan Compensation data.   
Calculated_Plan_Data  Proposed_Calculated_Plan_Assignment_Container_Data  [0..1]  Encapsulating element containing all Calculated Plan Compensation data.   
top
 

Compensatable_Default_Guidelines_Data

part of: Compensation_Default_Data
Data element containing the compensation guidelines for a compensation change.
 
Parameter name Type/Value Cardinality Description Validations
Compensation_Package_Reference  Compensation_PackageObject  [0..1]  Compensation Package to assign.   
Compensation_Grade_Reference  Compensation_GradeObject  [0..1]  Compensation grade to assign. Required if you select a compensation package. Doesn't default for Request Compensation Change.   
Compensation_Grade_Profile_Reference  Compensation_Grade_ProfileObject  [0..1]  Profile within the Compensation Grade to assign. Does not default for Request Compensation Change.   
Compensation_Step_Reference  Compensation_StepObject  [0..1]  Compensation Step within the Compensation Grade Profile.   
Validation Description
Compensation grade profile is not valid for the compensation grade.  Compensation grade profile is not valid for the compensation grade. 
Compensation step is not valid for the compensation grade profile.  Compensation step is not valid for the compensation grade profile. 
Compensation Grade is required.  Compensation Grade is required. 
Compensation step is not valid for the compensation grade.  Compensation step is not valid for the compensation grade. 
Compensation package is required.  Compensation package is required. 
top
 

Compensation_PackageObject

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

Compensation_PackageObjectID

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

Compensation_GradeObject

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

Compensation_GradeObjectID

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

Compensation_Grade_ProfileObject

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

Compensation_Grade_ProfileObjectID

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

Compensation_StepObject

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

Compensation_StepObjectID

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

Proposed_Base_Pay_Plan_Assignment_Container_Data

part of: Compensation_Default_Data
Encapsulating element containing all Salary or Hourly Plan Compensation data.
 
Parameter name Type/Value Cardinality Description Validations
@Replace  boolean  [1..1]  When True, indicates the compensation plans will replace any existing compensation plan assigned to the worker. The default value of False will add or update the compensation plans for the worker.   
Pay_Plan_Sub_Data  Proposed_Base_Pay_Plan_Assignment_Data  [0..*]  Encapsulating element containing all Salary or Hourly Plan Compensation data. 
Validation Description
Compensation Plan Assignment Amount Must be Greater than Zero, If you do not wish to use Compensation Plan Assignment, leave the field blank.   
 
top
 

Proposed_Base_Pay_Plan_Assignment_Data

part of: Proposed_Base_Pay_Plan_Assignment_Container_Data
Encapsulating element containing all Salary or Hourly Plan Compensation data.
 
Parameter name Type/Value Cardinality Description Validations
Pay_Plan_Reference  Salary_Pay_PlanObject  [0..1]  Salary or hourly plan to update or assign. Doesn't default for Request Compensation Change. 
Validation Description
Plan is required since system was unable to default from the existing compensation.   
The Base Pay Plan [plan] has not been assigned to [position].   
 
Amount [Choice]   decimal (26, 6)   [1..1]  Amount for the salary or hourly plan assignment. Required if the plan has no default amount. Decimal precision of the amount must match the currency. Mutually exclusive from the percent. 
Validation Description
The amount entered must be greater than or equal to the minimum wage amount for plan [plan].   
 
Percent_Change [Choice]   decimal (21, 6)   [1..1]  Percent of the compensation basis defined on the salary or hourly plan. Workday calculates the amount using this percent. Mutually exclusive from the amount. 
Validation Description
The amount calculated must be greater than or equal to the minimum wage amount for plan [plan].   
 
Amount_Change [Choice]   decimal (26, 6)   [1..1]  Amount difference from the compensation change. 
Validation Description
The amount calculated must be greater than or equal to the minimum wage amount for plan [plan].   
 
Currency_Reference  CurrencyObject  [0..1]  Currency of the plan assignment. 
Validation Description
Currency is required due to an amount entered or is required for plan [plan] and system was unable to default from the plan.   
 
Frequency_Reference  FrequencyObject  [0..1]  Frequency of the salary or hourly plan. Required if the plan has no default frequency. 
Validation Description
Frequency is required for plan [plan] and system was unable to default from the plan.   
 
Expected_End_Date  date  [0..1]  Expected end date for the plan assignment.   
Actual_End_Date  date  [0..1]  Actual End Date for the plan assignment. 
Validation Description
The Actual End Date must be on or after the Expected End Date.   
Please check the Enable Actual End Date tenant setup - HCM flag before attempting to set the Actual End Date.   
The Actual End Date must be on or after the Effective Date.   
 
Validation Description
Compensation Plan Assignment Amount Must be Greater than Zero, If you do not wish to use Compensation Plan Assignment, leave the field blank.   
top
 

Salary_Pay_PlanObject

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

Salary_Pay_PlanObjectID

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

CurrencyObject

part of: Proposed_Base_Pay_Plan_Assignment_Data, Proposed_Salary_Unit_Plan_Assignment_Data, Proposed_Allowance_Plan_Assignment_Data, Proposed_Allowance_Unit_Plan_Assignment_Data, Proposed_Commission_Plan_Assignment_Data, Proposed_Stock_Plan_Assignment_Data, Proposed_Period_Salary_Plan_Assignment_Data, Proposed_Calculated_Plan_Assignment_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  CurrencyObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

CurrencyObjectID

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

FrequencyObject

part of: Proposed_Base_Pay_Plan_Assignment_Data, Proposed_Salary_Unit_Plan_Assignment_Data, Proposed_Allowance_Plan_Assignment_Data, Proposed_Allowance_Unit_Plan_Assignment_Data, Proposed_Commission_Plan_Assignment_Data, Proposed_Commission_Plan_Assignment_Data, Proposed_Period_Salary_Plan_Assignment_Data, Proposed_Calculated_Plan_Assignment_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  FrequencyObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

FrequencyObjectID

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

Proposed_Salary_Unit_Plan_Assignment_Container_Data

part of: Compensation_Default_Data
Encapsulating element containing all Unit Salary Plan Compensation data.
 
Parameter name Type/Value Cardinality Description Validations
@Replace  boolean  [1..1]  When True, indicates the compensation plans will replace any existing compensation plan assigned to the worker. The default value of False will add or update the compensation plans for the worker.   
Unit_Salary_Plan_Sub_Data  Proposed_Salary_Unit_Plan_Assignment_Data  [0..*]  Encapsulating element containing all Unit Salary Plan Compensation data. 
Validation Description
Salary Unit Plan Per Unit Amount has to be greater than zero, If you do not wish to use Salary Unit Plan, leave the field blank.   
 
top
 

Proposed_Salary_Unit_Plan_Assignment_Data

part of: Proposed_Salary_Unit_Plan_Assignment_Container_Data
Encapsulating element containing all Unit Salary Plan Compensation data.
 
Parameter name Type/Value Cardinality Description Validations
Unit_Salary_Plan_Reference  Salary_Unit_PlanObject  [0..1]  Unit salary plan to update or assign. Doesn't default for Request Compensation Change. 
Validation Description
Plan is required since system was unable to default from the existing compensation.   
 
Per_Unit_Amount  decimal (26, 6)   [0..1]  Amount per unit of the unit salary plan. Decimal precision of the amount must match the currency. Required if there is no default amount for the plan. 
Validation Description
[plan] requires Per Unit Amount and system was unable to default from plan.   
Plan [plan] does not allow for individual overrides.   
 
Currency_Reference  CurrencyObject  [0..1]  Currency of the unit amount. Required if there is no default currency for the plan. 
Validation Description
Currency is required due to an amount entered or is required for plan [plan] and system was unable to default from the plan.   
Plan [plan] does not allow for individual overrides.   
 
Default_Units  decimal (21, 6) >0   [0..1]  Number of units to assign. 
Validation Description
Plan [plan] does not allow for individual overrides.   
 
Frequency_Reference  FrequencyObject  [0..1]  Frequency of the unit salary plan. 
Validation Description
Plan [plan] does not allow for individual overrides.   
 
Actual_End_Date  date  [0..1]  Actual End Date for the plan assignment. 
Validation Description
Please check the Enable Actual End Date tenant setup - HCM flag before attempting to set the Actual End Date.   
The Actual End Date must be on or after the Effective Date.   
 
Validation Description
Salary Unit Plan Per Unit Amount has to be greater than zero, If you do not wish to use Salary Unit Plan, leave the field blank.   
top
 

Salary_Unit_PlanObject

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

Salary_Unit_PlanObjectID

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

Proposed_Allowance_Plan_Assignment_Container_Data

part of: Compensation_Default_Data
Encapsulating element containing all Allowance Plan Compensation data.
 
Parameter name Type/Value Cardinality Description Validations
@Replace  boolean  [1..1]  When True, indicates the compensation plans will replace any existing compensation plan assigned to the worker. The default value of False will add or update the compensation plans for the worker.   
Allowance_Plan_Sub_Data  Proposed_Allowance_Plan_Assignment_Data  [0..*]  Encapsulating element containing all Allowance Plan Compensation data. 
Validation Description
Amount has to be greater than zero, if you do not wish to use Amount, leave the field blank   
Manage by Compensation Basis Override Amount for Proposed Allowance Plan, has to be greater than zero. If you do not wish to use Manage by Compensation Basis Override Amount, leave the field blank.   
 
top
 

Proposed_Allowance_Plan_Assignment_Data

part of: Proposed_Allowance_Plan_Assignment_Container_Data
Encapsulating element containing all Allowance Plan Compensation data.
 
Parameter name Type/Value Cardinality Description Validations
Allowance_Plan_Reference  Allowance_Value_PlanObject  [0..1]  Allowance Plan to update or assign. Does not default for Request Compensation Change. 
Validation Description
Plan is required since system was unable to default from the existing compensation.   
 
Percent [Choice]   decimal (20, 10) >0   [0..1]  Percent for the allowance plan. Required if percent allowance plan is entered and there is no default percent for the plan. The amount will be calculated using this percent. Mutually exclusive from the amount. 
Validation Description
Plan [plan] does not allow for individual overrides.   
 
Amount [Choice]   decimal (26, 6)   [0..1]  Amount for the allowance plan. Decimal precision of the amount must match the currency. Required if amount allowance plan is entered and there is no default amount for the plan. Mutually exclusive from the percent. 
Validation Description
Plan [plan] does not allow for individual overrides.   
 
Manage_by_Compensation_Basis_Override_Amount  decimal (26, 6)   [0..1]  This field allows an override amount to be specified for workerswho are managed by compensation basis. 
Validation Description
Manage by Compensation Basis Override Amount is not a valid field for plan [plan] because worker [worker] is not managed by compensation basis.   
Override Compensation Basis Calculation field needs to be set to true to be able to specify a value for Manage by Compensation Basis Override Amount.   
Manage by Compensation Basis Override Amount is not valid for plan [plan] because the plan is not a percent based plan.   
Manage by Compensation Basis Override Amount is not a valid field for plan [plan] because the plan is not part of the worker's primary compensation basis.   
Manage by Compensation Basis Override Amount is required for plan [plan] because the plan is in worker [worker]'s primary compensation basis and Override Compensation Basis Calculation is set to true.   
 
Currency_Reference  CurrencyObject  [0..1]  Currency of the allowance plan. Required if amount allowance plan is entered and there is no default currency for the plan. 
Validation Description
Currency Reference for plan [plan] must be [currency] to match the currency of the worker's proposed pay range.   
Plan [plan] does not allow for individual overrides.   
Override Compensation Basis Calculation field needs to be set to true to be able to specify a value for Currency Reference.   
 
Frequency_Reference  FrequencyObject  [0..1]  Frequency of the allowance plan. Required if there is no default frequency for the plan. 
Validation Description
Plan [plan] does not allow for individual overrides.   
Override Compensation Basis Calculation field needs to be set to true to be able to specify a value for Frequency Reference.   
 
Expected_End_Date  date  [0..1]  Expected end date for the plan assignment.   
Reimbursement_Start_Date  date  [0..1]  Reimbursement Start Date. 
Validation Description
Reimbursement Start Date must be entered for reimbursable allowance plans that use an expense accumulator requiring a custom date. For all other allowance plans it must be empty.   
 
Actual_End_Date  date  [0..1]  Actual End Date for the plan assignment. 
Validation Description
The Actual End Date must be on or after the Effective Date.   
Please check the Enable Actual End Date tenant setup - HCM flag before attempting to set the Actual End Date.   
The Actual End Date must be on or after the Expected End Date.   
 
Fixed_for_Manage_by_Basis_Total  boolean  [0..1]  This field allows a plan assignment for a remainder plan in the compensation basis algorithm to be considered a fixed plan assignment. This field is only valid for plans in the PCB of a worker that is managed by basis total where the plan allows override. The flag will be ignored if the conditions are not met. 
Validation Description
Fixed for Manage by Compensation Basis is not a valid field for percent based plan [plan].   
 
Validation Description
Amount has to be greater than zero, if you do not wish to use Amount, leave the field blank   
Manage by Compensation Basis Override Amount for Proposed Allowance Plan, has to be greater than zero. If you do not wish to use Manage by Compensation Basis Override Amount, leave the field blank.   
top
 

Allowance_Value_PlanObject

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

Allowance_Value_PlanObjectID

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

Proposed_Allowance_Unit_Plan_Assignment_Container_Data

part of: Compensation_Default_Data
Encapsulating element containing all Unit Allowance Plan Compensation data.
 
Parameter name Type/Value Cardinality Description Validations
@Replace  boolean  [1..1]  When True, indicates the compensation plans will replace any existing compensation plan assigned to the worker. The default value of False will add or update the compensation plans for the worker.   
Unit_Allowance_Plan_Sub_Data  Proposed_Allowance_Unit_Plan_Assignment_Data  [0..*]  Encapsulating element containing all Unit Allowance Plan Compensation data. 
Validation Description
Number of Units amount has to be greater than zero. If you do no wish to use Number of Units, leave the field blank.   
 
top
 

Proposed_Allowance_Unit_Plan_Assignment_Data

part of: Proposed_Allowance_Unit_Plan_Assignment_Container_Data
Encapsulating element containing all Unit Allowance Plan Compensation data.
 
Parameter name Type/Value Cardinality Description Validations
Unit_Allowance_Plan_Reference  Allowance_Unit_PlanObject  [0..1]  Unit Allowance Plan to update or assign. Does not default for Request Compensation Change. 
Validation Description
Plan is required since system was unable to default from the existing compensation.   
 
Number_of_Units  decimal (21, 6) >0   [0..1]  Number of units to assign. Required if there is no default number of units for the plan. 
Validation Description
Plan [plan] does not allow for individual overrides.   
 
Frequency_Reference  FrequencyObject  [0..1]  Frequency of the unit allowance plan. Required if there is no default frequency for the plan. 
Validation Description
Plan [plan] does not allow for individual overrides.   
 
Per_Unit_Amount  decimal (26, 6)   [0..1]  Amount per unit of the unit allowance plan. Required if there is no default amount per unit for the plan. 
Validation Description
Plan [plan] does not allow for individual overrides.   
 
Currency_Reference  CurrencyObject  [0..1]  Currency of the unit amount. Required if there is no default currency for the plan. 
Validation Description
Plan [plan] does not allow for individual overrides.   
 
Reimbursement_Start_Date  date  [0..1]  Reimbursement Start Date. 
Validation Description
Reimbursement Start Date must be entered for reimbursable allowance plans that use an expense accumulator requiring a custom date. For all other allowance plans it must be empty.   
 
Actual_End_Date  date  [0..1]  Actual End Date for the plan assignment. 
Validation Description
Please check the Enable Actual End Date tenant setup - HCM flag before attempting to set the Actual End Date.   
The Actual End Date must be on or after the Effective Date.   
 
Fixed_for_Manage_by_Basis_Total  boolean  [0..1]  This field allows a plan assignment for a remainder plan in the compensation basis algorithm to be considered a fixed plan assignment. This field is only valid for plans in the PCB of a worker that is managed by basis total where the plan allows override. The flag will be ignored if the conditions are not met.   
Validation Description
Number of Units amount has to be greater than zero. If you do no wish to use Number of Units, leave the field blank.   
top
 

Allowance_Unit_PlanObject

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

Allowance_Unit_PlanObjectID

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

Proposed_Bonus_Plan_Assignment_Container_Data

part of: Compensation_Default_Data
Encapsulating element containing all Bonus Plan Compensation data.
 
Parameter name Type/Value Cardinality Description Validations
@Replace  boolean  [1..1]  When True, indicates the compensation plans will replace any existing compensation plan assigned to the worker. The default value of False will add or update the compensation plans for the worker.   
Bonus_Plan_Sub_Data  Proposed_Bonus_Plan_Assignment_Data  [0..*]  Encapsulating element containing all Bonus Plan Compensation data.   
top
 

Proposed_Bonus_Plan_Assignment_Data

part of: Proposed_Bonus_Plan_Assignment_Container_Data
Encapsulating element containing all Bonus Plan Compensation data.
 
Parameter name Type/Value Cardinality Description Validations
Bonus_Plan_Reference  Bonus_PlanObject  [0..1]  Bonus Plan to update or assign. Does not default for Request Compensation Change. 
Validation Description
Plan is required since system was unable to default from the existing compensation.   
 
Individual_Target_Amount [Choice]   decimal (26, 6)   [0..1]  Individual target amount that overrides the default target percent on the plan, provided Allow Target Override is enabled on the plan. Mutually exclusive from Individual Target Percent. 
Validation Description
Amount cannot be entered for plan [plan] which is a percent based plan.   
Plan [plan] does not allow for individual overrides.   
 
Individual_Target_Percent [Choice]   decimal (16, 6) >0   [0..1]  Individual target percent that overrides the default target percent on the plan, provided Allow Target Override is enabled on the plan. Mutually exclusive from Individual Target Amount. 
Validation Description
Percent cannot be entered for plan [plan] which is an amount based plan.   
Plan [plan] does not allow for individual overrides.   
 
Manage_by_Compensation_Basis_Override_Amount  decimal (26, 6)   [0..1]  This field allows an override amount to be specified for workerswho are managed by compensation basis. 
Validation Description
Manage by Compensation Basis Override Amount is not a valid field for plan [plan] because worker [worker] is not managed by compensation basis.   
Override Compensation Basis Calculation field needs to be set to true to be able to specify a value for Manage by Compensation Basis Override Amount.   
Manage by Compensation Basis Override Amount is not valid for plan [plan] because the plan is not a percent based plan.   
Manage by Compensation Basis Override Amount is not a valid field for plan [plan] because the plan is not part of the worker's primary compensation basis.   
Manage by Compensation Basis Override Amount is required for plan [plan] because the plan is in worker [worker]'s primary compensation basis and Override Compensation Basis Calculation is set to true.   
 
Guaranteed_Minimum  boolean  [0..1]  If true, employee is guaranteed the minimum for the bonus plan. 
Validation Description
Plan [plan] does not allow for individual overrides.   
 
Percent_Assigned  decimal (16, 6) >0   [0..1]  Percent of the bonus assigned. If none entered, default is 100%.   
Actual_End_Date  date  [0..1]  Actual End Date for the plan assignment. 
Validation Description
The Actual End Date must be on or after the Effective Date.   
Please check the Enable Actual End Date tenant setup - HCM flag before attempting to set the Actual End Date.   
 
Fixed_for_Manage_by_Basis_Total  boolean  [0..1]  This field allows a plan assignment for a remainder plan in the compensation basis algorithm to be considered a fixed plan assignment. This field is only valid for plans in the PCB of a worker that is managed by basis total where the plan allows override. The flag will be ignored if the conditions are not met. 
Validation Description
Fixed for Manage by Compensation Basis is not a valid field for percent based plan [plan].   
 
top
 

Bonus_PlanObject

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

Bonus_PlanObjectID

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

Proposed_Merit_Plan_Assignment_Container_Data

part of: Compensation_Default_Data
Encapsulating element containing all Merit Plan Compensation data.
 
Parameter name Type/Value Cardinality Description Validations
@Replace  boolean  [1..1]  When True, indicates the compensation plans will replace any existing compensation plan assigned to the worker. The default value of False will add or update the compensation plans for the worker.   
Merit_Plan_Sub_Data  Proposed_Merit_Plan_Assignment_Data  [0..*]  Encapsulating element containing all Merit Plan Compensation data.   
top
 

Proposed_Merit_Plan_Assignment_Data

part of: Proposed_Merit_Plan_Assignment_Container_Data
Encapsulating element containing all Merit Plan Compensation data.
 
Parameter name Type/Value Cardinality Description Validations
Merit_Plan_Reference  Merit_PlanObject  [0..1]  Merit Plan to update or assign. Does not default for Request Compensation Change. 
Validation Description
Plan is required since system was unable to default from the existing compensation.   
 
Individual_Target_Amount  decimal (26, 6)   [0..1]  Individual target amount that overrides the default target amount on the plan, provided Allow Target Override is enabled on the plan. Mutually exclusive from Individual Target Percent. 
Validation Description
Amount cannot be entered for plan [plan] which is a percent based plan.   
Plan [plan] does not allow for individual overrides.   
 
Individual_Target_Percent  decimal (16, 6) >0   [0..1]  Individual target percent that overrides the default target percent on the plan, provided Allow Target Override is enabled on the plan. Mutually exclusive from Individual Target Amount. 
Validation Description
Percent cannot be entered for plan [plan] which is an amount based plan.   
Plan [plan] does not allow for individual overrides.   
 
Guaranteed_Minimum  boolean  [0..1]  If true, employee is guaranteed the minimum for the merit plan. 
Validation Description
Plan [plan] does not allow for individual overrides.   
 
Actual_End_Date  date  [0..1]  Actual End Date for the plan assignment. 
Validation Description
The Actual End Date must be on or after the Effective Date.   
Please check the Enable Actual End Date tenant setup - HCM flag before attempting to set the Actual End Date.   
 
top
 

Merit_PlanObject

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

Merit_PlanObjectID

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

Proposed_Commission_Plan_Assignment_Container_Data

part of: Compensation_Default_Data
Encapsulating element containing all Commission Plan Compensation data.
 
Parameter name Type/Value Cardinality Description Validations
@Replace  boolean  [1..1]  When True, indicates the compensation plans will replace any existing compensation plan assigned to the worker. The default value of False will add or update the compensation plans for the worker.   
Commission_Plan_Sub_Data  Proposed_Commission_Plan_Assignment_Data  [0..*]  Encapsulating element containing all Commission Plan Compensation data. 
Validation Description
Target Amount has to be greater than zero. If you do not wish to use Target Amount, leave the field blank.   
 
top
 

Proposed_Commission_Plan_Assignment_Data

part of: Proposed_Commission_Plan_Assignment_Container_Data
Encapsulating element containing all Commission Plan Compensation data.
 
Parameter name Type/Value Cardinality Description Validations
Commission_Plan_Reference  Commission_PlanObject  [0..1]  Commission plan to update or assign. Does not default for Request Compensation Change. 
Validation Description
Plan is required since system was unable to default from the existing compensation.   
 
Target_Amount  decimal (26, 6)   [0..1]  Target amount for the Commission Plan.   
Currency_Reference  CurrencyObject  [0..1]  Currency for the Commission Plan. Required if the target amount is entered and there is no default currency for the plan.   
Frequency_Reference  FrequencyObject  [0..1]  Frequency for the Commission Plan. Required if the target amount is entered and there is no default amount for the plan.   
Draw_Amount  decimal (21, 6) >0   [0..1]  Draw amount for the Commission Plan.   
Draw_Frequency_Reference  FrequencyObject  [0..1]  Reference element representing a unique instance of Frequency for the Draw Amount.   
Draw_Duration  string  [0..1]  Description of the duration of the draw amount. For informational purposes.   
Recoverable  boolean  [0..1]  If true, the compensation element is recoverable.   
Actual_End_Date  date  [0..1]  Actual End Date for the plan assignment. 
Validation Description
Please check the Enable Actual End Date tenant setup - HCM flag before attempting to set the Actual End Date.   
The Actual End Date must be on or after the Effective Date.   
 
Fixed_for_Manage_by_Basis_Total  boolean  [0..1]  This field allows a plan assignment for a remainder plan in the compensation basis algorithm to be considered a fixed plan assignment. This field is only valid for plans in the PCB of a worker that is managed by basis total where the plan allows override. The flag will be ignored if the conditions are not met.   
Validation Description
Target Amount has to be greater than zero. If you do not wish to use Target Amount, leave the field blank.   
top
 

Commission_PlanObject

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

Commission_PlanObjectID

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

Proposed_Stock_Plan_Assignment_Container_Data

part of: Compensation_Default_Data
Encapsulating element containing all Stock Plan Compensation data.
 
Parameter name Type/Value Cardinality Description Validations
@Replace  boolean  [1..1]  When True, indicates the compensation plans will replace any existing compensation plan assigned to the worker. The default value of False will add or update the compensation plans for the worker.   
Stock_Plan_Sub_Data  Proposed_Stock_Plan_Assignment_Data  [0..*]  Encapsulating element containing all Stock Plan Compensation data.   
top
 

Proposed_Stock_Plan_Assignment_Data

part of: Proposed_Stock_Plan_Assignment_Container_Data
Encapsulating element containing all Stock Plan Compensation data.
 
Parameter name Type/Value Cardinality Description Validations
Stock_Plan_Reference  Stock_PlanObject  [0..1]  Stock plan to update or assign. Does not default for Request Compensation Change. 
Validation Description
Plan is required since system was unable to default from the existing compensation.   
 
Individual_Target_Shares [Choice]   decimal (21, 6) >0   [0..1]  Individual target shares that overrides the default target shares on the plan, provided Allow Target Override is enabled on the plan. 
Validation Description
Plan [plan] does not allow for individual overrides.  Stock Plan does not allow override for individual target. 
Individual Target Shares is only valid if Stock Plan is unit based.   
 
Individual_Target_Percent [Choice]   decimal (18, 6) >0   [0..1]  Individual target percent that overrides the default target amount on the plan, provided Allow Target Override is enabled on the plan. 
Validation Description
Plan [plan] does not allow for individual overrides.  Stock Plan does not allow override for individual target. 
Individual Target Percent is only valid if Stock Plan is percent based.   
 
Individual_Target_Amount [Choice]   decimal (26, 6)   [0..1]  Individual target amount that overrides the default target amount on the plan, provided Allow Target Override is enabled on the plan. Mutually exclusive from Individual Target Percent. 
Validation Description
Plan [plan] does not allow for individual overrides.  Stock Plan does not allow override for individual target. 
Individual Target Amount is only valid if Stock Plan is an amount based.   
 
Manage_by_Compensation_Basis_Override_Amount  decimal (26, 6)   [0..1]  This field allows an override amount to be specified for workerswho are managed by compensation basis. 
Validation Description
Manage by Compensation Basis Override Amount is not a valid field for plan [plan] because worker [worker] is not managed by compensation basis.   
Override Compensation Basis Calculation field needs to be set to true to be able to specify a value for Manage by Compensation Basis Override Amount.   
Manage by Compensation Basis Override Amount is not valid for plan [plan] because the plan is not a percent based plan.   
Manage by Compensation Basis Override Amount is not a valid field for plan [plan] because the plan is not part of the worker's primary compensation basis.   
Manage by Compensation Basis Override Amount is required for plan [plan] because the plan is in worker [worker]'s primary compensation basis and Override Compensation Basis Calculation is set to true.   
 
Currency_Reference  CurrencyObject  [0..1]  Currency of the stock plan assignment. Only applicable for stock amount plans. 
Validation Description
Currency Reference is required when specifying an Individual Target Amount.   
Currency Reference for plan [plan] must be [currency] to match the currency of the worker's proposed pay range.   
Currency Reference must match the currency used by the referenced stock plan ([stock plan name]): [currency].   
Override Compensation Basis Calculation field needs to be set to true to be able to specify a value for Currency Reference.   
 
Actual_End_Date  date  [0..1]  Actual End Date for the plan assignment. 
Validation Description
Please check the Enable Actual End Date tenant setup - HCM flag before attempting to set the Actual End Date.   
The Actual End Date must be on or after the Effective Date.   
 
Fixed_for_Manage_by_Basis_Total  boolean  [0..1]  This field allows a plan assignment for a remainder plan in the compensation basis algorithm to be considered a fixed plan assignment. This field is only valid for plans in the PCB of a worker that is managed by basis total where the plan allows override. The flag will be ignored if the conditions are not met. 
Validation Description
Fixed for Manage by Compensation Basis is not a valid field for stock plan [plan] because it is not an amount based plan.   
 
top
 

Stock_PlanObject

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

Stock_PlanObjectID

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

Proposed_Period_Salary_Plan_Assignment_Container_Data

part of: Compensation_Default_Data
Encapsulating element containing all Period Salary Plan Compensation data.
 
Parameter name Type/Value Cardinality Description Validations
@Replace  boolean  [1..1]  When True, indicates the compensation plans will replace any existing compensation plan assigned to the worker. The default value of False will add or update the compensation plans for the worker.   
Period_Salary_Plan_Sub_Data  Proposed_Period_Salary_Plan_Assignment_Data  [0..*]  Encapsulating element containing all Period Salary Plan Compensation data. 
Validation Description
Manage by Compensation Basis Override Amount for Proposed Period Salary has to be greater than zero. If you do not wish to use Manage by Compensation Basis Override Amount, leave the field blank.   
 
top
 

Proposed_Period_Salary_Plan_Assignment_Data

part of: Proposed_Period_Salary_Plan_Assignment_Container_Data
Encapsulating element containing all Period Salary Plan Compensation data.
 
Parameter name Type/Value Cardinality Description Validations
Period_Salary_Plan_Reference  Period_Salary_PlanObject  [0..1]  Period salary plan to update or assign. Does not default for Request Compensation Change. 
Validation Description
Plan is required since system was unable to default from the existing compensation.   
 
Compensation_Period_Reference  Compensation_PeriodObject  [0..1]  Compensation period of time measure.   
Manage_by_Compensation_Basis_Override_Amount  decimal (26, 6)   [0..1]  This field allows an override amount to be specified for workerswho are managed by compensation basis. 
Validation Description
Manage by Compensation Basis Override Amount is not a valid field for plan [plan] because worker [worker] is not managed by compensation basis.   
Override Compensation Basis Calculation field needs to be set to true to be able to specify a value for Manage by Compensation Basis Override Amount.   
Manage by Compensation Basis Override Amount is not a valid field for plan [plan] because the plan is not part of the worker's primary compensation basis.   
Manage by Compensation Basis Override Amount is required for plan [plan] because the plan is in worker [worker]'s primary compensation basis and Override Compensation Basis Calculation is set to true.   
 
Currency_Reference  CurrencyObject  [0..1]  Currency of the period salary plan. 
Validation Description
Currency Reference for plan [plan] must be [currency] to match the currency of the worker's proposed pay range.   
Override Compensation Basis Calculation field needs to be set to true to be able to specify a value for Currency Reference.   
 
Compensation_Period_Multiplier  decimal (18, 6) >0   [0..1]  Default Compensation Period Multiplier is required.   
Frequency_Reference  FrequencyObject  [0..1]  Frequency of the period salary plan. 
Validation Description
Plan [plan] does not allow for individual overrides.   
Override Compensation Basis Calculation field needs to be set to true to be able to specify a value for Frequency Reference.   
 
Actual_End_Date  date  [0..1]  Actual End Date for the plan assignment. 
Validation Description
Please check the Enable Actual End Date tenant setup - HCM flag before attempting to set the Actual End Date.   
The Actual End Date must be on or after the Effective Date.   
 
Validation Description
Manage by Compensation Basis Override Amount for Proposed Period Salary has to be greater than zero. If you do not wish to use Manage by Compensation Basis Override Amount, leave the field blank.   
top
 

Period_Salary_PlanObject

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

Period_Salary_PlanObjectID

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

Compensation_PeriodObject

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

Compensation_PeriodObjectID

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

Proposed_Calculated_Plan_Assignment_Container_Data

part of: Compensation_Default_Data
Encapsulating element containing all Calculated Plan Compensation data.
 
Parameter name Type/Value Cardinality Description Validations
@Replace  boolean  [1..1]  When True, indicates the compensation plans will replace any existing compensation plan assigned to the worker. The default value of False will add or update the compensation plans for the worker.   
Calculated_Plan_Sub_Data  Proposed_Calculated_Plan_Assignment_Data  [0..*]  Encapsulating element containing all Calculated Plan Compensation data. 
Validation Description
Manage By Compensation Basis Override Amount for Proposed Calculated Plan has to be greater than zero. If you do not wish to use Manage By Compensation Basis Override Amount, leave the field blank.   
 
top
 

Proposed_Calculated_Plan_Assignment_Data

part of: Proposed_Calculated_Plan_Assignment_Container_Data
Encapsulating element containing all Calculated Plan Compensation data.
 
Parameter name Type/Value Cardinality Description Validations
Calculated_Plan_Reference  Calculated_PlanObject  [0..1]  Calculated plan to update or assign. Does not default for Request Compensation Change. 
Validation Description
Plan is required since system was unable to default from the existing compensation.   
 
Manage_by_Compensation_Basis_Override_Amount  decimal (26, 6)   [0..1]  This field allows an override amount to be specified for workerswho are managed by compensation basis. 
Validation Description
Manage by Compensation Basis Override Amount is not a valid field for plan [plan] because worker [worker] is not managed by compensation basis.   
Override Compensation Basis Calculation field needs to be set to true to be able to specify a value for Manage by Compensation Basis Override Amount.   
Manage by Compensation Basis Override Amount is not a valid field for plan [plan] because the plan is not part of the worker's primary compensation basis.   
Manage by Compensation Basis Override Amount is required for plan [plan] because the plan is in worker [worker]'s primary compensation basis and Override Compensation Basis Calculation is set to true.   
 
Currency_Reference  CurrencyObject  [0..1]  Currency of the calculated plan. 
Validation Description
Override Compensation Basis Calculation field needs to be set to true to be able to specify a value for Currency Reference.   
 
Frequency_Reference  FrequencyObject  [0..1]  Frequency of the calculated plan. 
Validation Description
Override Compensation Basis Calculation field needs to be set to true to be able to specify a value for Frequency Reference.   
 
Actual_End_Date  date  [0..1]  Actual End Date for the plan assignment. 
Validation Description
The Actual End Date must be on or after the Effective Date.   
The Actual End Date must be on or after the Effective Date.   
Please check the Enable Actual End Date tenant setup - HCM flag before attempting to set the Actual End Date.   
 
Validation Description
Manage By Compensation Basis Override Amount for Proposed Calculated Plan has to be greater than zero. If you do not wish to use Manage By Compensation Basis Override Amount, leave the field blank.   
top
 

Calculated_PlanObject

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

Calculated_PlanObjectID

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

Unique_IdentifierObject

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

Supervisory_OrganizationReferenceEnumeration

part of: Supervisory_OrganizationObjectID
Base Type
string
top
 

Event_Classification_SubcategoryReferenceEnumeration

part of: Event_Classification_SubcategoryObjectID
Base Type
string
top
 

Job_Family_BaseReferenceEnumeration

part of: Job_Family_BaseObjectID
Base Type
string
top
 

Job_ProfileReferenceEnumeration

part of: Job_ProfileObjectID
Base Type
string
top
 

LocationReferenceEnumeration

part of: LocationObjectID
Base Type
string
top
 

Worker_TypeReferenceEnumeration

part of: Worker_TypeObjectID
Base Type
string
top
 

Position_Time_TypeReferenceEnumeration

part of: Position_Time_TypeObjectID
Base Type
string
top
 

Position_Worker_TypeReferenceEnumeration

part of: Position_Worker_TypeObjectID
Base Type
string
top
 

Compensation_PackageReferenceEnumeration

part of: Compensation_PackageObjectID
Base Type
string
top
 

Compensation_GradeReferenceEnumeration

part of: Compensation_GradeObjectID
Base Type
string
top
 

Compensation_Grade_ProfileReferenceEnumeration

part of: Compensation_Grade_ProfileObjectID
Base Type
string
top
 

Compensation_StepReferenceEnumeration

part of: Compensation_StepObjectID
Base Type
string
top
 

Salary_Pay_PlanReferenceEnumeration

part of: Salary_Pay_PlanObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

FrequencyReferenceEnumeration

part of: FrequencyObjectID
Base Type
string
top
 

Salary_Unit_PlanReferenceEnumeration

part of: Salary_Unit_PlanObjectID
Base Type
string
top
 

Allowance_Value_PlanReferenceEnumeration

part of: Allowance_Value_PlanObjectID
Base Type
string
top
 

Allowance_Unit_PlanReferenceEnumeration

part of: Allowance_Unit_PlanObjectID
Base Type
string
top
 

Bonus_PlanReferenceEnumeration

part of: Bonus_PlanObjectID
Base Type
string
top
 

Merit_PlanReferenceEnumeration

part of: Merit_PlanObjectID
Base Type
string
top
 

Commission_PlanReferenceEnumeration

part of: Commission_PlanObjectID
Base Type
string
top
 

Stock_PlanReferenceEnumeration

part of: Stock_PlanObjectID
Base Type
string
top
 

Period_Salary_PlanReferenceEnumeration

part of: Period_Salary_PlanObjectID
Base Type
string
top
 

Compensation_PeriodReferenceEnumeration

part of: Compensation_PeriodObjectID
Base Type
string
top
 

Calculated_PlanReferenceEnumeration

part of: Calculated_PlanObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top