Browse Source

Merge 016a373867 into 050828d7a0

pull/399/merge
Murtaza Mithaiwala 4 years ago
committed by GitHub
parent
commit
250d476395
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 113
      pos_margin/README.rst
  2. 2
      pos_margin/__init__.py
  3. 22
      pos_margin/__manifest__.py
  4. 69
      pos_margin/i18n/es.po
  5. 61
      pos_margin/i18n/fr.po
  6. 66
      pos_margin/i18n/it.po
  7. 67
      pos_margin/i18n/nl_NL.po
  8. 57
      pos_margin/i18n/pos_margin.pot
  9. 2
      pos_margin/models/__init__.py
  10. 23
      pos_margin/models/pos_order.py
  11. 41
      pos_margin/models/pos_order_line.py
  12. 3
      pos_margin/readme/CONTRIBUTORS.rst
  13. 5
      pos_margin/readme/DESCRIPTION.rst
  14. 8
      pos_margin/readme/HISTORY.rst
  15. 7
      pos_margin/readme/ROADMAP.rst
  16. 7
      pos_margin/readme/USAGE.rst
  17. 2
      pos_margin/report/__init__.py
  18. 15
      pos_margin/report/pos_order_report.py
  19. BIN
      pos_margin/static/description/icon.png
  20. 463
      pos_margin/static/description/index.html
  21. BIN
      pos_margin/static/description/pos_order_form.png
  22. 1
      pos_margin/tests/__init__.py
  23. 67
      pos_margin/tests/test_module.py
  24. 33
      pos_margin/views/view_pos_order.xml

113
pos_margin/README.rst

@ -0,0 +1,113 @@
================
PoS Order Margin
================
.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! 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_margin
: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_margin
: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 extends the functionality of point of sale to support margin on
pos orders.
This gives the profitability by calculating the difference between the Unit
Price and Cost Price.
**Table of contents**
.. contents::
:local:
Usage
=====
To use this module, you need to:
* Go to 'Point Of Sale' / 'Orders' / 'Orders'
* Open an order
.. figure:: https://raw.githubusercontent.com/OCA/pos/12.0/pos_margin/static/description/pos_order_form.png
:width: 800px
Known issues / Roadmap
======================
This module depends on ``sale_margin`` module to reuse algorithm present in the
function ``_get_purchase_price`` of the model ``sale.order.line`` to
compute correctly purchase price, in a multicurrency context.
This dependency can be removed, when Odoo Core will be correctly refactored,
moving this ``@api.model`` function in a more generic module (``account``
for exemple).
Changelog
=========
12.0.1.0.0
~~~~~~~~~~
* Migrate to V12.0
* Reuse ``sale_margin`` computation to handle multi currency context.
* Correct computation of margin, if a module that adds ``uom_id`` on
``pos.order.line`` is installed.
* Add test
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 smashing it by providing a detailed and welcomed
`feedback <https://github.com/OCA/pos/issues/new?body=module:%20pos_margin%0Aversion:%2012.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
~~~~~~~
* GRAP
Contributors
~~~~~~~~~~~~
* Sylvain LE GAL (https://twitter.com/legalsylvain)
* Wolfgang Pichler
* Murtaza Mithaiwala (https://twitter.com/MurtazaMithaiw4)
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/12.0/pos_margin>`_ project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

2
pos_margin/__init__.py

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

22
pos_margin/__manifest__.py

@ -0,0 +1,22 @@
# Copyright (C) 2017 - Today: GRAP (http://www.grap.coop)
# @author: Sylvain LE GAL (https://twitter.com/legalsylvain)
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
{
'name': 'PoS Order Margin',
'summary': 'Margin on PoS Order',
'version': '13.0.1.0.0',
'category': 'Point Of Sale',
'author': "GRAP,"
"Odoo Community Association (OCA)",
'website': 'https://github.com/OCA/pos',
'license': 'AGPL-3',
'depends': [
'point_of_sale',
'sale_margin',
],
'data': [
'views/view_pos_order.xml',
],
'installable': True,
}

