Service Directory > v32.1 > Recruiting > Offer
 

Operation: Offer

Web service to initiate offer for a job application


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

A request to initiate offer
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Dynamic_Business_Process_Parameters  Dynamic_Business_Process_Parameters  [0..1]  Container for the processing options for a dynamic business process. If no options are submitted, the process does not move to the next stage or disposition. 
Validation Description
The next step or disposition chosen is invalid for the job application process.   
 
Offer_Data  Offer_Data  [1..1]  Contains the details of the offer and compensation 
Validation Description
The next step or disposition chosen is invalid for the job application process on offer stage   
Offer stage is not a valid next stage based off the current stage of the dynamic business process and the allowed next steps in its definition.   
The next step or disposition chosen is invalid for the job application process on offer stage   
The Business Process must be in progress to move candidate to the next stage.   
 
top
 

Response Element: Offer_Response

Wrapper element for Offer response.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Offer_Event_Reference  Unique_IdentifierObject  [0..1]  Offer event reference   
top
 

Dynamic_Business_Process_Parameters

part of: Offer_Request
Container for the processing options for a dynamic business process. If no options are submitted, the process does not move to the next stage or disposition.
 
Parameter name Type/Value Cardinality Description Validations
Next_Step_Reference [Choice]   Workflow_StepObject  [1..1]  Sends the dynamic business process to the next specified sub-process. This must be a valid next stage based off the current stage of the dynamic business process and the allowed next steps in its definition.   
Disposition_Step_Reference [Choice]   Workflow_StepObject  [1..1]  The disposition step for the dynamic business process. This must be a valid disposition step for the current stage of the business process according to the business process definition.   
Comment_Data  Business_Process_Comment_Data  [0..*]  Captures a comment for the Business Process.   
Validation Description
The next step or disposition chosen is invalid for the job application process.   
top
 

Workflow_StepObject

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

Workflow_StepObjectID

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

Business_Process_Comment_Data

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

WorkerObject

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

WorkerObjectID

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

Offer_Data

part of: Offer_Request
Contains the details of the offer and compensation
 
Parameter name Type/Value Cardinality Description Validations
Job_Application_Event_Reference [Choice]   Unique_IdentifierObject  [1..1]  A reference to the Job Application Event associated to the offer.   
Job_Application_Reference [Choice]   Job_ApplicationObject  [1..1]  A reference to the Job Application associated to the offer.   
Candidate_Criteria_Data [Choice]   Move_Candidate_Criteria  [1..1]  A Candidate and Job Requisition reference associated with the offer.   
Offer_Event_Data  Offer_Event_Data  [1..1]  Contains the offer details 
Validation Description
Proposed End Date is required when worker type is Contingent Worker   
Change the proposed dates so that the Proposed End Date is on or after the Proposed Start Date.   
Select a valid hire reason associated with the offer   
The Hire Date must be on or after the Recruiting Start Date of the Requisition.   
Job Profile does not meet the restrictions for the proposed Requisition.   
 
Propose_Compensation_Sub_Process  Propose_Compensation_For_Employment_Sub_Business_Process  [0..1]  Wrapper element for the Propose Compensation for Hire and Offer sub business processes. If any errors are found during processing, the Auto Complete boolean will be set to False and manual processing will occur for these business processes.   
Request_One_Time_Payment_Sub_Process  Request_One_Time_Payment_Sub_Business_Process  [0..1]  Grant an employee a one-time payment such as a referral, spot bonus, or severance pay. Uses the Request One Time Payment business event through the web service. Can be skipped, processed automatically or processed manually. 
Validation Description
Request One Time Payment Data element must be provided if Automatically Complete is True.   
Multiple One-Time Payment is not enabled. Please enable Multiple One-Time Payment in HCM Tenant Setup - Compensation.   
 
Request_Stock_Grant_Sub_Process  Request_Stock_Offer_Sub_Business_Process  [0..1]  Wrapper element for the Request Stock Grant sub business process. 
Validation Description
Request Stock Grant Data element is required if Automatically Complete is True   
 
