# NewKipp Microfinance Solution User Manual

This manual explains how to set up and use the Laravel NewKipp Microfinance Solution platform.

The same manual is available inside the website at:

`/user-manual`

The mobile app installation guide is available at:

`/mobile-app`

## 1. Main Portals

- **Tenant Admin:** manages one microfinance company, including members, staff, branches, products, transactions, gateways, and reports.
- **Staff:** managers, loan officers, accountants, and custom role profiles work based on assigned permissions.
- **Member:** views profile, savings, investments, loans, schedules, repayments, and transactions.
- **Merchant:** onboards or refers tenants and earns subscription commission.

## 2. Recommended Tenant Setup

1. Register or create the company.
2. Complete company profile, logo, color, address, currency, and portal slug.
3. Configure notification channels: email, SMS, WhatsApp, and system alerts.
4. Configure payment gateways: Paystack, Monnify, Flutterwave, Providus Bank, or Wema Bank.
5. Add branches.
6. Create role profiles.
7. Add staff and assign role profiles.
8. Create savings, loan, and investment products.
9. Import old records if the company already has data.
10. Start daily operations.

## 3. Members And KYC

Members can have:

- 10-digit account number
- first name, middle name, last name
- gender, date of birth, auto age display
- phone, email, address
- branch and group
- account officer
- BVN and NIN fields
- ID/photo uploads
- KYC verification status

Once KYC is verified and approved, protected KYC fields should not be edited casually. Admin review is required for corrections.

## 4. Savings

Supported savings workflows:

- Regular savings
- Target savings
- Thrift/Isusu savings
- Cooperative savings
- Member-created savings accounts
- Company-created savings accounts
- Deposits and withdrawals
- Savings statements
- Savings progress dashboard
- Savings schedule table

Savings processing fee can be:

- fixed amount
- percentage
- contribution amount

Contribution amount means the fee is based on the amount entered when opening the savings account.

## 5. Loans

Loan products support:

- loan ID prefix
- min and max amount
- interest type
- custom interest during application
- period/term
- first repayment date
- late penalty as fixed or percentage
- processing fee as fixed or percentage
- guarantor rule: mandatory, optional, or hidden
- collateral rule: mandatory, optional, or hidden
- visibility on member portal and public website

When a loan is created, the system should generate a repayment schedule showing:

- due date
- amount to pay
- paid amount
- principal
- interest
- processing fee
- late penalty
- remaining balance
- status

## 6. Investments

Tenants can create investment products, open investment accounts, track invested amount, expected return, return paid, maturity date, and transactions.

## 7. Accounting And Reports

Reports include:

- savings reports
- loan reports
- investment reports
- repayment reports
- outstanding loan report
- due loan report
- overdue loan report
- defaulters report
- non-performing loan report
- daily and monthly reports
- PDF exports

Accounting includes:

- income
- expenses
- journals
- ledger
- cashbook
- trial balance
- profit and loss
- balance sheet
- cashflow

## 8. Data Import

Use **Settings > Data Import** when moving an existing microfinance company into the system.

Recommended import order:

1. Branches
2. Members
3. Savings accounts
4. Loans
5. Savings transactions
6. Loan payments

Use the provided CSV templates. Keep account numbers, loan numbers, references, product names, and branch codes consistent.

## 9. Sync Center

Use **Settings > Sync Center** when an offline XAMPP copy needs to sync with an online hosted copy.

Automatic push:

1. On the online copy, create a receiver token.
2. On the offline copy, enter the online URL and token.
3. Click **Push to online now**.

Manual package:

1. On the offline copy, download a sync package.
2. On the online copy, upload/import that package.

Avoid editing the same records offline and online at the same time.

## 10. Mobile App / PWA

The first mobile version is an installable PWA.

To install:

1. Host the software on HTTPS.
2. Open the website in Chrome on Android.
3. Choose **Install app** or **Add to Home screen**.

The PWA includes:

- app manifest
- app icons
- service worker
- offline screen
- mobile menu
- bottom navigation

Later, the same web app can be wrapped with Capacitor for Play Store distribution.

## 11. Merchants

Merchant types:

- onboarding merchant
- referral merchant
- hybrid merchant

Merchants can:

- sign up themselves
- receive personalized landing pages
- onboard tenants
- refer tenants
- receive tenant assignments from the NewKipp team
- earn commission from tenant subscription payments

Commission rates are based on the merchant type, assigned work, and approved merchant level.

## 12. Billing

Tenants receive:

- automatic approval
- 14-day free trial
- visible countdown
- monthly or yearly subscription options
- manual payment approval
- invoices
- expiry handling
- reminder notifications

Plans control tenant limits such as staff, members, branches, and storage.

## 13. Common Issues

**Staff cannot see a menu:** check the role profile permissions.

**Import failed:** review the import history errors, fix the CSV row, and upload again.

**Offline sync failed:** check URL, token, internet access, HTTPS, and try manual export/import.

**Mobile install button is not showing:** use HTTPS and a supported browser. Browser menu may still show Add to Home screen.

**Loan schedule looks wrong:** review product period, first repayment date, interest, fee, penalty, and reschedule settings.
