Deel: Cost calculator schemas
6 Deel schemas with complete fields and constraints.
← Cost calculator operations · All schemas
Calculate Employee Costs Globally — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
additional_data | Model | Optional | Expand Calculate Employee Costs Globally — 200 response body — additional data |
benefits_data | array | Optional | |
benefits_data[] | Model | Each item | Expand Calculate Employee Costs Globally — 200 response body — benefits data item |
costs | array | Optional | |
costs[] | Model | Each item | Expand Calculate Employee Costs Globally — 200 response body — costs item |
country | string | Optional | The country where the employee is based. |
country_code | string | Optional | ISO Alpha-2 code of the country. |
currency | string | Optional | The currency used for cost calculation. |
deel_fee | string | Optional | The Deel fee for managing the employee. |
employer_annual_costs | string | Optional | Costs incurred by the employer for cost items with an annual payment frequency. |
employer_costs | string | Optional | Costs incurred by the employer. |
employer_costs_usd | string | Optional | Costs incurred by the employer, converted to USD. |
frequency | string | Optional | Frequency of the salary payment (e.g., monthly). |
salary | string | Optional | The base salary for the employee. |
severance_accural | string | Optional | Severance accrual costs. |
severance_accural_usd | string | Optional | Severance accrual costs, converted to USD. |
total_costs | string | Optional | Total employment costs. |
Referenced models: Calculate Employee Costs Globally — 200 response body — additional data, Calculate Employee Costs Globally — 200 response body — benefits data item, Calculate Employee Costs Globally — 200 response body — costs item
Calculate Employee Costs Globally — 200 response body — additional data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
additional_notes | array | Optional | |
additional_notes[] | string | Each item |
Calculate Employee Costs Globally — 200 response body — benefits data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | string | Optional | Benefit cost. |
fee_amount | string | Optional | Fees associated with the benefit. |
name | string | Optional | Benefit name. |
plan | string | Optional | Benefit plan. |
Calculate Employee Costs Globally — 200 response body — costs item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | string | Optional | Cost amount. |
country | string | Optional | The country of the cost item. |
country_code | string | Optional | ISO Alpha-2 code of the country. |
frequency | string | Optional | The frequency of the cost (e.g., monthly, annually). |
name | string | Optional | Name of the cost item. |
Calculate Employee Costs Globally — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
benefits | array or null | Optional | A list of selected benefit plans for the employee. |
benefits[] | Model | Each item | Expand Calculate Employee Costs Globally — request body — body data benefits item |
country | string | Required within parent | The full name of the country where the employee is based. |
country_code | string | Optional | The two-letter country code where the employee is based. |
currency | string | Required within parent | The currency in which the costs are calculated. |
salary | number | Required within parent | The base salary for the employee. Format: double Minimum: 1 |
salary_period | string | Optional | The salary period for the amount provided. Default: ANNUALLY One of: ANNUALLY, MONTHLY |
state | string | Optional | The state or region within the country, if applicable. |
Referenced models: Calculate Employee Costs Globally — request body — body data benefits item
Calculate Employee Costs Globally — request body — body data benefits item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
plan_id | string or null | Optional | The ID of the benefits plan, if applicable. |
provider_id | string | Required within parent | The ID of the benefits provider. |