69
pos_margin/i18n/es.po

@ -0,0 +1,69 @@
# Translation of Odoo Server.
# This file contains the translation of the following modules:
# * pos_margin
#
# Translators:
# OCA Transbot <transbot@odoo-community.org>, 2017
# enjolras <yo@miguelrevilla.com>, 2018
msgid ""
msgstr ""
"Project-Id-Version: Odoo Server 10.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2018-03-01 02:01+0000\n"
"PO-Revision-Date: 2018-03-01 02:01+0000\n"
"Last-Translator: enjolras <yo@miguelrevilla.com>, 2018\n"
"Language-Team: Spanish (https://www.transifex.com/oca/teams/23907/es/)\n"
"Language: es\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"
#. module: pos_margin
#: model:ir.model.fields,field_description:pos_margin.field_pos_order_line_purchase_price
msgid "Cost Price"
msgstr "Precio de coste"
#. module: pos_margin
#: model:ir.model.fields,help:pos_margin.field_pos_order_margin
msgid ""
"It gives profitability by calculating the difference between the Unit Price "
"and the cost price."
msgstr ""
"Indica el beneficio calculando la diferencia entre el precio unitario y el "
"precio de coste."
#. module: pos_margin
#: model:ir.model,name:pos_margin.model_pos_order_line
#, fuzzy
msgid "Lines of Point of Sale Orders"
msgstr "Líneas del punto de venta"
#. module: pos_margin
#: model:ir.model.fields,field_description:pos_margin.field_pos_order_line_margin
#: model:ir.model.fields,field_description:pos_margin.field_pos_order_margin
msgid "Margin"
msgstr "Margen"
#. module: pos_margin
#: model:ir.model.fields,field_description:pos_margin.field_report_pos_order_margin_rate
#, fuzzy
msgid "Margin Rate"
msgstr "Margen"
#. module: pos_margin
#: model:ir.model.fields,field_description:pos_margin.field_report_pos_order_margin_total
#, fuzzy
msgid "Margin Total"
msgstr "Margen"
#. module: pos_margin
#: model:ir.model,name:pos_margin.model_pos_order
msgid "Point of Sale Orders"
msgstr "Pedidos del TPV"
#. module: pos_margin
#: model:ir.model,name:pos_margin.model_report_pos_order
#, fuzzy
msgid "Point of Sale Orders Statistics"
msgstr "Pedidos del TPV"

61
pos_margin/i18n/fr.po

@ -0,0 +1,61 @@
# Translation of Odoo Server.
# This file contains the translation of the following modules:
# * pos_margin
#
msgid ""
msgstr ""
"Project-Id-Version: Odoo Server 12.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2019-08-15 11:05+0000\n"
"PO-Revision-Date: 2019-08-15 11:05+0000\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_margin
#: model:ir.model.fields,field_description:pos_margin.field_pos_order_line__purchase_price
msgid "Cost Price"
msgstr "Prix de revient"
#. module: pos_margin
#: model:ir.model.fields,help:pos_margin.field_pos_order__margin
msgid "It gives profitability by calculating the difference between the Unit Price and the cost price."
msgstr ""
"Il donne la rentabilité en calculant la différence entre le prix unitaire et "
"le prix de revient."
#. module: pos_margin
#: model:ir.model.fields,field_description:pos_margin.field_pos_order__margin
#: model:ir.model.fields,field_description:pos_margin.field_pos_order_line__margin
msgid "Margin"
msgstr "Marge"
#. module: pos_margin
#: model:ir.model.fields,field_description:pos_margin.field_report_pos_order__margin_rate
msgid "Margin Rate"
msgstr "Taux de marque"
#. module: pos_margin
#: model:ir.model.fields,field_description:pos_margin.field_report_pos_order__margin_total
#: model_terms:ir.ui.view,arch_db:pos_margin.view_pos_order_tree
msgid "Margin Total"
msgstr "Marge Totale"
#. module: pos_margin
#: model:ir.model,name:pos_margin.model_pos_order_line
msgid "Point of Sale Order Lines"
msgstr ""
#. module: pos_margin
#: model:ir.model,name:pos_margin.model_pos_order
msgid "Point of Sale Orders"
msgstr "Commandes du point de vente"
#. module: pos_margin
#: model:ir.model,name:pos_margin.model_report_pos_order
msgid "Point of Sale Orders Report"
msgstr ""

