Update sandbox employment

PUT

sandbox

employment

{individual_id}

object

first_name

string

middle_name

string

last_name

string

title

string

manager

object

string

department

object

name

string

employment

object

type

enum<string>

subtype

enum<string>

start_date

string

end_date

string

latest_rehire_date

string

is_active

boolean

employment_status

enum<string>

class_code

string

location

object

line1

string

line2

string

city

string

state

string

postal_code

string

country

string

name

string

source_id

string

income

object

unit

enum<string>

amount

integer

currency

string

effective_date

string

income_history

array

custom_fields

array

source_id

string

Authorizations

Authorization

string

headerrequired

Please use your Access Token

Path Parameters

individual_id

string

required

Body

application/json

first_name

string | null

The legal first name of the individual.

middle_name

string | null

The legal middle name of the individual.

last_name

string | null

The legal last name of the individual.

title

string | null

The current title of the individual.

manager

object | null

The manager object representing the manager of the individual within the org.

department

object | null

The department object.

employment

object | null

The employment object.

employment.type

enum<string> | null

The main employment type of the individual.

Available options:

employee,

contractor

employment.subtype

enum<string> | null

The secondary employment type of the individual. Options: `full_time`, `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.

Available options:

full_time,

intern,

part_time,

temp,

seasonal,

individual_contractor

start_date

string | null

end_date

string | null

latest_rehire_date

string | null

is_active

boolean | null

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

employment_status

enum<string> | null

The detailed employment status of the individual.

Available options:

active,

deceased,

leave,

onboarding,

prehire,

retired,

terminated

class_code

string | null

Worker's compensation classification code for this employee

location

object | null

income

object | null

The employee's income as reported by the provider. This may not always be annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc, depending on what information the provider returns.

income_history

array | null

The array of income history.

custom_fields

object[]

Custom fields for the individual. These are fields which are defined by the employer in the system. Custom fields are not currently supported for assisted connections.

source_id

string

The source system's unique employment identifier for this individual

Response

200 - application/json

first_name

string | null

The legal first name of the individual.

middle_name

string | null

The legal middle name of the individual.

last_name

string | null

The legal last name of the individual.

title

string | null

The current title of the individual.

manager

object | null

The manager object representing the manager of the individual within the org.

department

object | null

The department object.

employment

object | null

The employment object.

employment.type

enum<string> | null

The main employment type of the individual.

Available options:

employee,

contractor

employment.subtype

enum<string> | null

The secondary employment type of the individual. Options: `full_time`, `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.

Available options:

full_time,

intern,

part_time,

temp,

seasonal,

individual_contractor

start_date

string | null

end_date

string | null

latest_rehire_date

string | null

is_active

boolean | null

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

employment_status

enum<string> | null

The detailed employment status of the individual.

Available options:

active,

deceased,

leave,

onboarding,

prehire,

retired,

terminated

class_code

string | null

Worker's compensation classification code for this employee

location

object | null

income

object | null

income_history

array | null

The array of income history.

custom_fields

object[]

Custom fields for the individual. These are fields which are defined by the employer in the system. Custom fields are not currently supported for assisted connections.

source_id

string

The source system's unique employment identifier for this individual

string

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

Was this page helpful?

Update sandbox individual Add new individuals to a sandbox company

Organization

Payroll

Deductions

Documents

Connect

Management

Sandbox

Development Guides

Update sandbox employment

Authorizations

Path Parameters

Body

Response