API Data Provider - Online Help

EorAmendments

Track employment contract modifications for EOR employees including salary adjustments, title changes, work schedule updates, and benefit changes requiring legal review and compliance approval.

Columns

Name Type ReadOnly References Description
Id [KEY] String True

Amendment record identifier for tracking employment contract change history through legal and compliance workflows

ContractId String False

EOR employment contract to retrieve amendment history for

Type String True

Processing category determining review requirements and approval workflow

The allowed values are INSTANT, OPS, LEGAL, DISABLED, CUSTOM, AUTOMATED.

Source String True

How amendment was initiated (web app, API, bulk upload) for audit trail

The allowed values are APP, PUBLIC_API, APP_BULK_AMENDMENT.

Items String True

Specific fields being changed with before and after values for change tracking

CustomItems String True

Additional amendment details requiring special processing or approval

Salary Double False

New annual base salary effective when amendment activates

Currency String True

Salary currency which must match local regulations for employee's country

JobTitle String False

Updated position title appearing on employment contract and payslips

JobCode String True

Internal job classification code for HR systems and reporting

EmploymentType String False

Updated work arrangement affecting hours and benefits eligibility

The allowed values are FULL_TIME, PART_TIME.

StartDate Datetime False

Original employment commencement date (typically unchanged in amendments)

EndDate Datetime False

Updated contract end date for fixed-term employment modifications

EffectiveDate Datetime False

When amended terms take effect for payroll, benefits, and legal compliance

HourlyRate Decimal False

Hourly wage for part-time employees or overtime calculations

FixedAdjustments String True

Regular allowances like car, housing, or meal stipends added to base salary

VariableCompensation String True

Performance bonuses, commissions, or incentive pay structures

AmendmentStatuses String True

Workflow progression through draft, legal review, approval, and activation stages

LegalContext String True

Legal team review status and case reference for compliance verification

RejectionContext String True

When and why amendment was declined with rejection reason

CreatedAt Datetime True

When employment change was initiated by HR or manager

UpdatedAt Datetime True

Most recent modification to amendment details or status

RequestedBy String True

Name of person who initiated this employment change for audit trail

Scope String True

Amendment scope indicating extent of changes (partial update vs. full contract rewrite)

Holidays Integer False

Updated paid time off days per year based on country regulations and company policy

JobCategory String True

Occupation classification for statistical reporting and labor regulations

SeniorityId String True

Seniority level affecting compensation bands and benefits eligibility

SeniorityDate Datetime True

When employee's tenure tracking started for calculating leave accrual and severance

DocumentType String True

Legal document format for the amendment based on change type

The allowed values are SOW_EA.

TimeOffType String True

Vacation and leave policy framework applied to employee

The allowed values are STANDARD.

SickLeaveDays Integer True

Annual paid sick leave allowance per company policy and local law

EmploymentState String True

Current employment status (active, on leave, terminated) for amendment context

ProbationPeriod Integer True

Probationary period length in months before full employment rights activate

ProbationPeriodTypeForDefinite String True

Probation framework for fixed-term contracts based on local regulations

The allowed values are STANDARD.

WorkScheduleId String True

Assigned shift pattern or work calendar for attendance and payroll

WorkScheduleRulesVersion String True

Version number of work schedule configuration for tracking policy changes

WorkHoursPerWeek String False

Standard weekly hours determining full-time status and overtime thresholds

VoidDeadline Datetime True

Last date to cancel amendment before it automatically activates

VoidDeadlineType String True

Type of cancellation deadline (hard cutoff vs. negotiable window)

The allowed values are CUTOFF.

NoticePeriodType String False

Notice period framework (standard statutory or custom negotiated terms)

The allowed values are CUSTOM.

NoticePeriodTimeUnit String True

Time unit for notice period calculations (days, weeks, months)

The allowed values are WEEK.

NoticePeriodAfterProbation String False

Required termination notice after probation ends based on tenure and regulations

NoticePeriodDuringProbation String False

Shortened notice period applicable during probationary period

EmployeeNationality String True

Employee's citizenship affecting work permit requirements and tax treaties

IsHrxActionNeeded Boolean True

Whether Deel HR operations team must process this amendment for compliance

IsEffectiveDateUpdated Boolean True

Whether the amendment's effective date has been changed after initial creation

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 26.0.9770.0