PUT
/
sandbox
/
employment
/
{individual_id}
import Finch from '@tryfinch/finch-api';

const client = new Finch({
  accessToken: 'My Access Token',
});

async function main() {
  const employment = await client.sandbox.employment.update('individual_id');

  console.log(employment.id);
}

main();
{
  "first_name": "<string>",
  "middle_name": "<string>",
  "last_name": "<string>",
  "title": "<string>",
  "manager": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "department": {
    "name": "<string>"
  },
  "employment": {
    "type": "employee",
    "subtype": "full_time"
  },
  "start_date": "<string>",
  "end_date": "<string>",
  "latest_rehire_date": "<string>",
  "is_active": true,
  "employment_status": "active",
  "class_code": "<string>",
  "location": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postal_code": "<string>",
    "country": "<string>",
    "name": "<string>",
    "source_id": "<string>"
  },
  "income": {
    "unit": "yearly",
    "amount": 123,
    "currency": "<string>",
    "effective_date": "<string>"
  },
  "income_history": [
    {
      "unit": "yearly",
      "amount": 123,
      "currency": "<string>",
      "effective_date": "<string>"
    }
  ],
  "custom_fields": [
    {
      "name": "<string>",
      "value": "<any>"
    }
  ],
  "source_id": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

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 | 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.

​
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.

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.

​
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
OK
​
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.

​
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.

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.

​
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

​
id
string

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

Was this page helpful?