Deel: Create amendment — request body — body data variable compensation
Create amendment: request body, field body / data / variable_compensation. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: Create amendment — request body — body data variable compensation
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a change to an employee’s variable compensation (e.g., bonus or commission). This schema is used for creating new variable compensation items or updating existing ones. Some fields are required when creating, optional when updating, and forbidden when updating, as specified in each field description. |
amount | number | Required within parent | Positive amount for the variable compensation. Format: double Minimum: 0 |
effective_date | string | Optional | The date when this compensation starts or becomes effective. Required when creating a new compensation. Optional when updating an existing compensation. Format: date |
id | string | Optional | The ID of an existing active variable compensation to update or delete. Include this in the request only if you are updating or deleting an existing compensation. Do not include it when creating a new one. |
is_deleted | boolean | Optional | Flag to mark the variable compensation as deleted. Required only when the variable compensation needs to be removed; omit it otherwise |
timeline | string | Optional | How often this compensation occurs. Required when creating a new compensation. Forbidden when updating an existing compensation. One of: MONTHLY, QUARTERLY, ANNUALLY, BIANNUALLY |
title | string | Optional | The title of the compensation. Required when creating a new compensation. Optional when updating an existing compensation. Maximum length: 250 Minimum length: 1 |
type | string | Required within parent | Type of variable compensation. One of: PERCENTAGE, FIXED |