Skip to main content
PUT
/
v1
/
businesses
/
{businessId}
Update business
curl --request PUT \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "legal_name": "<string>",
  "us_state": "AL",
  "country": "AF",
  "entity_type": "SOLE_PROP",
  "phone_number": "<string>",
  "sms_enabled": true,
  "sms_categorization_start_date": "2023-11-07T05:31:56Z",
  "activation_at": "2023-11-07T05:31:56Z",
  "archived_at": "2023-11-07T05:31:56Z",
  "unit_ids": [
    {
      "unit_id": "<string>",
      "account_name": "My Unit account",
      "opening_balance_init_to_zero": true,
      "opening_balance_do_not_init": true
    }
  ],
  "internal_bank_account_ids": [
    {
      "unit_id": "<string>",
      "account_name": "My Unit account",
      "opening_balance_init_to_zero": true,
      "opening_balance_do_not_init": true
    }
  ],
  "plaid_items": [
    {
      "item_id": "<string>",
      "access_token": "<string>",
      "sync_transactions": true,
      "institution_plaid_id": "<string>"
    }
  ],
  "plaid_processor_tokens": [
    {
      "processor_token": "<string>"
    }
  ],
  "stripe_connect_accounts": [
    {
      "stripe_id": "<string>"
    }
  ],
  "free_trial_ends_at": "2023-11-07T05:31:56Z"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "Business",
  "external_id": "test-acme-id",
  "legal_name": "ACME LLC",
  "tin": "<string>",
  "us_state": "AL",
  "country": "AF",
  "entity_type": "SOLE_PROP",
  "industry": "<string>",
  "phone_number": "+16504651359",
  "naics_code": "484110",
  "sms_enabled": true,
  "sms_stopped": true,
  "sms_categorization_start_date": "2023-11-07T05:31:56Z",
  "activation_at": "2023-11-07T05:31:56Z",
  "imported_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "archived_at": "2023-11-07T05:31:56Z",
  "unit_accounts": [
    {
      "id": "111111",
      "importedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "plaid_items": [
    {
      "layer_item_id": "550e8400-e29b-41d4-a716-446655440000",
      "accessToken": "access-sandbox-a67d0be8-abcd-1234-5678-14fc7bc65366",
      "institution": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "layer_id": "550e8400-e29b-41d4-a716-446655440000",
        "plaid_institution_id": "ins_1",
        "name": "Bank of America",
        "logo": "iVBORw0KGgoAAAANSUhEUgAAAJgAAACYCAMAAAAvHNATAAAA6lBMVEUAAAD////////////////////////////////////////////////////////////////////////////////qUmn74ubnNVD4xc398fLlJkT1qLTf4+zpRFzrYHb509rvfY7xjJuAkLTzmqfxi5vzmai/x9lBWY7v8fXtb4LjGDftboIhPXwBIWkRL3P3t8D2t8HsYHbvfo7P1ePzmqigrMeQnr3oRF1RZphhdaGQnb0xS4Wfq8dgdKHuboL609lwgqtgdaFwgqqvutCfrMevudCQnr5BWY/pQ11RZpeQnb70qLRRZ5f98fO30r7oAAAAFHRSTlMA3yDvv0AQn2DPcFCAoJAwf4+vXxXsOc8AAAYDSURBVHhe7ZwHcus4EESZo5L9h1nROfvnvDmn+19nvevvoqimQAKgRFTtvguwa7pnIEIgNFmM0DtwLV/X6V903bLcQWCPtR4ZB65v0jZ8N7B7EGUHFmhCTCvYZ+kc+8Ck1uhuqO0FUNWM6e7cVGdikhC6Z+yyWK5J4ri7kmZbJIllKyILsbo21ABZShjqTKhDJo7WEaFOnaJ73ZTrkAAV/AxNAhQomnNAO+JAKmmGTjtDl7DzmUk7xBS2c0I7ZiIWL5d2jiuiy6c94BuqxB5bQBVdqEwVXahMFV2oTA1diN52EfBpz/jtlLm0d1zhea/AGuBRLzxrDL5JvWA2tKYDDalIax5QbxwoEjAkVGOyIqajxgRDDhUxEgmbOlKxzpxQ7wxqk08KYKiRfMRSpGCIDcIsIiVLZpMkWfEyn13eZ9Il67Rg6Sq6+kJ0+o1cybpM2PN5frVG8jKVKVm3LZku31W0XQprcztvybiIqnWL5ddyT6hIUXSabnbAfF1bVMSS418nXrLVY6zyFxsPz6p1E7DUlJgVacQqTFwk65Zyl80WjX4cXW0yO61qS6/XhXMOkJH2hMmf88cBAXWDsuWXRSYc/5BESK+TTW0v7quGz09SEsEGJ6W1JZcxyTPi6smLn89qtZWeNvVhlhYxT1+OW8k6uru9vfvzzZSAItrshJiQ7DTK/5Edt/cyoEam390+8Qtqo3jd0vwE0x6Xi3wraQH8sNgmq+T8jOp4Gl3RaVZTq2oOV3G7nxhms4koC3kePchKGbMYpbFDZgvKQtK0duFC8uWC2IybIrYu6+anqr93H6ZtFi5UBfqRgD3Fzm5KWXdHNbH7UDqLyXpXp+pF2nrv098q6/y25Oii4m9ZxjeEoIfYGWz8B2HbwlVpxSnErpT2QztZaCE7/ePmzN9UDPvx0d/S4ovtsmC6AenxtldyuzlcF+Avr6worVf18sHwpCCEwrqmnJ5vdfHb2wrvp+KystVTd/waE+BpA9C13cWPpb8w1kAWe1FPK298uEyNtCG6WPL9ulGvNlx8C8sSyMJH1q/76KdbrpTo1aczcBE14zhFWWg3klT9tDaEfYKKQCHBYngPwGyhLCSKq4NMpwqfz1uE/u4InyYpa3NF0PGVcvoVs1yl5pI0QWeYspqHnK4RMj16zyrXW3QRn8QpC9GITXO5XqM5y4xTFrcwbMbNci2iduEqEoYsAWGvNprxFVVZoTHHzC0FlCUk7CN7di1mOLkyAuI5pywUhh3Kml0rVi9iuDCILJredqe/QeqhGZnPSpPmcYrgHEM+30Dq65txtmBuDGF/sIX51MjRDaQ+wwc+ji5Uj+QFMYC1ksH09wv0p7lc6azWRch8vbAh8bPEdBGQLTnCBbjaiHjB3CQpM/TYts0M+Des0xybkV0udLGZQAtlbczv25YrWvBsKhpCNmJmsFy4VnEw5twZjq9hSLQs1zwjHvhPixVJQ5aXQqHHLQKYFxxFizL0esaxLrI3VQLi5fhLXx4zRj13uXAbakzcxEm9O9lcoly4O2wSPyfQjZB6KBcHpvi/zjEBK9FmRCz2djrvhEPyP0iIQPYAAdtGsJtnvAqFrKWNxySIrj0yIkmyOhuTheSxWHkvF3U2fp3JnyNz5Lx8ncuu2DgsuvAylbcRnezEyyKRtxHHfhd9GSdS3Yg9WTIgOU5gDZLA00qE44/7wrO40+OAQwLE7Fxm3Z7tt0mWv67hdVwMAw+2SQctv+/+LKBN8jyPSR5b3cOTWDJFTugqWTJX4SPNyIB6Z6D0sXkkpJ7xtC0cKpV85lquyueMoSJGIiPqjZHSn5ip/1Ee4ikSMGSgyMhHhrR3hkp87I/4GsBozf8/FNcN9T/5V/+SBPWvlUAMv5eP/RWZZ0NHE2HQ47xn4/V8PY76Fwohzoh2xMjR5PD0ndgYatIYO+jOQyiXEkXTQ60jnE4HxwDK1Z+f6t8LaNn/mQse0VC1bhI1RDvUhMh3jj00uVWNbG0vhEOdS5Wj7Y9xy6t9e7p3eOhv1+S7Qb9XNdvBwLWs8vpo33JHXig9Rv8G+MxS+LqktYUAAAAASUVORK5CYII="
      },
      "itemId": "V3jvONy9xbroJVaRnm6oiAqVMv5Qz3TrNyLdL",
      "syncTransactions": true
    }
  ],
  "plaid_processor_tokens": [
    {
      "layer_processor_token_id": "550e8400-e29b-41d4-a716-446655440000",
      "processor_token": "processor-sandbox-d8e791d1-1234-9876-a207-69acca316045"
    }
  ],
  "previously_imported": true,
  "stripe_connect_accounts": [
    {}
  ],
  "default_reporting_basis": "CASH",
  "free_trial_ends_at": "2023-11-07T05:31:56Z"
}

