Deel: Contractor amendments schemas
15 Deel schemas with complete fields and constraints.
← Contractor amendments operations · All schemas
List contract amendments — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cursor | JSON | Required within parent | |
cursor (anyOf 1) | string | Alternative | Cursor for the next page of results. |
cursor (anyOf 2) | null | Alternative | Cursor for the next page of results. |
data | array | Required within parent | List of amendments. IC contracts may return multiple; Global Payroll contracts return at most one (the current pending amendment). |
data[] | Model | Each item | Expand List contract amendments — 200 response body — data item |
has_more | boolean | Required within parent | Indicates if there are more work statements available. |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | integer | Alternative | Total number of work statements matching the filters. |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: List contract amendments — 200 response body — data item
List contract amendments — 200 response body — data / item / sign_status: PENDING, WAITING FOR APPROVAL, APPROVED, DECLINED, status: INITIAL, PENDING, ACTIVE, OUTDATED, APPROVED, DECLINED
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
contract_name | JSON | Optional | |
contract_name (anyOf 1) | string | Alternative | Name of the associated contract. |
contract_name (anyOf 2) | null | Alternative | Name of the associated contract. |
contract_type | JSON | Optional | Type of the associated IC contract. |
contract_type (anyOf 1) | string | Alternative | Type of the associated IC contract. Known values: milestones, time_based, ongoing_time_based, pay_as_you_go_time_based, commission, payg_milestones, payg_tasks |
contract_type (anyOf 2) | null | Alternative | |
created_at | string | Required within parent | Timestamp when the work statement was created. Format: date-time |
currency_code | JSON | Optional | |
currency_code (anyOf 1) | string | Alternative | Currency code in ISO 4217 format (e.g., USD, EUR, GBP). Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
currency_code (anyOf 2) | null | Alternative | Currency code in ISO 4217 format (e.g., USD, EUR, GBP). Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
effective_date | JSON | Optional | |
effective_date (anyOf 1) | string | Alternative | Effective date when the work statement becomes active. Format: date-time |
effective_date (anyOf 2) | null | Alternative | Effective date when the work statement becomes active. Format: date-time |
id | string | Required within parent | Unique identifier for the work statement. Format: uuid |
rate | JSON | Optional | |
rate (anyOf 1) | JSON | Alternative | |
rate (anyOf 1) (anyOf 1) | number | Alternative | Compensation rate per scale. The amount paid according to the specified scale (e.g., 5000 per month). Format: double |
rate (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
rate (anyOf 2) | null | Alternative | Compensation rate per scale. The amount paid according to the specified scale (e.g., 5000 per month). Format: double |
scale | JSON | Optional | Payment frequency/scale that defines how often the rate is paid. |
scale (anyOf 1) | string | Alternative | Payment frequency/scale that defines how often the rate is paid. Known values: hourly, daily, weekly, monthly, biweekly, semimonthly, custom |
scale (anyOf 2) | null | Alternative | |
sign_status | string | Required within parent | Current sign status of the work statement. Known values: PENDING, WAITING_FOR_APPROVAL, APPROVED, DECLINED |
status | string | Required within parent | Current status of the work statement. Known values: INITIAL, PENDING, ACTIVE, OUTDATED, APPROVED, DECLINED |
updated_at | string | Required within parent | Timestamp when the work statement was last updated. Format: date-time |
List contract amendments — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | Model | Alternative | Expand List contract amendments — 200 response body — data / item / sign_status: PENDING, WAITING FOR APPROVAL, APPROVED, DECLINED, status: INITIAL, PENDING, ACTIVE, OUTDATED, APPROVED, DECLINED |
$ (anyOf 2) | Model | Alternative | Expand List contract amendments — 200 response body — data item base compensation type, created at, currency code, effective date, id, rate, scale, sign status, status, updated at |
Referenced models: List contract amendments — 200 response body — data / item / sign_status: PENDING, WAITING FOR APPROVAL, APPROVED, DECLINED, status: INITIAL, PENDING, ACTIVE, OUTDATED, APPROVED, DECLINED, List contract amendments — 200 response body — data item base compensation type, created at, currency code, effective date, id, rate, scale, sign status, status, updated at
List contract amendments — 200 response body — data item base compensation type, created at, currency code, effective date, id, rate, scale, sign status, status, updated at
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
base_compensation_type | JSON | Optional | Type of base compensation for the amendment. |
base_compensation_type (anyOf 1) | string | Alternative | Type of base compensation for the amendment. Known values: salaried, hourly, unpaid, commission_only |
base_compensation_type (anyOf 2) | null | Alternative | |
created_at | string | Required within parent | Timestamp when the amendment was created. Format: date-time |
currency_code | JSON | Optional | |
currency_code (anyOf 1) | string | Alternative | Currency code for the base compensation. |
currency_code (anyOf 2) | null | Alternative | Currency code for the base compensation. |
effective_date | JSON | Optional | |
effective_date (anyOf 1) | string | Alternative | Short date in format ISO-8601 (YYYY-MM-DD) when the amendment takes effect. Format: date |
effective_date (anyOf 2) | null | Alternative | Short date in format ISO-8601 (YYYY-MM-DD) when the amendment takes effect. Format: date |
id | string | Required within parent | Unique identifier for the amendment. Format: uuid |
rate | JSON | Optional | |
rate (anyOf 1) | JSON | Alternative | |
rate (anyOf 1) (anyOf 1) | number | Alternative | Base compensation rate for the amendment. Format: double |
rate (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
rate (anyOf 2) | null | Alternative | Base compensation rate for the amendment. Format: double |
scale | JSON | Optional | Payment scale for the base compensation. |
scale (anyOf 1) | string | Alternative | Payment scale for the base compensation. Known values: hourly, daily, weekly, monthly, annually, two_weekly, bi_monthly, custom, one_off |
scale (anyOf 2) | null | Alternative | |
sign_status | JSON | Required within parent | Sign status is not tracked for Global Payroll amendments; always null. Signing state is conveyed by `status`. Filters `statuses` and `sign_statuses` apply to Individual Contractor contracts only and are ignored for Global Payroll contracts. |
sign_status (anyOf 1) | string | Alternative | Sign status is not tracked for Global Payroll amendments; always null. Signing state is conveyed by `status`. Filters `statuses` and `sign_statuses` apply to Individual Contractor contracts only and are ignored for Global Payroll contracts. Known values: PENDING, WAITING_FOR_APPROVAL, APPROVED, DECLINED |
sign_status (anyOf 2) | null | Alternative | |
status | string | Required within parent | Status of the Global Payroll amendment. Known values: waiting_for_approval, waiting_client_sign, waiting_worker_sign, signed, completed, obsolete |
updated_at | string | Required within parent | Timestamp when the amendment was last updated. Format: date-time |
Update contract — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Update contract — 201 response body — data |
Referenced models: Update contract — 201 response body — data
Update contract — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | Model | Alternative | Expand Update contract — 201 response body — data / status: initial, pending, active, outdated, approved, declined |
$ (anyOf 2) | Model | Alternative | Expand Update contract — 201 response body — data base compensation type, created, created at, currency code, effective date, id, rate, scale, status, updated at |
Referenced models: Update contract — 201 response body — data / status: initial, pending, active, outdated, approved, declined, Update contract — 201 response body — data base compensation type, created, created at, currency code, effective date, id, rate, scale, status, updated at
Update contract — 201 response body — data / status: initial, pending, active, outdated, approved, declined
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created | boolean | Required within parent | Contract has been successfully amended. |
created_at | string | Required within parent | Timestamp when the work statement was created. Format: date-time |
currency_code | string | Optional | Currency code for the amended work statement. |
id | string | Required within parent | The unique identifier of the created amendment. Format: uuid |
job_title | JSON | Optional | |
job_title (anyOf 1) | string | Alternative | Job title for the amended work statement. |
job_title (anyOf 2) | null | Alternative | Job title for the amended work statement. |
rate | JSON | Optional | |
rate (anyOf 1) | JSON | Alternative | |
rate (anyOf 1) (anyOf 1) | number | Alternative | Rate/amount for the amended work statement. Format: double |
rate (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
rate (anyOf 2) | null | Alternative | Rate/amount for the amended work statement. Format: double |
scale | JSON | Optional | Payment scale for the amended work statement. |
scale (anyOf 1) | string | Alternative | Payment scale for the amended work statement. Known values: hourly, daily, weekly, monthly, biweekly, semimonthly, custom |
scale (anyOf 2) | null | Alternative | |
scope_of_work | JSON | Optional | |
scope_of_work (anyOf 1) | string | Alternative | Scope of work for the amended work statement. |
scope_of_work (anyOf 2) | null | Alternative | Scope of work for the amended work statement. |
special_clause | JSON | Optional | |
special_clause (anyOf 1) | string | Alternative | Special clause for the amended work statement. |
special_clause (anyOf 2) | null | Alternative | Special clause for the amended work statement. |
status | string | Required within parent | Status of the amended work statement. Known values: initial, pending, active, outdated, approved, declined |
termination_notice_days | JSON | Optional | |
termination_notice_days (anyOf 1) | integer | Alternative | Number of days notice required for termination. Defaults to 10 if not provided. |
termination_notice_days (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
updated_at | string | Required within parent | Timestamp when the work statement was last updated. Format: date-time |
worker_id | JSON | Optional | |
worker_id (anyOf 1) | string | Alternative | The unique identifier of the worker. Format: uuid |
worker_id (anyOf 2) | null | Alternative | The unique identifier of the worker. Format: uuid |
Update contract — 201 response body — data base compensation type, created, created at, currency code, effective date, id, rate, scale, status, updated at
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
base_compensation_type | JSON | Optional | Type of base compensation for the amendment. |
base_compensation_type (anyOf 1) | string | Alternative | Type of base compensation for the amendment. Known values: salaried, hourly, unpaid, commission_only |
base_compensation_type (anyOf 2) | null | Alternative | |
created | boolean | Required within parent | True if this call created a new amendment, false if it updated an existing pending one. |
created_at | string | Required within parent | Timestamp when the amendment was created. Format: date-time |
currency_code | JSON | Optional | |
currency_code (anyOf 1) | string | Alternative | Currency code for the base compensation. |
currency_code (anyOf 2) | null | Alternative | Currency code for the base compensation. |
effective_date | JSON | Optional | |
effective_date (anyOf 1) | string | Alternative | Short date in format ISO-8601 (YYYY-MM-DD) when the amendment takes effect. Format: date |
effective_date (anyOf 2) | null | Alternative | Short date in format ISO-8601 (YYYY-MM-DD) when the amendment takes effect. Format: date |
id | string | Required within parent | The unique identifier of the amendment. Format: uuid |
rate | JSON | Optional | |
rate (anyOf 1) | JSON | Alternative | |
rate (anyOf 1) (anyOf 1) | number | Alternative | Base compensation rate for the amended employment agreement. Format: double |
rate (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
rate (anyOf 2) | null | Alternative | Base compensation rate for the amended employment agreement. Format: double |
scale | JSON | Optional | Payment scale for the base compensation. |
scale (anyOf 1) | string | Alternative | Payment scale for the base compensation. Known values: hourly, daily, weekly, monthly, annually, two_weekly, bi_monthly, custom, one_off |
scale (anyOf 2) | null | Alternative | |
status | string | Required within parent | Status of the Global Payroll amendment. 'applied' only appears after a type_of_edit=direct request — the change took effect immediately and no pending amendment remains. Known values: waiting_for_approval, waiting_client_sign, waiting_worker_sign, signed, completed, obsolete, applied |
updated_at | string | Required within parent | Timestamp when the amendment was last updated. Format: date-time |
Update contract — request body — body / data / base_compensation_type: salaried, hourly, unpaid, commission only, contract term: definite, indefinite, type of edit: amendment, direct
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | You can specify any combination of data points that need changing for a Global Payroll amendment, alongside the required effective_date. |
amount | number | Optional | Base compensation amount to be paid per scale. Format: double Maximum: 1000000000 Minimum: 0 |
base_compensation_custom_name | string | Optional | Custom display name for the base compensation. Maximum length: 255 |
base_compensation_type | string | Optional | Type of base compensation. Defaults to salaried if base compensation fields are provided and this is omitted. Default: salaried One of: salaried, hourly, unpaid, commission_only |
change_reason | string | Optional | The unique identifier (oid) of a modification reason configured for the organization, not free text. Required by organizations that have modification reasons configured. Format: uuid |
contract_start_date | string | Optional | Short date in format ISO-8601 (YYYY-MM-DD). The contract start date. Format: date |
contract_term | string | Optional | Whether the contract has a fixed end date. 'end_date' is required when this is 'definite'. One of: definite, indefinite |
currency_code | string | Optional | Currency code in ISO 4217 format. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
custom_fields | array | Optional | Custom field values to update. |
custom_fields[] | Model | Each item | Expand Update contract — request body — body / data / base_compensation_type: salaried, hourly, unpaid, commission only, contract term: definite, indefinite, type of edit: amendment, direct custom fields item |
effective_date | string | Required within parent | Short date in format ISO-8601 (YYYY-MM-DD) when the amendment takes effect. Required — the amendment cannot be signed without it. Format: date |
end_date | string | Optional | Short date in format ISO-8601 (YYYY-MM-DD). Required when contract_term is 'definite'. Format: date |
pay_slip_currency | string | Optional | Currency shown on the payslip. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
payout_currency | string | Optional | Currency the worker is paid out in. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
scale | string | Optional | Defines the scale at which the base compensation amount is paid. One of: hourly, daily, weekly, monthly, annually, two_weekly, bi_monthly, custom, one_off |
type_of_edit | string | Optional | Whether the change requires a signature. 'amendment' (default) creates a pending amendment that must be signed via POST /contracts/{contract_id}/amendments/{amendment_id}/sign before it takes effect. 'direct' applies the change immediately, with no signature required. Default: amendment One of: amendment, direct |
variable_compensations | array | Optional | Variable compensations to add or update alongside the base compensation change. |
variable_compensations[] | Model | Each item | Expand Update contract — request body — body / data / base_compensation_type: salaried, hourly, unpaid, commission only, contract term: definite, indefinite, type of edit: amendment, direct variable compensations item |
Referenced models: Update contract — request body — body / data / base_compensation_type: salaried, hourly, unpaid, commission only, contract term: definite, indefinite, type of edit: amendment, direct custom fields item, Update contract — request body — body / data / base_compensation_type: salaried, hourly, unpaid, commission only, contract term: definite, indefinite, type of edit: amendment, direct variable compensations item
Update contract — request body — body / data / base_compensation_type: salaried, hourly, unpaid, commission only, contract term: definite, indefinite, type of edit: amendment, direct custom fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
currency | string | Optional | Currency code in ISO 4217 format, for a currency-typed custom field. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
id | string | Required within parent | The unique identifier of the custom field. Format: uuid |
value | Model | Required within parent | Expand Update contract — request body — body / data / base_compensation_type: salaried, hourly, unpaid, commission only, contract term: definite, indefinite, type of edit: amendment, direct custom fields item value The new value for the custom field. |
Update contract — request body — body / data / base_compensation_type: salaried, hourly, unpaid, commission only, contract term: definite, indefinite, type of edit: amendment, direct custom fields item value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | The new value for the custom field. |
$ (oneOf 1) | string | Alternative | Maximum length: 5000 |
$ (oneOf 2) | number | Alternative | Format: double |
$ (oneOf 3) | boolean | Alternative |
Update contract — request body — body / data / base_compensation_type: salaried, hourly, unpaid, commission only, contract term: definite, indefinite, type of edit: amendment, direct variable compensations item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
currency_code | string | Required within parent | Currency code in ISO 4217 format. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
effective_date | string | Required within parent | Short date in format ISO-8601 (YYYY-MM-DD) when this variable compensation takes effect. Format: date |
effective_end_date | string or null | Optional | Short date in format ISO-8601 (YYYY-MM-DD) when this variable compensation stops applying, if it does. Format: date |
format | string | Optional | Whether the rate is a fixed amount or a percentage. One of: amount, percentage |
id | string | Optional | The unique identifier of an existing variable compensation being updated. Omit when adding a new one. Format: uuid |
rate | number | Required within parent | Variable compensation amount to be paid per scale. Format: double Maximum: 1000000000 Minimum: 0 |
scale | string | Required within parent | Defines the scale at which the variable compensation amount is paid. One of: bi_annually, annually, quarterly, monthly, one_off |
variable_compensation_configuration_id | string | Required within parent | The unique identifier of the variable compensation configuration. Format: uuid |
Update contract — request body — body / data / cycle_end_type: DAY OF WEEK, DAY OF LAST WEEK, DAY OF MONTH, frequency: weekly, monthly, biweekly, semimonthly, calendar-month, payment due type: REGULAR, WITHIN MONTH, scale: hourly, daily, weekly, monthly, biweekly, semimonthly, custom
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | You can specify any combination of data points that need changing. |
amount | number | Optional | Amount to be paid per scale. Format: double Minimum: 1 |
currency_code | string | Optional | Currency code in ISO 4217 format. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
cycle_end | number | Optional | Day of the month when the 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 |
effective_date | string | Optional | Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31. Format: date |
first_payment | number | Optional | Amount to be paid as the first payment. Format: double Minimum: 0 |
first_payment_date | string | Optional | Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31. Format: date |
frequency | string | Optional | Scale of the invoice cycle. One of: weekly, monthly, biweekly, semimonthly, calendar-month |
job_title_id | Model | Optional | Expand Update contract — request body — body / data / cycle_end_type: DAY OF WEEK, DAY OF LAST WEEK, DAY OF MONTH, frequency: weekly, monthly, biweekly, semimonthly, calendar-month, payment due type: REGULAR, WITHIN MONTH, scale: hourly, daily, weekly, monthly, biweekly, semimonthly, custom job title id |
job_title_name | string | Optional | You can enter new job title. |
pay_before_weekends | boolean | Optional | If the payment due is on a weekend, pay on Friday. |
payment_due_days | number | Optional | Number of days after the invoice is sent that the payment is due. 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'. Default: REGULAR One of: REGULAR, WITHIN_MONTH |
scale | string | Optional | 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 |
scope_of_work | string | Optional | Text to describe the scope of work of the contract. |
seniority_id | Model | Optional | Expand Update contract — request body — body / data / cycle_end_type: DAY OF WEEK, DAY OF LAST WEEK, DAY OF MONTH, frequency: weekly, monthly, biweekly, semimonthly, calendar-month, payment due type: REGULAR, WITHIN MONTH, scale: hourly, daily, weekly, monthly, biweekly, semimonthly, custom job title id |
special_clause | string | Optional | Text to describe any special clause in contract. |
start_date | string | Optional | The contract start date in ISO-8601 format (YYYY-MM-DD). Updates the contract's effective date. Format: date |
Update contract — request body — body / data / cycle_end_type: DAY OF WEEK, DAY OF LAST WEEK, DAY OF MONTH, frequency: weekly, monthly, biweekly, semimonthly, calendar-month, payment due type: REGULAR, WITHIN MONTH, scale: hourly, daily, weekly, monthly, biweekly, semimonthly, custom job title id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (oneOf 1) | string | Alternative | |
$ (oneOf 2) | integer | Alternative | Format: int64 |
Update contract — request body — body data
Referenced models: Update contract — request body — body / data / cycle_end_type: DAY OF WEEK, DAY OF LAST WEEK, DAY OF MONTH, frequency: weekly, monthly, biweekly, semimonthly, calendar-month, payment due type: REGULAR, WITHIN MONTH, scale: hourly, daily, weekly, monthly, biweekly, semimonthly, custom, Update contract — request body — body / data / base_compensation_type: salaried, hourly, unpaid, commission only, contract term: definite, indefinite, type of edit: amendment, direct