Deel: Contracts schemas (part 1)
82 Deel schemas with complete fields and constraints.
← Contracts operations · All schemas
Add external Id — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
client | JSON | Required within parent | Client details associated with the contract. |
client (anyOf 1) | Model | Alternative | Expand Add external Id — 200 response body — client Client details associated with the contract |
client (anyOf 2) | null | Alternative | |
compensation_details | Model | Optional | Expand Add external Id — 200 response body — compensation details Compensation and payment configuration for the contract. |
contract_template | JSON | Optional | Contract template details. |
contract_template (anyOf 1) | Model | Alternative | Expand Add external Id — 200 response body — contract template Contract template details |
contract_template (anyOf 2) | null | Alternative | |
cost_centers | array | Optional | List of cost centers associated with the contract. |
cost_centers[] | Model | Each item | Expand Add external Id — 200 response body — cost centers item |
created_at | string | Required within parent | Date and time when the contract was created. Format: date-time |
custom_fields | JSON | Optional | |
custom_fields (anyOf 1) | array | Alternative | List of custom fields attached to the contract. |
custom_fields (anyOf 1)[] | Model | Each item | Expand Create a new contract — 201 response body — data custom fields item |
custom_fields (anyOf 2) | null | Alternative | List of custom fields attached to the contract. |
custom_fields (anyOf 2)[] | Model | Each item | Expand Create a new contract — 201 response body — data custom fields item |
employment_details | Model | Optional | Expand Add external Id — 200 response body — employment details Employment-related details for the contract. |
employment_type | JSON | Optional | Type of employment. |
employment_type (anyOf 1) | string | Alternative | Type of employment. Known values: FULL_TIME, PART_TIME |
employment_type (anyOf 2) | null | Alternative | |
external_id | JSON | Optional | |
external_id (anyOf 1) | string | Alternative | External identifier of the contract. |
external_id (anyOf 2) | null | Alternative | External identifier of the contract. |
id | string | Required within parent | Unique identifier for the contract. Minimum length: 1 |
invitations | Model | Required within parent | Expand Add external Id — 200 response body — invitations Invitation email addresses for signing the contract. |
is_archived | JSON | Required within parent | |
is_archived (anyOf 1) | boolean | Alternative | Flag to indicate if the contract is archived. |
is_archived (anyOf 2) | null | Alternative | Flag to indicate if the contract is archived. |
job_title | string | Optional | Job title associated with the contract. |
notice_period | JSON | Optional | |
notice_period (anyOf 1) | JSON | Alternative | |
notice_period (anyOf 1) (anyOf 1) | number | Alternative | Notice period in days. Format: double |
notice_period (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
notice_period (anyOf 2) | null | Alternative | Notice period in days. Format: double |
quote | Model | Optional | Expand Add external Id — 200 response body — quote EOR quote approved by Deel. |
scope_of_work | JSON | Optional | |
scope_of_work (anyOf 1) | string | Alternative | Scope of work of the contract. |
scope_of_work (anyOf 2) | null | Alternative | Scope of work of the contract. |
seniority | JSON | Optional | Seniority describes level of expertise at a job e.g. junior. |
seniority (anyOf 1) | Model | Alternative | Expand Add external Id — 200 response body — seniority id, level, name |
seniority (anyOf 2) | null | Alternative | |
signatures | Model | Required within parent | Expand Add external Id — 200 response body — signatures Signature information for the contract parties. |
special_clause | JSON | Required within parent | |
special_clause (anyOf 1) | string | Alternative | Special clause of the contract. |
special_clause (anyOf 2) | null | Alternative | Special clause of the contract. |
start_date | string | Required within parent | Date and time when the contract starts. Format: date-time |
status | Model | Required within parent | Expand Add external Id — 200 response body — status Status of a contract in Deel workflow. |
termination_date | JSON | Required within parent | |
termination_date (anyOf 1) | string | Alternative | Date and time when the contract ends. |
termination_date (anyOf 2) | null | Alternative | Date and time when the contract ends. |
title | string | Required within parent | Title of the contract. Minimum length: 1 |
type | string | Required within parent | Type of a contract. Known values: ongoing_time_based, milestones, time_based, pay_as_you_go_time_based, commission, payg_milestones, payg_tasks, contractor_outside_deel, eor, unknown, employee, global_payroll, shield_msa, hris_direct_employee, peo |
updated_at | string | Required within parent | Date and time when the contract was updated. Format: date-time |
who_reports | string | Optional | Who reports the hours. |
work_schedule | JSON | Optional | Defines a work schedule including working days, hours, and employment details |
work_schedule (anyOf 1) | Model | Alternative | Expand Add external Id — 200 response body — work schedule country, days, employment type, name, work hours per week, work schedule type, worker types |
work_schedule (anyOf 2) | null | Alternative | |
work_statement_id | JSON | Optional | |
work_statement_id (anyOf 1) | string | Alternative | The unique identifier of the associated work statement. |
work_statement_id (anyOf 2) | null | Alternative | The unique identifier of the associated work statement. |
worker | JSON | Required within parent | Worker details associated with the contract. |
worker (anyOf 1) | Model | Alternative | Expand Add external Id — 200 response body — worker Worker details associated with the contract |
worker (anyOf 2) | null | Alternative |
Referenced models: Add external Id — 200 response body — contract template Contract template details, Create a new contract — 201 response body — data custom fields item, Add external Id — 200 response body — compensation details, Add external Id — 200 response body — cost centers item, Add external Id — 200 response body — invitations, Add external Id — 200 response body — quote, Add external Id — 200 response body — seniority id, level, name, Add external Id — 200 response body — signatures, Add external Id — 200 response body — status, Add external Id — 200 response body — client Client details associated with the contract, Add external Id — 200 response body — employment details, Add external Id — 200 response body — work schedule country, days, employment type, name, work hours per week, work schedule type, worker types, Add external Id — 200 response body — worker Worker details associated with the contract
Add external Id — 200 response body — client Client details associated with the contract
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Client details associated with the contract. |
email | JSON | Optional | |
email (anyOf 1) | string | Alternative | User's email address. It can be an empty string when no email has been provided for the worker. This can happen for draft contracts or workers with incomplete onboarding. |
email (anyOf 2) | null | Alternative | User's email address. It can be an empty string when no email has been provided for the worker. This can happen for draft contracts or workers with incomplete onboarding. |
full_name | string | Optional | Full name of the client. |
id | string | Optional | Unique identifier of this resource. |
legal_entity | JSON | Optional | Legal entity details of the client. |
legal_entity (anyOf 1) | Model | Alternative | Expand Add external Id — 200 response body — client Client details associated with the contract legal entity Legal entity details of the client |
legal_entity (anyOf 2) | null | Alternative | |
team | Model | Required within parent | Expand Add external Id — 200 response body — client Client details associated with the contract team Team information for the client organization. |
Referenced models: Add external Id — 200 response body — client Client details associated with the contract legal entity Legal entity details of the client, Add external Id — 200 response body — client Client details associated with the contract team
Add external Id — 200 response body — client Client details associated with the contract legal entity Legal entity details of the client
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Legal entity details of the client. |
email | JSON | Optional | |
email (anyOf 1) | string | Alternative | Email address of the legal entity. |
email (anyOf 2) | null | Alternative | Email address of the legal entity. |
id | string | Optional | Unique identifier of this resource. |
name | string | Optional | Name of a team. |
registration_number | JSON | Optional | |
registration_number (anyOf 1) | string | Alternative | Registration number of the legal entity. |
registration_number (anyOf 2) | null | Alternative | Registration number of the legal entity. |
subtype | JSON | Optional | |
subtype (anyOf 1) | string | Alternative | Sub-type of the legal entity. |
subtype (anyOf 2) | null | Alternative | Sub-type of the legal entity. |
type | JSON | Optional | |
type (anyOf 1) | string | Alternative | Type of the legal entity. |
type (anyOf 2) | null | Alternative | Type of the legal entity. |
vat_number | JSON | Optional | |
vat_number (anyOf 1) | string | Alternative | VAT number of the legal entity. |
vat_number (anyOf 2) | null | Alternative | VAT number of the legal entity. |
Add external Id — 200 response body — client Client details associated with the contract team
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Team information for the client organization. |
id | Model | Required within parent | Expand Add external Id — 200 response body — client Client details associated with the contract team id Unique identifier of this resource. |
name | string | Required within parent | Name of a team. |
Referenced models: Add external Id — 200 response body — client Client details associated with the contract team id
Add external Id — 200 response body — client Client details associated with the contract team id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Unique identifier of this resource. |
$ (anyOf 1) | string | Alternative | |
$ (anyOf 2) | JSON | Alternative | |
$ (anyOf 2) (anyOf 1) | number | Alternative | Format: double |
$ (anyOf 2) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Add external Id — 200 response body — compensation details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Compensation and payment configuration for the contract. |
amount | JSON | Optional | |
amount (anyOf 1) | string | Alternative | Amount to be paid. This field can be excluded when creating a Pay-as-you-go task-based or Milestone contracts. |
amount (anyOf 2) | null | Alternative | Amount to be paid. This field can be excluded when creating a Pay-as-you-go task-based or Milestone contracts. |
currency_code | JSON | Optional | |
currency_code (anyOf 1) | string | Alternative | Currency code. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
currency_code (anyOf 2) | null | Alternative | Currency code. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
cycle_end | JSON | Optional | |
cycle_end (anyOf 1) | JSON | Alternative | |
cycle_end (anyOf 1) (anyOf 1) | number | Alternative | Day of the cycle end Format: double |
cycle_end (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
cycle_end (anyOf 2) | null | Alternative | Day of the cycle end Format: double |
cycle_end_type | JSON | Optional | Cycle end type |
cycle_end_type (anyOf 1) | string | Alternative | Cycle end type Known values: DAY_OF_WEEK, DAY_OF_LAST_WEEK, DAY_OF_MONTH |
cycle_end_type (anyOf 2) | null | Alternative | |
first_payment | JSON | Optional | |
first_payment (anyOf 1) | string | Alternative | First payment amount. |
first_payment (anyOf 2) | null | Alternative | First payment amount. |
first_payment_date | JSON | Optional | |
first_payment_date (anyOf 1) | string | Alternative | First payment date. |
first_payment_date (anyOf 2) | null | Alternative | First payment date. |
frequency | string | Optional | Scale of the invoice cycle. |
gross_annual_salary | JSON | Optional | |
gross_annual_salary (anyOf 1) | string | Alternative | Gross annual salary. |
gross_annual_salary (anyOf 2) | null | Alternative | Gross annual salary. |
gross_signing_bonus | JSON | Optional | |
gross_signing_bonus (anyOf 1) | string | Alternative | Gross signing bonus. |
gross_signing_bonus (anyOf 2) | null | Alternative | Gross signing bonus. |
gross_variable_bonus | JSON | Optional | |
gross_variable_bonus (anyOf 1) | string | Alternative | Gross variable bonus. |
gross_variable_bonus (anyOf 2) | null | Alternative | Gross variable bonus. |
scale | JSON | Optional | |
scale (anyOf 1) | string | Alternative | Scale of the payment. |
scale (anyOf 2) | null | Alternative | Scale of the payment. |
Add external Id — 200 response body — contract template Contract template details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contract template details. |
id | string | Optional | Unique identifier of a contract template. |
title | string | Optional | Title of a contract template |
Add external Id — 200 response body — cost centers item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
allocation_percentage | JSON | Optional | |
allocation_percentage (anyOf 1) | number | Alternative | Percentage of the cost center allocation. Format: double |
allocation_percentage (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
name | string | Optional | Cost center name. |
number | string | Optional | Cost center number. |
Add external Id — 200 response body — employment details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Employment-related details for the contract. |
days_per_week | JSON | Optional | |
days_per_week (anyOf 1) | number | Alternative | Number of days per week. Format: double |
days_per_week (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
hours_per_day | JSON | Optional | |
hours_per_day (anyOf 1) | number | Alternative | Number of hours per day. Format: double |
hours_per_day (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
paid_vacation_days | JSON | Optional | |
paid_vacation_days (anyOf 1) | number | Alternative | Number of paid vacation days. Format: double |
paid_vacation_days (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
probation_period | JSON | Optional | |
probation_period (anyOf 1) | JSON | Alternative | |
probation_period (anyOf 1) (anyOf 1) | number | Alternative | Probation period in days. Format: double |
probation_period (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
probation_period (anyOf 2) | null | Alternative | Probation period in days. Format: double |
type | string | Optional | Type of employment. |
Add external Id — 200 response body — invitations
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Invitation email addresses for signing the contract. |
client_email | JSON | Optional | |
client_email (anyOf 1) | string | Alternative | User's email address. |
client_email (anyOf 2) | null | Alternative | User's email address. |
worker_email | JSON | Optional | |
worker_email (anyOf 1) | string | Alternative | User's email address. |
worker_email (anyOf 2) | null | Alternative | User's email address. |
Add external Id — 200 response body — quote
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | EOR quote approved by Deel. |
benefits | array | Optional | Array of benefits. |
benefits[] | Model | Each item | Expand Add external Id — 200 response body — quote benefits item |
currency | string | Optional | Currency used for the quote. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
Referenced models: Add external Id — 200 response body — quote benefits item
Add external Id — 200 response body — quote benefits item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
currency | string | Optional | Currency code. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
fee | JSON | Optional | |
fee (anyOf 1) | number | Alternative | Fee in local currency. Format: double |
fee (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
fee_usd | JSON | Optional | |
fee_usd (anyOf 1) | number | Alternative | Fee in USD. Format: double |
fee_usd (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
name | string | Optional | Benefit's name. |
plan | string | Optional | Benefit's plan. |
price | JSON | Optional | |
price (anyOf 1) | number | Alternative | Price in local currency. Format: double |
price (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
price_usd | JSON | Optional | |
price_usd (anyOf 1) | number | Alternative | Price in USD. Format: double |
price_usd (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Add external Id — 200 response body — seniority id, level, name
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Seniority describes level of expertise at a job e.g. junior. |
id | JSON | Optional | |
id (anyOf 1) | JSON | Alternative | |
id (anyOf 1) (anyOf 1) | number | Alternative | Unique identifier of this resource. Format: double |
id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id (anyOf 2) | null | Alternative | Unique identifier of this resource. Format: double |
level | JSON | Optional | |
level (anyOf 1) | JSON | Alternative | |
level (anyOf 1) (anyOf 1) | number | Alternative | Level of seniority level e.g. 2. Format: double |
level (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
level (anyOf 2) | null | Alternative | Level of seniority level e.g. 2. Format: double |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | Name of seniority level e.g. Mid (Individual Contributor Level 2). |
name (anyOf 2) | null | Alternative | Name of seniority level e.g. Mid (Individual Contributor Level 2). |
Add external Id — 200 response body — signatures
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Signature information for the contract parties. |
client_signature | string | Optional | Client representative signature (typically a name). |
client_signed_at | JSON | Optional | |
client_signed_at (anyOf 1) | string | Alternative | Date and time when the client signed the contract. Format: date-time |
client_signed_at (anyOf 2) | null | Alternative | Date and time when the client signed the contract. Format: date-time |
signed_at | JSON | Optional | |
signed_at (anyOf 1) | string | Alternative | Date and time when the contract was signed. Format: date-time |
signed_at (anyOf 2) | null | Alternative | Date and time when the contract was signed. Format: date-time |
worker_signature | string | Optional | Worker signature (typically a name). |
worker_signed_at | JSON | Optional | |
worker_signed_at (anyOf 1) | string | Alternative | Date and time when the worker signed the contract. Format: date-time |
worker_signed_at (anyOf 2) | null | Alternative | Date and time when the worker signed the contract. Format: date-time |
Add external Id — 200 response body — status
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Status of a contract in Deel workflow. Known values: new, under_review, waiting_for_employee_contract, waiting_for_client_sign, processing_payment, waiting_for_contractor_sign, waiting_for_eor_sign, waiting_for_employee_sign, awaiting_deposit_payment, in_progress, completed, cancelled, user_cancelled, rejected, waiting_for_client_payment, onboarding, waiting_for_approval, onboarded |
Add external Id — 200 response body — work schedule country, days, employment type, name, work hours per week, work schedule type, worker types
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Defines a work schedule including working days, hours, and employment details |
country | string | Required within parent | Country code where this work schedule applies (ISO 3166-1 alpha-2) Pattern: ^[A-Z]{2}$ |
days | array | Required within parent | Working days and hours configuration |
days[] | Model | Each item | Expand Add external Id — 200 response body — work schedule country, days, employment type, name, work hours per week, work schedule type, worker types days item |
employment_type | JSON | Optional | Type of employment arrangement |
employment_type (anyOf 1) | string | Alternative | Type of employment arrangement Known values: FULL_TIME, PART_TIME, CONTRACT, TEMPORARY |
employment_type (anyOf 2) | null | Alternative | |
name | string | Required within parent | Unique identifier or name for the work schedule Maximum length: 50 |
work_hours_per_week | JSON | Required within parent | |
work_hours_per_week (anyOf 1) | integer | Alternative | Total number of working hours per week Maximum: 168 Minimum: 1 |
work_hours_per_week (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
work_schedule_type | string | Required within parent | Work schedule type |
worker_types | array | Required within parent | List of worker types that can use this schedule |
worker_types[] | string | Each item | Known values: SALARIED_DIRECT_EMPLOYEE_PAYROLL, SALARIED_HRIS_DIRECT_EMPLOYEE, SALARIED_EOR_EMPLOYEE, HOURLY_EOR_EMPLOYEE, HOURLY_DIRECT_EMPLOYEE_PAYROLL |
Referenced models: Add external Id — 200 response body — work schedule country, days, employment type, name, work hours per week, work schedule type, worker types days item
Add external Id — 200 response body — work schedule country, days, employment type, name, work hours per week, work schedule type, worker types days item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Defines working hours for a specific day of the week |
day | string | Required within parent | Day of the week Known values: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY |
end | JSON | Required within parent | |
end (anyOf 1) | string | Alternative | End time for the work day (HH:MM:SS format, local time without offset) Pattern: ^([01]?[0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]$ |
end (anyOf 2) | null | Alternative | End time for the work day (HH:MM:SS format, local time without offset) Pattern: ^([01]?[0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]$ |
start | string | Required within parent | Start time for the work day (HH:MM:SS format, local time without offset) Pattern: ^([01]?[0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]$ |
work_hours | string | Required within parent | Number of working hours for this day |
Add external Id — 200 response body — worker Worker details associated with the contract
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Worker details associated with the contract. |
alternate_email | JSON | Optional | |
alternate_email (anyOf 1) | array | Alternative | List of alternate email addresses. |
alternate_email (anyOf 1)[] | Model | Each item | Expand Add external Id — 200 response body — worker Worker details associated with the contract alternate email List of alternate email addresses item |
alternate_email (anyOf 2) | null | Alternative | List of alternate email addresses. |
alternate_email (anyOf 2)[] | Model | Each item | Expand Add external Id — 200 response body — worker Worker details associated with the contract alternate email List of alternate email addresses item |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | Country of the worker. |
country (anyOf 2) | null | Alternative | Country of the worker. |
date_of_birth | Model | Optional | Expand Add external Id — 200 response body — worker Worker details associated with the contract date of birth Date of birth of the worker. Supports full date-time, date-only, or an empty string. |
email | JSON | Optional | |
email (anyOf 1) | string | Alternative | User's email address. Format: email Minimum length: 5 |
email (anyOf 2) | null | Alternative | User's email address. Format: email Minimum length: 5 |
expected_email | string | Optional | Expected email address of the worker (e.g., invitation target email). |
first_name | string | Optional | First name of the worker. |
full_name | string | Optional | Full name of the client. |
id | string | Optional | Unique identifier of this resource. |
last_name | string | Optional | Last name of the worker. |
nationality | JSON | Optional | |
nationality (anyOf 1) | string | Alternative | Nationality of the worker. |
nationality (anyOf 2) | null | Alternative | Nationality of the worker. |
Referenced models: Add external Id — 200 response body — worker Worker details associated with the contract alternate email List of alternate email addresses item, Add external Id — 200 response body — worker Worker details associated with the contract date of birth
Add external Id — 200 response body — worker Worker details associated with the contract alternate email List of alternate email addresses item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
email | string | Optional | Email address of the worker. |
isVerified | boolean | Optional | Indicates whether this alternate email address has been verified. |
Add external Id — 200 response body — worker Worker details associated with the contract date of birth
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Date of birth of the worker. Supports full date-time, date-only, or an empty string. |
$ (anyOf 1) | string | Alternative | Format: date-time |
$ (anyOf 2) | string | Alternative | Format: date |
$ (anyOf 3) | string | Alternative | Empty string for unknown/unset values. Known values: "" (empty string) |
Add external Id — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
external_id | string or null | Required within parent | A unique identifier for the object provided by an external system. Use or send null when you want to reset the external id. |
Approve an equity exercise — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | The date when the equity exercise was created. Format: date |
employer_approval | string | Required within parent | Indicates whether the employer has approved the equity exercise. Valid values: 'approved', 'rejected'. |
id | string | Required within parent | Unique identifier of the equity exercise. Format: uuid |
status | string | Required within parent | The current status of the equity exercise, e.g., 'approved' or 'pending'. |
updated_at | string | Required within parent | The date when the equity exercise was last updated. Format: date |
Create a new contract — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Create a new contract — 201 response body — data |
Referenced models: Create a new contract — 201 response body — data
Create a new contract — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
client | JSON | Required within parent | Client details associated with the contract. |
client (anyOf 1) | Model | Alternative | Expand Create a new contract — 201 response body — data client Client details associated with the contract |
client (anyOf 2) | null | Alternative | |
compensation_details | Model | Required within parent | Expand Create a new contract — 201 response body — data compensation details Compensation configuration and payment schedule details for the contract. |
created_at | JSON | Required within parent | |
created_at (anyOf 1) | string | Alternative | Long date-time format following ISO-8601 Format: date-time |
created_at (anyOf 2) | null | Alternative | Long date-time format following ISO-8601 Format: date-time |
custom_fields | array | Optional | Custom fields attached to the contract. |
custom_fields[] | Model | Each item | Expand Create a new contract — 201 response body — data custom fields item |
employment_details | Model | Required within parent | Expand Create a new contract — 201 response body — data employment details Employment-related details for the contract, when applicable. |
external_id | JSON | Optional | |
external_id (anyOf 1) | string | Alternative | A unique identifier for the object provided by an external system. |
external_id (anyOf 2) | null | Alternative | A unique identifier for the object provided by an external system. |
id | string | Required within parent | The public id of the object |
invitations | Model | Required within parent | Expand Create a new contract — 201 response body — data invitations List of signature invitations sent for this contract. |
is_archived | boolean | Required within parent | Flag to indicate if the contract is archived |
job_title | string | Required within parent | Job title associated with the contract. |
notice_period | JSON | Optional | |
notice_period (anyOf 1) | number | Alternative | Days before to notice the termination of contract for either party. Default: 10 Format: double Minimum: 0 |
notice_period (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
platform_payment_type | string | Optional | Whether the contract is paid through Deel (`STANDARD`) or outside Deel (`OFF_PLATFORM`). Applies to IC contracts only. Known values: STANDARD, OFF_PLATFORM |
quote | Model | Optional | Expand Create a new contract — 201 response body — data quote EOR quote approved by Deel |
scope_of_work | JSON | Optional | |
scope_of_work (anyOf 1) | string | Alternative | Scope of work for the contract |
scope_of_work (anyOf 2) | null | Alternative | Scope of work for the contract |
seniority | JSON | Optional | Seniority describes level of expertise at a job e.g. junior |
seniority (anyOf 1) | Model | Alternative | Expand Create a new contract — 201 response body — data seniority id, level, name |
seniority (anyOf 2) | null | Alternative | |
signatures | Model | Required within parent | Expand Create a new contract — 201 response body — data signatures List of signatures recorded for this contract. |
special_clause | string | Required within parent | Special clause for the contract |
start_date | JSON | Required within parent | |
start_date (anyOf 1) | string | Alternative | Long date-time format following ISO-8601 Format: date-time |
start_date (anyOf 2) | null | Alternative | Long date-time format following ISO-8601 Format: date-time |
status | string | Required within parent | Status of a contract in Deel workflow Known values: new, under_review, waiting_for_employee_contract, waiting_for_client_sign, processing_payment, waiting_for_contractor_sign, waiting_for_eor_sign, waiting_for_employee_sign, awaiting_deposit_payment, in_progress, completed, cancelled, user_cancelled, rejected, waiting_for_client_payment |
termination_date | Model | Required within parent | Expand Create a new contract — 201 response body — data termination date Contract termination date. When present, it is a date-time string in ISO-8601 format. |
title | string | Required within parent | Title of a contract Minimum length: 1 |
type | string | Required within parent | Type of a contract Known values: ongoing_time_based, milestones, time_based, pay_as_you_go_time_based, commission, payg_milestones, payg_tasks, eor, unknown, employee, global_payroll, shield_msa, hris_direct_employee |
who_reports | string | Optional | Flag to indicate who is supposed to provide regular reports Known values: both, client, contractor, "" (empty string) |
work_statement_id | string | Required within parent | The public unique identifier of the work statement |
worker | JSON | Required within parent | Worker details associated with the contract. |
worker (anyOf 1) | Model | Alternative | Expand Create a new contract — 201 response body — data worker Worker details associated with the contract |
worker (anyOf 2) | null | Alternative |
Referenced models: Create a new contract — 201 response body — data custom fields item, Create a new contract — 201 response body — data client Client details associated with the contract, Create a new contract — 201 response body — data compensation details, Create a new contract — 201 response body — data employment details, Create a new contract — 201 response body — data invitations, Create a new contract — 201 response body — data quote, Create a new contract — 201 response body — data seniority id, level, name, Create a new contract — 201 response body — data signatures, Create a new contract — 201 response body — data termination date, Create a new contract — 201 response body — data worker Worker details associated with the contract
Create a new contract — 201 response body — data / client / Client details associated with the contract / legal_entity / type: individual, company
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Legal entity information for the client organization. |
email | JSON | Required within parent | |
email (anyOf 1) | string | Alternative | User's email address. |
email (anyOf 2) | null | Alternative | User's email address. |
id | string | Required within parent | Unique identifier of this resource. |
name | string | Required within parent | Name of a legal entity |
registration_number | string | Required within parent | Registration number of a legal entity |
subtype | string | Required within parent | Subtype of a legal entity |
type | string | Required within parent | Type of a legal entity Known values: individual, company |
vat_number | string | Required within parent | VAT number of a legal entity |
Create a new contract — 201 response body — data client Client details associated with the contract
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Client details associated with the contract. |
email | JSON | Optional | |
email (anyOf 1) | string | Alternative | User's email address. Format: email Minimum length: 5 |
email (anyOf 2) | null | Alternative | User's email address. Format: email Minimum length: 5 |
full_name | string | Optional | User's full name. |
id | string | Optional | Unique identifier of this resource. |
legal_entity | JSON | Required within parent | Legal entity information for the client organization. |
legal_entity (anyOf 1) | Model | Alternative | Expand Create a new contract — 201 response body — data / client / Client details associated with the contract / legal_entity / type: individual, company |
legal_entity (anyOf 2) | null | Alternative | |
team | Model | Required within parent | Expand Create a new contract — 201 response body — data client Client details associated with the contract team Team information for the client organization. |
Referenced models: Create a new contract — 201 response body — data client Client details associated with the contract team, Create a new contract — 201 response body — data / client / Client details associated with the contract / legal_entity / type: individual, company
Create a new contract — 201 response body — data client Client details associated with the contract team
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Team information for the client organization. |
id | string | Required within parent | Unique identifier of this resource. |
name | string | Required within parent | Name of a team |
Create a new contract — 201 response body — data compensation details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Compensation configuration and payment schedule details for the contract. |
amount | JSON | Required within parent | |
amount (anyOf 1) | string | Alternative | Amount of compensation |
amount (anyOf 2) | null | Alternative | Amount of compensation |
currency_code | string | Required within parent | Currency code. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
first_payment | JSON | Required within parent | |
first_payment (anyOf 1) | string | Alternative | First payment |
first_payment (anyOf 2) | null | Alternative | First payment |
first_payment_date | JSON | Required within parent | |
first_payment_date (anyOf 1) | string | Alternative | Long date-time format following ISO-8601 |
first_payment_date (anyOf 2) | null | Alternative | Long date-time format following ISO-8601 |
frequency | string | Required within parent | Frequency of compensation |
gross_annual_salary | JSON | Required within parent | |
gross_annual_salary (anyOf 1) | string | Alternative | Gross annual salary |
gross_annual_salary (anyOf 2) | null | Alternative | Gross annual salary |
gross_signing_bonus | JSON | Required within parent | |
gross_signing_bonus (anyOf 1) | string | Alternative | Gross signing bonus |
gross_signing_bonus (anyOf 2) | null | Alternative | Gross signing bonus |
gross_variable_bonus | JSON | Required within parent | |
gross_variable_bonus (anyOf 1) | string | Alternative | Gross variable bonus |
gross_variable_bonus (anyOf 2) | null | Alternative | Gross variable bonus |
scale | string | Required within parent | Scale of compensation |
Create a new contract — 201 response body — data custom fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Customized attributes on contracts (Employee ID, Project code, etc). |
name | string | Optional | Custom field property name. |
value | string | Optional | Custom field property value. |
Create a new contract — 201 response body — data employment details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Employment-related details for the contract, when applicable. |
country | string | Optional | Country code. Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
days_per_week | JSON | Required within parent | |
days_per_week (anyOf 1) | number | Alternative | Number of days per week Format: double |
days_per_week (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
hours_per_day | JSON | Required within parent | |
hours_per_day (anyOf 1) | number | Alternative | Number of hours per day Format: double |
hours_per_day (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
non_compete_clause | JSON | Optional | |
non_compete_clause (anyOf 1) | boolean | Alternative | Non-compete clause state on the active EOR SOW. Null when not yet populated. |
non_compete_clause (anyOf 2) | null | Alternative | Non-compete clause state on the active EOR SOW. Null when not yet populated. |
non_solicitation_clause | JSON | Optional | |
non_solicitation_clause (anyOf 1) | boolean | Alternative | Non-solicitation clause state on the active EOR SOW. Null when not yet populated. |
non_solicitation_clause (anyOf 2) | null | Alternative | Non-solicitation clause state on the active EOR SOW. Null when not yet populated. |
paid_vacation_days | JSON | Required within parent | |
paid_vacation_days (anyOf 1) | number | Alternative | Number of paid vacation days Format: double |
paid_vacation_days (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
probation_period | JSON | Required within parent | |
probation_period (anyOf 1) | JSON | Alternative | |
probation_period (anyOf 1) (anyOf 1) | number | Alternative | Number of days for probation period Format: double |
probation_period (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
probation_period (anyOf 2) | null | Alternative | Number of days for probation period Format: double |
state | JSON | Optional | |
state (anyOf 1) | string | Alternative | State code. |
state (anyOf 2) | null | Alternative | State code. |
type | string | Required within parent | Employment type classification for the contract. |
Create a new contract — 201 response body — data invitations
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | List of signature invitations sent for this contract. |
client_email | JSON | Optional | |
client_email (anyOf 1) | string | Alternative | User's email address. |
client_email (anyOf 2) | null | Alternative | User's email address. |
worker_email | JSON | Optional | |
worker_email (anyOf 1) | string | Alternative | User's email address. |
worker_email (anyOf 2) | null | Alternative | User's email address. |
Create a new contract — 201 response body — data quote
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | EOR quote approved by Deel |
annual_salary | JSON | Optional | |
annual_salary (anyOf 1) | number | Alternative | Annual Salary in local currency Format: double |
annual_salary (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
benefits | array | Optional | Array of benefits |
benefits[] | Model | Each item | Expand Create a new contract — 201 response body — data quote benefits item |
breakdown_costs | Model | Optional | Expand Create a new contract — 201 response body — data quote breakdown costs Cost breakdown for the quote, grouped by billing cadence (e.g., monthly). |
cba_total | JSON | Optional | |
cba_total (anyOf 1) | number | Alternative | Total CBA in local currency Format: double |
cba_total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
cba_total_usd | JSON | Optional | |
cba_total_usd (anyOf 1) | number | Alternative | Total CBA in USD Format: double |
cba_total_usd (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
created_at | JSON | Optional | |
created_at (anyOf 1) | string | Alternative | Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31. Format: date Pattern: ^\d{4}-\d{2}-\d{2}$ |
created_at (anyOf 2) | null | Alternative | Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31. Format: date Pattern: ^\d{4}-\d{2}-\d{2}$ |
currency | string | Optional | Currency code. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
employer_cost_total | JSON | Optional | |
employer_cost_total (anyOf 1) | number | Alternative | Total employer cost in local currency Format: double |
employer_cost_total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
employer_cost_total_usd | JSON | Optional | |
employer_cost_total_usd (anyOf 1) | number | Alternative | Total employer cost in USD Format: double |
employer_cost_total_usd (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
gross_salary_total | JSON | Optional | |
gross_salary_total (anyOf 1) | number | Alternative | Total gross salary in local currency Format: double |
gross_salary_total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
gross_salary_total_usd | JSON | Optional | |
gross_salary_total_usd (anyOf 1) | number | Alternative | Total gross salary in USD Format: double |
gross_salary_total_usd (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
mobility_fee_total | JSON | Optional | |
mobility_fee_total (anyOf 1) | number | Alternative | Total mobility fee in local currency Format: double |
mobility_fee_total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
mobility_fee_total_usd | JSON | Optional | |
mobility_fee_total_usd (anyOf 1) | number | Alternative | Total mobility fee in USD Format: double |
mobility_fee_total_usd (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
monthly_cost_total | JSON | Optional | |
monthly_cost_total (anyOf 1) | number | Alternative | Total monthly cost in local currency Format: double |
monthly_cost_total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
monthly_cost_total_usd | JSON | Optional | |
monthly_cost_total_usd (anyOf 1) | number | Alternative | Total monthly cost in USD Format: double |
monthly_cost_total_usd (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
platform_fee_total | JSON | Optional | |
platform_fee_total (anyOf 1) | number | Alternative | Total platform fee in local currency Format: double |
platform_fee_total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
platform_fee_total_usd | JSON | Optional | |
platform_fee_total_usd (anyOf 1) | number | Alternative | Total platform fee in USD Format: double |
platform_fee_total_usd (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
recurring_allowance_total | JSON | Optional | |
recurring_allowance_total (anyOf 1) | number | Alternative | Total recurring allowance in local currency Format: double |
recurring_allowance_total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
recurring_allowance_total_usd | JSON | Optional | |
recurring_allowance_total_usd (anyOf 1) | number | Alternative | Total recurring allowance in USD Format: double |
recurring_allowance_total_usd (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
salary_total | JSON | Optional | |
salary_total (anyOf 1) | number | Alternative | Total salary in local currency Format: double |
salary_total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
salary_total_usd | JSON | Optional | |
salary_total_usd (anyOf 1) | number | Alternative | Total salary in USD Format: double |
salary_total_usd (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
severance_accrual_total | JSON | Optional | |
severance_accrual_total (anyOf 1) | number | Alternative | Total severance accrual in local currency Format: double |
severance_accrual_total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
severance_accrual_total_usd | JSON | Optional | |
severance_accrual_total_usd (anyOf 1) | number | Alternative | Total severance accrual in USD Format: double |
severance_accrual_total_usd (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
updated_at | JSON | Optional | |
updated_at (anyOf 1) | string | Alternative | Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31. Format: date Pattern: ^\d{4}-\d{2}-\d{2}$ |
updated_at (anyOf 2) | null | Alternative | Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31. Format: date Pattern: ^\d{4}-\d{2}-\d{2}$ |
Referenced models: Create a new contract — 201 response body — data quote benefits item, Create a new contract — 201 response body — data quote breakdown costs
Create a new contract — 201 response body — data quote benefits item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
currency | string | Optional | Currency code. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
fee | JSON | Optional | |
fee (anyOf 1) | number | Alternative | Fee in local currency Format: double |
fee (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
fee_usd | JSON | Optional | |
fee_usd (anyOf 1) | number | Alternative | Fee in USD Format: double |
fee_usd (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
name | string | Optional | Benefit's name |
plan | string | Optional | Benefit's plan |
price | JSON | Optional | |
price (anyOf 1) | number | Alternative | Price in local currency Format: double |
price (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
price_usd | JSON | Optional | |
price_usd (anyOf 1) | number | Alternative | Price in USD Format: double |
price_usd (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Create a new contract — 201 response body — data quote breakdown costs
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Cost breakdown for the quote, grouped by billing cadence (e.g., monthly). |
monthly | Model | Optional | Expand Create a new contract — 201 response body — data quote breakdown costs monthly Monthly cost breakdown for the quote. |
Referenced models: Create a new contract — 201 response body — data quote breakdown costs monthly
Create a new contract — 201 response body — data quote breakdown costs monthly
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Monthly cost breakdown for the quote. |
costs | array | Optional | List of individual monthly cost line items included in the quote. |
costs[] | Model | Each item | Expand Create a new contract — 201 response body — data quote breakdown costs monthly costs item |
total | JSON | Optional | |
total (anyOf 1) | number | Alternative | Total costs in local currency Format: double |
total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_usd | JSON | Optional | |
total_usd (anyOf 1) | number | Alternative | Total costs in USD Format: double |
total_usd (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Create a new contract — 201 response body — data quote breakdown costs monthly costs item
Create a new contract — 201 response body — data quote breakdown costs monthly costs item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
currency | string | Optional | Currency code. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
name | string | Optional | Cost's name |
total | JSON | Optional | |
total (anyOf 1) | number | Alternative | Total cost in local currency Format: double |
total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_usd | JSON | Optional | |
total_usd (anyOf 1) | number | Alternative | Total cost in USD Format: double |
total_usd (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Create a new contract — 201 response body — data seniority id, level, name
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Seniority describes level of expertise at a job e.g. junior |
id | JSON | Required within parent | |
id (anyOf 1) | number | Alternative | Unique identifier of this resource. Format: double |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
level | JSON | Optional | |
level (anyOf 1) | JSON | Alternative | |
level (anyOf 1) (anyOf 1) | number | Alternative | Level of seniority level e.g. 2 Format: double |
level (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
level (anyOf 2) | null | Alternative | Level of seniority level e.g. 2 Format: double |
name | string | Required within parent | Name of seniority level e.g. Mid (Individual Contributor Level 2) Minimum length: 1 |
Create a new contract — 201 response body — data signatures
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | List of signatures recorded for this contract. |
client_signature | string | Required within parent | normally name of client is used as signature |
client_signed_at | JSON | Required within parent | |
client_signed_at (anyOf 1) | string | Alternative | Long date-time format following ISO-8601 |
client_signed_at (anyOf 2) | null | Alternative | Long date-time format following ISO-8601 |
signed_at | JSON | Required within parent | |
signed_at (anyOf 1) | string | Alternative | Long date-time format following ISO-8601 |
signed_at (anyOf 2) | null | Alternative | Long date-time format following ISO-8601 |
worker_signature | string | Required within parent | Signatures of client representative. |
worker_signed_at | JSON | Required within parent | |
worker_signed_at (anyOf 1) | string | Alternative | Long date-time format following ISO-8601 |
worker_signed_at (anyOf 2) | null | Alternative | Long date-time format following ISO-8601 |
Create a new contract — 201 response body — data termination date
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Contract termination date. When present, it is a date-time string in ISO-8601 format. |
$ (anyOf 1) | string | Alternative | Format: date-time |
$ (anyOf 2) | string | Alternative | Known values: "" (empty string) |
Create a new contract — 201 response body — data worker Worker details associated with the contract
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Worker details associated with the contract. |
alternate_email | array | Optional | List of alternate email addresses. |
alternate_email[] | Model | Each item | Expand Create a new contract — 201 response body — data worker Worker details associated with the contract alternate email item |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | Worker's country (location not nationality) |
country (anyOf 2) | null | Alternative | Worker's country (location not nationality) |
date_of_birth | JSON | Optional | |
date_of_birth (anyOf 1) | string | Alternative | Long date-time format following ISO-8601 Format: date-time |
date_of_birth (anyOf 2) | null | Alternative | Long date-time format following ISO-8601 Format: date-time |
email | JSON | Optional | |
email (anyOf 1) | string | Alternative | User's email address. Format: email Minimum length: 5 |
email (anyOf 2) | null | Alternative | User's email address. Format: email Minimum length: 5 |
expected_email | JSON | Optional | |
expected_email (anyOf 1) | string | Alternative | Worker's email address. Format: email Minimum length: 5 |
expected_email (anyOf 2) | null | Alternative | Worker's email address. Format: email Minimum length: 5 |
first_name | JSON | Optional | |
first_name (anyOf 1) | string | Alternative | Worker's first name Maximum length: 255 |
first_name (anyOf 2) | null | Alternative | Worker's first name Maximum length: 255 |
full_name | string | Optional | Worker's full name. Minimum length: 1 |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | A unique identifier for this resource. |
id (anyOf 2) | null | Alternative | A unique identifier for this resource. |
image | string | Optional | URL to worker's image Format: url |
last_name | JSON | Optional | |
last_name (anyOf 1) | string | Alternative | Worker's last name Maximum length: 255 |
last_name (anyOf 2) | null | Alternative | Worker's last name Maximum length: 255 |
legal_entity | Model | Optional | Expand Create a new contract — 201 response body — data worker Worker details associated with the contract legal entity Worker legal entity information, if applicable. |
nationality | JSON | Optional | |
nationality (anyOf 1) | string | Alternative | Worker's nationality. |
nationality (anyOf 2) | null | Alternative | Worker's nationality. |
Referenced models: Create a new contract — 201 response body — data worker Worker details associated with the contract alternate email item, Create a new contract — 201 response body — data worker Worker details associated with the contract legal entity
Create a new contract — 201 response body — data worker Worker details associated with the contract alternate email item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
email | JSON | Required within parent | |
email (anyOf 1) | string | Alternative | User's email address. Format: email Minimum length: 5 |
email (anyOf 2) | null | Alternative | User's email address. Format: email Minimum length: 5 |
isVerified | boolean | Required within parent | True if email has been verified |
Create a new contract — 201 response body — data worker Worker details associated with the contract legal entity
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Worker legal entity information, if applicable. |
personal_name | string | Required within parent | Name of a legal entity |
registration_number | string | Required within parent | Registration number of a legal entity |
type | string | Required within parent | Type of a legal entity Known values: individual, company |
Create a new contract — request body — body / data / platform_payment_type: STANDARD, OFF PLATFORM, type: pay as you go time based, who reports: both, client, contractor
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of contract to create |
citizenship | string or null | Optional | ISO 3166-1 alpha-2 country code of the worker's citizenship. Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
client | Model | Required within parent | Expand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor client Client details for the contract, including the legal entity and team. |
compensation_details | Model | Required within parent | Expand Create a new contract — request body — body / data / type: ongoing time based, who reports: both, client, contractor compensation details Compensation and invoicing configuration for the contract. |
contract_template_id | string or null | Optional | Contract Template Id. |
country_code | string | Optional | Country code. Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
external_id | string or null | Optional | External Id. |
job_title | Model | Optional | Expand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor job title Worker's job title. You can enter a custom job title or use a pre-defined job title using the Id retrieved in job-titles endpoint. |
meta | Model | Required within parent | Expand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor meta Additional custom info about a contract |
notice_period | number | Optional | Days before to notice the termination of contract for either party. Default: 10 Format: double Minimum: 0 |
platform_payment_type | string | Optional | Whether the contract is paid through Deel (`STANDARD`) or outside Deel (`OFF_PLATFORM`). Applies to IC contracts only. One of: STANDARD, OFF_PLATFORM |
scope_of_work | string or null | Optional | Describe the work to be performed. |
scope_of_work_id | string or null | Optional | Existing scope of work public id Format: uuid |
seniority | JSON | Optional | Job seniority level. Please use the seniority levels endpoint to retrieve the list of seniority levels. |
seniority (oneOf 1) | Model | Alternative | Expand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor seniority id |
seniority (oneOf 2) | null | Alternative | |
special_clause | string or null | Optional | Enter any special clause you may have. |
start_date | string | Required within parent | Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31. Format: date Pattern: ^\d{4}-\d{2}-\d{2}$ |
state_code | string or null | Optional | The state or province code. Use country lookup endpoint to retrieve state codes. |
termination_date | string or null | Optional | Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31. Format: date Pattern: ^\d{4}-\d{2}-\d{2}$ |
title | string | Required within parent | The title of the contract. |
type | string | Required within parent | Type of contract One of: pay_as_you_go_time_based |
who_reports | string | Optional | Flag to indicate who is supposed to provide regular reports One of: both, client, contractor |
worker | JSON | Optional | Worker properties |
worker (oneOf 1) | Model | Alternative | Expand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor worker Worker properties |
worker (oneOf 2) | null | Alternative |
Referenced models: Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor client, Create a new contract — request body — body / data / type: ongoing time based, who reports: both, client, contractor compensation details, Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor job title, Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor meta, Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor seniority id, Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor worker Worker properties
Create a new contract — request body — body / data / type: ongoing time based, who reports: both, client, contractor
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of contract to create |
citizenship | string or null | Optional | ISO 3166-1 alpha-2 country code of the worker's citizenship. Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
client | Model | Required within parent | Expand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor client Client details for the contract, including the legal entity and team. |
compensation_details | Model | Required within parent | Expand Create a new contract — request body — body / data / type: ongoing time based, who reports: both, client, contractor compensation details Compensation and invoicing configuration for the contract. |
contract_template_id | string or null | Optional | Contract Template Id. |
country_code | string | Optional | Country code. Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
external_id | string or null | Optional | External Id. |
job_title | Model | Optional | Expand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor job title Worker's job title. You can enter a custom job title or use a pre-defined job title using the Id retrieved in job-titles endpoint. |
meta | Model | Required within parent | Expand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor meta Additional custom info about a contract |
notice_period | number | Optional | Days before to notice the termination of contract for either party. Default: 10 Format: double Minimum: 0 |
scope_of_work | string or null | Optional | Describe the work to be performed. |
scope_of_work_id | string or null | Optional | Existing scope of work public id Format: uuid |
seniority | JSON | Optional | Job seniority level. Please use the seniority levels endpoint to retrieve the list of seniority levels. |
seniority (oneOf 1) | Model | Alternative | Expand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor seniority id |
seniority (oneOf 2) | null | Alternative | |
special_clause | string or null | Optional | Enter any special clause you may have. |
start_date | string | Required within parent | Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31. Format: date Pattern: ^\d{4}-\d{2}-\d{2}$ |
state_code | string or null | Optional | The state or province code. Use country lookup endpoint to retrieve state codes. |
termination_date | string or null | Optional | Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31. Format: date Pattern: ^\d{4}-\d{2}-\d{2}$ |
title | string | Required within parent | The title of the contract. |
type | string | Required within parent | Type of contract One of: ongoing_time_based |
who_reports | string | Optional | Flag to indicate who is supposed to provide regular reports One of: both, client, contractor |
worker | JSON | Optional | Worker properties |
worker (oneOf 1) | Model | Alternative | Expand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor worker Worker properties |
worker (oneOf 2) | null | Alternative |
Referenced models: Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor client, Create a new contract — request body — body / data / type: ongoing time based, who reports: both, client, contractor compensation details, Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor job title, Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor meta, Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor seniority id, Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor worker Worker properties
Create a new contract — request body — body / data / type: ongoing time based, who reports: both, client, contractor compensation details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Compensation and invoicing configuration for the contract. |
amount | number | Required within parent | Amount to be paid. This field can be excluded when creating a Pay-as-you-go task-based or Milestone contracts. Format: double |
currency_code | string | Required within parent | Currency code. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
cycle_end | number | Optional | Date invoice cycle ends. Format: double Maximum: 31 Minimum: 1 |
cycle_end_type | string | Optional | Cycle end can be weekly 1-7 (Monday = 1) or monthly 1-31. One of: DAY_OF_WEEK, DAY_OF_LAST_WEEK, DAY_OF_MONTH |
first_payment | number | Optional | First payment amount. Default: 0 Format: double Minimum: 0 |
first_payment_date | string or null | Optional | Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31. |
frequency | string | Optional | Scale of the invoice cycle. One of: weekly, monthly, biweekly, semimonthly, calendar-month |
notice_period | number | Optional | Days before to notice the termination of contract for either party. Default: 10 Format: double Minimum: 0 |
pay_before_weekends | boolean | Optional | If the payment due is on a weekend, pay on Friday. |
payment_due_days | number | Optional | Number of days to pay the invoice. Format: double Maximum: 90 Minimum: 0 |
payment_due_type | string | Optional | Type of payment due. If the payment is due on the last day of month, enter 'WITHIN_MONTH'. If the payment is due some days after the end of the month, enter 'AFTER_MONTH'. If the payment is due before the end of the invoice cycle, enter 'BEFORE_CYCLE_END'. Default: REGULAR One of: REGULAR, WITHIN_MONTH, AFTER_MONTH, BEFORE_CYCLE_END |
payment_policy_id | string | Optional | ID of a pre-configured payment policy. When provided, the payment schedule is derived from the policy and the individual payment fields (frequency, cycle_end, cycle_end_type, payment_due_type, payment_due_days, pay_before_weekends) must be omitted. Mutually exclusive with those individual fields. Format: uuid |
scale | string | Required within parent | Defines the scale at which the amount is paid. For example, enter 'hourly' to define the amount per hour. This field can be excluded when creating a Pay-as-you-go task-based or Milestone contracts. One of: hourly, daily, weekly, monthly, biweekly, semimonthly, custom |
Create a new contract — request body — body / data / type: payg milestones, who reports: both, client, contractor
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of contract to create |
citizenship | string or null | Optional | ISO 3166-1 alpha-2 country code of the worker's citizenship. Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
client | Model | Required within parent | Expand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor client Client details for the contract, including the legal entity and team. |
compensation_details | Model | Required within parent | Expand Create a new contract — request body — body / data / type: payg milestones, who reports: both, client, contractor compensation details Compensation and invoicing configuration for the contract. |
contract_template_id | string or null | Optional | Contract Template Id. |
country_code | string | Optional | Country code. Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
external_id | string or null | Optional | External Id. |
job_title | Model | Optional | Expand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor job title Worker's job title. You can enter a custom job title or use a pre-defined job title using the Id retrieved in job-titles endpoint. |
meta | Model | Required within parent | Expand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor meta Additional custom info about a contract |
notice_period | number | Optional | Days before to notice the termination of contract for either party. Default: 10 Format: double Minimum: 0 |
scope_of_work | string or null | Optional | Describe the work to be performed. |
scope_of_work_id | string or null | Optional | Existing scope of work public id Format: uuid |
seniority | JSON | Optional | Job seniority level. Please use the seniority levels endpoint to retrieve the list of seniority levels. |
seniority (oneOf 1) | Model | Alternative | Expand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor seniority id |
seniority (oneOf 2) | null | Alternative | |
special_clause | string or null | Optional | Enter any special clause you may have. |
start_date | string or null | Optional | Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31. Format: date Pattern: ^\d{4}-\d{2}-\d{2}$ |
state_code | string or null | Optional | The state or province code. Use country lookup endpoint to retrieve state codes. |
termination_date | string or null | Optional | Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31. Format: date Pattern: ^\d{4}-\d{2}-\d{2}$ |
title | string | Required within parent | The title of the contract. |
type | string | Required within parent | Type of contract One of: payg_milestones |
who_reports | string | Optional | Flag to indicate who is supposed to provide regular reports One of: both, client, contractor |
worker | JSON | Optional | Worker properties |
worker (oneOf 1) | Model | Alternative | Expand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor worker Worker properties |
worker (oneOf 2) | null | Alternative |
Referenced models: Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor client, Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor job title, Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor meta, Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor seniority id, Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor worker Worker properties, Create a new contract — request body — body / data / type: payg milestones, who reports: both, client, contractor compensation details
Create a new contract — request body — body / data / type: payg milestones, who reports: both, client, contractor compensation details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Compensation and invoicing configuration for the contract. |
amount | number | Optional | Amount to be paid. This field can be excluded when creating a Pay-as-you-go task-based or Milestone contracts. Format: double |
currency_code | string | Required within parent | Currency code. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
cycle_end | number | Required within parent | Date invoice cycle ends. Format: double Maximum: 31 Minimum: 1 |
cycle_end_type | string | Required within parent | Cycle end can be weekly 1-7 (Monday = 1) or monthly 1-31. One of: DAY_OF_WEEK, DAY_OF_LAST_WEEK, DAY_OF_MONTH |
first_payment | number | Optional | First payment amount. Default: 0 Format: double Minimum: 0 |
first_payment_date | string or null | Optional | Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31. |
frequency | string | Required within parent | Scale of the invoice cycle. One of: weekly, monthly, biweekly, semimonthly, calendar-month |
notice_period | number | Optional | Days before to notice the termination of contract for either party. Default: 10 Format: double Minimum: 0 |
pay_before_weekends | boolean | Optional | If the payment due is on a weekend, pay on Friday. |
payment_due_days | number | Required within parent | Number of days to pay the invoice. Format: double Maximum: 90 Minimum: 0 |
payment_due_type | string | Required within parent | Type of payment due. If the payment is due on the last day of month, enter 'WITHIN_MONTH'. If the payment is due some days after the end of the month, enter 'AFTER_MONTH'. If the payment is due before the end of the invoice cycle, enter 'BEFORE_CYCLE_END'. Default: REGULAR One of: REGULAR, WITHIN_MONTH, AFTER_MONTH, BEFORE_CYCLE_END |
Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of contract to create |
citizenship | string or null | Optional | ISO 3166-1 alpha-2 country code of the worker's citizenship. Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
client | Model | Required within parent | Expand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor client Client details for the contract, including the legal entity and team. |
compensation_details | Model | Required within parent | Expand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor compensation details Compensation and invoicing configuration for the contract. |
contract_template_id | string or null | Optional | Contract Template Id. |
country_code | string | Optional | Country code. Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
external_id | string or null | Optional | External Id. |
job_title | Model | Optional | Expand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor job title Worker's job title. You can enter a custom job title or use a pre-defined job title using the Id retrieved in job-titles endpoint. |
meta | Model | Required within parent | Expand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor meta Additional custom info about a contract |
notice_period | number | Optional | Days before to notice the termination of contract for either party. Default: 10 Format: double Minimum: 0 |
scope_of_work | string or null | Optional | Describe the work to be performed. |
scope_of_work_id | string or null | Optional | Existing scope of work public id Format: uuid |
seniority | JSON | Optional | Job seniority level. Please use the seniority levels endpoint to retrieve the list of seniority levels. |
seniority (oneOf 1) | Model | Alternative | Expand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor seniority id |
seniority (oneOf 2) | null | Alternative | |
special_clause | string or null | Optional | Enter any special clause you may have. |
start_date | string | Required within parent | Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31. Format: date Pattern: ^\d{4}-\d{2}-\d{2}$ |
state_code | string or null | Optional | The state or province code. Use country lookup endpoint to retrieve state codes. |
termination_date | string or null | Optional | Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31. Format: date Pattern: ^\d{4}-\d{2}-\d{2}$ |
title | string | Required within parent | The title of the contract. |
type | string | Required within parent | Type of contract One of: payg_tasks |
who_reports | string | Optional | Flag to indicate who is supposed to provide regular reports One of: both, client, contractor |
worker | JSON | Optional | Worker properties |
worker (oneOf 1) | Model | Alternative | Expand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor worker Worker properties |
worker (oneOf 2) | null | Alternative |
Referenced models: Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor client, Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor job title, Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor meta, Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor seniority id, Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor worker Worker properties, Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor compensation details
Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor client
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Client details for the contract, including the legal entity and team. |
legal_entity | Model | Required within parent | Expand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor client legal entity Choose the Deel legal entity for this contract. Use legal entity endpoint to retrieve a list of legal entities in your organization. |
team | Model | Required within parent | Expand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor client team Choose the Deel team for this contract. Use teams endpoint to retrieve a list of teams in your organization. |
Referenced models: Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor client legal entity, Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor client team
Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor client legal entity
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Choose the Deel legal entity for this contract. Use legal entity endpoint to retrieve a list of legal entities in your organization. |
id | Model | Required within parent | Expand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor job title id Unique identifier of this resource. |
Referenced models: Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor job title id
Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor client team
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Choose the Deel team for this contract. Use teams endpoint to retrieve a list of teams in your organization. |
id | Model | Required within parent | Expand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor job title id Unique identifier of this resource. |
Referenced models: Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor job title id
Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor compensation details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Compensation and invoicing configuration for the contract. |
$ (oneOf 1) | JSON | Alternative | Any type |
$ (oneOf 2) | JSON | Alternative | Any type |
Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor job title
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Worker's job title. You can enter a custom job title or use a pre-defined job title using the Id retrieved in job-titles endpoint. |
id | Model | Optional | Expand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor job title id Unique identifier of this resource. |
name | string or null | Optional | Job title. Please leave it blank when entering an Id. Maximum length: 255 |
Referenced models: Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor job title id
Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor job title id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Unique identifier of this resource. |
$ (oneOf 1) | string | Alternative | |
$ (oneOf 2) | number | Alternative | Format: double |
Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor meta
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional custom info about a contract |
documents_required | boolean | Required within parent | Require the contractor to upload necessary compliance documents as per their country’s labor laws. |
is_main_income | boolean | Optional | Flag to indicate if the contract is the main income for the contractor. |
Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor seniority id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Job seniority level. Please use the seniority levels endpoint to retrieve the list of seniority levels. |
id | Model | Optional | Expand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor job title id Unique identifier of this resource. |
Referenced models: Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor job title id
Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor worker Worker properties
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Worker properties |
expected_email | string or null | Required within parent | Worker's email address. Format: email Minimum length: 5 |
first_name | string or null | Required within parent | Worker's first name Maximum length: 255 |
last_name | string or null | Optional | Worker's last name Maximum length: 255 |
work_email | string or null | Optional | Worker's work email address. Format: email Maximum length: 255 |
Create a new contract — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (oneOf 1) | Model | Alternative | Expand Create a new contract — request body — body / data / platform_payment_type: STANDARD, OFF PLATFORM, type: pay as you go time based, who reports: both, client, contractor |
$ (oneOf 2) | Model | Alternative | Expand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor |
$ (oneOf 3) | Model | Alternative | Expand Create a new contract — request body — body / data / type: payg milestones, who reports: both, client, contractor |
$ (oneOf 4) | Model | Alternative | Expand Create a new contract — request body — body / data / type: ongoing time based, who reports: both, client, contractor |
Referenced models: Create a new contract — request body — body / data / platform_payment_type: STANDARD, OFF PLATFORM, type: pay as you go time based, who reports: both, client, contractor, Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor, Create a new contract — request body — body / data / type: payg milestones, who reports: both, client, contractor, Create a new contract — request body — body / data / type: ongoing time based, who reports: both, client, contractor
Create a request to exercise equity — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Create a request to exercise equity — 201 response body — data |
Referenced models: Create a request to exercise equity — 201 response body — data
Create a request to exercise equity — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | ISO 8601 timestamp when the equity exercise request was created. Format: date-time |
id | string | Required within parent | Unique identifier of the equity exercise request. Format: uuid |
status | string | Required within parent | The initial status of the newly created equity exercise request. |
updated_at | string | Required within parent | ISO 8601 timestamp when the equity exercise request was last updated. Format: date-time |
Create a work statement payment policy — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Create a work statement payment policy — 201 response body — data The created work statement payment policy. |
Referenced models: Create a work statement payment policy — 201 response body — data
Create a work statement payment policy — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The created work statement payment policy. |
id | string | Required within parent | The public ID (UUID) of the created payment policy. Format: uuid |
Create a work statement payment policy — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | string | Optional | Description of the payment policy. Maximum length: 400 |
due_days | integer | Optional | Number of days after cycle end before payment is released. Defaults to 0. Maximum: 90 Minimum: 0 |
due_type | string | Optional | How the payment due date is calculated relative to cycle end. Defaults to REGULAR. One of: REGULAR, WITHIN_MONTH, AFTER_MONTH, BEFORE_CYCLE_END |
end_day | integer | Required within parent | Day the billing cycle ends. 1–31 when end_type is DAY_OF_MONTH, 1–7 when DAY_OF_WEEK or DAY_OF_LAST_WEEK. Maximum: 31 Minimum: 1 |
end_type | string | Optional | How end_day is interpreted. Defaults to DAY_OF_MONTH. One of: DAY_OF_WEEK, DAY_OF_LAST_WEEK, DAY_OF_MONTH |
end_week_parity | string | Optional | Week parity constraint for biweekly cycles. Only applicable when scale is BIWEEKLY. One of: AUTO, ODD, EVEN |
name | string | Required within parent | Name of the payment policy. Must be unique within the organization. Maximum length: 255 Minimum length: 3 |
scale | string | Required within parent | Payment cycle frequency. One of: WEEKLY, MONTHLY, BIWEEKLY, SEMIMONTHLY, CALENDAR_MONTH |
should_pay_before_weekends | boolean | Optional | Whether payment is moved earlier when the due date falls on a weekend. Defaults to false. |
List contract termination reasons — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand List contract termination reasons — 200 response body — data item |
has_more | boolean | Required within parent | Indicates whether there are more results available |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Cursor to use for fetching the next page. Null if there are no more results. |
next_cursor (anyOf 2) | null | Alternative | Cursor to use for fetching the next page. Null if there are no more results. |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | integer | Alternative | Total number of termination reasons available |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: List contract termination reasons — 200 response body — data item
List contract termination reasons — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Timestamp when the termination reason was created Format: date-time |
frequency | string | Required within parent | How commonly this reason is used Known values: COMMON, MOST_COMMON, LESS_COMMON |
id | string | Required within parent | Unique identifier for the termination reason Format: uuid |
name | string | Required within parent | The display text for the termination reason that can be shown to users |
updated_at | string | Required within parent | Timestamp when the termination reason was last updated Format: date-time |
List of contracts — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Array of contract objects. |
data[] | Model | Each item | Expand List of contracts — 200 response body — data item |
page | Model | Required within parent | Expand List of contracts — 200 response body — page Pagination information for the response. |
Referenced models: List of contracts — 200 response body — data item, List of contracts — 200 response body — page
List of contracts — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
client | Model | Required within parent | Expand List of contracts — 200 response body — data item client Client information associated with the contract. |
cost_centers | array | Optional | List of cost centers associated with the contract. |
cost_centers[] | Model | Each item | Expand List of contracts — 200 response body — data item cost centers item |
created_at | JSON | Required within parent | |
created_at (anyOf 1) | string | Alternative | Timestamp when the contract was created, in ISO-8601 format. Format: date-time |
created_at (anyOf 2) | null | Alternative | Timestamp when the contract was created, in ISO-8601 format. Format: date-time |
custom_fields | JSON | Optional | |
custom_fields (anyOf 1) | array | Alternative | Contract-level custom fields. Only returned when `expand=custom_fields` is provided. |
custom_fields (anyOf 1)[] | Model | Each item | Expand List of contracts — 200 response body — data item custom fields null item |
custom_fields (anyOf 2) | null | Alternative | Contract-level custom fields. Only returned when `expand=custom_fields` is provided. |
custom_fields (anyOf 2)[] | Model | Each item | Expand List of contracts — 200 response body — data item custom fields null item |
employment_details | Model | Optional | Expand List of contracts — 200 response body — data item employment details Employment-related details for the contract. |
external_id | JSON | Optional | |
external_id (anyOf 1) | string | Alternative | A unique identifier for the object provided by an external system. |
external_id (anyOf 2) | null | Alternative | A unique identifier for the object provided by an external system. |
fte_percentage | JSON | Optional | |
fte_percentage (anyOf 1) | JSON | Alternative | |
fte_percentage (anyOf 1) (anyOf 1) | number | Alternative | Full time percentage Format: double |
fte_percentage (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
fte_percentage (anyOf 2) | null | Alternative | Full time percentage Format: double |
id | string | Required within parent | UUID of the contract. Minimum length: 1 |
invitations | Model | Required within parent | Expand List of contracts — 200 response body — data item invitations Details of invitations sent for signing the contract. |
is_archived | boolean | Required within parent | Indicates whether the contract is archived. |
is_shielded | boolean | Required within parent | Indicates whether the contract is shielded. |
notice_period | JSON | Optional | |
notice_period (anyOf 1) | number | Alternative | Number of days required to give notice before terminating the contract. Default: 0 Format: double Minimum: 0 |
notice_period (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
scale | JSON | Optional | |
scale (anyOf 1) | string | Alternative | The payment scale (e.g., hourly, weekly, monthly, etc.). |
scale (anyOf 2) | null | Alternative | The payment scale (e.g., hourly, weekly, monthly, etc.). |
signatures | Model | Required within parent | Expand List of contracts — 200 response body — data item signatures Signature information for the contract. |
status | Model | Required within parent | Expand List of contracts — 200 response body — data item status Status of a contract in Deel workflow. |
termination_date | JSON | Required within parent | |
termination_date (anyOf 1) | string | Alternative | Date when the contract is terminated, in ISO-8601 format. Format: date-time |
termination_date (anyOf 2) | null | Alternative | Date when the contract is terminated, in ISO-8601 format. Format: date-time |
title | string | Required within parent | Title of the contract. Minimum length: 1 |
type | string | Required within parent | Type of a contract. Known values: ongoing_time_based, milestones, time_based, pay_as_you_go_time_based, commission, payg_milestones, payg_tasks, eor, unknown, peo, employee, global_payroll, shield_msa, hris_direct_employee, contractor_outside_deel |
who_reports | string | Optional | Indicates who is responsible for providing regular reports. Known values: both, client, contractor |
worker | JSON | Optional | Worker information associated with the contract. |
worker (anyOf 1) | Model | Alternative | Expand List of contracts — 200 response body — data item worker Worker information associated with the contract |
worker (anyOf 2) | null | Alternative |
Referenced models: List of contracts — 200 response body — data item client, List of contracts — 200 response body — data item cost centers item, List of contracts — 200 response body — data item custom fields null item, List of contracts — 200 response body — data item employment details, List of contracts — 200 response body — data item invitations, List of contracts — 200 response body — data item signatures, List of contracts — 200 response body — data item status, List of contracts — 200 response body — data item worker Worker information associated with the contract
List of contracts — 200 response body — data item client
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Client information associated with the contract. |
legal_entity | JSON | Optional | Legal entity information for the client. |
legal_entity (anyOf 1) | Model | Alternative | Expand List of contracts — 200 response body — data item client legal entity Legal entity information for the client |
legal_entity (anyOf 2) | null | Alternative | |
team | Model | Optional | Expand List of contracts — 200 response body — data item client team Team information for the client. |
Referenced models: List of contracts — 200 response body — data item client legal entity Legal entity information for the client, List of contracts — 200 response body — data item client team
List of contracts — 200 response body — data item client legal entity Legal entity information for the client
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Legal entity information for the client. |
id | string | Required within parent | Unique identifier of this resource. |
name | JSON | Required within parent | |
name (anyOf 1) | string | Alternative | Name of the legal entity. |
name (anyOf 2) | null | Alternative | Name of the legal entity. |
List of contracts — 200 response body — data item client team
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Team information for the client. |
id | string | Required within parent | Unique identifier of this resource. |
name | JSON | Required within parent | |
name (anyOf 1) | string | Alternative | Name of a team. |
name (anyOf 2) | null | Alternative | Name of a team. |
List of contracts — 200 response body — data item cost centers item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Cost center object. |
allocation_percentage | JSON | Optional | |
allocation_percentage (anyOf 1) | number | Alternative | Percentage of the cost center allocation. Format: double |
allocation_percentage (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
name | string | Optional | Cost center name. |
number | string | Optional | Cost center number. |
List of contracts — 200 response body — data item custom fields null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contract custom field object. |
id | string | Optional | Public identifier of the custom field. |
name | string | Optional | Name of the custom field. |
value | JSON | Optional | |
value (anyOf 1) | string | Alternative | Value of the custom field for this contract. |
value (anyOf 2) | null | Alternative | Value of the custom field for this contract. |
List of contracts — 200 response body — data item employment details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Employment-related details for the contract. |
non_compete_clause | JSON | Optional | |
non_compete_clause (anyOf 1) | boolean | Alternative | Non-compete clause state on the active EOR SOW. Null when not yet populated. |
non_compete_clause (anyOf 2) | null | Alternative | Non-compete clause state on the active EOR SOW. Null when not yet populated. |
non_solicitation_clause | JSON | Optional | |
non_solicitation_clause (anyOf 1) | boolean | Alternative | Non-solicitation clause state on the active EOR SOW. Null when not yet populated. |
non_solicitation_clause (anyOf 2) | null | Alternative | Non-solicitation clause state on the active EOR SOW. Null when not yet populated. |
List of contracts — 200 response body — data item invitations
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of invitations sent for signing the contract. |
client_email | JSON | Optional | |
client_email (anyOf 1) | string | Alternative | Email address of the client to invite. |
client_email (anyOf 2) | null | Alternative | Email address of the client to invite. |
worker_email | JSON | Optional | |
worker_email (anyOf 1) | string | Alternative | Email address of the worker to invite. |
worker_email (anyOf 2) | null | Alternative | Email address of the worker to invite. |
List of contracts — 200 response body — data item signatures
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Signature information for the contract. |
client_signed_at | JSON | Required within parent | |
client_signed_at (anyOf 1) | string | Alternative | Timestamp when the client signed the contract, in ISO-8601 format. Format: date-time |
client_signed_at (anyOf 2) | null | Alternative | Timestamp when the client signed the contract, in ISO-8601 format. Format: date-time |
worker_signature | JSON | Required within parent | |
worker_signature (anyOf 1) | string | Alternative | Worker's signature. |
worker_signature (anyOf 2) | null | Alternative | Worker's signature. |
worker_signed_at | JSON | Required within parent | |
worker_signed_at (anyOf 1) | string | Alternative | Timestamp when the worker signed the contract, in ISO-8601 format. Format: date-time |
worker_signed_at (anyOf 2) | null | Alternative | Timestamp when the worker signed the contract, in ISO-8601 format. Format: date-time |
List of contracts — 200 response body — data item status
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Status of a contract in Deel workflow. Known values: new, under_review, waiting_for_approval, waiting_for_employee_contract, waiting_for_client_sign, processing_payment, waiting_for_contractor_sign, waiting_for_eor_sign, waiting_for_employee_sign, waiting_for_hris_employee_sign, awaiting_deposit_payment, in_progress, completed, cancelled, user_cancelled, rejected, waiting_for_client_payment, onboarding, onboarded |
List of contracts — 200 response body — data item worker Worker information associated with the contract
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Worker information associated with the contract. |
alternate_email | array | Optional | List of alternate email addresses. |
alternate_email[] | Model | Each item | Expand List of contracts — 200 response body — data item worker Worker information associated with the contract alternate email item |
email | JSON | Optional | |
email (anyOf 1) | string | Alternative | User's email address. Minimum length: 5 |
email (anyOf 2) | null | Alternative | User's email address. Minimum length: 5 |
full_name | string | Optional | Full name of the worker. Minimum length: 1 |
id | string | Required within parent | Unique identifier of this resource. |
image | JSON | Optional | |
image (anyOf 1) | string | Alternative | URL of the worker's profile image. Format: uri Minimum length: 5 |
image (anyOf 2) | null | Alternative | URL of the worker's profile image. Format: uri Minimum length: 5 |
Referenced models: List of contracts — 200 response body — data item worker Worker information associated with the contract alternate email item
List of contracts — 200 response body — data item worker Worker information associated with the contract alternate email item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Alternate email address object. |
email | JSON | Optional | |
email (anyOf 1) | string | Alternative | User's email address. Format: email Minimum length: 5 |
email (anyOf 2) | null | Alternative | User's email address. Format: email Minimum length: 5 |
isVerified | boolean | Optional | Indicates whether the alternate email address is verified. |
List of contracts — 200 response body — page
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Pagination information for the response. |
cursor | string | Required within parent | Cursor for paginated results. |
total_rows | JSON | Required within parent | |
total_rows (anyOf 1) | number | Alternative | Total number of rows in the result set. Format: double |
total_rows (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
List work statement payment policies — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | The organization's work statement payment policies. |
data[] | Model | Each item | Expand List work statement payment policies — 200 response body — data item |
Referenced models: List work statement payment policies — 200 response body — data item
List work statement payment policies — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A work statement payment policy of the organization. |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Description of the payment policy. |
description (anyOf 2) | null | Alternative | Description of the payment policy. |
due_days | JSON | Required within parent | |
due_days (anyOf 1) | integer | Alternative | Number of days after cycle end before payment is released. |
due_days (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
due_type | string | Required within parent | How the payment due date is calculated relative to cycle end. Known values: REGULAR, WITHIN_MONTH, AFTER_MONTH, BEFORE_CYCLE_END |
end_day | JSON | Required within parent | |
end_day (anyOf 1) | integer | Alternative | Day the billing cycle ends. 1–31 when end_type is DAY_OF_MONTH, 1–7 when DAY_OF_WEEK or DAY_OF_LAST_WEEK. |
end_day (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
end_type | string | Required within parent | How end_day is interpreted. Known values: DAY_OF_WEEK, DAY_OF_LAST_WEEK, DAY_OF_MONTH |
end_week_parity | JSON | Optional | Week parity constraint for biweekly cycles. Null for non-biweekly scales. |
end_week_parity (anyOf 1) | string | Alternative | Week parity constraint for biweekly cycles. Null for non-biweekly scales. Known values: AUTO, ODD, EVEN |
end_week_parity (anyOf 2) | null | Alternative | |
id | string | Required within parent | The public ID (UUID) of the payment policy. Format: uuid |
name | string | Required within parent | Name of the payment policy. |
scale | string | Required within parent | Payment cycle frequency. Known values: WEEKLY, MONTHLY, BIWEEKLY, SEMIMONTHLY, CALENDAR_MONTH |
semimonthly_first_day | JSON | Optional | |
semimonthly_first_day (anyOf 1) | JSON | Alternative | |
semimonthly_first_day (anyOf 1) (anyOf 1) | integer | Alternative | First payment day of the month for semimonthly cycles. Null for other scales. |
semimonthly_first_day (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
semimonthly_first_day (anyOf 2) | null | Alternative | First payment day of the month for semimonthly cycles. Null for other scales. |
semimonthly_second_day | JSON | Optional | |
semimonthly_second_day (anyOf 1) | JSON | Alternative | |
semimonthly_second_day (anyOf 1) (anyOf 1) | integer | Alternative | Second payment day of the month for semimonthly cycles. Null for other scales. |
semimonthly_second_day (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
semimonthly_second_day (anyOf 2) | null | Alternative | Second payment day of the month for semimonthly cycles. Null for other scales. |
should_pay_before_weekends | boolean | Required within parent | Whether payment is moved earlier when the due date falls on a weekend. |
Retrieve a single contract — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Retrieve a single contract — 200 response body — data |
Referenced models: Retrieve a single contract — 200 response body — data