Merge pull request #26 from kainotomo/feature/documentation

Author: phalouvas

README.md

@@ -10,11 +10,15 @@ Invoice2Erpnext is an advanced tool that automatically processes invoices from v
 
 Before using Invoice2Erpnext, ensure:
 
-1. You've installed the Invoice2Erpnext app in your ERPNext instance
+1. You've installed the Invoice2Erpnext app in your ERPNext instance. Currently compatible with **ERPNext version 15**.
 2. Your administrator has configured the "Invoice2Erpnext Settings" with:
    - API credentials (api_key and api_secret) obtained from [https://kainotomo.com/api_keys](https://kainotomo.com/api_keys)
-   - Default VAT account
-   - Make sure you have credits obtained from [https://kainotomo.com/invoice2erpnext/shop](https://kainotomo.com/invoice2erpnext/shop)
+   - Default VAT account for tax calculations
+   - Default Supplier Group for new suppliers
+   - Default Item Group for extracted items
+   - One Item Invoice option (if you prefer all line items to be consolidated)
+   - Default Item (required when One Item Invoice is enabled)
+3. Make sure you have sufficient credits for processing invoices, available from [https://kainotomo.com/invoice2erpnext/shop](https://kainotomo.com/invoice2erpnext/shop)
 
 ### Installation
 
@@ -49,10 +53,14 @@ To configure Invoice2Erpnext:
 3. Configure the following required settings:
    - **API Credentials**: Enter your api_key and api_secret obtained from [https://kainotomo.com/api_keys](https://kainotomo.com/api_keys)
    - **Default VAT Account**: Select the account to be used for tax calculations
+   - **Supplier Group**: Choose the group where new suppliers will be categorized
+   - **Item Group**: Select the default group for new items created from invoices
+   - **One Item Invoice**: Enable this option if you want all invoice items to be consolidated into a single line item
+   - **Item**: If One Item Invoice is enabled, select the default item to use for all invoices
 
 4. Save the settings
 
-These configurations are essential for the app to function properly. Without valid API credentials, the system won't be able to process invoices.
+These configurations are essential for the app to function properly. Without valid API credentials and proper account settings, the system won't be able to process invoices correctly.
 
 ## How to Use
 
@@ -61,8 +69,10 @@ These configurations are essential for the app to function properly. Without val
 To process invoices with Invoice2Erpnext:
 
 1. Navigate to the **Purchase Invoice** list view
-![Alt text](documentation/prc-1.jpeg?raw=true "Purchase Invoice list view")
-2. Click the "Upload" button in the list view
+![Alt text](documentation/prc-4.png?raw=true "Purchase Invoice list view")
+2. Click the dropdown menu and select one of the following upload options:
+   - **Upload (Auto)**: Fully automatic processing where the system will identify the supplier, items, and all financial data without user input. Best for clear, well-structured invoices from established suppliers.
+   - **Upload (Manual)**: Requires you to select a specific supplier and item while the system extracts only the financial data. Ideal for unusual invoices, low-quality scans, or when you want consistent item categorization.
 3. Select the invoice files you want to process
 ![Alt text](documentation/prc-2.jpeg?raw=true "Upload")
 4. The system will:
@@ -71,42 +81,60 @@ To process invoices with Invoice2Erpnext:
    - Generate Logs with the result
 
 Once processed, you can review and submit the created Purchase Invoices after verifying their accuracy.
+
 ![Alt text](documentation/prc-3.jpeg "Purchase Invoice list view")
 
 ## Understanding the Process
 
 The system performs these steps automatically:
 
-1. **Document Extraction**: Sends the invoice to KAINOTOMO server that reads text and structures
-2. **Data Validation**: Checks for consistency in extracted financial data
-3. **Intelligent Reconciliation**: If discrepancies exist, determines which values are most reliable based on confidence scores
-4. **Return Result**: Return extracted data to your server and delete the file from KAINOTOMO server.
+1. **Document Extraction**: Sends the invoice to KAINOTOMO server that extracts text and structures data fields
+2. **Data Validation**: Checks for consistency in extracted financial data using confidence scores
+3. **Intelligent Reconciliation**: If discrepancies exist in totals, subtotals, or taxes, the system determines which values are most reliable based on confidence scores and adjusts values accordingly
 4. **Document Creation**:
    - Creates Supplier if not already in system
-   - Creates Items if not already in system
+   - Creates Items if not already in system (or uses a single default item if configured)
    - Creates Purchase Invoice with line items, taxes, and totals
+   - Handles special cases like credit notes and decimal point inconsistencies
 5. **File Attachment**: Links the original invoice file to the created Purchase Invoice
 
+### Processing Modes
+
+The system offers two processing modes:
+
+1. **Automatic Mode** (Default): The system extracts all information automatically and creates corresponding documents with no user intervention. Best for high-quality invoices from established suppliers.
+
+2. **Manual Mode**: Allows you to select a specific supplier and item while the system extracts only the financial data. Useful when:
+   - Working with unfamiliar suppliers
+   - Dealing with low-quality scans
+   - Needing consistent item categorization for reporting
+
 ## Monitoring Results
 
 After processing, use the Invoice2Erpnext Log to monitor status:
 
 1. Navigate to **Invoice2Erpnext Log** in your ERPNext menu
 2. View processing status for each uploaded file:
-   - Status: Shows "Success" if completed successfully
+   - Status: Shows "Success" if completed successfully, or "Error" if issues occurred
    - Created Docs: Lists all documents created from the invoice
-   - Message: Contains detailed processing information
+   - Message: Contains detailed processing information or error messages
+   - Cost: Shows the processing cost deducted from your credit balance
 
 The original file will be automatically attached to the new Purchase Invoice.
 
 ## Troubleshooting
 
 If processing fails:
-- Check the Invoice2Erpnext Log status and message fields
+- Check the Invoice2Erpnext Log status and message fields for specific error details
 - Common issues include:
   - Poor quality scans of invoices
   - Missing critical data (vendor name, invoice date, etc.)
   - Inconsistent totals that can't be reconciled
   - Connection issues with KAINOTOMO extraction service
+  - Decimal point inconsistencies in amount fields
+  - Insufficient credits in your account
 
-For best results, ensure your invoice files are clear, properly scanned, and contain all critical information.
+For best results:
+- Ensure your invoice files are clear, properly scanned, and contain all critical information
+- Verify that suppliers and default items are properly configured
+- Check your credit balance regularly at [https://kainotomo.com/invoice2erpnext/shop](https://kainotomo.com/invoice2erpnext/shop)

documentation/prc-1.jpeg

@@ -1,3 +1,3 @@
 
-__version__ = '2.2.0'
+__version__ = '2.3.0'