Skip to content

Deel: Contractor amendments schemas

15 Deel schemas with complete fields and constraints.

← Contractor amendments operations · All schemas

List contract amendments — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
cursorJSONRequired within parent
cursor (anyOf 1)stringAlternativeCursor for the next page of results.
cursor (anyOf 2)nullAlternativeCursor for the next page of results.
dataarrayRequired within parentList of amendments. IC contracts may return multiple; Global Payroll contracts return at most one (the current pending amendment).
data[]ModelEach itemExpand List contract amendments — 200 response body — data item
has_morebooleanRequired within parentIndicates if there are more work statements available.
total_countJSONRequired within parent
total_count (anyOf 1)integerAlternativeTotal number of work statements matching the filters.
total_count (anyOf 2)stringAlternativePattern: ^-?[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

FieldTypePresenceDescription and constraints
$objectRoot
contract_nameJSONOptional
contract_name (anyOf 1)stringAlternativeName of the associated contract.
contract_name (anyOf 2)nullAlternativeName of the associated contract.
contract_typeJSONOptionalType of the associated IC contract.
contract_type (anyOf 1)stringAlternativeType 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)nullAlternative
created_atstringRequired within parentTimestamp when the work statement was created.
Format: date-time
currency_codeJSONOptional
currency_code (anyOf 1)stringAlternativeCurrency code in ISO 4217 format (e.g., USD, EUR, GBP).
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
currency_code (anyOf 2)nullAlternativeCurrency code in ISO 4217 format (e.g., USD, EUR, GBP).
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
effective_dateJSONOptional
effective_date (anyOf 1)stringAlternativeEffective date when the work statement becomes active.
Format: date-time
effective_date (anyOf 2)nullAlternativeEffective date when the work statement becomes active.
Format: date-time
idstringRequired within parentUnique identifier for the work statement.
Format: uuid
rateJSONOptional
rate (anyOf 1)JSONAlternative
rate (anyOf 1) (anyOf 1)numberAlternativeCompensation rate per scale. The amount paid according to the specified scale (e.g., 5000 per month).
Format: double
rate (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
rate (anyOf 2)nullAlternativeCompensation rate per scale. The amount paid according to the specified scale (e.g., 5000 per month).
Format: double
scaleJSONOptionalPayment frequency/scale that defines how often the rate is paid.
scale (anyOf 1)stringAlternativePayment frequency/scale that defines how often the rate is paid.
Known values: hourly, daily, weekly, monthly, biweekly, semimonthly, custom
scale (anyOf 2)nullAlternative
sign_statusstringRequired within parentCurrent sign status of the work statement.
Known values: PENDING, WAITING_FOR_APPROVAL, APPROVED, DECLINED
statusstringRequired within parentCurrent status of the work statement.
Known values: INITIAL, PENDING, ACTIVE, OUTDATED, APPROVED, DECLINED
updated_atstringRequired within parentTimestamp when the work statement was last updated.
Format: date-time

List contract amendments — 200 response body — data item

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)ModelAlternativeExpand 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)ModelAlternativeExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
base_compensation_typeJSONOptionalType of base compensation for the amendment.
base_compensation_type (anyOf 1)stringAlternativeType of base compensation for the amendment.
Known values: salaried, hourly, unpaid, commission_only
base_compensation_type (anyOf 2)nullAlternative
created_atstringRequired within parentTimestamp when the amendment was created.
Format: date-time
currency_codeJSONOptional
currency_code (anyOf 1)stringAlternativeCurrency code for the base compensation.
currency_code (anyOf 2)nullAlternativeCurrency code for the base compensation.
effective_dateJSONOptional
effective_date (anyOf 1)stringAlternativeShort date in format ISO-8601 (YYYY-MM-DD) when the amendment takes effect.
Format: date
effective_date (anyOf 2)nullAlternativeShort date in format ISO-8601 (YYYY-MM-DD) when the amendment takes effect.
Format: date
idstringRequired within parentUnique identifier for the amendment.
Format: uuid
rateJSONOptional
rate (anyOf 1)JSONAlternative
rate (anyOf 1) (anyOf 1)numberAlternativeBase compensation rate for the amendment.
Format: double
rate (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
rate (anyOf 2)nullAlternativeBase compensation rate for the amendment.
Format: double
scaleJSONOptionalPayment scale for the base compensation.
scale (anyOf 1)stringAlternativePayment scale for the base compensation.
Known values: hourly, daily, weekly, monthly, annually, two_weekly, bi_monthly, custom, one_off
scale (anyOf 2)nullAlternative
sign_statusJSONRequired within parentSign 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)stringAlternativeSign 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)nullAlternative
statusstringRequired within parentStatus of the Global Payroll amendment.
Known values: waiting_for_approval, waiting_client_sign, waiting_worker_sign, signed, completed, obsolete
updated_atstringRequired within parentTimestamp when the amendment was last updated.
Format: date-time

