Malipotetu - Payment, Expense, Reporting & Revenue Management System

A comprehensive system for managing payments, expenses, and revenue for businesses.

Features

• User Authentication & Authorization
• Business Management
• Payment Processing & Management
• Expense Tracking
• Revenue Analytics & Reporting
• Real-time Notifications (Email & SMS)
• Role-based Access Control

Prerequisites

• Node.js (v14 or higher)
• MySQL (v8 or higher)
• npm or yarn

Installation

1. Clone the repository:

git clone https://github.com/yourusername/malipotetu.git
cd malipotetu

2. Install dependencies:

npm install

3. Create a MySQL database:

CREATE DATABASE malipotetu;

4. Configure environment variables:

• Copy .env.example to .env
• Update the values in .env with your configuration

5. Run database migrations:

npm run typeorm migration:run

Business Creation API - JSON Examples

When creating a business through the API endpoint POST /api/businesses, different payment schedule types can be specified. Here are examples for each type:

1. Daily Payment Schedule

{
  "name": "Business Name",
  "description": "Business description",
  "address": "123 Main Street",
  "phoneNumber": "+1234567890",
  "email": "[email protected]",
  "paymentSchedule": {
    "scheduleType": "DAILY",
    "amount": 100
  },
  "groupId": "optional-group-id"
}

2. Weekly Payment Schedule

{
  "name": "Business Name",
  "description": "Business description",
  "address": "123 Main Street",
  "phoneNumber": "+1234567890",
  "email": "[email protected]",
  "paymentSchedule": {
    "scheduleType": "WEEKLY",
    "daysOfWeek": ["MONDAY", "FRIDAY"],
    "amount": 250
  },
  "groupId": "optional-group-id"
}

3. Monthly Payment Schedule

{
  "name": "Business Name",
  "description": "Business description",
  "address": "123 Main Street",
  "phoneNumber": "+1234567890",
  "email": "[email protected]",
  "paymentSchedule": {
    "scheduleType": "MONTHLY",
    "daysOfMonth": [1, 15],
    "amount": 500
  },
  "groupId": "optional-group-id"
}

4. Yearly Payment Schedule

{
  "name": "Business Name",
  "description": "Business description",
  "address": "123 Main Street",
  "phoneNumber": "+1234567890",
  "email": "[email protected]",
  "paymentSchedule": {
    "scheduleType": "YEARLY",
    "daysOfMonth": [15],
    "months": [1, 7],
    "amount": 2000
  },
  "groupId": "optional-group-id"
}

Development

Start the development server:

npm run dev

The server will start at http://localhost:3000

Production

Build the application:

npm run build

Start the production server:

npm start

API Documentation

Authentication

• POST /auth/register - Register a new user
• POST /auth/login - Login user
• POST /auth/refresh-token - Refresh access token
• POST /auth/logout - Logout user

Business Management

• GET /api/businesses - Get all businesses
• GET /api/businesses/:id - Get business by ID
• POST /api/businesses - Create new business
• PUT /api/businesses/:id - Update business
• DELETE /api/businesses/:id - Delete business
• POST /api/businesses/:id/employees - Add employees
• DELETE /api/businesses/:id/employees/:employeeId - Remove employee

Payment Management

• GET /api/payments - Get all payments
• GET /api/payments/:id - Get payment by ID
• POST /api/payments - Create new payment
• PUT /api/payments/:id/process - Process payment

Expense Management

• GET /api/expenses - Get all expenses
• GET /api/expenses/:id - Get expense by ID
• POST /api/expenses - Create new expense
• PUT /api/expenses/:id - Update expense
• DELETE /api/expenses/:id - Delete expense

Reporting

• GET /api/reports/business/:businessId/analytics - Get business analytics
• GET /api/reports/business/:businessId/expenses - Get expense report
• GET /api/reports/business/:businessId/payments - Get payment report

Revenue Management

• GET /api/revenue/business/:businessId/metrics - Get revenue metrics
• GET /api/revenue/business/:businessId/forecast - Get revenue forecast
• GET /api/revenue/business/:businessId/trends - Get revenue trends

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.