Tiime
SDK TypeScript

Entreprise

Détails de l'entreprise, configuration et dashboard

Accès via client.company.

get

Récupérer les détails de l'entreprise active.

company.ts
const company = await client.company.get();
// { id: 50824, name: "Mon Entreprise", legal_form: "SAS", siret: "...", ... }

Retour : Promise<Company>

users

Récupérer les utilisateurs de l'entreprise.

company.ts
const users = await client.company.users();

Retour : Promise<unknown>

appConfig

Récupérer la configuration de l'application pour l'entreprise.

company.ts
const config = await client.company.appConfig();

Retour : Promise<unknown>

accountingPeriod

Récupérer la période comptable en cours.

company.ts
const period = await client.company.accountingPeriod();
// { id: 1, start_date: "2026-01-01", end_date: "2026-12-31", status: "open" }

// Avec une plage de N années
const multiYear = await client.company.accountingPeriod(3);
ParamètreTypeDéfautDescription
rangeYearnumber1Nombre d'années de la plage

Retour : Promise<AccountingPeriod>

tiles

Récupérer les tuiles du dashboard.

company.ts
const tiles = await client.company.tiles(["revenue", "expenses", "balance"]);
ParamètreTypeDescription
keysstring[]Clés des tuiles à récupérer

Retour : Promise<unknown>

dashboardBlocks

Récupérer les blocs du dashboard.

company.ts
const blocks = await client.company.dashboardBlocks();

// Avec un groupe d'affichage spécifique
const custom = await client.company.dashboardBlocks("analytics");
ParamètreTypeDéfautDescription
displayGroupstring"monitoring"Groupe d'affichage

Retour : Promise<unknown>

Type Company

ChampTypeDescription
idnumberIdentifiant unique
namestringNom de l'entreprise
legal_formstringForme juridique
siretstringSIRET
vat_numberstringNuméro de TVA
intracom_vat_numberstringTVA intracommunautaire
ape_codeApeCodeCode APE
streetstringRue
address_complementstring | nullComplément d'adresse
postal_codestringCode postal
citystringVille
countrystringPays
share_capitalnumberCapital social
registration_datestringDate d'immatriculation
activity_start_datestringDate de début d'activité
vat_systemVatSystemRégime de TVA
tax_regimestringRégime fiscal
receipt_emailstringEmail de réception
payment_emailstringEmail de paiement
has_invoicesbooleanA des factures
logo{ id: number }Logo
uuidstringUUID
slugstringSlug

Type AccountingPeriod

ChampTypeDescription
idnumberIdentifiant unique
start_datestringDate de début
end_datestringDate de fin
statusstringStatut

On this page