Validation Description
The next step or disposition chosen is invalid for the job application process on offer stage   
Offer stage is not a valid next stage based off the current stage of the dynamic business process and the allowed next steps in its definition.   
The next step or disposition chosen is invalid for the job application process on offer stage   
The Business Process must be in progress to move candidate to the next stage.   
top
 

Unique_IdentifierObject

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

Unique_IdentifierObjectID

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

Job_ApplicationObject

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

Job_ApplicationObjectID

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

Move_Candidate_Criteria

part of: Offer_Data
Collects the Candidate reference and Job Requisition reference
 
Parameter name Type/Value Cardinality Description Validations
Candidate_Reference  CandidateObject  [1..1]  A reference to the Candidate.   
Requisition_Reference  Job_Requisition_EnabledObject  [1..1]  A reference to a Requisition   
top
 

CandidateObject

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

CandidateObjectID

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

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

Job_Requisition_EnabledObjectID

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

Offer_Event_Data

part of: Offer_Data
Contains offer details
 
Parameter name Type/Value Cardinality Description Validations
Hire_Date  date  [1..1]  The hire date associated with the offer   
Hire_Reason_Reference  Event_Classification_SubcategoryObject  [0..1]  The hire reason associated with the offer   
Location_Reference  LocationObject  [1..1]  The location associated with the offer   
Proposed_End_Date  date  [0..1]  The proposed end date associated with the offer   
Document_Language_Reference  User_LanguageObject  [1..1]  The document language associated with the offer   
Job_Profile_Reference  Job_ProfileObject  [1..1]  The job profile associated with the offer   
Business_Title  string  [1..1]  The business title associated with the offer   
Default_Weekly_Hours  decimal (5, 2) >0   [0..1]  The default weekly hours associated with the offer   
Scheduled_Weekly_Hours  decimal (5, 2) >0   [0..1]  The scheduled weekly hours associated with the offer   
Specify_Paid_FTE  boolean  [0..1]  True if Paid FTE Percentage is specified. 
Validation Description
The Paid FTE localization isn’t active for [country]. Activate the Paid FTE localization.   
 
Paid_FTE  decimal (22, 12) >0   [0..1]  The paid full time equivalent percentage for the position, entered as a decimal value. This overrides the calculated full time equivalent. 
Validation Description
Set Specify Paid FTE to true before you submit a Paid FTE percentage.   
Paid FTE cannot be greater than 999%.   
 
Specify_Working_FTE  boolean  [0..1]  True if Working FTE Percentage is specified. 
Validation Description
The Working FTE localization isn’t active for [country]. Activate the Working FTE localization.   
 
Working_FTE  decimal (22, 12) >0   [0..1]  The working full time equivalent percentage for the position, entered as a decimal value. This overrides the calculated full time equivalent. 
Validation Description
Working FTE cannot be greater than 999%.   
Set Specify Working FTE to true before you submit a Working FTE percentage.   
 
Validation Description
Proposed End Date is required when worker type is Contingent Worker   
Change the proposed dates so that the Proposed End Date is on or after the Proposed Start Date.   
Select a valid hire reason associated with the offer   
The Hire Date must be on or after the Recruiting Start Date of the Requisition.   
Job Profile does not meet the restrictions for the proposed Requisition.   
top
 

Event_Classification_SubcategoryObject

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

Event_Classification_SubcategoryObjectID

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

LocationObject

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

User_LanguageObject

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

User_LanguageObjectID

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

Job_ProfileObject

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

Propose_Compensation_For_Employment_Sub_Business_Process

part of: Offer_Data
Wrapper element for the Propose Compensation for Hire and Offer sub business processes. If any errors are found during processing, the Auto Complete boolean will be set to False and manual processing will occur for these business processes.
 
