You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

95 lines
4.6 KiB

  1. .. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
  2. :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
  3. :alt: License: AGPL-3
  4. =====================
  5. Contract Auto Payment
  6. =====================
  7. This module allows for the configuration of automatic payments on invoices that are created by a contract.
  8. Usage
  9. =====
  10. Enable Automatic Payment
  11. ------------------------
  12. * Navigate to a customer contract
  13. * Check the `Auto Pay?` box to enable automatic payment
  14. * Configure the options as desired
  15. * Set the `Payment Token` to the payment token that should be used for automatic payment
  16. Automatic Payment Settings
  17. --------------------------
  18. The following settings are available at both the contract and contract template level:
  19. +-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  20. | Name | Description |
  21. +=======================+===============================================================================================================================================+
  22. | Invoice Message | Message template that is used to send invoices to customers upon creation. |
  23. +-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  24. | Payment Retry Message | Message template that is used to alert a customer that their automatic payment failed for some reason and will be retried. |
  25. +-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  26. | Payment Fail Message | Message template that is used to alert a customer that their automatic payment failed and will no longer be retried. |
  27. +-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  28. | Auto Pay Retries | Amount of times to attempt an automatic payment before discontinuing and removing the payment token from the contract/account payment method. |
  29. +-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  30. | Auto Pay Retry Hours | Amount of hours that should lapse until retrying failed payments. |
  31. +-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  32. Payment Token
  33. -------------
  34. A valid payment token is required to use this module. These tokens are typically created during the `website_sale` checkout process, but they can also be created manually at the acquirer.
  35. A payment token can be defined in one of two areas:
  36. * Contract - Defining a payment token in the contract will allow for the use of this token for automatic payments on this contract only.
  37. * Partner - Defining a payment token in the partner will allow for the use of this token for automatic payments on all contracts for this partner that do not have a payment token defined.
  38. .. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
  39. :alt: Try me on Runbot
  40. :target: https://runbot.odoo-community.org/runbot/110/10.0
  41. Known issues / Roadmap
  42. ======================
  43. * None
  44. Bug Tracker
  45. ===========
  46. Bugs are tracked on `GitHub Issues
  47. <https://github.com/OCA/contract/issues>`_. In case of trouble, please
  48. check there if your issue has already been reported. If you spotted it first,
  49. help us smash it by providing detailed and welcomed feedback.
  50. Credits
  51. =======
  52. Images
  53. ------
  54. * Odoo Community Association: `Icon <https://github.com/OCA/maintainer-tools/blob/master/template/module/static/description/icon.svg>`_.
  55. Contributors
  56. ------------
  57. * Dave Lasley <dave@laslabs.com>
  58. Maintainer
  59. ----------
  60. .. image:: https://odoo-community.org/logo.png
  61. :alt: Odoo Community Association
  62. :target: https://odoo-community.org
  63. This module is maintained by the OCA.
  64. OCA, or the Odoo Community Association, is a nonprofit organization whose
  65. mission is to support the collaborative development of Odoo features and
  66. promote its widespread use.
  67. To contribute to this module, please visit https://odoo-community.org.