Skip to main content

organizations — module reference

Rendered from the module's own manifest, and from nothing written by hand. What the module does is its own page.

Module idorganizations
NameOrganizations
Version1.1.0
Ships from@endora-commerce/mod-organizations
LicenceMIT

Activation​

This module cannot be switched off. The single unit of tenancy — every organization-scoped entity, membership and transacting customer resolves through it; switched off, the platform has no tenant.

Dependencies​

ModuleBindingWhat it means
_i18nyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
admin_rolesyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
admin_usersyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
custom_fieldsyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
dictionariesyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
emailyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
settingsyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
transactional_emailsyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
addressesgating onlyresolves addressServicePort; withheld from dependencies because the install order cannot carry the edge
customer_accountsgating onlyresolves customerAccountMemberCommandPort; withheld from dependencies because the install order cannot carry the edge
customer_accountsgating onlyresolves customerAccountMemberWritePort; withheld from dependencies because the install order cannot carry the edge
customer_accountsgating onlyresolves customerAccountReadPort; withheld from dependencies because the install order cannot carry the edge
customer_accountsgating onlyresolves customerAccountRoleCommandPort; withheld from dependencies because the install order cannot carry the edge
customer_accountsgating onlyresolves customerAuthPort; withheld from dependencies because the install order cannot carry the edge
customer_accountsgating onlyresolves customerRolePort; withheld from dependencies because the install order cannot carry the edge
customer_accountsgating onlyresolves passwordResetService; withheld from dependencies because the install order cannot carry the edge
price_listsgating onlyresolves priceListReadPort; withheld from dependencies because the install order cannot carry the edge
admin_notificationsnorefuses-without adminNotificationRecordPort — nobody is told a new organisation has registered: the bell entry refuses, and that refusal stops the new-registration e-mails too — the registration itself still completes
admin_searchnocontributes-to adminSearchProviderRegistry
credentialsnocontributes-to configurationTypeRegistry
credentialsnodegrades-without credentialsService — the registration company lookup cannot use GUS; Polish lookups use the Ministry of Finance VAT White List alone
credit_limitsnorefuses-without creditLimitReadPort — the ancestor-chain lookup for who holds a credit limit refuses — no screen reaches it, because its only caller is that module's own service

Permissions​

CodeLabelAlso needs
customers:manageManage customer organizations—
customers:readView customers—
organizations:assign-sales-repAssign sales representatives to organizations—
organizations:change-tax-idChange a company organization's tax IDcustomers:read
organizations:convert-to-companyConvert personal organizations to companiescustomers:read
organizations:manage-rolesManage organization rolesorganizations:read-roles
organizations:manage-tax-id-scopeManage the tax-ID scopecustomers:read
organizations:read-rolesView organization roles—

Command palette​

ActionOpensPermission
change-organization-tax-id/organizations/change-tax-idorganizations:change-tax-id
convert-personal-organization/organizations/convert-to-companyorganizations:convert-to-company
new-organization/organizations/newcustomers:manage
open-organizations/organizationscustomers:read
open-registration-registry-lookup-settings/settingssettings:read
open-tax-id-scope/organizations/tax-id-scopeorganizations:manage-tax-id-scope

Settings​

CodeNameType
organizations.hierarchy.credit_inheritance_modeCredit inheritance mode (organization hierarchy)string
organizations.moderation.modeModeration mode for new Organizationsstring
organizations.notifications.new_registration_recipientsNew Organization registration — email recipientsjson
organizations.registration.gus_credentialsRegistration — GUS REGON credentialscredential_ref
organizations.registration.registry_lookup_enabledRegistration — company registry lookupboolean
organizations.registration.registry_lookup_pl_sourcesRegistration — registries for Polish NIPsstring

Translations​

Bundles at i18n inside the module, one file per shipped language.

Operator commands​

None.