Skip to content

Deel: EOR amendments schemas

47 Deel schemas with complete fields and constraints.

← EOR amendments operations · All schemas

Accept amendment — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand Accept amendment — 200 response body — data

Referenced models: Accept amendment — 200 response body — data

Accept 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 Accept amendment — 200 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: Accept amendment — 200 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

Accept amendment — 200 response body — data amendment statuses item

FieldTypePresenceDescription and constraints
$objectRootDetails of a specific amendment status in the lifecycle of the amendment.
amendment_flow_statusModelOptionalExpand Accept amendment — 200 response body — data amendment statuses item amendment flow status
Metadata about the amendment status, including when it was created.
friendly_namestringOptionalHuman-readable label of the amendment status (e.g., DRAFT, PENDING, APPROVED).
namestringOptionalLogical, system-oriented identifier of the amendment status. Can be used to group statuses under a parent category and subgroup them for more granular state tracking. The structure typically follows a dot-separated hierarchy (e.g., 'PARENT','PARENT.CHILD', 'PARENT.CHILD.CHILD.CHILD', ...), which allows logical grouping and filtering of related statuses.

Referenced models: Accept amendment — 200 response body — data amendment statuses item amendment flow status

Accept amendment — 200 response body — data amendment statuses item amendment flow status

FieldTypePresenceDescription and constraints
$objectRootMetadata about the amendment status, including when it was created.
created_atstringOptionalThe timestamp when this amendment status was created.
Format: date-time

Accept amendment — 200 response body — data custom items item

FieldTypePresenceDescription and constraints
$objectRoot
descriptionJSONOptional
description (anyOf 1)stringAlternativeDetailed description of the custom amendment item
description (anyOf 2)nullAlternativeDetailed description of the custom amendment item
idstringRequired within parentUnique identifier for the custom amendment item
Format: uuid
rejection_reasonJSONOptional
rejection_reason (anyOf 1)stringAlternativeReason for rejection if the item was rejected
rejection_reason (anyOf 2)nullAlternativeReason for rejection if the item was rejected
statusstringRequired within parentCurrent status of the custom amendment item
Known values: REJECTED, APPROVED, PENDING_REVIEW, PENDING_LEGAL
typestringRequired within parentType/context of the custom amendment item

Accept amendment — 200 response body — data fixed adjustments item

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentTimestamp when the fixed adjustment was created.
Format: date-time
descriptionstringRequired within parentDescription of the fixed adjustment.
Maximum length: 256
Minimum length: 1
idstringRequired within parentSystem-generated unique identifier for the fixed adjustment record in an amendment request.
is_amendedbooleanRequired within parentWhether this fixed adjustment was amended from a previous one.
is_country_specificbooleanRequired within parentWhether this fixed adjustment applies only to a specific country.
is_deletedbooleanOptionalTrue if the fixed adjustment was deleted as part of the amendment; otherwise false.
is_recurringbooleanRequired within parentWhether the fixed adjustment is recurring. If set to false, it will be treated as a one-time fixed allowance.
parent_fixed_adjustment_idJSONOptional
parent_fixed_adjustment_id (anyOf 1)stringAlternativeReference to the parent fixed adjustment, if applicable.
parent_fixed_adjustment_id (anyOf 2)nullAlternativeReference to the parent fixed adjustment, if applicable.
statusstringRequired within parentCurrent status of the fixed adjustment.
Known values: WAITING_FOR_SIGNING, ACTIVE, OUTDATED, CANCELLED
updated_atstringRequired within parentTimestamp when the fixed adjustment was last updated.
Format: date-time
valuestringRequired within parentValue of the fixed adjustment.
Pattern: ^(?!0+(\.0+)?$)\d+(?:\.\d+)?$

Accept amendment — 200 response body — data items item

FieldTypePresenceDescription and constraints
$objectRoot
data_pointstringOptionalThe field that is selected for amendment.
idstringOptionalId of amendment item
Format: uuid
itemstringOptionalAmendment item
new_valuestringOptionalThe new valid value after the attempted change.
previous_valuestringOptionalThe previous valid value before the attempted change.
typestringOptionalType of amendment
Known values: INSTANT, OPS, LEGAL, DISABLED, CUSTOM, AUTOMATED

Accept amendment — 200 response body — data legal context Additional details needed for legal input

FieldTypePresenceDescription and constraints
$objectRootAdditional details needed for legal input
detailsstringOptionalDetails regarding the legal request
jira_ticketstringOptionalJira ticket identifier linked to the legal context
jira_web_urlstringOptionalLink to the Jira ticket for tracking
Format: uri
requested_atstringOptionalTimestamp when legal review was requested
Format: date-time
statusstringOptionalCurrent status of the legal review process
Known values: REQUEST_LEGAL_REVIEW, WAITING_FOR_ANOTHER_TEAM, WAITING_FOR_HRX_ACTION, DECLINED, SOLVED

