Estimate Gross or Net Salary
Estimate gross or net salary for a given country and type.
Pass an optional version alongside the fields below to pin the estimate to a specific tax ruleset version, for example v2.1.0; omit it to use the current ruleset. Discover pinnable versions with List Tax Ruleset Versions. A version that is unknown, malformed or not pinnable is rejected with a 400 rather than silently falling back. When a version is pinned the response returns it as rulesetVersion.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Required when using a Platform API token. The tenant key identifying which business to operate on.
Body
- Option 1
- Option 2
Country code for tax estimation
Type of estimation
gross-to-net, net-to-gross Optional region/state code
ISO 4217 currency to convert response amounts into. When different from the salary currency, all amounts are converted at the prevailing FX rate and fxRate is populated on the response.
"USD"
Response
Estimate taxes response
The pinned ruleset version this result was computed against. Returned only when the request pinned a version.
"v2.1.0"
Imputed-income line items (e.g. benefits-in-kind) surfaced by the country engine. Omitted when none apply.
Echo of the requested outputCurrency. Present only when the request specified a conversion.
"USD"
FX rate applied to convert from the input currency to outputCurrency. Present only when a conversion was performed.
"0.058"