Organisatie & configuratie

Organisatie, locaties, gebruikers, integraties en abonnement — configureer de werkruimte.

Deze referentie wordt gegenereerd op basis van het API-schema. Veldbeschrijvingen en tekst die nog niet is vertaald, worden in het Engels weergegeven.

Organisatie

Endpoints

Organisatie: Endpoints
Methode	Pad	Beschrijving
GET	/organizations	Haalt de verzameling Organization-resources op.
POST	/organizations	Maakt een Organization-resource aan.
GET	/organizations/{id}	Haalt een Organization-resource op.
POST	/organizations/clear	Maakt een Organization-resource aan.
POST	/organizations/icon	Maakt een Organization-resource aan.
POST	/organizations/logo	Maakt een Organization-resource aan.
GET	/organizations/mail-footer	Haalt een Organization-resource op.
PATCH	/organizations/mail-footer	Werkt de Organization-resource bij.

Schema-velden

Organisatie: Schema-velden
Veld	Type	Beschrijving
id	string
type	string
status	string
name	string
slug	string
stripeCustomerId	stringnull
manualBilling	boolean
databaseStatus	arraynull
verified	boolean
verifiedAt	string,null (date-time)
verifiedBy	stringnull
verificationRequestedAt	string,null (date-time)
graceStartedAt	string,null (date-time)
obsoletedAt	string,null (date-time)
purgedAt	string,null (date-time)	When the tenant schema was destroyed. NULL until the purge, set once, never cleared.
organizationUsers	array
organizationUserInvitations	array
organizationModules	array
subscriptions	array
organizationConfigs	array
organizationAddresses	array
createdAt	string (date-time)
updatedAt	string (date-time)
demo	boolean
productionLike	boolean
excludedFromSchemaCommands	boolean	Whether a schema-touching command will REFUSE this organization.
currentSubscription	string,null (iri-reference)
establishedPayment	boolean
trusted	boolean

Locatie

Endpoints

Locatie: Endpoints
Methode	Pad	Beschrijving
GET	/locations	Haalt de verzameling Location-resources op.
POST	/locations	Maakt een Location-resource aan.
GET	/locations/{id}	Haalt een Location-resource op.
PATCH	/locations/{id}	Werkt de Location-resource bij.

Schema-velden

Locatie: Schema-velden
Veld	Type	Beschrijving
name*	string
officeOpenHour	integernull
officeCloseHour	integernull

Land

Endpoints

Land: Endpoints
Methode	Pad	Beschrijving
GET	/countries	Haalt de verzameling Country-resources op.
GET	/countries/{id}	Haalt een Country-resource op.

Schema-velden

Land: Schema-velden
Veld	Type	Beschrijving
id*	string

Taal

Endpoints

Taal: Endpoints
Methode	Pad	Beschrijving
GET	/languages	Haalt de verzameling Language-resources op.
POST	/languages	Maakt een Language-resource aan.
GET	/languages/{id}	Haalt een Language-resource op.

Schema-velden

Taal: Schema-velden
Veld	Type	Beschrijving
id*	string

Integratie

Endpoints

Integratie: Endpoints
Methode	Pad	Beschrijving
POST	/integrations/kontomatik/pull	Maakt een Integration-resource aan.
POST	/integrations/kontomatik/revoke	Maakt een Integration-resource aan.
POST	/integrations/kontomatik/setup	Maakt een Integration-resource aan.

Vergadering

Endpoints

Vergadering: Endpoints
Methode	Pad	Beschrijving
GET	/meetings	Haalt de verzameling Meeting-resources op.
POST	/meetings	Maakt een Meeting-resource aan.
GET	/meetings/{id}	Haalt een Meeting-resource op.
PATCH	/meetings/{id}	Werkt de Meeting-resource bij.

Schema-velden

Vergadering: Schema-velden
Veld	Type	Beschrijving
employee*	string,null (iri-reference)
dateFrom*	string (date-time)
dateTo*	string (date-time)
notes	stringnull
time	string,null (date-time)

Abonnement

Endpoints

Abonnement: Endpoints
Methode	Pad	Beschrijving
GET	/subscriptions	Haalt de verzameling Subscription-resources op.
POST	/subscriptions	Maakt een Subscription-resource aan.
GET	/subscriptions/{id}	Haalt een Subscription-resource op.
POST	/subscriptions/{id}/cancel	Maakt een Subscription-resource aan.
GET	/subscriptions/{id}/invoices	Haalt de verzameling Subscription-resources op.
POST	/subscriptions/apply-coupon	Maakt een Subscription-resource aan.
POST	/subscriptions/clear-coupon	Maakt een Subscription-resource aan.