Accept amendment — 200 response body — data rejection context Additional details containing rejection reason

FieldTypePresenceDescription and constraints
$objectRootAdditional details containing rejection reason
rejected_atstringOptionalTimestamp of when the rejection occurred
Format: date-time
rejection_reasonJSONOptional
rejection_reason (anyOf 1)stringAlternativeReason provided when the amendment was rejected. Null when the amendment was cancelled rather than rejected by an admin.
rejection_reason (anyOf 2)nullAlternativeReason provided when the amendment was rejected. Null when the amendment was cancelled rather than rejected by an admin.

Accept amendment — 200 response body — data variable compensation

FieldTypePresenceDescription and constraints
$objectRootRepresents 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.
amountstringRequired within parentThe value of the compensation. Shown as a string to keep the exact number of decimals.
Format: decimal
created_atstringRequired within parentThe date and time when this record was first created in the system.
Format: date-time
effective_datestringRequired within parentThe date when this compensation starts being valid.
Format: date-time
idstringRequired within parentThe unique ID assigned by the system to this variable compensation record.
incentive_planModelOptionalExpand Accept amendment — 200 response body — data variable compensation incentive plan
Details of the incentive plan linked to this compensation, if any.
is_amendedbooleanOptionalShows whether this compensation has been changed as part of an amendment.
is_deletedbooleanOptionalShows whether this compensation has been deleted.
parent_idJSONRequired within parent
parent_id (anyOf 1)stringAlternativeReference to the parent variable compensation, if applicable. Null if this compensation is not linked to any compensation.
parent_id (anyOf 2)nullAlternativeReference to the parent variable compensation, if applicable. Null if this compensation is not linked to any compensation.
timelinestringRequired within parentHow often the compensation is paid — for example monthly, quarterly, annually, or twice a year.
Known values: MONTHLY, QUARTERLY, ANNUALLY, BIANNUALLY
titlestringRequired within parentTitle or name of the variable compensation.
typestringRequired within parentThe way the compensation is calculated. `FIXED` means a fixed amount (like $1000). `PERCENTAGE` means it’s based on a percentage of the salary.
Known values: FIXED, PERCENTAGE
updated_atstringRequired within parentThe date and time when this record was last updated.
Format: date-time

Referenced models: Accept amendment — 200 response body — data variable compensation incentive plan

Accept amendment — 200 response body — data variable compensation incentive plan

FieldTypePresenceDescription and constraints
$objectRootDetails of the incentive plan linked to this compensation, if any.
detailsstringOptionalExtra details about the incentive plan, if any.
employee_signaturestringOptionalThe employee’s signature for the incentive plan, if collected.
employee_signed_atstringOptionalThe date and time when the employee signed the incentive plan. Empty if not signed.
Format: date-time

Cancel amendment — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Cancel amendment — 200 response body — data

Referenced models: Cancel amendment — 200 response body — data

Cancel amendment — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
successbooleanRequired within parentWhether the amendment was deleted.

Confirm amendment — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand Confirm amendment — 200 response body — data

Referenced models: Confirm amendment — 200 response body — data

Confirm 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 Confirm 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-time
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-time
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
void_deadline (anyOf 2)nullAlternativeDeadline this SOW to be voided
Format: date
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, Confirm amendment — 200 response body — data items 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 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

Confirm amendment — 200 response body — data items item

FieldTypePresenceDescription and constraints
$objectRoot
data_pointstringOptionalThe field that is selected for amendment.
idstringOptionalId of amendment item
Format: uuid
itemstringOptionalAmendment item
new_valuestringOptionalThe new valid value after the attempted change.
previous_valuestringOptionalThe previous valid value before the attempted change.
typestringOptionalType of amendment

Contract amendment PDF — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand Contract amendment PDF — 200 response body — data

Referenced models: Contract amendment PDF — 200 response body — data

Contract amendment PDF — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
urlstringOptionalPre-signed URL to download the exported PDF (valid for 15 minutes).
Format: uri

Create amendment — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand Create amendment — 201 response body — data

Referenced models: Create amendment — 201 response body — data

Create amendment — 201 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-time
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-time
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

Create amendment — 201 response body — data amendment statuses item