66
pos_margin/i18n/it.po

@ -0,0 +1,66 @@
# Translation of Odoo Server.
# This file contains the translation of the following modules:
# * pos_margin
#
# Translators:
# Francesco Fresta <franco.fresta@gmail.com>, 2018
msgid ""
msgstr ""
"Project-Id-Version: Odoo Server 10.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2018-03-01 02:01+0000\n"
"PO-Revision-Date: 2018-03-01 02:01+0000\n"
"Last-Translator: Francesco Fresta <franco.fresta@gmail.com>, 2018\n"
"Language-Team: Italian (https://www.transifex.com/oca/teams/23907/it/)\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"
#. module: pos_margin
#: model:ir.model.fields,field_description:pos_margin.field_pos_order_line_purchase_price
msgid "Cost Price"
msgstr ""
#. module: pos_margin
#: model:ir.model.fields,help:pos_margin.field_pos_order_margin
msgid ""
"It gives profitability by calculating the difference between the Unit Price "
"and the cost price."
msgstr ""
#. module: pos_margin
#: model:ir.model,name:pos_margin.model_pos_order_line
#, fuzzy
msgid "Lines of Point of Sale Orders"
msgstr "Punto di riordino"
#. module: pos_margin
#: model:ir.model.fields,field_description:pos_margin.field_pos_order_line_margin
#: model:ir.model.fields,field_description:pos_margin.field_pos_order_margin
msgid "Margin"
msgstr "Margine"
#. module: pos_margin
#: model:ir.model.fields,field_description:pos_margin.field_report_pos_order_margin_rate
#, fuzzy
msgid "Margin Rate"
msgstr "Margine"
#. module: pos_margin
#: model:ir.model.fields,field_description:pos_margin.field_report_pos_order_margin_total
#, fuzzy
msgid "Margin Total"
msgstr "Margine"
#. module: pos_margin
#: model:ir.model,name:pos_margin.model_pos_order
msgid "Point of Sale Orders"
msgstr "Punto di riordino"
#. module: pos_margin
#: model:ir.model,name:pos_margin.model_report_pos_order
#, fuzzy
msgid "Point of Sale Orders Statistics"
msgstr "Punto di riordino"

67
pos_margin/i18n/nl_NL.po

