EndpointsContracts

Get an estimate of withholding amount given an equity event.

Get an estimate of the withholding amount required as well as the assumptions behind the estimate, given a contract id, event amount and currency code. Token scopes: contracts:read, global-payroll:read

Authentication

AuthorizationBearer
## Authentication The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail. ```curl curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` [Learn more about authentication](/api/authentication)
OR
AuthorizationBearer
Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Path parameters

contract_idstringRequired
Deel contract id.

Query parameters

event_valuestringRequired1-50 characters
The monetary value of the equity event.
event_currencystringRequiredformat: "^[A-Z]{3}$"=3 characters

Three-letter currency code for the payment, following ISO 4217.

Response

Successful operation.
dataobject or null

Errors