The business-establishment resource

A business-establishment is a geographically localized unit of the organization structure.

It belongs to a legal-entity. A legal-entity may have one (and only one) business-establishment set as its headquarters.

Business-establishments are an essential resource of the enterprise model, as they are the fundamental units of access rights scoping. As such, most objects are either directly or indirectly attached to a business-establishment.

Employees are attached to a business-establishment through their job-position.

name

string

required

Minimum string length: 1

remoteId

null | string

The third-party API ID of the matching object.

isArchived

boolean

If this business-establishment is archived. Only possible if there are no more employees attached.

legalEntity

Reference to a legal-entity · object

Reference to the legal-entity this business-establishment belongs to.

Show child attributes

legalEntity.id

string

required

Minimum string length: 1

isHeadquarters

boolean

True when this business-establishment should be considered the headquarters of the legal-entity it belongs to. A legal-entity may only have a single one headquarters.

taxIdentificationNumber

object

France: SIRET (Système d'identification du répertoire des établissements). Must start with the same identifier than its legal-entity (SIREN).

Show child attributes

taxIdentificationNumber.format

enum<string>

required

Available options:

other,

franceSIRET,

spainNIF

taxIdentificationNumber.value

string

required

Minimum string length: 1

industryCode

object

The industry (classification) code identifies the main type of activity of this legal-entity.

France: APE or NAF code.
Spain: CNAE.
Germany: WZ (Die Klassifikation der Wirtschaftszweige).
U.S.A.: NAICS (North American Industry Classification System).

Show child attributes

industryCode.format

enum<string>

required

Available options:

other,

franceAPE,

spainCNAE,

germanyWZ,

usaNAICS

industryCode.value

string

required

Minimum string length: 1

address

address · object

Representation of a postal address.

Show child attributes

address.addressLines

string[]

required

Unstructured ordered address lines describing the lower levels of an address.

Minimum array length: 1

Minimum string length: 1

address.postalCode

string | null

Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. city validation).

address.locality

string | null

Optional. Generally refers to the city/town portion of the address. Examples: French city, IT comune, UK post town.

address.administrativeArea

string | null

Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture.

address.countryCode

enum<string> | null

Three letters ISO 3166-1 alpha-3 country code.

Available options:

FRA,

ESP,

DEU,

CHE,

ITA,

GBR,

USA,

BEL,

CAN,

AFG,

ALA,

ALB,

DZA,

ASM,

AND,

AGO,

AIA,

ATA,

ATG,

ARG,

ARM,

ABW,

AUS,

AUT,

AZE,

BHS,

BHR,

BGD,

BRB,

BLR,

BLZ,

BEN,

BMU,

BTN,

BOL,

BIH,

BWA,

BVT,

BRA,

VGB,

IOT,

BRN,

BGR,

BFA,

BDI,

KHM,

CMR,

CPV,

CYM,

CAF,

TCD,

CHL,

CHN,

HKG,

MAC,

CXR,

CCK,

COL,

COM,

COG,

COD,

COK,

CRI,

CIV,

HRV,

CUB,

CYP,

CZE,

DNK,

DJI,

DMA,

DOM,

ECU,

EGY,

SLV,

GNQ,

ERI,

EST,

ETH,

FLK,

FRO,

FJI,

FIN,

GUF,

PYF,

ATF,

GAB,

GMB,

GEO,

GHA,

GIB,

GRC,

GRL,

GRD,

GLP,

GUM,

GTM,

GGY,

GIN,

GNB,

GUY,

HTI,

HMD,

VAT,

HND,

HUN,

ISL,

IND,

IDN,

IRN,

IRQ,

IRL,

IMN,

ISR,

JAM,

JPN,

JEY,

JOR,

KAZ,

KEN,

KIR,

PRK,

KOR,

KWT,

KGZ,

LAO,

LVA,

LBN,

LSO,

LBR,

LBY,

LIE,

LTU,

LUX,

MKD,

MDG,

MWI,

MYS,

MDV,

MLI,

MLT,

MHL,

MTQ,

MRT,

MUS,

MYT,

MEX,

FSM,

MDA,

MCO,

MNG,

MNE,

MSR,

MAR,

MOZ,

MMR,

NAM,

NRU,

NPL,

NLD,

NCL,

NZL,

NIC,

NER,

NGA,

NIU,

NFK,

MNP,

NOR,

OMN,

PAK,

PLW,

PSE,

PAN,

PNG,

PRY,

PER,

PHL,

PCN,

POL,

PRT,

PRI,

QAT,

REU,

ROU,

RUS,

RWA,

BLM,

SHN,

KNA,

LCA,

MAF,

SXM,

SPM,

VCT,

WSM,

SMR,

STP,

SAU,

SEN,

SRB,

SYC,

SLE,

SGP,

SVK,

SVN,

SLB,

SOM,

ZAF,

SGS,

SSD,

LKA,

SDN,

SUR,

SJM,

SWZ,

SWE,

SYR,

TWN,

TJK,

TZA,

THA,

TLS,

TGO,

TKL,

TON,

TTO,

TUN,

TUR,

TKM,

TCA,

TUV,

UGA,

UKR,

ARE,

UMI,

URY,

UZB,

VUT,

VEN,

VNM,

VIR,

WLF,

ESH,

YEM,

ZMB,

ZWE

Required string length: 3

Example:

"FRA"

Example:

{
  "addressLines": ["10 Place de la Joliette", "Atrium 10.2"],
  "postalCode": "13002",
  "locality": "Marseille",
  "administrativeArea": "Bouches-du-Rhône",
  "countryCode": "FRA"
}

timezoneId

string | null

IANA timezone identifier this business-establishment belongs to.

Example:

"Europe/Paris"

lastArchivedAt

string<date-time> | null

Read-only. UTC timestamp of the moment this object was last archived through its isArchived property.

Example:

"2023-01-23T12:45:23.1234Z"

Overview

Organization

Employee Records

Events & Webhooks

The business-establishment resource