Schema-velden

Abonnement: Schema-velden
Veld	Type	Beschrijving
id	string
organization	string (iri-reference)
organizationAddress	string (iri-reference)
type	string
paymentMethod	string,null (iri-reference)
products	array
seats	integer
modules	array
status	string
externalId	stringnull
metadata	array
createdAt	string (date-time)
updatedAt	string (date-time)
active	boolean
awaiting	boolean

Adres organisatie

Endpoints

Adres organisatie: Endpoints
Methode	Pad	Beschrijving
GET	/organization-addresses	Haalt de verzameling OrganizationAddress-resources op.
POST	/organization-addresses	Maakt een OrganizationAddress-resource aan.
GET	/organization-addresses/{id}	Haalt een OrganizationAddress-resource op.
PATCH	/organization-addresses/{id}	Werkt de OrganizationAddress-resource bij.
DELETE	/organization-addresses/{id}	Verwijdert de OrganizationAddress-resource.

Schema-velden

Adres organisatie: Schema-velden
Veld	Type	Beschrijving
type*	string
name*	string
street*	string
city*	string
postCode*	string
country*	string
email	string,null (email)
tin	stringnull
tinCountry	stringnull

Organisatieconfiguratie

Endpoints

Organisatieconfiguratie: Endpoints
Methode	Pad	Beschrijving
GET	/configs	Get multiple configuration values
GET	/configs/{id}	Haalt een OrganizationConfig-resource op.
PATCH	/configs/{id}	Werkt de OrganizationConfig-resource bij.

Schema-velden

Organisatieconfiguratie: Schema-velden
Veld	Type	Beschrijving
type*	string
name*	string

Organisatiegebruiker

Endpoints

Organisatiegebruiker: Endpoints
Methode	Pad	Beschrijving
GET	/organization-users	Haalt de verzameling OrganizationUser-resources op.
DELETE	/organization-users/{id}	Verwijdert de OrganizationUser-resource.

Schema-velden

Organisatiegebruiker: Schema-velden
Veld	Type	Beschrijving
id	string
organization	string (iri-reference)
user	string (iri-reference)
type	string
organizationUserConfigs	array
createdAt	string (date-time)
updatedAt	string (date-time)

Configuratie organisatiegebruiker

Endpoints

Configuratie organisatiegebruiker: Endpoints
Methode	Pad	Beschrijving
GET	/user-configs/{id}	Haalt een OrganizationUserConfig-resource op.
PATCH	/user-configs/{id}	Werkt de OrganizationUserConfig-resource bij.

Schema-velden

Configuratie organisatiegebruiker: Schema-velden
Veld	Type	Beschrijving
type	string
name	string
value	string

Uitnodiging organisatiegebruiker

Endpoints

Uitnodiging organisatiegebruiker: Endpoints
Methode	Pad	Beschrijving
GET	/organization-user-invitations	Haalt de verzameling OrganizationUserInvitation-resources op.
POST	/organization-user-invitations/{id}/accept	Maakt een OrganizationUserInvitation-resource aan.
POST	/organization-user-invitations/{id}/reject	Maakt een OrganizationUserInvitation-resource aan.
POST	/organization-user-invitations/{id}/retry	Maakt een OrganizationUserInvitation-resource aan.

Schema-velden

Uitnodiging organisatiegebruiker: Schema-velden
Veld	Type	Beschrijving
id	string
organization	string (iri-reference)
employeeId	string
user	string,null (iri-reference)
email	string
firstname	string
lastname	string
status	string
phone	stringnull
createdAt	string (date-time)
updatedAt	string (date-time)
deletedAt	string,null (date-time)
fullname	string
deleted	boolean	Check if the entity has been soft deleted.

Catalogusitem configuratiesleutel

Endpoints

Catalogusitem configuratiesleutel: Endpoints
Methode	Pad	Beschrijving
GET	/config-keys	Haalt de verzameling ConfigKeyCatalogItem-resources op.

Schema-velden

Catalogusitem configuratiesleutel: Schema-velden
Veld	Type	Beschrijving
name	string	The config key slug — the id used at /configs/{name}.
type	string	Value type: boolean\|string\|option\|datetime\|number\|integer\|array.
group	string	Grouping derived from the key namespace, e.g. "Organization", "Invoice".
label	string	Human-readable label (falls back to a humanized slug when undocumented).
description	string	What the setting controls and the impact of changing it ('' if undocumented).
defaultValue	string	The default value applied when the org hasn't set one.
allowedValues	array	Allowed values for `option`-type settings (parsed from the key's Choice constraint); empty for free-form types.
writable	boolean	Whether the current caller is permitted to change this setting.