Service Directory > v31.2 > Staffing > Get_Positions
 

Operation: Get_Positions

Returns information for position management positions. If a position is filled, identifies the worker filling the position.


@ - A parameter name with this symbol denotes an XML attribute within the document instead of an XML element.


Contents

 

Web Service

 

Request

 

Response

 

Element(s)

 

Request Element: Get_Positions_Request

Request element to get position management positions and their associated data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Position_Request_References  [0..1]  Utilize the Request References element to retrieve a specific instance(s) of Position and its associated data. 
Validation Description
Position [position] is not a position management position. This web service only returns position management positions.   
The Position has a future dated request [date].   
 
Request_Criteria  Position_Request_Criteria  [0..1]  Utilize the Request Criteria element to search the transaction log for specific instance(s) of a Position.   
Response_Filter  Response_Filter  [0..1]  The "Response_Filter" element contains common WWS information that allows you control the response data that you will be provided including As_Of_Date, As_Of_Entry_Moment, and Page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Position_Response_Group  [0..1]  The response group allows for the response data to be tailored to only included elements that the user is looking for. If no response group is provided in the request the only the following elements will be returned: Reference and Position Definition Data   
top
 

Response Element: Get_Positions_Response

Response element containing instances of positions and their associated data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Position_Request_References  [0..*]  Utilize the Request References element to retrieve a specific instance(s) of Position and its associated data. 
Validation Description
Position [position] is not a position management position. This web service only returns position management positions.   
The Position has a future dated request [date].   
 
Request_Criteria  Position_Request_Criteria  [0..*]  Utilize the Request Criteria element to search the transaction log for specific instance(s) of a Position.   
Response_Filter  Response_Filter  [0..*]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Position_Response_Group  [0..*]  The response group allows for the response data to be tailored to only included elements that the user is looking for. If no response group is provided in the request the only the following elements will be returned: Reference and Position Definition Data   
Response_Results  Response_Results  [0..*]  The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.   
Response_Data  Positions_Response_Data  [0..*]  Contains each Position based on the Request References or Request Criteria. The data returned is the current information as of the dates in the response filter, and does not include all historical information about the position.   
Invalid_Reference_ID_Response  Invalid_Reference_ID_Response  [0..*]  Invalid Reference ID Response   
top
 

Position_Request_References

part of: Get_Positions_Request, Get_Positions_Response
Utilize the Request References element to retrieve a specific instance(s) of Position and its associated data.
 
Parameter name Type/Value Cardinality Description Validations
@Skip_Non_Existing_Instances  boolean  [1..1]     
@Ignore_Invalid_References  boolean  [1..1]     
Positions_Reference  Position_ElementObject  [1..*]  An unique identifier for a Position requested.   
Validation Description
Position [position] is not a position management position. This web service only returns position management positions.   
The Position has a future dated request [date].   
top
 

Position_ElementObject

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

Position_ElementObjectID

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

part of: Get_Positions_Request, Get_Positions_Response
Utilize the Request Criteria element to search the transaction log for specific instance(s) of a Position.
 
Parameter name Type/Value Cardinality Description Validations
Transaction_Log_Criteria_Data  Transaction_Log_Criteria  [0..*]  Searches the transaction log for business processes and event lites to find specific events that occurred during a period of time. 
Validation Description
Subscriber Reference must have an enabled Transaction Log Service configuration.  Subscriber Reference must have an enabled Transaction Log Service configuration. 
 
Supervisory_Organization_Reference  Supervisory_OrganizationObject  [0..*]  A unique identifier for the organization. 
Validation Description
Supervisory Organization(s) [orgs] must be active.   
 
Job_Requisition_Reference  Job_RequisitionObject  [0..*]  A unique Identifier for a Job Requisition for a Position. Identifies all positions connected to the Job Requisition.   
Exclude_Filled_Positions  boolean  [0..1]  Indicates if filled positions are to be returned in the response   
Exclude_Non-Recruitable_Positions  boolean  [0..1]  If set to true, indicates that non-recruitable positions are to be excluded in the response. Non-recruitable positions include those with an open Job Requisition if the Recruiting Instruction is specified as "Do Not Send To Recruiting System".   
Ignore_Future_Positions  boolean  [0..1]  No data will be returned for positions that are available after the effective date of the request. The position information will remain in the request criteria and they will not cause an error.   
Include_Closed_Positions  boolean  [0..1]  Indicates if closed positions are to be included in the response   
Show_Only_Closed_Positions  boolean  [0..1]  Indicates if only closed positions are to be returned in the response   
Event_Reference  EventObject  [0..1]  The identifier of an existing Event.   
Field_And_Parameter_Criteria_Data  Field_And_Parameter_Criteria_Data  [0..1]  Field Result Request Criteria   
Location_Reference  LocationObject  [0..*]  Reference(s) to the location that a worker being hired/contracted using this opening can use. The results for this criteria are combined(union operation) with the results from the Additional Locations Reference criteria   
Additional_Locations_Reference  LocationObject  [0..*]  Reference to Additional Location(s) for the Job Requisition. This also applies to Positions that have Job Requisitions. The results for this criteria are combined(union operation) with the results from the Location Reference criteria   
top
 

