> ## Documentation Index > Fetch the complete documentation index at: https://docs.ecrypt.com/llms.txt > Use this file to discover all available pages before exploring further. # Overview & Navigation The Ecrypt **Dashboard** is the home screen for every login — a single-page snapshot of recent activity for the currently selected location (MID), plus the launchpad for every other feature in the platform. This guide explains how to read the dashboard, where to find each major function, and how the global navigation works so you can move efficiently between modules. **Path:** `/dashboard` (loads automatically on login) *** ## Page Layout The dashboard is divided into three persistent regions that appear on every page in Ecrypt: 1. **Left Sidebar** — global navigation (location switcher, quick actions, app modules). 2. **Top Bar** — date filter and session controls (Logout). 3. **Main Content** — the page-specific content. On the Dashboard, this is KPIs, revenue chart, and a recent transactions table. *** ## Top Bar | Element | Description | | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | | **Ecrypt Logo** (top-left) | Clicking returns you to the Dashboard from anywhere in the app. | | **DATE FILTER → Date Range** | Sets the time window applied to the KPI cards, revenue chart, and transactions table on this page. Default is the last 7 days. | | **Logout** (top-right) | Ends the session and returns to the login screen. | ### Date Range Picker Clicking the **Date Range** field opens a picker with: * **Quick presets:** Last Month, Last 2 Weeks, Last Week, Last 7 Days, Reset Date. * **Two-month calendar** with previous/next month navigation. Click a start date, then an end date to define a custom range. * **Ok** — apply the range, **Cancel** — close without changing, **Clear** — empty the selection. The active range is also reflected in the URL (`transactionDate-range=MM-DD-YYYY~MM-DD-YYYY`), so the view is shareable / bookmarkable. *** ## Left Sidebar The sidebar is grouped into clearly labeled sections from top to bottom. ### Dashboard (link) Direct link back to this overview page from anywhere in the app. ### YOUR MERCHANT ACCOUNTS The **location switcher**. The button label reflects current scope: * `Reporting on [Location Name]` — single location selected; all transactional features are available. * `Reporting on N locations` — multiple selected; consolidated reporting mode (transactional features unavailable until a single location is selected). Click the button to open the **Your Merchant Accounts** panel: search the list, check one or more MIDs, then **APPLY**. See `16_location_management.md` for the full workflow. ### ACTIONS One-click shortcuts for the most common transactional tasks. Each launches a slide-out or full-page entry form scoped to the active location. | Action | What it does | | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | | **POS** | Card-present transaction via a paired terminal. Use this after a terminal has been registered (Settings → Terminal Settings → Device Management). | | **KEY** | Keyed/manual credit-card transaction. The Virtual Terminal entry form for card-not-present sales. | | **ACH** | Manual ACH (eCheck) transaction. | | **Add Customer** | Create a new customer and save a profile in the Customer Vault. | | **Add Subscriptions** | Create a new subscription or installment plan. | > **Single-location only.** Quick actions require a single MID in scope. If multiple locations are selected via the location switcher, narrow to one before running these. ### APPS The full module catalog. Items with `∨` are expandable groups that reveal sub-pages. | Module | Contents | | ------------------- | -------------------------------------------------------------------------------------------------------------------------------- | | **Credit Cards** | Transactions, Refunds, Voids, Captures, Tip Adjust, L2/L3 data. | | **Check** | ACH Transactions, Bulk Refunds, Bulk Voids. | | **Customer Vault** | Stored customer profiles, payment methods, billing addresses. See `05_customer_vault.md`. | | **Subscriptions** | Recurring billing plans and active subscriptions. See `06_subscriptions.md`. | | **Reporting** | Settlements, deposits, statements, processing summaries. See `07_reporting.md`. | | **Hosted Payments** | Hosted payment page configuration. See `10_hosted_payments.md`. | | **Settings** | Expand to see sub-groups: Account Settings, Terminal Settings, Developer Tools, Fraud Prevention (see settings-specific guides). | > Invoices and Manual Payment Entry may surface from the Customer Vault / transaction flows depending on the merchant's enabled features. See `09_invoices.md` and `04_manual_payment_entry.md`. *** ## Main Content (Dashboard Body) ### KPI Cards (Top Row) Four metrics for the selected date range, each with a percentage change vs. the **immediately-preceding** window of equal length. | Card | What it counts | | ------------------------- | ------------------------------------------------------------------ | | **APPROVED TRANSACTIONS** | Count of approved transactions within the date range. | | **REFUNDED TRANSACTIONS** | Count of refunds issued within the date range. | | **NEW CUSTOMERS** | Count of new Customer Vault entries created within the date range. | | **DECLINED TRANSACTIONS** | Count of declined transactions within the date range. | Each card shows: * Big number — the total for the current range. * ↑ / ↓ percentage and color (green/red) — change vs. previous comparable window. * `PREV. 7 DAYS` label (or whatever the comparable prior window is). * `ⓘ` info icon — hover to see the exact prior window (e.g., "Previous 7 days from 05-15-2026 to 05-21-2026"). ### Revenue Breakdown A combined view of the merchant's revenue for the selected range: * **Net volume** — gross minus refunds, voids, and chargebacks. * **Gross volume** — total approved sales before deductions. * **Line chart** — daily volume over the selected date range. Hover a point to see exact daily totals. ### Recent Transactions Table A live list of transactions for the active MID within the selected date range. | Column | Description | | -------------------- | -------------------------------------------------------------- | | **ID** | Ecrypt transaction ID. Click to open the detail slide-out. | | **Transaction Date** | Date + time of the transaction. | | **Amount** | Transaction amount. | | **Type** | Sale, Auth, Credit, Refund. | | **Account Data** | Masked PAN + card brand logo (or ACH routing/account preview). | | **Customer** | Linked customer name if one was attached. | | **Status** | Approved, Settled, Voided, Refunded, Declined, etc. | Above the table: * **Transaction Date pill** — restates the active date range. * **Type tabs:** All / Auth / Sale / Credit / Refund — quick filter by transaction type. * **BATCHES** — jump to the batch view (settlement batches for the range). Below the table: * **▽ FILTERS** — open the advanced filter panel. * **CLEAR FILTERS** — reset filters. * **Rows per page** dropdown + pagination arrows. Clicking any row opens the transaction detail slide-out (covered in `02_manage_transactions.md`). *** ## Global Navigation Patterns A few conventions apply across every page in Ecrypt — knowing these makes the rest of the app feel familiar. ### Page-level URLs Every screen has its own URL with the active MID embedded as `?merchantId=...`. Date ranges and other filters are also in the URL, so any view can be bookmarked or shared with a teammate who has access to the same MID. ### Slide-out detail panels Clicking a row in any list (transactions, customers, subscriptions, invoices, etc.) opens a right-side slide-out with the full record and contextual actions (refund, void, edit, view receipt, etc.). The list behind it stays in place so you can move quickly between records. ### Date filters Most list pages have their own date-range filter that works the same as the Dashboard's — same picker, same quick presets, same URL persistence. ### Filters + Clear Filters Most list pages expose a **▽ FILTERS** button that opens a panel of field-level filters (status, amount, customer, card brand, etc.) and a **CLEAR FILTERS** link to reset. ### Settings sidebar When you enter Settings, the left sidebar swaps to a Settings-specific tree (Account Settings, Terminal Settings, Developer Tools, Fraud Prevention) plus a **Go Back** button that returns to the previous app context. *** ## Tips & Best Practices * **Always check the location button in the top-left before doing anything.** It tells you exactly which MID an action will affect — refunding the wrong location is a frustrating mistake to undo. * **Use the date range presets.** "Last 7 Days" and "Last Month" cover most day-to-day reviews; the calendar handles custom audits. * **The KPI comparison window auto-matches your selected range.** If you pick a 14-day window, the comparison is the prior 14 days — not always exactly 7 days. Hover the `ⓘ` icon to confirm. * **Click the Ecrypt logo to reset.** From deep inside Settings or a slide-out, the logo is a one-click way back to the Dashboard. * **Bookmark frequently-used filtered views.** Because filters and date ranges are URL-encoded, you can bookmark e.g. "this MID's last-30-days declines" and reload it later. * **Use Actions for one-off transactions, the apps for management.** Quick Actions (POS, KEY, ACH, Add Customer) are optimized for speed; the corresponding modules in the APPS section give you the full history, search, and bulk tools. * **Set a default MID.** If you primarily work in one location, configure it under Settings → Account Settings → Location Management so the Dashboard opens there automatically on each login. * **Mind the difference between approved and settled.** The Dashboard counts approvals; cash flow questions belong in Reporting, where settlement batches and deposits are tracked. * **Logout when stepping away from a shared workstation.** The Logout link in the top-right ends the session immediately; reauthenticating uses your SMS-verified login flow.