Authorizations

ā€‹
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

ā€‹
Content-Type
string

Content-Type must be set to application/json.

Path Parameters

ā€‹
businessId
string
required

The UUID of the business to update.

Body

application/json
ā€‹
legal_name
string | null
ā€‹
us_state
enum<string>

Which United States state the business is incorporated in.

Available options:
AL,
AK,
AZ,
AR,
CA,
CO,
CT,
DE,
DC,
FL,
GA,
HI,
ID,
IL,
IN,
IA,
KS,
KY,
LA,
ME,
MD,
MA,
MI,
MN,
MS,
MO,
MT,
NE,
NV,
NH,
NJ,
NM,
NY,
NC,
ND,
OH,
OK,
OR,
PA,
PR,
RI,
SC,
SD,
TN,
TX,
UT,
VT,
VI,
VA,
WA,
WV,
WI,
WY
ā€‹
country
enum<string>

Which country the business is incorporated in.

Available options:
AF,
AL,
DZ,
AS,
AD,
AO,
AI,
AQ,
AG,
AR,
AM,
AW,
AU,
AT,
AZ,
BS,
BH,
BD,
BB,
BY,
BE,
BZ,
BJ,
BM,
BT,
BO,
BA,
BW,
BV,
BR,
IO,
BN,
BG,
BF,
BI,
KH,
CM,
CA,
CV,
KY,
CF,
TD,
CL,
CN,
CX,
CC,
CO,
KM,
CG,
CD,
CK,
CR,
CI,
HR,
CU,
CY,
CZ,
DK,
DJ,
DM,
DO,
EC,
EG,
SV,
GQ,
ER,
EE,
ET,
FK,
FO,
FJ,
FI,
FR,
GF,
PF,
TF,
GA,
GM,
GE,
DE,
GH,
GI,
GR,
GL,
GD,
GP,
GU,
GT,
GN,
GW,
GY,
HT,
HM,
VA,
HN,
HK,
HU,
IS,
IN,
ID,
IR,
IQ,
IE,
IL,
IT,
JM,
JP,
JO,
KZ,
KE,
KI,
KP,
KR,
KW,
KG,
LA,
LV,
LB,
LS,
LR,
LY,
LI,
LT,
LU,
MO,
MK,
MG,
MW,
MY,
MV,
ML,
MT,
ME,
MH,
MQ,
MR,
MU,
YT,
MX,
FM,
MD,
MC,
MN,
MS,
MA,
MZ,
MM,
NA,
NR,
NP,
NL,
NC,
NZ,
NI,
NE,
NG,
NU,
NF,
MP,
NO,
OM,
PK,
PW,
PS,
PA,
PG,
PY,
PE,
PH,
PN,
PL,
PT,
PR,
QA,
RE,
RO,
RU,
RS,
RW,
SH,
KN,
LC,
PM,
VC,
WS,
SM,
ST,
SA,
SN,
SC,
SL,
SG,
SK,
SI,
SB,
SO,
ZA,
GS,
ES,
LK,
SD,
SR,
SJ,
SZ,
SE,
CH,
SY,
TW,
TJ,
TZ,
TH,
TL,
TG,
TK,
TO,
TT,
TN,
TR,
TM,
TC,
TV,
UG,
UA,
AE,
GB,
US,
UM,
UY,
UZ,
VU,
VE,
VN,
VG,
VI,
WF,
EH,
YE,
ZM,
ZW
ā€‹
entity_type
enum<string>

