Deel: EOR benefits schemas
9 Deel schemas with complete fields and constraints.
← EOR benefits operations · All schemas
Retrieve Benefits for EOR Contract — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Optional | |
data[] | Model | Each item | Expand Retrieve Benefits for EOR Contract — 200 response body — data item |
worker_benefits_link | Model | Optional | Expand Retrieve Benefits for EOR Contract — 200 response body — worker benefits link Short-lived link where the worker completes their benefits enrolment and manages their benefits. Only returned for organisations set up as white-label with Deel, whose workers don't use the Deel app. Redirect the worker to it from your app; call this endpoint again for a new link after expires_at. Don't store, email or share it. |
Referenced models: Retrieve Benefits for EOR Contract — 200 response body — worker benefits link, Retrieve Benefits for EOR Contract — 200 response body — data item
Retrieve Benefits for EOR Contract — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
enrollment_details | Model | Optional | Expand Retrieve Benefits for EOR Contract — 200 response body — data item enrollment details |
id | string | Optional | The unique ID of the benefit. |
name | string | Optional | The name of the benefit. |
offer_status | string | Optional | Indicates whether the benefit is offered. Known values: Offered, Not offered |
plan | Model | Optional | Expand Retrieve Benefits for EOR Contract — 200 response body — data item plan |
provider | Model | Optional | Expand Retrieve Benefits for EOR Contract — 200 response body — data item provider |
Referenced models: Retrieve Benefits for EOR Contract — 200 response body — data item plan, Retrieve Benefits for EOR Contract — 200 response body — data item provider, Retrieve Benefits for EOR Contract — 200 response body — data item enrollment details
Retrieve Benefits for EOR Contract — 200 response body — data item enrollment details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
current_cycle | Model | Optional | Expand Retrieve Benefits for EOR Contract — 200 response body — data item enrollment details current cycle |
plan | Model | Optional | Expand Retrieve Benefits for EOR Contract — 200 response body — data item enrollment details plan |
standard | Model | Optional | Expand Retrieve Benefits for EOR Contract — 200 response body — data item enrollment details standard |
status | string | Optional | The current enrollment status of the benefit (e.g. ENROLLED, AWAITING_ENROLLMENT, AWAITING_CONTRACT_ACTIVATION, AWAITING_CARRIER_CONFIRMATION). |
Referenced models: Retrieve Benefits for EOR Contract — 200 response body — data item enrollment details current cycle, Retrieve Benefits for EOR Contract — 200 response body — data item enrollment details plan, Retrieve Benefits for EOR Contract — 200 response body — data item enrollment details standard
Retrieve Benefits for EOR Contract — 200 response body — data item enrollment details current cycle
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
employee_monthly_contribution | string | Optional | The monthly contribution paid by the employer (client) for the current enrollment. Note: despite the field name, this value is the employer contribution, not the employee's. |
monthly_cost | string | Optional | The total monthly cost of the current enrollment. |
Retrieve Benefits for EOR Contract — 200 response body — data item enrollment details plan
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | string | Optional | The name of the enrolled plan. |
Retrieve Benefits for EOR Contract — 200 response body — data item enrollment details standard
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
employee_monthly_contribution | JSON | Optional | |
employee_monthly_contribution (anyOf 1) | string | Alternative | The standard monthly contribution paid by the employer (client) toward the benefit. Note: despite the field name, this value is the employer contribution, not the employee's. |
employee_monthly_contribution (anyOf 2) | null | Alternative | The standard monthly contribution paid by the employer (client) toward the benefit. Note: despite the field name, this value is the employer contribution, not the employee's. |
monthly_cost | JSON | Optional | |
monthly_cost (anyOf 1) | string | Alternative | The standard total monthly cost of the benefit. |
monthly_cost (anyOf 2) | null | Alternative | The standard total monthly cost of the benefit. |
Retrieve Benefits for EOR Contract — 200 response body — data item plan
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | string | Optional | The name of the associated plan. |
Retrieve Benefits for EOR Contract — 200 response body — data item provider
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | string | Optional | The name of the benefit provider. |
Retrieve Benefits for EOR Contract — 200 response body — worker benefits link
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Short-lived link where the worker completes their benefits enrolment and manages their benefits. Only returned for organisations set up as white-label with Deel, whose workers don't use the Deel app. Redirect the worker to it from your app; call this endpoint again for a new link after expires_at. Don't store, email or share it. |
expires_at | string | Optional | The date and time (UTC) after which the link no longer works. Format: date-time |
url | string | Optional | The short-lived URL to redirect the worker to. Format: uri |