Deel: HRX documents schemas
4 Deel schemas with complete fields and constraints.
← HRX documents operations · All schemas
Download HRX documents — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Download HRX documents — 200 response body — data Download information for the HRX document |
Referenced models: Download HRX documents — 200 response body — data
Download HRX documents — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Download information for the HRX document |
created_at | string | Required within parent | When the document was created Format: date-time |
updated_at | string | Required within parent | When the document was last updated Format: date-time |
url | string | Required within parent | Pre-signed URL to download the HRX document PDF. Valid for 15 minutes. Format: uri |
Retrieve HRX documents — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | List of employee documents |
data[] | Model | Each item | Expand Retrieve HRX documents — 200 response body — data item |
has_more | boolean | Required within parent | Indicates if there are more pages available |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Cursor to use for the next page. Null if there are no more pages. |
next_cursor (anyOf 2) | null | Alternative | Cursor to use for the next page. Null if there are no more pages. |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | integer | Alternative | Total number of documents available across all pages |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Retrieve HRX documents — 200 response body — data item
Retrieve HRX documents — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
category | string | Required within parent | Type of the document category |
category_description | string | Required within parent | Description of the document category |
category_id | string | Required within parent | Unique identifier for the document category Format: uuid |
category_type | string | Required within parent | Type of the document category Known values: EMPLOYMENT_AGREEMENT, ONBOARDING_REGISTRATION, OFFBOARDING_TERMINATION, TAX_FISCAL, STATUS_BENEFITS, VISA_TRAVEL_SUPPORT, OTHER |
created_at | string | Required within parent | When the document was created Format: date-time |
id | string | Required within parent | Unique identifier for the employee document Format: uuid |
name | string | Required within parent | Name of the employee document |
updated_at | string | Required within parent | When the document was last updated Format: date-time |