Skip to content

Deel: Update amendment — 200 response body — data

Update amendment: 200 response body, field data. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: Update amendment — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
amendment_statusesarrayOptionalList of amendment statuses representing the history and progression of an amendment.
amendment_statuses[]ModelEach itemExpand Create amendment — 201 response body — data amendment statuses item
created_atstringOptionalCreation date of the amendment.
Format: date-time
currencystringOptionalContract currency.
custom_itemsarrayOptionalCustom amendment items associated with the amendment flow
custom_items[]ModelEach itemExpand Accept amendment — 200 response body — data custom items item
descriptionJSONOptional
description (anyOf 1)stringAlternativeFree-text description of the amendment.
description (anyOf 2)nullAlternativeFree-text description of the amendment.
document_typeJSONOptionalAmendment document type
document_type (anyOf 1)stringAlternativeAmendment document type
Known values: EA, SOW, SOW_EA
document_type (anyOf 2)nullAlternative
effective_dateJSONOptional
effective_date (anyOf 1)stringAlternativeEffective date of the amendment.
Format: date-time
effective_date (anyOf 2)nullAlternativeEffective date of the amendment.
Format: date-time
employee_nationalitystringOptionalNationality of the employee.
employment_stateJSONOptional
employment_state (anyOf 1)stringAlternativeState of employment.
employment_state (anyOf 2)nullAlternativeState of employment.
employment_typestringOptionalType of employment.
Known values: FULL_TIME, PART_TIME
end_dateJSONOptional
end_date (anyOf 1)stringAlternativeEnd date of the employment.
Format: date-time
end_date (anyOf 2)nullAlternativeEnd date of the employment.
Format: date-time
fixed_adjustmentsarrayOptionalList of fixed adjustments associated with the amendment request.
fixed_adjustments[]ModelEach itemExpand Accept amendment — 200 response body — data fixed adjustments item
holidaysJSONOptional
holidays (anyOf 1)JSONAlternative
holidays (anyOf 1) (anyOf 1)integerAlternativeNumber of holidays.
holidays (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
holidays (anyOf 2)nullAlternativeNumber of holidays.
hourly_rateJSONOptional
hourly_rate (anyOf 1)stringAlternativeHourly rate of the amendment
hourly_rate (anyOf 2)nullAlternativeHourly rate of the amendment
idstringOptionalId of amendment
Format: uuid
is_effective_date_updatedbooleanOptionalIs Effective Date updated.
is_hrx_action_neededbooleanOptionalIs HRX action needed.
itemsarrayOptionalItems of amendment
items[]ModelEach itemExpand Accept amendment — 200 response body — data items item
job_categoryJSONOptional
job_category (anyOf 1)stringAlternativeJob category associated with the job title.
job_category (anyOf 2)nullAlternativeJob category associated with the job title.
job_codeJSONOptional
job_code (anyOf 1)stringAlternativeJob code associated with the job title.
job_code (anyOf 2)nullAlternativeJob code associated with the job title.
job_titlestringOptionalJob title associated with the amendment.
Maximum length: 1000
legal_contextJSONOptionalAdditional details needed for legal input
legal_context (anyOf 1)ModelAlternativeExpand Accept amendment — 200 response body — data legal context Additional details needed for legal input
legal_context (anyOf 2)nullAlternative
net_salaryJSONOptional
net_salary (anyOf 1)stringAlternativeNet salary for the amendment.
net_salary (anyOf 2)nullAlternativeNet salary for the amendment.
notice_period_after_probationJSONOptional
notice_period_after_probation (anyOf 1)stringAlternativeNotice period after probation.
notice_period_after_probation (anyOf 2)nullAlternativeNotice period after probation.
notice_period_during_probationJSONOptional
notice_period_during_probation (anyOf 1)stringAlternativeNotice period during probation.
notice_period_during_probation (anyOf 2)nullAlternativeNotice period during probation.
notice_period_time_unitJSONOptionalNotice period time unit.
notice_period_time_unit (anyOf 1)stringAlternativeNotice period time unit.
Known values: DAY, WEEK, MONTH
notice_period_time_unit (anyOf 2)nullAlternative
notice_period_typeJSONOptionalType of notice period.
notice_period_type (anyOf 1)stringAlternativeType of notice period.
Known values: STANDARD, CUSTOM
notice_period_type (anyOf 2)nullAlternative
probation_periodJSONOptional
probation_period (anyOf 1)JSONAlternative
probation_period (anyOf 1) (anyOf 1)integerAlternativeDuration of the probation period.
probation_period (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
probation_period (anyOf 2)nullAlternativeDuration of the probation period.
probation_period_type_for_definiteJSONOptionalType of probation period for definite contracts.
probation_period_type_for_definite (anyOf 1)stringAlternativeType of probation period for definite contracts.
Known values: STANDARD, CUSTOM
probation_period_type_for_definite (anyOf 2)nullAlternative
rejection_contextJSONOptionalAdditional details containing rejection reason
rejection_context (anyOf 1)ModelAlternativeExpand Accept amendment — 200 response body — data rejection context Additional details containing rejection reason
rejection_context (anyOf 2)nullAlternative
requested_byJSONOptional
requested_by (anyOf 1)stringAlternativeProfile name of the user who requested the change
requested_by (anyOf 2)nullAlternativeProfile name of the user who requested the change
salarystringOptionalSalary for the amendment.
scopestringOptionalScope of the amendment.
seniority_dateJSONOptional
seniority_date (anyOf 1)stringAlternativeThe 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_date (anyOf 2)nullAlternativeThe 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_idJSONOptional
seniority_id (anyOf 1)stringAlternativeSeniority level identifier.
Format: uuid
seniority_id (anyOf 2)nullAlternativeSeniority level identifier.
Format: uuid
sick_leave_daysJSONOptional
sick_leave_days (anyOf 1)JSONAlternative
sick_leave_days (anyOf 1) (anyOf 1)integerAlternativeNumber of sick leave days
sick_leave_days (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
sick_leave_days (anyOf 2)nullAlternativeNumber of sick leave days
sourceJSONOptionalSource of amendment flow creation.
source (anyOf 1)stringAlternativeSource of amendment flow creation.
Known values: APP, PUBLIC_API, APP_BULK_AMENDMENT
source (anyOf 2)nullAlternative
start_datestringOptionalStart date of the employment.
Format: date-time
time_off_typestringOptionalType of time off.
Known values: STANDARD, SPECIFIC, PRORATED
typeJSONOptionalType of amendment
type (anyOf 1)stringAlternativeType of amendment
Known values: INSTANT, OPS, LEGAL, DISABLED, CUSTOM, AUTOMATED
type (anyOf 2)nullAlternative
updated_atstringOptionalDate when amendment is updated
Format: date-time
variable_compensationModelOptionalExpand Accept amendment — 200 response body — data variable compensation
Represents a variable compensation record (such as a bonus, commission, or incentive) within a contract. It contains details like the amount, type, frequency, and whether it is part of an incentive plan. The record also tracks when it was created, updated, and whether it has been amended.
void_deadlineJSONOptional
void_deadline (anyOf 1)stringAlternativeDeadline this SOW to be voided
Format: date-time
void_deadline (anyOf 2)nullAlternativeDeadline this SOW to be voided
Format: date-time
void_deadline_typeJSONOptionalType of void deadline
void_deadline_type (anyOf 1)stringAlternativeType of void deadline
Known values: CUTOFF, START_DATE, END_DATE, EXPIRY
void_deadline_type (anyOf 2)nullAlternative
work_hours_per_weekstringOptionalNumber of work hours per week.
work_schedule_idJSONOptional
work_schedule_id (anyOf 1)stringAlternativeWork schedule id
Format: uuid
work_schedule_id (anyOf 2)nullAlternativeWork schedule id
Format: uuid
work_schedule_rules_versionJSONOptional
work_schedule_rules_version (anyOf 1)stringAlternativeWork schedule rule version.
work_schedule_rules_version (anyOf 2)nullAlternativeWork schedule rule version.

Referenced models: Create amendment — 201 response body — data amendment statuses item, Accept amendment — 200 response body — data custom items item, Accept amendment — 200 response body — data fixed adjustments item, Accept amendment — 200 response body — data items item, Accept amendment — 200 response body — data legal context Additional details needed for legal input, Accept amendment — 200 response body — data rejection context Additional details containing rejection reason, Accept amendment — 200 response 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.