Expenses Documentation

Expenses Controller Documentation

File: /controllers/expensesController.php

Purpose: Manages business expenses, supplier payments, and expense accounting

Last Updated: December 19, 2024

Total Functions: 18

Lines of Code: 1951

---

📋 Overview

The Expenses Controller manages all expense-related operations in the ERP system. It handles:

Primary Functions

Related Controllers

---

🗄️ Database Tables

Primary Tables (Direct Operations)

Table NamePurposeKey Columns
**expenses**Main expense recordsid, expensesname, expensevalue, expensetype, saveid, supplierId, paymethod, taxExist, tax, taxVal
**expensestype**Expense categoriesid, name, parent, accountstreeid
**costcenterdetail**Cost center allocationsexpenseId, costcenterId, amount
### Financial Integration Tables

Table NamePurposeRelationship
**save**Cash registersUpdated by cash expenses
**savedaily**Cash movementsRecords cash expense transactions
**bankaccount**Bank accountsUpdated by bank expenses
**accountmovement**Bank movementsRecords bank expense transactions
**dailyentry**Journal entriesAuto-generated for all expenses
**dailyentrycreditor**Credit entriesCash/bank credit sides
**dailyentrydebtor**Debit entriesExpense account debit sides
### Integration Tables

Table NamePurposeRelationship
**supplier**SuppliersFor supplier payments
**supplierdebtchange**Supplier debt trackingPayment history
**client**ClientsFor client expense allocations
**clientdebtchange**Client debt trackingExpense allocations
**accountstree**Chart of accountsExpense account mapping
**costcenter**Cost centersExpense allocation tracking
### Specialized Tracking Tables

Table NamePurposeRelationship
**product**ProductsFor product-related expenses
**sellbill**Sales ordersFor order-specific expenses
**realestateunit**Real estateProperty expense tracking
**travel**TransportationTravel expense tracking
---

🔧 Key Functions

1. Main Display (Default Action)

Purpose: Display expense entry form and recent expenses

Line: 317

Process Flow:

┌─────────────────┐ ┌──────────────────┐ ┌─────────────────┐
Load Expense
Types Tree
└─────────────────┘ └──────────────────┘ └─────────────────┘
│
▼
┌─────────────────┐ ┌──────────────────┐ ┌─────────────────┐
Load Cash
Registers
└─────────────────┘ └──────────────────┘ └─────────────────┘

2. add()

Purpose: Create new expense record with full financial integration

Line: 704

Parameters (via $_POST):

Process Flow:

┌─────────────────┐ ┌──────────────────┐ ┌─────────────────┐
Validate
Input Data
└─────────────────┘ └──────────────────┘ └─────────────────┘
│
▼
┌─────────────────┐ ┌──────────────────┐ ┌─────────────────┐
Handle Tax
Calculations
└─────────────────┘ └──────────────────┘ └─────────────────┘
│
▼
┌─────────────────┐ ┌──────────────────┐ ┌─────────────────┐
Update Supplier
Debt (if any)
└─────────────────┘ └──────────────────┘ └─────────────────┘

Critical Business Logic:

3. show()

Purpose: Display expense listing with search and filter capabilities

Line: 358

Features:

4. delete($expenseid)

Purpose: Delete expense and reverse all financial effects

Line: 1088

Process Flow:

┌─────────────────┐ ┌──────────────────┐ ┌─────────────────┐
Load Original
Expense Data
└─────────────────┘ └──────────────────┘ └─────────────────┘
│
▼
┌─────────────────┐ ┌──────────────────┐ ┌─────────────────┐
Reverse Journal
Entries
└─────────────────┘ └──────────────────┘ └─────────────────┘

5. executeOperation()

Purpose: Process bulk operations on multiple expenses

Line: 1042

Operations Supported:

6. edit()

Purpose: Load expense for editing

Line: 1379

Process:

7. update()

Purpose: Update existing expense with full reversal and re-entry

Line: 1390

Process Flow:

┌─────────────────┐ ┌──────────────────┐ ┌─────────────────┐
Load Original
Expense
└─────────────────┘ └──────────────────┘ └─────────────────┘

Note: Updates work by reversing the original expense effects and creating new entries with updated values.

8. expensesType()

Purpose: Get hierarchical expense type structure

Line: 686