@ -0,0 +1,67 @@
# Translation of Odoo Server.
# This file contains the translation of the following modules:
# * pos_margin
#
# Translators:
# Peter Hageman <hageman.p@gmail.com>, 2017
msgid ""
msgstr ""
"Project-Id-Version: Odoo Server 10.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2017-05-30 02:44+0000\n"
"PO-Revision-Date: 2017-05-30 02:44+0000\n"
"Last-Translator: Peter Hageman <hageman.p@gmail.com>, 2017\n"
"Language-Team: Dutch (Netherlands) (https://www.transifex.com/oca/"
"teams/23907/nl_NL/)\n"
"Language: nl_NL\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"
#. module: pos_margin
#: model:ir.model.fields,field_description:pos_margin.field_pos_order_line_purchase_price
msgid "Cost Price"
msgstr "Kostprijs"
#. module: pos_margin
#: model:ir.model.fields,help:pos_margin.field_pos_order_margin
msgid ""
"It gives profitability by calculating the difference between the Unit Price "
"and the cost price."
msgstr ""
#. module: pos_margin
#: model:ir.model,name:pos_margin.model_pos_order_line
#, fuzzy
msgid "Lines of Point of Sale Orders"
msgstr "Kassaorders"
#. module: pos_margin
#: model:ir.model.fields,field_description:pos_margin.field_pos_order_line_margin
#: model:ir.model.fields,field_description:pos_margin.field_pos_order_margin
msgid "Margin"
msgstr "Marge"
#. module: pos_margin
#: model:ir.model.fields,field_description:pos_margin.field_report_pos_order_margin_rate
#, fuzzy
msgid "Margin Rate"
msgstr "Marge"
#. module: pos_margin
#: model:ir.model.fields,field_description:pos_margin.field_report_pos_order_margin_total
#, fuzzy
msgid "Margin Total"
msgstr "Marge"
#. module: pos_margin
#: model:ir.model,name:pos_margin.model_pos_order
msgid "Point of Sale Orders"
msgstr "Kassaorders"
#. module: pos_margin
#: model:ir.model,name:pos_margin.model_report_pos_order
#, fuzzy
msgid "Point of Sale Orders Statistics"
msgstr "Kassaorders"

57
pos_margin/i18n/pos_margin.pot

@ -0,0 +1,57 @@
# Translation of Odoo Server.
# This file contains the translation of the following modules:
# * pos_margin
#
msgid ""
msgstr ""
"Project-Id-Version: Odoo Server 12.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_margin
#: model:ir.model.fields,field_description:pos_margin.field_pos_order_line__purchase_price
msgid "Cost Price"
msgstr ""
#. module: pos_margin
#: model:ir.model.fields,help:pos_margin.field_pos_order__margin
msgid "It gives profitability by calculating the difference between the Unit Price and the cost price."
msgstr ""
#. module: pos_margin
#: model:ir.model.fields,field_description:pos_margin.field_pos_order__margin
#: model:ir.model.fields,field_description:pos_margin.field_pos_order_line__margin
msgid "Margin"
msgstr ""
#. module: pos_margin
#: model:ir.model.fields,field_description:pos_margin.field_report_pos_order__margin_rate
msgid "Margin Rate"
msgstr ""
#. module: pos_margin
#: model:ir.model.fields,field_description:pos_margin.field_report_pos_order__margin_total
#: model_terms:ir.ui.view,arch_db:pos_margin.view_pos_order_tree
msgid "Margin Total"
msgstr ""
#. module: pos_margin
#: model:ir.model,name:pos_margin.model_pos_order_line
msgid "Point of Sale Order Lines"
msgstr ""
#. module: pos_margin
#: model:ir.model,name:pos_margin.model_pos_order
msgid "Point of Sale Orders"
msgstr ""
#. module: pos_margin
#: model:ir.model,name:pos_margin.model_report_pos_order
msgid "Point of Sale Orders Report"
msgstr ""

2
pos_margin/models/__init__.py

@ -0,0 +1,2 @@
from . import pos_order
from . import pos_order_line

23
pos_margin/models/pos_order.py

@ -0,0 +1,23 @@
# Copyright (C) 2017 - Today: GRAP (http://www.grap.coop)
# @author: Sylvain LE GAL (https://twitter.com/legalsylvain)
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
from odoo import api, fields, models
import odoo.addons.decimal_precision as dp
class PosOrder(models.Model):
_inherit = 'pos.order'
# Columns Section
margin = fields.Float(
'Margin', compute='_compute_margin', store=True,
digits=dp.get_precision('Product Price'),
help="It gives profitability by calculating the difference between"
" the Unit Price and the cost price.")
# Compute Section
@api.depends('lines.margin')
def _compute_margin(self):
for order in self:
order.margin = sum(order.mapped('lines.margin'))

41
pos_margin/models/pos_order_line.py

