oca-financial/odoo-bringout-oca-account-invoicing-account_invoice_payment_retention/account_invoice_payment_retention

=================================
Account Invoice Payment Retention
=================================

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

.. |badge1| image:: https://img.shields.io/badge/maturity-Alpha-red.png
    :target: https://odoo-community.org/page/development-status
    :alt: Alpha
.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
    :alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Faccount--invoicing-lightgray.png?logo=github
    :target: https://github.com/OCA/account-invoicing/tree/16.0/account_invoice_payment_retention
    :alt: OCA/account-invoicing
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
    :target: https://translation.odoo-community.org/projects/account-invoicing-16-0/account-invoicing-16-0-account_invoice_payment_retention
    :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/account-invoicing&target_branch=16.0
    :alt: Try me on Runboat

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

This module provide a feature to plan for retention during invoice / payment. And return it at later time.

#. At Vendor Bill (or Customer Invoice), user can plan the retention by percent/amount
#. At Payment, to retain the amount as planned (enforce / not enforce)
#. At a later time, with another Vendor Bill (or Customer Invoice), user can select the retained payment in order to return it

Note: This feature works on both customer invoice and vendor bill alike.

.. IMPORTANT::
   This is an alpha version, the data model and design can change at any time without warning.
   Only for development or testing purpose, do not use in production.
   `More details on development status <https://odoo-community.org/page/development-status>`_

**Table of contents**

.. contents::
   :local:

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

#. Go to menu > Invoicing > Configurations > Settings
#. Enable Invoice's Retention on Payment
#. Select the Retention Payable Account and Retention Receivalbe Account, make sure this account allow reconciliation
#. Once setup, user will see new Retention fields in Customer Invoice / Vendor Bill.

Usage
=====

**To plan for retention during invoice**

#. Create new Vendor Bill (or Customer Invoice).
#. Specify amount to retain, by percent or amount.
#. Validate invoice as per normal.

**To make payment retention**

#. From the invoice, click Register Payment.
#. On the payment window, system suggest the retention amount, click on helper toggle to apply it.
#. By default, enforce retention is checked to ensure that, a valid retention amount and retention account is applied.
#. Once ready, make payment as per normal. Journal Entry created with a retention account move line (to be cleared at later time).

**Note:** System just help to validate retention. At the end, user can ignore the retention.

**To return the retained amount**

#. As time arrived to return the retained amount. Create the new Vendor Bill (or Customer Invoice).
#. Select the partner. Return Retention field will list only uncleared retained amount for this partner.
#. Select one or multiple payments (journal entry), system will auto populate the retained amount.
#. Validate invoice as per normal, system will now clear (reconcile) that retention.
#. Proceed to payment as per normal.

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

Bugs are tracked on `GitHub Issues <https://github.com/OCA/account-invoicing/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/account-invoicing/issues/new?body=module:%20account_invoice_payment_retention%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
~~~~~~~

* Ecosoft

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

* `Ecosoft <http://ecosoft.co.th>`__:

  * Kitti U. <kittiu@ecosoft.co.th>
  * Saran Lim. <saranl@ecosoft.co.th>

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/account-invoicing <https://github.com/OCA/account-invoicing/tree/16.0/account_invoice_payment_retention>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.