Transaction_Log_Criteria

part of: Position_Request_Criteria
Searches the transaction log for business processes and event lites to find specific events that occurred during a period of time.
 
Parameter name Type/Value Cardinality Description Validations
Transaction_Date_Range_Data  Effective_And_Updated_DateTime_Data  [0..1]  Encapsulating element containing Effective and Updated DateTime data. 
Validation Description
Updated Through must be less than or equal to Current Moment!  Updated Through must be less than or equal to Current Moment! 
Effective From must be less than or equal to Effective Through!  Effective From must be less than or equal to Effective Through! 
If one of Effective From or Effective Through contains a value, both are Required!  If one of Effective From or Effective Through contains a value, both are Required! 
If one of Updated From or Updated Through contains a value, both are Required!  If one of Updated From or Updated Through contains a value, both are Required! 
Updated From must be less than or equal to Updated Through!  Updated From must be less than or equal to Updated Through! 
 
Transaction_Type_References [Choice]   Transaction_Type_References  [0..1]  If specified, this search criteria will return those Transaction Log Entries which match the Transaction Types specified here.   
Subscriber_Reference [Choice]   SubscriberObject  [0..1]  If specified, this search criterium will return those Transaction Log Entries that match the Transaction Types defined in the subscription of the subscriber.   
Validation Description
Subscriber Reference must have an enabled Transaction Log Service configuration.  Subscriber Reference must have an enabled Transaction Log Service configuration. 
top
 

Effective_And_Updated_DateTime_Data

part of: Transaction_Log_Criteria
Element contains effective and updated date/time data.
 
Parameter name Type/Value Cardinality Description Validations
Updated_From  dateTime  [0..1]  Defines the earliest moment (e.g. datetime) data was entered into the Workday system.   
Updated_Through  dateTime  [0..1]  Defines the latest moment (e.g. datetime) data was entered into the Workday system.   
Effective_From  dateTime  [0..1]  Defines the earliest Effective Date (e.g. As Of Date) data is marked within the Workday system.   
Effective_Through  dateTime  [0..1]  Defines the latest Effective Date (e.g. As Of Date) data is marked within the Workday system.   
Validation Description
Updated Through must be less than or equal to Current Moment!  Updated Through must be less than or equal to Current Moment! 
Effective From must be less than or equal to Effective Through!  Effective From must be less than or equal to Effective Through! 
If one of Effective From or Effective Through contains a value, both are Required!  If one of Effective From or Effective Through contains a value, both are Required! 
If one of Updated From or Updated Through contains a value, both are Required!  If one of Updated From or Updated Through contains a value, both are Required! 
Updated From must be less than or equal to Updated Through!  Updated From must be less than or equal to Updated Through! 
top
 

Transaction_Type_References

part of: Transaction_Log_Criteria
Wrapper element containing Transaction Types.
 
Parameter name Type/Value Cardinality Description Validations
Transaction_Type_Reference  Transaction_Log_TypeObject  [0..*]  If specified, this search criterium will return those Transaction Log Entries with Transaction Types that match the search criterium.   
top
 

Transaction_Log_TypeObject

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

Transaction_Log_TypeObjectID

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

SubscriberObject

part of: Transaction_Log_Criteria
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  SubscriberObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

SubscriberObjectID

part of: SubscriberObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Integration_Service_Name, Integration_System_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Supervisory_OrganizationObject

part of: Position_Request_Criteria, Position_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Supervisory_OrganizationObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Supervisory_OrganizationObjectID

part of: Supervisory_OrganizationObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Organization_Reference_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Job_RequisitionObject

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

Job_RequisitionObjectID

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

EventObject

part of: Position_Request_Criteria
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  EventObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

EventObjectID

