Getting Started

Dashboard

The landing screen after sign-in. It answers one question — how is the business doing right now — from live data, with no date pickers to set.

Last updated 2026-10-13

DigitalKey ERP — Docs · digital-key.co/docs/getting-started/dashboard

Overview

The dashboard is read-only and always scoped to your own business. It refreshes each time you open it. Every amount is in your business's main currency.

NoteThe sales figures count POS sales and completed sales orders, and are net of returns — the same rule finance and the reports use, so the three agree. A draft order is not in these numbers.
Dashboard — Full dashboard
Full dashboard
Full dashboard — The KPI row across the top, the money-in/money-out and sales charts side by side, and the latest-invoices and top-debtors panels beneath.

KPI cards

The row across the top summarises the business at a glance. “Today” means the current calendar day; “this month” means the current calendar month to date.

Figures returned by GET /api/v1/dashboard
ParameterTypeRequiredDescription
today_salesdecimalOptionalTotal value of sales completed today.
today_countintegerOptionalNumber of sales completed today.
month_salesdecimalOptionalTotal value of sales this calendar month to date.
month_countintegerOptionalNumber of sales this month to date.
total_debtdecimalOptionalTotal currently owed to you by all customers.
debtor_countintegerOptionalHow many customers currently owe you money.
month_expensesdecimalOptionalTotal expenses recorded this month.
month_expense_countintegerOptionalNumber of expense entries this month.
month_po_countintegerOptionalNumber of purchase orders raised this month.
Notetotal_debt is a live balance across all customers, not a month-to-date figure. It does not reset when the month rolls over.

The two charts

Two charts sit side by side under the KPI row.

Did the business make money?

The last six months as pairs of bars — Money in and Money out — with a line for Profit. Money out is the cost of what you sold plus your expenses, so profit is exactly the gap between the two bars; a line dipping under zero is a losing month. Buying stock is not counted — it is inventory, not a loss. The figures are the same ones the Finance screen charts, and the chart is shown to users who have finance.view.

Sales Revenue

Daily sales totals over the last 14 days, so you can see the shape of the fortnight rather than just a single number.

ParameterTypeRequiredDescription
trend[].datestringOptionalThe day being plotted.
trend[].amountdecimalOptionalTotal sales value for that day.

Recent invoices

The latest sales, newest first. Selecting one opens it, from where it can be reprinted if you subscribe to invoice printing.

ParameterTypeRequiredDescription
recent_invoices[].sale_idintegerOptionalInternal sale identifier.
recent_invoices[].invoice_nostringOptionalThe invoice number shown to customers.
recent_invoices[].customer_namestringOptionalCustomer on the sale, or the walk-in customer.
recent_invoices[].totaldecimalOptionalInvoice total.
recent_invoices[].sale_datetimestampOptionalWhen the sale was completed.

Top debtors

The customers who owe you the most, largest balance first — the shortlist to chase first. Selecting a customer opens their record.

ParameterTypeRequiredDescription
top_debtors[].customer_idintegerOptionalCustomer identifier.
top_debtors[].namestringOptionalCustomer name.
top_debtors[].balancedecimalOptionalAmount currently owed.
TipFor collections work, Customers has a debt schedule ordered by expected payment date, which is usually more actionable than the top- debtors list on its own.

Related