Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
119 changes: 119 additions & 0 deletions pos_payment_method_fee/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,119 @@
.. image:: https://odoo-community.org/readme-banner-image
:target: https://odoo-community.org/get-involved?utm_source=readme
:alt: Odoo Community Association

=======================
POS Payment Method Fees
=======================

..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:a4d4bff3ef27de510be6cb421b036d7440070332b0b6e91b58d08a5ff925e02f
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
:target: https://odoo-community.org/page/development-status
:alt: Beta
.. |badge2| image:: https://img.shields.io/badge/license-LGPL--3-blue.png
:target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
:alt: License: LGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fpos-lightgray.png?logo=github
:target: https://github.com/OCA/pos/tree/16.0/pos_payment_method_fee
:alt: OCA/pos
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/pos-16-0/pos-16-0-pos_payment_method_fee
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
:target: https://runboat.odoo-community.org/builds?repo=OCA/pos&target_branch=16.0
:alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

Models transactional financial fees per POS payment method.
Fees can be defined for each available payment method.
The corresponding fee amount is calculated automatically during order payment.
This module facilitates the management of surcharges associated with credit cards or other payment methods.
The applied fee amounts are posted into accounting.

**Table of contents**

.. contents::
:local:

Configuration
=============

To configure payment methods and their fees in Point of Sale:

1. Go to *Point of Sale -> Configuration -> Payment Methods*.
2. Create a new payment method or open an existing one.
3. Configure the **Fee Grouping Policy**:

* **Grouped**: Fees are summarized per fee rule into a single journal entry at session close.
* **Detailed**: One journal entry is generated per transaction fee at session close.

4. Under the **Transaction Fees** section, add one or more fee rules:

* **Fee Type**: Select *Fixed* or *Percentage*.
* **Amount**: Set the fixed amount or percentage value.
* **Posting Policy**: Select *Immediate* (posted immediately upon payment) or *At Session Close* (posted when POS session is closed).
* Configure the **Fee Account**, **Counterpart Account**, and **Posting Journal**.

5. Save the payment method.
6. Ensure the payment method is added to the relevant **POS Configuration** (*Point of Sale -> Configuration -> Point of Sale*).

Usage
=====

Usage in Point of Sale session:

1. Open a POS session and select an order.
2. Select a payment method configured with fee rules.
3. The system automatically calculates and registers the corresponding fee line.
4. Validate the payment and close the session according to the configured posting policy.

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/pos/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/pos/issues/new?body=module:%20pos_payment_method_fee%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

Do not contact contributors directly about support or help with technical issues.

Credits
=======

Authors
~~~~~~~

* BINHEX Systems Solutions S.L.

Contributors
~~~~~~~~~~~~

* `BINHEX Systems Solutions <https://www.binhex.es>`_:

* Ariel Torres Galvez
* Abraham J. Febres

Maintainers
~~~~~~~~~~~

This module is maintained by the OCA.

.. image:: https://odoo-community.org/logo.png
:alt: Odoo Community Association
:target: https://odoo-community.org

OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.

This module is part of the `OCA/pos <https://github.com/OCA/pos/tree/16.0/pos_payment_method_fee>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
1 change: 1 addition & 0 deletions pos_payment_method_fee/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
from . import models
22 changes: 22 additions & 0 deletions pos_payment_method_fee/__manifest__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
{
"name": "POS Payment Method Fees",
"summary": "Models transactional financial fees per POS payment method, "
"with automatic posting and complete traceability.",
"version": "16.0.1.0.0",
"category": "Point of Sale",
"license": "LGPL-3",
"author": "BINHEX Systems Solutions S.L., Odoo Community Association (OCA)",
"website": "https://github.com/OCA/pos",
"depends": [
"point_of_sale",
"account",
],
"data": [
"security/ir.model.access.csv",
"views/pos_payment_method_fee_views.xml",
"views/pos_payment_fee_line_views.xml",
],
"installable": True,
"application": False,
"auto_install": False,
}
Loading
Loading