Service Directory > v31.2 > Compensation > Update_Stock_Grant
 

Operation: Update_Stock_Grant

This operation allows the updating of an existing stock grant which has been given to a worker.


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

Stock grant request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Stock_Grant_Reference  Stock_GrantObject  [1..1]  Stock grant reference.   
Stock_Grant_Data  Update_Stock_Grant_Data  [1..1]  Stock grant data.   
top
 

Response Element: Update_Stock_Grant_Response

Update Stock Grant Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Stock_Grant_Reference  Stock_GrantObject  [0..1]  Stock grant which was updated.   
top
 

Stock_GrantObject

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

Stock_GrantObjectID

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

Update_Stock_Grant_Data

part of: Update_Stock_Grant_Request
Stock Grant data to be updated.
 
Parameter name Type/Value Cardinality Description Validations
Grant_ID  string  [0..1]  Stock grant id.   
Grant_Date  date  [0..1]  Stock grant date.   
Grant_Price  decimal (16, 6) >0   [0..1]  Stock grant price. 
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]  Stock grant price currency. 
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.   
 
Board_Approved  boolean  [0..1]  Stock grant board approved flag.   
Vest_From_Date  date  [0..1]  Stock grant vest from date.   
Expiration_Date  date  [0..1]  Stock grant expiration date. 
Validation Description
Expiration Date must be on or after the Vest From Date.   
 
Options_Pricing_Factor  decimal (5, 4) >0   [0..1]  Stock grant options pricing factor. 
Validation Description
Options Pricing Factor can only be supplied if the grant is an Option: [id]   
 
Shares_Vested  decimal (15, 0) >0   [0..1]  Number of shares vested. Applies to options or grants only. 
Validation Description
The Shares Vested ([shares vested]) cannot be more than Shares Granted ([shares granted])  Shares Vested cannot be more than Shares Granted. 
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.   
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, or update Board Approval to proceed.   
 
Shares_Unvested  decimal (15, 0) >0   [0..1]  Number of shares unvested. Applies to options or grants only. 
Validation Description
The Shares Unvested ([shares unvested]) must be less than or equal to the Shares Granted ([shares granted])  Shares Unvested cannot be more than Shares Granted. 
The Shares Vested ([shares vested]) plus the Shares Unvested ([shares unvested]) must be less than or equal to the Shares Granted ([shares granted])  Shares Vested plus Shares Unvested cannot be greater than Shares Granted. 
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.   
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, or update Board Approval to proceed.   
 
Vesting_Price  decimal (26, 6) >0   [0..1]  The price associated to the grant vesting date. 
Validation Description
Shares Vested, Shares Unvested, Vesting Price, and Vested As Of are only valid for board approved stock grants. Please remove Shares Vested, Shares 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 stock grants. 
 
Vested_As_Of  date  [0..1]  The most recent vesting date of the grant. 
Validation Description
Shares Vested, Shares Unvested, Vesting Price, and Vested As Of are only valid for board approved stock grants. Please remove Shares Vested, Shares 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 stock grants. 
Vested as of date cannot be before the vest from date.  Vested as of date cannot be before the vest from date. 
Vested as of date cannot be before the grant date.  Vested as of date cannot be before the grant date. 
 
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, 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.   
Long Term Cash Amount Vested cannot be more 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 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 plus Long Term Cash Amount Unvested cannot be greater than Amount Granted.   
Long Term Cash Amount Unvested cannot be more than Amount Granted.   
 
top
 

CurrencyObject

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

Stock_GrantReferenceEnumeration

part of: Stock_GrantObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top