v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-2148120293.6 KB
Sandbox

Update sandbox employment

put/sandbox/employment/{individual_id}

Request body

first_namestring nullable

The legal first name of the individual.

middle_namestring nullable

The legal middle name of the individual.

last_namestring nullable

The legal last name of the individual.

titlestring nullable

The current title of the individual.

start_datestring nullable
end_datestring nullable
latest_rehire_datestring nullable
is_activeboolean nullable

true if the individual an an active employee or contractor at the company.

employment_status'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated' | 'null' nullable

The detailed employment status of the individual.

flsa_status'exempt' | 'non_exempt' | 'unknown' | 'null' nullable

The FLSA status of the individual. Available options: exempt, non_exempt, unknown.

class_codestring nullable

Worker's compensation classification code for this employee

union_codestring nullable

The code identifying the union the employee is a member of, as configured in the payroll system.

union_localstring nullable

The local chapter or local number within the employee's union.

highly_compensated_employeeboolean nullable

IRS flag indicating whether the employee is classified as a Highly Compensated Employee for nondiscrimination testing purposes (ADP/ACP tests). US-only.

key_employeeboolean nullable

IRS flag indicating whether the employee is classified as a Key Employee for top-heavy testing purposes. US-only.

source_idstring nullable

The source system's unique employment identifier for this individual

Response

OK

first_namestring nullable

The legal first name of the individual.

middle_namestring nullable

The legal middle name of the individual.

last_namestring nullable

The legal last name of the individual.

titlestring nullable

The current title of the individual.

start_datestring nullable
end_datestring nullable
latest_rehire_datestring nullable
is_activeboolean nullable

true if the individual an an active employee or contractor at the company.

employment_status'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated' | 'null' nullable

The detailed employment status of the individual.

flsa_status'exempt' | 'non_exempt' | 'unknown' | 'null' nullable

The FLSA status of the individual. Available options: exempt, non_exempt, unknown.

class_codestring nullable

Worker's compensation classification code for this employee

union_codestring nullable

The code identifying the union the employee is a member of, as configured in the payroll system.

union_localstring nullable

The local chapter or local number within the employee's union.

highly_compensated_employeeboolean nullable

IRS flag indicating whether the employee is classified as a Highly Compensated Employee for nondiscrimination testing purposes (ADP/ACP tests). US-only.

key_employeeboolean nullable

IRS flag indicating whether the employee is classified as a Key Employee for top-heavy testing purposes. US-only.

source_idstring nullable

The source system's unique employment identifier for this individual

idstring uuid

A stable Finch id (UUID v4) for an individual in the company.