Admin Guide

Managing Tenants

A tenant is one business. Creating it is the first step in onboarding a customer.

Last updated 2026-10-13

DigitalKey ERP — Docs · digital-key.co/docs/admin/tenants

Overview

Every piece of data in the system belongs to a tenant, and nothing crosses between them. A tenant on its own cannot do anything — it needs at least one user before anyone can sign in.

Admin — Tenants list
Tenants list
Tenants list — Businesses with their reseller, user count, total balance and monthly cost.
  1. 1

    Open Tenants

    Go to Tenants in the admin console.

  2. 2

    Create the business

    Enter the business name and owner details. Only the business name is required, but contact details make support far easier later.

    Admin — Create tenant form
    Create tenant form
    Create tenant form — Business name, owner, contact details, city and reseller assignment.
  3. 3

    Assign a reseller (optional)

    If a partner brought this customer in, set the reseller so it appears in their portal and they can manage it.

  4. 4

    Create the owner user

    Go to Users and create at least one user with the owner role for this tenant. Until then nobody can sign in.

Tenant fields

POST /api/v1/admin/tenants
ParameterTypeRequiredDescription
business_namestringRequiredThe business's trading name.
owner_namestringOptionalName of the owner.
emailstringOptionalBusiness contact email.
phonestringOptionalBusiness contact phone.
citystringOptionalCity.
countrystringOptionalCountry.
reseller_idintegerOptionalReseller who owns this relationship. Leave empty for a direct customer.
subscription_planstring= standardOptionalPlan label.
notesstringOptionalInternal notes. Not visible to the business.

What the list shows

ParameterTypeRequiredDescription
tenant_idintegerOptionalIdentifier.
reseller_namestringOptionalReseller, when assigned.
user_countintegerOptionalHow many users belong to this business.
total_balancedecimalOptionalCombined balance of all its users, in IQD.
total_monthly_costdecimalOptionalCombined monthly cost of all its users.
is_activebooleanOptionalWhether the business is enabled.
created_attimestampOptionalWhen it was created.
TipComparing total_balance against total_monthly_cost is the quickest way to spot a business heading for suspension — less than one month of cover means trouble within weeks.

Disabling a tenant

PUT /api/v1/admin/tenants/{id}/toggle
ParameterTypeRequiredDescription
idintegerRequiredThe tenant to enable or disable. Taken from the URL.
ImportantDisabling a tenant blocks sign-in for every user in that business immediately — the login check requires both the user and the tenant to be active. This is the fastest way to cut off a business, and it affects everyone at once.
NoteDisabling does not delete anything and does not stop billing. Users keep their balances and subscriptions, and deductions continue to run. Re-enabling restores access exactly as it was.

A tenant's main currency

Each business chooses its main currency once, at the owner's first sign-in, and it is locked from then on. From the tenant list an administrator can see which currency a business chose and when — and, if it was chosen by mistake, clear it so the owner is asked again.

/api/v1/admin/tenants/{id}/currency
ParameterTypeRequiredDescription
GETendpointOptionalThe tenant's main currency, when it was set, and whether it can still be cleared.
POST /resetendpointOptionalClear the main currency. Refused once the business has any transaction.
ImportantThe reset works only while the business has zero transactions. Once there is a sale, purchase, payment or expense, the currency is permanent — every figure in the books is recorded in it, and nobody can change it.

Demo tenancies

WarningDemo tenants carry a trial expiry date and are never billed. Once the date passes, the next sign-in attempt disables the account automatically. Converting a demo to a paying customer means clearing the demo flag and creating real subscriptions — an expired demo cannot simply be topped up.

Related