Admin Guide

Admin Guide

The platform console used by DigitalKey staff to run every business on the system.

Last updated 2026-10-13

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

ImportantThis section is for platform administrators only. Admin accounts are not scoped to a business — they can see and change every tenant, every user and every balance on the platform.

Overview

Admin accounts live in a separate table from ERP users and sign in through the same login page. There is no tenant attached, so nothing in the console is filtered by business.

Admin — Admin dashboard
Admin dashboard
Admin dashboard — Platform KPIs with the revenue trend, lifecycle breakdown and recent activity.

Dashboard KPIs

GET /api/v1/admin/dashboard
ParameterTypeRequiredDescription
total_tenantsintegerOptionalBusinesses on the platform.
active_tenantsintegerOptionalBusinesses currently enabled.
total_usersintegerOptionalERP users across all businesses.
active_usersintegerOptionalUsers currently enabled.
suspended_usersintegerOptionalUsers in temp_suspend or suspend.
total_resellersintegerOptionalReseller partners.
total_platform_revenuedecimalOptionalAll revenue collected to date, in IQD.
this_month_revenuedecimalOptionalRevenue collected this month.
deductions_this_monthintegerOptionalNumber of deductions run this month.
pending_issuesintegerOptionalSuspended users plus failed deductions this month — the number to act on.
Warningpending_issues is the health figure. A rising number means customers are hitting balance problems and will start losing access within ten days.

Activity feed

GET /api/v1/admin/dashboard/activity
ParameterTypeRequiredDescription
revenue_trend[]arrayOptionalRevenue per month for the trend chart.
lifecycle[]arrayOptionalHow many users sit in each lifecycle state.
recent_deductions[]arrayOptionalLatest deductions with user, amount and status.
recent_tenants[]arrayOptionalMost recently created businesses.

What the console controls

AreaWhat it does
TenantsCreate businesses, assign them to resellers, enable and disable them.
UsersCreate users, set features, reset passwords, top up balances.
ResellersCreate partners, set commission, credit their balance.
BillingRun daily billing, read the deduction and top-up logs.
FeaturesEdit the feature catalogue and its prices.
SettingsGrace periods, warning threshold and platform values.
TranslationsOverride any interface string in any of the three languages.
Demo requestsRequests submitted from the public site.
NotificationsBroadcast a message to a tenant or a role.
Portal AccountsEvery customer portal login each business has created, grouped by business: customer, login phone, on/off, last login and created date. View only — passwords are never shown.
Online NowWho is signed in at this moment, refreshed automatically.
Activity & KPIsWho is actually using the platform: per business and per user, how many sales, purchases, expenses, payments and other records they created today and over a chosen period, and when they were last active.
Balance TopupsThe log of every top-up, exportable.

Editing the feature catalogue

POST/PUT /api/v1/admin/features
ParameterTypeRequiredDescription
module_idintegerRequiredModule the feature belongs to.
feature_keystringRequiredThe key checked in code, such as pos.invoice_print.
feature_namestringRequiredDisplay name.
descriptionstringOptionalWhat the feature does.
monthly_price_iqddecimalRequiredMonthly price in IQD.
sort_orderintegerOptionalPosition within its module.
is_activeboolean= trueOptionalWhether it can be subscribed to.
Importantfeature_key is what the application checks in code. Changing the key of an existing feature silently breaks every gate that references it — existing subscribers lose access to a capability they are still paying for. Change prices and names freely; treat keys as permanent.

Admin versus reseller

NoteResellers do much of the same work but only for their own tenants, and they fund top-ups from their own balance rather than creating credit. See the Reseller Guide.

In this section