Return Buy Bill Controller Documentation
File: /controllers/returnBuyBillController.php
Purpose: Manages purchase return operations, refunds to suppliers, and inventory adjustments for returned goods
Last Updated: December 19, 2024
Total Functions: 30
Lines of Code: 1,464
---
📋 Overview
The Return Buy Bill Controller handles all operations related to returning purchased goods back to suppliers. It manages:
- • Creating and editing purchase return bills (return buy bills)
- • Adjusting supplier debts for returned goods
- • Restoring inventory levels after returns
- • Managing cash register adjustments for refunds
- • Serial number tracking for returned items
- • Daily accounting entries for returns
- • Currency conversion for multi-currency returns
Primary Functions
- ✅ Create new purchase return bills
- ✅ Edit existing return bills
- ✅ Delete return bills
- ✅ View return bill details
- ✅ Print return bills
- ✅ Adjust supplier debts
- ✅ Update inventory quantities
- ✅ Track serial numbers
- ✅ Generate accounting entries
- ✅ Handle multi-currency returns
Related Controllers
- • buyBillController.php - Original purchase operations
- • supplierController.php - Supplier management
- • productController.php - Product management
- • storeController.php - Warehouse/store management
- • returnSellBillController.php - Sales returns
- • storedetailController.php - Inventory management
- • dailyentryController.php - Accounting entries
---
🗄️ Database Tables
Primary Tables (Direct Operations)
| Table Name | Purpose | Key Columns | |
|---|---|---|---|
| **returnbuybill** | Main return bills | returnbuybillid, returnbuybillserial, returnbuybilldate, returnbuybilltotalbill, returnbuybillsupplierid, returnbuybillstoreid | |
| **returnbuybilldetail** | Return bill line items | returnbuybilldetailid, returnbuybillid, returnbuybilldetailproductid, returnbuybilldetailquantity, returnbuybilldetailprice | |
| **returnbuybillcurr** | Multi-currency returns | returnbuybillcurrid, returnbuybillid, returnbuybillcurrencyid, returnbuybillexchangerate |
| Table Name | Purpose | Relationship | |
|---|---|---|---|
| **storedetail** | Stock quantities by store | Increased on returns | |
| **sizecolorstoredetail** | Stock by size/color variants | For variant products | |
| **storereport** | Stock movement history | Audit trail for returns | |
| **buypriceshistorybook** | Purchase price history | Cost tracking | |
| **productserial** | Serial number tracking | For serialized items |
| Table Name | Purpose | Relationship | |
|---|---|---|---|
| **supplier** | Supplier master data | returnbuybill.returnbuybillsupplierid | |
| **supplierdebtchange** | Supplier debt changes | Debt reduction tracking | |
| **save** | Cash registers/safes | returnbuybill.returnbuybillsaveid | |
| **savedaily** | Daily cash movements | Financial reconciliation | |
| **dailyentry** | Accounting journal entries | Auto-generated from returns |
| Table Name | Purpose | Relationship | |
|---|---|---|---|
| **product** | Product master data | Foreign key in details | |
| **productunit** | Units of measurement | returnbuybilldetail.productunitid | |
| **store** | Warehouses/stores | returnbuybill.returnbuybillstoreid | |
| **billname** | Bill templates/types | returnbuybill.billnameid | |
| **billsettings** | Bill configuration | Per bill type settings | |
| **currency** | Currency definitions | For multi-currency |
🔧 Key Functions
1. editprint()
Purpose: Main entry point for creating/editing return buy bills
Called By: Form submission with ?do=editprint
Line: 319
Parameters (via $_POST):
- •
returnbuybillId- ID of existing bill (empty for new) - •
returnbuybillserial- Serial number - •
returnbuybillsupplierid- Supplier ID - •
returnbuybillstoreid- Store ID - •
returnbuybillsaveid- Cash register ID - •
returnbuybilldate- Return date - •
returnbuybilltotalbill- Total amount
Database Operations:
- • INSERT/UPDATE
returnbuybill - • INSERT/UPDATE
returnbuybilldetail - • UPDATE
supplier(debt reduction) - • UPDATE
storedetail(inventory increase) - • INSERT
storereport(audit trail) - • INSERT
savedaily(cash movement)
Business Logic Flow:
┌─────────────────┐
User submits
return form
└─────────┬───────┘
▼
┌─────────────────┐
Validate data
& permissions
└─────────┬───────┘
▼
┌─────────────────┐
Save return
bill header
└─────────┬───────┘
▼
┌─────────────────┐
Process each
returned item
└─────────┬───────┘
▼
┌─────────────────┐
Update supplier
debt (decrease)
└─────────┬───────┘
▼
┌─────────────────┐
Increase store
inventory
└─────────┬───────┘
▼
┌─────────────────┐
Create daily
└─────────────────┘
2. showBillDetails($returnbuybillId)
Purpose: Display detailed view of a specific return bill
Parameters: $returnbuybillId - Return bill ID
Line: 572
Returns: Formatted HTML view with:
- • Return bill header information
- • Line items with products and quantities
- • Supplier information
- • Total amounts and currency
3. delete()
Purpose: Delete a return buy bill and reverse all its effects
Called By: Form with ?do=delete
Line: 711
Database Operations:
- • Reverse supplier debt changes
- • Reverse inventory adjustments
- • Reverse cash register changes
- • DELETE from
returnbuybilldetail - • DELETE from
returnbuybill - • INSERT audit records
4. getStoreDetails($storeId, $productId, $unittype, $sizeColorStoreDetailId, $sizeId, $colorId)
Purpose: Retrieve current stock levels for a product in a store
Line: 1135
Parameters:
- •
$storeId- Store identifier - •
$productId- Product identifier - •
$unittype- Unit type (1=main, 2=secondary) - •
$sizeColorStoreDetailId- Size/color variant ID - •
$sizeId,$colorId- Variant identifiers
Returns: Current quantity and store detail record
5. increaseProductQuantity($storedetailId, $productquantityBefore, $productChangeAmount, $sizeColorStoreDetailId, $sizeId, $colorId)
Purpose: Increase inventory when products are returned
Line: 1161
Database Operations:
- • UPDATE
storedetailSET quantity = quantity + amount - • UPDATE
sizecolorstoredetailif variants exist - • INSERT
storereportfor audit trail
6. updateSupplierDebt($supplierId, $supplierDebtAfter, $totaldeptafterInMainCurr)
Purpose: Reduce supplier debt when goods are returned
Line: 1330
Parameters:
- •
$supplierId- Supplier identifier - •
$supplierDebtAfter- New debt amount - •
$totaldeptafterInMainCurr- Debt in main currency
7. insertSupplierDebtChange($supplierId, $supplierDebtChangeBefore, $supplierDebtChangeBeforeInMainCurr, $supplierDebtChangeAmountInMainCurr, $supplierDebtChangeAmount, $supplierDebtChangeType, $processname, $supplierDebtChangeModelId, $supplierDebtChangeAfter, $supplierDebtChangeAfterInMainCurr, $tablename, $comment)
Purpose: Record supplier debt change for audit trail
Line: 1346
---
🔄 Business Logic Flow
Return Purchase Workflow
┌─────────────────┐
Original
Purchase Bill
└─────────┬───────┘
▼
┌─────────────────┐
Select Products
to Return
└─────────┬───────┘
▼
┌─────────────────┐
Create Return
Bill Header
└─────────┬───────┘
▼
┌─────────────────┐
Add Return
Line Items
└─────────┬───────┘
▼
┌─────────────────┐
Calculate
Return Amount
└─────────┬───────┘
▼
┌─────────────────┐
Update Supplier
Debt (Reduce)
└─────────┬───────┘
▼
┌─────────────────┐
Increase Store
Inventory
└─────────┬───────┘
▼
┌─────────────────┐
Update Cash
Register
└─────────┬───────┘
▼
┌─────────────────┐
Create Daily
Entry Record
└─────────┬───────┘
▼
┌─────────────────┐
Generate
Return Receipt
└─────────────────┘
Files Involved:
- • View:
/views/default/returnbuybill/returnbuybill_add.html - • Model:
/models/dto/Returnbuybill.class.php - • DAO:
/models/mysql/ReturnbuybillMySqlDAO.class.php
---
⚠️ Common Issues
Issue 1: Object Initialization
Problem: Fatal error: Attempt to assign property on null
Cause: PHP 8.2 requires explicit object initialization
Fix: Initialize objects before property assignment
Files: Various functions throughout controller
Issue 2: Type Conversion
Problem: TypeError: Unsupported operand types: string + string
Cause: PHP 8.2 strict type checking for arithmetic
Fix: Cast strings to numeric types before calculations
Issue 3: Array Validation
Problem: TypeError: count(): Argument must be Countable
Cause: count() called on non-array values
Fix: Use !empty() or validate array type first
---
🔗 Dependencies
Includes
include("../public/impOpreation.php");
include_once("../public/config.php");
include_once("dailyentryfun.php");
include("../public/include_dao.php");
Required DAOs
- •
ReturnbuybillDAO- Return bill operations - •
ReturnbuybilldetailDAO- Return line items - •
SupplierDAO- Supplier management - •
StoredetailDAO- Inventory operations - •
StorereportDAO- Audit trail - •
SaveDAO- Cash register operations - •
ProductDAO- Product information
Related Views
- •
/views/default/returnbuybill/returnbuybill_add.html- Return form - •
/views/default/returnbuybill/returnbuybill_show.html- Return list - •
/views/default/returnbuybill/returnbuybill_details.html- Return details
JavaScript Files
- •
/views/default/assets/js/returnbuybill.js- Return bill functionality
---
🎯 URL Routes & Actions
| Action (`?do=`) | Method | Description | View Template | |
|---|---|---|---|---|
| show | GET | Display return bills list | returnbuybill_show.html | |
| editprint | POST | Create/edit return bill | returnbuybill_add.html | |
| details | GET | Show return bill details | returnbuybill_details.html | |
| delete | POST | Delete return bill | - | |
| sucess | GET | Success confirmation | success.html | |
| error | GET | Error display | error.html |
🔐 Permissions & Security
Required Permissions
- • Return bill creation/editing rights
- • Supplier management access
- • Inventory adjustment permissions
Security Checks
include_once("../public/authentication.php");
include_once("initiateStaticSessionCommingWithCurl.php");
---
📝 Notes
Important Considerations
- • Return bills must reference original purchase bills
- • Inventory adjustments are immediate and permanent
- • Supplier debt changes must be properly tracked
- • Multi-currency calculations require exchange rates
- • Serial numbers must be properly handled for returns
Future Improvements
- ◻️ Add batch return processing
- ◻️ Implement return approval workflow
- ◻️ Add return reason codes
- ◻️ Integrate with quality control system
- ◻️ Add return analytics dashboard
---