TrashBin

# TrashBin - User Manual

## What is TrashBin?

TrashBin is a **recycle bin** for Dolibarr, just like the one on your computer. When you delete an item by mistake (a customer, a product, an invoice...), instead of losing it permanently, it goes to the trash bin. You can then easily restore it.

---

## 📋 Access the Trash Bin

1. In the main Dolibarr menu, click on **"TrashBin"** (trash icon)
2. You access the list of all deleted items

---

## 👁️ View the List of Deleted Items

The list displays:
- **Type**: The type of item (Third Party, Product, Invoice, etc.)
- **Reference**: The name or number of the item
- **Deletion Date**: When the item was deleted
- **Deleted By**: Who deleted the item

### Search for an Item

Use the search field at the top of the page to quickly find an item by its reference or name.

---

## ♻️ Restore an Item

### Restore a Single Item

1. In the list, click on the **reference** of the item you want to restore
2. On the detail page, click the **"Restore"** button
3. A confirmation is displayed: the item is available again in Dolibarr

> **💡 Tip**: Items are restored with all their information (contact details, prices, invoice lines, associated contacts, etc.)

---

## 🗑️ Delete Permanently

If you are sure you no longer need an item, you can permanently delete it from the trash bin.

### Delete an Item Permanently

1. Click on the item's reference
2. Click the **"Delete Permanently"** button
3. ⚠️ **Warning**: This action is irreversible! The item will be lost forever.

### Empty the Entire Trash Bin

1. At the top of the list, click **"Empty Trash Bin"**
2. Confirm the action
3. ⚠️ **Warning**: All items in the trash bin will be permanently deleted!

### Empty a Selection

1. Check the boxes of items to delete permanently
2. Click **"Purge Selected"**
3. Confirm: the checked items will be permanently deleted

---

## 🔍 View Item Details

Click on an item's reference to see its detailed information.

### "View JSON" Button

This button displays all technical information of the item in data format. It is useful to:
- Verify that an item contains all information before restoring it
- Share details with technical support in case of problems

Click **"Hide JSON"** to close this information.

---

## ⚙️ Configuration (for Administrators)

### Access Configuration

1. Go to **Home → Setup → Modules/Applications**
2. Find the **TrashBin** module in the list
3. Click on the **gear** icon (⚙️) on the right side of the module

### Automatic Purge

You can configure an **automatic purge** to automatically clean the trash bin.

- **Automatic Purge Delay (days)**: Number of days items are kept in the trash bin
  - Example: If you set **30**, items deleted more than 30 days ago will be automatically removed from the trash bin
  - Set **0** to disable automatic purge (items remain indefinitely)

**Recommendation**: 
- For small organizations: **90 days** (3 months)
- For large organizations: **30 days** (1 month)

The purge is triggered automatically each time someone opens the trash bin page.

---

## ❓ Frequently Asked Questions

### Do all my deleted items go to the trash bin?

Yes, TrashBin automatically captures the deletion of all types of items:
- Third parties (customers/suppliers)
- Contacts
- Products and services
- Invoices
- Quotes
- Orders
- Projects
- Interventions
- Etc.

### Can I restore an item deleted several months ago?

Yes, as long as the item is still in the trash bin. If an automatic purge is configured, check the retention period.

### Are attached files preserved?

Item information is preserved. Related documents may require special attention depending on the deletion context.

### What happens if I restore a deleted customer?

The customer is restored with:
- All contact details
- Associated contacts
- Categories
- Custom fields
- All information
- Documents
- Images
- Extrafields

### Can I restore an invoice with all its lines?

Yes, invoices are restored with all their lines, amounts, and details.

---

## 🆘 Need Help?

If you accidentally deleted an important item:

1. **Don't panic** 😊
2. Go to **TrashBin**
3. Search for the item by its name or reference
4. Click on it to verify it's the right one
5. Click **"Restore"**

If you can't find the item in the trash bin, contact your system administrator: they can check if automatic purge was enabled.

---

## 🔐 Permissions

Your administrator can define who can:
- **Read trash bin**: View the list of deleted items
- **Restore objects**: Put items back into Dolibarr
- **Purge objects**: Permanently delete from trash bin
- **Administer trash bin**: Access configuration

If you don't have access to certain functions, contact your administrator.

---

**TrashBin Module - Version 1.0.0**  
*Developed by Goldoweb SL*  
*Support: goldoweb@gmail.com*