Organização & configuração

Organização, localizações, utilizadores, integrações e subscrição — configure o espaço de trabalho.

Organização

Endpoints

GET	/organizations	Recupera a coleção de recursos Organization.
POST	/organizations	Cria um recurso Organization.
GET	/organizations/{id}	Recupera um recurso Organization.
POST	/organizations/clear	Cria um recurso Organization.
POST	/organizations/icon	Cria um recurso Organization.
POST	/organizations/logo	Cria um recurso Organization.
GET	/organizations/mail-footer	Recupera um recurso Organization.
PATCH	/organizations/mail-footer	Atualiza o recurso Organization.

Campos de schema

Campo	Tipo	Descrição
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

Localização

Endpoints

GET	/locations	Recupera a coleção de recursos Location.
POST	/locations	Cria um recurso Location.
GET	/locations/{id}	Recupera um recurso Location.
PATCH	/locations/{id}	Atualiza o recurso Location.

Campos de schema

Campo	Tipo	Descrição
name*	string
officeOpenHour	integernull
officeCloseHour	integernull

País

Endpoints

GET	/countries	Recupera a coleção de recursos Country.
GET	/countries/{id}	Recupera um recurso Country.

Campos de schema

Campo	Tipo	Descrição
id*	string

Idioma

Endpoints

GET	/languages	Recupera a coleção de recursos Language.
POST	/languages	Cria um recurso Language.
GET	/languages/{id}	Recupera um recurso Language.

Campos de schema

Campo	Tipo	Descrição
id*	string

Integração

Endpoints

POST	/integrations/kontomatik/pull	Cria um recurso Integration.
POST	/integrations/kontomatik/revoke	Cria um recurso Integration.
POST	/integrations/kontomatik/setup	Cria um recurso Integration.

Reunião

Endpoints

GET	/meetings	Recupera a coleção de recursos Meeting.
POST	/meetings	Cria um recurso Meeting.
GET	/meetings/{id}	Recupera um recurso Meeting.
PATCH	/meetings/{id}	Atualiza o recurso Meeting.

Campos de schema

Campo	Tipo	Descrição
employee*	string,null (iri-reference)
dateFrom*	string (date-time)
dateTo*	string (date-time)
notes	stringnull
time	string,null (date-time)

Assinatura

Endpoints

GET	/subscriptions	Recupera a coleção de recursos Subscription.
POST	/subscriptions	Cria um recurso Subscription.
GET	/subscriptions/{id}	Recupera um recurso Subscription.
POST	/subscriptions/{id}/cancel	Cria um recurso Subscription.
GET	/subscriptions/{id}/invoices	Recupera a coleção de recursos Subscription.
POST	/subscriptions/apply-coupon	Cria um recurso Subscription.
POST	/subscriptions/clear-coupon	Cria um recurso Subscription.

Campos de schema

Campo	Tipo	Descrição
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

Morada da Organização

Endpoints

GET	/organization-addresses	Recupera a coleção de recursos OrganizationAddress.
POST	/organization-addresses	Cria um recurso OrganizationAddress.
GET	/organization-addresses/{id}	Recupera um recurso OrganizationAddress.
PATCH	/organization-addresses/{id}	Atualiza o recurso OrganizationAddress.
DELETE	/organization-addresses/{id}	Remove o recurso OrganizationAddress.

Campos de schema

Campo	Tipo	Descrição
type*	string
name*	string
street*	string
city*	string
postCode*	string
country*	string
email	string,null (email)
tin	stringnull
tinCountry	stringnull

Configuração da Organização

Endpoints

GET	/configs	Get multiple configuration values
GET	/configs/{id}	Recupera um recurso OrganizationConfig.
PATCH	/configs/{id}	Atualiza o recurso OrganizationConfig.

Campos de schema

Campo	Tipo	Descrição
type*	string
name*	string

Utilizador da Organização

Endpoints

GET	/organization-users	Recupera a coleção de recursos OrganizationUser.
DELETE	/organization-users/{id}	Remove o recurso OrganizationUser.

Campos de schema

Campo	Tipo	Descrição
id	string
organization	string (iri-reference)
user	string (iri-reference)
type	string
organizationUserConfigs	array
createdAt	string (date-time)
updatedAt	string (date-time)

Configuração de Utilizador da Organização

Endpoints

GET	/user-configs/{id}	Recupera um recurso OrganizationUserConfig.
PATCH	/user-configs/{id}	Atualiza o recurso OrganizationUserConfig.

Campos de schema

Campo	Tipo	Descrição
type	string
name	string
value	string

Convite de Utilizador da Organização

Endpoints

GET	/organization-user-invitations	Recupera a coleção de recursos OrganizationUserInvitation.
POST	/organization-user-invitations/{id}/accept	Cria um recurso OrganizationUserInvitation.
POST	/organization-user-invitations/{id}/reject	Cria um recurso OrganizationUserInvitation.

Campos de schema

Campo	Tipo	Descrição
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.

Item do Catálogo de Chaves de Configuração

Endpoints

GET

/config-keys

Campos de schema

Campo	Tipo	Descrição
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.