Skip to content

Deel: Create amendment — request body — body data

Create amendment: request body, field body / data. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: Create amendment — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
additional_infoJSONOptionalAdditional metadata related to job validation and categorisation
additional_info (oneOf 1)ModelAlternativeExpand Create amendment — request body — body data additional info ai scope check public id, job categorization log id
additional_info (oneOf 2)nullAlternative
customarrayOptionalAn optional array of custom objects.
custom[]ModelEach itemExpand Create amendment — request body — body data custom item
effective_datestringOptionalEffective date for the amendment.
Format: date
employment_statestringOptionalState of employment.
employment_typestringOptionalType of employment.
One of: FULL_TIME, PART_TIME
end_datestringOptionalEnd date of the employment.
Format: date
fixed_adjustmentsarrayOptionalArray of fixed adjustments to be submitted for the amendment request.
fixed_adjustments[]ModelEach itemExpand Create amendment — request body — body data fixed adjustments item
holidaysnumberOptionalNumber of holidays.
Format: double
hourly_ratenumberOptionalHourly rate of the amendment. The max value supported is 1e19
Format: double
job_titlestringOptionalJob title associated with the amendment.
Maximum length: 1000
notice_period_after_probationnumberOptionalNotice period after probation.
Format: double
notice_period_during_probationnumberOptionalNotice period during probation.
Format: double
notice_period_typestringOptionalType of notice period.
One of: STANDARD, CUSTOM
probation_periodnumberOptionalDuration of the probation period.
Format: double
probation_period_type_for_definitestringOptionalType of probation period for definite contracts.
One of: STANDARD, CUSTOM
salarynumberOptionalSalary for the amendment.
Format: double
scopestringOptionalScope of the amendment.
Maximum length: 20000
seniority_datestring or nullOptionalThe seniority date represents the employee’s original start date with a previous employer. It is used to preserve employment tenure when the employee transfers to this company. Can be null if not applicable.
Format: date
seniority_idstringOptionalPublic Id of the seniority level.
Format: uuid
start_datestringOptionalStart date of the employment.
Format: date
time_off_typestringOptionalType of time off.
One of: STANDARD, SPECIFIC, PRORATED
variable_compensationModelOptionalExpand Create amendment — request body — body data variable compensation
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.
work_hours_per_weeknumberOptionalNumber of work hours per week.
Format: double

Referenced models: Create amendment — request body — body data additional info ai scope check public id, job categorization log id, Create amendment — request body — body data custom item, Create amendment — request body — body data fixed adjustments item, Create amendment — request body — body data variable compensation

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.