Update contract — 201 response body

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

Referenced models: Update contract — 201 response body — data

Update contract — 201 response body — data

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)ModelAlternativeExpand Update contract — 201 response body — data / status: initial, pending, active, outdated, approved, declined
$ (anyOf 2)ModelAlternativeExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
createdbooleanRequired within parentContract has been successfully amended.
created_atstringRequired within parentTimestamp when the work statement was created.
Format: date-time
currency_codestringOptionalCurrency code for the amended work statement.
idstringRequired within parentThe unique identifier of the created amendment.
Format: uuid
job_titleJSONOptional
job_title (anyOf 1)stringAlternativeJob title for the amended work statement.
job_title (anyOf 2)nullAlternativeJob title for the amended work statement.
rateJSONOptional
rate (anyOf 1)JSONAlternative
rate (anyOf 1) (anyOf 1)numberAlternativeRate/amount for the amended work statement.
Format: double
rate (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
rate (anyOf 2)nullAlternativeRate/amount for the amended work statement.
Format: double
scaleJSONOptionalPayment scale for the amended work statement.
scale (anyOf 1)stringAlternativePayment scale for the amended work statement.
Known values: hourly, daily, weekly, monthly, biweekly, semimonthly, custom
scale (anyOf 2)nullAlternative
scope_of_workJSONOptional
scope_of_work (anyOf 1)stringAlternativeScope of work for the amended work statement.
scope_of_work (anyOf 2)nullAlternativeScope of work for the amended work statement.
special_clauseJSONOptional
special_clause (anyOf 1)stringAlternativeSpecial clause for the amended work statement.
special_clause (anyOf 2)nullAlternativeSpecial clause for the amended work statement.
statusstringRequired within parentStatus of the amended work statement.
Known values: initial, pending, active, outdated, approved, declined
termination_notice_daysJSONOptional
termination_notice_days (anyOf 1)integerAlternativeNumber of days notice required for termination. Defaults to 10 if not provided.
termination_notice_days (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updated_atstringRequired within parentTimestamp when the work statement was last updated.
Format: date-time
worker_idJSONOptional
worker_id (anyOf 1)stringAlternativeThe unique identifier of the worker.
Format: uuid
worker_id (anyOf 2)nullAlternativeThe 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

FieldTypePresenceDescription and constraints
$objectRoot
base_compensation_typeJSONOptionalType of base compensation for the amendment.
base_compensation_type (anyOf 1)stringAlternativeType of base compensation for the amendment.
Known values: salaried, hourly, unpaid, commission_only
base_compensation_type (anyOf 2)nullAlternative
createdbooleanRequired within parentTrue if this call created a new amendment, false if it updated an existing pending one.
created_atstringRequired within parentTimestamp when the amendment was created.
Format: date-time
currency_codeJSONOptional
currency_code (anyOf 1)stringAlternativeCurrency code for the base compensation.
currency_code (anyOf 2)nullAlternativeCurrency code for the base compensation.
effective_dateJSONOptional
effective_date (anyOf 1)stringAlternativeShort date in format ISO-8601 (YYYY-MM-DD) when the amendment takes effect.
Format: date
effective_date (anyOf 2)nullAlternativeShort date in format ISO-8601 (YYYY-MM-DD) when the amendment takes effect.
Format: date
idstringRequired within parentThe unique identifier of the amendment.
Format: uuid
rateJSONOptional
rate (anyOf 1)JSONAlternative
rate (anyOf 1) (anyOf 1)numberAlternativeBase compensation rate for the amended employment agreement.
Format: double
rate (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
rate (anyOf 2)nullAlternativeBase compensation rate for the amended employment agreement.
Format: double
scaleJSONOptionalPayment scale for the base compensation.
scale (anyOf 1)stringAlternativePayment scale for the base compensation.
Known values: hourly, daily, weekly, monthly, annually, two_weekly, bi_monthly, custom, one_off
scale (anyOf 2)nullAlternative
statusstringRequired within parentStatus 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_atstringRequired within parentTimestamp 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

FieldTypePresenceDescription and constraints
$objectRootYou can specify any combination of data points that need changing for a Global Payroll amendment, alongside the required effective_date.
amountnumberOptionalBase compensation amount to be paid per scale.
Format: double
Maximum: 1000000000
Minimum: 0
base_compensation_custom_namestringOptionalCustom display name for the base compensation.
Maximum length: 255
base_compensation_typestringOptionalType 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_reasonstringOptionalThe 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_datestringOptionalShort date in format ISO-8601 (YYYY-MM-DD). The contract start date.
Format: date
contract_termstringOptionalWhether the contract has a fixed end date. 'end_date' is required when this is 'definite'.
One of: definite, indefinite
currency_codestringOptionalCurrency code in ISO 4217 format.
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
custom_fieldsarrayOptionalCustom field values to update.
custom_fields[]ModelEach itemExpand 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_datestringRequired within parentShort date in format ISO-8601 (YYYY-MM-DD) when the amendment takes effect. Required — the amendment cannot be signed without it.
Format: date
end_datestringOptionalShort date in format ISO-8601 (YYYY-MM-DD). Required when contract_term is 'definite'.
Format: date
pay_slip_currencystringOptionalCurrency shown on the payslip.
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
payout_currencystringOptionalCurrency the worker is paid out in.
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
scalestringOptionalDefines 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_editstringOptionalWhether 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_compensationsarrayOptionalVariable compensations to add or update alongside the base compensation change.
variable_compensations[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
currencystringOptionalCurrency code in ISO 4217 format, for a currency-typed custom field.
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
idstringRequired within parentThe unique identifier of the custom field.
Format: uuid
valueModelRequired within parentExpand 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.

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 value

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

FieldTypePresenceDescription and constraints
$JSONRootThe new value for the custom field.
$ (oneOf 1)stringAlternativeMaximum length: 5000
$ (oneOf 2)numberAlternativeFormat: double
$ (oneOf 3)booleanAlternative

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

FieldTypePresenceDescription and constraints
$objectRoot
currency_codestringRequired within parentCurrency code in ISO 4217 format.
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
effective_datestringRequired within parentShort date in format ISO-8601 (YYYY-MM-DD) when this variable compensation takes effect.
Format: date
effective_end_datestring or nullOptionalShort date in format ISO-8601 (YYYY-MM-DD) when this variable compensation stops applying, if it does.
Format: date
formatstringOptionalWhether the rate is a fixed amount or a percentage.
One of: amount, percentage
idstringOptionalThe unique identifier of an existing variable compensation being updated. Omit when adding a new one.
Format: uuid
ratenumberRequired within parentVariable compensation amount to be paid per scale.
Format: double
Maximum: 1000000000
Minimum: 0
scalestringRequired within parentDefines the scale at which the variable compensation amount is paid.
One of: bi_annually, annually, quarterly, monthly, one_off
variable_compensation_configuration_idstringRequired within parentThe 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

FieldTypePresenceDescription and constraints
$objectRootYou can specify any combination of data points that need changing.
amountnumberOptionalAmount to be paid per scale.
Format: double
Minimum: 1
currency_codestringOptionalCurrency code in ISO 4217 format.
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
cycle_endnumberOptionalDay of the month when the cycle ends.
Format: double
Maximum: 31
Minimum: 1
cycle_end_typestringOptionalCycle 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_datestringOptionalShort date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.
Format: date
first_paymentnumberOptionalAmount to be paid as the first payment.
Format: double
Minimum: 0
first_payment_datestringOptionalShort date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.
Format: date
frequencystringOptionalScale of the invoice cycle.
One of: weekly, monthly, biweekly, semimonthly, calendar-month
job_title_idModelOptionalExpand 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_namestringOptionalYou can enter new job title.
pay_before_weekendsbooleanOptionalIf the payment due is on a weekend, pay on Friday.
payment_due_daysnumberOptionalNumber of days after the invoice is sent that the payment is due.
Format: double
Maximum: 90
Minimum: 0
payment_due_typestringOptionalType of payment due. If the payment is due on the last day of month, enter 'WITHIN_MONTH'.
Default: REGULAR
One of: REGULAR, WITHIN_MONTH
scalestringOptionalDefines 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_workstringOptionalText to describe the scope of work of the contract.
seniority_idModelOptionalExpand 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_clausestringOptionalText to describe any special clause in contract.
start_datestringOptionalThe contract start date in ISO-8601 format (YYYY-MM-DD). Updates the contract's effective date.
Format: date

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 job title id

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

FieldTypePresenceDescription and constraints
$JSONRoot
$ (oneOf 1)stringAlternative
$ (oneOf 2)integerAlternativeFormat: int64

Update contract — request body — body data

FieldTypePresenceDescription and constraints
$JSONRoot
$ (oneOf 1)ModelAlternativeExpand 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
$ (oneOf 2)ModelAlternativeExpand Update contract — request body — body / data / base_compensation_type: salaried, hourly, unpaid, commission only, contract term: definite, indefinite, type of edit: amendment, direct

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

Report an issue with this page

Necessary

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

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

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

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