Організація та конфігурація

Організація, локації, користувачі, інтеграції та підписка — налаштуйте робочий простір.

Організація

Endpoints

GET	/organizations	Отримує колекцію ресурсів Organization.
POST	/organizations	Створює ресурс Organization.
GET	/organizations/{id}	Отримує ресурс Organization.
POST	/organizations/clear	Створює ресурс Organization.
POST	/organizations/icon	Створює ресурс Organization.
POST	/organizations/logo	Створює ресурс Organization.
GET	/organizations/mail-footer	Отримує ресурс Organization.
PATCH	/organizations/mail-footer	Оновлює ресурс Organization.

Поля схеми

Поле	Тип	Опис
id	string
type	string
status	string
name	string
slug	string
stripeCustomerId	stringnull
manualBilling	boolean
databaseStatus	arraynull
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)

Локація

Endpoints

GET	/locations	Отримує колекцію ресурсів Location.
POST	/locations	Створює ресурс Location.
GET	/locations/{id}	Отримує ресурс Location.
PATCH	/locations/{id}	Оновлює ресурс Location.

Поля схеми

Поле	Тип	Опис
name*	string
officeOpenHour	integernull
officeCloseHour	integernull

Країна

Endpoints

GET	/countries	Отримує колекцію ресурсів Country.
GET	/countries/{id}	Отримує ресурс Country.

Поля схеми

Поле	Тип	Опис
id*	string

Мова

Endpoints

GET	/languages	Отримує колекцію ресурсів Language.
POST	/languages	Створює ресурс Language.
GET	/languages/{id}	Отримує ресурс Language.

Поля схеми

Поле	Тип	Опис
id*	string

Інтеграція

Endpoints

POST	/integrations/kontomatik/pull	Створює ресурс Integration.
POST	/integrations/kontomatik/revoke	Створює ресурс Integration.
POST	/integrations/kontomatik/setup	Створює ресурс Integration.

Зустріч

Endpoints

GET	/meetings	Отримує колекцію ресурсів Meeting.
POST	/meetings	Створює ресурс Meeting.
GET	/meetings/{id}	Отримує ресурс Meeting.
PATCH	/meetings/{id}	Оновлює ресурс Meeting.

Поля схеми

Поле	Тип	Опис
employee*	string,null (iri-reference)
dateFrom*	string (date-time)
dateTo*	string (date-time)
notes	stringnull
time	string,null (date-time)

Підписка

Endpoints

GET	/subscriptions	Отримує колекцію ресурсів Subscription.
POST	/subscriptions	Створює ресурс Subscription.
GET	/subscriptions/{id}	Отримує ресурс Subscription.
POST	/subscriptions/{id}/cancel	Створює ресурс Subscription.
GET	/subscriptions/{id}/invoices	Отримує колекцію ресурсів Subscription.
POST	/subscriptions/apply-coupon	Створює ресурс Subscription.
POST	/subscriptions/clear-coupon	Створює ресурс Subscription.

Поля схеми

Поле	Тип	Опис
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

Адреса організації

Endpoints

GET	/organization-addresses	Отримує колекцію ресурсів OrganizationAddress.
POST	/organization-addresses	Створює ресурс OrganizationAddress.
GET	/organization-addresses/{id}	Отримує ресурс OrganizationAddress.
PATCH	/organization-addresses/{id}	Оновлює ресурс OrganizationAddress.
DELETE	/organization-addresses/{id}	Видаляє ресурс OrganizationAddress.

Поля схеми

Поле	Тип	Опис
type*	string
name*	string
street*	string
city*	string
postCode*	string
country*	string
email	string,null (email)
tin	stringnull
tinCountry	stringnull

Конфігурація організації

Endpoints

GET	/configs	Get multiple configuration values
GET	/configs/{id}	Отримує ресурс OrganizationConfig.
PATCH	/configs/{id}	Оновлює ресурс OrganizationConfig.

Поля схеми

Поле	Тип	Опис
type*	string
name*	string

Користувач організації

Endpoints

GET	/organization-users	Отримує колекцію ресурсів OrganizationUser.
DELETE	/organization-users/{id}	Видаляє ресурс OrganizationUser.

Поля схеми

Поле	Тип	Опис
id	string
organization	string (iri-reference)
user	string (iri-reference)
type	string
organizationUserConfigs	array
createdAt	string (date-time)
updatedAt	string (date-time)

Конфігурація користувача організації

Endpoints

GET	/user-configs/{id}	Отримує ресурс OrganizationUserConfig.
PATCH	/user-configs/{id}	Оновлює ресурс OrganizationUserConfig.

Поля схеми

Поле	Тип	Опис
type	string
name	string
value	string

Запрошення користувача організації

Endpoints

GET	/organization-user-invitations	Отримує колекцію ресурсів OrganizationUserInvitation.
POST	/organization-user-invitations/{id}/accept	Створює ресурс OrganizationUserInvitation.
POST	/organization-user-invitations/{id}/reject	Створює ресурс OrganizationUserInvitation.

Поля схеми

Поле	Тип	Опис
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.

Елемент каталогу ключів конфігурації

Endpoints

GET

/config-keys

Поля схеми

Поле	Тип	Опис
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.