Parameter name Type/Value Cardinality Description Validations
Business_Sub_Process_Parameters  Business_Sub_Process_Parameters  [0..1]  Container for the processing options for sub-business processes within a business process. If no options are submitted (or the options are submitted as 'false') then the sub-business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.   
Propose_Compensation_for_Hire_Data  Compensation_Proposed_For_Employment_Data  [0..1]  Data element for the Propose Compensation for Hire business process. 
Validation Description
Primary Compensation Basis amount has to be greater than zero. If you do not wish to use Primary Compensation Basis, leave the field blank.  Primary Compensation Basis amount has to be greater than zero. If you do not wish to use Primary Compensation Basis, leave the field blank. 
 
top
 

Business_Sub_Process_Parameters

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

Business_Process_Attachment_Data

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

Event_Attachment_CategoryObject

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

Event_Attachment_CategoryObjectID

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

Compensation_Proposed_For_Employment_Data

part of: Propose_Compensation_For_Employment_Sub_Business_Process
Data element for the Propose Compensation for Hire business process.
 
Parameter name Type/Value Cardinality Description Validations
Primary_Compensation_Basis  decimal (26, 6)   [0..1]  Sum of the worker's plan assignments as defined by their primary compensation basis.   
Compensation_Guidelines_Data  Compensatable_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_Job_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_Data  Proposed_Allowance_Plan_Assignment_Container_Data  [0..1]  Encapsulating element containing all Allowance Plan Compensation data.   
Unit_Allowance_Plan_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.   
Validation Description
Primary Compensation Basis amount has to be greater than zero. If you do not wish to use Primary Compensation Basis, leave the field blank.  Primary Compensation Basis amount has to be greater than zero. If you do not wish to use Primary Compensation Basis, leave the field blank. 
top
 

Compensatable_Guidelines_Data

part of: Compensation_Proposed_For_Employment_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.   
Progression_Start_Date  date  [0..1]  Start date for the Compensation Step.   
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_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_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_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_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_Job_Assignment_Container_Data

part of: Compensation_Proposed_For_Employment_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_Job_Assignment_Data  [0..*]  Encapsulating element containing all Salary or Hourly Plan Compensation data.   
top
 

Proposed_Base_Pay_Plan_Job_Assignment_Data

part of: Proposed_Base_Pay_Plan_Job_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.   
Amount  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].   
 
Currency_Reference  CurrencyObject  [1..1]  Currency of the plan assignment.   
Frequency_Reference  FrequencyObject  [1..1]  Frequency of the salary or hourly plan. Required if the plan has no default frequency.   
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 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.   
 
top
 

Salary_Pay_PlanObject

part of: Proposed_Base_Pay_Plan_Job_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: One-Time_Payment_Data, Proposed_Salary_Unit_Plan_Assignment_Data, Proposed_Allowance_Plan_Assignment_Data, Proposed_Allowance_Unit_Plan_Assignment_Data, Proposed_Commission_Plan_Assignment_Data, Proposed_Base_Pay_Plan_Job_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_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_Base_Pay_Plan_Job_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_Proposed_For_Employment_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_Proposed_For_Employment_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_Proposed_For_Employment_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_Proposed_For_Employment_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_Proposed_For_Employment_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_Proposed_For_Employment_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_Proposed_For_Employment_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]  Workday ignores any currency specified for the stock plan and assigns a currency based on worker eligibility for stock plans. 
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.   
 
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, Request_Stock_Grant_Offer_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_Proposed_For_Employment_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_Proposed_For_Employment_Data
Encapsulating element containing all Calculated Plan Compensation data.
 
Parameter name Type/Value Cardinality Description Validations
@Replace  boolean  [1..1]  When True, indicates the compensation plans will replace any existing compensation plan assigned to the worker. The default value of False will add or update the compensation plans for the worker.   
Calculated_Plan_Sub_Data  Proposed_Calculated_Plan_Assignment_Data  [0..*]  Encapsulating element containing all Calculated Plan Compensation data. 
Validation Description
Manage By Compensation Basis Override Amount for Proposed Calculated Plan has to be greater than zero. If you do not wish to use Manage By Compensation Basis Override Amount, leave the field blank.   
 
top
 

Proposed_Calculated_Plan_Assignment_Data

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

Calculated_PlanObject

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

