NMXpert User Manual

1. System Overview

NMXpert is a multi-tenant SaaS MLM & Network Business Management Platform. It enables companies to run binary, unilevel, matrix, generation, board, breakaway, matching, rank, leadership, pool, and hybrid compensation plans — all from a single installation.

Key Capabilities

2. Architecture & Tech Stack

┌─────────────────────────────────────────────────────────┐
│                    CLIENT BROWSERS                       │
│         Admin Portal │ Member Portal │ Customer Portal   │
│              Bootstrap 5 + Chart.js + Vanilla JS         │
└────────────────────────┬────────────────────────────────┘
                         │  HTTP/HTTPS (JSON API)
┌────────────────────────▼────────────────────────────────┐
│                   PHP 8.3+ BACKEND                       │
│  Controllers (13) │ Services (8) │ Middleware (3)        │
│  Helpers (5) │ Models (1) │ Config (3)                   │
└────────────────────────┬────────────────────────────────┘
                         │  PDO (MySQL)
┌────────────────────────▼────────────────────────────────┐
│                    MySQL 8+ DATABASE                     │
│              75 tables │ nmxpert database                │
└─────────────────────────────────────────────────────────┘

File Structure

NMXpert/
├── backend/
│   ├── config/          # database.php, app.php, constants.php
│   ├── app/
│   │   ├── Controllers/ # Auth, Dashboard, Member, Product, Order,
│   │   │                # Wallet, Withdrawal, Genealogy, Kyc,
│   │   │                # Report, Notification, Support, Search
│   │   ├── Services/    # Commission, Wallet, PlanEngine, Rank,
│   │   │                # Audit, Notification, Fraud, Currency
│   │   ├── Middleware/   # Auth, Role, RateLimiter
│   │   ├── Helpers/     # Response, Validator, JwtHelper, Logger, FileUploader
│   │   └── Models/      # Database (PDO singleton)
│   └── public/          # index.php (API entry point)
├── web/
│   ├── admin/           # 16 admin pages
│   ├── member/          # 14 member pages
│   ├── customer/        # 1 customer page
│   ├── includes/        # header, footer, topbar, sidebars
│   └── assets/          # css/, js/, img/
├── database/
│   └── schema.sql       # 75 tables + seed data
└── docs/
    └── MANUAL.md        # This manual

3. User Roles & Portals

Three Portals

11 Role Types

Default Login Credentials

4. System Flows

4.1 Registration Flow

4.2 Activation Flow

4.3 Order & Commission Flow

4.4 Withdrawal Flow

5. Admin Portal Guide

5.1 Dashboard

Overview of all key metrics at a glance.

Also includes: Sales Trend chart, Commission Distribution chart, Recent Members, Recent Orders.

5.2 Members Management

• List all members with search, status filter, pagination
• View member details (profile, bank accounts, wallets, rank)
• Create new member (admin-initiated)
• Edit member details
• Deactivate member (soft delete)

5.3 Products

• Product catalog with BV/PV/CV values
• Categories, variants, pricing
• Inventory management
• Product images & descriptions

5.4 Orders

• View all orders with status tracking
• Update status: pending → confirmed → processing → shipped → delivered
• View order items, payments, returns

5.5 Plans

• Configure compensation plan parameters
• Set binary pair bonus, unilevel levels, matrix dimensions
• Plan simulator (preview commissions before activating)
• Activate/deactivate plans

5.6 Commissions

• View all commission transactions
• Filter by type, date, status
• Approve pending commissions
• Commission summary & leaderboard

5.7 Wallets

• Overview of all member wallets
• Transaction history
• Manual adjustments (credit/debit)

5.8 Withdrawals

• Review pending withdrawal requests
• Approve/reject with reasons
• Process payments (bank transfer/UPI)
• View withdrawal history

5.9 Ranks

• Define rank levels (8 ranks seeded by default)
• Set thresholds: BV, team size, direct members
• Rank bonus amounts
• View rank achievements

5.10 KYC

• Review KYC submissions
• View uploaded documents
• Approve/reject with admin notes
• Fraud detection alerts

5.11 Reports

• Member report (registration, activity)
• Sales report (revenue, orders)
• Commission report (by type, by member)
• Wallet report (balances, transactions)

5.12 Settings

