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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Optional | the date and time when the equity/token tax event was created Format: date-time |
id | string | Optional | the id of the equity/token tax event generated Format: uuid |
Create equity or token tax event — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
benefit_in_kind_local_currency | string | Required within parent | The benefit in kind in the local currency |
contract_id | string | Required within parent | The unique identifier of the contract of the employee who received the equity/token grant |
equity_grant_id | string | Optional | The unique identifier of the equity/token grant - optional in case you don't have remove the property |
event_date | string | Optional | The date of the event Format: date |
exercise_price | string | Optional | The price at which the equity/token was exercised |
fx_rate | string | Required within parent | The exchange rate used to convert the local currency to the payroll currency |
gross_value | string | Optional | The gross value of the equity/token grant |
method_of_tax_coverage | string | Required within parent | The 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_currency | string | Required within parent | The currency in which the payroll is processed |
plan_currency | string | Required within parent | The currency in which the equity/token grant was issued |
quantity_exercised_or_released | string | Optional | The quantity of equity/token that was exercised or released |
quantity_remaining | string | Optional | The quantity of equity/token that remains |
quantity_withheld_or_sold | string | Optional | The quantity of equity/token that was withheld or sold |
sale_price | string | Optional | The price at which the equity/token was sold |
settlement_date | string | Required within parent | The date of the settlement Format: date |
tax_jurisdiction | string | Required within parent | The tax jurisdiction in which the equity/token grant was issued |
tax_rate | string | Optional | The tax rate applied to the benefit in kind |
taxable_gain_or_loss | string | Required within parent | The taxable gain or loss |
total_exercise_price | string | Optional | The total exercise price |
total_taxes_withheld | string | Required within parent | The total amount of taxes withheld |
transaction_fees | string | Optional | The fees associated with the transaction |
unit_fmv | string | Optional | The fair market value of the equity/token grant at the time of the event |
withheld_tax_local_currency | string | Required within parent | The tax withheld in the local currency |
List Shareworks equity exercises — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Page 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[] | Model | Each item | Expand List Shareworks equity exercises — 200 response body — data item |
has_more | boolean | Required within parent | Whether another page of results is available. |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Cursor for the next page. Null when has_more is false. |
next_cursor (anyOf 2) | null | Alternative | Cursor 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cost_of_options | JSON | Optional | |
cost_of_options (anyOf 1) | JSON | Alternative | |
cost_of_options (anyOf 1) (anyOf 1) | number | Alternative | Total cost paid to exercise the options. Format: double |
cost_of_options (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
cost_of_options (anyOf 2) | null | Alternative | Total cost paid to exercise the options. Format: double |
currency | string | Optional | ISO 4217 currency code for the monetary fields on this record. |
employee_grant_number | string | Optional | Shareworks grant number for this employee. |
employee_number | string | Optional | Shareworks employee number, as reported by the ingested file. The intended join key for this record. |
exercise_date | string | Optional | Date the exercise took place. Format: date |
exercise_fmv | JSON | Optional | |
exercise_fmv (anyOf 1) | JSON | Alternative | |
exercise_fmv (anyOf 1) (anyOf 1) | number | Alternative | Total fair market value of the exercised shares. Format: double |
exercise_fmv (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
exercise_fmv (anyOf 2) | null | Alternative | Total fair market value of the exercised shares. Format: double |
exercise_gain | JSON | Optional | |
exercise_gain (anyOf 1) | JSON | Alternative | |
exercise_gain (anyOf 1) (anyOf 1) | number | Alternative | Gain realized on exercise (FMV minus cost). Format: double |
exercise_gain (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
exercise_gain (anyOf 2) | null | Alternative | Gain realized on exercise (FMV minus cost). Format: double |
exercise_price | JSON | Optional | |
exercise_price (anyOf 1) | JSON | Alternative | |
exercise_price (anyOf 1) (anyOf 1) | number | Alternative | Strike/exercise price per unit. Format: double |
exercise_price (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
exercise_price (anyOf 2) | null | Alternative | Strike/exercise price per unit. Format: double |
fmv_per_unit | JSON | Optional | |
fmv_per_unit (anyOf 1) | JSON | Alternative | |
fmv_per_unit (anyOf 1) (anyOf 1) | number | Alternative | Fair market value per unit at exercise. Format: double |
fmv_per_unit (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
fmv_per_unit (anyOf 2) | null | Alternative | Fair market value per unit at exercise. Format: double |
grant_date | JSON | Optional | |
grant_date (anyOf 1) | string | Alternative | Date the grant was issued. Format: date |
grant_date (anyOf 2) | null | Alternative | Date the grant was issued. Format: date |
grant_name | JSON | Optional | |
grant_name (anyOf 1) | string | Alternative | Grant name, as reported by the ingested file. |
grant_name (anyOf 2) | null | Alternative | Grant name, as reported by the ingested file. |
grant_type | JSON | Optional | |
grant_type (anyOf 1) | string | Alternative | Grant type (e.g. ISO, NSO, RSU), as reported by the ingested file. |
grant_type (anyOf 2) | null | Alternative | Grant type (e.g. ISO, NSO, RSU), as reported by the ingested file. |
hris_profile_id | JSON | Optional | |
hris_profile_id (anyOf 1) | JSON | Alternative | |
hris_profile_id (anyOf 1) (anyOf 1) | integer | Alternative | Matched HRIS profile id, if employee_number could be resolved to one. Null when unmatched. |
hris_profile_id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
hris_profile_id (anyOf 2) | null | Alternative | Matched HRIS profile id, if employee_number could be resolved to one. Null when unmatched. |
id | string | Optional | The unique identifier of the exercise record. Format: uuid |
plan_name | JSON | Optional | |
plan_name (anyOf 1) | string | Alternative | Equity plan name, as reported by the ingested file. |
plan_name (anyOf 2) | null | Alternative | Equity plan name, as reported by the ingested file. |
shares_exercised_total | JSON | Optional | |
shares_exercised_total (anyOf 1) | JSON | Alternative | |
shares_exercised_total (anyOf 1) (anyOf 1) | number | Alternative | Total number of shares exercised. Format: double |
shares_exercised_total (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
shares_exercised_total (anyOf 2) | null | Alternative | Total number of shares exercised. Format: double |
shares_exercised_unvested | JSON | Optional | |
shares_exercised_unvested (anyOf 1) | JSON | Alternative | |
shares_exercised_unvested (anyOf 1) (anyOf 1) | number | Alternative | Number of unvested shares exercised. Format: double |
shares_exercised_unvested (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
shares_exercised_unvested (anyOf 2) | null | Alternative | Number of unvested shares exercised. Format: double |
shares_exercised_vested | JSON | Optional | |
shares_exercised_vested (anyOf 1) | JSON | Alternative | |
shares_exercised_vested (anyOf 1) (anyOf 1) | number | Alternative | Number of vested shares exercised. Format: double |
shares_exercised_vested (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
shares_exercised_vested (anyOf 2) | null | Alternative | Number of vested shares exercised. Format: double |
updated_at | string | Optional | Timestamp this record was last upserted, for incremental sync. Format: date-time |
List equity awards granted — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Page of granted equity award records, one per reported award row. |
data[] | Model | Each item | Expand List equity awards granted — 200 response body — data item |
has_more | boolean | Required within parent | Whether another page of results is available. |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Cursor for the next page. Null when has_more is false. |
next_cursor (anyOf 2) | null | Alternative | Cursor 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
allow_early_exercise | JSON | Required within parent | |
allow_early_exercise (anyOf 1) | string | Alternative | Whether early exercise is allowed, as reported by the ingested file (verbatim text, e.g. Yes/No). |
allow_early_exercise (anyOf 2) | null | Alternative | Whether early exercise is allowed, as reported by the ingested file (verbatim text, e.g. Yes/No). |
award_name | JSON | Required within parent | |
award_name (anyOf 1) | string | Alternative | Award template name, as reported by the ingested file. |
award_name (anyOf 2) | null | Alternative | Award template name, as reported by the ingested file. |
compensation_benefit | JSON | Required within parent | |
compensation_benefit (anyOf 1) | JSON | Alternative | |
compensation_benefit (anyOf 1) (anyOf 1) | number | Alternative | Compensation benefit amount, as reported by the ingested file. Format: double |
compensation_benefit (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
compensation_benefit (anyOf 2) | null | Alternative | Compensation benefit amount, as reported by the ingested file. Format: double |
created_at | string | Required within parent | Timestamp this record was first ingested. Format: date-time |
employee_number | string | Required within parent | Shareworks 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_type | JSON | Required within parent | |
employee_type (anyOf 1) | string | Alternative | Employee type (e.g. Employee, Consultant), as reported by the ingested file. |
employee_type (anyOf 2) | null | Alternative | Employee type (e.g. Employee, Consultant), as reported by the ingested file. |
federal_exemption | JSON | Required within parent | |
federal_exemption (anyOf 1) | string | Alternative | Federal exemption, as reported by the ingested file. |
federal_exemption (anyOf 2) | null | Alternative | Federal exemption, as reported by the ingested file. |
federal_exemption_date | JSON | Required within parent | |
federal_exemption_date (anyOf 1) | string | Alternative | Federal exemption date, as reported by the ingested file. |
federal_exemption_date (anyOf 2) | null | Alternative | Federal exemption date, as reported by the ingested file. |
first_name | JSON | Required within parent | |
first_name (anyOf 1) | string | Alternative | Employee first name, as reported by the ingested file. |
first_name (anyOf 2) | null | Alternative | Employee first name, as reported by the ingested file. |
fmv_per_share_at_grant_date | JSON | Required within parent | |
fmv_per_share_at_grant_date (anyOf 1) | JSON | Alternative | |
fmv_per_share_at_grant_date (anyOf 1) (anyOf 1) | number | Alternative | Fair 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
fmv_per_share_at_grant_date (anyOf 2) | null | Alternative | Fair market value per share at grant date, as reported by the ingested file. Format: double |
grant_date | string | Required within parent | Date the grant was issued, as reported by the ingested file. Format: date |
grant_name | string | Required within parent | Grant name, as reported by the ingested file. |
grant_price | JSON | Required within parent | |
grant_price (anyOf 1) | JSON | Alternative | |
grant_price (anyOf 1) (anyOf 1) | number | Alternative | Strike/grant price per unit, as reported by the ingested file. Format: double |
grant_price (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
grant_price (anyOf 2) | null | Alternative | Strike/grant price per unit, as reported by the ingested file. Format: double |
grant_quantity | JSON | Required within parent | |
grant_quantity (anyOf 1) | JSON | Alternative | |
grant_quantity (anyOf 1) (anyOf 1) | number | Alternative | Number of shares/units granted, as reported by the ingested file. Format: double |
grant_quantity (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
grant_quantity (anyOf 2) | null | Alternative | Number of shares/units granted, as reported by the ingested file. Format: double |
hris_profile_id | JSON | Required within parent | |
hris_profile_id (anyOf 1) | JSON | Alternative | |
hris_profile_id (anyOf 1) (anyOf 1) | integer | Alternative | Matched 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
hris_profile_id (anyOf 2) | null | Alternative | Matched HRIS profile id, if employee_number could be resolved to one. Null when unmatched, or when employee_number is non-numeric or blank. |
id | string | Required within parent | The unique identifier of the record. Format: uuid |
is_under_rule_701 | JSON | Required within parent | |
is_under_rule_701 (anyOf 1) | string | Alternative | Whether the grant is under Rule 701, as reported by the ingested file (verbatim text, e.g. Yes/No). |
is_under_rule_701 (anyOf 2) | null | Alternative | Whether the grant is under Rule 701, as reported by the ingested file (verbatim text, e.g. Yes/No). |
last_name | JSON | Required within parent | |
last_name (anyOf 1) | string | Alternative | Employee last name, as reported by the ingested file. |
last_name (anyOf 2) | null | Alternative | Employee last name, as reported by the ingested file. |
last_seen_dataset_id | JSON | Required within parent | |
last_seen_dataset_id (anyOf 1) | string | Alternative | Identifier 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) | null | Alternative | Identifier of the most recent ingested dataset in which this record still appeared. Null for records ingested before dataset tracking began. Format: uuid |
occurrence_index | JSON | Required within parent | |
occurrence_index (anyOf 1) | integer | Alternative | Discriminates 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
plan_name | JSON | Required within parent | |
plan_name (anyOf 1) | string | Alternative | Equity plan name, as reported by the ingested file. |
plan_name (anyOf 2) | null | Alternative | Equity plan name, as reported by the ingested file. |
row_hash | string | Required within parent | Hash of the reported values on this record. Compare it between syncs to detect a change without diffing every field. |
source_file_id | string | Required within parent | Identifier of the ingested Shareworks report file this record was last upserted from. Format: uuid |
state_exemption | JSON | Required within parent | |
state_exemption (anyOf 1) | string | Alternative | State exemption, as reported by the ingested file. |
state_exemption (anyOf 2) | null | Alternative | State exemption, as reported by the ingested file. |
state_exemption_date | JSON | Required within parent | |
state_exemption_date (anyOf 1) | string | Alternative | State exemption date, as reported by the ingested file. |
state_exemption_date (anyOf 2) | null | Alternative | State exemption date, as reported by the ingested file. |
state_of_exemption | JSON | Required within parent | |
state_of_exemption (anyOf 1) | string | Alternative | State of exemption, as reported by the ingested file. |
state_of_exemption (anyOf 2) | null | Alternative | State of exemption, as reported by the ingested file. |
total_exercise_price | JSON | Required within parent | |
total_exercise_price (anyOf 1) | JSON | Alternative | |
total_exercise_price (anyOf 1) (anyOf 1) | number | Alternative | Total exercise price for the grant, as reported by the ingested file. Format: double |
total_exercise_price (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_exercise_price (anyOf 2) | null | Alternative | Total exercise price for the grant, as reported by the ingested file. Format: double |
total_fmv | JSON | Required within parent | |
total_fmv (anyOf 1) | JSON | Alternative | |
total_fmv (anyOf 1) (anyOf 1) | number | Alternative | Total fair market value of the grant, as reported by the ingested file. Format: double |
total_fmv (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_fmv (anyOf 2) | null | Alternative | Total fair market value of the grant, as reported by the ingested file. Format: double |
updated_at | string | Required within parent | Timestamp this record was last upserted, for incremental sync. Format: date-time |
vest_schedule_name | JSON | Required within parent | |
vest_schedule_name (anyOf 1) | string | Alternative | Vesting schedule name, as reported by the ingested file. |
vest_schedule_name (anyOf 2) | null | Alternative | Vesting schedule name, as reported by the ingested file. |
vesting_start_date | JSON | Required within parent | |
vesting_start_date (anyOf 1) | string | Alternative | Vesting start date, as reported by the ingested file. Format: date |
vesting_start_date (anyOf 2) | null | Alternative | Vesting start date, as reported by the ingested file. Format: date |
List equity grant expense amortization records — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Page of expense amortization records, one per grant occurrence. |
data[] | Model | Each item | Expand List equity grant expense amortization records — 200 response body — data item |
has_more | boolean | Required within parent | Whether another page of results is available. |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Cursor for the next page. Null when has_more is false. |
next_cursor (anyOf 2) | null | Alternative | Cursor 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
actual_performance_factor | JSON | Required within parent | |
actual_performance_factor (anyOf 1) | JSON | Alternative | |
actual_performance_factor (anyOf 1) (anyOf 1) | number | Alternative | Actual 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
actual_performance_factor (anyOf 2) | null | Alternative | Actual performance factor applied, as reported by the ingested file. Sparsely populated (measured: 5 of 11,863 real rows). Format: double |
award_type | string | Required within parent | Award type (e.g. Restricted Stock - Standard), as reported by the ingested file. |
before_period_total_expense_accrued | JSON | Required within parent | |
before_period_total_expense_accrued (anyOf 1) | JSON | Alternative | |
before_period_total_expense_accrued (anyOf 1) (anyOf 1) | number | Alternative | Before Period > Total Expense Accrued, as reported by the ingested file. Format: double |
before_period_total_expense_accrued (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
before_period_total_expense_accrued (anyOf 2) | null | Alternative | Before Period > Total Expense Accrued, as reported by the ingested file. Format: double |
before_period_total_shares_accrued | JSON | Required within parent | |
before_period_total_shares_accrued (anyOf 1) | JSON | Alternative | |
before_period_total_shares_accrued (anyOf 1) (anyOf 1) | number | Alternative | Before Period > Total Shares Accrued, as reported by the ingested file. Format: double |
before_period_total_shares_accrued (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
before_period_total_shares_accrued (anyOf 2) | null | Alternative | Before Period > Total Shares Accrued, as reported by the ingested file. Format: double |
before_period_unamortized_expense | JSON | Required within parent | |
before_period_unamortized_expense (anyOf 1) | JSON | Alternative | |
before_period_unamortized_expense (anyOf 1) (anyOf 1) | number | Alternative | Before Period > Unamortized Expense, as reported by the ingested file. Format: double |
before_period_unamortized_expense (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
before_period_unamortized_expense (anyOf 2) | null | Alternative | Before Period > Unamortized Expense, as reported by the ingested file. Format: double |
before_period_unamortized_shares | JSON | Required within parent | |
before_period_unamortized_shares (anyOf 1) | JSON | Alternative | |
before_period_unamortized_shares (anyOf 1) (anyOf 1) | number | Alternative | Before Period > Unamortized Shares, as reported by the ingested file. Format: double |
before_period_unamortized_shares (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
before_period_unamortized_shares (anyOf 2) | null | Alternative | Before Period > Unamortized Shares, as reported by the ingested file. Format: double |
created_at | string | Required within parent | Timestamp this record was first ingested. Format: date-time |
employee_grant_number | string | Required within parent | Shareworks grant number for this employee, as reported by the ingested file. |
employee_number | string | Required within parent | Shareworks 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_factor | JSON | Required within parent | |
estimated_performance_factor (anyOf 1) | JSON | Alternative | |
estimated_performance_factor (anyOf 1) (anyOf 1) | number | Alternative | Estimated performance factor, as reported by the ingested file. Format: double |
estimated_performance_factor (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
estimated_performance_factor (anyOf 2) | null | Alternative | Estimated performance factor, as reported by the ingested file. Format: double |
fair_value_per_share | JSON | Required within parent | |
fair_value_per_share (anyOf 1) | JSON | Alternative | |
fair_value_per_share (anyOf 1) (anyOf 1) | number | Alternative | Fair market value per share, as reported by the ingested file. Format: double |
fair_value_per_share (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
fair_value_per_share (anyOf 2) | null | Alternative | Fair market value per share, as reported by the ingested file. Format: double |
grant_date | string | Required within parent | Date the grant was issued, as reported by the ingested file. Format: date |
grant_name | string | Required within parent | Grant name, as reported by the ingested file. |
grant_price | JSON | Required within parent | |
grant_price (anyOf 1) | JSON | Alternative | |
grant_price (anyOf 1) (anyOf 1) | number | Alternative | Strike/grant price per unit, as reported by the ingested file. Format: double |
grant_price (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
grant_price (anyOf 2) | null | Alternative | Strike/grant price per unit, as reported by the ingested file. Format: double |
hris_profile_id | JSON | Required within parent | |
hris_profile_id (anyOf 1) | JSON | Alternative | |
hris_profile_id (anyOf 1) (anyOf 1) | integer | Alternative | Matched 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
hris_profile_id (anyOf 2) | null | Alternative | Matched HRIS profile id, if employee_number could be resolved to one. Null when unmatched, or when employee_number is non-numeric or blank. |
id | string | Required within parent | The unique identifier of the record. Format: uuid |
last_seen_dataset_id | JSON | Required within parent | |
last_seen_dataset_id (anyOf 1) | string | Alternative | Identifier 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) | null | Alternative | Identifier of the most recent ingested dataset in which this record still appeared. Null for records ingested before dataset tracking began. Format: uuid |
occurrence_index | JSON | Required within parent | |
occurrence_index (anyOf 1) | integer | Alternative | Discriminates 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
period_end_life_to_date_total_expense_accrued | JSON | Required within parent | |
period_end_life_to_date_total_expense_accrued (anyOf 1) | JSON | Alternative | |
period_end_life_to_date_total_expense_accrued (anyOf 1) (anyOf 1) | number | Alternative | Period 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
period_end_life_to_date_total_expense_accrued (anyOf 2) | null | Alternative | Period End > Life-to-Date Total Expense Accrued, as reported by the ingested file. Format: double |
period_end_life_to_date_total_shares_accrued | JSON | Required within parent | |
period_end_life_to_date_total_shares_accrued (anyOf 1) | JSON | Alternative | |
period_end_life_to_date_total_shares_accrued (anyOf 1) (anyOf 1) | number | Alternative | Period 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
period_end_life_to_date_total_shares_accrued (anyOf 2) | null | Alternative | Period End > Life-to-Date Total Shares Accrued, as reported by the ingested file. Format: double |
period_end_unamortized_expense | JSON | Required within parent | |
period_end_unamortized_expense (anyOf 1) | JSON | Alternative | |
period_end_unamortized_expense (anyOf 1) (anyOf 1) | number | Alternative | Period End > Unamortized Expense, as reported by the ingested file. Format: double |
period_end_unamortized_expense (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
period_end_unamortized_expense (anyOf 2) | null | Alternative | Period End > Unamortized Expense, as reported by the ingested file. Format: double |
period_end_unamortized_shares | JSON | Required within parent | |
period_end_unamortized_shares (anyOf 1) | JSON | Alternative | |
period_end_unamortized_shares (anyOf 1) (anyOf 1) | number | Alternative | Period End > Unamortized Shares, as reported by the ingested file. Format: double |
period_end_unamortized_shares (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
period_end_unamortized_shares (anyOf 2) | null | Alternative | Period End > Unamortized Shares, as reported by the ingested file. Format: double |
period_end_weighted_avg_remaining_recognition_period | JSON | Required within parent | |
period_end_weighted_avg_remaining_recognition_period (anyOf 1) | JSON | Alternative | |
period_end_weighted_avg_remaining_recognition_period (anyOf 1) (anyOf 1) | number | Alternative | Period 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
period_end_weighted_avg_remaining_recognition_period (anyOf 2) | null | Alternative | Period End > Weighted Average Remaining Recognition Period, as reported by the ingested file. Format: double |
plan_name | string | Required within parent | Equity plan name, as reported by the ingested file. |
row_hash | string | Required within parent | Hash of the reported values on this record. Compare it between syncs to detect a change without diffing every field. |
source_file_id | string | Required within parent | Identifier of the ingested Shareworks report file this record was last upserted from. Format: uuid |
total_estimated_expense | JSON | Required within parent | |
total_estimated_expense (anyOf 1) | JSON | Alternative | |
total_estimated_expense (anyOf 1) (anyOf 1) | number | Alternative | Total estimated expense, as reported by the ingested file. Format: double |
total_estimated_expense (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_estimated_expense (anyOf 2) | null | Alternative | Total estimated expense, as reported by the ingested file. Format: double |
total_estimated_shares_to_expense | JSON | Required within parent | |
total_estimated_shares_to_expense (anyOf 1) | JSON | Alternative | |
total_estimated_shares_to_expense (anyOf 1) (anyOf 1) | number | Alternative | Total estimated shares to expense, as reported by the ingested file. Format: double |
total_estimated_shares_to_expense (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_estimated_shares_to_expense (anyOf 2) | null | Alternative | Total estimated shares to expense, as reported by the ingested file. Format: double |
updated_at | string | Required within parent | Timestamp this record was last upserted, for incremental sync. Format: date-time |
valuation_status | JSON | Required within parent | |
valuation_status (anyOf 1) | string | Alternative | Valuation status (e.g. Approved, Do Not Expense), as reported by the ingested file. |
valuation_status (anyOf 2) | null | Alternative | Valuation status (e.g. Approved, Do Not Expense), as reported by the ingested file. |
within_period_agg_grant_price_of_shares_early_exercised_vested | JSON | Required within parent | |
within_period_agg_grant_price_of_shares_early_exercised_vested (anyOf 1) | JSON | Alternative | |
within_period_agg_grant_price_of_shares_early_exercised_vested (anyOf 1) (anyOf 1) | number | Alternative | Within 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
within_period_agg_grant_price_of_shares_early_exercised_vested (anyOf 2) | null | Alternative | Within 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_period | JSON | Required within parent | |
within_period_agg_grant_price_of_shares_exercised_in_period (anyOf 1) | JSON | Alternative | |
within_period_agg_grant_price_of_shares_exercised_in_period (anyOf 1) (anyOf 1) | number | Alternative | Within 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
within_period_agg_grant_price_of_shares_exercised_in_period (anyOf 2) | null | Alternative | Within 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_vested | JSON | Required within parent | |
within_period_expense_fv_of_shares_early_exercised_vested (anyOf 1) | JSON | Alternative | |
within_period_expense_fv_of_shares_early_exercised_vested (anyOf 1) (anyOf 1) | number | Alternative | Within 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
within_period_expense_fv_of_shares_early_exercised_vested (anyOf 2) | null | Alternative | Within 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_released | JSON | Required within parent | |
within_period_expense_fv_of_shares_exercised_released (anyOf 1) | JSON | Alternative | |
within_period_expense_fv_of_shares_exercised_released (anyOf 1) (anyOf 1) | number | Alternative | Within 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
within_period_expense_fv_of_shares_exercised_released (anyOf 2) | null | Alternative | Within Period > Expense (Fair Value) of Shares Exercised / Released, as reported by the ingested file. Format: double |
within_period_expense_fv_of_shares_vesting | JSON | Required within parent | |
within_period_expense_fv_of_shares_vesting (anyOf 1) | JSON | Alternative | |
within_period_expense_fv_of_shares_vesting (anyOf 1) (anyOf 1) | number | Alternative | Within 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
within_period_expense_fv_of_shares_vesting (anyOf 2) | null | Alternative | Within Period > Expense (Fair Value) of Shares Vesting, as reported by the ingested file. Format: double |
within_period_shares_early_exercised_vested | JSON | Required within parent | |
within_period_shares_early_exercised_vested (anyOf 1) | JSON | Alternative | |
within_period_shares_early_exercised_vested (anyOf 1) (anyOf 1) | number | Alternative | Within 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
within_period_shares_early_exercised_vested (anyOf 2) | null | Alternative | Within 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_released | JSON | Required within parent | |
within_period_shares_exercised_released (anyOf 1) | JSON | Alternative | |
within_period_shares_exercised_released (anyOf 1) (anyOf 1) | number | Alternative | Within Period > Shares Exercised / Released, as reported by the ingested file. Format: double |
within_period_shares_exercised_released (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
within_period_shares_exercised_released (anyOf 2) | null | Alternative | Within Period > Shares Exercised / Released, as reported by the ingested file. Format: double |
within_period_shares_vesting | JSON | Required within parent | |
within_period_shares_vesting (anyOf 1) | JSON | Alternative | |
within_period_shares_vesting (anyOf 1) (anyOf 1) | number | Alternative | Within Period > Shares Vesting, as reported by the ingested file. Format: double |
within_period_shares_vesting (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
within_period_shares_vesting (anyOf 2) | null | Alternative | Within Period > Shares Vesting, as reported by the ingested file. Format: double |
within_period_total_expense_accrued | JSON | Required within parent | |
within_period_total_expense_accrued (anyOf 1) | JSON | Alternative | |
within_period_total_expense_accrued (anyOf 1) (anyOf 1) | number | Alternative | Within Period > Total Expense Accrued, as reported by the ingested file. Format: double |
within_period_total_expense_accrued (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
within_period_total_expense_accrued (anyOf 2) | null | Alternative | Within Period > Total Expense Accrued, as reported by the ingested file. Format: double |
within_period_total_shares_accrued | JSON | Required within parent | |
within_period_total_shares_accrued (anyOf 1) | JSON | Alternative | |
within_period_total_shares_accrued (anyOf 1) (anyOf 1) | number | Alternative | Within Period > Total Shares Accrued, as reported by the ingested file. Format: double |
within_period_total_shares_accrued (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
within_period_total_shares_accrued (anyOf 2) | null | Alternative | Within Period > Total Shares Accrued, as reported by the ingested file. Format: double |
List equity grant total expense records — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Page of total expense records, one per grant occurrence. |
data[] | Model | Each item | Expand List equity grant total expense records — 200 response body — data item |
has_more | boolean | Required within parent | Whether another page of results is available. |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Cursor for the next page. Null when has_more is false. |
next_cursor (anyOf 2) | null | Alternative | Cursor 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
actual_forfeitures | JSON | Required within parent | |
actual_forfeitures (anyOf 1) | number | Alternative | Actual forfeited share count, as reported by the ingested file. Format: double |
actual_forfeitures (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
actual_performance_factor | JSON | Required within parent | |
actual_performance_factor (anyOf 1) | JSON | Alternative | |
actual_performance_factor (anyOf 1) (anyOf 1) | number | Alternative | Actual performance factor applied, as reported by the ingested file. Format: double |
actual_performance_factor (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
actual_performance_factor (anyOf 2) | null | Alternative | Actual performance factor applied, as reported by the ingested file. Format: double |
award_type | string | Required within parent | Award type (e.g. Restricted Stock - Standard), as reported by the ingested file. |
base_expense | JSON | Required within parent | |
base_expense (anyOf 1) | JSON | Alternative | |
base_expense (anyOf 1) (anyOf 1) | number | Alternative | Base expense amount, as reported by the ingested file. Format: double |
base_expense (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
base_expense (anyOf 2) | null | Alternative | Base expense amount, as reported by the ingested file. Format: double |
base_shares | JSON | Required within parent | |
base_shares (anyOf 1) | number | Alternative | Base share count for this grant, as reported by the ingested file. Format: double |
base_shares (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
created_at | string | Required within parent | Timestamp this record was first ingested. Format: date-time |
employee_grant_number | string | Required within parent | Shareworks grant number for this employee, as reported by the ingested file. |
employee_number | string | Required within parent | Shareworks 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_forfeitures | JSON | Required within parent | |
estimated_forfeitures (anyOf 1) | JSON | Alternative | |
estimated_forfeitures (anyOf 1) (anyOf 1) | number | Alternative | Estimated forfeited share count, as reported by the ingested file. Format: double |
estimated_forfeitures (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
estimated_forfeitures (anyOf 2) | null | Alternative | Estimated forfeited share count, as reported by the ingested file. Format: double |
estimated_performance_factor | JSON | Required within parent | |
estimated_performance_factor (anyOf 1) | JSON | Alternative | |
estimated_performance_factor (anyOf 1) (anyOf 1) | number | Alternative | Estimated performance factor, as reported by the ingested file. Format: double |
estimated_performance_factor (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
estimated_performance_factor (anyOf 2) | null | Alternative | Estimated performance factor, as reported by the ingested file. Format: double |
factor_shares | JSON | Required within parent | |
factor_shares (anyOf 1) | JSON | Alternative | |
factor_shares (anyOf 1) (anyOf 1) | number | Alternative | Shares resulting from the performance factor, as reported by the ingested file. Format: double |
factor_shares (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
factor_shares (anyOf 2) | null | Alternative | Shares resulting from the performance factor, as reported by the ingested file. Format: double |
fair_value_per_share | JSON | Required within parent | |
fair_value_per_share (anyOf 1) | JSON | Alternative | |
fair_value_per_share (anyOf 1) (anyOf 1) | number | Alternative | Fair market value per share, as reported by the ingested file. Format: double |
fair_value_per_share (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
fair_value_per_share (anyOf 2) | null | Alternative | Fair market value per share, as reported by the ingested file. Format: double |
forfeiture_rate_percent | JSON | Required within parent | |
forfeiture_rate_percent (anyOf 1) | JSON | Alternative | |
forfeiture_rate_percent (anyOf 1) (anyOf 1) | number | Alternative | Forfeiture 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
forfeiture_rate_percent (anyOf 2) | null | Alternative | Forfeiture rate, stored as the percent NUMBER itself (e.g. 44.336788 means 44.336788%), NOT a fraction. See parseShareworksPercent. Format: double |
grant_date | string | Required within parent | Date the grant was issued, as reported by the ingested file. Format: date |
grant_name | string | Required within parent | Grant name, as reported by the ingested file. |
grant_price | JSON | Required within parent | |
grant_price (anyOf 1) | JSON | Alternative | |
grant_price (anyOf 1) (anyOf 1) | number | Alternative | Strike/grant price per unit, as reported by the ingested file. Format: double |
grant_price (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
grant_price (anyOf 2) | null | Alternative | Strike/grant price per unit, as reported by the ingested file. Format: double |
hris_profile_id | JSON | Required within parent | |
hris_profile_id (anyOf 1) | JSON | Alternative | |
hris_profile_id (anyOf 1) (anyOf 1) | integer | Alternative | Matched 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
hris_profile_id (anyOf 2) | null | Alternative | Matched HRIS profile id, if employee_number could be resolved to one. Null when unmatched, or when employee_number is non-numeric or blank. |
id | string | Required within parent | The unique identifier of the record. Format: uuid |
last_seen_dataset_id | JSON | Required within parent | |
last_seen_dataset_id (anyOf 1) | string | Alternative | Identifier 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) | null | Alternative | Identifier of the most recent ingested dataset in which this record still appeared. Null for records ingested before dataset tracking began. Format: uuid |
occurrence_index | JSON | Required within parent | |
occurrence_index (anyOf 1) | integer | Alternative | Discriminates 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
plan_name | string | Required within parent | Equity plan name, as reported by the ingested file. |
row_hash | string | Required within parent | Hash of the reported values on this record. Compare it between syncs to detect a change without diffing every field. |
source_file_id | string | Required within parent | Identifier of the ingested Shareworks report file this record was last upserted from. Format: uuid |
total_actual_expense_to_accrue | JSON | Required within parent | |
total_actual_expense_to_accrue (anyOf 1) | JSON | Alternative | |
total_actual_expense_to_accrue (anyOf 1) (anyOf 1) | number | Alternative | Total actual expense to accrue, as reported by the ingested file. Format: double |
total_actual_expense_to_accrue (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_actual_expense_to_accrue (anyOf 2) | null | Alternative | Total actual expense to accrue, as reported by the ingested file. Format: double |
total_actual_shares_to_expense | JSON | Required within parent | |
total_actual_shares_to_expense (anyOf 1) | number | Alternative | Total actual shares to expense, as reported by the ingested file. Format: double |
total_actual_shares_to_expense (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_estimated_expense | JSON | Required within parent | |
total_estimated_expense (anyOf 1) | JSON | Alternative | |
total_estimated_expense (anyOf 1) (anyOf 1) | number | Alternative | Total estimated expense, as reported by the ingested file. Format: double |
total_estimated_expense (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_estimated_expense (anyOf 2) | null | Alternative | Total estimated expense, as reported by the ingested file. Format: double |
total_estimated_shares_to_expense | JSON | Required within parent | |
total_estimated_shares_to_expense (anyOf 1) | JSON | Alternative | |
total_estimated_shares_to_expense (anyOf 1) (anyOf 1) | number | Alternative | Total estimated shares to expense, as reported by the ingested file. Format: double |
total_estimated_shares_to_expense (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_estimated_shares_to_expense (anyOf 2) | null | Alternative | Total estimated shares to expense, as reported by the ingested file. Format: double |
unvested_repurchased | JSON | Required within parent | |
unvested_repurchased (anyOf 1) | JSON | Alternative | |
unvested_repurchased (anyOf 1) (anyOf 1) | number | Alternative | Unvested shares repurchased, as reported by the ingested file. Format: double |
unvested_repurchased (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
unvested_repurchased (anyOf 2) | null | Alternative | Unvested shares repurchased, as reported by the ingested file. Format: double |
updated_at | string | Required within parent | Timestamp this record was last upserted, for incremental sync. Format: date-time |
valuation_status | JSON | Required within parent | |
valuation_status (anyOf 1) | string | Alternative | Valuation status (e.g. Approved, Do Not Expense), as reported by the ingested file. |
valuation_status (anyOf 2) | null | Alternative | Valuation status (e.g. Approved, Do Not Expense), as reported by the ingested file. |
List equity grant valuations — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Page of grant valuation records, one per grant occurrence. |
data[] | Model | Each item | Expand List equity grant valuations — 200 response body — data item |
has_more | boolean | Required within parent | Whether another page of results is available. |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Cursor for the next page. Null when has_more is false. |
next_cursor (anyOf 2) | null | Alternative | Cursor 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amortization_method | string | Required within parent | Amortization method (e.g. Straight-Line), as reported by the ingested file. |
award_type | string | Required within parent | Award type (e.g. Restricted Stock - Standard), as reported by the ingested file. |
created_at | string | Required within parent | Timestamp this record was first ingested. Format: date-time |
dividend_yield_percent | JSON | Required within parent | |
dividend_yield_percent (anyOf 1) | JSON | Alternative | |
dividend_yield_percent (anyOf 1) (anyOf 1) | number | Alternative | Dividend 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
dividend_yield_percent (anyOf 2) | null | Alternative | Dividend 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_type | JSON | Required within parent | |
dividend_yield_type (anyOf 1) | string | Alternative | Dividend yield type, as reported by the ingested file. Sparsely populated (measured: 14,353 of 15,090 real rows). |
dividend_yield_type (anyOf 2) | null | Alternative | Dividend yield type, as reported by the ingested file. Sparsely populated (measured: 14,353 of 15,090 real rows). |
employee_grant_number | string | Required within parent | Shareworks grant number for this employee, as reported by the ingested file. |
expected_life | JSON | Required within parent | |
expected_life (anyOf 1) | JSON | Alternative | |
expected_life (anyOf 1) (anyOf 1) | number | Alternative | Expected 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
expected_life (anyOf 2) | null | Alternative | Expected 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_type | JSON | Required within parent | |
expected_life_type (anyOf 1) | string | Alternative | Expected life type, as reported by the ingested file. Sparsely populated (measured: 14,353 of 15,090 real rows). |
expected_life_type (anyOf 2) | null | Alternative | Expected life type, as reported by the ingested file. Sparsely populated (measured: 14,353 of 15,090 real rows). |
expense_amortization_start_date | string | Required within parent | Expense amortization start date, as reported by the ingested file. Format: date |
expense_valuation_model | string | Required within parent | Expense valuation model (e.g. Black-Scholes), as reported by the ingested file. |
fair_value_per_share | JSON | Required within parent | |
fair_value_per_share (anyOf 1) | number | Alternative | Fair market value per share, as reported by the ingested file. Format: double |
fair_value_per_share (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
forfeiture_rate_calculation_method | string | Required within parent | Forfeiture rate calculation method, as reported by the ingested file. |
forfeiture_rate_percent | JSON | Required within parent | |
forfeiture_rate_percent (anyOf 1) | number | Alternative | Forfeiture 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
grant_date | string | Required within parent | Date the grant was issued, as reported by the ingested file. Format: date |
grant_name | string | Required within parent | Grant name, as reported by the ingested file. |
grant_price | JSON | Required within parent | |
grant_price (anyOf 1) | number | Alternative | Strike/grant price per unit, as reported by the ingested file. Format: double |
grant_price (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id | string | Required within parent | The unique identifier of the record. Format: uuid |
last_seen_dataset_id | JSON | Required within parent | |
last_seen_dataset_id (anyOf 1) | string | Alternative | Identifier 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) | null | Alternative | Identifier of the most recent ingested dataset in which this record still appeared. Null for records ingested before dataset tracking began. Format: uuid |
market_price | JSON | Required within parent | |
market_price (anyOf 1) | number | Alternative | Market price per unit, as reported by the ingested file. Format: double |
market_price (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
occurrence_index | JSON | Required within parent | |
occurrence_index (anyOf 1) | integer | Alternative | Discriminates 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
original_granted | JSON | Required within parent | |
original_granted (anyOf 1) | number | Alternative | Original granted share count, as reported by the ingested file. Format: double |
original_granted (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
original_performance_rule | JSON | Required within parent | |
original_performance_rule (anyOf 1) | string | Alternative | Original performance rule, as reported by the ingested file. Sparsely populated (measured: 25 of 15,090 real rows). |
original_performance_rule (anyOf 2) | null | Alternative | Original performance rule, as reported by the ingested file. Sparsely populated (measured: 25 of 15,090 real rows). |
original_vest_date | JSON | Required within parent | |
original_vest_date (anyOf 1) | string | Alternative | Original 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) | null | Alternative | Original 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_name | string | Required within parent | Equity plan name, as reported by the ingested file. |
risk_free_rate_percent | JSON | Required within parent | |
risk_free_rate_percent (anyOf 1) | JSON | Alternative | |
risk_free_rate_percent (anyOf 1) (anyOf 1) | number | Alternative | Risk-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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
risk_free_rate_percent (anyOf 2) | null | Alternative | Risk-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_source | JSON | Required within parent | |
risk_free_rate_source (anyOf 1) | string | Alternative | Risk-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) | null | Alternative | Risk-free rate source, as reported by the ingested file. Sparsely populated (measured: 8,308 of 15,090 real rows). |
risk_free_rate_type | JSON | Required within parent | |
risk_free_rate_type (anyOf 1) | string | Alternative | Risk-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) | null | Alternative | Risk-free rate type, as reported by the ingested file. Sparsely populated (measured: 14,353 of 15,090 real rows). |
row_hash | string | Required within parent | Hash of the reported values on this record. Compare it between syncs to detect a change without diffing every field. |
source_file_id | string | Required within parent | Identifier of the ingested Shareworks report file this record was last upserted from. Format: uuid |
updated_at | string | Required within parent | Timestamp this record was last upserted, for incremental sync. Format: date-time |
valuation_type | string | Required within parent | Valuation type, as reported by the ingested file. |
volatility_percent | JSON | Required within parent | |
volatility_percent (anyOf 1) | JSON | Alternative | |
volatility_percent (anyOf 1) (anyOf 1) | number | Alternative | Volatility, 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
volatility_percent (anyOf 2) | null | Alternative | Volatility, stored as the percent NUMBER itself, NOT a fraction. See parseShareworksPercent. Sparsely populated (measured: 14,353 of 15,090 real rows). Format: double |
volatility_type | JSON | Required within parent | |
volatility_type (anyOf 1) | string | Alternative | Volatility type, as reported by the ingested file. Sparsely populated (measured: 14,353 of 15,090 real rows). |
volatility_type (anyOf 2) | null | Alternative | Volatility 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Optional | |
data[] | Model | Each item | Expand List equity grants with tax events — 200 response body — data item |
limit | JSON | Optional | |
limit (anyOf 1) | integer | Alternative | The limit applied to this page of results |
limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
offset | JSON | Optional | |
offset (anyOf 1) | integer | Alternative | The offset applied to this page of results |
offset (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total | JSON | Optional | |
total (anyOf 1) | integer | Alternative | The total number of grants matching the query, independent of limit/offset |
total (anyOf 2) | string | Alternative | Pattern: ^-?[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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
additional_grant_requirements_and_restrictions | JSON | Optional | |
additional_grant_requirements_and_restrictions (anyOf 1) | string | Alternative | Free-text additional requirements or restrictions on the grant |
additional_grant_requirements_and_restrictions (anyOf 2) | null | Alternative | Free-text additional requirements or restrictions on the grant |
cliff_period | JSON | Optional | |
cliff_period (anyOf 1) | JSON | Alternative | |
cliff_period (anyOf 1) (anyOf 1) | number | Alternative | The cliff period in months before any shares vest Format: double |
cliff_period (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
cliff_period (anyOf 2) | null | Alternative | The cliff period in months before any shares vest Format: double |
equity_grant_type | JSON | Optional | |
equity_grant_type (anyOf 1) | string | Alternative | The type of equity instrument granted |
equity_grant_type (anyOf 2) | null | Alternative | The type of equity instrument granted |
equity_grant_type_name | JSON | Optional | |
equity_grant_type_name (anyOf 1) | string | Alternative | The organization's custom label for the grant type |
equity_grant_type_name (anyOf 2) | null | Alternative | The organization's custom label for the grant type |
exercise_price | JSON | Optional | |
exercise_price (anyOf 1) | JSON | Alternative | |
exercise_price (anyOf 1) (anyOf 1) | number | Alternative | The per-unit price at which the option or warrant can be exercised, in exercise price currency Format: double |
exercise_price (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
exercise_price (anyOf 2) | null | Alternative | The per-unit price at which the option or warrant can be exercised, in exercise price currency Format: double |
exercise_price_currency | JSON | Optional | |
exercise_price_currency (anyOf 1) | string | Alternative | The currency of the exercise price |
exercise_price_currency (anyOf 2) | null | Alternative | The currency of the exercise price |
fmv_when_granted | JSON | Optional | |
fmv_when_granted (anyOf 1) | JSON | Alternative | |
fmv_when_granted (anyOf 1) (anyOf 1) | number | Alternative | The fair market value of the underlying instrument at grant time Format: double |
fmv_when_granted (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
fmv_when_granted (anyOf 2) | null | Alternative | The fair market value of the underlying instrument at grant time Format: double |
grant_currency | JSON | Optional | |
grant_currency (anyOf 1) | string | Alternative | The currency of the grant value |
grant_currency (anyOf 2) | null | Alternative | The currency of the grant value |
grant_date | JSON | Optional | |
grant_date (anyOf 1) | string | Alternative | The date the grant was issued Format: date |
grant_date (anyOf 2) | null | Alternative | The date the grant was issued Format: date |
grant_name | JSON | Optional | |
grant_name (anyOf 1) | string | Alternative | The name of the grant |
grant_name (anyOf 2) | null | Alternative | The name of the grant |
grant_status | JSON | Optional | |
grant_status (anyOf 1) | string | Alternative | The lifecycle status of the grant (e.g. GRANTED, PENDING_APPROVAL) |
grant_status (anyOf 2) | null | Alternative | The lifecycle status of the grant (e.g. GRANTED, PENDING_APPROVAL) |
hris_profile | Model | Optional | Expand List equity grants with tax events — 200 response body — data item hris profile Profile information for the EOR worker who holds the grant |
id | string | Optional | The unique identifier of the equity grant Format: uuid |
option_expiration | JSON | Optional | |
option_expiration (anyOf 1) | string | Alternative | The date the option expires Format: date |
option_expiration (anyOf 2) | null | Alternative | The date the option expires Format: date |
quantity | JSON | Optional | |
quantity (anyOf 1) | JSON | Alternative | |
quantity (anyOf 1) (anyOf 1) | number | Alternative | The total quantity granted Format: double |
quantity (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
quantity (anyOf 2) | null | Alternative | The total quantity granted Format: double |
reference_id | JSON | Optional | |
reference_id (anyOf 1) | JSON | Alternative | |
reference_id (anyOf 1) (anyOf 1) | number | Alternative | The human-readable reference number of the grant Format: double |
reference_id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
reference_id (anyOf 2) | null | Alternative | The human-readable reference number of the grant Format: double |
source | JSON | Optional | |
source (anyOf 1) | string | Alternative | The system of record the grant originated from |
source (anyOf 2) | null | Alternative | The system of record the grant originated from |
tax_events | array | Optional | The tax events reported against this grant |
tax_events[] | Model | Each item | Expand List equity grants with tax events — 200 response body — data item tax events item |
tranches | JSON | Optional | |
tranches (anyOf 1) | JSON | Alternative | |
tranches (anyOf 1) (anyOf 1) | number | Alternative | The number of vesting tranches Format: double |
tranches (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
tranches (anyOf 2) | null | Alternative | The number of vesting tranches Format: double |
value | JSON | Optional | |
value (anyOf 1) | JSON | Alternative | |
value (anyOf 1) (anyOf 1) | number | Alternative | The total grant value at the time of issuance, in grant currency Format: double |
value (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
value (anyOf 2) | null | Alternative | The total grant value at the time of issuance, in grant currency Format: double |
vested_events | array | Optional | The individual vesting events recorded for this grant |
vested_events[] | Model | Each item | Expand List equity grants with tax events — 200 response body — data item vested events item |
vested_quantity | JSON | Optional | |
vested_quantity (anyOf 1) | JSON | Alternative | |
vested_quantity (anyOf 1) (anyOf 1) | number | Alternative | The quantity vested so far Format: double |
vested_quantity (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
vested_quantity (anyOf 2) | null | Alternative | The quantity vested so far Format: double |
vesting_length | JSON | Optional | |
vesting_length (anyOf 1) | JSON | Alternative | |
vesting_length (anyOf 1) (anyOf 1) | number | Alternative | The total vesting length in months Format: double |
vesting_length (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
vesting_length (anyOf 2) | null | Alternative | The total vesting length in months Format: double |
vesting_start_date | JSON | Optional | |
vesting_start_date (anyOf 1) | string | Alternative | The date vesting begins Format: date |
vesting_start_date (anyOf 2) | null | Alternative | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Profile information for the EOR worker who holds the grant |
email | string | Optional | The worker's email address Format: email |
first_name | JSON | Optional | |
first_name (anyOf 1) | string | Alternative | The worker's first name |
first_name (anyOf 2) | null | Alternative | The worker's first name |
hiring_type | JSON | Optional | |
hiring_type (anyOf 1) | string | Alternative | The worker's engagement type within Deel (e.g. employee, contractor) |
hiring_type (anyOf 2) | null | Alternative | The worker's engagement type within Deel (e.g. employee, contractor) |
id | string | Optional | The unique identifier of the worker Format: uuid |
job_title | JSON | Optional | |
job_title (anyOf 1) | string | Alternative | The worker's job title |
job_title (anyOf 2) | null | Alternative | The worker's job title |
last_name | JSON | Optional | |
last_name (anyOf 1) | string | Alternative | The worker's last name |
last_name (anyOf 2) | null | Alternative | The worker's last name |
middle_name | JSON | Optional | |
middle_name (anyOf 1) | string | Alternative | The worker's middle name |
middle_name (anyOf 2) | null | Alternative | The worker's middle name |
pic_url | JSON | Optional | |
pic_url (anyOf 1) | string | Alternative | URL of the worker's profile picture |
pic_url (anyOf 2) | null | Alternative | URL of the worker's profile picture |
List equity grants with tax events — 200 response body — data item tax events item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
actual_payroll_cycle_cutoff | JSON | Optional | |
actual_payroll_cycle_cutoff (anyOf 1) | string | Alternative | The cutoff date of the actual payroll cycle Format: date-time |
actual_payroll_cycle_cutoff (anyOf 2) | null | Alternative | The cutoff date of the actual payroll cycle Format: date-time |
actual_payroll_cycle_end | JSON | Optional | |
actual_payroll_cycle_end (anyOf 1) | string | Alternative | The end date of the actual payroll cycle Format: date |
actual_payroll_cycle_end (anyOf 2) | null | Alternative | The end date of the actual payroll cycle Format: date |
actual_payroll_cycle_id | JSON | Optional | |
actual_payroll_cycle_id (anyOf 1) | string | Alternative | The unique identifier of the actual payroll cycle Format: uuid |
actual_payroll_cycle_id (anyOf 2) | null | Alternative | The unique identifier of the actual payroll cycle Format: uuid |
actual_payroll_cycle_start | JSON | Optional | |
actual_payroll_cycle_start (anyOf 1) | string | Alternative | The start date of the actual payroll cycle Format: date |
actual_payroll_cycle_start (anyOf 2) | null | Alternative | The start date of the actual payroll cycle Format: date |
archived_at | JSON | Optional | |
archived_at (anyOf 1) | string | Alternative | The date and time the tax event was archived Format: date-time |
archived_at (anyOf 2) | null | Alternative | The date and time the tax event was archived Format: date-time |
benefit_in_kind_local_currency | JSON | Optional | |
benefit_in_kind_local_currency (anyOf 1) | string | Alternative | The benefit-in-kind (BIK) value reported to payroll, expressed in the worker's local payroll currency |
benefit_in_kind_local_currency (anyOf 2) | null | Alternative | The benefit-in-kind (BIK) value reported to payroll, expressed in the worker's local payroll currency |
contract_completion_date | JSON | Optional | |
contract_completion_date (anyOf 1) | string | Alternative | The completion date of the associated contract Format: date-time |
contract_completion_date (anyOf 2) | null | Alternative | The completion date of the associated contract Format: date-time |
contract_id | string | Optional | The unique identifier of the contract associated with the tax event |
contract_status | string | Optional | The lifecycle status of the associated worker contract (e.g. in_progress, completed, cancelled) |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | The ISO 3166-1 alpha-2 country code of the worker's employment country |
country (anyOf 2) | null | Alternative | The ISO 3166-1 alpha-2 country code of the worker's employment country |
created_at | JSON | Optional | |
created_at (anyOf 1) | string | Alternative | The date and time the tax event was created Format: date-time |
created_at (anyOf 2) | null | Alternative | The date and time the tax event was created Format: date-time |
created_by_email | JSON | Optional | |
created_by_email (anyOf 1) | string | Alternative | The email of the user who created the tax event Format: email |
created_by_email (anyOf 2) | null | Alternative | The email of the user who created the tax event Format: email |
email | string | Optional | The worker's email address Format: email |
equity_service_status | string | Optional | The equity service enrollment status for the worker (ONBOARDED, OFFBOARDED, NOT_ONBOARDED, NOT_ELIGIBLE, MORE_INFO_REQUIRED) |
event_date | JSON | Optional | |
event_date (anyOf 1) | string | Alternative | The date of the tax event Format: date |
event_date (anyOf 2) | null | Alternative | The date of the tax event Format: date |
exercise_price | JSON | Optional | |
exercise_price (anyOf 1) | string | Alternative | The price at which the equity was exercised |
exercise_price (anyOf 2) | null | Alternative | The price at which the equity was exercised |
expected_payroll_cycle_cutoff | JSON | Optional | |
expected_payroll_cycle_cutoff (anyOf 1) | string | Alternative | The cutoff date of the expected payroll cycle Format: date-time |
expected_payroll_cycle_cutoff (anyOf 2) | null | Alternative | The cutoff date of the expected payroll cycle Format: date-time |
expected_payroll_cycle_end | JSON | Optional | |
expected_payroll_cycle_end (anyOf 1) | string | Alternative | The end date of the expected payroll cycle Format: date |
expected_payroll_cycle_end (anyOf 2) | null | Alternative | The end date of the expected payroll cycle Format: date |
expected_payroll_cycle_id | JSON | Optional | |
expected_payroll_cycle_id (anyOf 1) | string | Alternative | The unique identifier of the expected payroll cycle Format: uuid |
expected_payroll_cycle_id (anyOf 2) | null | Alternative | The unique identifier of the expected payroll cycle Format: uuid |
expected_payroll_cycle_start | JSON | Optional | |
expected_payroll_cycle_start (anyOf 1) | string | Alternative | The start date of the expected payroll cycle Format: date |
expected_payroll_cycle_start (anyOf 2) | null | Alternative | The start date of the expected payroll cycle Format: date |
external_id | JSON | Optional | |
external_id (anyOf 1) | string | Alternative | An external system identifier for the worker, such as an ID from a cap-table provider |
external_id (anyOf 2) | null | Alternative | An external system identifier for the worker, such as an ID from a cap-table provider |
first_name | JSON | Optional | |
first_name (anyOf 1) | string | Alternative | The worker's first name |
first_name (anyOf 2) | null | Alternative | The worker's first name |
fx_rate | JSON | Optional | |
fx_rate (anyOf 1) | string | Alternative | The exchange rate used to convert local currency to payroll currency |
fx_rate (anyOf 2) | null | Alternative | The exchange rate used to convert local currency to payroll currency |
grant_date | JSON | Optional | |
grant_date (anyOf 1) | string | Alternative | The date the associated grant was issued Format: date |
grant_date (anyOf 2) | null | Alternative | The date the associated grant was issued Format: date |
grant_id | JSON | Optional | |
grant_id (anyOf 1) | string | Alternative | The unique identifier of the associated grant Format: uuid |
grant_id (anyOf 2) | null | Alternative | The unique identifier of the associated grant Format: uuid |
grant_reference_id | JSON | Optional | |
grant_reference_id (anyOf 1) | JSON | Alternative | |
grant_reference_id (anyOf 1) (anyOf 1) | number | Alternative | The human-readable reference number of the associated grant Format: double |
grant_reference_id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
grant_reference_id (anyOf 2) | null | Alternative | The human-readable reference number of the associated grant Format: double |
grant_type | JSON | Optional | |
grant_type (anyOf 1) | string | Alternative | The equity instrument type of the associated grant (e.g. RSU, NSO, ISO) |
grant_type (anyOf 2) | null | Alternative | The equity instrument type of the associated grant (e.g. RSU, NSO, ISO) |
gross_value | JSON | Optional | |
gross_value (anyOf 1) | string | Alternative | The gross value of the equity event, calculated as unit FMV multiplied by quantity exercised or released |
gross_value (anyOf 2) | null | Alternative | The gross value of the equity event, calculated as unit FMV multiplied by quantity exercised or released |
hris_profile_id | string | Optional | The unique identifier of the worker who holds the grant Format: uuid |
id | string | Optional | The unique identifier of the tax event Format: uuid |
instrument_type | JSON | Optional | |
instrument_type (anyOf 1) | string | Alternative | The type of equity instrument (e.g. RSU, NSO, ISO, PHANTOM, SARS) |
instrument_type (anyOf 2) | null | Alternative | The type of equity instrument (e.g. RSU, NSO, ISO, PHANTOM, SARS) |
is_archived | JSON | Optional | |
is_archived (anyOf 1) | boolean | Alternative | Whether the tax event has been archived |
is_archived (anyOf 2) | null | Alternative | Whether the tax event has been archived |
last_name | JSON | Optional | |
last_name (anyOf 1) | string | Alternative | The worker's last name |
last_name (anyOf 2) | null | Alternative | The worker's last name |
method_of_tax_coverage | JSON | Optional | |
method_of_tax_coverage (anyOf 1) | string | Alternative | How 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) | null | Alternative | How 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_name | JSON | Optional | |
middle_name (anyOf 1) | string | Alternative | The worker's middle name |
middle_name (anyOf 2) | null | Alternative | The worker's middle name |
note | JSON | Optional | |
note (anyOf 1) | string | Alternative | A free-text note attached to the tax event |
note (anyOf 2) | null | Alternative | A free-text note attached to the tax event |
organization_id | string | Optional | The unique identifier of the organization Format: uuid |
organization_name | JSON | Optional | |
organization_name (anyOf 1) | string | Alternative | The name of the organization |
organization_name (anyOf 2) | null | Alternative | The name of the organization |
payroll_currency | JSON | Optional | |
payroll_currency (anyOf 1) | string | Alternative | The currency in which payroll is processed |
payroll_currency (anyOf 2) | null | Alternative | The currency in which payroll is processed |
pic_url | JSON | Optional | |
pic_url (anyOf 1) | string | Alternative | URL of the worker's profile picture |
pic_url (anyOf 2) | null | Alternative | URL of the worker's profile picture |
plan_currency | JSON | Optional | |
plan_currency (anyOf 1) | string | Alternative | The currency in which the equity plan was issued |
plan_currency (anyOf 2) | null | Alternative | The currency in which the equity plan was issued |
quantity_exercised_or_released | JSON | Optional | |
quantity_exercised_or_released (anyOf 1) | string | Alternative | The quantity of equity exercised or released |
quantity_exercised_or_released (anyOf 2) | null | Alternative | The quantity of equity exercised or released |
quantity_remaining | JSON | Optional | |
quantity_remaining (anyOf 1) | string | Alternative | The quantity of equity remaining |
quantity_remaining (anyOf 2) | null | Alternative | The quantity of equity remaining |
quantity_withheld_or_sold | JSON | Optional | |
quantity_withheld_or_sold (anyOf 1) | string | Alternative | The quantity of equity withheld or sold |
quantity_withheld_or_sold (anyOf 2) | null | Alternative | The quantity of equity withheld or sold |
sale_price | JSON | Optional | |
sale_price (anyOf 1) | string | Alternative | The price at which the equity was sold |
sale_price (anyOf 2) | null | Alternative | The price at which the equity was sold |
sent_for_processing_at | JSON | Optional | |
sent_for_processing_at (anyOf 1) | string | Alternative | The date and time the event was sent for payroll processing Format: date-time |
sent_for_processing_at (anyOf 2) | null | Alternative | The date and time the event was sent for payroll processing Format: date-time |
settlement_date | JSON | Optional | |
settlement_date (anyOf 1) | string | Alternative | The date the equity event was settled (i.e. when shares were transferred or cash was received) Format: date |
settlement_date (anyOf 2) | null | Alternative | The date the equity event was settled (i.e. when shares were transferred or cash was received) Format: date |
supporting_documents_id | JSON | Optional | |
supporting_documents_id (anyOf 1) | string | Alternative | The unique identifier of the supporting documents attached to the event Format: uuid |
supporting_documents_id (anyOf 2) | null | Alternative | The unique identifier of the supporting documents attached to the event Format: uuid |
tax_jurisdiction | JSON | Optional | |
tax_jurisdiction (anyOf 1) | string | Alternative | The ISO 3166-1 alpha-2 country code of the worker's contract jurisdiction at the time of the event |
tax_jurisdiction (anyOf 2) | null | Alternative | The ISO 3166-1 alpha-2 country code of the worker's contract jurisdiction at the time of the event |
tax_rate | JSON | Optional | |
tax_rate (anyOf 1) | string | Alternative | The tax rate applied to the benefit in kind |
tax_rate (anyOf 2) | null | Alternative | The tax rate applied to the benefit in kind |
taxable_gain_or_loss | JSON | Optional | |
taxable_gain_or_loss (anyOf 1) | string | Alternative | The taxable gain or loss on the event, typically gross value minus the total exercise price |
taxable_gain_or_loss (anyOf 2) | null | Alternative | The taxable gain or loss on the event, typically gross value minus the total exercise price |
total_exercise_price | JSON | Optional | |
total_exercise_price (anyOf 1) | string | Alternative | The total exercise price paid for the equity, calculated as exercise price per unit multiplied by quantity exercised |
total_exercise_price (anyOf 2) | null | Alternative | The total exercise price paid for the equity, calculated as exercise price per unit multiplied by quantity exercised |
total_taxes_withheld | JSON | Optional | |
total_taxes_withheld (anyOf 1) | string | Alternative | The total amount of income tax and social contributions withheld on behalf of the worker |
total_taxes_withheld (anyOf 2) | null | Alternative | The total amount of income tax and social contributions withheld on behalf of the worker |
transaction_fees | JSON | Optional | |
transaction_fees (anyOf 1) | string | Alternative | Brokerage or transaction fees associated with the equity event, in plan currency |
transaction_fees (anyOf 2) | null | Alternative | Brokerage or transaction fees associated with the equity event, in plan currency |
unit_fmv | JSON | Optional | |
unit_fmv (anyOf 1) | string | Alternative | The fair market value per unit at the time of the event |
unit_fmv (anyOf 2) | null | Alternative | The fair market value per unit at the time of the event |
updated_at | JSON | Optional | |
updated_at (anyOf 1) | string | Alternative | The date and time the tax event was last updated Format: date-time |
updated_at (anyOf 2) | null | Alternative | The date and time the tax event was last updated Format: date-time |
verification_status | JSON | Optional | |
verification_status (anyOf 1) | string | Alternative | The current verification status of the tax event (PENDING_VERIFICATION, VERIFIED, SENT_FOR_PROCESSING, PROCESSED, MISMATCH) |
verification_status (anyOf 2) | null | Alternative | The current verification status of the tax event (PENDING_VERIFICATION, VERIFIED, SENT_FOR_PROCESSING, PROCESSED, MISMATCH) |
withheld_tax_local_currency | JSON | Optional | |
withheld_tax_local_currency (anyOf 1) | string | Alternative | The income tax and social contributions withheld, expressed in the worker's local payroll currency |
withheld_tax_local_currency (anyOf 2) | null | Alternative | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
quantity | JSON | Optional | |
quantity (anyOf 1) | JSON | Alternative | |
quantity (anyOf 1) (anyOf 1) | number | Alternative | The quantity that vested on this date Format: double |
quantity (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
quantity (anyOf 2) | null | Alternative | The quantity that vested on this date Format: double |
vesting_date | JSON | Optional | |
vesting_date (anyOf 1) | string | Alternative | The date this tranche vested Format: date |
vesting_date (anyOf 2) | null | Alternative | The date this tranche vested Format: date |
List equity option ledger entries — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Page of option holder ledger records, one per grant occurrence. |
data[] | Model | Each item | Expand List equity option ledger entries — 200 response body — data item |
has_more | boolean | Required within parent | Whether another page of results is available. |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Cursor for the next page. Null when has_more is false. |
next_cursor (anyOf 2) | null | Alternative | Cursor 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
carta_grant_acceptance_date | JSON | Required within parent | |
carta_grant_acceptance_date (anyOf 1) | string | Alternative | Carta - Grant Acceptance Date, as reported by the ingested file. Format: date |
carta_grant_acceptance_date (anyOf 2) | null | Alternative | Carta - Grant Acceptance Date, as reported by the ingested file. Format: date |
compensation_benefit | JSON | Required within parent | |
compensation_benefit (anyOf 1) | JSON | Alternative | |
compensation_benefit (anyOf 1) (anyOf 1) | number | Alternative | Compensation benefit amount, as reported by the ingested file. Format: double |
compensation_benefit (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
compensation_benefit (anyOf 2) | null | Alternative | Compensation benefit amount, as reported by the ingested file. Format: double |
created_at | string | Required within parent | Timestamp this record was first ingested. Format: date-time |
early_exercise_allowed | JSON | Required within parent | |
early_exercise_allowed (anyOf 1) | string | Alternative | Whether early exercise is allowed, as reported by the ingested file (verbatim text, e.g. Yes/No). |
early_exercise_allowed (anyOf 2) | null | Alternative | Whether early exercise is allowed, as reported by the ingested file (verbatim text, e.g. Yes/No). |
employee_grant_number | string | Required within parent | Shareworks grant number for this employee, as reported by the ingested file. |
employee_number | JSON | Required within parent | |
employee_number (anyOf 1) | string | Alternative | Shareworks 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) | null | Alternative | Shareworks 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_share | JSON | Required within parent | |
exercise_price_per_share (anyOf 1) | JSON | Alternative | |
exercise_price_per_share (anyOf 1) (anyOf 1) | number | Alternative | Exercise price per share, as reported by the ingested file. Format: double |
exercise_price_per_share (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
exercise_price_per_share (anyOf 2) | null | Alternative | Exercise price per share, as reported by the ingested file. Format: double |
expire_date | JSON | Required within parent | |
expire_date (anyOf 1) | string | Alternative | Grant expiration date, as reported by the ingested file. Format: date |
expire_date (anyOf 2) | null | Alternative | Grant expiration date, as reported by the ingested file. Format: date |
federal_exemption | JSON | Required within parent | |
federal_exemption (anyOf 1) | string | Alternative | Federal exemption, as reported by the ingested file. |
federal_exemption (anyOf 2) | null | Alternative | Federal exemption, as reported by the ingested file. |
first_name | JSON | Required within parent | |
first_name (anyOf 1) | string | Alternative | Employee first name, as reported by the ingested file. |
first_name (anyOf 2) | null | Alternative | Employee first name, as reported by the ingested file. |
fmv_per_share_at_grant_date | JSON | Required within parent | |
fmv_per_share_at_grant_date (anyOf 1) | JSON | Alternative | |
fmv_per_share_at_grant_date (anyOf 1) (anyOf 1) | number | Alternative | Fair 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
fmv_per_share_at_grant_date (anyOf 2) | null | Alternative | Fair market value per share at grant date, as reported by the ingested file. Format: double |
formatted_home_address | JSON | Required within parent | |
formatted_home_address (anyOf 1) | string | Alternative | Formatted home address, as reported by the ingested file. |
formatted_home_address (anyOf 2) | null | Alternative | Formatted home address, as reported by the ingested file. |
grant_agreement_template_name | JSON | Required within parent | |
grant_agreement_template_name (anyOf 1) | string | Alternative | Grant agreement template name, as reported by the ingested file. |
grant_agreement_template_name (anyOf 2) | null | Alternative | Grant agreement template name, as reported by the ingested file. |
grant_date | JSON | Required within parent | |
grant_date (anyOf 1) | string | Alternative | Date the grant was issued, as reported by the ingested file. Format: date |
grant_date (anyOf 2) | null | Alternative | Date the grant was issued, as reported by the ingested file. Format: date |
grant_name | JSON | Required within parent | |
grant_name (anyOf 1) | string | Alternative | Grant name, as reported by the ingested file. |
grant_name (anyOf 2) | null | Alternative | Grant name, as reported by the ingested file. |
grant_reason | JSON | Required within parent | |
grant_reason (anyOf 1) | string | Alternative | Grant reason, as reported by the ingested file. |
grant_reason (anyOf 2) | null | Alternative | Grant reason, as reported by the ingested file. |
grant_type | JSON | Required within parent | |
grant_type (anyOf 1) | string | Alternative | Grant type (e.g. Options (NQ)), as reported by the ingested file. |
grant_type (anyOf 2) | null | Alternative | Grant type (e.g. Options (NQ)), as reported by the ingested file. |
hris_profile_id | JSON | Required within parent | |
hris_profile_id (anyOf 1) | JSON | Alternative | |
hris_profile_id (anyOf 1) (anyOf 1) | integer | Alternative | Matched 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
hris_profile_id (anyOf 2) | null | Alternative | Matched HRIS profile id, if employee_number could be resolved to one. Null when unmatched, or when employee_number is non-numeric or blank. |
id | string | Required within parent | The unique identifier of the record. Format: uuid |
is_under_rule_701 | JSON | Required within parent | |
is_under_rule_701 (anyOf 1) | string | Alternative | Whether the grant is under Rule 701, as reported by the ingested file (verbatim text, e.g. Yes/No). |
is_under_rule_701 (anyOf 2) | null | Alternative | Whether the grant is under Rule 701, as reported by the ingested file (verbatim text, e.g. Yes/No). |
iso_csop_disqualification_date | JSON | Required within parent | |
iso_csop_disqualification_date (anyOf 1) | string | Alternative | ISO/CSOP disqualification date, as reported by the ingested file. Format: date |
iso_csop_disqualification_date (anyOf 2) | null | Alternative | ISO/CSOP disqualification date, as reported by the ingested file. Format: date |
last_name | JSON | Required within parent | |
last_name (anyOf 1) | string | Alternative | Employee last name, as reported by the ingested file. |
last_name (anyOf 2) | null | Alternative | Employee last name, as reported by the ingested file. |
last_seen_dataset_id | JSON | Required within parent | |
last_seen_dataset_id (anyOf 1) | string | Alternative | Identifier 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) | null | Alternative | Identifier of the most recent ingested dataset in which this record still appeared. Null for records ingested before dataset tracking began. Format: uuid |
middle_name | JSON | Required within parent | |
middle_name (anyOf 1) | string | Alternative | Employee middle name, as reported by the ingested file. |
middle_name (anyOf 2) | null | Alternative | Employee middle name, as reported by the ingested file. |
no_of_shares_granted | JSON | Required within parent | |
no_of_shares_granted (anyOf 1) | JSON | Alternative | |
no_of_shares_granted (anyOf 1) (anyOf 1) | number | Alternative | Number of shares/units granted, as reported by the ingested file. Format: double |
no_of_shares_granted (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
no_of_shares_granted (anyOf 2) | null | Alternative | Number of shares/units granted, as reported by the ingested file. Format: double |
no_of_shares_unvested | JSON | Required within parent | |
no_of_shares_unvested (anyOf 1) | JSON | Alternative | |
no_of_shares_unvested (anyOf 1) (anyOf 1) | number | Alternative | Number of shares unvested, as reported by the ingested file. Format: double |
no_of_shares_unvested (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
no_of_shares_unvested (anyOf 2) | null | Alternative | Number of shares unvested, as reported by the ingested file. Format: double |
no_of_shares_vested | JSON | Required within parent | |
no_of_shares_vested (anyOf 1) | JSON | Alternative | |
no_of_shares_vested (anyOf 1) (anyOf 1) | number | Alternative | Number of shares vested, as reported by the ingested file. Format: double |
no_of_shares_vested (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
no_of_shares_vested (anyOf 2) | null | Alternative | Number of shares vested, as reported by the ingested file. Format: double |
notes | JSON | Required within parent | |
notes (anyOf 1) | string | Alternative | Free-form notes, as reported by the ingested file. |
notes (anyOf 2) | null | Alternative | Free-form notes, as reported by the ingested file. |
occurrence_index | JSON | Required within parent | |
occurrence_index (anyOf 1) | integer | Alternative | Discriminates 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
outstanding_exercisable | JSON | Required within parent | |
outstanding_exercisable (anyOf 1) | JSON | Alternative | |
outstanding_exercisable (anyOf 1) (anyOf 1) | number | Alternative | Outstanding exercisable shares, as reported by the ingested file. Format: double |
outstanding_exercisable (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
outstanding_exercisable (anyOf 2) | null | Alternative | Outstanding exercisable shares, as reported by the ingested file. Format: double |
outstanding_unvested | JSON | Required within parent | |
outstanding_unvested (anyOf 1) | JSON | Alternative | |
outstanding_unvested (anyOf 1) (anyOf 1) | number | Alternative | Outstanding unvested shares, as reported by the ingested file. Format: double |
outstanding_unvested (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
outstanding_unvested (anyOf 2) | null | Alternative | Outstanding unvested shares, as reported by the ingested file. Format: double |
outstanding_vested | JSON | Required within parent | |
outstanding_vested (anyOf 1) | JSON | Alternative | |
outstanding_vested (anyOf 1) (anyOf 1) | number | Alternative | Outstanding vested shares, as reported by the ingested file. Format: double |
outstanding_vested (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
outstanding_vested (anyOf 2) | null | Alternative | Outstanding vested shares, as reported by the ingested file. Format: double |
plan_name | JSON | Required within parent | |
plan_name (anyOf 1) | string | Alternative | Equity plan name, as reported by the ingested file. |
plan_name (anyOf 2) | null | Alternative | Equity plan name, as reported by the ingested file. |
preferred_share_price | JSON | Required within parent | |
preferred_share_price (anyOf 1) | JSON | Alternative | |
preferred_share_price (anyOf 1) (anyOf 1) | number | Alternative | Preferred share price, as reported by the ingested file. Format: double |
preferred_share_price (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
preferred_share_price (anyOf 2) | null | Alternative | Preferred share price, as reported by the ingested file. Format: double |
row_hash | string | Required within parent | Hash of the reported values on this record. Compare it between syncs to detect a change without diffing every field. |
section_102_disqualification_date | JSON | Required within parent | |
section_102_disqualification_date (anyOf 1) | string | Alternative | "102 Disqualification date" in the source file (Section 102 of the Israeli tax ordinance). Format: date |
section_102_disqualification_date (anyOf 2) | null | Alternative | "102 Disqualification date" in the source file (Section 102 of the Israeli tax ordinance). Format: date |
shares_cancelled | JSON | Required within parent | |
shares_cancelled (anyOf 1) | JSON | Alternative | |
shares_cancelled (anyOf 1) (anyOf 1) | number | Alternative | Shares cancelled, as reported by the ingested file. Format: double |
shares_cancelled (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
shares_cancelled (anyOf 2) | null | Alternative | Shares cancelled, as reported by the ingested file. Format: double |
shares_exercised_released | JSON | Required within parent | |
shares_exercised_released (anyOf 1) | JSON | Alternative | |
shares_exercised_released (anyOf 1) (anyOf 1) | number | Alternative | Shares exercised/released, as reported by the ingested file. Format: double |
shares_exercised_released (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
shares_exercised_released (anyOf 2) | null | Alternative | Shares exercised/released, as reported by the ingested file. Format: double |
shares_expired | JSON | Required within parent | |
shares_expired (anyOf 1) | JSON | Alternative | |
shares_expired (anyOf 1) (anyOf 1) | number | Alternative | Shares expired, as reported by the ingested file. Format: double |
shares_expired (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
shares_expired (anyOf 2) | null | Alternative | Shares expired, as reported by the ingested file. Format: double |
shares_outstanding | JSON | Required within parent | |
shares_outstanding (anyOf 1) | JSON | Alternative | |
shares_outstanding (anyOf 1) (anyOf 1) | number | Alternative | Shares outstanding, as reported by the ingested file. Format: double |
shares_outstanding (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
shares_outstanding (anyOf 2) | null | Alternative | Shares outstanding, as reported by the ingested file. Format: double |
shares_repurchased | JSON | Required within parent | |
shares_repurchased (anyOf 1) | JSON | Alternative | |
shares_repurchased (anyOf 1) (anyOf 1) | number | Alternative | Shares repurchased, as reported by the ingested file. Format: double |
shares_repurchased (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
shares_repurchased (anyOf 2) | null | Alternative | Shares repurchased, as reported by the ingested file. Format: double |
shares_subject_to_repurchase | JSON | Required within parent | |
shares_subject_to_repurchase (anyOf 1) | JSON | Alternative | |
shares_subject_to_repurchase (anyOf 1) (anyOf 1) | number | Alternative | Shares subject to repurchase, as reported by the ingested file. Format: double |
shares_subject_to_repurchase (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
shares_subject_to_repurchase (anyOf 2) | null | Alternative | Shares subject to repurchase, as reported by the ingested file. Format: double |
shareworks_grant_agreement_agreement_date | JSON | Required within parent | |
shareworks_grant_agreement_agreement_date (anyOf 1) | string | Alternative | Shareworks - Grant Agreement - Agreement Date, as reported by the ingested file. Format: date |
shareworks_grant_agreement_agreement_date (anyOf 2) | null | Alternative | Shareworks - Grant Agreement - Agreement Date, as reported by the ingested file. Format: date |
shareworks_grant_agreement_print_instant | JSON | Required within parent | |
shareworks_grant_agreement_print_instant (anyOf 1) | string | Alternative | Shareworks - Grant Agreement - Print Instant, as reported by the ingested file. |
shareworks_grant_agreement_print_instant (anyOf 2) | null | Alternative | Shareworks - Grant Agreement - Print Instant, as reported by the ingested file. |
source_file_id | string | Required within parent | Identifier of the ingested Shareworks report file this record was last upserted from. Format: uuid |
split_employee_grant_number | JSON | Required within parent | |
split_employee_grant_number (anyOf 1) | string | Alternative | Split Employee Grant Number, as reported by the ingested file. |
split_employee_grant_number (anyOf 2) | null | Alternative | Split Employee Grant Number, as reported by the ingested file. |
state_exemption | JSON | Required within parent | |
state_exemption (anyOf 1) | string | Alternative | State exemption, as reported by the ingested file. |
state_exemption (anyOf 2) | null | Alternative | State exemption, as reported by the ingested file. |
stock_options_and_awards_employee_status | JSON | Required within parent | |
stock_options_and_awards_employee_status (anyOf 1) | string | Alternative | Stock Options and Awards Employee Status, as reported by the ingested file. |
stock_options_and_awards_employee_status (anyOf 2) | null | Alternative | Stock Options and Awards Employee Status, as reported by the ingested file. |
stock_options_and_awards_employee_status_effective_date | JSON | Required within parent | |
stock_options_and_awards_employee_status_effective_date (anyOf 1) | string | Alternative | Stock 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) | null | Alternative | Stock Options and Awards Employee Status (Effective Date), as reported by the ingested file. Format: date |
tax_identifier | JSON | Required within parent | |
tax_identifier (anyOf 1) | string | Alternative | Tax identifier, as reported by the ingested file. |
tax_identifier (anyOf 2) | null | Alternative | Tax identifier, as reported by the ingested file. |
total_exercise_price | JSON | Required within parent | |
total_exercise_price (anyOf 1) | JSON | Alternative | |
total_exercise_price (anyOf 1) (anyOf 1) | number | Alternative | Total exercise price for the grant, as reported by the ingested file. Format: double |
total_exercise_price (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_exercise_price (anyOf 2) | null | Alternative | Total exercise price for the grant, as reported by the ingested file. Format: double |
total_fmv | JSON | Required within parent | |
total_fmv (anyOf 1) | JSON | Alternative | |
total_fmv (anyOf 1) (anyOf 1) | number | Alternative | Total fair market value of the grant, as reported by the ingested file. Format: double |
total_fmv (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_fmv (anyOf 2) | null | Alternative | Total fair market value of the grant, as reported by the ingested file. Format: double |
updated_at | string | Required within parent | Timestamp this record was last upserted, for incremental sync. Format: date-time |
vesting_schedule | JSON | Required within parent | |
vesting_schedule (anyOf 1) | string | Alternative | Vesting schedule name, as reported by the ingested file. |
vesting_schedule (anyOf 2) | null | Alternative | Vesting schedule name, as reported by the ingested file. |
vesting_start_date | JSON | Required within parent | |
vesting_start_date (anyOf 1) | string | Alternative | Vesting start date, as reported by the ingested file. Format: date |
vesting_start_date (anyOf 2) | null | Alternative | Vesting start date, as reported by the ingested file. Format: date |
List equity participants — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Page of equity participant records, one per Shareworks employee number. |
data[] | Model | Each item | Expand List equity participants — 200 response body — data item |
has_more | boolean | Required within parent | Whether another page of results is available. |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Cursor for the next page. Null when has_more is false. |
next_cursor (anyOf 2) | null | Alternative | Cursor 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
account_activation_date | JSON | Required within parent | |
account_activation_date (anyOf 1) | string | Alternative | Moment 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) | null | Alternative | Moment 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_type | JSON | Required within parent | |
account_holder_type (anyOf 1) | string | Alternative | Account holder type, as reported by the ingested file. |
account_holder_type (anyOf 2) | null | Alternative | Account holder type, as reported by the ingested file. |
alternate_employee_number | JSON | Required within parent | |
alternate_employee_number (anyOf 1) | string | Alternative | Alternate employee number, as reported by the ingested file. |
alternate_employee_number (anyOf 2) | null | Alternative | Alternate employee number, as reported by the ingested file. |
company_email | JSON | Required within parent | |
company_email (anyOf 1) | string | Alternative | Company email address, as reported by the ingested file. |
company_email (anyOf 2) | null | Alternative | Company email address, as reported by the ingested file. |
company_provided_personal_email | JSON | Required within parent | |
company_provided_personal_email (anyOf 1) | string | Alternative | Personal email address supplied by the company, as reported by the ingested file. |
company_provided_personal_email (anyOf 2) | null | Alternative | Personal email address supplied by the company, as reported by the ingested file. |
cost_center | JSON | Required within parent | |
cost_center (anyOf 1) | string | Alternative | Cost center, as reported by the ingested file. |
cost_center (anyOf 2) | null | Alternative | Cost center, as reported by the ingested file. |
cost_center_effective_date | JSON | Required within parent | |
cost_center_effective_date (anyOf 1) | string | Alternative | Date the cost center took effect. Format: date |
cost_center_effective_date (anyOf 2) | null | Alternative | Date the cost center took effect. Format: date |
created_at | string | Required within parent | Timestamp this record was first ingested. Format: date-time |
current_employment | JSON | Required within parent | |
current_employment (anyOf 1) | string | Alternative | Current employment classification, as reported by the ingested file. |
current_employment (anyOf 2) | null | Alternative | Current employment classification, as reported by the ingested file. |
current_employment_description | JSON | Required within parent | |
current_employment_description (anyOf 1) | string | Alternative | Free-text description of the current employment, as reported by the ingested file. Unpopulated in every record delivered so far. |
current_employment_description (anyOf 2) | null | Alternative | Free-text description of the current employment, as reported by the ingested file. Unpopulated in every record delivered so far. |
current_employment_effective_date | JSON | Required within parent | |
current_employment_effective_date (anyOf 1) | string | Alternative | Date the current employment classification took effect. Format: date |
current_employment_effective_date (anyOf 2) | null | Alternative | Date the current employment classification took effect. Format: date |
email | JSON | Required within parent | |
email (anyOf 1) | string | Alternative | Personal email address, as reported by the ingested file. |
email (anyOf 2) | null | Alternative | Personal email address, as reported by the ingested file. |
employee_number | string | Required within parent | Shareworks 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_name | JSON | Required within parent | |
full_name (anyOf 1) | string | Alternative | Participant full name, as reported by the ingested file. |
full_name (anyOf 2) | null | Alternative | Participant full name, as reported by the ingested file. |
hire_date | JSON | Required within parent | |
hire_date (anyOf 1) | string | Alternative | Hire date, as reported by the ingested file. Format: date |
hire_date (anyOf 2) | null | Alternative | Hire date, as reported by the ingested file. Format: date |
home_address_city | JSON | Required within parent | |
home_address_city (anyOf 1) | string | Alternative | Home address city, as reported by the ingested file. |
home_address_city (anyOf 2) | null | Alternative | Home address city, as reported by the ingested file. |
home_address_country | JSON | Required within parent | |
home_address_country (anyOf 1) | string | Alternative | Home address country, as reported by the ingested file. |
home_address_country (anyOf 2) | null | Alternative | Home address country, as reported by the ingested file. |
home_address_line_1 | JSON | Required within parent | |
home_address_line_1 (anyOf 1) | string | Alternative | First line of the home address, as reported by the ingested file. |
home_address_line_1 (anyOf 2) | null | Alternative | First line of the home address, as reported by the ingested file. |
home_address_line_2 | JSON | Required within parent | |
home_address_line_2 (anyOf 1) | string | Alternative | Second line of the home address, as reported by the ingested file. |
home_address_line_2 (anyOf 2) | null | Alternative | Second line of the home address, as reported by the ingested file. |
home_address_state_province | JSON | Required within parent | |
home_address_state_province (anyOf 1) | string | Alternative | Home address state or province, as reported by the ingested file. |
home_address_state_province (anyOf 2) | null | Alternative | Home address state or province, as reported by the ingested file. |
home_address_zip_postal_code | JSON | Required within parent | |
home_address_zip_postal_code (anyOf 1) | string | Alternative | Home address ZIP or postal code, as reported by the ingested file. |
home_address_zip_postal_code (anyOf 2) | null | Alternative | Home address ZIP or postal code, as reported by the ingested file. |
hris_profile_id | JSON | Required within parent | |
hris_profile_id (anyOf 1) | JSON | Alternative | |
hris_profile_id (anyOf 1) (anyOf 1) | integer | Alternative | Matched 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
hris_profile_id (anyOf 2) | null | Alternative | Matched HRIS profile id, if employee_number could be resolved to one. Null when unmatched, or when employee_number is non-numeric or blank. |
id | string | Required within parent | The unique identifier of the participant record. Format: uuid |
last_seen_dataset_id | JSON | Required within parent | |
last_seen_dataset_id (anyOf 1) | string | Alternative | Identifier 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) | null | Alternative | Identifier of the most recent ingested dataset in which this record still appeared. Null for records ingested before dataset tracking began. Format: uuid |
organization_name | JSON | Required within parent | |
organization_name (anyOf 1) | string | Alternative | Organization name, as reported by the ingested file. |
organization_name (anyOf 2) | null | Alternative | Organization name, as reported by the ingested file. |
pre_clearance | JSON | Required within parent | |
pre_clearance (anyOf 1) | string | Alternative | Pre-clearance status, as reported by the ingested file. |
pre_clearance (anyOf 2) | null | Alternative | Pre-clearance status, as reported by the ingested file. |
row_hash | string | Required within parent | Hash of the reported values on this record. Compare it between syncs to detect a change without diffing every field. |
source_file_id | string | Required within parent | Identifier of the ingested Shareworks report file this record was last upserted from. Format: uuid |
ssn | JSON | Required within parent | |
ssn (anyOf 1) | string | Alternative | US 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) | null | Alternative | US 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_status | JSON | Required within parent | |
stock_options_and_awards_employee_status (anyOf 1) | string | Alternative | Stock options and awards employee status, as reported by the ingested file. |
stock_options_and_awards_employee_status (anyOf 2) | null | Alternative | Stock options and awards employee status, as reported by the ingested file. |
stock_options_and_awards_employee_status_effective_date | JSON | Required within parent | |
stock_options_and_awards_employee_status_effective_date (anyOf 1) | string | Alternative | Date the stock options and awards employee status took effect. Format: date |
stock_options_and_awards_employee_status_effective_date (anyOf 2) | null | Alternative | Date the stock options and awards employee status took effect. Format: date |
updated_at | string | Required within parent | Timestamp this record was last upserted, for incremental sync. Format: date-time |