part of: EventObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Absence_Case_ID, Assignable_Payroll_ID, Background_Check_ID, Background_Process_Instance_ID, Backorder_Event_ID, Budget_Amendment_ID, Change_Order_Reference_ID, Compensation_Review_Event_ID, Customer_Request_ID, Customer_Request_Reference_ID, Eligibility_Override_Event_ID, Employee_Review_ID, Employee_Severance_Worksheet_Event_ID, Goods_Delivery_Group_ID, Goods_Delivery_Run_ID, Historical_Student_Charge_ID, Invite_Committee_Candidate_Event_ID, IRS_1099_MISC_Adjustment_ID, Mass_Change_Requisition_Requester_ID, Medicare_Information_Event_ID, Position_Budget_Group_ID, Procurement_Mass_Close_ID, Procurement_Mass_ReOpen_ID, Procurement_Roll_Forward_ID, Receipt_Number, Reorganization_ID, Request_Leave_of_Absence_ID, Requisition_Sourcing_Event_ID, Spend_Authorization_ID, Spend_Authorization_Mass_Close_ID, Student_Charge_Adjustment_ID, Student_Charge_Document_ID, Student_Charge_ID, Student_Dismissal_Event_ID, Student_Employment_Eligibility_Event_ID, Student_Hold_Assignment_Override_Event_ID, Student_Institutional_Withdrawal_Event_ID, Student_Leave_of_Absence_Event_ID, Supplier_Contract_Amendment_ID, Supplier_Contract_History_ID, Supplier_Contract_ID, Supplier_Invoice_Contract_ID, Workday_Project_ID, Worker_Time_Card_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
 

Field_And_Parameter_Criteria_Data

part of: Position_Request_Criteria
Field Result Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
Provider_Reference  External_Field_and_Parameter_Initialization_ProviderObject  [1..*]  Field And Parameter Initialization Provider Reference   
top
 

External_Field_and_Parameter_Initialization_ProviderObject

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

External_Field_and_Parameter_Initialization_ProviderObjectID

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

Response_Filter

part of: Get_Positions_Request, Get_Positions_Response
Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.
 
Parameter name Type/Value Cardinality Description Validations
As_Of_Effective_Date  date  [0..1]  Indicates the date when application data, such as benefits and compensation, are deemed effective in the Workday system. (Also referred to as the "Effective Moment".) If not specified, this date defaults to TODAY.   
As_Of_Entry_DateTime  dateTime  [0..1]  Indicates the date and time that data was entered into the system. (This field is also referred to as the "Entry Moment".) If not specified, defaults to the CURRENT DATE/TIME.   
Page  decimal (12, 0) >0   [0..1]  Indicates the page of data to return in the response, and defaults to the first page (Page = 1). For responses that contain more than one page of data, use this parameter to retrieve the additional pages of data. For example, set Page = 2 to retrieve the second page of data. Note: If you set the page parameter, you must also specify the "As_Of_Entry_Date" to ensure that the result set remains the same between your requests.   
Count  decimal (3, 0) >0   [0..1]  Sets the number of objects to return within each response page (Min = 1, Max = 999, Default = 100 if not set). Any values you set must be between 1-999.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Position_Response_Group

part of: Get_Positions_Request, Get_Positions_Response
The response group allows for the response data to be tailored to only included elements that the user is looking for. If no response group is provided in the request the only the following elements will be returned: Reference and Position Definition Data
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Indicates if the Reference for the Position is included in the response.   
Include_Position_Definition_Data  boolean  [0..1]  Indicates if the details of the Position is included in the response.   
Include_Position_Restrictions_Data  boolean  [0..1]  Indicates if the Hiring Restrictions is included in the response.   
Include_Default_Compensation_Data  boolean  [0..1]  Indicates if the Default Compensation is included in the response.   
Include_Default_Position_Organization_Assignment_Data  boolean  [0..1]  Indicates if the Default Position Organization Assignment Data is included in the response.   
Include_Worker_For_Filled_Positions_Data  boolean  [0..1]  Indicates if the Worker for Filled Positions is included in the response.   
Include_Qualifications  boolean  [0..1]  Indicates if the Position's Qualifications (Competencies, Education, Responsibilities, etc.) are included in the response.   
Include_Job_Requisition_Data  boolean  [0..1]  Indicates if the Position's Open Job Requisition (if there is one) is included in the response.   
Include_Job_Requisition_Attachments  boolean  [0..1]  Indicates if the Position's Open Job Requisition Attachments (if they exist) are included in the response.   
top
 

Response_Results

part of: Get_Positions_Response
The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.
 
Parameter name Type/Value Cardinality Description Validations
Total_Results  decimal (12, 0) >0   [0..1]  The total number of results that have been returned from your request.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages that exist for your request. A page of data in WWS contains a maximum of 100 entries. So, if you have exactly 1,000 employees returned in a request, then you will have 10 pages of data that will need to be retrieved to build your complete dataset. Each page contains a maximum of 100 entries.   
Page_Results  decimal (12, 0) >0   [0..1]  Number of Results in current page.   
Page  decimal (12, 0) >0   [0..1]  The page of data that has been returned for the given request.   
top
 