• Company profile
• Currency settings
• Withdrawal limits
• KYC requirements
• Notification preferences
• Branding (colors, logo)

6. Member Portal Guide

6.1 Dashboard

6.2 My Network

• Toggle between Sponsor Tree and Placement Tree
• Visual tree showing up to 3 levels
• Click nodes to expand/collapse
• Shows member code, name, BV, status per node

6.3 Shop

• Browse products with images and descriptions
• Search by product name
• View price, BV, PV per product
• Add to cart & checkout

6.4 Wallet

• View all 5 wallet balances
• Transaction history with filters
• Transfer between wallets

6.5 Withdrawals

• Request withdrawal (select amount, payment method)
• Enter bank details or UPI ID
• View withdrawal history & status tracking

7. MLM Compensation Plans

NMXpert supports 11 plan types. A company can configure one or combine multiple.

7.1 Binary Plan

7.2 Unilevel Plan

7.3 Matrix Plan

7.4 Other Plans

8. Commission Engine

Commission Types

How Commissions Are Calculated

1. Member places an order and payment is confirmed
2. CommissionService.processOrderCommission(orderId) is triggered
3. Runs inside a database transaction (all or nothing)
4. Calculates Binary Bonus: matches left BV vs right BV pairs
5. Calculates Direct Bonus: percentage of order BV to sponsor
6. Calculates Level Bonus: walks up sponsor chain (5 levels deep)
7. Each commission creates a commission_transactions record
8. 10% tax deducted, net amount credited to member's commission wallet
9. Wallet transaction logged with balance before/after
10. Rank evaluation triggered for the member
11. Notifications sent to all commission recipients

9. Wallet System

5 Wallet Types

Wallet Operations

• Credit: Creates wallet if missing, adds to balance, logs transaction
• Debit: Validates sufficient balance, subtracts, logs transaction
• Transfer: Debits from source wallet, credits to destination, logs both

10. Withdrawal Process

Step-by-Step

1. Member requests → Selects wallet type, amount, payment method (bank/UPI)
2. Validation → Balance check, KYC check, limit check
3. Deductions → Fee (% from plan) + TDS (% from plan) deducted
4. Wallet debited → Balance reduced immediately
5. Status: pending → Awaits admin review
6. Admin reviews → Approves or rejects with reason
7. If approved → approved → payment processed → paid
8. If rejected → rejected → wallet credited back → member notified

Withdrawal Limits (Default)

11. KYC Verification

Required Documents

KYC Status Flow

Fraud Detection Checks

12. Rank & Achievement System

8 Default Rank Levels

How Rank Promotion Works

1. RankService.evaluateMember(memberId) is called after every order
2. Fetches member's current stats (BV, team size, direct members)
3. Iterates through ranks in ascending order
4. Checks all thresholds: personal BV, team BV, direct members, left/right BV
5. If ALL thresholds met → auto-promotes
6. Creates member_ranks and rank_achievements records
7. Sends rank promotion notification

13. Genealogy / Network Tree

Two Tree Types

Tree Node Data

Each node displays: Member Code, Name, Personal BV, Team BV, Activation Status, Rank.

API Endpoints: GET /genealogy/sponsor and GET /genealogy/placement

14. Product & Order Management

Product Attributes

Order Lifecycle

Order Financial Breakdown

subtotal = sum(item_prices)
tax_amount = sum(item_taxes)
discount_amount = coupon discount
shipping_amount = shipping charge
total_amount = subtotal + tax - discount + shipping
total_bv = sum(item_bv × quantity)   ← for commissions
total_pv = sum(item_pv × quantity)   ← for rank qualification

15. Notifications & Support

Notification Events

System sends in-app notifications for: registration, new_referral, order, payment, commission, rank_achievement, kyc, withdrawal, product, subscription, support_ticket, announcement.

Support Ticket System

16. API Reference

Base URL

http://localhost/NMXpert/backend/public/index.php/

Authentication

All authenticated endpoints require: Authorization: Bearer <jwt_token>

Response Format

{
  "success": true,
  "message": "Request successful",
  "data": { ... },
  "errors": []
}

Complete Endpoint List

17. Troubleshooting

18. Frequently Asked Questions

General

Registration & Activation

Commissions & Income

Wallets & Withdrawals

Ranks

Technical