Skip to content

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

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

Report an issue with this page

Necessary

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

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

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

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