Positions_Response_Data

part of: Get_Positions_Response
Contains each Position based on the Request References or Request Criteria. The data returned is the current information as of the dates in the response filter, and does not include all historical information about the position.
 
Parameter name Type/Value Cardinality Description Validations
Position  Position_Restriction  [0..*]  Contains each Position based on the Request References or Request Criteria. The data returned is the current information as of the dates in the response filter, and does not include all historical information about the position.   
top
 

Position_Restriction

part of: Positions_Response_Data
Contains each Position based on the Request References or Request Criteria. The data returned is the current information as of the dates in the response filter, and does not include all historical information about the position.
 
Parameter name Type/Value Cardinality Description Validations
Position_Reference  Position_RestrictionsObject  [0..1]  A unique identifier to reference a Position.   
Position_Data  Position_Data  [0..1]  Contains the detailed information about a Position.   
top
 

Position_RestrictionsObject

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

Position_RestrictionsObjectID

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

part of: Position_Restriction
Contains the detailed information about a Position.
 
Parameter name Type/Value Cardinality Description Validations
Supervisory_Organization_Reference  Supervisory_OrganizationObject  [1..1]  Reference to the supervisory organization on the position.   
Effective_Date  date  [0..1]  Date this position is effective.   
Position_Definition_Data  Position_Details_Data  [0..1]  Wrapper element for general data pertaining to a position opening.   
Position_Restrictions_Data  Position_Group_Restriction_Summary_Data  [0..1]  Wrapper for restriction data for openings for all staffing models.   
Default_Compensation_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.   
Default_Position_Organization_Assignments_Data  Default_Position_Organization_Assignments_Data  [0..1]  Wrapper element for the default organization assignments for the Position.   
Worker_For_Filled_Position  Worker_For_Filled_Position  [0..1]  Wrapper element for Worker Filling Position.   
Qualification_Data  Qualifications_from_Position_Restrictions_Data  [0..1]  Contains the position's and it's job profile's qualification information which includes the following: Competency, Certification, Education, Language, Responsibility, Training, and Work Experience   
Integration_Field_Override_Data  Document_Field_Result_Data  [0..*]  Position External Field Result Data   
Job_Requisition_Data  Job_Requisition_Data  [0..1]  Returns the effective Job Requisition for the Position. Starting in WD22, this requisition can have a status of 'Open' or 'Frozen'. If you need to see that status, please use the v22.0 version of the web service.   
Closed  boolean  [0..1]  Returns true of the position is closed.   
top
 

Position_Details_Data

part of: Position_Data
Wrapper element for general data pertaining to a position opening.
 
Parameter name Type/Value Cardinality Description Validations
Position_ID  string  [0..1]  Unique identifier for the Position   
Job_Posting_Title  string  [0..1]  Job Posting Title for the Position.   
Academic_Tenure_Eligible  boolean  [0..1]  Value that represents if the position is eligible for academic tenure.   
Job_Description_Summary  string  [0..1]  Job Description Summary (plain text) for the Position.   
Job_Description  RichText  [0..1]  Job Description (rich text) for the Position.   
Position_Status_Reference  Worker_EventObject  [0..*]  The various statuses for the Position.   
Available_For_Hire  boolean  [0..1]  Returns a true if this is able to be filled by a worker.   
Available_for_Recruiting  boolean  [0..1]  Returns true if this is available for recruiting. If Enable Job Requisitons is turned off in the tenant, this is the same as Available for Hire.   
Hiring_Freeze  boolean  [0..1]  Boolean attribute identifying whether a Hiring Freeze is currently in affect.   
Work_Shift_Required  boolean  [0..1]  Returns true if the position is restricted to only one job profile and that job profile requires a work shift.   
Available_for_Overlap  boolean  [0..1]  Returns true if the Position Restriction is available to be overlapped.   
Earliest_Overlap_Date  date  [0..1]  Returns the earliest date this Position Restriction can be filled with an overlapping worker. This will only have a value if the position restriction is available to be overlapped.   
Critical_Job  boolean  [0..1]  Boolean attribute which is set to yes if the Position Restriction is considered a critical job.   
Difficulty_to_Fill_Reference  Difficulty_to_FillObject  [0..1]  Reference to the Difficulty to Fill for this Position Restriction.   
top
 

Worker_EventObject

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

Worker_EventObjectID