Calculated_PlanObjectID

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

Request_One_Time_Payment_Sub_Business_Process

part of: Offer_Data
Grant an employee a one-time payment such as a referral, spot bonus, or severance pay. Uses the Request One Time Payment business event through the web service. Can be skipped, processed automatically or processed manually.
 
Parameter name Type/Value Cardinality Description Validations
Business_Sub_Process_Parameters  Business_Sub_Process_Parameters  [0..1]  Parameters to indicate whether the subprocess should be completed automatically, initiated and left for manual completion, or skipped. If skip is selected, the subprocess must be tagged as optional.   
Request_One_Time_Payment_Data  One-Time_Payment_Data  [0..*]  Data Element that contains the one-time payment information for the terminate employee process. 
Validation Description
Scheduled Payment Date cannot take place before the Effective Date.   
The coverage period End Date must be on or after Start Date.   
Coverage Start Date and Coverage End Date can not be entered for a One-Time Payment Plan that does not have Coverage Dates enabled.   
If specifying a Coverage Date range, then both dates must be specified.   
Scheduled Payment Date must be equal to Event Effective Date when Multiple One-Time Payment is not enabled in Edit Tenant Setup - HCM.   
In order to specify a costing company, please enable the Intercompany Accounting setting in Edit Tenant Setup - Payroll.   
 
Effective_Date  date  [0..1]  Date the one-time payment for the employee is effective.   
Reason_Reference  Event_Classification_SubcategoryObject  [0..1]  Reason for the one-time payment. Use format: General_Event_Subcategory_ID.   
Validation Description
Request One Time Payment Data element must be provided if Automatically Complete is True.   
Multiple One-Time Payment is not enabled. Please enable Multiple One-Time Payment in HCM Tenant Setup - Compensation.   
top
 

One-Time_Payment_Data

part of: Request_One_Time_Payment_Sub_Business_Process
Data Element that contains the one-time payment information.
 
Parameter name Type/Value Cardinality Description Validations
One_Time_Payment_Plan_Reference  One-Time_Payment_PlanObject  [1..1]  One-time payment plan for the one-time payment. If Multiple One-Time Payments is enabled on the Edit Tenant Setup - HCM task, there can be multiple plans.   
Scheduled_Payment_Date  date  [0..1]  Date the employee will receive the one-time payment. Workday defaults the effective date if a Scheduled Payment Date is not provided. Multiple One-Time Payments must be enabled on the Edit Tenant Setup - HCM task.   
Coverage_Start_Date  date  [0..1]  Start date of the period a FLSA-eligible wage increase applies.   
Coverage_End_Date  date  [0..1]  End date of the period a FLSA-eligible wage increase applies.   
Amount [Choice]   decimal (26, 6)   [0..1]  Amount of the one time payment. Decimal precision of the amount must match the currency. This is mutually exclusive with the percent.   
Percent [Choice]   decimal (18, 6)   [0..1]  Percent of the calculation basis defined on the one-time payment plan. Workday calculates the amount based on this percent. This is mutually exclusive with the amount.   
Currency_Reference  CurrencyObject  [0..1]  Currency for the one-time payment. Defaults to the one-time payment plan currency default if not provided.   
Comment  string  [0..1]  Comment for the one-time payment.   
Do_Not_Pay  boolean  [0..1]  If True, Workday Payroll doesn't process this one-time payment.   
Costing_Company_Reference  CompanyObject  [0..1]  Optional: Specify a costing company to charge this one-time payment to. Intercompany Accounting must be enabled in Edit Tenant Setup - Payroll. 
Validation Description
One-Time Payment: 'Cost Center: [Cost Center]' is not allowed for 'Company: [Company]'.   
The costing company is not valid.   
 
