Bizwiz Module Guide — Table of Contents¶
Status: DRAFT TOC for review. Derived from the web app side navigation (
bizwiz/resources/views/admin/includes/sidebar_includes/*.blade.php, 19 nav sections). This guide documents how Bizwiz works, module by module — independent of the AI research, but intended as its foundation. Author format: Markdown + Mermaid, layered for dev + non-dev readers.
Per-chapter template (every chapter follows this)¶
- Purpose — plain-language, non-dev readable
- Users & roles — who uses it + the permissions that gate it
- Processes — each mapped start→finish: trigger → steps/states → screens/routes → outcome
- Tables touched & key data — per process
- Interactions with other modules — the handoffs in and out
- Alternatives & variants — manual vs automated paths, flavor/tenant differences, edge cases
- Open questions to confirm — our inferences, flagged for user/dev validation
- Source references — files, for devs
Books & Chapters (~30 chapters, 7 books)¶
Book 1 — Sales & Revenue (from sales_and_receivables, 155 KB — split)¶
- Order Taking & Sales Invoicing
- Dispatch & Delivery
- POS / Cash Sales
- Customer Management
- Route Management
- Banking & Receivables Reconciliation
Book 2 — Inventory & Stock (from inventory, 111 KB — split)¶
- Item Master & Pricing
- Stock Operations (stock takes, breaks, adjustments)
- Goods Receiving & Returns (GRN)
- Inter-branch Transfers & Internal Requisitions
- Warehouse Special Stores —
storec+overflow_stores← investigate first, not assumed dead
Book 3 — Procurement & Suppliers¶
- Purchases & Requisitions (
purchases) - Accounts Payable (
accounts_payable) - Supplier Portal (
supplier_portal)
Book 4 — Finance & Accounting¶
- General Ledger & Journals (
general_ledger, split) - Fixed Assets (from
general_ledger) - Petty Cash & Expenses (
pettycash)
Book 5 — Fleet & Logistics (from fleet, 55 KB — split; + logistics)¶
- Vehicles & Tracking
- Fuel Management
- Tyre Management
- Vehicle Service & Route Compliance
- Logistics & Inbound Deliveries (
logistics)
Book 6 — HR & Payroll (from hr, 55 KB — split)¶
- Employees & Payroll
- Benefits & Deductions
- Leave & Attendance
- Sacco
Book 7 — Platform & Admin¶
- System Administration — users, roles, permissions, settings (
system_administration) - CRM (
crm) - Help Desk (
help_desk) - Communication Centre (
communication_centre)
Placeholders (listed, no deep dive) → 08_placeholders.md ✅¶
- Manufacturing & Production (
manufacturing_and_production) — feature-flaggedACTIVATE_MANUFACTURING_MODULE; built, gated off, deferred - Laboratory (
laboratory) — feature-flaggedACTIVATE_LABORATORY_MODULE; built, gated off, deferred
Cross-cutting deliverables (produced after chapters)¶
- Cross-module handoff map → 09_cross_module_handoff_map.md ✅ — end-to-end stitch across all 7 books (money-in, procure-to-pay, fleet, payroll → the shared
wa_gl_trans/wa_stock_movesspines, wrapped by the Book 7 control plane); carries the one still-open cross-book loop (driver-incentive earnings → payslip) - Book indexes — one per book (
00_bookN_index.md), each an index + reading guide + consolidated open questions
Status: COMPLETE ✅¶
All 30 chapters (7 books) + 7 book indexes + placeholders + cross-module handoff map are written and on disk. The guide now pivots to the AI-leverage research phase it was built to found.
Flags carried over from nav scout (to resolve during deep dives)¶
- Disabled in nav: Budgeting, Cash Management (opacity/disabled CSS in
general_ledger) - Legacy report sets:
reports_olddd/*, commented-out salesman invoice / order-taking blocks insales_and_receivables - Feature-flag / setting-gated visibility:
SHOW_ROUTE_INTEGRATION_CODES,REQUIRE_APPROVAL_FOR_ROUTE_CUSTOMER_DEACTIVATION,SHOP_ONBOARDING_PHONE_REQUIRED,activate-subbins,enable-additional-cost-price-list-module,identify-sales-orders-from-normal-orders,allow-backend-invoice-order-taking
Proposed fan-out order (for early validation)¶
- Book 1 — Sales & Revenue (core + largest; validate early)
- Book 2 — Inventory & Stock (incl. storec/overflow investigation)
- Book 3 — Procurement & Suppliers
- Book 4 — Finance & Accounting
- Book 5 — Fleet & Logistics
- Book 6 — HR & Payroll
- Book 7 — Platform & Admin
- Placeholders + cross-cutting handoff map