Data Dictionary
Complete reference of all data fields available in the Rewardata API, organized by category
Currency & period. Monetary values are in each country's
local currency unless the field name or description says otherwise
(a
_usd, _ppp or _eur suffix, or "in USD" in the
description). Wage & earnings fields state their period — hourly / monthly / annual — in the description.
- Categories
- Fields
- Countries
- Records
Loading data dictionary...
Global Mobility
13 endpoints
calculations
Relocation & assignment calculators — POST /api/v1/mobility/<endpoint> (authenticated), inputs are ISO-3 codes + a household (single/family_of_2/family_of_4). Built on the government-sourced tax, social-security, cost-of-living & living-wage data. Approximate — for planning, not payroll.
| Field Name | Display Name | Source | Countries | Latest Year | Last Updated | Description | API |
|---|---|---|---|---|---|---|---|
/mobility/net-to-net | Net-to-Net Gross-Up | Calculated | 184 Global | live | — | Gross needed in the host country to keep an employee's net pay whole (tax + social security + cost of living). | API call |
/mobility/take-home | Take-Home (Net) Pay | Calculated | 184 Global | live | — | Net take-home pay from a gross salary — income tax + employee social security, family-adjusted. | API call |
/mobility/gross-up | Gross-Up to Target Net | Calculated | 184 Global | live | — | Gross salary needed in a country to reach a target net. | API call |
/mobility/cost-to-company | Cost to Company (Employer) | Calculated | 184 Global | live | — | Total employer cost (gross + employer social security) home vs host for a relocation. | API call |
/mobility/tax-equalization | Tax Equalization | Calculated | 184 Global | live | — | Hypothetical home tax, host gross to keep home net, and the employer's tax-equalization cost. | API call |
/mobility/offer-check | Offer Adequacy Check | Calculated | 184 Global | live | — | Is a proposed host-country gross enough to keep the employee whole? Returns the net surplus/shortfall. | API call |
/mobility/balance-sheet | Balance-Sheet Package | Calculated | 184 Global | live | — | Indicative assignment package: net-to-net gross + housing differential + hardship premium. | API call |
/mobility/rank-hosts | Host Country Ranking | Calculated | 184 Global | live | — | Rank candidate host countries by the gross needed to keep an employee whole (cheapest first). | API call |
/mobility/compare | Full Mobility Comparison | Calculated | 165 Global | live | — | Full relocation report: net income, purchasing power, family benefits, employer costs, quality of life, allowances. | API call |
/mobility/purchasing-power | Purchasing-Power Conversion | Calculated | 165 Global | live | — | What a salary is "worth" in another country (cost-of-living-adjusted, no tax). | API call |
/mobility/cost-of-living | Cost-of-Living Index | Calculated | 165 Global | live | — | Cost-of-living (price-level) factor between two locations — country or city. | API call |
/mobility/quality-of-life | Quality of Life (Hardship) | Calculated | 165 Global | live | — | Living-conditions (hardship) comparison between two countries. | API call |
/mobility/living-wage-gross | Living-Wage Gross | Calculated | 165 Global | live | — | Gross needed to clear the living wage (net) for a household in a country. | API call |