One_Time_Payment_Worktags_Reference  Tenanted_Payroll_WorktagObject  [0..*]  The worktags associated with this one-time payment. If provided, the worktag type must match that of the Worktag Balancing Configuration unless the employee has that organizational assignment. 
Validation Description
Only one worktag for each type is allowed for each document line.   
The following Accounting Worktags are required but have not been assigned: [missing].   
Based on the worktag type configuration following worktag types are not valid for taggable type [tt]: [awt]. Please remove all worktags for the invalid worktag types.   
[non-allowed related worktags message for OTP]   
[missing related worktags for OTP message]   
Select a balancing worktag for Worktags of the following type: [type]   
[non-allowed related worktags message for OTP]   
 
Validation Description
Scheduled Payment Date cannot take place before the Effective Date.   
The coverage period End Date must be on or after Start Date.   
Coverage Start Date and Coverage End Date can not be entered for a One-Time Payment Plan that does not have Coverage Dates enabled.   
If specifying a Coverage Date range, then both dates must be specified.   
Scheduled Payment Date must be equal to Event Effective Date when Multiple One-Time Payment is not enabled in Edit Tenant Setup - HCM.   
In order to specify a costing company, please enable the Intercompany Accounting setting in Edit Tenant Setup - Payroll.   
top
 

One-Time_Payment_PlanObject

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

One-Time_Payment_PlanObjectID

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

CompanyObject

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

CompanyObjectID

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

Tenanted_Payroll_WorktagObject

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

Tenanted_Payroll_WorktagObjectID

part of: Tenanted_Payroll_WorktagObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Business_Unit_ID, Company_Reference_ID, Contingent_Worker_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Custom_Worktag_06_ID, Custom_Worktag_07_ID, Custom_Worktag_08_ID, Custom_Worktag_09_ID, Custom_Worktag_1_ID, Custom_Worktag_10_ID, Custom_Worktag_11_ID, Custom_Worktag_12_ID, Custom_Worktag_13_ID, Custom_Worktag_14_ID, Custom_Worktag_15_ID, Custom_Worktag_2_ID, Custom_Worktag_3_ID, Custom_Worktag_4_ID, Custom_Worktag_5_ID, Employee_ID, FLSA_Workweek_Calendar_Event_ID, Fund_ID, Gift_Reference_ID, Grant_ID, Holiday_Calendar_Event_ID, Job_Profile_ID, Location_ID, Object_Class_ID, Organization_Reference_ID, Payroll_ID, Position_ID, Program_ID, Project_ID, Project_Plan_ID, Region_Reference_ID, Run_Category_ID, Withholding_Order_Case_ID, Workers_Compensation_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
@parent_id  string  [1..1]  Contains a unique identifier for an instance of a parent object   
@parent_type  WID, FLSA_Workweek_Calendar_ID, Holiday_Calendar_ID  [1..1]  The unique identifier type of a parent object   
top
 

Request_Stock_Offer_Sub_Business_Process

part of: Offer_Data
Wrapper element for the Request Stock Grant sub business process.
 
Parameter name Type/Value Cardinality Description Validations
Business_Sub_Process_Parameters  Business_Sub_Process_Parameters  [1..1]  Container for the processing options for sub-business processes within a business process. If no options are submitted (or the options are submitted as 'false') then the sub-business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.   
Request_Stock_Grant_Data  Request_Stock_Grant_Offer_Data  [0..1]  Data element for the stock grant request 
Validation Description
Amount may only be entered if the Stock Plan is either a Percent or Amount Plan.   
Shares Granted may only be entered if the Stock Plan is a Unit Plan.   
Percent may only be entered if the Stock Plan is either a Percent or Amount Plan.   
 
Validation Description
Request Stock Grant Data element is required if Automatically Complete is True   
top
 

Request_Stock_Grant_Offer_Data

part of: Request_Stock_Offer_Sub_Business_Process
Data element for the stock grant request
 
Parameter name Type/Value Cardinality Description Validations
Effective_Date  date  [1..1]  Date the stock grant becomes effective. 
Validation Description
Select an Effective Date that is on or after the effective date for the staffing event [parent effective date].   
 
Stock_Plan_Reference  Stock_PlanObject  [1..1]  Stock Plan for the Stock Grants. 
Validation Description
Only active Stock Plans are allowed for this web service.   
 
