Update sandbox employment

Authorizations

Authorization

string

header

required

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

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

Show child attributes

manager.id

string<uuid>

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

department

object

The department object.

Show child attributes

department.name

string | null

The name of the department associated with the individual.

employment

object

The employment object.

Show child attributes

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.

Available options:

active,

deceased,

leave,

onboarding,

prehire,

retired,

terminated,

class_code

string | null

Worker's compensation classification code for this employee

location

Location · object

Show child attributes

location.line1

string | null

required

Street address or PO box.

location.line2

string | null

required

Apartment, suite, unit, or building.

location.city

string | null

required

City, district, suburb, town, or village.

location.state

string | null

required

The state code.

location.postal_code

string | null

required

The postal code or zip code.

location.country

string | null

required

The 2-letter ISO 3166 country code.

location.name

string | null

location.source_id

string | null

income

Income · object

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.

Show child attributes

income.unit

enum<string> | null

required

The income unit of payment. Options: yearly, quarterly, monthly, semi_monthly, bi_weekly, weekly, daily, hourly, and fixed.

Available options:

yearly,

quarterly,

monthly,

semi_monthly,

bi_weekly,

weekly,

daily,

hourly,

fixed,

income.amount

integer | null

required

The income amount in cents.

income.currency

string | null

required

The currency code.

income.effective_date

string<date> | null

required

The date the income amount went into effect.

income_history

(Income · object | null)[] | null

The array of income history.

Show child attributes

income_history.unit

enum<string> | null

required

The income unit of payment. Options: yearly, quarterly, monthly, semi_monthly, bi_weekly, weekly, daily, hourly, and fixed.

Available options:

yearly,

quarterly,

monthly,

semi_monthly,

bi_weekly,

weekly,

daily,

hourly,

fixed,

income_history.amount

integer | null

required

The income amount in cents.

income_history.currency

string | null

required

The currency code.

income_history.effective_date

string<date> | null

required

The date the income amount went into effect.

custom_fields

object[] | null

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.

Show child attributes

custom_fields.name

string | null

custom_fields.value

unknown

source_id

string | null

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

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

Show child attributes

manager.id

string<uuid>

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

department

object

The department object.

Show child attributes

department.name

string | null

The name of the department associated with the individual.

employment

object

The employment object.

Show child attributes

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.

Available options:

active,

deceased,

leave,

onboarding,

prehire,

retired,

terminated,

class_code

string | null

Worker's compensation classification code for this employee

location

Location · object

Show child attributes

location.line1

string | null

required

Street address or PO box.

location.line2

string | null

required

Apartment, suite, unit, or building.

location.city

string | null

required

City, district, suburb, town, or village.

location.state

string | null

required

The state code.

location.postal_code

string | null

required

The postal code or zip code.

location.country

string | null

required

The 2-letter ISO 3166 country code.

location.name

string | null

location.source_id

string | null

income

Income · object

Show child attributes

income.unit

enum<string> | null

required

The income unit of payment. Options: yearly, quarterly, monthly, semi_monthly, bi_weekly, weekly, daily, hourly, and fixed.

Available options:

yearly,

quarterly,

monthly,

semi_monthly,

bi_weekly,

weekly,

daily,

hourly,

fixed,

income.amount

integer | null

required

The income amount in cents.

income.currency

string | null

required

The currency code.

income.effective_date

string<date> | null

required

The date the income amount went into effect.

income_history

(Income · object | null)[] | null

The array of income history.

Show child attributes

income_history.unit

enum<string> | null

required

The income unit of payment. Options: yearly, quarterly, monthly, semi_monthly, bi_weekly, weekly, daily, hourly, and fixed.

Available options:

yearly,

quarterly,

monthly,

semi_monthly,

bi_weekly,

weekly,

daily,

hourly,

fixed,

income_history.amount

integer | null

required

The income amount in cents.

income_history.currency

string | null

required

The currency code.

income_history.effective_date

string<date> | null

required

The date the income amount went into effect.

custom_fields

object[] | null

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.

Show child attributes

custom_fields.name

string | null

custom_fields.value

unknown

source_id

string | null

The source system's unique employment identifier for this individual

string<uuid>

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

Organization

Payroll

Deductions

Documents

Connect

Management

Sandbox

Development Guides

Update sandbox employment

Authorizations

Path Parameters

Body

Response