Skip to content

Deel: HRX documents schemas

4 Deel schemas with complete fields and constraints.

← HRX documents operations · All schemas

Download HRX documents — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRootDownload information for the HRX document
created_atstringRequired within parentWhen the document was created
Format: date-time
updated_atstringRequired within parentWhen the document was last updated
Format: date-time
urlstringRequired within parentPre-signed URL to download the HRX document PDF. Valid for 15 minutes.
Format: uri

Retrieve HRX documents — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentList of employee documents
data[]ModelEach itemExpand Retrieve HRX documents — 200 response body — data item
has_morebooleanRequired within parentIndicates if there are more pages available
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeCursor to use for the next page. Null if there are no more pages.
next_cursor (anyOf 2)nullAlternativeCursor to use for the next page. Null if there are no more pages.
total_countJSONRequired within parent
total_count (anyOf 1)integerAlternativeTotal number of documents available across all pages
total_count (anyOf 2)stringAlternativePattern: ^-?[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

FieldTypePresenceDescription and constraints
$objectRoot
categorystringRequired within parentType of the document category
category_descriptionstringRequired within parentDescription of the document category
category_idstringRequired within parentUnique identifier for the document category
Format: uuid
category_typestringRequired within parentType of the document category
Known values: EMPLOYMENT_AGREEMENT, ONBOARDING_REGISTRATION, OFFBOARDING_TERMINATION, TAX_FISCAL, STATUS_BENEFITS, VISA_TRAVEL_SUPPORT, OTHER
created_atstringRequired within parentWhen the document was created
Format: date-time
idstringRequired within parentUnique identifier for the employee document
Format: uuid
namestringRequired within parentName of the employee document
updated_atstringRequired within parentWhen the document was last updated
Format: date-time

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.