Deel: Update contract — request body — body data base compensation type: salaried, hourly, unpaid, commission only, contract term: definite, indefinite, type of edit: amendment, direct
Update contract: request body, field body / data / base_compensation_type: salaried, hourly, unpaid, commission_only, contract_term: definite, indefinite, type_of_edit: amendment, direct. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: 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 /rest/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