@ -0,0 +1,41 @@
# Copyright (C) 2017 - Today: GRAP (http://www.grap.coop)
# @author: Sylvain LE GAL (https://twitter.com/legalsylvain)
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
from odoo import api, fields, models
import odoo.addons.decimal_precision as dp
class PosOrderLine(models.Model):
_inherit = 'pos.order.line'
# Columns Section
margin = fields.Float(
'Margin', compute='_compute_multi_margin', store=True,
multi='multi_margin', digits=dp.get_precision('Product Price'))
purchase_price = fields.Float(
'Cost Price', compute='_compute_multi_margin', store=True,
multi='multi_margin', digits=dp.get_precision('Product Price'))
# Compute Section
@api.depends('product_id', 'qty', 'price_subtotal')
def _compute_multi_margin(self):
for line in self.filtered('product_id'):
purchase_price = self._get_purchase_price(line)
line.purchase_price = purchase_price
line.margin = line.price_subtotal - (purchase_price * line.qty)
@api.model
def _get_purchase_price(self, line):
# We call _get_purchase_price from sale_margin module, to reuse
# computation that handles multi currencies context and UoM
SaleOrderLine = self.env['sale.order.line']
# if used in combination with module which does add the uom_id to line
uom = hasattr(line, 'uom_id') and line.uom_id\
or line.product_id.uom_id
return SaleOrderLine._get_purchase_price(
line.order_id.pricelist_id, line.product_id, uom,
line.order_id.date_order)['purchase_price']

3
pos_margin/readme/CONTRIBUTORS.rst

