diff --git a/pos_payment_terminal/README.rst b/pos_payment_terminal/README.rst index 140f1f57..b1adac6c 100644 --- a/pos_payment_terminal/README.rst +++ b/pos_payment_terminal/README.rst @@ -1,3 +1,108 @@ ==================== POS Payment Terminal ==================== + +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |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/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%2Fpos-lightgray.png?logo=github + :target: https://github.com/OCA/pos/tree/12.0/pos_payment_terminal + :alt: OCA/pos +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/pos-12-0/pos-12-0-pos_payment_terminal + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png + :target: https://runbot.odoo-community.org/runbot/184/12.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This module adds support for credit card reader and checks printer +in the Point of Sale. + +**Table of contents** + +.. contents:: + :local: + +Installation +============ + +This module is designed to be installed on the +*main Odoo server*. On the *POSbox*, you should install the module +*hw_x* depending on the protocol implemented in your device. +`Ingenico ` +and old Sagem devices support the Telium protocol implemented in the +*hw_telium_payment_terminal* module. + +Configuration +============= + +* Go to Point of Sale > Configuration > Point of Sale, and check + the field "Payment Terminal" + +.. figure:: https://raw.githubusercontent.com/OCA/pos/12.0/pos_payment_terminal/static/description/pos_config_form.png + +* Then, in the same point of sale form, click on "Payment Methods" to + set correctly your account journals. + This module support two payment modes : *card* and *check*, this + option is available in te Point of sale tab. + +.. figure:: https://raw.githubusercontent.com/OCA/pos/12.0/pos_payment_terminal/static/description/account_journal_form.png + +Usage +===== + +In the frontend of the POS, when you select a payment method that has a payment mode *card* or *check*, you will have a *Start Transaction* button : if you click on that button, the amount, the currency and the payment mode will be sent to the POSbox. + +Bug Tracker +=========== + +Bugs are tracked on `GitHub Issues `_. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us smashing it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +~~~~~~~ + +* Aurélien DUMAINE +* GRAP +* Akretion + +Contributors +~~~~~~~~~~~~ + +* Aurelien Dumaine +* Alexis de Lattre +* Sylvain LE GAL (https://twitter.com/legalsylvain) + +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 `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/pos_payment_terminal/static/description/index.html b/pos_payment_terminal/static/description/index.html new file mode 100644 index 00000000..5178cfc1 --- /dev/null +++ b/pos_payment_terminal/static/description/index.html @@ -0,0 +1,459 @@ + + + + + + +POS Payment Terminal + + + +
+

POS Payment Terminal

+ + +

Beta License: AGPL-3 OCA/pos Translate me on Weblate Try me on Runbot

+

This module adds support for credit card reader and checks printer +in the Point of Sale.

+

Table of contents

+ +
+

Installation

+

This module is designed to be installed on the +main Odoo server. On the POSbox, you should install the module +hw_x depending on the protocol implemented in your device. +Ingenico <http://en.wikipedia.org/wiki/Ingenico> +and old Sagem devices support the Telium protocol implemented in the +hw_telium_payment_terminal module.

+
+
+

Configuration

+
    +
  • Go to Point of Sale > Configuration > Point of Sale, and check +the field “Payment Terminal”
  • +
+
+https://raw.githubusercontent.com/OCA/pos/12.0/pos_payment_terminal/static/description/pos_config_form.png +
+
    +
  • Then, in the same point of sale form, click on “Payment Methods” to +set correctly your account journals. +This module support two payment modes : card and check, this +option is available in te Point of sale tab.
  • +
+
+https://raw.githubusercontent.com/OCA/pos/12.0/pos_payment_terminal/static/description/account_journal_form.png +
+
+
+

Usage

+

In the frontend of the POS, when you select a payment method that has a payment mode card or check, you will have a Start Transaction button : if you click on that button, the amount, the currency and the payment mode will be sent to the POSbox.

+
+
+

Bug Tracker

+

Bugs are tracked on GitHub Issues. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us smashing it by providing a detailed and welcomed +feedback.

+

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

+
+
+

Credits

+
+

Authors

+
    +
  • Aurélien DUMAINE
  • +
  • GRAP
  • +
  • Akretion
  • +
+
+
+

Contributors

+ +
+
+

Maintainers

+

This module is maintained by the OCA.

+Odoo Community Association +

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 project on GitHub.

+

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

+
+
+
+ +