Organizzazione e configurazione

Organizzazione, sedi, utenti, integrazioni e abbonamento — configura lo spazio di lavoro.

Organizzazione

Endpoint

GET	/organizations	Recupera la raccolta di risorse Organization.
POST	/organizations	Crea una risorsa Organization.
GET	/organizations/{id}	Recupera una risorsa Organization.
POST	/organizations/clear	Crea una risorsa Organization.
POST	/organizations/icon	Crea una risorsa Organization.
POST	/organizations/logo	Crea una risorsa Organization.
GET	/organizations/mail-footer	Recupera una risorsa Organization.
PATCH	/organizations/mail-footer	Aggiorna la risorsa Organization.

Campi schema

Campo	Tipo	Descrizione
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)
organizationUsers	array
organizationUserInvitations	array
organizationModules	array
subscriptions	array
organizationConfigs	array
organizationAddresses	array
createdAt	string (date-time)
updatedAt	string (date-time)
demo	boolean
productionLike	boolean
currentSubscription	string,null (iri-reference)
establishedPayment	boolean
trusted	boolean

Ubicazione

Endpoint

GET	/locations	Recupera la raccolta di risorse Location.
POST	/locations	Crea una risorsa Location.
GET	/locations/{id}	Recupera una risorsa Location.
PATCH	/locations/{id}	Aggiorna la risorsa Location.

Campi schema

Campo	Tipo	Descrizione
name*	string
officeOpenHour	integernull
officeCloseHour	integernull

Paese

Endpoint

GET	/countries	Recupera la raccolta di risorse Country.
GET	/countries/{id}	Recupera una risorsa Country.

Campi schema

Campo	Tipo	Descrizione
id*	string

Lingua

Endpoint

GET	/languages	Recupera la raccolta di risorse Language.
POST	/languages	Crea una risorsa Language.
GET	/languages/{id}	Recupera una risorsa Language.

Campi schema

Campo	Tipo	Descrizione
id*	string

Integrazione

Endpoint

POST	/integrations/kontomatik/pull	Crea una risorsa Integration.
POST	/integrations/kontomatik/revoke	Crea una risorsa Integration.
POST	/integrations/kontomatik/setup	Crea una risorsa Integration.

Riunione

Endpoint

GET	/meetings	Recupera la raccolta di risorse Meeting.
POST	/meetings	Crea una risorsa Meeting.
GET	/meetings/{id}	Recupera una risorsa Meeting.
PATCH	/meetings/{id}	Aggiorna la risorsa Meeting.

Campi schema

Campo	Tipo	Descrizione
employee*	string,null (iri-reference)
dateFrom*	string (date-time)
dateTo*	string (date-time)
notes	stringnull
time	string,null (date-time)

Abbonamento

Endpoint

GET	/subscriptions	Recupera la raccolta di risorse Subscription.
POST	/subscriptions	Crea una risorsa Subscription.
GET	/subscriptions/{id}	Recupera una risorsa Subscription.
POST	/subscriptions/{id}/cancel	Crea una risorsa Subscription.
GET	/subscriptions/{id}/invoices	Recupera la raccolta di risorse Subscription.
POST	/subscriptions/apply-coupon	Crea una risorsa Subscription.
POST	/subscriptions/clear-coupon	Crea una risorsa Subscription.

Campi schema

Campo	Tipo	Descrizione
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

Indirizzo organizzazione

Endpoint

GET	/organization-addresses	Recupera la raccolta di risorse OrganizationAddress.
POST	/organization-addresses	Crea una risorsa OrganizationAddress.
GET	/organization-addresses/{id}	Recupera una risorsa OrganizationAddress.
PATCH	/organization-addresses/{id}	Aggiorna la risorsa OrganizationAddress.
DELETE	/organization-addresses/{id}	Rimuove la risorsa OrganizationAddress.

Campi schema

Campo	Tipo	Descrizione
type*	string
name*	string
street*	string
city*	string
postCode*	string
country*	string
email	string,null (email)
tin	stringnull
tinCountry	stringnull

Configurazione organizzazione

Endpoint

GET	/configs	Get multiple configuration values
GET	/configs/{id}	Recupera una risorsa OrganizationConfig.
PATCH	/configs/{id}	Aggiorna la risorsa OrganizationConfig.

Campi schema

Campo	Tipo	Descrizione
type*	string
name*	string

Utente organizzazione

Endpoint

GET	/organization-users	Recupera la raccolta di risorse OrganizationUser.
DELETE	/organization-users/{id}	Rimuove la risorsa OrganizationUser.

Campi schema

Campo	Tipo	Descrizione
id	string
organization	string (iri-reference)
user	string (iri-reference)
type	string
organizationUserConfigs	array
createdAt	string (date-time)
updatedAt	string (date-time)

Configurazione utente organizzazione

Endpoint

GET	/user-configs/{id}	Recupera una risorsa OrganizationUserConfig.
PATCH	/user-configs/{id}	Aggiorna la risorsa OrganizationUserConfig.

Campi schema

Campo	Tipo	Descrizione
type	string
name	string
value	string

Invito utente organizzazione

Endpoint

GET	/organization-user-invitations	Recupera la raccolta di risorse OrganizationUserInvitation.
POST	/organization-user-invitations/{id}/accept	Crea una risorsa OrganizationUserInvitation.
POST	/organization-user-invitations/{id}/reject	Crea una risorsa OrganizationUserInvitation.

Campi schema

Campo	Tipo	Descrizione
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.

Voce catalogo chiavi di configurazione

Endpoint

GET

/config-keys

Campi schema

Campo	Tipo	Descrizione
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.