Reason_Reference  Event_Classification_SubcategoryObject  [0..1]  Reason for the stock plan assignment. Use the format: General_Event_Subcategory.   
Shares_Granted [Choice]   decimal (15, 0) >0   [1..1]  Number of shares granted for the stock grant.   
Grant_Percent [Choice]   decimal (18, 6) >0   [1..1]  Percent of compensation basis allotted to stock grant for a percent stock plan. Cannot exceed 10,000% of employee base pay.   
Grant_Amount [Choice]   decimal (26, 6) >0   [1..1]  Amount allotted for stock grant for an amount stock plan. Cannot exceed 10,000% of employee base pay.   
Validation Description
Amount may only be entered if the Stock Plan is either a Percent or Amount Plan.   
Shares Granted may only be entered if the Stock Plan is a Unit Plan.   
Percent may only be entered if the Stock Plan is either a Percent or Amount Plan.   
top
 

Workflow_StepReferenceEnumeration

part of: Workflow_StepObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

Job_ApplicationReferenceEnumeration

part of: Job_ApplicationObjectID
Base Type
string
top
 

CandidateReferenceEnumeration

part of: CandidateObjectID
Base Type
string
top
 

Job_Requisition_EnabledReferenceEnumeration

part of: Job_Requisition_EnabledObjectID
Base Type
string
top
 

Event_Classification_SubcategoryReferenceEnumeration

part of: Event_Classification_SubcategoryObjectID
Base Type
string
top
 

LocationReferenceEnumeration

part of: LocationObjectID
Base Type
string
top
 

User_LanguageReferenceEnumeration

part of: User_LanguageObjectID
Base Type
string
top
 

Job_ProfileReferenceEnumeration

part of: Job_ProfileObjectID
Base Type
string
top
 

Event_Attachment_CategoryReferenceEnumeration

part of: Event_Attachment_CategoryObjectID
Base Type
string
top
 

Compensation_PackageReferenceEnumeration

part of: Compensation_PackageObjectID
Base Type
string
top
 

Compensation_GradeReferenceEnumeration

part of: Compensation_GradeObjectID
Base Type
string
top
 

Compensation_Grade_ProfileReferenceEnumeration

part of: Compensation_Grade_ProfileObjectID
Base Type
string
top
 

Compensation_StepReferenceEnumeration

part of: Compensation_StepObjectID
Base Type
string
top
 

Salary_Pay_PlanReferenceEnumeration

part of: Salary_Pay_PlanObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

FrequencyReferenceEnumeration

part of: FrequencyObjectID
Base Type
string
top
 

Salary_Unit_PlanReferenceEnumeration

part of: Salary_Unit_PlanObjectID
Base Type
string
top
 

Allowance_Value_PlanReferenceEnumeration

part of: Allowance_Value_PlanObjectID
Base Type
string
top
 

Allowance_Unit_PlanReferenceEnumeration

part of: Allowance_Unit_PlanObjectID
Base Type
string
top
 

Bonus_PlanReferenceEnumeration

part of: Bonus_PlanObjectID
Base Type
string
top
 

Merit_PlanReferenceEnumeration

part of: Merit_PlanObjectID
Base Type
string
top
 

Commission_PlanReferenceEnumeration

part of: Commission_PlanObjectID
Base Type
string
top
 

Stock_PlanReferenceEnumeration

part of: Stock_PlanObjectID
Base Type
string
top
 

Period_Salary_PlanReferenceEnumeration

part of: Period_Salary_PlanObjectID
Base Type
string
top
 

Compensation_PeriodReferenceEnumeration

part of: Compensation_PeriodObjectID
Base Type
string
top
 

Calculated_PlanReferenceEnumeration

part of: Calculated_PlanObjectID
Base Type
string
top
 

One-Time_Payment_PlanReferenceEnumeration

part of: One-Time_Payment_PlanObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Tenanted_Payroll_WorktagReferenceEnumeration

part of: Tenanted_Payroll_WorktagObjectID
Base Type
string
top
 

Base Type
string

top