Skip to content

Deel: Equity tokens schemas

22 Deel schemas with complete fields and constraints.

← Equity tokens operations · All schemas

Create equity or token tax event — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand Create equity or token tax event — 201 response body — data

Referenced models: Create equity or token tax event — 201 response body — data

Create equity or token tax event — 201 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringOptionalthe date and time when the equity/token tax event was created
Format: date-time
idstringOptionalthe id of the equity/token tax event generated
Format: uuid

Create equity or token tax event — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
benefit_in_kind_local_currencystringRequired within parentThe benefit in kind in the local currency
contract_idstringRequired within parentThe unique identifier of the contract of the employee who received the equity/token grant
equity_grant_idstringOptionalThe unique identifier of the equity/token grant - optional in case you don't have remove the property
event_datestringOptionalThe date of the event
Format: date
exercise_pricestringOptionalThe price at which the equity/token was exercised
fx_ratestringRequired within parentThe exchange rate used to convert the local currency to the payroll currency
gross_valuestringOptionalThe gross value of the equity/token grant
method_of_tax_coveragestringRequired within parentThe method used to cover the taxes
One of: AD_HOC, BIK_REPORTING_ONLY, BIK_WITHHOLDING_AT_SOURCE_CLIENT, BIK_WITHHOLDING_AT_SOURCE_CLIENT_REVERSE, BIK_WITHHOLDING_GROSSED_UP_BONUS, BIK_WITHHOLDING_NET_SETTLEMENT, BIK_WITHHOLDING_SALARY_DEDUCTION, BIK_WITHHOLDING_WORKER, NO_BIK_NO_WITHHOLDING
payroll_currencystringRequired within parentThe currency in which the payroll is processed
plan_currencystringRequired within parentThe currency in which the equity/token grant was issued
quantity_exercised_or_releasedstringOptionalThe quantity of equity/token that was exercised or released
quantity_remainingstringOptionalThe quantity of equity/token that remains
quantity_withheld_or_soldstringOptionalThe quantity of equity/token that was withheld or sold
sale_pricestringOptionalThe price at which the equity/token was sold
settlement_datestringRequired within parentThe date of the settlement
Format: date
tax_jurisdictionstringRequired within parentThe tax jurisdiction in which the equity/token grant was issued
tax_ratestringOptionalThe tax rate applied to the benefit in kind
taxable_gain_or_lossstringRequired within parentThe taxable gain or loss
total_exercise_pricestringOptionalThe total exercise price
total_taxes_withheldstringRequired within parentThe total amount of taxes withheld
transaction_feesstringOptionalThe fees associated with the transaction
unit_fmvstringOptionalThe fair market value of the equity/token grant at the time of the event
withheld_tax_local_currencystringRequired within parentThe tax withheld in the local currency

List Shareworks equity exercises — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentPage of exercise records. Worker name fields are deliberately not included — employee_number is the intended join key, and first/last name are SENSITIVE PII not needed by downstream consumers of this endpoint.
data[]ModelEach itemExpand List Shareworks equity exercises — 200 response body — data item
has_morebooleanRequired within parentWhether another page of results is available.
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeCursor for the next page. Null when has_more is false.
next_cursor (anyOf 2)nullAlternativeCursor for the next page. Null when has_more is false.

Referenced models: List Shareworks equity exercises — 200 response body — data item

