Initial commit: OCA Technical packages (595 packages)

This commit is contained in:
Ernad Husremovic 2025-08-29 15:43:03 +02:00
commit 2cc02aac6e
24950 changed files with 2318079 additions and 0 deletions

View file

@ -0,0 +1,46 @@
# PoS Payment Method CashDro
Odoo addon: pos_payment_method_cashdro
## Installation
```bash
pip install odoo-bringout-oca-pos-pos_payment_method_cashdro
```
## Dependencies
This addon depends on:
- point_of_sale
## Manifest Information
- **Name**: PoS Payment Method CashDro
- **Version**: 16.0.1.0.0
- **Category**: Point Of Sale
- **License**: AGPL-3
- **Installable**: False
## Source
Based on [OCA/pos](https://github.com/OCA/pos) branch 16.0, addon `pos_payment_method_cashdro`.
## License
This package maintains the original AGPL-3 license from the upstream Odoo project.
## Documentation
- Overview: doc/OVERVIEW.md
- Architecture: doc/ARCHITECTURE.md
- Models: doc/MODELS.md
- Controllers: doc/CONTROLLERS.md
- Wizards: doc/WIZARDS.md
- Reports: doc/REPORTS.md
- Security: doc/SECURITY.md
- Install: doc/INSTALL.md
- Usage: doc/USAGE.md
- Configuration: doc/CONFIGURATION.md
- Dependencies: doc/DEPENDENCIES.md
- Troubleshooting: doc/TROUBLESHOOTING.md
- FAQ: doc/FAQ.md

View file

@ -0,0 +1,32 @@
# Architecture
```mermaid
flowchart TD
U[Users] -->|HTTP| V[Views and QWeb Templates]
V --> C[Controllers]
V --> W[Wizards Transient Models]
C --> M[Models and ORM]
W --> M
M --> R[Reports]
DX[Data XML] --> M
S[Security ACLs and Groups] -. enforces .-> M
subgraph Pos_payment_method_cashdro Module - pos_payment_method_cashdro
direction LR
M:::layer
W:::layer
C:::layer
V:::layer
R:::layer
S:::layer
DX:::layer
end
classDef layer fill:#eef8ff,stroke:#6ea8fe,stroke-width:1px
```
Notes
- Views include tree/form/kanban templates and report templates.
- Controllers provide website/portal routes when present.
- Wizards are UI flows implemented with `models.TransientModel`.
- Data XML loads data/demo records; Security defines groups and access.

View file

@ -0,0 +1,3 @@
# Configuration
Refer to Odoo settings for pos_payment_method_cashdro. Configure related models, access rights, and options as needed.

View file

@ -0,0 +1,3 @@
# Controllers
This module does not define custom HTTP controllers.

View file

@ -0,0 +1,5 @@
# Dependencies
This addon depends on:
- [point_of_sale](../../odoo-bringout-oca-ocb-point_of_sale)

View file

@ -0,0 +1,4 @@
# FAQ
- Q: Which Odoo version? A: 16.0 (OCA/OCB packaged).
- Q: How to enable? A: Start server with --addon pos_payment_method_cashdro or install in UI.

View file

@ -0,0 +1,7 @@
# Install
```bash
pip install odoo-bringout-oca-pos-pos_payment_method_cashdro"
# or
uv pip install odoo-bringout-oca-pos-pos_payment_method_cashdro"
```

View file

@ -0,0 +1,13 @@
# Models
Detected core models and extensions in pos_payment_method_cashdro.
```mermaid
classDiagram
class pos_payment_method
class pos_session
```
Notes
- Classes show model technical names; fields omitted for brevity.
- Items listed under _inherit are extensions of existing models.

View file

@ -0,0 +1,6 @@
# Overview
Packaged Odoo addon: pos_payment_method_cashdro. Provides features documented in upstream Odoo 16 under this addon.
- Source: OCA/OCB 16.0, addon pos_payment_method_cashdro
- License: LGPL-3

View file

@ -0,0 +1,3 @@
# Reports
This module does not define custom reports.

View file

@ -0,0 +1,8 @@
# Security
This module does not define custom security rules or access controls beyond Odoo defaults.
Default Odoo security applies:
- Base user access through standard groups
- Model access inherited from dependencies
- No custom row-level security rules

View file

@ -0,0 +1,5 @@
# Troubleshooting
- Ensure Python and Odoo environment matches repo guidance.
- Check database connectivity and logs if startup fails.
- Validate that dependent addons listed in DEPENDENCIES.md are installed.

View file

@ -0,0 +1,7 @@
# Usage
Start Odoo including this addon (from repo root):
```bash
python3 scripts/nix_odoo_web_server.py --db-name mydb --addon pos_payment_method_cashdro
```

View file

@ -0,0 +1,3 @@
# Wizards
This module does not include UI wizards.

View file

@ -0,0 +1,118 @@
==========================
PoS Payment Method CashDro
==========================
..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:395fd3a96489361b1f59537f222d4d570a5ba750ced74e3eb03fd89245aeb72a
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |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/16.0/pos_payment_method_cashdro
: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_cashdro
: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|
This module allows to make payments with a Cashdro (https://www.cashdro.com) terminal
on the Point of Sale frontend.
**Table of contents**
.. contents::
:local:
Configuration
=============
To add a Cashdro payment terminal:
#. Go to *Point of Sale > Configuration > Payment Methods*
#. Choose a cash payment method or create a new one.
#. Select *Cashdro* in the *Use a Payment Terminal* field.
#. Configure the Cashdro terminal hostname and credentials.
#. Configure the desired, Cashdro terminal in the proper PoS configurations.
Note that if a single payment method was used for cash in different stores, it should
be splitted in as many phisical stores there are.
Usage
=====
With the proper configuration made:
#. Make a new PoS order and choose the cash payment method configured with the Cashdro
settings.
#. Click on *Send* to send the request to the Cashdro terminal that will ask the
customer for the amount to pay.
#. The cashier can cancel the amount request discarding the line clicking on the (x)
symbol.
#. When the customer pays the sale amount in the terminal, the Cashdro reports the
amount received and change delivered back.
#. The Point of Sale reflects it in the payment line and thus the order can be validated
now.
Known issues / Roadmap
======================
* Integrate cash control (money inputs / outputs).
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_cashdro%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
~~~~~~~
* Tecnativa
Contributors
~~~~~~~~~~~~
* `Acysos S.L. <https://www.acysos.com>`_:
* Ignacio Ibeas
* `Tecnativa <https://www.tecnativa.com>`_
* David Vidal
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_cashdro>`_ project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

View file

@ -0,0 +1 @@
from . import models

View file

@ -0,0 +1,20 @@
# Copyright 2021 Tecnativa - David Vidal
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
{
"name": "PoS Payment Method CashDro",
"summary": "Allows to pay with CashDro Terminals on the Point of Sale",
"version": "16.0.1.0.0",
"category": "Point Of Sale",
"website": "https://github.com/OCA/pos",
"author": "Tecnativa, Odoo Community Association (OCA)",
"license": "AGPL-3",
"depends": [
"point_of_sale",
],
"data": [
"views/pos_payment_method_views.xml",
],
"assets": {
"point_of_sale.assets": ["pos_payment_method_cashdro/static/src/js/*.js"],
},
}

View file

@ -0,0 +1,44 @@
# Translation of Odoo Server.
# This file contains the translation of the following modules:
# * pos_payment_method_cashdro
#
msgid ""
msgstr ""
"Project-Id-Version: Odoo Server 16.0\n"
"Report-Msgid-Bugs-To: \n"
"Last-Translator: \n"
"Language-Team: \n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: \n"
"Plural-Forms: \n"
#. module: pos_payment_method_cashdro
#: model:ir.model.fields,field_description:pos_payment_method_cashdro.field_pos_payment_method__cashdro_password
msgid "Cashdro Password"
msgstr "Cashdro lozinka"
#. module: pos_payment_method_cashdro
#: model:ir.model.fields,field_description:pos_payment_method_cashdro.field_pos_payment_method__cashdro_host
msgid "Cashdro Terminal Host Name or IP address"
msgstr "Cashdro terminal naziv hosta ili IP adresa"
#. module: pos_payment_method_cashdro
#: model:ir.model.fields,field_description:pos_payment_method_cashdro.field_pos_payment_method__cashdro_user
msgid "Cashdro User"
msgstr "Cashdro korisnik"
#. module: pos_payment_method_cashdro
#: model:ir.model.fields,help:pos_payment_method_cashdro.field_pos_payment_method__cashdro_host
msgid "It must be reachable by the PoS in the store"
msgstr "Mora biti dostupan prodajnom mjestu u trgovini"
#. module: pos_payment_method_cashdro
#: model:ir.model,name:pos_payment_method_cashdro.model_pos_payment_method
msgid "Point of Sale Payment Methods"
msgstr "Načini plaćanja na prodajnom mjestu"
#. module: pos_payment_method_cashdro
#: model:ir.model,name:pos_payment_method_cashdro.model_pos_session
msgid "Point of Sale Session"
msgstr "Sesija POS-a"

View file

@ -0,0 +1,56 @@
# Translation of Odoo Server.
# This file contains the translation of the following modules:
# * pos_payment_method_cashdro
#
msgid ""
msgstr ""
"Project-Id-Version: Odoo Server 14.0\n"
"Report-Msgid-Bugs-To: \n"
"PO-Revision-Date: 2024-03-05 14:40+0000\n"
"Last-Translator: mymage <stefano.consolaro@mymage.it>\n"
"Language-Team: none\n"
"Language: it\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: \n"
"Plural-Forms: nplurals=2; plural=n != 1;\n"
"X-Generator: Weblate 4.17\n"
#. module: pos_payment_method_cashdro
#: model:ir.model.fields,field_description:pos_payment_method_cashdro.field_pos_payment_method__cashdro_password
msgid "Cashdro Password"
msgstr "Password Cashdro"
#. module: pos_payment_method_cashdro
#: model:ir.model.fields,field_description:pos_payment_method_cashdro.field_pos_payment_method__cashdro_host
msgid "Cashdro Terminal Host Name or IP address"
msgstr "Nome host terminale Cashdro o indirizzo IP"
#. module: pos_payment_method_cashdro
#: model:ir.model.fields,field_description:pos_payment_method_cashdro.field_pos_payment_method__cashdro_user
msgid "Cashdro User"
msgstr "Utente Cashdro"
#. module: pos_payment_method_cashdro
#: model:ir.model.fields,help:pos_payment_method_cashdro.field_pos_payment_method__cashdro_host
msgid "It must be reachable by the PoS in the store"
msgstr "Deve essere raggiungibile dal POS nel negozio"
#. module: pos_payment_method_cashdro
#: model:ir.model,name:pos_payment_method_cashdro.model_pos_payment_method
msgid "Point of Sale Payment Methods"
msgstr "Metodi di pagamento punto vendita"
#. module: pos_payment_method_cashdro
#: model:ir.model,name:pos_payment_method_cashdro.model_pos_session
msgid "Point of Sale Session"
msgstr "Sessione punto vendita"
#~ msgid "Display Name"
#~ msgstr "Nome visualizzato"
#~ msgid "ID"
#~ msgstr "ID"
#~ msgid "Last Modified on"
#~ msgstr "Ultima modifica il"

View file

@ -0,0 +1,44 @@
# Translation of Odoo Server.
# This file contains the translation of the following modules:
# * pos_payment_method_cashdro
#
msgid ""
msgstr ""
"Project-Id-Version: Odoo Server 16.0\n"
"Report-Msgid-Bugs-To: \n"
"Last-Translator: \n"
"Language-Team: \n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: \n"
"Plural-Forms: \n"
#. module: pos_payment_method_cashdro
#: model:ir.model.fields,field_description:pos_payment_method_cashdro.field_pos_payment_method__cashdro_password
msgid "Cashdro Password"
msgstr ""
#. module: pos_payment_method_cashdro
#: model:ir.model.fields,field_description:pos_payment_method_cashdro.field_pos_payment_method__cashdro_host
msgid "Cashdro Terminal Host Name or IP address"
msgstr ""
#. module: pos_payment_method_cashdro
#: model:ir.model.fields,field_description:pos_payment_method_cashdro.field_pos_payment_method__cashdro_user
msgid "Cashdro User"
msgstr ""
#. module: pos_payment_method_cashdro
#: model:ir.model.fields,help:pos_payment_method_cashdro.field_pos_payment_method__cashdro_host
msgid "It must be reachable by the PoS in the store"
msgstr ""
#. module: pos_payment_method_cashdro
#: model:ir.model,name:pos_payment_method_cashdro.model_pos_payment_method
msgid "Point of Sale Payment Methods"
msgstr ""
#. module: pos_payment_method_cashdro
#: model:ir.model,name:pos_payment_method_cashdro.model_pos_session
msgid "Point of Sale Session"
msgstr ""

View file

@ -0,0 +1,2 @@
from . import pos_payment_method
from . import pos_session

View file

@ -0,0 +1,35 @@
# Copyright 2021 Tecnativa - David Vidal
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
from odoo import fields, models
class PosPaymentMethod(models.Model):
_inherit = "pos.payment.method"
def _get_payment_terminal_selection(self):
return super()._get_payment_terminal_selection() + [("cashdro", "Cashdro")]
cashdro_host = fields.Char(
string="Cashdro Terminal Host Name or IP address",
help="It must be reachable by the PoS in the store",
)
cashdro_user = fields.Char()
cashdro_password = fields.Char()
def _onchange_journal_id(self):
"""Cash payment method force the `use_payment_terminal` to `False` as
it's assumed that a cash journal can't have a payment terminal. Let's keep
the method when it's needed"""
res = super()._onchange_journal_id()
if self.use_payment_terminal != "cashdro" and not self.is_cash_count:
return res
self.use_payment_terminal = "cashdro"
def _compute_hide_use_payment_terminal(self):
"""Now that we have the option to choose a payment terminal for the cashdro
payments, we can show the terminal options for cash payment types."""
cash_payment_types = self.filtered(lambda x: x.type == "cash")
cash_payment_types.hide_use_payment_terminal = False
return super(
PosPaymentMethod, self - cash_payment_types
)._compute_hide_use_payment_terminal()

View file

@ -0,0 +1,14 @@
# Copyright 2024 Tecnativa - David Vidal
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
from odoo import models
class PosSession(models.Model):
_inherit = "pos.session"
def _loader_params_pos_payment_method(self):
result = super()._loader_params_pos_payment_method()
result["search_params"]["fields"].extend(
["cashdro_host", "cashdro_user", "cashdro_password"]
)
return result

View file

@ -0,0 +1,10 @@
To add a Cashdro payment terminal:
#. Go to *Point of Sale > Configuration > Payment Methods*
#. Choose a cash payment method or create a new one.
#. Select *Cashdro* in the *Use a Payment Terminal* field.
#. Configure the Cashdro terminal hostname and credentials.
#. Configure the desired, Cashdro terminal in the proper PoS configurations.
Note that if a single payment method was used for cash in different stores, it should
be splitted in as many phisical stores there are.

View file

@ -0,0 +1,7 @@
* `Acysos S.L. <https://www.acysos.com>`_:
* Ignacio Ibeas
* `Tecnativa <https://www.tecnativa.com>`_
* David Vidal

View file

@ -0,0 +1,2 @@
This module allows to make payments with a Cashdro (https://www.cashdro.com) terminal
on the Point of Sale frontend.

View file

@ -0,0 +1 @@
* Integrate cash control (money inputs / outputs).

View file

@ -0,0 +1,12 @@
With the proper configuration made:
#. Make a new PoS order and choose the cash payment method configured with the Cashdro
settings.
#. Click on *Send* to send the request to the Cashdro terminal that will ask the
customer for the amount to pay.
#. The cashier can cancel the amount request discarding the line clicking on the (x)
symbol.
#. When the customer pays the sale amount in the terminal, the Cashdro reports the
amount received and change delivered back.
#. The Point of Sale reflects it in the payment line and thus the order can be validated
now.

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.2 KiB

View file

@ -0,0 +1,466 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils: https://docutils.sourceforge.io/" />
<title>PoS Payment Method CashDro</title>
<style type="text/css">
/*
:Author: David Goodger (goodger@python.org)
:Id: $Id: html4css1.css 8954 2022-01-20 10:10:25Z milde $
:Copyright: This stylesheet has been placed in the public domain.
Default cascading style sheet for the HTML output of Docutils.
See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/
/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
border: 0 }
table.borderless td, table.borderless th {
/* Override padding for "table.docutils td" with "! important".
The right padding separates the table cells. */
padding: 0 0.5em 0 0 ! important }
.first {
/* Override more specific margin styles with "! important". */
margin-top: 0 ! important }
.last, .with-subtitle {
margin-bottom: 0 ! important }
.hidden {
display: none }
.subscript {
vertical-align: sub;
font-size: smaller }
.superscript {
vertical-align: super;
font-size: smaller }
a.toc-backref {
text-decoration: none ;
color: black }
blockquote.epigraph {
margin: 2em 5em ; }
dl.docutils dd {
margin-bottom: 0.5em }
object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
overflow: hidden;
}
/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
font-weight: bold }
*/
div.abstract {
margin: 2em 5em }
div.abstract p.topic-title {
font-weight: bold ;
text-align: center }
div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
margin: 2em ;
border: medium outset ;
padding: 1em }
div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
font-weight: bold ;
font-family: sans-serif }
div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title, .code .error {
color: red ;
font-weight: bold ;
font-family: sans-serif }
/* Uncomment (and remove this text!) to get reduced vertical space in
compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
margin-bottom: 0.5em }
div.compound .compound-last, div.compound .compound-middle {
margin-top: 0.5em }
*/
div.dedication {
margin: 2em 5em ;
text-align: center ;
font-style: italic }
div.dedication p.topic-title {
font-weight: bold ;
font-style: normal }
div.figure {
margin-left: 2em ;
margin-right: 2em }
div.footer, div.header {
clear: both;
font-size: smaller }
div.line-block {
display: block ;
margin-top: 1em ;
margin-bottom: 1em }
div.line-block div.line-block {
margin-top: 0 ;
margin-bottom: 0 ;
margin-left: 1.5em }
div.sidebar {
margin: 0 0 0.5em 1em ;
border: medium outset ;
padding: 1em ;
background-color: #ffffee ;
width: 40% ;
float: right ;
clear: right }
div.sidebar p.rubric {
font-family: sans-serif ;
font-size: medium }
div.system-messages {
margin: 5em }
div.system-messages h1 {
color: red }
div.system-message {
border: medium outset ;
padding: 1em }
div.system-message p.system-message-title {
color: red ;
font-weight: bold }
div.topic {
margin: 2em }
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
margin-top: 0.4em }
h1.title {
text-align: center }
h2.subtitle {
text-align: center }
hr.docutils {
width: 75% }
img.align-left, .figure.align-left, object.align-left, table.align-left {
clear: left ;
float: left ;
margin-right: 1em }
img.align-right, .figure.align-right, object.align-right, table.align-right {
clear: right ;
float: right ;
margin-left: 1em }
img.align-center, .figure.align-center, object.align-center {
display: block;
margin-left: auto;
margin-right: auto;
}
table.align-center {
margin-left: auto;
margin-right: auto;
}
.align-left {
text-align: left }
.align-center {
clear: both ;
text-align: center }
.align-right {
text-align: right }
/* reset inner alignment in figures */
div.align-right {
text-align: inherit }
/* div.align-center * { */
/* text-align: left } */
.align-top {
vertical-align: top }
.align-middle {
vertical-align: middle }
.align-bottom {
vertical-align: bottom }
ol.simple, ul.simple {
margin-bottom: 1em }
ol.arabic {
list-style: decimal }
ol.loweralpha {
list-style: lower-alpha }
ol.upperalpha {
list-style: upper-alpha }
ol.lowerroman {
list-style: lower-roman }
ol.upperroman {
list-style: upper-roman }
p.attribution {
text-align: right ;
margin-left: 50% }
p.caption {
font-style: italic }
p.credits {
font-style: italic ;
font-size: smaller }
p.label {
white-space: nowrap }
p.rubric {
font-weight: bold ;
font-size: larger ;
color: maroon ;
text-align: center }
p.sidebar-title {
font-family: sans-serif ;
font-weight: bold ;
font-size: larger }
p.sidebar-subtitle {
font-family: sans-serif ;
font-weight: bold }
p.topic-title {
font-weight: bold }
pre.address {
margin-bottom: 0 ;
margin-top: 0 ;
font: inherit }
pre.literal-block, pre.doctest-block, pre.math, pre.code {
margin-left: 2em ;
margin-right: 2em }
pre.code .ln { color: grey; } /* line numbers */
pre.code, code { background-color: #eeeeee }
pre.code .comment, code .comment { color: #5C6576 }
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
pre.code .literal.string, code .literal.string { color: #0C5404 }
pre.code .name.builtin, code .name.builtin { color: #352B84 }
pre.code .deleted, code .deleted { background-color: #DEB0A1}
pre.code .inserted, code .inserted { background-color: #A3D289}
span.classifier {
font-family: sans-serif ;
font-style: oblique }
span.classifier-delimiter {
font-family: sans-serif ;
font-weight: bold }
span.interpreted {
font-family: sans-serif }
span.option {
white-space: nowrap }
span.pre {
white-space: pre }
span.problematic {
color: red }
span.section-subtitle {
/* font-size relative to parent (h1..h6 element) */
font-size: 80% }
table.citation {
border-left: solid 1px gray;
margin-left: 1px }
table.docinfo {
margin: 2em 4em }
table.docutils {
margin-top: 0.5em ;
margin-bottom: 0.5em }
table.footnote {
border-left: solid 1px black;
margin-left: 1px }
table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
padding-left: 0.5em ;
padding-right: 0.5em ;
vertical-align: top }
table.docutils th.field-name, table.docinfo th.docinfo-name {
font-weight: bold ;
text-align: left ;
white-space: nowrap ;
padding-left: 0 }
/* "booktabs" style (no vertical lines) */
table.docutils.booktabs {
border: 0px;
border-top: 2px solid;
border-bottom: 2px solid;
border-collapse: collapse;
}
table.docutils.booktabs * {
border: 0px;
}
table.docutils.booktabs th {
border-bottom: thin solid;
text-align: left;
}
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
font-size: 100% }
ul.auto-toc {
list-style-type: none }
</style>
</head>
<body>
<div class="document" id="pos-payment-method-cashdro">
<h1 class="title">PoS Payment Method CashDro</h1>
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:395fd3a96489361b1f59537f222d4d570a5ba750ced74e3eb03fd89245aeb72a
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/pos/tree/16.0/pos_payment_method_cashdro"><img alt="OCA/pos" src="https://img.shields.io/badge/github-OCA%2Fpos-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/pos-16-0/pos-16-0-pos_payment_method_cashdro"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/pos&amp;target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
<p>This module allows to make payments with a Cashdro (<a class="reference external" href="https://www.cashdro.com">https://www.cashdro.com</a>) terminal
on the Point of Sale frontend.</p>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#configuration" id="toc-entry-1">Configuration</a></li>
<li><a class="reference internal" href="#usage" id="toc-entry-2">Usage</a></li>
<li><a class="reference internal" href="#known-issues-roadmap" id="toc-entry-3">Known issues / Roadmap</a></li>
<li><a class="reference internal" href="#bug-tracker" id="toc-entry-4">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="toc-entry-5">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="toc-entry-6">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="toc-entry-7">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="toc-entry-8">Maintainers</a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="configuration">
<h1><a class="toc-backref" href="#toc-entry-1">Configuration</a></h1>
<p>To add a Cashdro payment terminal:</p>
<ol class="arabic simple">
<li>Go to <em>Point of Sale &gt; Configuration &gt; Payment Methods</em></li>
<li>Choose a cash payment method or create a new one.</li>
<li>Select <em>Cashdro</em> in the <em>Use a Payment Terminal</em> field.</li>
<li>Configure the Cashdro terminal hostname and credentials.</li>
<li>Configure the desired, Cashdro terminal in the proper PoS configurations.</li>
</ol>
<p>Note that if a single payment method was used for cash in different stores, it should
be splitted in as many phisical stores there are.</p>
</div>
<div class="section" id="usage">
<h1><a class="toc-backref" href="#toc-entry-2">Usage</a></h1>
<p>With the proper configuration made:</p>
<ol class="arabic simple">
<li>Make a new PoS order and choose the cash payment method configured with the Cashdro
settings.</li>
<li>Click on <em>Send</em> to send the request to the Cashdro terminal that will ask the
customer for the amount to pay.</li>
<li>The cashier can cancel the amount request discarding the line clicking on the (x)
symbol.</li>
<li>When the customer pays the sale amount in the terminal, the Cashdro reports the
amount received and change delivered back.</li>
<li>The Point of Sale reflects it in the payment line and thus the order can be validated
now.</li>
</ol>
</div>
<div class="section" id="known-issues-roadmap">
<h1><a class="toc-backref" href="#toc-entry-3">Known issues / Roadmap</a></h1>
<ul class="simple">
<li>Integrate cash control (money inputs / outputs).</li>
</ul>
</div>
<div class="section" id="bug-tracker">
<h1><a class="toc-backref" href="#toc-entry-4">Bug Tracker</a></h1>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/pos/issues">GitHub Issues</a>.
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
<a class="reference external" href="https://github.com/OCA/pos/issues/new?body=module:%20pos_payment_method_cashdro%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
<p>Do not contact contributors directly about support or help with technical issues.</p>
</div>
<div class="section" id="credits">
<h1><a class="toc-backref" href="#toc-entry-5">Credits</a></h1>
<div class="section" id="authors">
<h2><a class="toc-backref" href="#toc-entry-6">Authors</a></h2>
<ul class="simple">
<li>Tecnativa</li>
</ul>
</div>
<div class="section" id="contributors">
<h2><a class="toc-backref" href="#toc-entry-7">Contributors</a></h2>
<ul class="simple">
<li><a class="reference external" href="https://www.acysos.com">Acysos S.L.</a>:<ul>
<li>Ignacio Ibeas</li>
</ul>
</li>
<li><a class="reference external" href="https://www.tecnativa.com">Tecnativa</a><ul>
<li>David Vidal</li>
</ul>
</li>
</ul>
</div>
<div class="section" id="maintainers">
<h2><a class="toc-backref" href="#toc-entry-8">Maintainers</a></h2>
<p>This module is maintained by the OCA.</p>
<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
<p>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.</p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/pos/tree/16.0/pos_payment_method_cashdro">OCA/pos</a> project on GitHub.</p>
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
</div>
</div>
</div>
</body>
</html>

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.8 KiB

View file

@ -0,0 +1,35 @@
/** @odoo-module */
/* Copyright 2021 Tecnativa - David Vidal
License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).*/
import {Order, register_payment_method} from "point_of_sale.models";
import {PaymentCashdro} from "./payment_cashdro.esm";
import Registries from "point_of_sale.Registries";
register_payment_method("cashdro", PaymentCashdro);
const PaymentCashdroOrder = (OriginalOrder) =>
class extends OriginalOrder {
constructor() {
super(...arguments);
this.in_cashdro_transaction = false;
}
/**
* @override
* Set the amount to 0 as it's going to be filled by the Cashdro response
*/
add_paymentline() {
const line = super.add_paymentline(...arguments);
if (!line) {
return line;
}
if (
line.payment_method &&
line.payment_method.use_payment_terminal === "cashdro"
) {
line.set_amount(0);
}
return line;
}
};
Registries.Model.extend(Order, PaymentCashdroOrder);

View file

@ -0,0 +1,197 @@
/** @odoo-module */
/* Copyright 2021 Tecnativa - David Vidal
License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).*/
import PaymentInterface from "point_of_sale.PaymentInterface";
export const PaymentCashdro = PaymentInterface.extend({
/**
* @override
*/
init: function () {
this._super(...arguments);
this.enable_reversals();
},
/**
* @override
*/
send_payment_reversal: function () {
this._super.apply(...arguments);
const order = this.pos.get_order();
const line = order.selected_paymentline;
line.set_payment_status("reversing");
return this.cashdro_send_payment_request(order);
},
/**
* @override
*/
send_payment_cancel: function () {
this._super(...arguments);
const operation = this.pos.get_order().cashdro_operation;
if (!operation) {
return Promise.resolve();
}
return this.cashdro_finish_operation(operation);
},
/**
* @override
*/
send_payment_request: function () {
this._super(...arguments);
const order = this.pos.get_order();
const line = order.selected_paymentline;
line.set_payment_status("waiting");
return this.cashdro_send_payment_request(order);
},
// --------------------------------------------------------------------------
// Private
// --------------------------------------------------------------------------
cashdro_send_payment_request: async function (order) {
// The payment is done in three concatenated steps:
// 1. The POS send a payment request, to which the Cashdro respondes
// with an operation id.
// 2. Then the POS has to acknowledge that such operation id has
// been received.
// 3. Once acknowledged the POS has to send a payment request to the
// cashdro. Once the Cashdro responses with a "F" state (for
// finished) we'll get the response and fill the tendered money
// for the payment line.
const payment_line = order.selected_paymentline;
try {
// Cashdro treats decimals as positions in an integer we also have
// to deal with floating point computing to avoid decimals at the
// end or the drawer will reject our request.
const amount = Math.round(order.get_due(payment_line) * 100);
const res = await this._cashdro_request(
this._cashdro_payment_url({amount: amount})
);
// It comes handy to log the response from the drawer, as
// we can diagnose the right sytmoms for each issue
console.log(res);
const operation_id = res.data || "";
this.pos.get_order().cashdro_operation = operation_id;
// Acknowledge the operation
var ack_url = this._cashdro_ack_url(operation_id);
const res_ack = await this._cashdro_request(ack_url);
// Validate the operation
console.log(res_ack);
var ask_url = this._cashdro_ask_url(operation_id);
const operation_data = await this._cashdro_request_payment(ask_url);
// This might be too verbose, but it helps a lot to diagnose issues and
// their reasons.
console.log(operation_data);
var data = JSON.parse(operation_data.data);
payment_line.cashdro_operation_data = data;
var tendered = data.operation.totalin / 100;
payment_line.set_amount(tendered);
} catch (error) {
// We wan't to be able to retry after any error.
// TODO: catch specific exceptions
payment_line.set_payment_status("retry");
throw error;
}
return true;
},
cashdro_finish_operation: async function (operation) {
// Finish the Cashdro running operation
var order = this.pos.get_order();
if (operation) {
await this._cashdro_request(this._cashdro_finish_url(operation));
order.cashdro_operation = false;
}
},
// API communication methods
_cashdro_url: function () {
// Cashdro machines don't support safe POST calls, so we're sending
// all the data quite unsafely constantly...
const method = this.pos.get_order().selected_paymentline.payment_method;
const host = method && method.cashdro_host;
if (!host) {
return false;
}
let url = `https://${host}/Cashdro3WS/index.php`;
url += `?name=${method.cashdro_user}`;
url += `&password=${method.cashdro_password}`;
return url;
},
_cashdro_payment_url: function (parameters) {
// Compose the url for a sale report to Cashdro
const user = this.pos.get_cashier().id || this.pos.user.id;
let url = `${this._cashdro_url()}&operation=startOperation&type=4`;
url += `&posid=pos-${this.pos.pos_session.name}`;
url += `&posuser=${user}`;
url += `&parameters=${encodeURIComponent(JSON.stringify(parameters))}`;
return url;
},
_cashdro_ack_url: function (operation_id) {
// Compose the url for a sale report to Cashdro
var url = this._cashdro_url();
url += "&operation=acknowledgeOperationId";
url += "&operationId=" + operation_id;
return url;
},
_cashdro_ask_url: function (operation_id) {
// Compose the url for to report a sale to Cashdro
var url = this._cashdro_url();
url += "&operation=askOperation";
url += "&operationId=" + operation_id;
return url;
},
_cashdro_finish_url: function (operation_id) {
// Compose the url for a sale report to Cashdro
var url = this._cashdro_url();
url += "&operation=finishOperation&type=2";
url += "&operationId=" + operation_id;
return url;
},
_cashdro_request: function (url) {
// We'll use it for regular requests
return $.ajax({
url: url,
method: "GET",
async: true,
success: function (response) {
return response;
},
});
},
/**
* This is a special request, as we keep requesting the CashDro until we get
* the *finished* state that will give us the amount received in the cashdrawer.
*
* @param {String} request_url
* @returns promise
*/
_cashdro_request_payment: function (request_url) {
var def = $.Deferred();
var _request_payment = (url) => {
$.ajax({
url: url,
method: "GET",
success: (response) => {
var data = JSON.parse(response.data);
if (data.operation.state === "F") {
def.resolve(response);
} else {
_request_payment(url);
}
},
});
};
_request_payment(request_url);
return def;
},
});

View file

@ -0,0 +1,24 @@
<?xml version="1.0" encoding="UTF-8" ?>
<odoo>
<record id="pos_payment_method_view_form" model="ir.ui.view">
<field name="model">pos.payment.method</field>
<field name="inherit_id" ref="point_of_sale.pos_payment_method_view_form" />
<field name="arch" type="xml">
<field name="use_payment_terminal" position="after">
<field
name="cashdro_host"
attrs="{'invisible': [('use_payment_terminal', '!=', 'cashdro')], 'required': [('use_payment_terminal', '=', 'cashdro')]}"
/>
<field
name="cashdro_user"
attrs="{'invisible': [('use_payment_terminal', '!=', 'cashdro')], 'required': [('use_payment_terminal', '=', 'cashdro')]}"
/>
<field
name="cashdro_password"
password="True"
attrs="{'invisible': [('use_payment_terminal', '!=', 'cashdro')], 'required': [('use_payment_terminal', '=', 'cashdro')]}"
/>
</field>
</field>
</record>
</odoo>

View file

@ -0,0 +1,42 @@
[project]
name = "odoo-bringout-oca-pos-pos_payment_method_cashdro"
version = "16.0.0"
description = "PoS Payment Method CashDro - Allows to pay with CashDro Terminals on the Point of Sale"
authors = [
{ name = "Ernad Husremovic", email = "hernad@bring.out.ba" }
]
dependencies = [
"odoo-bringout-oca-ocb-point_of_sale>=16.0.0",
"requests>=2.25.1"
]
readme = "README.md"
requires-python = ">= 3.11"
classifiers = [
"Development Status :: 5 - Production/Stable",
"Intended Audience :: Developers",
"License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Topic :: Office/Business",
]
[project.urls]
homepage = "https://github.com/bringout/0"
repository = "https://github.com/bringout/0"
[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"
[tool.hatch.metadata]
allow-direct-references = true
[tool.hatch.build.targets.wheel]
packages = ["pos_payment_method_cashdro"]
[tool.rye]
managed = true
dev-dependencies = [
"pytest>=8.4.1",
]