FieldTypePresenceDescription and constraints
$objectRoot
amendment_flow_statusModelOptionalExpand Create amendment — 201 response body — data amendment statuses item amendment flow status
Metadata about the amendment status, including when it was created.
friendly_namestringOptionalFriendly name of amendment status
namestringOptionalLogical, system-oriented identifier of the amendment status. Can be used to group statuses under a parent category and subgroup them for more granular state tracking. The structure typically follows a dot-separated hierarchy (e.g., 'PARENT','PARENT.CHILD', 'PARENT.CHILD.CHILD.CHILD', ...), which allows logical grouping and filtering of related statuses.

Referenced models: Create amendment — 201 response body — data amendment statuses item amendment flow status

Create amendment — 201 response body — data amendment statuses item amendment flow status

FieldTypePresenceDescription and constraints
$objectRootMetadata about the amendment status, including when it was created.
created_atstringOptionalCreation date
Format: date-time

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

Create amendment — request body — body data additional info ai scope check public id, job categorization log id

FieldTypePresenceDescription and constraints
$objectRootAdditional metadata related to job validation and categorisation
ai_scope_check_public_idstringOptionalIdentifier or flag for AI scope validation check
Format: uuid
job_categorization_log_idstringOptionalIdentifier for job categorisation log
Format: uuid

Create amendment — request body — body data custom item

FieldTypePresenceDescription and constraints
$objectRoot
descriptionstringRequired within parentA required description for the custom object.
Maximum length: 1000
Minimum length: 50
idstringOptionalAn optional identifier for the custom object.
Format: uuid
typestringRequired within parentThe type of the custom object. Must be one of the valid custom types.

Create amendment — request body — body data fixed adjustments item

FieldTypePresenceDescription and constraints
$objectRoot
descriptionstringRequired within parentDescription of the fixed adjustment.
Maximum length: 256
Minimum length: 1
idstringOptionalThe ID of an existing active fixed adjustment to update or delete. Include this in the request only if you are updating or deleting an existing adjustment. Do not include it when creating a new one.
is_deletedbooleanOptionalFlag to mark the fixed adjustment as deleted. Required only when the fixed adjustment needs to be removed; omit it otherwise.
is_recurringbooleanRequired within parentWhether the fixed adjustment is recurring. If set to false, it will be treated as a one-time fixed allowance.
valuestringRequired within parentValue of the fixed adjustment. Must be a positive number, not zero.
Pattern: ^(?!0+(\.0+)?$)\d+(?:\.\d+)?$

Create amendment — request body — body data variable compensation

FieldTypePresenceDescription and constraints
$objectRootRepresents 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.
amountnumberRequired within parentPositive amount for the variable compensation.
Format: double
Minimum: 0
effective_datestringOptionalThe date when this compensation starts or becomes effective. Required when creating a new compensation. Optional when updating an existing compensation.
Format: date
idstringOptionalThe 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_deletedbooleanOptionalFlag to mark the variable compensation as deleted. Required only when the variable compensation needs to be removed; omit it otherwise
timelinestringOptionalHow often this compensation occurs. Required when creating a new compensation. Forbidden when updating an existing compensation.
One of: MONTHLY, QUARTERLY, ANNUALLY, BIANNUALLY
titlestringOptionalThe title of the compensation. Required when creating a new compensation. Optional when updating an existing compensation.
Maximum length: 250
Minimum length: 1
typestringRequired within parentType of variable compensation.
One of: PERCENTAGE, FIXED

Get amendment validation settings — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayOptional
data[]ModelEach itemExpand Get amendment validation settings — 200 response body — data item

Referenced models: Get amendment validation settings — 200 response body — data item

Get amendment validation settings — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
data_pointstringOptionalThe name of the data point being configured.
rulesarrayOptionalThe rules for the data point.
rules[]ModelEach itemExpand Get amendment validation settings — 200 response body — data item rules item

Referenced models: Get amendment validation settings — 200 response body — data item rules item

Get amendment validation settings — 200 response body — data item rules item