List Shareworks equity exercises — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
cost_of_optionsJSONOptional
cost_of_options (anyOf 1)JSONAlternative
cost_of_options (anyOf 1) (anyOf 1)numberAlternativeTotal cost paid to exercise the options.
Format: double
cost_of_options (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
cost_of_options (anyOf 2)nullAlternativeTotal cost paid to exercise the options.
Format: double
currencystringOptionalISO 4217 currency code for the monetary fields on this record.
employee_grant_numberstringOptionalShareworks grant number for this employee.
employee_numberstringOptionalShareworks employee number, as reported by the ingested file. The intended join key for this record.
exercise_datestringOptionalDate the exercise took place.
Format: date
exercise_fmvJSONOptional
exercise_fmv (anyOf 1)JSONAlternative
exercise_fmv (anyOf 1) (anyOf 1)numberAlternativeTotal fair market value of the exercised shares.
Format: double
exercise_fmv (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
exercise_fmv (anyOf 2)nullAlternativeTotal fair market value of the exercised shares.
Format: double
exercise_gainJSONOptional
exercise_gain (anyOf 1)JSONAlternative
exercise_gain (anyOf 1) (anyOf 1)numberAlternativeGain realized on exercise (FMV minus cost).
Format: double
exercise_gain (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
exercise_gain (anyOf 2)nullAlternativeGain realized on exercise (FMV minus cost).
Format: double
exercise_priceJSONOptional
exercise_price (anyOf 1)JSONAlternative
exercise_price (anyOf 1) (anyOf 1)numberAlternativeStrike/exercise price per unit.
Format: double
exercise_price (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
exercise_price (anyOf 2)nullAlternativeStrike/exercise price per unit.
Format: double
fmv_per_unitJSONOptional
fmv_per_unit (anyOf 1)JSONAlternative
fmv_per_unit (anyOf 1) (anyOf 1)numberAlternativeFair market value per unit at exercise.
Format: double
fmv_per_unit (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
fmv_per_unit (anyOf 2)nullAlternativeFair market value per unit at exercise.
Format: double
grant_dateJSONOptional
grant_date (anyOf 1)stringAlternativeDate the grant was issued.
Format: date
grant_date (anyOf 2)nullAlternativeDate the grant was issued.
Format: date
grant_nameJSONOptional
grant_name (anyOf 1)stringAlternativeGrant name, as reported by the ingested file.
grant_name (anyOf 2)nullAlternativeGrant name, as reported by the ingested file.
grant_typeJSONOptional
grant_type (anyOf 1)stringAlternativeGrant type (e.g. ISO, NSO, RSU), as reported by the ingested file.
grant_type (anyOf 2)nullAlternativeGrant type (e.g. ISO, NSO, RSU), as reported by the ingested file.
hris_profile_idJSONOptional
hris_profile_id (anyOf 1)JSONAlternative
hris_profile_id (anyOf 1) (anyOf 1)integerAlternativeMatched HRIS profile id, if employee_number could be resolved to one. Null when unmatched.
hris_profile_id (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hris_profile_id (anyOf 2)nullAlternativeMatched HRIS profile id, if employee_number could be resolved to one. Null when unmatched.
idstringOptionalThe unique identifier of the exercise record.
Format: uuid
plan_nameJSONOptional
plan_name (anyOf 1)stringAlternativeEquity plan name, as reported by the ingested file.
plan_name (anyOf 2)nullAlternativeEquity plan name, as reported by the ingested file.
shares_exercised_totalJSONOptional
shares_exercised_total (anyOf 1)JSONAlternative
shares_exercised_total (anyOf 1) (anyOf 1)numberAlternativeTotal number of shares exercised.
Format: double
shares_exercised_total (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
shares_exercised_total (anyOf 2)nullAlternativeTotal number of shares exercised.
Format: double
shares_exercised_unvestedJSONOptional
shares_exercised_unvested (anyOf 1)JSONAlternative
shares_exercised_unvested (anyOf 1) (anyOf 1)numberAlternativeNumber of unvested shares exercised.
Format: double
shares_exercised_unvested (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
shares_exercised_unvested (anyOf 2)nullAlternativeNumber of unvested shares exercised.
Format: double
shares_exercised_vestedJSONOptional
shares_exercised_vested (anyOf 1)JSONAlternative
shares_exercised_vested (anyOf 1) (anyOf 1)numberAlternativeNumber of vested shares exercised.
Format: double
shares_exercised_vested (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
shares_exercised_vested (anyOf 2)nullAlternativeNumber of vested shares exercised.
Format: double
updated_atstringOptionalTimestamp this record was last upserted, for incremental sync.
Format: date-time

List equity awards granted — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentPage of granted equity award records, one per reported award row.
data[]ModelEach itemExpand List equity awards granted — 200 response body — data item
has_morebooleanRequired within parentWhether another page of results is available.
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeCursor for the next page. Null when has_more is false.
next_cursor (anyOf 2)nullAlternativeCursor for the next page. Null when has_more is false.

Referenced models: List equity awards granted — 200 response body — data item

List equity awards granted — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
allow_early_exerciseJSONRequired within parent
allow_early_exercise (anyOf 1)stringAlternativeWhether early exercise is allowed, as reported by the ingested file (verbatim text, e.g. Yes/No).
allow_early_exercise (anyOf 2)nullAlternativeWhether early exercise is allowed, as reported by the ingested file (verbatim text, e.g. Yes/No).
award_nameJSONRequired within parent
award_name (anyOf 1)stringAlternativeAward template name, as reported by the ingested file.
award_name (anyOf 2)nullAlternativeAward template name, as reported by the ingested file.
compensation_benefitJSONRequired within parent
compensation_benefit (anyOf 1)JSONAlternative
compensation_benefit (anyOf 1) (anyOf 1)numberAlternativeCompensation benefit amount, as reported by the ingested file.
Format: double
compensation_benefit (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
compensation_benefit (anyOf 2)nullAlternativeCompensation benefit amount, as reported by the ingested file.
Format: double
created_atstringRequired within parentTimestamp this record was first ingested.
Format: date-time
employee_numberstringRequired within parentShareworks employee number, as reported by the ingested file. The intended join key for this record. Some values are non-numeric for legacy or masked records.
employee_typeJSONRequired within parent
employee_type (anyOf 1)stringAlternativeEmployee type (e.g. Employee, Consultant), as reported by the ingested file.
employee_type (anyOf 2)nullAlternativeEmployee type (e.g. Employee, Consultant), as reported by the ingested file.
federal_exemptionJSONRequired within parent
federal_exemption (anyOf 1)stringAlternativeFederal exemption, as reported by the ingested file.
federal_exemption (anyOf 2)nullAlternativeFederal exemption, as reported by the ingested file.
federal_exemption_dateJSONRequired within parent
federal_exemption_date (anyOf 1)stringAlternativeFederal exemption date, as reported by the ingested file.
federal_exemption_date (anyOf 2)nullAlternativeFederal exemption date, as reported by the ingested file.
first_nameJSONRequired within parent
first_name (anyOf 1)stringAlternativeEmployee first name, as reported by the ingested file.
first_name (anyOf 2)nullAlternativeEmployee first name, as reported by the ingested file.
fmv_per_share_at_grant_dateJSONRequired within parent
fmv_per_share_at_grant_date (anyOf 1)JSONAlternative
fmv_per_share_at_grant_date (anyOf 1) (anyOf 1)numberAlternativeFair market value per share at grant date, as reported by the ingested file.
Format: double
fmv_per_share_at_grant_date (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
fmv_per_share_at_grant_date (anyOf 2)nullAlternativeFair market value per share at grant date, as reported by the ingested file.
Format: double
grant_datestringRequired within parentDate the grant was issued, as reported by the ingested file.
Format: date
grant_namestringRequired within parentGrant name, as reported by the ingested file.
grant_priceJSONRequired within parent
grant_price (anyOf 1)JSONAlternative
grant_price (anyOf 1) (anyOf 1)numberAlternativeStrike/grant price per unit, as reported by the ingested file.
Format: double
grant_price (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
grant_price (anyOf 2)nullAlternativeStrike/grant price per unit, as reported by the ingested file.
Format: double
grant_quantityJSONRequired within parent
grant_quantity (anyOf 1)JSONAlternative
grant_quantity (anyOf 1) (anyOf 1)numberAlternativeNumber of shares/units granted, as reported by the ingested file.
Format: double
grant_quantity (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
grant_quantity (anyOf 2)nullAlternativeNumber of shares/units granted, as reported by the ingested file.
Format: double
hris_profile_idJSONRequired within parent
hris_profile_id (anyOf 1)JSONAlternative
hris_profile_id (anyOf 1) (anyOf 1)integerAlternativeMatched HRIS profile id, if employee_number could be resolved to one. Null when unmatched, or when employee_number is non-numeric or blank.
hris_profile_id (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hris_profile_id (anyOf 2)nullAlternativeMatched HRIS profile id, if employee_number could be resolved to one. Null when unmatched, or when employee_number is non-numeric or blank.
idstringRequired within parentThe unique identifier of the record.
Format: uuid
is_under_rule_701JSONRequired within parent
is_under_rule_701 (anyOf 1)stringAlternativeWhether the grant is under Rule 701, as reported by the ingested file (verbatim text, e.g. Yes/No).
is_under_rule_701 (anyOf 2)nullAlternativeWhether the grant is under Rule 701, as reported by the ingested file (verbatim text, e.g. Yes/No).
last_nameJSONRequired within parent
last_name (anyOf 1)stringAlternativeEmployee last name, as reported by the ingested file.
last_name (anyOf 2)nullAlternativeEmployee last name, as reported by the ingested file.
last_seen_dataset_idJSONRequired within parent
last_seen_dataset_id (anyOf 1)stringAlternativeIdentifier of the most recent ingested dataset in which this record still appeared. Null for records ingested before dataset tracking began.
Format: uuid
last_seen_dataset_id (anyOf 2)nullAlternativeIdentifier of the most recent ingested dataset in which this record still appeared. Null for records ingested before dataset tracking began.
Format: uuid
occurrence_indexJSONRequired within parent
occurrence_index (anyOf 1)integerAlternativeDiscriminates several records the source file reports for the same natural key. Starts at 1, in the order the rows appear in the file.
occurrence_index (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
plan_nameJSONRequired within parent
plan_name (anyOf 1)stringAlternativeEquity plan name, as reported by the ingested file.
plan_name (anyOf 2)nullAlternativeEquity plan name, as reported by the ingested file.
row_hashstringRequired within parentHash of the reported values on this record. Compare it between syncs to detect a change without diffing every field.
source_file_idstringRequired within parentIdentifier of the ingested Shareworks report file this record was last upserted from.
Format: uuid
state_exemptionJSONRequired within parent
state_exemption (anyOf 1)stringAlternativeState exemption, as reported by the ingested file.
state_exemption (anyOf 2)nullAlternativeState exemption, as reported by the ingested file.
state_exemption_dateJSONRequired within parent
state_exemption_date (anyOf 1)stringAlternativeState exemption date, as reported by the ingested file.
state_exemption_date (anyOf 2)nullAlternativeState exemption date, as reported by the ingested file.
state_of_exemptionJSONRequired within parent
state_of_exemption (anyOf 1)stringAlternativeState of exemption, as reported by the ingested file.
state_of_exemption (anyOf 2)nullAlternativeState of exemption, as reported by the ingested file.
total_exercise_priceJSONRequired within parent
total_exercise_price (anyOf 1)JSONAlternative
total_exercise_price (anyOf 1) (anyOf 1)numberAlternativeTotal exercise price for the grant, as reported by the ingested file.
Format: double
total_exercise_price (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_exercise_price (anyOf 2)nullAlternativeTotal exercise price for the grant, as reported by the ingested file.
Format: double
total_fmvJSONRequired within parent
total_fmv (anyOf 1)JSONAlternative
total_fmv (anyOf 1) (anyOf 1)numberAlternativeTotal fair market value of the grant, as reported by the ingested file.
Format: double
total_fmv (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_fmv (anyOf 2)nullAlternativeTotal fair market value of the grant, as reported by the ingested file.
Format: double
updated_atstringRequired within parentTimestamp this record was last upserted, for incremental sync.
Format: date-time
vest_schedule_nameJSONRequired within parent
vest_schedule_name (anyOf 1)stringAlternativeVesting schedule name, as reported by the ingested file.
vest_schedule_name (anyOf 2)nullAlternativeVesting schedule name, as reported by the ingested file.
vesting_start_dateJSONRequired within parent
vesting_start_date (anyOf 1)stringAlternativeVesting start date, as reported by the ingested file.
Format: date
vesting_start_date (anyOf 2)nullAlternativeVesting start date, as reported by the ingested file.
Format: date

List equity grant expense amortization records — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentPage of expense amortization records, one per grant occurrence.
data[]ModelEach itemExpand List equity grant expense amortization records — 200 response body — data item
has_morebooleanRequired within parentWhether another page of results is available.
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeCursor for the next page. Null when has_more is false.
next_cursor (anyOf 2)nullAlternativeCursor for the next page. Null when has_more is false.

Referenced models: List equity grant expense amortization records — 200 response body — data item

List equity grant expense amortization records — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
actual_performance_factorJSONRequired within parent
actual_performance_factor (anyOf 1)JSONAlternative
actual_performance_factor (anyOf 1) (anyOf 1)numberAlternativeActual performance factor applied, as reported by the ingested file. Sparsely populated (measured: 5 of 11,863 real rows).
Format: double
actual_performance_factor (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
actual_performance_factor (anyOf 2)nullAlternativeActual performance factor applied, as reported by the ingested file. Sparsely populated (measured: 5 of 11,863 real rows).
Format: double
award_typestringRequired within parentAward type (e.g. Restricted Stock - Standard), as reported by the ingested file.
before_period_total_expense_accruedJSONRequired within parent
before_period_total_expense_accrued (anyOf 1)JSONAlternative
before_period_total_expense_accrued (anyOf 1) (anyOf 1)numberAlternativeBefore Period > Total Expense Accrued, as reported by the ingested file.
Format: double
before_period_total_expense_accrued (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
before_period_total_expense_accrued (anyOf 2)nullAlternativeBefore Period > Total Expense Accrued, as reported by the ingested file.
Format: double
before_period_total_shares_accruedJSONRequired within parent
before_period_total_shares_accrued (anyOf 1)JSONAlternative
before_period_total_shares_accrued (anyOf 1) (anyOf 1)numberAlternativeBefore Period > Total Shares Accrued, as reported by the ingested file.
Format: double
before_period_total_shares_accrued (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
before_period_total_shares_accrued (anyOf 2)nullAlternativeBefore Period > Total Shares Accrued, as reported by the ingested file.
Format: double
before_period_unamortized_expenseJSONRequired within parent
before_period_unamortized_expense (anyOf 1)JSONAlternative
before_period_unamortized_expense (anyOf 1) (anyOf 1)numberAlternativeBefore Period > Unamortized Expense, as reported by the ingested file.
Format: double
before_period_unamortized_expense (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
before_period_unamortized_expense (anyOf 2)nullAlternativeBefore Period > Unamortized Expense, as reported by the ingested file.
Format: double
before_period_unamortized_sharesJSONRequired within parent
before_period_unamortized_shares (anyOf 1)JSONAlternative
before_period_unamortized_shares (anyOf 1) (anyOf 1)numberAlternativeBefore Period > Unamortized Shares, as reported by the ingested file.
Format: double
before_period_unamortized_shares (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
before_period_unamortized_shares (anyOf 2)nullAlternativeBefore Period > Unamortized Shares, as reported by the ingested file.
Format: double
created_atstringRequired within parentTimestamp this record was first ingested.
Format: date-time
employee_grant_numberstringRequired within parentShareworks grant number for this employee, as reported by the ingested file.
employee_numberstringRequired within parentShareworks employee number, as reported by the ingested file. The intended join key for this record. Some values are non-numeric for legacy or masked records.
estimated_performance_factorJSONRequired within parent
estimated_performance_factor (anyOf 1)JSONAlternative
estimated_performance_factor (anyOf 1) (anyOf 1)numberAlternativeEstimated performance factor, as reported by the ingested file.
Format: double
estimated_performance_factor (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
estimated_performance_factor (anyOf 2)nullAlternativeEstimated performance factor, as reported by the ingested file.
Format: double
fair_value_per_shareJSONRequired within parent
fair_value_per_share (anyOf 1)JSONAlternative
fair_value_per_share (anyOf 1) (anyOf 1)numberAlternativeFair market value per share, as reported by the ingested file.
Format: double
fair_value_per_share (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
fair_value_per_share (anyOf 2)nullAlternativeFair market value per share, as reported by the ingested file.
Format: double
grant_datestringRequired within parentDate the grant was issued, as reported by the ingested file.
Format: date
grant_namestringRequired within parentGrant name, as reported by the ingested file.
grant_priceJSONRequired within parent
grant_price (anyOf 1)JSONAlternative
grant_price (anyOf 1) (anyOf 1)numberAlternativeStrike/grant price per unit, as reported by the ingested file.
Format: double
grant_price (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
grant_price (anyOf 2)nullAlternativeStrike/grant price per unit, as reported by the ingested file.
Format: double
hris_profile_idJSONRequired within parent
hris_profile_id (anyOf 1)JSONAlternative
hris_profile_id (anyOf 1) (anyOf 1)integerAlternativeMatched HRIS profile id, if employee_number could be resolved to one. Null when unmatched, or when employee_number is non-numeric or blank.
hris_profile_id (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hris_profile_id (anyOf 2)nullAlternativeMatched HRIS profile id, if employee_number could be resolved to one. Null when unmatched, or when employee_number is non-numeric or blank.
idstringRequired within parentThe unique identifier of the record.
Format: uuid
last_seen_dataset_idJSONRequired within parent
last_seen_dataset_id (anyOf 1)stringAlternativeIdentifier of the most recent ingested dataset in which this record still appeared. Null for records ingested before dataset tracking began.
Format: uuid
last_seen_dataset_id (anyOf 2)nullAlternativeIdentifier of the most recent ingested dataset in which this record still appeared. Null for records ingested before dataset tracking began.
Format: uuid
occurrence_indexJSONRequired within parent
occurrence_index (anyOf 1)integerAlternativeDiscriminates several records the source file reports for the same natural key. Starts at 1, in the order the rows appear in the file.
occurrence_index (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
period_end_life_to_date_total_expense_accruedJSONRequired within parent
period_end_life_to_date_total_expense_accrued (anyOf 1)JSONAlternative
period_end_life_to_date_total_expense_accrued (anyOf 1) (anyOf 1)numberAlternativePeriod End > Life-to-Date Total Expense Accrued, as reported by the ingested file.
Format: double
period_end_life_to_date_total_expense_accrued (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
period_end_life_to_date_total_expense_accrued (anyOf 2)nullAlternativePeriod End > Life-to-Date Total Expense Accrued, as reported by the ingested file.
Format: double
period_end_life_to_date_total_shares_accruedJSONRequired within parent
period_end_life_to_date_total_shares_accrued (anyOf 1)JSONAlternative
period_end_life_to_date_total_shares_accrued (anyOf 1) (anyOf 1)numberAlternativePeriod End > Life-to-Date Total Shares Accrued, as reported by the ingested file.
Format: double
period_end_life_to_date_total_shares_accrued (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
period_end_life_to_date_total_shares_accrued (anyOf 2)nullAlternativePeriod End > Life-to-Date Total Shares Accrued, as reported by the ingested file.
Format: double
period_end_unamortized_expenseJSONRequired within parent
period_end_unamortized_expense (anyOf 1)JSONAlternative
period_end_unamortized_expense (anyOf 1) (anyOf 1)numberAlternativePeriod End > Unamortized Expense, as reported by the ingested file.
Format: double
period_end_unamortized_expense (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
period_end_unamortized_expense (anyOf 2)nullAlternativePeriod End > Unamortized Expense, as reported by the ingested file.
Format: double
period_end_unamortized_sharesJSONRequired within parent
period_end_unamortized_shares (anyOf 1)JSONAlternative
period_end_unamortized_shares (anyOf 1) (anyOf 1)numberAlternativePeriod End > Unamortized Shares, as reported by the ingested file.
Format: double
period_end_unamortized_shares (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
period_end_unamortized_shares (anyOf 2)nullAlternativePeriod End > Unamortized Shares, as reported by the ingested file.
Format: double
period_end_weighted_avg_remaining_recognition_periodJSONRequired within parent
period_end_weighted_avg_remaining_recognition_period (anyOf 1)JSONAlternative
period_end_weighted_avg_remaining_recognition_period (anyOf 1) (anyOf 1)numberAlternativePeriod End > Weighted Average Remaining Recognition Period, as reported by the ingested file.
Format: double
period_end_weighted_avg_remaining_recognition_period (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
period_end_weighted_avg_remaining_recognition_period (anyOf 2)nullAlternativePeriod End > Weighted Average Remaining Recognition Period, as reported by the ingested file.
Format: double
plan_namestringRequired within parentEquity plan name, as reported by the ingested file.
row_hashstringRequired within parentHash of the reported values on this record. Compare it between syncs to detect a change without diffing every field.
source_file_idstringRequired within parentIdentifier of the ingested Shareworks report file this record was last upserted from.
Format: uuid
total_estimated_expenseJSONRequired within parent
total_estimated_expense (anyOf 1)JSONAlternative
total_estimated_expense (anyOf 1) (anyOf 1)numberAlternativeTotal estimated expense, as reported by the ingested file.
Format: double
total_estimated_expense (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_estimated_expense (anyOf 2)nullAlternativeTotal estimated expense, as reported by the ingested file.
Format: double
total_estimated_shares_to_expenseJSONRequired within parent
total_estimated_shares_to_expense (anyOf 1)JSONAlternative
total_estimated_shares_to_expense (anyOf 1) (anyOf 1)numberAlternativeTotal estimated shares to expense, as reported by the ingested file.
Format: double
total_estimated_shares_to_expense (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_estimated_shares_to_expense (anyOf 2)nullAlternativeTotal estimated shares to expense, as reported by the ingested file.
Format: double
updated_atstringRequired within parentTimestamp this record was last upserted, for incremental sync.
Format: date-time
valuation_statusJSONRequired within parent
valuation_status (anyOf 1)stringAlternativeValuation status (e.g. Approved, Do Not Expense), as reported by the ingested file.
valuation_status (anyOf 2)nullAlternativeValuation status (e.g. Approved, Do Not Expense), as reported by the ingested file.
within_period_agg_grant_price_of_shares_early_exercised_vestedJSONRequired within parent
within_period_agg_grant_price_of_shares_early_exercised_vested (anyOf 1)JSONAlternative
within_period_agg_grant_price_of_shares_early_exercised_vested (anyOf 1) (anyOf 1)numberAlternativeWithin Period > Aggregate Grant Price of Shares Early Exercised Vested, as reported by the ingested file. Sparsely populated.
Format: double
within_period_agg_grant_price_of_shares_early_exercised_vested (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
within_period_agg_grant_price_of_shares_early_exercised_vested (anyOf 2)nullAlternativeWithin Period > Aggregate Grant Price of Shares Early Exercised Vested, as reported by the ingested file. Sparsely populated.
Format: double
within_period_agg_grant_price_of_shares_exercised_in_periodJSONRequired within parent
within_period_agg_grant_price_of_shares_exercised_in_period (anyOf 1)JSONAlternative
within_period_agg_grant_price_of_shares_exercised_in_period (anyOf 1) (anyOf 1)numberAlternativeWithin Period > Aggregate Grant Price of Shares Exercised in Period, as reported by the ingested file.
Format: double
within_period_agg_grant_price_of_shares_exercised_in_period (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
within_period_agg_grant_price_of_shares_exercised_in_period (anyOf 2)nullAlternativeWithin Period > Aggregate Grant Price of Shares Exercised in Period, as reported by the ingested file.
Format: double
within_period_expense_fv_of_shares_early_exercised_vestedJSONRequired within parent
within_period_expense_fv_of_shares_early_exercised_vested (anyOf 1)JSONAlternative
within_period_expense_fv_of_shares_early_exercised_vested (anyOf 1) (anyOf 1)numberAlternativeWithin Period > Expense (Fair Value) of Shares Early Exercised Vested, as reported by the ingested file. Sparsely populated.
Format: double
within_period_expense_fv_of_shares_early_exercised_vested (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
within_period_expense_fv_of_shares_early_exercised_vested (anyOf 2)nullAlternativeWithin Period > Expense (Fair Value) of Shares Early Exercised Vested, as reported by the ingested file. Sparsely populated.
Format: double
within_period_expense_fv_of_shares_exercised_releasedJSONRequired within parent
within_period_expense_fv_of_shares_exercised_released (anyOf 1)JSONAlternative
within_period_expense_fv_of_shares_exercised_released (anyOf 1) (anyOf 1)numberAlternativeWithin Period > Expense (Fair Value) of Shares Exercised / Released, as reported by the ingested file.
Format: double
within_period_expense_fv_of_shares_exercised_released (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
within_period_expense_fv_of_shares_exercised_released (anyOf 2)nullAlternativeWithin Period > Expense (Fair Value) of Shares Exercised / Released, as reported by the ingested file.
Format: double
within_period_expense_fv_of_shares_vestingJSONRequired within parent
within_period_expense_fv_of_shares_vesting (anyOf 1)JSONAlternative
within_period_expense_fv_of_shares_vesting (anyOf 1) (anyOf 1)numberAlternativeWithin Period > Expense (Fair Value) of Shares Vesting, as reported by the ingested file.
Format: double
within_period_expense_fv_of_shares_vesting (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
within_period_expense_fv_of_shares_vesting (anyOf 2)nullAlternativeWithin Period > Expense (Fair Value) of Shares Vesting, as reported by the ingested file.
Format: double
within_period_shares_early_exercised_vestedJSONRequired within parent
within_period_shares_early_exercised_vested (anyOf 1)JSONAlternative
within_period_shares_early_exercised_vested (anyOf 1) (anyOf 1)numberAlternativeWithin Period > Shares Early Exercised Vested, as reported by the ingested file. Sparsely populated (measured: 13 of 11,863 real rows).
Format: double
within_period_shares_early_exercised_vested (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
within_period_shares_early_exercised_vested (anyOf 2)nullAlternativeWithin Period > Shares Early Exercised Vested, as reported by the ingested file. Sparsely populated (measured: 13 of 11,863 real rows).
Format: double
within_period_shares_exercised_releasedJSONRequired within parent
within_period_shares_exercised_released (anyOf 1)JSONAlternative
within_period_shares_exercised_released (anyOf 1) (anyOf 1)numberAlternativeWithin Period > Shares Exercised / Released, as reported by the ingested file.
Format: double
within_period_shares_exercised_released (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
within_period_shares_exercised_released (anyOf 2)nullAlternativeWithin Period > Shares Exercised / Released, as reported by the ingested file.
Format: double
within_period_shares_vestingJSONRequired within parent
within_period_shares_vesting (anyOf 1)JSONAlternative
within_period_shares_vesting (anyOf 1) (anyOf 1)numberAlternativeWithin Period > Shares Vesting, as reported by the ingested file.
Format: double
within_period_shares_vesting (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
within_period_shares_vesting (anyOf 2)nullAlternativeWithin Period > Shares Vesting, as reported by the ingested file.
Format: double
within_period_total_expense_accruedJSONRequired within parent
within_period_total_expense_accrued (anyOf 1)JSONAlternative
within_period_total_expense_accrued (anyOf 1) (anyOf 1)numberAlternativeWithin Period > Total Expense Accrued, as reported by the ingested file.
Format: double
within_period_total_expense_accrued (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
within_period_total_expense_accrued (anyOf 2)nullAlternativeWithin Period > Total Expense Accrued, as reported by the ingested file.
Format: double
within_period_total_shares_accruedJSONRequired within parent
within_period_total_shares_accrued (anyOf 1)JSONAlternative
within_period_total_shares_accrued (anyOf 1) (anyOf 1)numberAlternativeWithin Period > Total Shares Accrued, as reported by the ingested file.
Format: double
within_period_total_shares_accrued (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
within_period_total_shares_accrued (anyOf 2)nullAlternativeWithin Period > Total Shares Accrued, as reported by the ingested file.
Format: double

List equity grant total expense records — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentPage of total expense records, one per grant occurrence.
data[]ModelEach itemExpand List equity grant total expense records — 200 response body — data item
has_morebooleanRequired within parentWhether another page of results is available.
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeCursor for the next page. Null when has_more is false.
next_cursor (anyOf 2)nullAlternativeCursor for the next page. Null when has_more is false.

Referenced models: List equity grant total expense records — 200 response body — data item

List equity grant total expense records — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
actual_forfeituresJSONRequired within parent
actual_forfeitures (anyOf 1)numberAlternativeActual forfeited share count, as reported by the ingested file.
Format: double
actual_forfeitures (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
actual_performance_factorJSONRequired within parent
actual_performance_factor (anyOf 1)JSONAlternative
actual_performance_factor (anyOf 1) (anyOf 1)numberAlternativeActual performance factor applied, as reported by the ingested file.
Format: double
actual_performance_factor (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
actual_performance_factor (anyOf 2)nullAlternativeActual performance factor applied, as reported by the ingested file.
Format: double
award_typestringRequired within parentAward type (e.g. Restricted Stock - Standard), as reported by the ingested file.
base_expenseJSONRequired within parent
base_expense (anyOf 1)JSONAlternative
base_expense (anyOf 1) (anyOf 1)numberAlternativeBase expense amount, as reported by the ingested file.
Format: double
base_expense (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
base_expense (anyOf 2)nullAlternativeBase expense amount, as reported by the ingested file.
Format: double
base_sharesJSONRequired within parent
base_shares (anyOf 1)numberAlternativeBase share count for this grant, as reported by the ingested file.
Format: double
base_shares (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
created_atstringRequired within parentTimestamp this record was first ingested.
Format: date-time
employee_grant_numberstringRequired within parentShareworks grant number for this employee, as reported by the ingested file.
employee_numberstringRequired within parentShareworks employee number, as reported by the ingested file. The intended join key for this record. Some values are non-numeric for legacy or masked records.
estimated_forfeituresJSONRequired within parent
estimated_forfeitures (anyOf 1)JSONAlternative
estimated_forfeitures (anyOf 1) (anyOf 1)numberAlternativeEstimated forfeited share count, as reported by the ingested file.
Format: double
estimated_forfeitures (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
estimated_forfeitures (anyOf 2)nullAlternativeEstimated forfeited share count, as reported by the ingested file.
Format: double
estimated_performance_factorJSONRequired within parent
estimated_performance_factor (anyOf 1)JSONAlternative
estimated_performance_factor (anyOf 1) (anyOf 1)numberAlternativeEstimated performance factor, as reported by the ingested file.
Format: double
estimated_performance_factor (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
estimated_performance_factor (anyOf 2)nullAlternativeEstimated performance factor, as reported by the ingested file.
Format: double
factor_sharesJSONRequired within parent
factor_shares (anyOf 1)JSONAlternative
factor_shares (anyOf 1) (anyOf 1)numberAlternativeShares resulting from the performance factor, as reported by the ingested file.
Format: double
factor_shares (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
factor_shares (anyOf 2)nullAlternativeShares resulting from the performance factor, as reported by the ingested file.
Format: double
fair_value_per_shareJSONRequired within parent
fair_value_per_share (anyOf 1)JSONAlternative
fair_value_per_share (anyOf 1) (anyOf 1)numberAlternativeFair market value per share, as reported by the ingested file.
Format: double
fair_value_per_share (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
fair_value_per_share (anyOf 2)nullAlternativeFair market value per share, as reported by the ingested file.
Format: double
forfeiture_rate_percentJSONRequired within parent
forfeiture_rate_percent (anyOf 1)JSONAlternative
forfeiture_rate_percent (anyOf 1) (anyOf 1)numberAlternativeForfeiture rate, stored as the percent NUMBER itself (e.g. 44.336788 means 44.336788%), NOT a fraction. See parseShareworksPercent.
Format: double
forfeiture_rate_percent (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
forfeiture_rate_percent (anyOf 2)nullAlternativeForfeiture rate, stored as the percent NUMBER itself (e.g. 44.336788 means 44.336788%), NOT a fraction. See parseShareworksPercent.
Format: double
grant_datestringRequired within parentDate the grant was issued, as reported by the ingested file.
Format: date
grant_namestringRequired within parentGrant name, as reported by the ingested file.
grant_priceJSONRequired within parent
grant_price (anyOf 1)JSONAlternative
grant_price (anyOf 1) (anyOf 1)numberAlternativeStrike/grant price per unit, as reported by the ingested file.
Format: double
grant_price (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
grant_price (anyOf 2)nullAlternativeStrike/grant price per unit, as reported by the ingested file.
Format: double
hris_profile_idJSONRequired within parent
hris_profile_id (anyOf 1)JSONAlternative
hris_profile_id (anyOf 1) (anyOf 1)integerAlternativeMatched HRIS profile id, if employee_number could be resolved to one. Null when unmatched, or when employee_number is non-numeric or blank.
hris_profile_id (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hris_profile_id (anyOf 2)nullAlternativeMatched HRIS profile id, if employee_number could be resolved to one. Null when unmatched, or when employee_number is non-numeric or blank.
idstringRequired within parentThe unique identifier of the record.
Format: uuid
last_seen_dataset_idJSONRequired within parent
last_seen_dataset_id (anyOf 1)stringAlternativeIdentifier of the most recent ingested dataset in which this record still appeared. Null for records ingested before dataset tracking began.
Format: uuid
last_seen_dataset_id (anyOf 2)nullAlternativeIdentifier of the most recent ingested dataset in which this record still appeared. Null for records ingested before dataset tracking began.
Format: uuid
occurrence_indexJSONRequired within parent
occurrence_index (anyOf 1)integerAlternativeDiscriminates several records the source file reports for the same natural key. Starts at 1, in the order the rows appear in the file.
occurrence_index (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
plan_namestringRequired within parentEquity plan name, as reported by the ingested file.
row_hashstringRequired within parentHash of the reported values on this record. Compare it between syncs to detect a change without diffing every field.
source_file_idstringRequired within parentIdentifier of the ingested Shareworks report file this record was last upserted from.
Format: uuid
total_actual_expense_to_accrueJSONRequired within parent
total_actual_expense_to_accrue (anyOf 1)JSONAlternative
total_actual_expense_to_accrue (anyOf 1) (anyOf 1)numberAlternativeTotal actual expense to accrue, as reported by the ingested file.
Format: double
total_actual_expense_to_accrue (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_actual_expense_to_accrue (anyOf 2)nullAlternativeTotal actual expense to accrue, as reported by the ingested file.
Format: double
total_actual_shares_to_expenseJSONRequired within parent
total_actual_shares_to_expense (anyOf 1)numberAlternativeTotal actual shares to expense, as reported by the ingested file.
Format: double
total_actual_shares_to_expense (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_estimated_expenseJSONRequired within parent
total_estimated_expense (anyOf 1)JSONAlternative
total_estimated_expense (anyOf 1) (anyOf 1)numberAlternativeTotal estimated expense, as reported by the ingested file.
Format: double
total_estimated_expense (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_estimated_expense (anyOf 2)nullAlternativeTotal estimated expense, as reported by the ingested file.
Format: double
total_estimated_shares_to_expenseJSONRequired within parent
total_estimated_shares_to_expense (anyOf 1)JSONAlternative
total_estimated_shares_to_expense (anyOf 1) (anyOf 1)numberAlternativeTotal estimated shares to expense, as reported by the ingested file.
Format: double
total_estimated_shares_to_expense (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_estimated_shares_to_expense (anyOf 2)nullAlternativeTotal estimated shares to expense, as reported by the ingested file.
Format: double
unvested_repurchasedJSONRequired within parent
unvested_repurchased (anyOf 1)JSONAlternative
unvested_repurchased (anyOf 1) (anyOf 1)numberAlternativeUnvested shares repurchased, as reported by the ingested file.
Format: double
unvested_repurchased (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
unvested_repurchased (anyOf 2)nullAlternativeUnvested shares repurchased, as reported by the ingested file.
Format: double
updated_atstringRequired within parentTimestamp this record was last upserted, for incremental sync.
Format: date-time
valuation_statusJSONRequired within parent
valuation_status (anyOf 1)stringAlternativeValuation status (e.g. Approved, Do Not Expense), as reported by the ingested file.
valuation_status (anyOf 2)nullAlternativeValuation status (e.g. Approved, Do Not Expense), as reported by the ingested file.

List equity grant valuations — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentPage of grant valuation records, one per grant occurrence.
data[]ModelEach itemExpand List equity grant valuations — 200 response body — data item
has_morebooleanRequired within parentWhether another page of results is available.
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeCursor for the next page. Null when has_more is false.
next_cursor (anyOf 2)nullAlternativeCursor for the next page. Null when has_more is false.

Referenced models: List equity grant valuations — 200 response body — data item

List equity grant valuations — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
amortization_methodstringRequired within parentAmortization method (e.g. Straight-Line), as reported by the ingested file.
award_typestringRequired within parentAward type (e.g. Restricted Stock - Standard), as reported by the ingested file.
created_atstringRequired within parentTimestamp this record was first ingested.
Format: date-time
dividend_yield_percentJSONRequired within parent
dividend_yield_percent (anyOf 1)JSONAlternative
dividend_yield_percent (anyOf 1) (anyOf 1)numberAlternativeDividend yield, stored as the percent NUMBER itself, NOT a fraction. See parseShareworksPercent. Sparsely populated (measured: 14,353 of 15,090 real rows).
Format: double
dividend_yield_percent (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
dividend_yield_percent (anyOf 2)nullAlternativeDividend yield, stored as the percent NUMBER itself, NOT a fraction. See parseShareworksPercent. Sparsely populated (measured: 14,353 of 15,090 real rows).
Format: double
dividend_yield_typeJSONRequired within parent
dividend_yield_type (anyOf 1)stringAlternativeDividend yield type, as reported by the ingested file. Sparsely populated (measured: 14,353 of 15,090 real rows).
dividend_yield_type (anyOf 2)nullAlternativeDividend yield type, as reported by the ingested file. Sparsely populated (measured: 14,353 of 15,090 real rows).
employee_grant_numberstringRequired within parentShareworks grant number for this employee, as reported by the ingested file.
expected_lifeJSONRequired within parent
expected_life (anyOf 1)JSONAlternative
expected_life (anyOf 1) (anyOf 1)numberAlternativeExpected life of the award (years), as reported by the ingested file. Sparsely populated (measured: 14,353 of 15,090 real rows).
Format: double
expected_life (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
expected_life (anyOf 2)nullAlternativeExpected life of the award (years), as reported by the ingested file. Sparsely populated (measured: 14,353 of 15,090 real rows).
Format: double
expected_life_typeJSONRequired within parent
expected_life_type (anyOf 1)stringAlternativeExpected life type, as reported by the ingested file. Sparsely populated (measured: 14,353 of 15,090 real rows).
expected_life_type (anyOf 2)nullAlternativeExpected life type, as reported by the ingested file. Sparsely populated (measured: 14,353 of 15,090 real rows).
expense_amortization_start_datestringRequired within parentExpense amortization start date, as reported by the ingested file.
Format: date
expense_valuation_modelstringRequired within parentExpense valuation model (e.g. Black-Scholes), as reported by the ingested file.
fair_value_per_shareJSONRequired within parent
fair_value_per_share (anyOf 1)numberAlternativeFair market value per share, as reported by the ingested file.
Format: double
fair_value_per_share (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
forfeiture_rate_calculation_methodstringRequired within parentForfeiture rate calculation method, as reported by the ingested file.
forfeiture_rate_percentJSONRequired within parent
forfeiture_rate_percent (anyOf 1)numberAlternativeForfeiture rate, stored as the percent NUMBER itself (e.g. 5.25 means 5.25%), NOT a fraction. See parseShareworksPercent.
Format: double
forfeiture_rate_percent (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
grant_datestringRequired within parentDate the grant was issued, as reported by the ingested file.
Format: date
grant_namestringRequired within parentGrant name, as reported by the ingested file.
grant_priceJSONRequired within parent
grant_price (anyOf 1)numberAlternativeStrike/grant price per unit, as reported by the ingested file.
Format: double
grant_price (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
idstringRequired within parentThe unique identifier of the record.
Format: uuid
last_seen_dataset_idJSONRequired within parent
last_seen_dataset_id (anyOf 1)stringAlternativeIdentifier of the most recent ingested dataset in which this record still appeared. Null for records ingested before dataset tracking began.
Format: uuid
last_seen_dataset_id (anyOf 2)nullAlternativeIdentifier of the most recent ingested dataset in which this record still appeared. Null for records ingested before dataset tracking began.
Format: uuid
market_priceJSONRequired within parent
market_price (anyOf 1)numberAlternativeMarket price per unit, as reported by the ingested file.
Format: double
market_price (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
occurrence_indexJSONRequired within parent
occurrence_index (anyOf 1)integerAlternativeDiscriminates several records the source file reports for the same natural key. Starts at 1, in the order the rows appear in the file.
occurrence_index (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
original_grantedJSONRequired within parent
original_granted (anyOf 1)numberAlternativeOriginal granted share count, as reported by the ingested file.
Format: double
original_granted (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
original_performance_ruleJSONRequired within parent
original_performance_rule (anyOf 1)stringAlternativeOriginal performance rule, as reported by the ingested file. Sparsely populated (measured: 25 of 15,090 real rows).
original_performance_rule (anyOf 2)nullAlternativeOriginal performance rule, as reported by the ingested file. Sparsely populated (measured: 25 of 15,090 real rows).
original_vest_dateJSONRequired within parent
original_vest_date (anyOf 1)stringAlternativeOriginal vest date, as reported by the ingested file. Sparsely populated (measured: 4,477 of 15,090 real rows) - deliberately NOT part of the uniqueness key, since a Null value would not conflict with another Null under Postgres unique-constraint semantics.
Format: date
original_vest_date (anyOf 2)nullAlternativeOriginal vest date, as reported by the ingested file. Sparsely populated (measured: 4,477 of 15,090 real rows) - deliberately NOT part of the uniqueness key, since a Null value would not conflict with another Null under Postgres unique-constraint semantics.
Format: date
plan_namestringRequired within parentEquity plan name, as reported by the ingested file.
risk_free_rate_percentJSONRequired within parent
risk_free_rate_percent (anyOf 1)JSONAlternative
risk_free_rate_percent (anyOf 1) (anyOf 1)numberAlternativeRisk-free rate, stored as the percent NUMBER itself, NOT a fraction. See parseShareworksPercent. Sparsely populated (measured: 14,353 of 15,090 real rows).
Format: double
risk_free_rate_percent (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
risk_free_rate_percent (anyOf 2)nullAlternativeRisk-free rate, stored as the percent NUMBER itself, NOT a fraction. See parseShareworksPercent. Sparsely populated (measured: 14,353 of 15,090 real rows).
Format: double
risk_free_rate_sourceJSONRequired within parent
risk_free_rate_source (anyOf 1)stringAlternativeRisk-free rate source, as reported by the ingested file. Sparsely populated (measured: 8,308 of 15,090 real rows).
risk_free_rate_source (anyOf 2)nullAlternativeRisk-free rate source, as reported by the ingested file. Sparsely populated (measured: 8,308 of 15,090 real rows).
risk_free_rate_typeJSONRequired within parent
risk_free_rate_type (anyOf 1)stringAlternativeRisk-free rate type, as reported by the ingested file. Sparsely populated (measured: 14,353 of 15,090 real rows).
risk_free_rate_type (anyOf 2)nullAlternativeRisk-free rate type, as reported by the ingested file. Sparsely populated (measured: 14,353 of 15,090 real rows).
row_hashstringRequired within parentHash of the reported values on this record. Compare it between syncs to detect a change without diffing every field.
source_file_idstringRequired within parentIdentifier of the ingested Shareworks report file this record was last upserted from.
Format: uuid
updated_atstringRequired within parentTimestamp this record was last upserted, for incremental sync.
Format: date-time
valuation_typestringRequired within parentValuation type, as reported by the ingested file.
volatility_percentJSONRequired within parent
volatility_percent (anyOf 1)JSONAlternative
volatility_percent (anyOf 1) (anyOf 1)numberAlternativeVolatility, stored as the percent NUMBER itself, NOT a fraction. See parseShareworksPercent. Sparsely populated (measured: 14,353 of 15,090 real rows).
Format: double
volatility_percent (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
volatility_percent (anyOf 2)nullAlternativeVolatility, stored as the percent NUMBER itself, NOT a fraction. See parseShareworksPercent. Sparsely populated (measured: 14,353 of 15,090 real rows).
Format: double
volatility_typeJSONRequired within parent
volatility_type (anyOf 1)stringAlternativeVolatility type, as reported by the ingested file. Sparsely populated (measured: 14,353 of 15,090 real rows).
volatility_type (anyOf 2)nullAlternativeVolatility type, as reported by the ingested file. Sparsely populated (measured: 14,353 of 15,090 real rows).

List equity grants with tax events — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayOptional
data[]ModelEach itemExpand List equity grants with tax events — 200 response body — data item
limitJSONOptional
limit (anyOf 1)integerAlternativeThe limit applied to this page of results
limit (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
offsetJSONOptional
offset (anyOf 1)integerAlternativeThe offset applied to this page of results
offset (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
totalJSONOptional
total (anyOf 1)integerAlternativeThe total number of grants matching the query, independent of limit/offset
total (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List equity grants with tax events — 200 response body — data item

List equity grants with tax events — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
additional_grant_requirements_and_restrictionsJSONOptional
additional_grant_requirements_and_restrictions (anyOf 1)stringAlternativeFree-text additional requirements or restrictions on the grant
additional_grant_requirements_and_restrictions (anyOf 2)nullAlternativeFree-text additional requirements or restrictions on the grant
cliff_periodJSONOptional
cliff_period (anyOf 1)JSONAlternative
cliff_period (anyOf 1) (anyOf 1)numberAlternativeThe cliff period in months before any shares vest
Format: double
cliff_period (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
cliff_period (anyOf 2)nullAlternativeThe cliff period in months before any shares vest
Format: double
equity_grant_typeJSONOptional
equity_grant_type (anyOf 1)stringAlternativeThe type of equity instrument granted
equity_grant_type (anyOf 2)nullAlternativeThe type of equity instrument granted
equity_grant_type_nameJSONOptional
equity_grant_type_name (anyOf 1)stringAlternativeThe organization's custom label for the grant type
equity_grant_type_name (anyOf 2)nullAlternativeThe organization's custom label for the grant type
exercise_priceJSONOptional
exercise_price (anyOf 1)JSONAlternative
exercise_price (anyOf 1) (anyOf 1)numberAlternativeThe per-unit price at which the option or warrant can be exercised, in exercise price currency
Format: double
exercise_price (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
exercise_price (anyOf 2)nullAlternativeThe per-unit price at which the option or warrant can be exercised, in exercise price currency
Format: double
exercise_price_currencyJSONOptional
exercise_price_currency (anyOf 1)stringAlternativeThe currency of the exercise price
exercise_price_currency (anyOf 2)nullAlternativeThe currency of the exercise price
fmv_when_grantedJSONOptional
fmv_when_granted (anyOf 1)JSONAlternative
fmv_when_granted (anyOf 1) (anyOf 1)numberAlternativeThe fair market value of the underlying instrument at grant time
Format: double
fmv_when_granted (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
fmv_when_granted (anyOf 2)nullAlternativeThe fair market value of the underlying instrument at grant time
Format: double
grant_currencyJSONOptional
grant_currency (anyOf 1)stringAlternativeThe currency of the grant value
grant_currency (anyOf 2)nullAlternativeThe currency of the grant value
grant_dateJSONOptional
grant_date (anyOf 1)stringAlternativeThe date the grant was issued
Format: date
grant_date (anyOf 2)nullAlternativeThe date the grant was issued
Format: date
grant_nameJSONOptional
grant_name (anyOf 1)stringAlternativeThe name of the grant
grant_name (anyOf 2)nullAlternativeThe name of the grant
grant_statusJSONOptional
grant_status (anyOf 1)stringAlternativeThe lifecycle status of the grant (e.g. GRANTED, PENDING_APPROVAL)
grant_status (anyOf 2)nullAlternativeThe lifecycle status of the grant (e.g. GRANTED, PENDING_APPROVAL)
hris_profileModelOptionalExpand List equity grants with tax events — 200 response body — data item hris profile
Profile information for the EOR worker who holds the grant
idstringOptionalThe unique identifier of the equity grant
Format: uuid
option_expirationJSONOptional
option_expiration (anyOf 1)stringAlternativeThe date the option expires
Format: date
option_expiration (anyOf 2)nullAlternativeThe date the option expires
Format: date
quantityJSONOptional
quantity (anyOf 1)JSONAlternative
quantity (anyOf 1) (anyOf 1)numberAlternativeThe total quantity granted
Format: double
quantity (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
quantity (anyOf 2)nullAlternativeThe total quantity granted
Format: double
reference_idJSONOptional
reference_id (anyOf 1)JSONAlternative
reference_id (anyOf 1) (anyOf 1)numberAlternativeThe human-readable reference number of the grant
Format: double
reference_id (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
reference_id (anyOf 2)nullAlternativeThe human-readable reference number of the grant
Format: double
sourceJSONOptional
source (anyOf 1)stringAlternativeThe system of record the grant originated from
source (anyOf 2)nullAlternativeThe system of record the grant originated from
tax_eventsarrayOptionalThe tax events reported against this grant
tax_events[]ModelEach itemExpand List equity grants with tax events — 200 response body — data item tax events item
tranchesJSONOptional
tranches (anyOf 1)JSONAlternative
tranches (anyOf 1) (anyOf 1)numberAlternativeThe number of vesting tranches
Format: double
tranches (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
tranches (anyOf 2)nullAlternativeThe number of vesting tranches
Format: double
valueJSONOptional
value (anyOf 1)JSONAlternative
value (anyOf 1) (anyOf 1)numberAlternativeThe total grant value at the time of issuance, in grant currency
Format: double
value (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
value (anyOf 2)nullAlternativeThe total grant value at the time of issuance, in grant currency
Format: double
vested_eventsarrayOptionalThe individual vesting events recorded for this grant
vested_events[]ModelEach itemExpand List equity grants with tax events — 200 response body — data item vested events item
vested_quantityJSONOptional
vested_quantity (anyOf 1)JSONAlternative
vested_quantity (anyOf 1) (anyOf 1)numberAlternativeThe quantity vested so far
Format: double
vested_quantity (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
vested_quantity (anyOf 2)nullAlternativeThe quantity vested so far
Format: double
vesting_lengthJSONOptional
vesting_length (anyOf 1)JSONAlternative
vesting_length (anyOf 1) (anyOf 1)numberAlternativeThe total vesting length in months
Format: double
vesting_length (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
vesting_length (anyOf 2)nullAlternativeThe total vesting length in months
Format: double
vesting_start_dateJSONOptional
vesting_start_date (anyOf 1)stringAlternativeThe date vesting begins
Format: date
vesting_start_date (anyOf 2)nullAlternativeThe date vesting begins
Format: date

Referenced models: List equity grants with tax events — 200 response body — data item hris profile, List equity grants with tax events — 200 response body — data item tax events item, List equity grants with tax events — 200 response body — data item vested events item

List equity grants with tax events — 200 response body — data item hris profile

FieldTypePresenceDescription and constraints
$objectRootProfile information for the EOR worker who holds the grant
emailstringOptionalThe worker's email address
Format: email
first_nameJSONOptional
first_name (anyOf 1)stringAlternativeThe worker's first name
first_name (anyOf 2)nullAlternativeThe worker's first name
hiring_typeJSONOptional
hiring_type (anyOf 1)stringAlternativeThe worker's engagement type within Deel (e.g. employee, contractor)
hiring_type (anyOf 2)nullAlternativeThe worker's engagement type within Deel (e.g. employee, contractor)
idstringOptionalThe unique identifier of the worker
Format: uuid
job_titleJSONOptional
job_title (anyOf 1)stringAlternativeThe worker's job title
job_title (anyOf 2)nullAlternativeThe worker's job title
last_nameJSONOptional
last_name (anyOf 1)stringAlternativeThe worker's last name
last_name (anyOf 2)nullAlternativeThe worker's last name
middle_nameJSONOptional
middle_name (anyOf 1)stringAlternativeThe worker's middle name
middle_name (anyOf 2)nullAlternativeThe worker's middle name
pic_urlJSONOptional
pic_url (anyOf 1)stringAlternativeURL of the worker's profile picture
pic_url (anyOf 2)nullAlternativeURL of the worker's profile picture

List equity grants with tax events — 200 response body — data item tax events item

FieldTypePresenceDescription and constraints
$objectRoot
actual_payroll_cycle_cutoffJSONOptional
actual_payroll_cycle_cutoff (anyOf 1)stringAlternativeThe cutoff date of the actual payroll cycle
Format: date-time
actual_payroll_cycle_cutoff (anyOf 2)nullAlternativeThe cutoff date of the actual payroll cycle
Format: date-time
actual_payroll_cycle_endJSONOptional
actual_payroll_cycle_end (anyOf 1)stringAlternativeThe end date of the actual payroll cycle
Format: date
actual_payroll_cycle_end (anyOf 2)nullAlternativeThe end date of the actual payroll cycle
Format: date
actual_payroll_cycle_idJSONOptional
actual_payroll_cycle_id (anyOf 1)stringAlternativeThe unique identifier of the actual payroll cycle
Format: uuid
actual_payroll_cycle_id (anyOf 2)nullAlternativeThe unique identifier of the actual payroll cycle
Format: uuid
actual_payroll_cycle_startJSONOptional
actual_payroll_cycle_start (anyOf 1)stringAlternativeThe start date of the actual payroll cycle
Format: date
actual_payroll_cycle_start (anyOf 2)nullAlternativeThe start date of the actual payroll cycle
Format: date
archived_atJSONOptional
archived_at (anyOf 1)stringAlternativeThe date and time the tax event was archived
Format: date-time
archived_at (anyOf 2)nullAlternativeThe date and time the tax event was archived
Format: date-time
benefit_in_kind_local_currencyJSONOptional
benefit_in_kind_local_currency (anyOf 1)stringAlternativeThe benefit-in-kind (BIK) value reported to payroll, expressed in the worker's local payroll currency
benefit_in_kind_local_currency (anyOf 2)nullAlternativeThe benefit-in-kind (BIK) value reported to payroll, expressed in the worker's local payroll currency
contract_completion_dateJSONOptional
contract_completion_date (anyOf 1)stringAlternativeThe completion date of the associated contract
Format: date-time
contract_completion_date (anyOf 2)nullAlternativeThe completion date of the associated contract
Format: date-time
contract_idstringOptionalThe unique identifier of the contract associated with the tax event
contract_statusstringOptionalThe lifecycle status of the associated worker contract (e.g. in_progress, completed, cancelled)
countryJSONOptional
country (anyOf 1)stringAlternativeThe ISO 3166-1 alpha-2 country code of the worker's employment country
country (anyOf 2)nullAlternativeThe ISO 3166-1 alpha-2 country code of the worker's employment country
created_atJSONOptional
created_at (anyOf 1)stringAlternativeThe date and time the tax event was created
Format: date-time
created_at (anyOf 2)nullAlternativeThe date and time the tax event was created
Format: date-time
created_by_emailJSONOptional
created_by_email (anyOf 1)stringAlternativeThe email of the user who created the tax event
Format: email
created_by_email (anyOf 2)nullAlternativeThe email of the user who created the tax event
Format: email
emailstringOptionalThe worker's email address
Format: email
equity_service_statusstringOptionalThe equity service enrollment status for the worker (ONBOARDED, OFFBOARDED, NOT_ONBOARDED, NOT_ELIGIBLE, MORE_INFO_REQUIRED)
event_dateJSONOptional
event_date (anyOf 1)stringAlternativeThe date of the tax event
Format: date
event_date (anyOf 2)nullAlternativeThe date of the tax event
Format: date
exercise_priceJSONOptional
exercise_price (anyOf 1)stringAlternativeThe price at which the equity was exercised
exercise_price (anyOf 2)nullAlternativeThe price at which the equity was exercised
expected_payroll_cycle_cutoffJSONOptional
expected_payroll_cycle_cutoff (anyOf 1)stringAlternativeThe cutoff date of the expected payroll cycle
Format: date-time
expected_payroll_cycle_cutoff (anyOf 2)nullAlternativeThe cutoff date of the expected payroll cycle
Format: date-time
expected_payroll_cycle_endJSONOptional
expected_payroll_cycle_end (anyOf 1)stringAlternativeThe end date of the expected payroll cycle
Format: date
expected_payroll_cycle_end (anyOf 2)nullAlternativeThe end date of the expected payroll cycle
Format: date
expected_payroll_cycle_idJSONOptional
expected_payroll_cycle_id (anyOf 1)stringAlternativeThe unique identifier of the expected payroll cycle
Format: uuid
expected_payroll_cycle_id (anyOf 2)nullAlternativeThe unique identifier of the expected payroll cycle
Format: uuid
expected_payroll_cycle_startJSONOptional
expected_payroll_cycle_start (anyOf 1)stringAlternativeThe start date of the expected payroll cycle
Format: date
expected_payroll_cycle_start (anyOf 2)nullAlternativeThe start date of the expected payroll cycle
Format: date
external_idJSONOptional
external_id (anyOf 1)stringAlternativeAn external system identifier for the worker, such as an ID from a cap-table provider
external_id (anyOf 2)nullAlternativeAn external system identifier for the worker, such as an ID from a cap-table provider
first_nameJSONOptional
first_name (anyOf 1)stringAlternativeThe worker's first name
first_name (anyOf 2)nullAlternativeThe worker's first name
fx_rateJSONOptional
fx_rate (anyOf 1)stringAlternativeThe exchange rate used to convert local currency to payroll currency
fx_rate (anyOf 2)nullAlternativeThe exchange rate used to convert local currency to payroll currency
grant_dateJSONOptional
grant_date (anyOf 1)stringAlternativeThe date the associated grant was issued
Format: date
grant_date (anyOf 2)nullAlternativeThe date the associated grant was issued
Format: date
grant_idJSONOptional
grant_id (anyOf 1)stringAlternativeThe unique identifier of the associated grant
Format: uuid
grant_id (anyOf 2)nullAlternativeThe unique identifier of the associated grant
Format: uuid
grant_reference_idJSONOptional
grant_reference_id (anyOf 1)JSONAlternative
grant_reference_id (anyOf 1) (anyOf 1)numberAlternativeThe human-readable reference number of the associated grant
Format: double
grant_reference_id (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
grant_reference_id (anyOf 2)nullAlternativeThe human-readable reference number of the associated grant
Format: double
grant_typeJSONOptional
grant_type (anyOf 1)stringAlternativeThe equity instrument type of the associated grant (e.g. RSU, NSO, ISO)
grant_type (anyOf 2)nullAlternativeThe equity instrument type of the associated grant (e.g. RSU, NSO, ISO)
gross_valueJSONOptional
gross_value (anyOf 1)stringAlternativeThe gross value of the equity event, calculated as unit FMV multiplied by quantity exercised or released
gross_value (anyOf 2)nullAlternativeThe gross value of the equity event, calculated as unit FMV multiplied by quantity exercised or released
hris_profile_idstringOptionalThe unique identifier of the worker who holds the grant
Format: uuid
idstringOptionalThe unique identifier of the tax event
Format: uuid
instrument_typeJSONOptional
instrument_type (anyOf 1)stringAlternativeThe type of equity instrument (e.g. RSU, NSO, ISO, PHANTOM, SARS)
instrument_type (anyOf 2)nullAlternativeThe type of equity instrument (e.g. RSU, NSO, ISO, PHANTOM, SARS)
is_archivedJSONOptional
is_archived (anyOf 1)booleanAlternativeWhether the tax event has been archived
is_archived (anyOf 2)nullAlternativeWhether the tax event has been archived
last_nameJSONOptional
last_name (anyOf 1)stringAlternativeThe worker's last name
last_name (anyOf 2)nullAlternativeThe worker's last name
method_of_tax_coverageJSONOptional
method_of_tax_coverage (anyOf 1)stringAlternativeHow the benefit-in-kind (BIK) tax on this equity event is collected. BIK_WITHHOLDING_* values indicate the employer withholds tax from payroll; the suffix identifies the mechanism (e.g. at-source deduction, salary deduction, net settlement, grossed-up bonus). BIK_REPORTING_ONLY reports the BIK without withholding. NO_BIK_NO_WITHHOLDING applies when no taxable benefit arises. AD_HOC covers special cases outside the standard methods.
method_of_tax_coverage (anyOf 2)nullAlternativeHow the benefit-in-kind (BIK) tax on this equity event is collected. BIK_WITHHOLDING_* values indicate the employer withholds tax from payroll; the suffix identifies the mechanism (e.g. at-source deduction, salary deduction, net settlement, grossed-up bonus). BIK_REPORTING_ONLY reports the BIK without withholding. NO_BIK_NO_WITHHOLDING applies when no taxable benefit arises. AD_HOC covers special cases outside the standard methods.
middle_nameJSONOptional
middle_name (anyOf 1)stringAlternativeThe worker's middle name
middle_name (anyOf 2)nullAlternativeThe worker's middle name
noteJSONOptional
note (anyOf 1)stringAlternativeA free-text note attached to the tax event
note (anyOf 2)nullAlternativeA free-text note attached to the tax event
organization_idstringOptionalThe unique identifier of the organization
Format: uuid
organization_nameJSONOptional
organization_name (anyOf 1)stringAlternativeThe name of the organization
organization_name (anyOf 2)nullAlternativeThe name of the organization
payroll_currencyJSONOptional
payroll_currency (anyOf 1)stringAlternativeThe currency in which payroll is processed
payroll_currency (anyOf 2)nullAlternativeThe currency in which payroll is processed
pic_urlJSONOptional
pic_url (anyOf 1)stringAlternativeURL of the worker's profile picture
pic_url (anyOf 2)nullAlternativeURL of the worker's profile picture
plan_currencyJSONOptional
plan_currency (anyOf 1)stringAlternativeThe currency in which the equity plan was issued
plan_currency (anyOf 2)nullAlternativeThe currency in which the equity plan was issued
quantity_exercised_or_releasedJSONOptional
quantity_exercised_or_released (anyOf 1)stringAlternativeThe quantity of equity exercised or released
quantity_exercised_or_released (anyOf 2)nullAlternativeThe quantity of equity exercised or released
quantity_remainingJSONOptional
quantity_remaining (anyOf 1)stringAlternativeThe quantity of equity remaining
quantity_remaining (anyOf 2)nullAlternativeThe quantity of equity remaining
quantity_withheld_or_soldJSONOptional
quantity_withheld_or_sold (anyOf 1)stringAlternativeThe quantity of equity withheld or sold
quantity_withheld_or_sold (anyOf 2)nullAlternativeThe quantity of equity withheld or sold
sale_priceJSONOptional
sale_price (anyOf 1)stringAlternativeThe price at which the equity was sold
sale_price (anyOf 2)nullAlternativeThe price at which the equity was sold
sent_for_processing_atJSONOptional
sent_for_processing_at (anyOf 1)stringAlternativeThe date and time the event was sent for payroll processing
Format: date-time
sent_for_processing_at (anyOf 2)nullAlternativeThe date and time the event was sent for payroll processing
Format: date-time
settlement_dateJSONOptional
settlement_date (anyOf 1)stringAlternativeThe date the equity event was settled (i.e. when shares were transferred or cash was received)
Format: date
settlement_date (anyOf 2)nullAlternativeThe date the equity event was settled (i.e. when shares were transferred or cash was received)
Format: date
supporting_documents_idJSONOptional
supporting_documents_id (anyOf 1)stringAlternativeThe unique identifier of the supporting documents attached to the event
Format: uuid
supporting_documents_id (anyOf 2)nullAlternativeThe unique identifier of the supporting documents attached to the event
Format: uuid
tax_jurisdictionJSONOptional
tax_jurisdiction (anyOf 1)stringAlternativeThe ISO 3166-1 alpha-2 country code of the worker's contract jurisdiction at the time of the event
tax_jurisdiction (anyOf 2)nullAlternativeThe ISO 3166-1 alpha-2 country code of the worker's contract jurisdiction at the time of the event
tax_rateJSONOptional
tax_rate (anyOf 1)stringAlternativeThe tax rate applied to the benefit in kind
tax_rate (anyOf 2)nullAlternativeThe tax rate applied to the benefit in kind
taxable_gain_or_lossJSONOptional
taxable_gain_or_loss (anyOf 1)stringAlternativeThe taxable gain or loss on the event, typically gross value minus the total exercise price
taxable_gain_or_loss (anyOf 2)nullAlternativeThe taxable gain or loss on the event, typically gross value minus the total exercise price
total_exercise_priceJSONOptional
total_exercise_price (anyOf 1)stringAlternativeThe total exercise price paid for the equity, calculated as exercise price per unit multiplied by quantity exercised
total_exercise_price (anyOf 2)nullAlternativeThe total exercise price paid for the equity, calculated as exercise price per unit multiplied by quantity exercised
total_taxes_withheldJSONOptional
total_taxes_withheld (anyOf 1)stringAlternativeThe total amount of income tax and social contributions withheld on behalf of the worker
total_taxes_withheld (anyOf 2)nullAlternativeThe total amount of income tax and social contributions withheld on behalf of the worker
transaction_feesJSONOptional
transaction_fees (anyOf 1)stringAlternativeBrokerage or transaction fees associated with the equity event, in plan currency
transaction_fees (anyOf 2)nullAlternativeBrokerage or transaction fees associated with the equity event, in plan currency
unit_fmvJSONOptional
unit_fmv (anyOf 1)stringAlternativeThe fair market value per unit at the time of the event
unit_fmv (anyOf 2)nullAlternativeThe fair market value per unit at the time of the event
updated_atJSONOptional
updated_at (anyOf 1)stringAlternativeThe date and time the tax event was last updated
Format: date-time
updated_at (anyOf 2)nullAlternativeThe date and time the tax event was last updated
Format: date-time
verification_statusJSONOptional
verification_status (anyOf 1)stringAlternativeThe current verification status of the tax event (PENDING_VERIFICATION, VERIFIED, SENT_FOR_PROCESSING, PROCESSED, MISMATCH)
verification_status (anyOf 2)nullAlternativeThe current verification status of the tax event (PENDING_VERIFICATION, VERIFIED, SENT_FOR_PROCESSING, PROCESSED, MISMATCH)
withheld_tax_local_currencyJSONOptional
withheld_tax_local_currency (anyOf 1)stringAlternativeThe income tax and social contributions withheld, expressed in the worker's local payroll currency
withheld_tax_local_currency (anyOf 2)nullAlternativeThe income tax and social contributions withheld, expressed in the worker's local payroll currency

List equity grants with tax events — 200 response body — data item vested events item

FieldTypePresenceDescription and constraints
$objectRoot
quantityJSONOptional
quantity (anyOf 1)JSONAlternative
quantity (anyOf 1) (anyOf 1)numberAlternativeThe quantity that vested on this date
Format: double
quantity (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
quantity (anyOf 2)nullAlternativeThe quantity that vested on this date
Format: double
vesting_dateJSONOptional
vesting_date (anyOf 1)stringAlternativeThe date this tranche vested
Format: date
vesting_date (anyOf 2)nullAlternativeThe date this tranche vested
Format: date

List equity option ledger entries — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentPage of option holder ledger records, one per grant occurrence.
data[]ModelEach itemExpand List equity option ledger entries — 200 response body — data item
has_morebooleanRequired within parentWhether another page of results is available.
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeCursor for the next page. Null when has_more is false.
next_cursor (anyOf 2)nullAlternativeCursor for the next page. Null when has_more is false.

Referenced models: List equity option ledger entries — 200 response body — data item

List equity option ledger entries — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
carta_grant_acceptance_dateJSONRequired within parent
carta_grant_acceptance_date (anyOf 1)stringAlternativeCarta - Grant Acceptance Date, as reported by the ingested file.
Format: date
carta_grant_acceptance_date (anyOf 2)nullAlternativeCarta - Grant Acceptance Date, as reported by the ingested file.
Format: date
compensation_benefitJSONRequired within parent
compensation_benefit (anyOf 1)JSONAlternative
compensation_benefit (anyOf 1) (anyOf 1)numberAlternativeCompensation benefit amount, as reported by the ingested file.
Format: double
compensation_benefit (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
compensation_benefit (anyOf 2)nullAlternativeCompensation benefit amount, as reported by the ingested file.
Format: double
created_atstringRequired within parentTimestamp this record was first ingested.
Format: date-time
early_exercise_allowedJSONRequired within parent
early_exercise_allowed (anyOf 1)stringAlternativeWhether early exercise is allowed, as reported by the ingested file (verbatim text, e.g. Yes/No).
early_exercise_allowed (anyOf 2)nullAlternativeWhether early exercise is allowed, as reported by the ingested file (verbatim text, e.g. Yes/No).
employee_grant_numberstringRequired within parentShareworks grant number for this employee, as reported by the ingested file.
employee_numberJSONRequired within parent
employee_number (anyOf 1)stringAlternativeShareworks employee number, as reported by the ingested file. The intended join key for this record. Some values are non-numeric for legacy or masked records.
employee_number (anyOf 2)nullAlternativeShareworks employee number, as reported by the ingested file. The intended join key for this record. Some values are non-numeric for legacy or masked records.
exercise_price_per_shareJSONRequired within parent
exercise_price_per_share (anyOf 1)JSONAlternative
exercise_price_per_share (anyOf 1) (anyOf 1)numberAlternativeExercise price per share, as reported by the ingested file.
Format: double
exercise_price_per_share (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
exercise_price_per_share (anyOf 2)nullAlternativeExercise price per share, as reported by the ingested file.
Format: double
expire_dateJSONRequired within parent
expire_date (anyOf 1)stringAlternativeGrant expiration date, as reported by the ingested file.
Format: date
expire_date (anyOf 2)nullAlternativeGrant expiration date, as reported by the ingested file.
Format: date
federal_exemptionJSONRequired within parent
federal_exemption (anyOf 1)stringAlternativeFederal exemption, as reported by the ingested file.
federal_exemption (anyOf 2)nullAlternativeFederal exemption, as reported by the ingested file.
first_nameJSONRequired within parent
first_name (anyOf 1)stringAlternativeEmployee first name, as reported by the ingested file.
first_name (anyOf 2)nullAlternativeEmployee first name, as reported by the ingested file.
fmv_per_share_at_grant_dateJSONRequired within parent
fmv_per_share_at_grant_date (anyOf 1)JSONAlternative
fmv_per_share_at_grant_date (anyOf 1) (anyOf 1)numberAlternativeFair market value per share at grant date, as reported by the ingested file.
Format: double
fmv_per_share_at_grant_date (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
fmv_per_share_at_grant_date (anyOf 2)nullAlternativeFair market value per share at grant date, as reported by the ingested file.
Format: double
formatted_home_addressJSONRequired within parent
formatted_home_address (anyOf 1)stringAlternativeFormatted home address, as reported by the ingested file.
formatted_home_address (anyOf 2)nullAlternativeFormatted home address, as reported by the ingested file.
grant_agreement_template_nameJSONRequired within parent
grant_agreement_template_name (anyOf 1)stringAlternativeGrant agreement template name, as reported by the ingested file.
grant_agreement_template_name (anyOf 2)nullAlternativeGrant agreement template name, as reported by the ingested file.
grant_dateJSONRequired within parent
grant_date (anyOf 1)stringAlternativeDate the grant was issued, as reported by the ingested file.
Format: date
grant_date (anyOf 2)nullAlternativeDate the grant was issued, as reported by the ingested file.
Format: date
grant_nameJSONRequired within parent
grant_name (anyOf 1)stringAlternativeGrant name, as reported by the ingested file.
grant_name (anyOf 2)nullAlternativeGrant name, as reported by the ingested file.
grant_reasonJSONRequired within parent
grant_reason (anyOf 1)stringAlternativeGrant reason, as reported by the ingested file.
grant_reason (anyOf 2)nullAlternativeGrant reason, as reported by the ingested file.
grant_typeJSONRequired within parent
grant_type (anyOf 1)stringAlternativeGrant type (e.g. Options (NQ)), as reported by the ingested file.
grant_type (anyOf 2)nullAlternativeGrant type (e.g. Options (NQ)), as reported by the ingested file.
hris_profile_idJSONRequired within parent
hris_profile_id (anyOf 1)JSONAlternative
hris_profile_id (anyOf 1) (anyOf 1)integerAlternativeMatched HRIS profile id, if employee_number could be resolved to one. Null when unmatched, or when employee_number is non-numeric or blank.
hris_profile_id (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hris_profile_id (anyOf 2)nullAlternativeMatched HRIS profile id, if employee_number could be resolved to one. Null when unmatched, or when employee_number is non-numeric or blank.
idstringRequired within parentThe unique identifier of the record.
Format: uuid
is_under_rule_701JSONRequired within parent
is_under_rule_701 (anyOf 1)stringAlternativeWhether the grant is under Rule 701, as reported by the ingested file (verbatim text, e.g. Yes/No).
is_under_rule_701 (anyOf 2)nullAlternativeWhether the grant is under Rule 701, as reported by the ingested file (verbatim text, e.g. Yes/No).
iso_csop_disqualification_dateJSONRequired within parent
iso_csop_disqualification_date (anyOf 1)stringAlternativeISO/CSOP disqualification date, as reported by the ingested file.
Format: date
iso_csop_disqualification_date (anyOf 2)nullAlternativeISO/CSOP disqualification date, as reported by the ingested file.
Format: date
last_nameJSONRequired within parent
last_name (anyOf 1)stringAlternativeEmployee last name, as reported by the ingested file.
last_name (anyOf 2)nullAlternativeEmployee last name, as reported by the ingested file.
last_seen_dataset_idJSONRequired within parent
last_seen_dataset_id (anyOf 1)stringAlternativeIdentifier of the most recent ingested dataset in which this record still appeared. Null for records ingested before dataset tracking began.
Format: uuid
last_seen_dataset_id (anyOf 2)nullAlternativeIdentifier of the most recent ingested dataset in which this record still appeared. Null for records ingested before dataset tracking began.
Format: uuid
middle_nameJSONRequired within parent
middle_name (anyOf 1)stringAlternativeEmployee middle name, as reported by the ingested file.
middle_name (anyOf 2)nullAlternativeEmployee middle name, as reported by the ingested file.
no_of_shares_grantedJSONRequired within parent
no_of_shares_granted (anyOf 1)JSONAlternative
no_of_shares_granted (anyOf 1) (anyOf 1)numberAlternativeNumber of shares/units granted, as reported by the ingested file.
Format: double
no_of_shares_granted (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
no_of_shares_granted (anyOf 2)nullAlternativeNumber of shares/units granted, as reported by the ingested file.
Format: double
no_of_shares_unvestedJSONRequired within parent
no_of_shares_unvested (anyOf 1)JSONAlternative
no_of_shares_unvested (anyOf 1) (anyOf 1)numberAlternativeNumber of shares unvested, as reported by the ingested file.
Format: double
no_of_shares_unvested (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
no_of_shares_unvested (anyOf 2)nullAlternativeNumber of shares unvested, as reported by the ingested file.
Format: double
no_of_shares_vestedJSONRequired within parent
no_of_shares_vested (anyOf 1)JSONAlternative
no_of_shares_vested (anyOf 1) (anyOf 1)numberAlternativeNumber of shares vested, as reported by the ingested file.
Format: double
no_of_shares_vested (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
no_of_shares_vested (anyOf 2)nullAlternativeNumber of shares vested, as reported by the ingested file.
Format: double
notesJSONRequired within parent
notes (anyOf 1)stringAlternativeFree-form notes, as reported by the ingested file.
notes (anyOf 2)nullAlternativeFree-form notes, as reported by the ingested file.
occurrence_indexJSONRequired within parent
occurrence_index (anyOf 1)integerAlternativeDiscriminates several records the source file reports for the same natural key. Starts at 1, in the order the rows appear in the file.
occurrence_index (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
outstanding_exercisableJSONRequired within parent
outstanding_exercisable (anyOf 1)JSONAlternative
outstanding_exercisable (anyOf 1) (anyOf 1)numberAlternativeOutstanding exercisable shares, as reported by the ingested file.
Format: double
outstanding_exercisable (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
outstanding_exercisable (anyOf 2)nullAlternativeOutstanding exercisable shares, as reported by the ingested file.
Format: double
outstanding_unvestedJSONRequired within parent
outstanding_unvested (anyOf 1)JSONAlternative
outstanding_unvested (anyOf 1) (anyOf 1)numberAlternativeOutstanding unvested shares, as reported by the ingested file.
Format: double
outstanding_unvested (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
outstanding_unvested (anyOf 2)nullAlternativeOutstanding unvested shares, as reported by the ingested file.
Format: double
outstanding_vestedJSONRequired within parent
outstanding_vested (anyOf 1)JSONAlternative
outstanding_vested (anyOf 1) (anyOf 1)numberAlternativeOutstanding vested shares, as reported by the ingested file.
Format: double
outstanding_vested (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
outstanding_vested (anyOf 2)nullAlternativeOutstanding vested shares, as reported by the ingested file.
Format: double
plan_nameJSONRequired within parent
plan_name (anyOf 1)stringAlternativeEquity plan name, as reported by the ingested file.
plan_name (anyOf 2)nullAlternativeEquity plan name, as reported by the ingested file.
preferred_share_priceJSONRequired within parent
preferred_share_price (anyOf 1)JSONAlternative
preferred_share_price (anyOf 1) (anyOf 1)numberAlternativePreferred share price, as reported by the ingested file.
Format: double
preferred_share_price (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
preferred_share_price (anyOf 2)nullAlternativePreferred share price, as reported by the ingested file.
Format: double
row_hashstringRequired within parentHash of the reported values on this record. Compare it between syncs to detect a change without diffing every field.
section_102_disqualification_dateJSONRequired within parent
section_102_disqualification_date (anyOf 1)stringAlternative"102 Disqualification date" in the source file (Section 102 of the Israeli tax ordinance).
Format: date
section_102_disqualification_date (anyOf 2)nullAlternative"102 Disqualification date" in the source file (Section 102 of the Israeli tax ordinance).
Format: date
shares_cancelledJSONRequired within parent
shares_cancelled (anyOf 1)JSONAlternative
shares_cancelled (anyOf 1) (anyOf 1)numberAlternativeShares cancelled, as reported by the ingested file.
Format: double
shares_cancelled (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
shares_cancelled (anyOf 2)nullAlternativeShares cancelled, as reported by the ingested file.
Format: double
shares_exercised_releasedJSONRequired within parent
shares_exercised_released (anyOf 1)JSONAlternative
shares_exercised_released (anyOf 1) (anyOf 1)numberAlternativeShares exercised/released, as reported by the ingested file.
Format: double
shares_exercised_released (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
shares_exercised_released (anyOf 2)nullAlternativeShares exercised/released, as reported by the ingested file.
Format: double
shares_expiredJSONRequired within parent
shares_expired (anyOf 1)JSONAlternative
shares_expired (anyOf 1) (anyOf 1)numberAlternativeShares expired, as reported by the ingested file.
Format: double
shares_expired (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
shares_expired (anyOf 2)nullAlternativeShares expired, as reported by the ingested file.
Format: double
shares_outstandingJSONRequired within parent
shares_outstanding (anyOf 1)JSONAlternative
shares_outstanding (anyOf 1) (anyOf 1)numberAlternativeShares outstanding, as reported by the ingested file.
Format: double
shares_outstanding (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
shares_outstanding (anyOf 2)nullAlternativeShares outstanding, as reported by the ingested file.
Format: double
shares_repurchasedJSONRequired within parent
shares_repurchased (anyOf 1)JSONAlternative
shares_repurchased (anyOf 1) (anyOf 1)numberAlternativeShares repurchased, as reported by the ingested file.
Format: double
shares_repurchased (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
shares_repurchased (anyOf 2)nullAlternativeShares repurchased, as reported by the ingested file.
Format: double
shares_subject_to_repurchaseJSONRequired within parent
shares_subject_to_repurchase (anyOf 1)JSONAlternative
shares_subject_to_repurchase (anyOf 1) (anyOf 1)numberAlternativeShares subject to repurchase, as reported by the ingested file.
Format: double
shares_subject_to_repurchase (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
shares_subject_to_repurchase (anyOf 2)nullAlternativeShares subject to repurchase, as reported by the ingested file.
Format: double
shareworks_grant_agreement_agreement_dateJSONRequired within parent
shareworks_grant_agreement_agreement_date (anyOf 1)stringAlternativeShareworks - Grant Agreement - Agreement Date, as reported by the ingested file.
Format: date
shareworks_grant_agreement_agreement_date (anyOf 2)nullAlternativeShareworks - Grant Agreement - Agreement Date, as reported by the ingested file.
Format: date
shareworks_grant_agreement_print_instantJSONRequired within parent
shareworks_grant_agreement_print_instant (anyOf 1)stringAlternativeShareworks - Grant Agreement - Print Instant, as reported by the ingested file.
shareworks_grant_agreement_print_instant (anyOf 2)nullAlternativeShareworks - Grant Agreement - Print Instant, as reported by the ingested file.
source_file_idstringRequired within parentIdentifier of the ingested Shareworks report file this record was last upserted from.
Format: uuid
split_employee_grant_numberJSONRequired within parent
split_employee_grant_number (anyOf 1)stringAlternativeSplit Employee Grant Number, as reported by the ingested file.
split_employee_grant_number (anyOf 2)nullAlternativeSplit Employee Grant Number, as reported by the ingested file.
state_exemptionJSONRequired within parent
state_exemption (anyOf 1)stringAlternativeState exemption, as reported by the ingested file.
state_exemption (anyOf 2)nullAlternativeState exemption, as reported by the ingested file.
stock_options_and_awards_employee_statusJSONRequired within parent
stock_options_and_awards_employee_status (anyOf 1)stringAlternativeStock Options and Awards Employee Status, as reported by the ingested file.
stock_options_and_awards_employee_status (anyOf 2)nullAlternativeStock Options and Awards Employee Status, as reported by the ingested file.
stock_options_and_awards_employee_status_effective_dateJSONRequired within parent
stock_options_and_awards_employee_status_effective_date (anyOf 1)stringAlternativeStock Options and Awards Employee Status (Effective Date), as reported by the ingested file.
Format: date
stock_options_and_awards_employee_status_effective_date (anyOf 2)nullAlternativeStock Options and Awards Employee Status (Effective Date), as reported by the ingested file.
Format: date
tax_identifierJSONRequired within parent
tax_identifier (anyOf 1)stringAlternativeTax identifier, as reported by the ingested file.
tax_identifier (anyOf 2)nullAlternativeTax identifier, as reported by the ingested file.
total_exercise_priceJSONRequired within parent
total_exercise_price (anyOf 1)JSONAlternative
total_exercise_price (anyOf 1) (anyOf 1)numberAlternativeTotal exercise price for the grant, as reported by the ingested file.
Format: double
total_exercise_price (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_exercise_price (anyOf 2)nullAlternativeTotal exercise price for the grant, as reported by the ingested file.
Format: double
total_fmvJSONRequired within parent
total_fmv (anyOf 1)JSONAlternative
total_fmv (anyOf 1) (anyOf 1)numberAlternativeTotal fair market value of the grant, as reported by the ingested file.
Format: double
total_fmv (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_fmv (anyOf 2)nullAlternativeTotal fair market value of the grant, as reported by the ingested file.
Format: double
updated_atstringRequired within parentTimestamp this record was last upserted, for incremental sync.
Format: date-time
vesting_scheduleJSONRequired within parent
vesting_schedule (anyOf 1)stringAlternativeVesting schedule name, as reported by the ingested file.
vesting_schedule (anyOf 2)nullAlternativeVesting schedule name, as reported by the ingested file.
vesting_start_dateJSONRequired within parent
vesting_start_date (anyOf 1)stringAlternativeVesting start date, as reported by the ingested file.
Format: date
vesting_start_date (anyOf 2)nullAlternativeVesting start date, as reported by the ingested file.
Format: date

List equity participants — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentPage of equity participant records, one per Shareworks employee number.
data[]ModelEach itemExpand List equity participants — 200 response body — data item
has_morebooleanRequired within parentWhether another page of results is available.
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeCursor for the next page. Null when has_more is false.
next_cursor (anyOf 2)nullAlternativeCursor for the next page. Null when has_more is false.

Referenced models: List equity participants — 200 response body — data item

List equity participants — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
account_activation_dateJSONRequired within parent
account_activation_date (anyOf 1)stringAlternativeMoment the Shareworks account was activated. The source file reports this in US Pacific local time; it is returned here in UTC.
Format: date-time
account_activation_date (anyOf 2)nullAlternativeMoment the Shareworks account was activated. The source file reports this in US Pacific local time; it is returned here in UTC.
Format: date-time
account_holder_typeJSONRequired within parent
account_holder_type (anyOf 1)stringAlternativeAccount holder type, as reported by the ingested file.
account_holder_type (anyOf 2)nullAlternativeAccount holder type, as reported by the ingested file.
alternate_employee_numberJSONRequired within parent
alternate_employee_number (anyOf 1)stringAlternativeAlternate employee number, as reported by the ingested file.
alternate_employee_number (anyOf 2)nullAlternativeAlternate employee number, as reported by the ingested file.
company_emailJSONRequired within parent
company_email (anyOf 1)stringAlternativeCompany email address, as reported by the ingested file.
company_email (anyOf 2)nullAlternativeCompany email address, as reported by the ingested file.
company_provided_personal_emailJSONRequired within parent
company_provided_personal_email (anyOf 1)stringAlternativePersonal email address supplied by the company, as reported by the ingested file.
company_provided_personal_email (anyOf 2)nullAlternativePersonal email address supplied by the company, as reported by the ingested file.
cost_centerJSONRequired within parent
cost_center (anyOf 1)stringAlternativeCost center, as reported by the ingested file.
cost_center (anyOf 2)nullAlternativeCost center, as reported by the ingested file.
cost_center_effective_dateJSONRequired within parent
cost_center_effective_date (anyOf 1)stringAlternativeDate the cost center took effect.
Format: date
cost_center_effective_date (anyOf 2)nullAlternativeDate the cost center took effect.
Format: date
created_atstringRequired within parentTimestamp this record was first ingested.
Format: date-time
current_employmentJSONRequired within parent
current_employment (anyOf 1)stringAlternativeCurrent employment classification, as reported by the ingested file.
current_employment (anyOf 2)nullAlternativeCurrent employment classification, as reported by the ingested file.
current_employment_descriptionJSONRequired within parent
current_employment_description (anyOf 1)stringAlternativeFree-text description of the current employment, as reported by the ingested file. Unpopulated in every record delivered so far.
current_employment_description (anyOf 2)nullAlternativeFree-text description of the current employment, as reported by the ingested file. Unpopulated in every record delivered so far.
current_employment_effective_dateJSONRequired within parent
current_employment_effective_date (anyOf 1)stringAlternativeDate the current employment classification took effect.
Format: date
current_employment_effective_date (anyOf 2)nullAlternativeDate the current employment classification took effect.
Format: date
emailJSONRequired within parent
email (anyOf 1)stringAlternativePersonal email address, as reported by the ingested file.
email (anyOf 2)nullAlternativePersonal email address, as reported by the ingested file.
employee_numberstringRequired within parentShareworks employee number, as reported by the ingested file. The intended join key for this record. Some values are non-numeric for legacy or masked records.
full_nameJSONRequired within parent
full_name (anyOf 1)stringAlternativeParticipant full name, as reported by the ingested file.
full_name (anyOf 2)nullAlternativeParticipant full name, as reported by the ingested file.
hire_dateJSONRequired within parent
hire_date (anyOf 1)stringAlternativeHire date, as reported by the ingested file.
Format: date
hire_date (anyOf 2)nullAlternativeHire date, as reported by the ingested file.
Format: date
home_address_cityJSONRequired within parent
home_address_city (anyOf 1)stringAlternativeHome address city, as reported by the ingested file.
home_address_city (anyOf 2)nullAlternativeHome address city, as reported by the ingested file.
home_address_countryJSONRequired within parent
home_address_country (anyOf 1)stringAlternativeHome address country, as reported by the ingested file.
home_address_country (anyOf 2)nullAlternativeHome address country, as reported by the ingested file.
home_address_line_1JSONRequired within parent
home_address_line_1 (anyOf 1)stringAlternativeFirst line of the home address, as reported by the ingested file.
home_address_line_1 (anyOf 2)nullAlternativeFirst line of the home address, as reported by the ingested file.
home_address_line_2JSONRequired within parent
home_address_line_2 (anyOf 1)stringAlternativeSecond line of the home address, as reported by the ingested file.
home_address_line_2 (anyOf 2)nullAlternativeSecond line of the home address, as reported by the ingested file.
home_address_state_provinceJSONRequired within parent
home_address_state_province (anyOf 1)stringAlternativeHome address state or province, as reported by the ingested file.
home_address_state_province (anyOf 2)nullAlternativeHome address state or province, as reported by the ingested file.
home_address_zip_postal_codeJSONRequired within parent
home_address_zip_postal_code (anyOf 1)stringAlternativeHome address ZIP or postal code, as reported by the ingested file.
home_address_zip_postal_code (anyOf 2)nullAlternativeHome address ZIP or postal code, as reported by the ingested file.
hris_profile_idJSONRequired within parent
hris_profile_id (anyOf 1)JSONAlternative
hris_profile_id (anyOf 1) (anyOf 1)integerAlternativeMatched HRIS profile id, if employee_number could be resolved to one. Null when unmatched, or when employee_number is non-numeric or blank.
hris_profile_id (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hris_profile_id (anyOf 2)nullAlternativeMatched HRIS profile id, if employee_number could be resolved to one. Null when unmatched, or when employee_number is non-numeric or blank.
idstringRequired within parentThe unique identifier of the participant record.
Format: uuid
last_seen_dataset_idJSONRequired within parent
last_seen_dataset_id (anyOf 1)stringAlternativeIdentifier of the most recent ingested dataset in which this record still appeared. Null for records ingested before dataset tracking began.
Format: uuid
last_seen_dataset_id (anyOf 2)nullAlternativeIdentifier of the most recent ingested dataset in which this record still appeared. Null for records ingested before dataset tracking began.
Format: uuid
organization_nameJSONRequired within parent
organization_name (anyOf 1)stringAlternativeOrganization name, as reported by the ingested file.
organization_name (anyOf 2)nullAlternativeOrganization name, as reported by the ingested file.
pre_clearanceJSONRequired within parent
pre_clearance (anyOf 1)stringAlternativePre-clearance status, as reported by the ingested file.
pre_clearance (anyOf 2)nullAlternativePre-clearance status, as reported by the ingested file.
row_hashstringRequired within parentHash of the reported values on this record. Compare it between syncs to detect a change without diffing every field.
source_file_idstringRequired within parentIdentifier of the ingested Shareworks report file this record was last upserted from.
Format: uuid
ssnJSONRequired within parent
ssn (anyOf 1)stringAlternativeUS Social Security Number, as reported by the ingested file. Returned in full, unmasked, because it is a required input to US equity tax withholding. Present only for participants whose source record carries one. Treat this value as a direct identifier and store it accordingly.
ssn (anyOf 2)nullAlternativeUS Social Security Number, as reported by the ingested file. Returned in full, unmasked, because it is a required input to US equity tax withholding. Present only for participants whose source record carries one. Treat this value as a direct identifier and store it accordingly.
stock_options_and_awards_employee_statusJSONRequired within parent
stock_options_and_awards_employee_status (anyOf 1)stringAlternativeStock options and awards employee status, as reported by the ingested file.
stock_options_and_awards_employee_status (anyOf 2)nullAlternativeStock options and awards employee status, as reported by the ingested file.
stock_options_and_awards_employee_status_effective_dateJSONRequired within parent
stock_options_and_awards_employee_status_effective_date (anyOf 1)stringAlternativeDate the stock options and awards employee status took effect.
Format: date
stock_options_and_awards_employee_status_effective_date (anyOf 2)nullAlternativeDate the stock options and awards employee status took effect.
Format: date
updated_atstringRequired within parentTimestamp this record was last upserted, for incremental sync.
Format: date-time

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.