Service Directory > v32.1 > Compensation > Add_Stock_Grant
 

Operation: Add_Stock_Grant

This operation allows the addition of stock grants to an employee via the Request Stock Option Grant business process.


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

This web service operation is designed to grant a stock grant to an employee using the Request Stock Grant business process.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Business_Process_Parameters  Business_Process_Parameters  [0..1]  Container for the processing options for a business process. If no options are submitted (or the options are submitted as 'false') then the business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.   
Add_Stock_Grant_Data  Add_Stock_Grant_Data  [1..1]  Wrapper element for the Request Stock Grant business process.   
top
 

Response Element: Add_Stock_Grant_Response

Responds with the Event ID for the Request Stock Grant Event.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Stock_Package_Event_Reference  Unique_IdentifierObject  [0..1]  Event ID of the Request Stock Grant Event.   
top
 

Business_Process_Parameters

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

Business_Process_Comment_Data

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

WorkerObject

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

WorkerObjectID

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

Business_Process_Attachment_Data

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

Add_Stock_Grant_Data

part of: Add_Stock_Grant_Request
Wrapper element for the Request Stock Grant business process.
 
Parameter name Type/Value Cardinality Description Validations
Effective_Date  date  [1..1]  Date the stock grant becomes effective.   
Employee_Reference  EmployeeObject  [1..1]  Employee to receive the stock grant.   
Position_Reference  Position_ElementObject  [0..1]  Employee's current position. Used in multiple-job scenarios. 
Validation Description
Position submitted is not filled as of the effective date.   
The employee you have selected has more than one job. You must supply the job to which this operation applies.   
The job is not valid for the employee.   
 
Stock_Plan_Reference  Stock_PlanObject  [1..1]  Stock Plan for the Stock Grants.   
Reason_Reference  Event_Classification_SubcategoryObject  [0..1]  Reason for the stock plan assignment. Use the format: General_Event_Subcategory.   
Stock_Grant_Data  Add_Individual_Stock_Grant_Data  [1..*]  Reference element to the stock grant. 
Validation Description
Long Term Cash Amount Vested, Long Term Cash Amount Unvested, Vesting Price, and Vested As Of are only valid for board approved long term cash category grants. Please remove Long Term Cash Amount Vested, Long Term Cash Amount Unvested, Vesting Price, and Vested As Of to proceed.   
Shares Vested, Shares Unvested, Vesting Price, and Vested As Of are only valid for board approved option and stock category grants. Please remove Shares Vested, Shares Unvested, Vesting Price, and Vested As Of to proceed.   
Long Term Cash Amount Vested, Long Term Cash Amount Unvested, Vesting Price, and Vested As Of are only valid for board approved long term cash category grants. Please remove Long Term Cash Amount Vested, Long Term Cash Amount Unvested, Vesting Price, and Vested As Of to proceed.   
Shares Vested, Shares Unvested, Vesting Price, and Vested As Of are only valid for board approved option and stock category grants. Please remove Shares Vested, Shares Unvested, Vesting Price, and Vested As Of to proceed.   
 
top
 

EmployeeObject

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

EmployeeObjectID

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

Position_ElementObject

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

Stock_PlanObject

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

Event_Classification_SubcategoryObject

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

Add_Individual_Stock_Grant_Data

part of: Add_Stock_Grant_Data
Data element for the Request Stock Grant business process.
 
Parameter name Type/Value Cardinality Description Validations
Stock_Grant_Reference_ID  string  [0..1]  Stock grant reference ID.   
Grant_Type_Reference  Stock_Grant_TypeObject  [1..1]  Type of stock grant: ISO, RSU, etc. Must correspond to a grant type in the stock plan. 
Validation Description
Stock Grant Type [grant_type] is not valid for [stock_plan].   
 
Grant_ID  string  [0..1]  Stock grant ID.   
Grant_Date  date  [0..1]  Grant date.   
Vesting_Schedule_Reference  Stock_Vesting_ScheduleObject  [0..1]  Vesting schedule for the stock plan.   
Vest_From_Date  date  [0..1]  From Date of the vesting schedule.   
Expiration_Date  date  [0..1]  Expiration date of the stock grant. 
Validation Description
Expiration Date must be on or after the Vest From Date.   
 
