The establishment resource

name

string

required

Required string length: 0

legalUnitId

integer<int32>

required

Required range: x >= 1

code

string | null

Required string length: 0

legalUnit

legal-unit · object

Show child attributes

legalUnit.name

string

required

Required string length: 0

legalUnit.countryId

string

required

ISO 3166 alpha-2 code for the country this legal-unit belongs to.

Required string length: 2

legalUnit.code

string | null

Required string length: 0

legalUnit.legalIdentificationNumber

string | null

Depends on the country:

SIREN in France
NIF code in Spain

Required string length: 0

legalUnit.activityCode

string | null

France only: NAF code. Null otherwise.

Required string length: 0

legalUnit.headquartersId

integer<int32>

Identifier of the establishment that belongs to this legal-unit and should be considered headquarters for the whole group.

legalUnit.isArchived

boolean

Is this legal-unit archived and thus should no longer be used?

legalIdentificationNumber

string | null

NIF code for Spanish establishment, Siret code for French establishment. Null otherwise.

activityCode

string | null

In France, NAF code. Null otherwise.

calendarId

integer<int32>

Default holidays calendar for employees in this establishment.

address

object

Show child attributes

address.street

string

address.zipCode

string

address.city

string

timezoneId

string

Identifier of the timezone this establishment belongs to.

Example:

"Europe/Paris"

isArchived

boolean

Documentation

Files

Organization Structure API

Core HR API

Expenses API

Invoices API

Absences API

Office API

Project API

Schedule API

Timesheet API

Mealvouchers API

Compensation API

Training API

The establishment resource