Skip to content

Deel: Create equity or token tax event

Deel equityTokens.createEquityOrTokenTaxEvent: arguments, response, policy and SDK examples.

← Equity tokens operations · Get started

Operation deel.equitytokens_createequityortokentaxevent_v2026_01_01

Provider route: POST /equities-tokens/tax-events. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["equityTokens"]["createEquityOrTokenTaxEvent"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.equityTokens.createEquityOrTokenTaxEvent(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_deel import DeelIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.equity_tokens.create_equity_or_token_tax_event(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bodyobjectOptional
body.dataModelOptionalExpand Create equity or token tax event — request body — body data

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

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Create equity or token tax event — 201 response body

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

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
Create equity or token tax event — 201 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand Create equity or token tax event — 201 response body — data

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

Create equity or token tax event — 201 response body — data
FieldTypePresenceDescription and constraints
$objectRoot
created_atstringOptionalthe date and time when the equity/token tax event was created
Format: date-time
idstringOptionalthe id of the equity/token tax event generated
Format: uuid

SDK function policy ID: deel.equitytokens_createequityortokentaxevent_v2026_01_01. Catalog operation: equitytokens_createequityortokentaxevent_v2026_01_01. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["equities:write"]

Pinned headers: {"X-Version": "2026-01-01"}

Official provider source

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.