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

const finch = new Finch();

async function main() {
  const companyUpdateResponse = await finch.sandbox.company.update({
    accounts: [{}, {}, {}],
    departments: [{}, {}, {}],
    ein: 'string',
    entity: {},
    legal_name: 'string',
    locations: [{}, {}, {}],
    primary_email: 'string',
    primary_phone_number: 'string',
  });

  console.log(companyUpdateResponse.accounts);
}

main();
{
  "legal_name": "<string>",
  "entity": {
    "type": "llc",
    "subtype": "s_corporation"
  },
  "primary_email": "<string>",
  "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
headerrequired

Please use your Access Token

Body

application/json
legal_name
string | null

The legal name of the company.

entity
object | null

The entity type object.

primary_email
string | null

The email of the main administrator on the account.

primary_phone_number
string | null

The phone number of the main administrator on the account. Format: XXXXXXXXXX

departments
array | null

The array of company departments.

ein
string | null

The employer identification number.

locations
array | null
accounts
object[] | null

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

Response

200 - application/json
legal_name
string | null

The legal name of the company.

entity
object | null

The entity type object.

primary_email
string | null

The email of the main administrator on the account.

primary_phone_number
string | null

The phone number of the main administrator on the account. Format: XXXXXXXXXX

departments
array | null

The array of company departments.

ein
string | null

The employer identification number.

locations
array | null
accounts
object[] | null

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