@ -0,0 +1,3 @@
* Sylvain LE GAL (https://twitter.com/legalsylvain)
* Wolfgang Pichler
* Murtaza Mithaiwala (https://twitter.com/MurtazaMithaiw4)

5
pos_margin/readme/DESCRIPTION.rst

@ -0,0 +1,5 @@
This module extends the functionality of point of sale to support margin on
pos orders.
This gives the profitability by calculating the difference between the Unit
Price and Cost Price.

8
pos_margin/readme/HISTORY.rst

@ -0,0 +1,8 @@
13.0.1.0.0
~~~~~~~~~~
* Migrate to V13.0
* Reuse ``sale_margin`` computation to handle multi currency context.
* Correct computation of margin, if a module that adds ``uom_id`` on
``pos.order.line`` is installed.
* Add test

7
pos_margin/readme/ROADMAP.rst

@ -0,0 +1,7 @@
This module depends on ``sale_margin`` module to reuse algorithm present in the
function ``_get_purchase_price`` of the model ``sale.order.line`` to
compute correctly purchase price, in a multicurrency context.
This dependency can be removed, when Odoo Core will be correctly refactored,
moving this ``@api.model`` function in a more generic module (``account``
for exemple).

7
pos_margin/readme/USAGE.rst

@ -0,0 +1,7 @@
To use this module, you need to:
* Go to 'Point Of Sale' / 'Orders' / 'Orders'
* Open an order
.. figure:: ../static/description/pos_order_form.png
:width: 800px

2
pos_margin/report/__init__.py

@ -0,0 +1,2 @@
from . import pos_order_report

15
pos_margin/report/pos_order_report.py

@ -0,0 +1,15 @@
from odoo import fields, models
class PosOrderReport(models.Model):
_inherit = 'report.pos.order'
margin_total = fields.Float(string='Margin Total')
margin_rate = fields.Float(string='Margin Rate', group_operator='avg')
def _select(self):
return super(PosOrderReport, self)._select() + """,
SUM(l.margin) as margin_total,
(SUM(l.margin / nullif(l.qty,0)) * 100 /
SUM(nullif(l.purchase_price,0)))::decimal as margin_rate
"""

BIN
pos_margin/static/description/icon.png

After

Width: 128  |  Height: 128  |  Size: 9.2 KiB

463
pos_margin/static/description/index.html

@ -0,0 +1,463 @@
<?xml version="1.0" encoding="utf-8" ?>
<!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 0.15.1: http://docutils.sourceforge.net/" />
<title>PoS Order Margin</title>
<style type="text/css">
/*
:Author: David Goodger (goodger@python.org)
:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
:Copyright: This stylesheet has been placed in the public domain.
Default cascading style sheet for the HTML output of Docutils.
See http://docutils.sf.net/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-order-margin">
<h1 class="title">PoS Order Margin</h1>
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<p><a class="reference external" 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" 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" href="https://github.com/OCA/pos/tree/12.0/pos_margin"><img alt="OCA/pos" src="https://img.shields.io/badge/github-OCA%2Fpos-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/pos-12-0/pos-12-0-pos_margin"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/184/12.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
<p>This module extends the functionality of point of sale to support margin on
pos orders.</p>
<p>This gives the profitability by calculating the difference between the Unit
Price and Cost Price.</p>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#usage" id="id2">Usage</a></li>
<li><a class="reference internal" href="#known-issues-roadmap" id="id3">Known issues / Roadmap</a></li>
<li><a class="reference internal" href="#changelog" id="id4">Changelog</a><ul>
<li><a class="reference internal" href="#id1" id="id5">12.0.1.0.0</a></li>
</ul>
</li>
<li><a class="reference internal" href="#bug-tracker" id="id6">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id7">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id8">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id9">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="id10">Maintainers</a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="usage">
<h1><a class="toc-backref" href="#id2">Usage</a></h1>
<p>To use this module, you need to:</p>
<ul class="simple">
<li>Go to ‘Point Of Sale’ / ‘Orders’ / ‘Orders’</li>
<li>Open an order</li>
</ul>
<div class="figure">
<img alt="https://raw.githubusercontent.com/OCA/pos/12.0/pos_margin/static/description/pos_order_form.png" src="https://raw.githubusercontent.com/OCA/pos/12.0/pos_margin/static/description/pos_order_form.png" style="width: 800px;" />
</div>
</div>
<div class="section" id="known-issues-roadmap">
<h1><a class="toc-backref" href="#id3">Known issues / Roadmap</a></h1>
<p>This module depends on <tt class="docutils literal">sale_margin</tt> module to reuse algorithm present in the
function <tt class="docutils literal">_get_purchase_price</tt> of the model <tt class="docutils literal">sale.order.line</tt> to
compute correctly purchase price, in a multicurrency context.</p>
<p>This dependency can be removed, when Odoo Core will be correctly refactored,
moving this <tt class="docutils literal">&#64;api.model</tt> function in a more generic module (<tt class="docutils literal">account</tt>
for exemple).</p>
</div>
<div class="section" id="changelog">
<h1><a class="toc-backref" href="#id4">Changelog</a></h1>
<div class="section" id="id1">
<h2><a class="toc-backref" href="#id5">13.0.1.0.0</a></h2>
<ul class="simple">
<li>Migrate to V13.0</li>
<li>Reuse <tt class="docutils literal">sale_margin</tt> computation to handle multi currency context.</li>
<li>Correct computation of margin, if a module that adds <tt class="docutils literal">uom_id</tt> on
<tt class="docutils literal">pos.order.line</tt> is installed.</li>
<li>Add test</li>
</ul>
</div>
</div>
<div class="section" id="bug-tracker">
<h1><a class="toc-backref" href="#id6">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 smashing it by providing a detailed and welcomed
<a class="reference external" href="https://github.com/OCA/pos/issues/new?body=module:%20pos_margin%0Aversion:%2012.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="#id7">Credits</a></h1>
<div class="section" id="authors">
<h2><a class="toc-backref" href="#id8">Authors</a></h2>
<ul class="simple">
<li>GRAP</li>
</ul>
</div>
<div class="section" id="contributors">
<h2><a class="toc-backref" href="#id9">Contributors</a></h2>
<ul class="simple">
<li>Sylvain LE GAL (<a class="reference external" href="https://twitter.com/legalsylvain">https://twitter.com/legalsylvain</a>)</li>
<li>Wolfgang Pichler</li>
<li>Murtaza Mithaiwala (<a class="reference external" href="https://twitter.com/MurtazaMithaiw4">https://twitter.com/MurtazaMithaiw4</a>)</li>
</ul>
</div>
<div class="section" id="maintainers">
<h2><a class="toc-backref" href="#id10">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/13.0/pos_margin">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>

BIN
pos_margin/static/description/pos_order_form.png

After

Width: 896  |  Height: 379  |  Size: 30 KiB

1
pos_margin/tests/__init__.py

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

67
pos_margin/tests/test_module.py

@ -0,0 +1,67 @@
# Copyright 2019 - Today Sylvain LE GAL (https://twitter.com/legalsylvain)
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
from odoo import fields
from odoo.tests.common import TransactionCase
class TestModule(TransactionCase):
def setUp(self):
super(TestModule, self).setUp()
self.PosOrder = self.env['pos.order']
self.pos_product = self.env.ref('point_of_sale.whiteboard_pen')
self.pricelist = self.env.ref('product.list0')
# Create a new pos config and open it
self.pos_config = self.env.ref('point_of_sale.pos_config_main').copy()
self.pos_config.open_session_cb()
def test_margin(self):
self.pos_product.list_price = 1.8
self.pos_product.standard_price = 0.5
order = self._create_order()
self.assertEqual(
order.margin, 10 * (1.8 - 0.5),
"Bad computation of margin")
def _create_order(self):
# Create order
order_data = {
'id': u'0006-001-0010',
'to_invoice': False,
'data': {
'pricelist_id': self.pricelist.id,
'user_id': 1,
'name': 'Order 0006-001-0010',
'partner_id': False,
'amount_paid': 0.9,
'pos_session_id': self.pos_config.current_session_id.id,
'lines': [[0, 0, {
'product_id': self.pos_product.id,
'price_unit': self.pos_product.list_price,
'qty': 10,
'price_subtotal': 18.0,
'price_subtotal_incl': 18.0,
}]],
'statement_ids': [[0, 0, {
'payment_method_id':
self.pos_config.payment_method_ids[0].id,
'amount': 18.0,
'name': fields.Datetime.now(),
'account_id':
self.env.user.partner_id.property_account_receivable_id.id,
'session_id' : self.pos_config.current_session_id.id,
}]],
'creation_date': u'2018-09-27 15:51:03',
'amount_tax': 0,
'fiscal_position_id': False,
'uid': u'00001-001-0001',
'amount_return': 0,
'sequence_number': 1,
'amount_total': 18.0,
}}
result = self.PosOrder.create_from_ui([order_data])
order = self.PosOrder.browse(result[0].get('id'))
return order

33
pos_margin/views/view_pos_order.xml

@ -0,0 +1,33 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (C) 2017 - Today: GRAP (http://www.grap.coop)
@author Sylvain LE GAL (https://twitter.com/legalsylvain)
License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
-->
<odoo>
<record id="view_pos_order_form" model="ir.ui.view">
<field name="model">pos.order</field>
<field name="inherit_id" ref="point_of_sale.view_pos_pos_form"/>
<field name="arch" type="xml">
<field name="amount_total" position="after">
<field name="margin" widget="monetary"/>
</field>
<xpath expr="//field[@name='lines']/tree/field[@name='price_unit']" position="after">
<field name="purchase_price" widget="monetary"/>
</xpath>
</field>
</record>
<record id="view_pos_order_tree" model="ir.ui.view">
<field name="model">pos.order</field>
<field name="inherit_id" ref="point_of_sale.view_pos_order_tree"/>
<field name="arch" type="xml">
<field name="amount_total" position="before">
<field name="margin" widget="monetary" sum="Margin Total"/>
</field>
</field>
</record>
</odoo>
Loading…
Cancel
Save