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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | JSON | Required within parent | This object is used for linking file attachments to your records. |
data (anyOf 1) | Model | Alternative | Expand Attach a file to contract — 201 response body — data filename, key |
data (anyOf 2) | null | Alternative |
Referenced models: Attach a file to contract — 201 response body — data filename, key
Attach a file to contract — 201 response body — data filename, key
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object is used for linking file attachments to your records. |
filename | string | Required within parent | Original filename you used to upload using attachments end-point. |
key | string | Required within parent | You can call attachments end-point, get key and URL to upload your file. |
Create contract signature — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Create contract signature — 201 response body — data |
Referenced models: Create contract signature — 201 response body — data
Create contract signature — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created | boolean | Required within parent | Whether the contract (or pending amendment) was successfully signed. |
Create contract signature — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
client_signature | string | Required within parent | Signature of client. Minimum length: 2 |
contract_template_id | JSON | Optional | Please 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) | Model | Alternative | Expand Create contract signature — request body — body data contract template id value |
contract_template_id (oneOf 2) | null | Alternative |
Referenced models: Create contract signature — request body — body data contract template id value
Create contract signature — request body — body data contract template id value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Please 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) | number | Alternative | Format: double |
$ (oneOf 2) | string | Alternative |
Get worker invite link — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | string | Required within parent |
Remove invite — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Remove invite — 200 response body — data |
Referenced models: Remove invite — 200 response body — data
Remove invite — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
deleted | boolean | Required within parent | Confirms the deletion. |
Retrieve contractor payment dates — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
due_date | string | Required within parent | The date and time when the payment is due. Format: date-time |
id | string | Required within parent | Unique identifier for the payment. Format: uuid |
status | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
email | string | Optional | Worker email Format: email |
locale | string | Optional | Locale of the email Default: en One of: en, es, fr, de, it, pt, pl, nn, nl, da, deAT, fi, sv, nlBE, ja |
message | string | Optional | Message to the worker |