Returns: Tree structure of expense categories for dropdown/tree display

9. getExpensesByType($typeid)

Purpose: Get all expenses by expense type

Line: 696

Parameters:

10. getSaveValue($saveid)

Purpose: Get current cash register balance

Line: 1715

Parameters:

11. updateSave($saveid, $savevalueafter)

Purpose: Update cash register balance

Line: 1762

12. insertSavedaily(...)

Purpose: Record cash movement in daily cash log

Line: 1775

Parameters:

13. insertAccountmovement(...)

Purpose: Record bank account movement

Line: 1797

14. affectSupplierWithExpense(...)

Purpose: Update supplier debt for supplier payments

Line: 1820

15. insertSupplierDebtChangeupdate(...)

Purpose: Log supplier debt change

Line: 1857

16. display_children($parent, $level)

Purpose: Build hierarchical expense type tree display

Line: 1880

17. CURL_IT2($data_arr, $url)

Purpose: API integration for expense data synchronization

Line: 1915

18. tempdelete($expenseid) / returndelete($expenseid)

Purpose: Soft delete and restore expense functionality

Lines: 1191, 1281

---

🔄 Business Logic Flow

Expense Payment Methods

Cash Payment (paymethod = 0)

┌─────────────────┐ ┌──────────────────┐ ┌─────────────────┐
Validate Cash
Register Balance│
└─────────────────┘ └──────────────────┘ └─────────────────┘
│
▼

Bank Payment (paymethod = 1)

┌─────────────────┐ ┌──────────────────┐ ┌─────────────────┐
Validate Bank
Account Balance
└─────────────────┘ └──────────────────┘ └─────────────────┘
│
▼

Credit Payment (paymethod = 2)

┌─────────────────┐ ┌──────────────────┐ ┌─────────────────┐
Create Expense
Record
└─────────────────┘ └──────────────────┘ └─────────────────┘
│
▼

Tax Calculation Logic 

if ($taxExist == 1) {
    $taxVal = ($expensevalue * $tax) / 100;
    $expensevalueAfterTax = $expensevalue + $taxVal;
}

Cost Center Allocation

┌─────────────────┐ ┌──────────────────┐ ┌─────────────────┐
Create Main
Expense Entry
└─────────────────┘ └──────────────────┘ └─────────────────┘

---

⚠️ Common Issues

1. Insufficient Cash/Bank Balance

Issue: Attempting expenses without sufficient funds

Prevention: Balance validation before processing: 

if ($saveValueafterValid >= 0) {
    // Process expense
} else {
    // Display error
}

2. Tax Calculation Errors

Issue: Incorrect tax calculations

Solution: Validate tax rate and calculations: 

$taxVal = ($expensevalue * $tax) / 100;
$expensevalueAfterTax = $expensevalue + $taxVal;

3. Supplier Debt Management

Issue: Supplier debt inconsistencies

Prevention: Always use debt change logging: 

insertSupplierDebtChangeupdate(
    $supplierId, 
    $beforeDebt, 
    $expensevalue, 
    $changeType, 
    $processname, 
    $expenseId, 
    $afterDebt
);

4. Journal Entry Imbalance

Issue: Debits ≠ Credits in auto-generated entries

Solution: Ensure all expense amounts include taxes in journal entries

5. Cost Center Allocation

Issue: Missing or incorrect cost center assignments

Prevention: Validate cost center requirements for expense types

---

🔗 Dependencies

Required Files

Critical DAOs

External Integrations

---

🎯 Expense Categories and Classification

Standard Expense Types 

1. Administrative Expenses
   ├── Office Supplies
   ├── Utilities
   └── Communication

2. Operational Expenses  
   ├── Raw Materials
   ├── Transportation
   └── Maintenance

3. Marketing Expenses
   ├── Advertising
   ├── Promotions
   └── Events

4. Financial Expenses
   ├── Bank Charges
   ├── Interest
   └── Exchange Differences

Payment Method Codes

Tax Handling

---

🎲 Best Practices

1. Expense Entry

2. Supplier Payments

3. Tax Management

4. Cost Center Allocation

---

Critical Note: This controller handles all business expense recording and directly impacts cash flow, supplier relationships, and financial reporting. All expense entries generate automatic journal entries that must maintain double-entry bookkeeping integrity.