Shares_Granted [Choice]   decimal (15, 0) >0   [0..1]  Number of shares granted for a unit stock plan. 
Validation Description
Shares Granted may only be entered if the Stock Plan is a Unit Plan.   
 
Grant_Percent [Choice]   decimal (18, 6) >0   [0..1]  Percent of compensation basis allotted to stock grant for a percent stock plan. Cannot exceed 10,000% of employee base pay. 
Validation Description
Percent may only be entered if the Stock Plan is either a Percent or Amount Plan.   
 
Grant_Amount [Choice]   decimal (26, 6) >0   [0..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.   
 
Grant_Amount_Currency_Reference  CurrencyObject  [0..1]  Currency of the stock grant. Required for both percent or amount. 
Validation Description
Grant Amount Currency must be entered if Grant Amount or Grant Percent is entered. When a percent is entered, an amount is automatically calculated from the percent so a currency is required.   
Use Target Currency set on Stock Plan. Currency applied must be the currency specified in the Stock Plan and Stock Plan Profiles. For Position: [position], and Stock Plan: [stock plan] combination, the currency should be [target currency] instead of [currency].   
 
Grant_Price  decimal (16, 6) >0   [0..1]  Grant price for the stock grant. 
Validation Description
Grant Price and Grant Price Currency are only valid for unit based long term cash category grants. Please remove Grant Price and Grant Price Currency to proceed.   
 
Grant_Price_Currency_Reference  CurrencyObject  [0..1]  Currency of the Grant Price. Required if Grant Price is entered. 
Validation Description
Grant Price Currency must be entered if Grant Price is entered.   
Grant Price and Grant Price Currency are only valid for unit based long term cash category grants. Please remove Grant Price and Grant Price Currency to proceed.   
 
Options_Pricing_Factor  decimal (5, 4) >0   [0..1]  Options pricing factor for stock grant. 
Validation Description
Options Pricing Factor can only be supplied if the grant is an Option: [id]   
 
Board_Approved  boolean  [0..1]  If true, the stock grant has been board approved.   
Comments  string  [0..1]  Comments of the stock grant.   
Shares_Vested  decimal (15, 0) >0   [0..1]  Number of shares vested. Applies to options or grants only. 
Validation Description
Shares Vested, Vesting Price, and Vested As Of are only valid for board approved stock grants. Please remove Shares Vested, Vesting Price, and Vested As Of to proceed.  Shares Vested, Vesting Price, and Vested As Of are only valid for board approved stock grants. 
Shares Vested cannot be more than Shares Granted.  Shares Vested cannot be more than Shares Granted. 
Shares Vested plus Shares Unvested cannot be greater than Shares Granted.   
 
Shares_Unvested  decimal (15, 0) >0   [0..1]  Number of shares unvested. Applies to options or grants only. 
Validation Description
Shares Unvested cannot be more than Shares Granted.   
Shares Vested, Vesting Price, and Vested As Of are only valid for board approved stock grants.   
Shares Vested plus Shares Unvested cannot be greater than Shares Granted.   
 
Long_Term_Cash_Amount_Vested  decimal (26, 6) >0   [0..1]  Amount vested. Applies to long-term cash only. 
Validation Description
Long Term Cash Amount Vested, Long Term Cash Amount Unvested, Vesting Price, and Vested As Of are only valid for board approved long term cash category grants. Please remove Long Term Cash Amount Vested, Long Term Cash Amount Unvested, Vesting Price, and Vested As Of, or update Board Approval to proceed.   
Long Term Cash Amount Vested cannot be more than Amount Granted.   
Long Term Cash Amount Vested plus Long Term Cash Amount Unvested cannot be greater than Amount Granted.   
Long Term Cash Amount Vested cannot be more than Amount Granted.   
Long Term Cash Amount Vested cannot be more than Amount Granted.   
Long Term Cash Amount Vested plus Long Term Cash Amount Unvested cannot be greater than Amount Granted.   
Long Term Cash Amount Vested plus Long Term Cash Amount Unvested cannot be greater than Amount Granted.   
 
Long_Term_Cash_Amount_Unvested  decimal (26, 6) >0   [0..1]  Amount unvested. Applies to long-term cash only. 
Validation Description
Long Term Cash Amount Vested, Long Term Cash Amount Unvested, Vesting Price, and Vested As Of are only valid for board approved long term cash category grants. Please remove Long Term Cash Amount Vested, Long Term Cash Amount Unvested, Vesting Price, and Vested As Of, or update Board Approval to proceed.   
Long Term Cash Amount Unvested cannot be more than Amount Granted.   
Long Term Cash Amount Unvested cannot be more than Amount Granted.   
Long Term Cash Amount Unvested cannot be more than Amount Granted.   
 
Vesting_Price  decimal (26, 6) >0   [0..1]  The price associated to the grant vesting date. 
Validation Description
Shares Vested, Vesting Price, and Vested As Of are only valid for board approved stock grants. Please remove Shares Vested, Vesting Price, and Vested As Of to proceed.  Shares Vested, Vesting Price, and Vested As Of are only valid for board approved stock grants. 
 
Vested_As_Of  date  [0..1]  The most recent vesting date of the grant. 
Validation Description
Shares Vested, Vesting Price, and Vested As Of are only valid for board approved stock grants. Please remove Shares Vested, Vesting Price, and Vested As Of to proceed.  Shares Vested, Vesting Price, and Vested As Of are only valid for board approved stock grants. 
Vested as of date cannot be before the grant date.  Vested as of date cannot be before the grant date. 
Vested as of date cannot be before the vest from date.  Vested as of date cannot be before the vest from date. 
 
Validation Description
Long Term Cash Amount Vested, Long Term Cash Amount Unvested, Vesting Price, and Vested As Of are only valid for board approved long term cash category grants. Please remove Long Term Cash Amount Vested, Long Term Cash Amount Unvested, Vesting Price, and Vested As Of to proceed.   
Shares Vested, Shares Unvested, Vesting Price, and Vested As Of are only valid for board approved option and stock category grants. Please remove Shares Vested, Shares Unvested, Vesting Price, and Vested As Of to proceed.   
Long Term Cash Amount Vested, Long Term Cash Amount Unvested, Vesting Price, and Vested As Of are only valid for board approved long term cash category grants. Please remove Long Term Cash Amount Vested, Long Term Cash Amount Unvested, Vesting Price, and Vested As Of to proceed.   
Shares Vested, Shares Unvested, Vesting Price, and Vested As Of are only valid for board approved option and stock category grants. Please remove Shares Vested, Shares Unvested, Vesting Price, and Vested As Of to proceed.   
top
 

Stock_Grant_TypeObject

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

Stock_Grant_TypeObjectID

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

Stock_Vesting_ScheduleObject

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

Stock_Vesting_ScheduleObjectID

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

CurrencyObject

part of: Add_Individual_Stock_Grant_Data, Add_Individual_Stock_Grant_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
 

Unique_IdentifierObject

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

Unique_IdentifierObjectID

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

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Event_Attachment_CategoryReferenceEnumeration

part of: Event_Attachment_CategoryObjectID
Base Type
string
top
 

EmployeeReferenceEnumeration

part of: EmployeeObjectID
Base Type
string
top
 

Position_ElementReferenceEnumeration

part of: Position_ElementObjectID
Base Type
string
top
 

Stock_PlanReferenceEnumeration

part of: Stock_PlanObjectID
Base Type
string
top
 

Event_Classification_SubcategoryReferenceEnumeration

part of: Event_Classification_SubcategoryObjectID
Base Type
string
top
 

Stock_Grant_TypeReferenceEnumeration

part of: Stock_Grant_TypeObjectID
Base Type
string
top
 

Stock_Vesting_ScheduleReferenceEnumeration

part of: Stock_Vesting_ScheduleObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top