part of: Worker_EventObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Absence_Case_ID, Assignable_Payroll_ID, Background_Check_ID, Background_Process_Instance_ID, Employee_Review_ID, Employee_Severance_Worksheet_Event_ID, Medicare_Information_Event_ID, Request_Leave_of_Absence_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
 

Difficulty_to_FillObject

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

Difficulty_to_FillObjectID

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

Position_Group_Restriction_Summary_Data

part of: Position_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.   
Earliest_Hire_Date  date  [0..1]  Earliest date that a worker can be hired/contracted into this opening.   
Job_Family_Reference  Job_Family_BaseObject  [0..*]  Reference(s) to the job families that a worker being hired/contracted using this opening can use.   
Job_Profile_Restriction_Summary_Data  Job_Profile_Summary_Data  [0..*]  Reference(s) (and additional data) to the job profiles that a worker being hired/contracted using this opening can use.   
Location_Reference  LocationObject  [0..*]  Reference(s) to the location that a worker being hired/contracted using this opening can use.   
Worker_Type_Reference  Worker_TypeObject  [0..1]  Reference to the worker type that a worker being hired/contracted using this opening can use.   
Time_Type_Reference  Position_Time_TypeObject  [0..1]  Reference to the time type that a worker being hired/contracted using this opening can use.   
Position_Worker_Type_Reference  Position_Worker_TypeObject  [0..*]  Reference(s) to the position worker types that the position is restricted by (e.g., Regular, Contractor, Temporary).   
top
 

Job_Family_BaseObject

part of: Job_Profile_Summary_Data, Position_Group_Restriction_Summary_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_Profile_Summary_Data

part of: Position_Group_Restriction_Summary_Data
Contains the details of a Job Profile.
 
Parameter name Type/Value Cardinality Description Validations
Job_Profile_Reference  Job_ProfileObject  [0..1]  A unique identifier for the job profile.   
Job_Profile_Name  string  [0..1]  The name of the job profile.   
Management_Level_Reference  Management_LevelObject  [0..1]  A unique identifier for the management level.   
Job_Category_Reference  Job_CategoryObject  [0..1]  A unique identifier for the job category.   
Job_Family_Reference  Job_Family_BaseObject  [0..*]  A unique identifier for the job family.   
Work_Shift_Required  boolean  [0..1]  A boolean attribute that returns true if a work shift is required on the position where this job profile is used.   
Job_Profile_Exempt_Data  Job_Profile_Exempt_Data  [0..*]  Element containing the Job Profile Exempt data for a Job Profile. 
Validation Description
Only one Job Exempt entry for a Country/Country Region is allowed. This Country/Country Region is entered more than once: [Location Context].   
 
Critical_Job  boolean  [0..1]  Boolean attribute indicating whether the job profile is considered a critical job.   
Difficulty_to_Fill_Reference  Difficulty_to_FillObject  [0..1]  A unique identifier for the difficulty to fill.   
top
 

Job_ProfileObject

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

Management_LevelObject

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

Management_LevelObjectID

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

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

Job_CategoryObjectID

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

Job_Profile_Exempt_Data

part of: Job_Profile_Summary_Data
Element containing the Job Profile Exempt data for a Job Profile.
 
Parameter name Type/Value Cardinality Description Validations
@Delete  boolean  [1..1]  If True is entered, the Job Exempt for the supplied Country/Country Region reference will be deleted. 
Validation Description
Delete is selected but the Job Profile does not have a Job Exempt entry for this Country/Country Region as of the effective date. Job Profile: [profile] Country/Country Region: [location] Effective Date: [date]   
 
Location_Context_Reference  Location_ContextObject  [1..1]  Contains the reference to the Country Reference or Country Region Reference for this Job Exempt value. Leave ISO 3166 1 Alpha 2 Code blank when there‚Äôs a value on Location Context.   
Job_Exempt  boolean  [0..1]  Returns True if the Job Profile is Exempt for the given Country or Country Region.   
Validation Description
Only one Job Exempt entry for a Country/Country Region is allowed. This Country/Country Region is entered more than once: [Location Context].   
top
 

Location_ContextObject

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

Location_ContextObjectID

part of: Location_ContextObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Country_Region_ID, Country_Subregion_Code_In_Country, Country_Subregion_Internal_ID, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_Code, ISO_3166-2_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".   
@parent_id  string  [1..1]  Contains a unique identifier for an instance of a parent object   
@parent_type  WID, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_Code  [1..1]  The unique identifier type of a parent object   
top
 

Worker_TypeObject

part of: Position_Group_Restriction_Summary_Data, Job_Requisition_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_Summary_Data, Job_Requisition_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_Summary_Data, Job_Requisition_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
 

Compensation_Default_Data

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