Type of the business.

Available options:
SOLE_PROP,
C_CORP,
LLC,
S_CORP,
PARTNERSHIP,
NON_PROFIT,
TRUST
ā€‹
phone_number
string | null
ā€‹
sms_enabled
boolean | null
ā€‹
sms_categorization_start_date
string<date-time> | null
ā€‹
activation_at
string<date-time> | null

The activation timestamp represents the time at which Layer should begin displaying accounting data. Data before this time will not be displayed to users. This field is important for businesses migrating over from other accounting platforms. Defaults to Jan 1 of the current year.

ā€‹
archived_at
string<date-time> | null
ā€‹
unit_ids
object[] | null
ā€‹
internal_bank_account_ids
object[] | null
ā€‹
plaid_items
(New Plaid item Ā· object | Existing Plaid item by Layer ID Ā· object)[] | null

List of plaid items to connect to this business. If the business already has plaid items associated with it, they will be removed and replaced with the items in this list.

Parameters for specifying a Plaid item when creating or updating a business. Either provide item_id and access_token to create a new item, or provide id to reference an existing Plaid item by its Layer ID. Referencing by id is only supported when updating a business, not when creating one.

ā€‹
plaid_processor_tokens
(New Plaid processor token Ā· object | Existing processor token by Layer ID Ā· object)[] | null

