Skip to main content

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 length: 1
​
id
string
Minimum length: 1
​
type
string
Allowed value: "business-establishment"
​
url
string<uri>
​
remoteId
string | null

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
object

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

​
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 | null
  • France: SIRET (Système d'identification du répertoire des établissements). Must start with the same identifier than its legal-entity (SIREN).
​
industryCode
object | null

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).
​
address
object | null

Representation of a postal address.

Examples:
{
  "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. Identifier from the IANA timezone database.

Examples:

"Europe/Paris"

​
lastArchivedAt
string<date-time> | null

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

Examples:

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

​
createdAt
string<date-time-offset>

Read-only. UTC timestamp of the moment this object was created.

Examples:

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

​
lastUpdatedAt
string<date-time>

Read-only. UTC timestamp of the moment this object was last updated. Set upon creation, update or deletion of the object.

Examples:

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

​
links
object