Carrot reference
Functions

vestShares()

Given a start date and end date, returns the number of shares that will vest over that period of time.

Syntax

vestShares(fromDate, untilDate)

  • fromDate - the first date in the range
  • untilDate - the second date in the range
  • Return type: Money

Sample usage

vestValue('2020-01-01', '2021-01-01') returns the number of shares that will vest over the defined date range

Supported data types

Input type

Return type

Logic

Date

Money

If two Dates are passed, the number of shares that will vest over that range will be returned.

Unsupported data types

Null

Unsupported data types return Null.



Updated 04 Oct 2023
Doc contributor
Did this page help you?