List of plaid processor tokens to connect to this business. If the business already has plaid processor tokens associated with it, they will be removed and replaced with the tokens in this list.

Parameters for specifying a Plaid processor token when creating or updating a business. Either provide processor_token to create a new token, or provide id to reference an existing processor token by its Layer ID. Referencing by id is only supported when updating a business, not when creating one.

ā€‹
stripe_connect_accounts
object[] | null
ā€‹
free_trial_ends_at
string<date-time> | null

The date and time when the business's free trial ends.

Response

200 - application/json
ā€‹
id
string<uuid>

Unique identifier for the business.

ā€‹
type
string

Resource type. Value will be ā€œBusinessā€.

Example:

"Business"

ā€‹
external_id
string

Unique ID of the business in your system for linking purposes. Idempotency key.

Example:

"test-acme-id"

ā€‹
legal_name
string

Legal name of the business as it has been registered.

Example:

"ACME LLC"

ā€‹
tin
string | null

Tax Identification Number for the business.

ā€‹
us_state
enum<string>

The state this business is incorporated in.

Available options:
AL,
AK,
AZ,
AR,
CA,
CO,
CT,
DE,
DC,
FL,
GA,
HI,
ID,
IL,
IN,
IA,
KS,
KY,
LA,
ME,
MD,
MA,
MI,
MN,
MS,
MO,
MT,
NE,
NV,
NH,
NJ,
NM,
NY,
NC,
ND,
OH,
OK,
OR,
PA,
PR,
RI,
SC,
SD,
TN,
TX,
UT,
VT,
VI,
VA,
WA,
WV,
WI,
WY
ā€‹
country
enum<string>

2 letter ISO country code representing the country this business is incorporated in. Defaults to US.

