PUT
/
sandbox
/
company
JavaScript
import Finch from '@tryfinch/finch-api';

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

const company = await client.sandbox.company.update({
  accounts: [{}],
  departments: [{}],
  ein: 'ein',
  entity: {},
  legal_name: 'legal_name',
  locations: [
    {
      city: 'city',
      country: 'country',
      line1: 'line1',
      line2: 'line2',
      postal_code: 'postal_code',
      state: 'state',
    },
  ],
  primary_email: 'dev@stainless.com',
  primary_phone_number: 'primary_phone_number',
});

console.log(company.accounts);
{
  "legal_name": "<string>",
  "entity": {
    "type": "llc",
    "subtype": "s_corporation"
  },
  "primary_email": "jsmith@example.com",
  "primary_phone_number": "<string>",
  "departments": [
    {
      "name": "<string>",
      "parent": {
        "name": "<string>"
      }
    }
  ],
  "ein": "<string>",
  "locations": [
    {
      "line1": "<string>",
      "line2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "postal_code": "<string>",
      "country": "<string>",
      "name": "<string>",
      "source_id": "<string>"
    }
  ],
  "accounts": [
    {
      "routing_number": "<string>",
      "account_name": "<string>",
      "institution_name": "<string>",
      "account_type": "checking",
      "account_number": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Please use your Access Token

Body

application/json
​
legal_name
string | null
required

The legal name of the company.

​
entity
object | null
required

The entity type object.

​
primary_email
string<email> | null
required

The email of the main administrator on the account.

​
primary_phone_number
string | null
required

The phone number of the main administrator on the account. Format: E.164, with extension where applicable, e.g. +NNNNNNNNNNN xExtension

​
departments
array | null
required

The array of company departments.

​
ein
string | null
required

The employer identification number.

​
locations
(Location · object | null)[] | null
required
​
accounts
object[] | null
required

An array of bank account objects associated with the payroll/HRIS system.

Response

200 - application/json

OK

​
legal_name
string | null
required

The legal name of the company.

​
entity
object | null
required

The entity type object.

​
primary_email
string<email> | null
required

The email of the main administrator on the account.

​
primary_phone_number
string | null
required

The phone number of the main administrator on the account. Format: E.164, with extension where applicable, e.g. +NNNNNNNNNNN xExtension

​
departments
array | null
required

The array of company departments.

​
ein
string | null
required

The employer identification number.

​
locations
(Location · object | null)[] | null
required
​
accounts
object[] | null
required

An array of bank account objects associated with the payroll/HRIS system.