Deel: EOR amendments schemas
47 Deel schemas with complete fields and constraints.
← EOR amendments operations · All schemas
Accept amendment — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand Accept amendment — 200 response body — data |
Referenced models: Accept amendment — 200 response body — data
Accept amendment — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amendment_statuses | array | Optional | List of amendment statuses representing the history and progression of an amendment. |
amendment_statuses[] | Model | Each item | Expand Accept amendment — 200 response body — data amendment statuses item |
created_at | string | Optional | Creation date of the amendment. Format: date-time |
currency | string | Optional | Contract currency. |
custom_items | array | Optional | Custom amendment items associated with the amendment flow |
custom_items[] | Model | Each item | Expand Accept amendment — 200 response body — data custom items item |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Free-text description of the amendment. |
description (anyOf 2) | null | Alternative | Free-text description of the amendment. |
document_type | JSON | Optional | Amendment document type |
document_type (anyOf 1) | string | Alternative | Amendment document type Known values: EA, SOW, SOW_EA |
document_type (anyOf 2) | null | Alternative | |
effective_date | JSON | Optional | |
effective_date (anyOf 1) | string | Alternative | Effective date of the amendment. Format: date-time |
effective_date (anyOf 2) | null | Alternative | Effective date of the amendment. Format: date-time |
employee_nationality | string | Optional | Nationality of the employee. |
employment_state | JSON | Optional | |
employment_state (anyOf 1) | string | Alternative | State of employment. |
employment_state (anyOf 2) | null | Alternative | State of employment. |
employment_type | string | Optional | Type of employment. Known values: FULL_TIME, PART_TIME |
end_date | JSON | Optional | |
end_date (anyOf 1) | string | Alternative | End date of the employment. Format: date-time |
end_date (anyOf 2) | null | Alternative | End date of the employment. Format: date-time |
fixed_adjustments | array | Optional | List of fixed adjustments associated with the amendment request. |
fixed_adjustments[] | Model | Each item | Expand Accept amendment — 200 response body — data fixed adjustments item |
holidays | JSON | Optional | |
holidays (anyOf 1) | JSON | Alternative | |
holidays (anyOf 1) (anyOf 1) | integer | Alternative | Number of holidays. |
holidays (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
holidays (anyOf 2) | null | Alternative | Number of holidays. |
hourly_rate | JSON | Optional | |
hourly_rate (anyOf 1) | string | Alternative | Hourly rate of the amendment |
hourly_rate (anyOf 2) | null | Alternative | Hourly rate of the amendment |
id | string | Optional | Id of amendment Format: uuid |
is_effective_date_updated | boolean | Optional | Is Effective Date updated. |
is_hrx_action_needed | boolean | Optional | Is HRX action needed. |
items | array | Optional | Items of amendment |
items[] | Model | Each item | Expand Accept amendment — 200 response body — data items item |
job_category | JSON | Optional | |
job_category (anyOf 1) | string | Alternative | Job category associated with the job title. |
job_category (anyOf 2) | null | Alternative | Job category associated with the job title. |
job_code | JSON | Optional | |
job_code (anyOf 1) | string | Alternative | Job code associated with the job title. |
job_code (anyOf 2) | null | Alternative | Job code associated with the job title. |
job_title | string | Optional | Job title associated with the amendment. Maximum length: 1000 |
legal_context | JSON | Optional | Additional details needed for legal input |
legal_context (anyOf 1) | Model | Alternative | Expand Accept amendment — 200 response body — data legal context Additional details needed for legal input |
legal_context (anyOf 2) | null | Alternative | |
net_salary | JSON | Optional | |
net_salary (anyOf 1) | string | Alternative | Net salary for the amendment. |
net_salary (anyOf 2) | null | Alternative | Net salary for the amendment. |
notice_period_after_probation | JSON | Optional | |
notice_period_after_probation (anyOf 1) | string | Alternative | Notice period after probation. |
notice_period_after_probation (anyOf 2) | null | Alternative | Notice period after probation. |
notice_period_during_probation | JSON | Optional | |
notice_period_during_probation (anyOf 1) | string | Alternative | Notice period during probation. |
notice_period_during_probation (anyOf 2) | null | Alternative | Notice period during probation. |
notice_period_time_unit | JSON | Optional | Notice period time unit. |
notice_period_time_unit (anyOf 1) | string | Alternative | Notice period time unit. Known values: DAY, WEEK, MONTH |
notice_period_time_unit (anyOf 2) | null | Alternative | |
notice_period_type | JSON | Optional | Type of notice period. |
notice_period_type (anyOf 1) | string | Alternative | Type of notice period. Known values: STANDARD, CUSTOM |
notice_period_type (anyOf 2) | null | Alternative | |
probation_period | JSON | Optional | |
probation_period (anyOf 1) | JSON | Alternative | |
probation_period (anyOf 1) (anyOf 1) | integer | Alternative | Duration of the probation period. |
probation_period (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
probation_period (anyOf 2) | null | Alternative | Duration of the probation period. |
probation_period_type_for_definite | JSON | Optional | Type of probation period for definite contracts. |
probation_period_type_for_definite (anyOf 1) | string | Alternative | Type of probation period for definite contracts. Known values: STANDARD, CUSTOM |
probation_period_type_for_definite (anyOf 2) | null | Alternative | |
rejection_context | JSON | Optional | Additional details containing rejection reason |
rejection_context (anyOf 1) | Model | Alternative | Expand Accept amendment — 200 response body — data rejection context Additional details containing rejection reason |
rejection_context (anyOf 2) | null | Alternative | |
requested_by | JSON | Optional | |
requested_by (anyOf 1) | string | Alternative | Profile name of the user who requested the change |
requested_by (anyOf 2) | null | Alternative | Profile name of the user who requested the change |
salary | string | Optional | Salary for the amendment. |
scope | string | Optional | Scope of the amendment. |
seniority_date | JSON | Optional | |
seniority_date (anyOf 1) | string | Alternative | The 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) | null | Alternative | The 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_id | JSON | Optional | |
seniority_id (anyOf 1) | string | Alternative | Seniority level identifier. Format: uuid |
seniority_id (anyOf 2) | null | Alternative | Seniority level identifier. Format: uuid |
sick_leave_days | JSON | Optional | |
sick_leave_days (anyOf 1) | JSON | Alternative | |
sick_leave_days (anyOf 1) (anyOf 1) | integer | Alternative | Number of sick leave days |
sick_leave_days (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
sick_leave_days (anyOf 2) | null | Alternative | Number of sick leave days |
source | JSON | Optional | Source of amendment flow creation. |
source (anyOf 1) | string | Alternative | Source of amendment flow creation. Known values: APP, PUBLIC_API, APP_BULK_AMENDMENT |
source (anyOf 2) | null | Alternative | |
start_date | string | Optional | Start date of the employment. Format: date-time |
time_off_type | string | Optional | Type of time off. Known values: STANDARD, SPECIFIC, PRORATED |
type | JSON | Optional | Type of amendment |
type (anyOf 1) | string | Alternative | Type of amendment Known values: INSTANT, OPS, LEGAL, DISABLED, CUSTOM, AUTOMATED |
type (anyOf 2) | null | Alternative | |
updated_at | string | Optional | Date when amendment is updated Format: date-time |
variable_compensation | Model | Optional | Expand 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_deadline | JSON | Optional | |
void_deadline (anyOf 1) | string | Alternative | Deadline this SOW to be voided Format: date-time |
void_deadline (anyOf 2) | null | Alternative | Deadline this SOW to be voided Format: date-time |
void_deadline_type | JSON | Optional | Type of void deadline |
void_deadline_type (anyOf 1) | string | Alternative | Type of void deadline Known values: CUTOFF, START_DATE, END_DATE, EXPIRY |
void_deadline_type (anyOf 2) | null | Alternative | |
work_hours_per_week | string | Optional | Number of work hours per week. |
work_schedule_id | JSON | Optional | |
work_schedule_id (anyOf 1) | string | Alternative | Work schedule id Format: uuid |
work_schedule_id (anyOf 2) | null | Alternative | Work schedule id Format: uuid |
work_schedule_rules_version | JSON | Optional | |
work_schedule_rules_version (anyOf 1) | string | Alternative | Work schedule rule version. |
work_schedule_rules_version (anyOf 2) | null | Alternative | Work 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of a specific amendment status in the lifecycle of the amendment. |
amendment_flow_status | Model | Optional | Expand Accept amendment — 200 response body — data amendment statuses item amendment flow status Metadata about the amendment status, including when it was created. |
friendly_name | string | Optional | Human-readable label of the amendment status (e.g., DRAFT, PENDING, APPROVED). |
name | string | Optional | Logical, 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Metadata about the amendment status, including when it was created. |
created_at | string | Optional | The timestamp when this amendment status was created. Format: date-time |
Accept amendment — 200 response body — data custom items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Detailed description of the custom amendment item |
description (anyOf 2) | null | Alternative | Detailed description of the custom amendment item |
id | string | Required within parent | Unique identifier for the custom amendment item Format: uuid |
rejection_reason | JSON | Optional | |
rejection_reason (anyOf 1) | string | Alternative | Reason for rejection if the item was rejected |
rejection_reason (anyOf 2) | null | Alternative | Reason for rejection if the item was rejected |
status | string | Required within parent | Current status of the custom amendment item Known values: REJECTED, APPROVED, PENDING_REVIEW, PENDING_LEGAL |
type | string | Required within parent | Type/context of the custom amendment item |
Accept amendment — 200 response body — data fixed adjustments item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Timestamp when the fixed adjustment was created. Format: date-time |
description | string | Required within parent | Description of the fixed adjustment. Maximum length: 256 Minimum length: 1 |
id | string | Required within parent | System-generated unique identifier for the fixed adjustment record in an amendment request. |
is_amended | boolean | Required within parent | Whether this fixed adjustment was amended from a previous one. |
is_country_specific | boolean | Required within parent | Whether this fixed adjustment applies only to a specific country. |
is_deleted | boolean | Optional | True if the fixed adjustment was deleted as part of the amendment; otherwise false. |
is_recurring | boolean | Required within parent | Whether the fixed adjustment is recurring. If set to false, it will be treated as a one-time fixed allowance. |
parent_fixed_adjustment_id | JSON | Optional | |
parent_fixed_adjustment_id (anyOf 1) | string | Alternative | Reference to the parent fixed adjustment, if applicable. |
parent_fixed_adjustment_id (anyOf 2) | null | Alternative | Reference to the parent fixed adjustment, if applicable. |
status | string | Required within parent | Current status of the fixed adjustment. Known values: WAITING_FOR_SIGNING, ACTIVE, OUTDATED, CANCELLED |
updated_at | string | Required within parent | Timestamp when the fixed adjustment was last updated. Format: date-time |
value | string | Required within parent | Value of the fixed adjustment. Pattern: ^(?!0+(\.0+)?$)\d+(?:\.\d+)?$ |
Accept amendment — 200 response body — data items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data_point | string | Optional | The field that is selected for amendment. |
id | string | Optional | Id of amendment item Format: uuid |
item | string | Optional | Amendment item |
new_value | string | Optional | The new valid value after the attempted change. |
previous_value | string | Optional | The previous valid value before the attempted change. |
type | string | Optional | Type of amendment Known values: INSTANT, OPS, LEGAL, DISABLED, CUSTOM, AUTOMATED |
Accept amendment — 200 response body — data legal context Additional details needed for legal input
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional details needed for legal input |
details | string | Optional | Details regarding the legal request |
jira_ticket | string | Optional | Jira ticket identifier linked to the legal context |
jira_web_url | string | Optional | Link to the Jira ticket for tracking Format: uri |
requested_at | string | Optional | Timestamp when legal review was requested Format: date-time |
status | string | Optional | Current 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional details containing rejection reason |
rejected_at | string | Optional | Timestamp of when the rejection occurred Format: date-time |
rejection_reason | JSON | Optional | |
rejection_reason (anyOf 1) | string | Alternative | Reason provided when the amendment was rejected. Null when the amendment was cancelled rather than rejected by an admin. |
rejection_reason (anyOf 2) | null | Alternative | Reason 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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. |
amount | string | Required within parent | The value of the compensation. Shown as a string to keep the exact number of decimals. Format: decimal |
created_at | string | Required within parent | The date and time when this record was first created in the system. Format: date-time |
effective_date | string | Required within parent | The date when this compensation starts being valid. Format: date-time |
id | string | Required within parent | The unique ID assigned by the system to this variable compensation record. |
incentive_plan | Model | Optional | Expand Accept amendment — 200 response body — data variable compensation incentive plan Details of the incentive plan linked to this compensation, if any. |
is_amended | boolean | Optional | Shows whether this compensation has been changed as part of an amendment. |
is_deleted | boolean | Optional | Shows whether this compensation has been deleted. |
parent_id | JSON | Required within parent | |
parent_id (anyOf 1) | string | Alternative | Reference to the parent variable compensation, if applicable. Null if this compensation is not linked to any compensation. |
parent_id (anyOf 2) | null | Alternative | Reference to the parent variable compensation, if applicable. Null if this compensation is not linked to any compensation. |
timeline | string | Required within parent | How often the compensation is paid — for example monthly, quarterly, annually, or twice a year. Known values: MONTHLY, QUARTERLY, ANNUALLY, BIANNUALLY |
title | string | Required within parent | Title or name of the variable compensation. |
type | string | Required within parent | The 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_at | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of the incentive plan linked to this compensation, if any. |
details | string | Optional | Extra details about the incentive plan, if any. |
employee_signature | string | Optional | The employee’s signature for the incentive plan, if collected. |
employee_signed_at | string | Optional | The date and time when the employee signed the incentive plan. Empty if not signed. Format: date-time |
Cancel amendment — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Cancel amendment — 200 response body — data |
Referenced models: Cancel amendment — 200 response body — data
Cancel amendment — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
success | boolean | Required within parent | Whether the amendment was deleted. |
Confirm amendment — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand Confirm amendment — 200 response body — data |
Referenced models: Confirm amendment — 200 response body — data
Confirm amendment — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amendment_statuses | array | Optional | List of amendment statuses representing the history and progression of an amendment. |
amendment_statuses[] | Model | Each item | Expand Create amendment — 201 response body — data amendment statuses item |
created_at | string | Optional | Creation date of the amendment. Format: date-time |
currency | string | Optional | Contract currency. |
custom_items | array | Optional | Custom amendment items associated with the amendment flow |
custom_items[] | Model | Each item | Expand Accept amendment — 200 response body — data custom items item |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Free-text description of the amendment. |
description (anyOf 2) | null | Alternative | Free-text description of the amendment. |
document_type | JSON | Optional | Amendment document type |
document_type (anyOf 1) | string | Alternative | Amendment document type Known values: EA, SOW, SOW_EA |
document_type (anyOf 2) | null | Alternative | |
effective_date | JSON | Optional | |
effective_date (anyOf 1) | string | Alternative | Effective date of the amendment. Format: date-time |
effective_date (anyOf 2) | null | Alternative | Effective date of the amendment. Format: date-time |
employee_nationality | string | Optional | Nationality of the employee. |
employment_state | JSON | Optional | |
employment_state (anyOf 1) | string | Alternative | State of employment. |
employment_state (anyOf 2) | null | Alternative | State of employment. |
employment_type | string | Optional | Type of employment. Known values: FULL_TIME, PART_TIME |
end_date | JSON | Optional | |
end_date (anyOf 1) | string | Alternative | End date of the employment. Format: date-time |
end_date (anyOf 2) | null | Alternative | End date of the employment. Format: date-time |
fixed_adjustments | array | Optional | List of fixed adjustments associated with the amendment request. |
fixed_adjustments[] | Model | Each item | Expand Accept amendment — 200 response body — data fixed adjustments item |
holidays | JSON | Optional | |
holidays (anyOf 1) | JSON | Alternative | |
holidays (anyOf 1) (anyOf 1) | integer | Alternative | Number of holidays. |
holidays (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
holidays (anyOf 2) | null | Alternative | Number of holidays. |
hourly_rate | JSON | Optional | |
hourly_rate (anyOf 1) | string | Alternative | Hourly rate of the amendment |
hourly_rate (anyOf 2) | null | Alternative | Hourly rate of the amendment |
id | string | Optional | Id of amendment Format: uuid |
is_effective_date_updated | boolean | Optional | Is Effective Date updated. |
is_hrx_action_needed | boolean | Optional | Is HRX action needed. |
items | array | Optional | Items of amendment |
items[] | Model | Each item | Expand Confirm amendment — 200 response body — data items item |
job_category | JSON | Optional | |
job_category (anyOf 1) | string | Alternative | Job category associated with the job title. |
job_category (anyOf 2) | null | Alternative | Job category associated with the job title. |
job_code | JSON | Optional | |
job_code (anyOf 1) | string | Alternative | Job code associated with the job title. |
job_code (anyOf 2) | null | Alternative | Job code associated with the job title. |
job_title | string | Optional | Job title associated with the amendment. Maximum length: 1000 |
legal_context | JSON | Optional | Additional details needed for legal input |
legal_context (anyOf 1) | Model | Alternative | Expand Accept amendment — 200 response body — data legal context Additional details needed for legal input |
legal_context (anyOf 2) | null | Alternative | |
net_salary | JSON | Optional | |
net_salary (anyOf 1) | string | Alternative | Net salary for the amendment. |
net_salary (anyOf 2) | null | Alternative | Net salary for the amendment. |
notice_period_after_probation | JSON | Optional | |
notice_period_after_probation (anyOf 1) | string | Alternative | Notice period after probation. |
notice_period_after_probation (anyOf 2) | null | Alternative | Notice period after probation. |
notice_period_during_probation | JSON | Optional | |
notice_period_during_probation (anyOf 1) | string | Alternative | Notice period during probation. |
notice_period_during_probation (anyOf 2) | null | Alternative | Notice period during probation. |
notice_period_time_unit | JSON | Optional | Notice period time unit. |
notice_period_time_unit (anyOf 1) | string | Alternative | Notice period time unit. Known values: DAY, WEEK, MONTH |
notice_period_time_unit (anyOf 2) | null | Alternative | |
notice_period_type | JSON | Optional | Type of notice period. |
notice_period_type (anyOf 1) | string | Alternative | Type of notice period. Known values: STANDARD, CUSTOM |
notice_period_type (anyOf 2) | null | Alternative | |
probation_period | JSON | Optional | |
probation_period (anyOf 1) | JSON | Alternative | |
probation_period (anyOf 1) (anyOf 1) | integer | Alternative | Duration of the probation period. |
probation_period (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
probation_period (anyOf 2) | null | Alternative | Duration of the probation period. |
probation_period_type_for_definite | JSON | Optional | Type of probation period for definite contracts. |
probation_period_type_for_definite (anyOf 1) | string | Alternative | Type of probation period for definite contracts. Known values: STANDARD, CUSTOM |
probation_period_type_for_definite (anyOf 2) | null | Alternative | |
rejection_context | JSON | Optional | Additional details containing rejection reason |
rejection_context (anyOf 1) | Model | Alternative | Expand Accept amendment — 200 response body — data rejection context Additional details containing rejection reason |
rejection_context (anyOf 2) | null | Alternative | |
requested_by | JSON | Optional | |
requested_by (anyOf 1) | string | Alternative | Profile name of the user who requested the change |
requested_by (anyOf 2) | null | Alternative | Profile name of the user who requested the change |
salary | string | Optional | Salary for the amendment. |
scope | string | Optional | Scope of the amendment. |
seniority_date | JSON | Optional | |
seniority_date (anyOf 1) | string | Alternative | The 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) | null | Alternative | The 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_id | JSON | Optional | |
seniority_id (anyOf 1) | string | Alternative | Seniority level identifier. Format: uuid |
seniority_id (anyOf 2) | null | Alternative | Seniority level identifier. Format: uuid |
sick_leave_days | JSON | Optional | |
sick_leave_days (anyOf 1) | JSON | Alternative | |
sick_leave_days (anyOf 1) (anyOf 1) | integer | Alternative | Number of sick leave days |
sick_leave_days (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
sick_leave_days (anyOf 2) | null | Alternative | Number of sick leave days |
source | JSON | Optional | Source of amendment flow creation. |
source (anyOf 1) | string | Alternative | Source of amendment flow creation. Known values: APP, PUBLIC_API, APP_BULK_AMENDMENT |
source (anyOf 2) | null | Alternative | |
start_date | string | Optional | Start date of the employment. Format: date-time |
time_off_type | string | Optional | Type of time off. Known values: STANDARD, SPECIFIC, PRORATED |
type | JSON | Optional | Type of amendment |
type (anyOf 1) | string | Alternative | Type of amendment Known values: INSTANT, OPS, LEGAL, DISABLED, CUSTOM, AUTOMATED |
type (anyOf 2) | null | Alternative | |
updated_at | string | Optional | Date when amendment is updated Format: date-time |
variable_compensation | Model | Optional | Expand 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_deadline | JSON | Optional | |
void_deadline (anyOf 1) | string | Alternative | Deadline this SOW to be voided Format: date |
void_deadline (anyOf 2) | null | Alternative | Deadline this SOW to be voided Format: date |
void_deadline_type | JSON | Optional | Type of void deadline |
void_deadline_type (anyOf 1) | string | Alternative | Type of void deadline Known values: CUTOFF, START_DATE, END_DATE, EXPIRY |
void_deadline_type (anyOf 2) | null | Alternative | |
work_hours_per_week | string | Optional | Number of work hours per week. |
work_schedule_id | JSON | Optional | |
work_schedule_id (anyOf 1) | string | Alternative | Work schedule id Format: uuid |
work_schedule_id (anyOf 2) | null | Alternative | Work schedule id Format: uuid |
work_schedule_rules_version | JSON | Optional | |
work_schedule_rules_version (anyOf 1) | string | Alternative | Work schedule rule version. |
work_schedule_rules_version (anyOf 2) | null | Alternative | Work 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data_point | string | Optional | The field that is selected for amendment. |
id | string | Optional | Id of amendment item Format: uuid |
item | string | Optional | Amendment item |
new_value | string | Optional | The new valid value after the attempted change. |
previous_value | string | Optional | The previous valid value before the attempted change. |
type | string | Optional | Type of amendment |
Contract amendment PDF — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand Contract amendment PDF — 200 response body — data |
Referenced models: Contract amendment PDF — 200 response body — data
Contract amendment PDF — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
url | string | Optional | Pre-signed URL to download the exported PDF (valid for 15 minutes). Format: uri |
Create amendment — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand Create amendment — 201 response body — data |
Referenced models: Create amendment — 201 response body — data
Create amendment — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amendment_statuses | array | Optional | List of amendment statuses representing the history and progression of an amendment. |
amendment_statuses[] | Model | Each item | Expand Create amendment — 201 response body — data amendment statuses item |
created_at | string | Optional | Creation date of the amendment. Format: date-time |
currency | string | Optional | Contract currency. |
custom_items | array | Optional | Custom amendment items associated with the amendment flow |
custom_items[] | Model | Each item | Expand Accept amendment — 200 response body — data custom items item |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Free-text description of the amendment. |
description (anyOf 2) | null | Alternative | Free-text description of the amendment. |
document_type | JSON | Optional | Amendment document type |
document_type (anyOf 1) | string | Alternative | Amendment document type Known values: EA, SOW, SOW_EA |
document_type (anyOf 2) | null | Alternative | |
effective_date | JSON | Optional | |
effective_date (anyOf 1) | string | Alternative | Effective date of the amendment. Format: date-time |
effective_date (anyOf 2) | null | Alternative | Effective date of the amendment. Format: date-time |
employee_nationality | string | Optional | Nationality of the employee. |
employment_state | JSON | Optional | |
employment_state (anyOf 1) | string | Alternative | State of employment. |
employment_state (anyOf 2) | null | Alternative | State of employment. |
employment_type | string | Optional | Type of employment. Known values: FULL_TIME, PART_TIME |
end_date | JSON | Optional | |
end_date (anyOf 1) | string | Alternative | End date of the employment. Format: date-time |
end_date (anyOf 2) | null | Alternative | End date of the employment. Format: date-time |
fixed_adjustments | array | Optional | List of fixed adjustments associated with the amendment request. |
fixed_adjustments[] | Model | Each item | Expand Accept amendment — 200 response body — data fixed adjustments item |
holidays | JSON | Optional | |
holidays (anyOf 1) | JSON | Alternative | |
holidays (anyOf 1) (anyOf 1) | integer | Alternative | Number of holidays. |
holidays (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
holidays (anyOf 2) | null | Alternative | Number of holidays. |
hourly_rate | JSON | Optional | |
hourly_rate (anyOf 1) | string | Alternative | Hourly rate of the amendment |
hourly_rate (anyOf 2) | null | Alternative | Hourly rate of the amendment |
id | string | Optional | Id of amendment Format: uuid |
is_effective_date_updated | boolean | Optional | Is Effective Date updated. |
is_hrx_action_needed | boolean | Optional | Is HRX action needed. |
items | array | Optional | Items of amendment |
items[] | Model | Each item | Expand Accept amendment — 200 response body — data items item |
job_category | JSON | Optional | |
job_category (anyOf 1) | string | Alternative | Job category associated with the job title. |
job_category (anyOf 2) | null | Alternative | Job category associated with the job title. |
job_code | JSON | Optional | |
job_code (anyOf 1) | string | Alternative | Job code associated with the job title. |
job_code (anyOf 2) | null | Alternative | Job code associated with the job title. |
job_title | string | Optional | Job title associated with the amendment. Maximum length: 1000 |
legal_context | JSON | Optional | Additional details needed for legal input |
legal_context (anyOf 1) | Model | Alternative | Expand Accept amendment — 200 response body — data legal context Additional details needed for legal input |
legal_context (anyOf 2) | null | Alternative | |
net_salary | JSON | Optional | |
net_salary (anyOf 1) | string | Alternative | Net salary for the amendment. |
net_salary (anyOf 2) | null | Alternative | Net salary for the amendment. |
notice_period_after_probation | JSON | Optional | |
notice_period_after_probation (anyOf 1) | string | Alternative | Notice period after probation. |
notice_period_after_probation (anyOf 2) | null | Alternative | Notice period after probation. |
notice_period_during_probation | JSON | Optional | |
notice_period_during_probation (anyOf 1) | string | Alternative | Notice period during probation. |
notice_period_during_probation (anyOf 2) | null | Alternative | Notice period during probation. |
notice_period_time_unit | JSON | Optional | Notice period time unit. |
notice_period_time_unit (anyOf 1) | string | Alternative | Notice period time unit. Known values: DAY, WEEK, MONTH |
notice_period_time_unit (anyOf 2) | null | Alternative | |
notice_period_type | JSON | Optional | Type of notice period. |
notice_period_type (anyOf 1) | string | Alternative | Type of notice period. Known values: STANDARD, CUSTOM |
notice_period_type (anyOf 2) | null | Alternative | |
probation_period | JSON | Optional | |
probation_period (anyOf 1) | JSON | Alternative | |
probation_period (anyOf 1) (anyOf 1) | integer | Alternative | Duration of the probation period. |
probation_period (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
probation_period (anyOf 2) | null | Alternative | Duration of the probation period. |
probation_period_type_for_definite | JSON | Optional | Type of probation period for definite contracts. |
probation_period_type_for_definite (anyOf 1) | string | Alternative | Type of probation period for definite contracts. Known values: STANDARD, CUSTOM |
probation_period_type_for_definite (anyOf 2) | null | Alternative | |
rejection_context | JSON | Optional | Additional details containing rejection reason |
rejection_context (anyOf 1) | Model | Alternative | Expand Accept amendment — 200 response body — data rejection context Additional details containing rejection reason |
rejection_context (anyOf 2) | null | Alternative | |
requested_by | JSON | Optional | |
requested_by (anyOf 1) | string | Alternative | Profile name of the user who requested the change |
requested_by (anyOf 2) | null | Alternative | Profile name of the user who requested the change |
salary | string | Optional | Salary for the amendment. |
scope | string | Optional | Scope of the amendment. |
seniority_date | JSON | Optional | |
seniority_date (anyOf 1) | string | Alternative | The 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) | null | Alternative | The 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_id | JSON | Optional | |
seniority_id (anyOf 1) | string | Alternative | Seniority level identifier. Format: uuid |
seniority_id (anyOf 2) | null | Alternative | Seniority level identifier. Format: uuid |
sick_leave_days | JSON | Optional | |
sick_leave_days (anyOf 1) | JSON | Alternative | |
sick_leave_days (anyOf 1) (anyOf 1) | integer | Alternative | Number of sick leave days |
sick_leave_days (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
sick_leave_days (anyOf 2) | null | Alternative | Number of sick leave days |
source | JSON | Optional | Source of amendment flow creation. |
source (anyOf 1) | string | Alternative | Source of amendment flow creation. Known values: APP, PUBLIC_API, APP_BULK_AMENDMENT |
source (anyOf 2) | null | Alternative | |
start_date | string | Optional | Start date of the employment. Format: date-time |
time_off_type | string | Optional | Type of time off. Known values: STANDARD, SPECIFIC, PRORATED |
type | JSON | Optional | Type of amendment |
type (anyOf 1) | string | Alternative | Type of amendment Known values: INSTANT, OPS, LEGAL, DISABLED, CUSTOM, AUTOMATED |
type (anyOf 2) | null | Alternative | |
updated_at | string | Optional | Date when amendment is updated Format: date-time |
variable_compensation | Model | Optional | Expand 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_deadline | JSON | Optional | |
void_deadline (anyOf 1) | string | Alternative | Deadline this SOW to be voided Format: date-time |
void_deadline (anyOf 2) | null | Alternative | Deadline this SOW to be voided Format: date-time |
void_deadline_type | JSON | Optional | Type of void deadline |
void_deadline_type (anyOf 1) | string | Alternative | Type of void deadline Known values: CUTOFF, START_DATE, END_DATE, EXPIRY |
void_deadline_type (anyOf 2) | null | Alternative | |
work_hours_per_week | string | Optional | Number of work hours per week. |
work_schedule_id | JSON | Optional | |
work_schedule_id (anyOf 1) | string | Alternative | Work schedule id Format: uuid |
work_schedule_id (anyOf 2) | null | Alternative | Work schedule id Format: uuid |
work_schedule_rules_version | JSON | Optional | |
work_schedule_rules_version (anyOf 1) | string | Alternative | Work schedule rule version. |
work_schedule_rules_version (anyOf 2) | null | Alternative | Work 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amendment_flow_status | Model | Optional | Expand Create amendment — 201 response body — data amendment statuses item amendment flow status Metadata about the amendment status, including when it was created. |
friendly_name | string | Optional | Friendly name of amendment status |
name | string | Optional | Logical, 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Metadata about the amendment status, including when it was created. |
created_at | string | Optional | Creation date Format: date-time |
Create amendment — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
additional_info | JSON | Optional | Additional metadata related to job validation and categorisation |
additional_info (oneOf 1) | Model | Alternative | Expand Create amendment — request body — body data additional info ai scope check public id, job categorization log id |
additional_info (oneOf 2) | null | Alternative | |
custom | array | Optional | An optional array of custom objects. |
custom[] | Model | Each item | Expand Create amendment — request body — body data custom item |
effective_date | string | Optional | Effective date for the amendment. Format: date |
employment_state | string | Optional | State of employment. |
employment_type | string | Optional | Type of employment. One of: FULL_TIME, PART_TIME |
end_date | string | Optional | End date of the employment. Format: date |
fixed_adjustments | array | Optional | Array of fixed adjustments to be submitted for the amendment request. |
fixed_adjustments[] | Model | Each item | Expand Create amendment — request body — body data fixed adjustments item |
holidays | number | Optional | Number of holidays. Format: double |
hourly_rate | number | Optional | Hourly rate of the amendment. The max value supported is 1e19 Format: double |
job_title | string | Optional | Job title associated with the amendment. Maximum length: 1000 |
notice_period_after_probation | number | Optional | Notice period after probation. Format: double |
notice_period_during_probation | number | Optional | Notice period during probation. Format: double |
notice_period_type | string | Optional | Type of notice period. One of: STANDARD, CUSTOM |
probation_period | number | Optional | Duration of the probation period. Format: double |
probation_period_type_for_definite | string | Optional | Type of probation period for definite contracts. One of: STANDARD, CUSTOM |
salary | number | Optional | Salary for the amendment. Format: double |
scope | string | Optional | Scope of the amendment. Maximum length: 20000 |
seniority_date | string or null | Optional | The 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_id | string | Optional | Public Id of the seniority level. Format: uuid |
start_date | string | Optional | Start date of the employment. Format: date |
time_off_type | string | Optional | Type of time off. One of: STANDARD, SPECIFIC, PRORATED |
variable_compensation | Model | Optional | Expand 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_week | number | Optional | Number 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional metadata related to job validation and categorisation |
ai_scope_check_public_id | string | Optional | Identifier or flag for AI scope validation check Format: uuid |
job_categorization_log_id | string | Optional | Identifier for job categorisation log Format: uuid |
Create amendment — request body — body data custom item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | string | Required within parent | A required description for the custom object. Maximum length: 1000 Minimum length: 50 |
id | string | Optional | An optional identifier for the custom object. Format: uuid |
type | string | Required within parent | The type of the custom object. Must be one of the valid custom types. |
Create amendment — request body — body data fixed adjustments item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | string | Required within parent | Description of the fixed adjustment. Maximum length: 256 Minimum length: 1 |
id | string | Optional | The 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_deleted | boolean | Optional | Flag to mark the fixed adjustment as deleted. Required only when the fixed adjustment needs to be removed; omit it otherwise. |
is_recurring | boolean | Required within parent | Whether the fixed adjustment is recurring. If set to false, it will be treated as a one-time fixed allowance. |
value | string | Required within parent | Value of the fixed adjustment. Must be a positive number, not zero. Pattern: ^(?!0+(\.0+)?$)\d+(?:\.\d+)?$ |
Create amendment — request body — body data variable compensation
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a change to an employee’s variable compensation (e.g., bonus or commission). This schema is used for creating new variable compensation items or updating existing ones. Some fields are required when creating, optional when updating, and forbidden when updating, as specified in each field description. |
amount | number | Required within parent | Positive amount for the variable compensation. Format: double Minimum: 0 |
effective_date | string | Optional | The date when this compensation starts or becomes effective. Required when creating a new compensation. Optional when updating an existing compensation. Format: date |
id | string | Optional | The ID of an existing active variable compensation to update or delete. Include this in the request only if you are updating or deleting an existing compensation. Do not include it when creating a new one. |
is_deleted | boolean | Optional | Flag to mark the variable compensation as deleted. Required only when the variable compensation needs to be removed; omit it otherwise |
timeline | string | Optional | How often this compensation occurs. Required when creating a new compensation. Forbidden when updating an existing compensation. One of: MONTHLY, QUARTERLY, ANNUALLY, BIANNUALLY |
title | string | Optional | The title of the compensation. Required when creating a new compensation. Optional when updating an existing compensation. Maximum length: 250 Minimum length: 1 |
type | string | Required within parent | Type of variable compensation. One of: PERCENTAGE, FIXED |
Get amendment validation settings — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Optional | |
data[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data_point | string | Optional | The name of the data point being configured. |
rules | array | Optional | The rules for the data point. |
rules[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
additional_details | Model | Optional | Expand Get amendment validation settings — 200 response body — data item rules item additional details Optional additional information for rules, if applicable. |
external_validation | boolean | Optional | Indicates 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_editable | boolean | Optional | Indicates whether the data point can be updated. |
max | JSON | Optional | |
max (anyOf 1) | number | Alternative | The maximum allowable value for numerical data points. Format: double |
max (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
max_date | JSON | Optional | |
max_date (anyOf 1) | string | Alternative | The latest allowable date for date-type data points. Format: date |
max_date (anyOf 2) | null | Alternative | The latest allowable date for date-type data points. Format: date |
min | JSON | Optional | |
min (anyOf 1) | JSON | Alternative | |
min (anyOf 1) (anyOf 1) | number | Alternative | The minimum allowable value for numerical data points. Format: double |
min (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
min (anyOf 2) | null | Alternative | The minimum allowable value for numerical data points. Format: double |
min_date | JSON | Optional | |
min_date (anyOf 1) | string | Alternative | The earliest allowable date for date-type data points. Format: date |
min_date (anyOf 2) | null | Alternative | The earliest allowable date for date-type data points. Format: date |
nullable | boolean | Optional | Indicates whether the data point can be null. |
possible_options | array | Optional | A list of possible values the data point can have. Unique for each data point. |
possible_options[] | string | Each item | |
requires | Model | Optional | Expand 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_rules | array | Optional | Defines notice period rules based on the duration of employment. |
tenure_based_rules[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Optional additional information for rules, if applicable. |
cap | JSON | Optional | |
cap (anyOf 1) | JSON | Alternative | |
cap (anyOf 1) (anyOf 1) | number | Alternative | The 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
cap (anyOf 2) | null | Alternative | The maximum limit imposed for probation period for definite contract when specific calculation is used, it will be in additional_details.rule. Format: double |
note | JSON | Optional | |
note (anyOf 1) | string | Alternative | Additional explanation or notes related to this rule. |
note (anyOf 2) | null | Alternative | Additional explanation or notes related to this rule. |
rule | JSON | Optional | Specific rule that applies for probation period. |
rule (anyOf 1) | string | Alternative | Specific 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) | null | Alternative | |
time_unit | JSON | Optional | The unit of time applicable to notice period. |
time_unit (anyOf 1) | string | Alternative | The unit of time applicable to notice period. Known values: WEEK, MONTH, DAY |
time_unit (anyOf 2) | null | Alternative |
Get amendment validation settings — 200 response body — data item rules item requires
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contract 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
employment_duration_type | JSON | Optional | The unit of measurement for the employment duration. |
employment_duration_type (anyOf 1) | string | Alternative | The unit of measurement for the employment duration. Known values: DAY, WEEK, MONTH, YEAR |
employment_duration_type (anyOf 2) | null | Alternative | |
max_employment_duration | JSON | Optional | |
max_employment_duration (anyOf 1) | JSON | Alternative | |
max_employment_duration (anyOf 1) (anyOf 1) | integer | Alternative | The maximum duration of employment for this rule to apply. |
max_employment_duration (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
max_employment_duration (anyOf 2) | null | Alternative | The maximum duration of employment for this rule to apply. |
min_employment_duration | JSON | Optional | |
min_employment_duration (anyOf 1) | JSON | Alternative | |
min_employment_duration (anyOf 1) (anyOf 1) | integer | Alternative | The minimum duration of employment for this rule to apply. |
min_employment_duration (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
min_employment_duration (anyOf 2) | null | Alternative | The minimum duration of employment for this rule to apply. |
notice_value | JSON | Optional | |
notice_value (anyOf 1) | JSON | Alternative | |
notice_value (anyOf 1) (anyOf 1) | integer | Alternative | The required notice period for this range of employment duration. |
notice_value (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
notice_value (anyOf 2) | null | Alternative | The required notice period for this range of employment duration. |
Get amendments by contract — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Optional | |
data[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amendment_statuses | array | Optional | List of amendment statuses representing the history and progression of an amendment. |
amendment_statuses[] | Model | Each item | Expand Create amendment — 201 response body — data amendment statuses item |
created_at | string | Optional | Creation date of the amendment. Format: date-time |
currency | string | Optional | Contract currency. |
custom_items | array | Optional | Custom amendment items associated with the amendment flow |
custom_items[] | Model | Each item | Expand Accept amendment — 200 response body — data custom items item |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Free-text description of the amendment. |
description (anyOf 2) | null | Alternative | Free-text description of the amendment. |
document_type | JSON | Optional | Amendment document type |
document_type (anyOf 1) | string | Alternative | Amendment document type Known values: EA, SOW, SOW_EA |
document_type (anyOf 2) | null | Alternative | |
effective_date | JSON | Optional | |
effective_date (anyOf 1) | string | Alternative | Effective date of the amendment. Format: date-time |
effective_date (anyOf 2) | null | Alternative | Effective date of the amendment. Format: date-time |
employee_nationality | string | Optional | Nationality of the employee. |
employment_state | JSON | Optional | |
employment_state (anyOf 1) | string | Alternative | State of employment. |
employment_state (anyOf 2) | null | Alternative | State of employment. |
employment_type | string | Optional | Type of employment. Known values: FULL_TIME, PART_TIME |
end_date | JSON | Optional | |
end_date (anyOf 1) | string | Alternative | End date of the employment. Format: date-time |
end_date (anyOf 2) | null | Alternative | End date of the employment. Format: date-time |
fixed_adjustments | array | Optional | List of fixed adjustments associated with the amendment request. |
fixed_adjustments[] | Model | Each item | Expand Accept amendment — 200 response body — data fixed adjustments item |
holidays | JSON | Optional | |
holidays (anyOf 1) | JSON | Alternative | |
holidays (anyOf 1) (anyOf 1) | integer | Alternative | Number of holidays. |
holidays (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
holidays (anyOf 2) | null | Alternative | Number of holidays. |
hourly_rate | JSON | Optional | |
hourly_rate (anyOf 1) | string | Alternative | Hourly rate of the amendment |
hourly_rate (anyOf 2) | null | Alternative | Hourly rate of the amendment |
id | string | Optional | Id of amendment Format: uuid |
is_effective_date_updated | boolean | Optional | Is Effective Date updated. |
is_hrx_action_needed | boolean | Optional | Is HRX action needed. |
items | array | Optional | Items of amendment |
items[] | Model | Each item | Expand Get amendments by contract — 200 response body — data item items item |
job_category | JSON | Optional | |
job_category (anyOf 1) | string | Alternative | Job category associated with the job title. |
job_category (anyOf 2) | null | Alternative | Job category associated with the job title. |
job_code | JSON | Optional | |
job_code (anyOf 1) | string | Alternative | Job code associated with the job title. |
job_code (anyOf 2) | null | Alternative | Job code associated with the job title. |
job_title | string | Optional | Job title associated with the amendment. Maximum length: 1000 |
legal_context | JSON | Optional | Additional details needed for legal input |
legal_context (anyOf 1) | Model | Alternative | Expand Get amendments by contract — 200 response body — data item legal context Additional details needed for legal input |
legal_context (anyOf 2) | null | Alternative | |
net_salary | JSON | Optional | |
net_salary (anyOf 1) | string | Alternative | Net salary for the amendment. |
net_salary (anyOf 2) | null | Alternative | Net salary for the amendment. |
notice_period_after_probation | JSON | Optional | |
notice_period_after_probation (anyOf 1) | string | Alternative | Notice period after probation. |
notice_period_after_probation (anyOf 2) | null | Alternative | Notice period after probation. |
notice_period_during_probation | JSON | Optional | |
notice_period_during_probation (anyOf 1) | string | Alternative | Notice period during probation. |
notice_period_during_probation (anyOf 2) | null | Alternative | Notice period during probation. |
notice_period_time_unit | JSON | Optional | Notice period time unit. |
notice_period_time_unit (anyOf 1) | string | Alternative | Notice period time unit. Known values: DAY, WEEK, MONTH |
notice_period_time_unit (anyOf 2) | null | Alternative | |
notice_period_type | JSON | Optional | Type of notice period. |
notice_period_type (anyOf 1) | string | Alternative | Type of notice period. Known values: STANDARD, CUSTOM |
notice_period_type (anyOf 2) | null | Alternative | |
probation_period | JSON | Optional | |
probation_period (anyOf 1) | JSON | Alternative | |
probation_period (anyOf 1) (anyOf 1) | integer | Alternative | Duration of the probation period. |
probation_period (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
probation_period (anyOf 2) | null | Alternative | Duration of the probation period. |
probation_period_type_for_definite | JSON | Optional | Type of probation period for definite contracts. |
probation_period_type_for_definite (anyOf 1) | string | Alternative | Type of probation period for definite contracts. Known values: STANDARD, CUSTOM |
probation_period_type_for_definite (anyOf 2) | null | Alternative | |
rejection_context | JSON | Optional | Additional details containing rejection reason |
rejection_context (anyOf 1) | Model | Alternative | Expand Accept amendment — 200 response body — data rejection context Additional details containing rejection reason |
rejection_context (anyOf 2) | null | Alternative | |
requested_by | JSON | Optional | |
requested_by (anyOf 1) | string | Alternative | Profile name of the user who requested the change |
requested_by (anyOf 2) | null | Alternative | Profile name of the user who requested the change |
salary | string | Optional | Salary for the amendment. |
scope | string | Optional | Scope of the amendment. |
seniority_date | JSON | Optional | |
seniority_date (anyOf 1) | string | Alternative | The 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) | null | Alternative | The 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_id | JSON | Optional | |
seniority_id (anyOf 1) | string | Alternative | New seniority level identifier. Format: uuid |
seniority_id (anyOf 2) | null | Alternative | New seniority level identifier. Format: uuid |
sick_leave_days | JSON | Optional | |
sick_leave_days (anyOf 1) | JSON | Alternative | |
sick_leave_days (anyOf 1) (anyOf 1) | integer | Alternative | Number of sick leave days |
sick_leave_days (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
sick_leave_days (anyOf 2) | null | Alternative | Number of sick leave days |
source | JSON | Optional | Source of amendment flow creation. |
source (anyOf 1) | string | Alternative | Source of amendment flow creation. Known values: APP, PUBLIC_API, APP_BULK_AMENDMENT |
source (anyOf 2) | null | Alternative | |
start_date | string | Optional | Start date of the employment. Format: date-time |
time_off_type | string | Optional | Type of time off. Known values: STANDARD, SPECIFIC, PRORATED |
type | JSON | Optional | Type of amendment |
type (anyOf 1) | string | Alternative | Type of amendment Known values: INSTANT, OPS, LEGAL, DISABLED, CUSTOM, AUTOMATED |
type (anyOf 2) | null | Alternative | |
updated_at | string | Optional | Date when amendment is updated Format: date-time |
variable_compensation | Model | Optional | Expand 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_deadline | JSON | Optional | |
void_deadline (anyOf 1) | string | Alternative | Deadline this SOW to be voided Format: date-time |
void_deadline (anyOf 2) | null | Alternative | Deadline this SOW to be voided Format: date-time |
void_deadline_type | JSON | Optional | Type of void deadline |
void_deadline_type (anyOf 1) | string | Alternative | Type of void deadline Known values: CUTOFF, START_DATE, END_DATE, EXPIRY |
void_deadline_type (anyOf 2) | null | Alternative | |
work_hours_per_week | string | Optional | Number of work hours per week. |
work_schedule_id | JSON | Optional | |
work_schedule_id (anyOf 1) | string | Alternative | Work schedule id Format: uuid |
work_schedule_id (anyOf 2) | null | Alternative | Work schedule id Format: uuid |
work_schedule_rules_version | JSON | Optional | |
work_schedule_rules_version (anyOf 1) | string | Alternative | Work schedule rule version. |
work_schedule_rules_version (anyOf 2) | null | Alternative | Work 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data_point | string | Optional | The field that is selected for amendment. |
id | string | Optional | Id of amendment item Format: uuid |
item | string | Optional | Amendment item |
new_value | JSON | Optional | |
new_value (anyOf 1) | string | Alternative | The new valid value after the attempted change. |
new_value (anyOf 2) | null | Alternative | The new valid value after the attempted change. |
previous_value | JSON | Optional | |
previous_value (anyOf 1) | string | Alternative | The previous valid value before the attempted change. |
previous_value (anyOf 2) | null | Alternative | The previous valid value before the attempted change. |
type | string | Optional | Type of amendment |
Get amendments by contract — 200 response body — data item legal context Additional details needed for legal input
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional details needed for legal input |
details | string | Optional | Details regarding the legal request |
jira_ticket | string | Optional | Jira ticket identifier linked to the legal context |
jira_web_url | string | Optional | Link to the Jira ticket for tracking Format: uri |
requested_at | string | Optional | Timestamp when legal review was requested Format: date-time |
status | string | Optional | Current 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
default_effective_date | JSON | Optional | |
default_effective_date (anyOf 1) | string | Alternative | A default effective date suggested by the system Format: date-time |
default_effective_date (anyOf 2) | null | Alternative | A default effective date suggested by the system Format: date-time |
is_disabled | boolean | Optional | Indicates if the effective date field is disabled |
is_hidden | boolean | Optional | Indicates if the effective date field should be hidden. |
max_effective_date | JSON | Optional | |
max_effective_date (anyOf 1) | string | Alternative | The latest valid effective date Format: date-time |
max_effective_date (anyOf 2) | null | Alternative | The latest valid effective date Format: date-time |
message | string | Optional | Optional human-readable additional explanation on effective date limitation |
min_effective_date | JSON | Optional | |
min_effective_date (anyOf 1) | string | Alternative | The earliest valid effective date Format: date-time |
min_effective_date (anyOf 2) | null | Alternative | The earliest valid effective date Format: date-time |
Sign a contract amendment (employee) — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amendment_statuses | array | Optional | List of amendment statuses representing the history and progression of an amendment. |
amendment_statuses[] | Model | Each item | Expand Create amendment — 201 response body — data amendment statuses item |
created_at | string | Optional | Creation date of the amendment. Format: date-time |
currency | string | Optional | Contract currency. |
custom_items | array | Optional | Custom amendment items associated with the amendment flow |
custom_items[] | Model | Each item | Expand Accept amendment — 200 response body — data custom items item |
document_type | JSON | Optional | Amendment document type |
document_type (anyOf 1) | string | Alternative | Amendment document type Known values: EA, SOW, SOW_EA |
document_type (anyOf 2) | null | Alternative | |
effective_date | JSON | Optional | |
effective_date (anyOf 1) | string | Alternative | Effective date of the amendment. Format: date-time |
effective_date (anyOf 2) | null | Alternative | Effective date of the amendment. Format: date-time |
employee_nationality | string | Optional | Nationality of the employee. |
employment_state | JSON | Optional | |
employment_state (anyOf 1) | string | Alternative | State of employment. |
employment_state (anyOf 2) | null | Alternative | State of employment. |
employment_type | string | Optional | Type of employment. Known values: FULL_TIME, PART_TIME |
end_date | JSON | Optional | |
end_date (anyOf 1) | string | Alternative | End date of the employment. Format: date-time |
end_date (anyOf 2) | null | Alternative | End date of the employment. Format: date-time |
fixed_adjustments | array | Optional | List of fixed adjustments associated with the amendment request. |
fixed_adjustments[] | Model | Each item | Expand Accept amendment — 200 response body — data fixed adjustments item |
holidays | JSON | Optional | |
holidays (anyOf 1) | JSON | Alternative | |
holidays (anyOf 1) (anyOf 1) | integer | Alternative | Number of holidays. |
holidays (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
holidays (anyOf 2) | null | Alternative | Number of holidays. |
hourly_rate | JSON | Optional | |
hourly_rate (anyOf 1) | string | Alternative | Hourly rate of the amendment |
hourly_rate (anyOf 2) | null | Alternative | Hourly rate of the amendment |
id | string | Optional | Id of amendment Format: uuid |
is_effective_date_updated | boolean | Optional | Is Effective Date updated. |
is_hrx_action_needed | boolean | Optional | Is HRX action needed. |
items | array | Optional | Items of amendment |
items[] | Model | Each item | Expand Accept amendment — 200 response body — data items item |
job_category | JSON | Optional | |
job_category (anyOf 1) | string | Alternative | Job category associated with the job title. |
job_category (anyOf 2) | null | Alternative | Job category associated with the job title. |
job_code | JSON | Optional | |
job_code (anyOf 1) | string | Alternative | Job code associated with the job title. |
job_code (anyOf 2) | null | Alternative | Job code associated with the job title. |
job_title | string | Optional | Job title associated with the amendment. Maximum length: 1000 |
legal_context | JSON | Optional | Additional details needed for legal input |
legal_context (anyOf 1) | Model | Alternative | Expand Accept amendment — 200 response body — data legal context Additional details needed for legal input |
legal_context (anyOf 2) | null | Alternative | |
notice_period_after_probation | JSON | Optional | |
notice_period_after_probation (anyOf 1) | string | Alternative | Notice period after probation. |
notice_period_after_probation (anyOf 2) | null | Alternative | Notice period after probation. |
notice_period_during_probation | JSON | Optional | |
notice_period_during_probation (anyOf 1) | string | Alternative | Notice period during probation. |
notice_period_during_probation (anyOf 2) | null | Alternative | Notice period during probation. |
notice_period_time_unit | JSON | Optional | Notice period time unit. |
notice_period_time_unit (anyOf 1) | string | Alternative | Notice period time unit. Known values: DAY, WEEK, MONTH |
notice_period_time_unit (anyOf 2) | null | Alternative | |
notice_period_type | JSON | Optional | Type of notice period. |
notice_period_type (anyOf 1) | string | Alternative | Type of notice period. Known values: STANDARD, CUSTOM |
notice_period_type (anyOf 2) | null | Alternative | |
probation_period | JSON | Optional | |
probation_period (anyOf 1) | JSON | Alternative | |
probation_period (anyOf 1) (anyOf 1) | integer | Alternative | Duration of the probation period. |
probation_period (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
probation_period (anyOf 2) | null | Alternative | Duration of the probation period. |
probation_period_type_for_definite | JSON | Optional | Type of probation period for definite contracts. |
probation_period_type_for_definite (anyOf 1) | string | Alternative | Type of probation period for definite contracts. Known values: STANDARD, CUSTOM |
probation_period_type_for_definite (anyOf 2) | null | Alternative | |
rejection_context | JSON | Optional | Additional details containing rejection reason |
rejection_context (anyOf 1) | Model | Alternative | Expand Sign a contract amendment (employee) — 200 response body — data rejection context Additional details containing rejection reason |
rejection_context (anyOf 2) | null | Alternative | |
requested_by | JSON | Optional | |
requested_by (anyOf 1) | string | Alternative | Profile name of the user who requested the change |
requested_by (anyOf 2) | null | Alternative | Profile name of the user who requested the change |
salary | string | Optional | Salary for the amendment. |
scope | string | Optional | Scope of the amendment. |
seniority_date | JSON | Optional | |
seniority_date (anyOf 1) | string | Alternative | The 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) | null | Alternative | The 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_id | JSON | Optional | |
seniority_id (anyOf 1) | string | Alternative | Seniority level identifier. Format: uuid |
seniority_id (anyOf 2) | null | Alternative | Seniority level identifier. Format: uuid |
sick_leave_days | JSON | Optional | |
sick_leave_days (anyOf 1) | JSON | Alternative | |
sick_leave_days (anyOf 1) (anyOf 1) | integer | Alternative | Number of sick leave days |
sick_leave_days (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
sick_leave_days (anyOf 2) | null | Alternative | Number of sick leave days |
source | JSON | Optional | Source of amendment flow creation. |
source (anyOf 1) | string | Alternative | Source of amendment flow creation. Known values: APP, PUBLIC_API, APP_BULK_AMENDMENT |
source (anyOf 2) | null | Alternative | |
start_date | string | Optional | Start date of the employment. Format: date-time |
time_off_type | string | Optional | Type of time off. Known values: STANDARD, SPECIFIC, PRORATED |
type | JSON | Optional | Type of amendment |
type (anyOf 1) | string | Alternative | Type of amendment Known values: INSTANT, OPS, LEGAL, DISABLED, CUSTOM, AUTOMATED |
type (anyOf 2) | null | Alternative | |
updated_at | string | Optional | Date when amendment is updated Format: date-time |
variable_compensation | Model | Optional | Expand 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_deadline | JSON | Optional | |
void_deadline (anyOf 1) | string | Alternative | Deadline this SOW to be voided Format: date-time |
void_deadline (anyOf 2) | null | Alternative | Deadline this SOW to be voided Format: date-time |
void_deadline_type | JSON | Optional | Type of void deadline |
void_deadline_type (anyOf 1) | string | Alternative | Type of void deadline Known values: CUTOFF, START_DATE, END_DATE, EXPIRY |
void_deadline_type (anyOf 2) | null | Alternative | |
work_hours_per_week | string | Optional | Number of work hours per week. |
work_schedule_id | JSON | Optional | |
work_schedule_id (anyOf 1) | string | Alternative | Work schedule id Format: uuid |
work_schedule_id (anyOf 2) | null | Alternative | Work schedule id Format: uuid |
work_schedule_rules_version | JSON | Optional | |
work_schedule_rules_version (anyOf 1) | string | Alternative | Work schedule rule version. |
work_schedule_rules_version (anyOf 2) | null | Alternative | Work 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional details containing rejection reason |
rejected_at | string | Optional | Timestamp of when the rejection occurred Format: date-time |
Update amendment — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand Update amendment — 200 response body — data |
Referenced models: Update amendment — 200 response body — data
Update amendment — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amendment_statuses | array | Optional | List of amendment statuses representing the history and progression of an amendment. |
amendment_statuses[] | Model | Each item | Expand Create amendment — 201 response body — data amendment statuses item |
created_at | string | Optional | Creation date of the amendment. Format: date-time |
currency | string | Optional | Contract currency. |
custom_items | array | Optional | Custom amendment items associated with the amendment flow |
custom_items[] | Model | Each item | Expand Accept amendment — 200 response body — data custom items item |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Free-text description of the amendment. |
description (anyOf 2) | null | Alternative | Free-text description of the amendment. |
document_type | JSON | Optional | Amendment document type |
document_type (anyOf 1) | string | Alternative | Amendment document type Known values: EA, SOW, SOW_EA |
document_type (anyOf 2) | null | Alternative | |
effective_date | JSON | Optional | |
effective_date (anyOf 1) | string | Alternative | Effective date of the amendment. Format: date-time |
effective_date (anyOf 2) | null | Alternative | Effective date of the amendment. Format: date-time |
employee_nationality | string | Optional | Nationality of the employee. |
employment_state | JSON | Optional | |
employment_state (anyOf 1) | string | Alternative | State of employment. |
employment_state (anyOf 2) | null | Alternative | State of employment. |
employment_type | string | Optional | Type of employment. Known values: FULL_TIME, PART_TIME |
end_date | JSON | Optional | |
end_date (anyOf 1) | string | Alternative | End date of the employment. Format: date-time |
end_date (anyOf 2) | null | Alternative | End date of the employment. Format: date-time |
fixed_adjustments | array | Optional | List of fixed adjustments associated with the amendment request. |
fixed_adjustments[] | Model | Each item | Expand Accept amendment — 200 response body — data fixed adjustments item |
holidays | JSON | Optional | |
holidays (anyOf 1) | JSON | Alternative | |
holidays (anyOf 1) (anyOf 1) | integer | Alternative | Number of holidays. |
holidays (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
holidays (anyOf 2) | null | Alternative | Number of holidays. |
hourly_rate | JSON | Optional | |
hourly_rate (anyOf 1) | string | Alternative | Hourly rate of the amendment |
hourly_rate (anyOf 2) | null | Alternative | Hourly rate of the amendment |
id | string | Optional | Id of amendment Format: uuid |
is_effective_date_updated | boolean | Optional | Is Effective Date updated. |
is_hrx_action_needed | boolean | Optional | Is HRX action needed. |
items | array | Optional | Items of amendment |
items[] | Model | Each item | Expand Accept amendment — 200 response body — data items item |
job_category | JSON | Optional | |
job_category (anyOf 1) | string | Alternative | Job category associated with the job title. |
job_category (anyOf 2) | null | Alternative | Job category associated with the job title. |
job_code | JSON | Optional | |
job_code (anyOf 1) | string | Alternative | Job code associated with the job title. |
job_code (anyOf 2) | null | Alternative | Job code associated with the job title. |
job_title | string | Optional | Job title associated with the amendment. Maximum length: 1000 |
legal_context | JSON | Optional | Additional details needed for legal input |
legal_context (anyOf 1) | Model | Alternative | Expand Accept amendment — 200 response body — data legal context Additional details needed for legal input |
legal_context (anyOf 2) | null | Alternative | |
net_salary | JSON | Optional | |
net_salary (anyOf 1) | string | Alternative | Net salary for the amendment. |
net_salary (anyOf 2) | null | Alternative | Net salary for the amendment. |
notice_period_after_probation | JSON | Optional | |
notice_period_after_probation (anyOf 1) | string | Alternative | Notice period after probation. |
notice_period_after_probation (anyOf 2) | null | Alternative | Notice period after probation. |
notice_period_during_probation | JSON | Optional | |
notice_period_during_probation (anyOf 1) | string | Alternative | Notice period during probation. |
notice_period_during_probation (anyOf 2) | null | Alternative | Notice period during probation. |
notice_period_time_unit | JSON | Optional | Notice period time unit. |
notice_period_time_unit (anyOf 1) | string | Alternative | Notice period time unit. Known values: DAY, WEEK, MONTH |
notice_period_time_unit (anyOf 2) | null | Alternative | |
notice_period_type | JSON | Optional | Type of notice period. |
notice_period_type (anyOf 1) | string | Alternative | Type of notice period. Known values: STANDARD, CUSTOM |
notice_period_type (anyOf 2) | null | Alternative | |
probation_period | JSON | Optional | |
probation_period (anyOf 1) | JSON | Alternative | |
probation_period (anyOf 1) (anyOf 1) | integer | Alternative | Duration of the probation period. |
probation_period (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
probation_period (anyOf 2) | null | Alternative | Duration of the probation period. |
probation_period_type_for_definite | JSON | Optional | Type of probation period for definite contracts. |
probation_period_type_for_definite (anyOf 1) | string | Alternative | Type of probation period for definite contracts. Known values: STANDARD, CUSTOM |
probation_period_type_for_definite (anyOf 2) | null | Alternative | |
rejection_context | JSON | Optional | Additional details containing rejection reason |
rejection_context (anyOf 1) | Model | Alternative | Expand Accept amendment — 200 response body — data rejection context Additional details containing rejection reason |
rejection_context (anyOf 2) | null | Alternative | |
requested_by | JSON | Optional | |
requested_by (anyOf 1) | string | Alternative | Profile name of the user who requested the change |
requested_by (anyOf 2) | null | Alternative | Profile name of the user who requested the change |
salary | string | Optional | Salary for the amendment. |
scope | string | Optional | Scope of the amendment. |
seniority_date | JSON | Optional | |
seniority_date (anyOf 1) | string | Alternative | The 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) | null | Alternative | The 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_id | JSON | Optional | |
seniority_id (anyOf 1) | string | Alternative | Seniority level identifier. Format: uuid |
seniority_id (anyOf 2) | null | Alternative | Seniority level identifier. Format: uuid |
sick_leave_days | JSON | Optional | |
sick_leave_days (anyOf 1) | JSON | Alternative | |
sick_leave_days (anyOf 1) (anyOf 1) | integer | Alternative | Number of sick leave days |
sick_leave_days (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
sick_leave_days (anyOf 2) | null | Alternative | Number of sick leave days |
source | JSON | Optional | Source of amendment flow creation. |
source (anyOf 1) | string | Alternative | Source of amendment flow creation. Known values: APP, PUBLIC_API, APP_BULK_AMENDMENT |
source (anyOf 2) | null | Alternative | |
start_date | string | Optional | Start date of the employment. Format: date-time |
time_off_type | string | Optional | Type of time off. Known values: STANDARD, SPECIFIC, PRORATED |
type | JSON | Optional | Type of amendment |
type (anyOf 1) | string | Alternative | Type of amendment Known values: INSTANT, OPS, LEGAL, DISABLED, CUSTOM, AUTOMATED |
type (anyOf 2) | null | Alternative | |
updated_at | string | Optional | Date when amendment is updated Format: date-time |
variable_compensation | Model | Optional | Expand 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_deadline | JSON | Optional | |
void_deadline (anyOf 1) | string | Alternative | Deadline this SOW to be voided Format: date-time |
void_deadline (anyOf 2) | null | Alternative | Deadline this SOW to be voided Format: date-time |
void_deadline_type | JSON | Optional | Type of void deadline |
void_deadline_type (anyOf 1) | string | Alternative | Type of void deadline Known values: CUTOFF, START_DATE, END_DATE, EXPIRY |
void_deadline_type (anyOf 2) | null | Alternative | |
work_hours_per_week | string | Optional | Number of work hours per week. |
work_schedule_id | JSON | Optional | |
work_schedule_id (anyOf 1) | string | Alternative | Work schedule id Format: uuid |
work_schedule_id (anyOf 2) | null | Alternative | Work schedule id Format: uuid |
work_schedule_rules_version | JSON | Optional | |
work_schedule_rules_version (anyOf 1) | string | Alternative | Work schedule rule version. |
work_schedule_rules_version (anyOf 2) | null | Alternative | Work 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | object | Optional | Validation results keyed by amendment field Additional keys: see wildcard field |
data.* | Model | Additional keys | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
message | JSON | Optional | |
message (anyOf 1) | string | Alternative | Validation message for the field, present when the value is invalid. |
message (anyOf 2) | null | Alternative | Validation message for the field, present when the value is invalid. |
valid | JSON | Optional | |
valid (anyOf 1) | boolean | Alternative | Whether the submitted value for this field is valid. |
valid (anyOf 2) | null | Alternative | Whether the submitted value for this field is valid. |
Validate amendment data points — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Amendment fields to validate. At least one of scope or job_title must be provided. |
job_title | string | Optional | Job title to validate, up to 1,000 characters. |
scope | string | Optional | Job scope to validate, up to 20,000 characters. |