Skip to content

Deel: Contractor hiring schemas

12 Deel schemas with complete fields and constraints.

← Contractor hiring operations · All schemas

Attach a file to contract — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataJSONRequired within parentThis object is used for linking file attachments to your records.
data (anyOf 1)ModelAlternativeExpand Attach a file to contract — 201 response body — data filename, key
data (anyOf 2)nullAlternative

Referenced models: Attach a file to contract — 201 response body — data filename, key

Attach a file to contract — 201 response body — data filename, key

FieldTypePresenceDescription and constraints
$objectRootThis object is used for linking file attachments to your records.
filenamestringRequired within parentOriginal filename you used to upload using attachments end-point.
keystringRequired within parentYou can call attachments end-point, get key and URL to upload your file.

Create contract signature — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Create contract signature — 201 response body — data

Referenced models: Create contract signature — 201 response body — data

Create contract signature — 201 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
createdbooleanRequired within parentWhether the contract (or pending amendment) was successfully signed.

Create contract signature — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
client_signaturestringRequired within parentSignature of client.
Minimum length: 2
contract_template_idJSONOptionalPlease use null to use default Deel contract template; otherwise you can use the template you created and customized. If template ID is not in payload, template stays unchanged.
contract_template_id (oneOf 1)ModelAlternativeExpand Create contract signature — request body — body data contract template id value
contract_template_id (oneOf 2)nullAlternative

Referenced models: Create contract signature — request body — body data contract template id value

Create contract signature — request body — body data contract template id value

FieldTypePresenceDescription and constraints
$JSONRootPlease use null to use default Deel contract template; otherwise you can use the template you created and customized. If template ID is not in payload, template stays unchanged.
$ (oneOf 1)numberAlternativeFormat: double
$ (oneOf 2)stringAlternative

Get worker invite link — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
datastringRequired within parent

Remove invite — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Remove invite — 200 response body — data

Referenced models: Remove invite — 200 response body — data

Remove invite — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
deletedbooleanRequired within parentConfirms the deletion.

Retrieve contractor payment dates — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Retrieve contractor payment dates — 200 response body — data item

Referenced models: Retrieve contractor payment dates — 200 response body — data item

Retrieve contractor payment dates — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
due_datestringRequired within parentThe date and time when the payment is due.
Format: date-time
idstringRequired within parentUnique identifier for the payment.
Format: uuid
statusstringRequired within parentThe current status of the payment cycle.
Known values: active, upcoming, awaiting_payment, overdue, awaiting_invoice_submission, completed

Send contract to worker — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
emailstringOptionalWorker email
Format: email
localestringOptionalLocale of the email
Default: en
One of: en, es, fr, de, it, pt, pl, nn, nl, da, deAT, fi, sv, nlBE, ja
messagestringOptionalMessage to the worker

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.