Available options:
AF,
AL,
DZ,
AS,
AD,
AO,
AI,
AQ,
AG,
AR,
AM,
AW,
AU,
AT,
AZ,
BS,
BH,
BD,
BB,
BY,
BE,
BZ,
BJ,
BM,
BT,
BO,
BA,
BW,
BV,
BR,
IO,
BN,
BG,
BF,
BI,
KH,
CM,
CA,
CV,
KY,
CF,
TD,
CL,
CN,
CX,
CC,
CO,
KM,
CG,
CD,
CK,
CR,
CI,
HR,
CU,
CY,
CZ,
DK,
DJ,
DM,
DO,
EC,
EG,
SV,
GQ,
ER,
EE,
ET,
FK,
FO,
FJ,
FI,
FR,
GF,
PF,
TF,
GA,
GM,
GE,
DE,
GH,
GI,
GR,
GL,
GD,
GP,
GU,
GT,
GN,
GW,
GY,
HT,
HM,
VA,
HN,
HK,
HU,
IS,
IN,
ID,
IR,
IQ,
IE,
IL,
IT,
JM,
JP,
JO,
KZ,
KE,
KI,
KP,
KR,
KW,
KG,
LA,
LV,
LB,
LS,
LR,
LY,
LI,
LT,
LU,
MO,
MK,
MG,
MW,
MY,
MV,
ML,
MT,
ME,
MH,
MQ,
MR,
MU,
YT,
MX,
FM,
MD,
MC,
MN,
MS,
MA,
MZ,
MM,
NA,
NR,
NP,
NL,
NC,
NZ,
NI,
NE,
NG,
NU,
NF,
MP,
NO,
OM,
PK,
PW,
PS,
PA,
PG,
PY,
PE,
PH,
PN,
PL,
PT,
PR,
QA,
RE,
RO,
RU,
RS,
RW,
SH,
KN,
LC,
PM,
VC,
WS,
SM,
ST,
SA,
SN,
SC,
SL,
SG,
SK,
SI,
SB,
SO,
ZA,
GS,
ES,
LK,
SD,
SR,
SJ,
SZ,
SE,
CH,
SY,
TW,
TJ,
TZ,
TH,
TL,
TG,
TK,
TO,
TT,
TN,
TR,
TM,
TC,
TV,
UG,
UA,
AE,
GB,
US,
UM,
UY,
UZ,
VU,
VE,
VN,
VG,
VI,
WF,
EH,
YE,
ZM,
ZW
ā€‹
entity_type
enum<string>

Entity type of the business. Used to determine tax filing status.

Available options:
SOLE_PROP,
C_CORP,
LLC,
S_CORP,
PARTNERSHIP,
NON_PROFIT,
TRUST
ā€‹
industry
string

Industry classification for the business.

ā€‹
phone_number
string

Phone number used for SMS based categorization.

Example:

"+16504651359"

ā€‹
naics_code
string | null

6-digit NAICS code used to identify the business's industry.

Example:

"484110"

ā€‹
sms_enabled
boolean

Whether SMS is enabled for this business.

ā€‹
sms_stopped
boolean

Whether this business has responded to Layer's SMS with "STOP".

ā€‹
sms_categorization_start_date
string<date-time>

Date when SMS categorization starts for this business.

ā€‹
activation_at
string<date-time>

The activation timestamp represents the time at which Layer should begin displaying accounting data. Data before this time will not be displayed to users. This field is important for businesses migrating over from other accounting platforms. Defaults to Jan 1 of the current year.

ā€‹
imported_at
string<date-time>

Time when the business entity was created in Layer. Eligible sort key.

ā€‹
updated_at
string<date-time> | null

Time when the business's information was last updated in Layer. Eligible sort key.

ā€‹
archived_at
string<date-time> | null

Time when the business was archived, if applicable.

ā€‹
unit_accounts
object[]

List of unit accounts associated with this business.

ā€‹
plaid_items
object[]

Plaid items linked to this account.

ā€‹
plaid_processor_tokens
object[]

Plaid processor tokens linked to this account.

ā€‹
previously_imported
boolean | null

True if an archived business with the same phone number was unarchived during creation.

ā€‹
stripe_connect_accounts
object[]

List of Stripe Connect accounts associated with this business.

ā€‹
default_reporting_basis
enum<string> | null

Default accounting basis for financial reports.

Available options:
CASH,
ACCRUAL
ā€‹
free_trial_ends_at
string<date-time> | null

The date and time when the business's free trial ends.