docs: convert README.md to README.rst format
This commit is contained in:
parent
b6c99f07d1
commit
e903f586fd
@ -1,91 +1,111 @@
|
|||||||
# Vendor Batch Payment Merge
|
==========================
|
||||||
|
Vendor Batch Payment Merge
|
||||||
|
==========================
|
||||||
|
|
||||||
This Odoo addon enhances the batch payment functionality to allow direct creation of payment lines within the batch payment form, rather than selecting existing payments. It also adds an expense account field to payment lines that will be used in journal entries instead of the default payable/receivable account.
|
This Odoo addon enhances the batch payment functionality to allow direct creation of payment lines
|
||||||
|
within the batch payment form, rather than selecting existing payments. It also adds an expense
|
||||||
|
account field to payment lines that will be used in journal entries instead of the default
|
||||||
|
payable/receivable account.
|
||||||
|
|
||||||
## Features
|
Features
|
||||||
|
========
|
||||||
|
|
||||||
1. **Direct Payment Line Creation**: Create payment lines directly within the batch payment form without having to create individual payments first.
|
1. **Direct Payment Line Creation**: Create payment lines directly within the batch payment form without having to create individual payments first.
|
||||||
2. **Expense Account Field**: Add an expense account to each payment line that will be used in the journal entry instead of the default payable/receivable account.
|
2. **Expense Account Field**: Add an expense account to each payment line that will be used in the journal entry instead of the default payable/receivable account.
|
||||||
3. **Automatic Payment Generation**: Generate actual payments from the direct payment lines with a single click.
|
3. **Automatic Payment Generation**: Generate actual payments from the direct payment lines with a single click.
|
||||||
4. **Support for Both Inbound and Outbound Payments**: Works with both customer and vendor batch payments.
|
4. **Support for Both Inbound and Outbound Payments**: Works with both customer and vendor batch payments.
|
||||||
5. **Smart Partner Filtering**: Automatically shows appropriate partners based on batch type:
|
5. **Smart Partner Filtering**: Automatically shows appropriate partners based on batch type:
|
||||||
- For vendor payments (outbound): Shows partners with supplier_rank > 0
|
* For vendor payments (outbound): Shows partners with supplier_rank > 0
|
||||||
- For customer payments (inbound): Shows partners with customer_rank > 0
|
* For customer payments (inbound): Shows partners with customer_rank > 0
|
||||||
|
|
||||||
## Installation
|
Installation
|
||||||
|
============
|
||||||
|
|
||||||
1. Copy the `vendor_batch_payment_merge` folder to your Odoo addons directory.
|
1. Copy the `vendor_batch_payment_merge` folder to your Odoo addons directory.
|
||||||
2. Update the Apps list in Odoo.
|
2. Update the Apps list in Odoo.
|
||||||
3. Install the "Vendor Batch Payment Merge" addon.
|
3. Install the "Vendor Batch Payment Merge" addon.
|
||||||
|
|
||||||
## Usage
|
Usage
|
||||||
|
=====
|
||||||
|
|
||||||
### For Vendor Payments (Outbound):
|
For Vendor Payments (Outbound):
|
||||||
|
------------------------------
|
||||||
1. Go to Accounting > Vendors > Batch Payments.
|
1. Go to Accounting > Vendors > Batch Payments.
|
||||||
2. Create a new batch payment or open an existing one.
|
2. Create a new batch payment or open an existing one.
|
||||||
3. In the "Direct Payment Lines" tab, add your payment lines with vendor, amount, and expense account.
|
3. In the "Direct Payment Lines" tab, add your payment lines with vendor, amount, and expense account.
|
||||||
4. Click "Generate Payments" to create the actual payments and add them to the batch.
|
4. Click "Generate Payments" to create the actual payments and add them to the batch.
|
||||||
5. Validate the batch as usual.
|
5. Validate the batch as usual.
|
||||||
|
|
||||||
### For Customer Payments (Inbound):
|
For Customer Payments (Inbound):
|
||||||
|
--------------------------------
|
||||||
1. Go to Accounting > Customers > Batch Payments.
|
1. Go to Accounting > Customers > Batch Payments.
|
||||||
2. Create a new batch payment or open an existing one.
|
2. Create a new batch payment or open an existing one.
|
||||||
3. In the "Direct Payment Lines" tab, add your payment lines with customer, amount, and income account.
|
3. In the "Direct Payment Lines" tab, add your payment lines with customer, amount, and income account.
|
||||||
4. Click "Generate Payments" to create the actual payments and add them to the batch.
|
4. Click "Generate Payments" to create the actual payments and add them to the batch.
|
||||||
5. Validate the batch as usual.
|
5. Validate the batch as usual.
|
||||||
|
|
||||||
## How It Works
|
How It Works
|
||||||
|
============
|
||||||
|
|
||||||
1. When you create a batch payment, you can now add direct payment lines in a new tab.
|
1. When you create a batch payment, you can now add direct payment lines in a new tab.
|
||||||
2. Each payment line can specify an expense/income account that will be used in the journal entry.
|
2. Each payment line can specify an expense/income account that will be used in the journal entry.
|
||||||
3. When you click "Generate Payments", the addon creates actual payment records and adds them to the batch.
|
3. When you click "Generate Payments", the addon creates actual payment records and adds them to the batch.
|
||||||
4. The journal entries for these payments will use the specified expense/income account instead of the default payable/receivable account.
|
4. The journal entries for these payments will use the specified expense/income account instead of the default payable/receivable account.
|
||||||
|
|
||||||
## Documentation
|
Documentation
|
||||||
|
=============
|
||||||
|
|
||||||
- [User Guide](doc/user_guide.md): Detailed instructions for end users
|
* `User Guide <doc/user_guide.md>`_: Detailed instructions for end users
|
||||||
- [Technical Guide](doc/technical_guide.md): Implementation details for developers
|
* `Technical Guide <doc/technical_guide.md>`_: Implementation details for developers
|
||||||
|
|
||||||
## Configuration
|
Configuration
|
||||||
|
=============
|
||||||
|
|
||||||
No additional configuration is required. The addon works out of the box with the standard Odoo accounting setup.
|
No additional configuration is required. The addon works out of the box with the standard Odoo accounting setup.
|
||||||
|
|
||||||
## Dependencies
|
Dependencies
|
||||||
|
============
|
||||||
|
|
||||||
- account
|
* account
|
||||||
- account_batch_payment
|
* account_batch_payment
|
||||||
|
|
||||||
## Demo Data
|
Demo Data
|
||||||
|
=========
|
||||||
|
|
||||||
The addon includes demo data that can be loaded to showcase its functionality:
|
The addon includes demo data that can be loaded to showcase its functionality:
|
||||||
- Demo vendors and customers
|
* Demo vendors and customers
|
||||||
- Demo expense and income accounts
|
* Demo expense and income accounts
|
||||||
|
|
||||||
## Tests
|
Tests
|
||||||
|
=====
|
||||||
|
|
||||||
The addon includes comprehensive tests to ensure proper functionality:
|
The addon includes comprehensive tests to ensure proper functionality:
|
||||||
- Test payment generation for both inbound and outbound payments
|
* Test payment generation for both inbound and outbound payments
|
||||||
- Test journal entry creation with expense accounts
|
* Test journal entry creation with expense accounts
|
||||||
- Test payment method availability
|
* Test payment method availability
|
||||||
|
|
||||||
## Recent Fixes
|
Recent Fixes
|
||||||
|
============
|
||||||
|
|
||||||
- Fixed partner field constraint issues
|
* Fixed partner field constraint issues
|
||||||
- Removed incorrect partner property references
|
* Removed incorrect partner property references
|
||||||
- Improved error handling for missing partners
|
* Improved error handling for missing partners
|
||||||
- Restored smart partner filtering based on batch type
|
* Restored smart partner filtering based on batch type
|
||||||
- Fixed payment method line search to properly find direct batch payment methods
|
* Fixed payment method line search to properly find direct batch payment methods
|
||||||
- Added automatic creation of payment method lines when they don't exist
|
* Added automatic creation of payment method lines when they don't exist
|
||||||
- Fixed domain context for proper partner filtering in payment lines
|
* Fixed domain context for proper partner filtering in payment lines
|
||||||
|
|
||||||
## License
|
License
|
||||||
|
=======
|
||||||
|
|
||||||
LGPL-3
|
LGPL-3
|
||||||
|
|
||||||
## Author
|
Author
|
||||||
|
======
|
||||||
|
|
||||||
[Your Name/Company]
|
[Your Name/Company]
|
||||||
|
|
||||||
## Support
|
Support
|
||||||
|
=======
|
||||||
|
|
||||||
For issues or questions about this addon, please contact your Odoo administrator or the addon developer.
|
For issues or questions about this addon, please contact your Odoo administrator or the addon developer.
|
||||||
Loading…
Reference in New Issue
Block a user