Deel: Create equity or token tax event — request body — body data
Create equity or token tax event: request body, field body / data. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: 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 |