FieldTypePresenceDescription and constraints
$objectRoot
additional_detailsModelOptionalExpand Get amendment validation settings — 200 response body — data item rules item additional details
Optional additional information for rules, if applicable.
external_validationbooleanOptionalIndicates whether external validation/fetching is required for this data point. If yes, the information for this data point must be retrieved using another endpoint.
is_editablebooleanOptionalIndicates whether the data point can be updated.
maxJSONOptional
max (anyOf 1)numberAlternativeThe maximum allowable value for numerical data points.
Format: double
max (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_dateJSONOptional
max_date (anyOf 1)stringAlternativeThe latest allowable date for date-type data points.
Format: date
max_date (anyOf 2)nullAlternativeThe latest allowable date for date-type data points.
Format: date
minJSONOptional
min (anyOf 1)JSONAlternative
min (anyOf 1) (anyOf 1)numberAlternativeThe minimum allowable value for numerical data points.
Format: double
min (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
min (anyOf 2)nullAlternativeThe minimum allowable value for numerical data points.
Format: double
min_dateJSONOptional
min_date (anyOf 1)stringAlternativeThe earliest allowable date for date-type data points.
Format: date
min_date (anyOf 2)nullAlternativeThe earliest allowable date for date-type data points.
Format: date
nullablebooleanOptionalIndicates whether the data point can be null.
possible_optionsarrayOptionalA list of possible values the data point can have. Unique for each data point.
possible_options[]stringEach item
requiresModelOptionalExpand Get amendment validation settings — 200 response body — data item rules item requires
Contract conditions that must be met for this rule to be applied.
tenure_based_rulesarrayOptionalDefines notice period rules based on the duration of employment.
tenure_based_rules[]ModelEach itemExpand Get amendment validation settings — 200 response body — data item rules item tenure based rules item

Referenced models: Get amendment validation settings — 200 response body — data item rules item requires, Get amendment validation settings — 200 response body — data item rules item additional details, Get amendment validation settings — 200 response body — data item rules item tenure based rules item

Get amendment validation settings — 200 response body — data item rules item additional details

FieldTypePresenceDescription and constraints
$objectRootOptional additional information for rules, if applicable.
capJSONOptional
cap (anyOf 1)JSONAlternative
cap (anyOf 1) (anyOf 1)numberAlternativeThe maximum limit imposed for probation period for definite contract when specific calculation is used, it will be in additional_details.rule.
Format: double
cap (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
cap (anyOf 2)nullAlternativeThe maximum limit imposed for probation period for definite contract when specific calculation is used, it will be in additional_details.rule.
Format: double
noteJSONOptional
note (anyOf 1)stringAlternativeAdditional explanation or notes related to this rule.
note (anyOf 2)nullAlternativeAdditional explanation or notes related to this rule.
ruleJSONOptionalSpecific rule that applies for probation period.
rule (anyOf 1)stringAlternativeSpecific rule that applies for probation period.
Known values: ONE_QUARTER_OF_CONTRACT_DURATION, ONE_THIRD_OF_CONTRACT_DURATION, HALF_OF_CONTRACT_DURATION
rule (anyOf 2)nullAlternative
time_unitJSONOptionalThe unit of time applicable to notice period.
time_unit (anyOf 1)stringAlternativeThe unit of time applicable to notice period.
Known values: WEEK, MONTH, DAY
time_unit (anyOf 2)nullAlternative

Get amendment validation settings — 200 response body — data item rules item requires

FieldTypePresenceDescription and constraints
$objectRootContract conditions that must be met for this rule to be applied.

Get amendment validation settings — 200 response body — data item rules item tenure based rules item

FieldTypePresenceDescription and constraints
$objectRoot
employment_duration_typeJSONOptionalThe unit of measurement for the employment duration.
employment_duration_type (anyOf 1)stringAlternativeThe unit of measurement for the employment duration.
Known values: DAY, WEEK, MONTH, YEAR
employment_duration_type (anyOf 2)nullAlternative
max_employment_durationJSONOptional
max_employment_duration (anyOf 1)JSONAlternative
max_employment_duration (anyOf 1) (anyOf 1)integerAlternativeThe maximum duration of employment for this rule to apply.
max_employment_duration (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_employment_duration (anyOf 2)nullAlternativeThe maximum duration of employment for this rule to apply.
min_employment_durationJSONOptional
min_employment_duration (anyOf 1)JSONAlternative
min_employment_duration (anyOf 1) (anyOf 1)integerAlternativeThe minimum duration of employment for this rule to apply.
min_employment_duration (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
min_employment_duration (anyOf 2)nullAlternativeThe minimum duration of employment for this rule to apply.
notice_valueJSONOptional
notice_value (anyOf 1)JSONAlternative
notice_value (anyOf 1) (anyOf 1)integerAlternativeThe required notice period for this range of employment duration.
notice_value (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
notice_value (anyOf 2)nullAlternativeThe required notice period for this range of employment duration.

Get amendments by contract — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayOptional
data[]ModelEach itemExpand Get amendments by contract — 200 response body — data item

Referenced models: Get amendments by contract — 200 response body — data item

Get amendments by contract — 200 response body — data item

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 Get amendments by contract — 200 response body — data item 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 Get amendments by contract — 200 response body — data item 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-time
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-time
seniority_idJSONOptional
seniority_id (anyOf 1)stringAlternativeNew seniority level identifier.
Format: uuid
seniority_id (anyOf 2)nullAlternativeNew seniority 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 rejection context Additional details containing rejection reason, Accept amendment — 200 response body — data variable compensation, Get amendments by contract — 200 response body — data item items item, Get amendments by contract — 200 response body — data item legal context Additional details needed for legal input

Get amendments by contract — 200 response body — data item items item

FieldTypePresenceDescription and constraints
$objectRoot
data_pointstringOptionalThe field that is selected for amendment.
idstringOptionalId of amendment item
Format: uuid
itemstringOptionalAmendment item
new_valueJSONOptional
new_value (anyOf 1)stringAlternativeThe new valid value after the attempted change.
new_value (anyOf 2)nullAlternativeThe new valid value after the attempted change.
previous_valueJSONOptional
previous_value (anyOf 1)stringAlternativeThe previous valid value before the attempted change.
previous_value (anyOf 2)nullAlternativeThe previous valid value before the attempted change.
typestringOptionalType of amendment

Get amendments by contract — 200 response body — data item legal context Additional details needed for legal input

FieldTypePresenceDescription and constraints
$objectRootAdditional details needed for legal input
detailsstringOptionalDetails regarding the legal request
jira_ticketstringOptionalJira ticket identifier linked to the legal context
jira_web_urlstringOptionalLink to the Jira ticket for tracking
Format: uri
requested_atstringOptionalTimestamp when legal review was requested
Format: date-time
statusstringOptionalCurrent status of the legal review process
Known values: REQUEST_LEGAL_REVIEW, WAITING_FOR_ANOTHER_TEAM, WAITING_FOR_HRX_ACTION, DECLINED, SOLVED, SOLVE_LEGAL, LEGAL_JIRA_REOPENED

Retrieve Effective Date Limitations — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand Retrieve Effective Date Limitations — 200 response body — data

Referenced models: Retrieve Effective Date Limitations — 200 response body — data

Retrieve Effective Date Limitations — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
default_effective_dateJSONOptional
default_effective_date (anyOf 1)stringAlternativeA default effective date suggested by the system
Format: date-time
default_effective_date (anyOf 2)nullAlternativeA default effective date suggested by the system
Format: date-time
is_disabledbooleanOptionalIndicates if the effective date field is disabled
is_hiddenbooleanOptionalIndicates if the effective date field should be hidden.
max_effective_dateJSONOptional
max_effective_date (anyOf 1)stringAlternativeThe latest valid effective date
Format: date-time
max_effective_date (anyOf 2)nullAlternativeThe latest valid effective date
Format: date-time
messagestringOptionalOptional human-readable additional explanation on effective date limitation
min_effective_dateJSONOptional
min_effective_date (anyOf 1)stringAlternativeThe earliest valid effective date
Format: date-time
min_effective_date (anyOf 2)nullAlternativeThe earliest valid effective date
Format: date-time

Sign a contract amendment (employee) — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand Sign a contract amendment (employee) — 200 response body — data

Referenced models: Sign a contract amendment (employee) — 200 response body — data

Sign a contract amendment (employee) — 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
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
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 Sign a contract amendment (employee) — 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, Sign a contract amendment (employee) — 200 response body — data rejection context Additional details containing rejection reason, 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 variable compensation

Sign a contract amendment (employee) — 200 response body — data rejection context Additional details containing rejection reason

FieldTypePresenceDescription and constraints
$objectRootAdditional details containing rejection reason
rejected_atstringOptionalTimestamp of when the rejection occurred
Format: date-time

Update amendment — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand Update amendment — 200 response body — data

Referenced models: Update amendment — 200 response body — data

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

Validate amendment data points — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataobjectOptionalValidation results keyed by amendment field
Additional keys: see wildcard field
data.*ModelAdditional keysExpand Validate amendment data points — 200 response body — data value

Referenced models: Validate amendment data points — 200 response body — data value

Validate amendment data points — 200 response body — data value

FieldTypePresenceDescription and constraints
$objectRoot
messageJSONOptional
message (anyOf 1)stringAlternativeValidation message for the field, present when the value is invalid.
message (anyOf 2)nullAlternativeValidation message for the field, present when the value is invalid.
validJSONOptional
valid (anyOf 1)booleanAlternativeWhether the submitted value for this field is valid.
valid (anyOf 2)nullAlternativeWhether the submitted value for this field is valid.

Validate amendment data points — request body — body data

FieldTypePresenceDescription and constraints
$objectRootAmendment fields to validate. At least one of scope or job_title must be provided.
job_titlestringOptionalJob title to validate, up to 1,000 characters.
scopestringOptionalJob scope to validate, up to 20,000 characters.

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.