Skip to content

Commit

Permalink
Merge PR #769 into 15.0
Browse files Browse the repository at this point in the history
Signed-off-by thomaspaulb
  • Loading branch information
OCA-git-bot committed Jul 14, 2023
2 parents 2efe623 + ffa22fd commit f0e5a69
Show file tree
Hide file tree
Showing 12 changed files with 657 additions and 0 deletions.
106 changes: 106 additions & 0 deletions report_qweb_decimal_place/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
=========================
Report Qweb Decimal Place
=========================

.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! 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-LGPL--3-blue.png
:target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
:alt: License: LGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Freporting--engine-lightgray.png?logo=github
:target: https://github.com/OCA/reporting-engine/tree/15.0/report_qweb_decimal_place
:alt: OCA/reporting-engine
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/reporting-engine-15-0/reporting-engine-15-0-report_qweb_decimal_place
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
:target: https://runbot.odoo-community.org/runbot/143/15.0
:alt: Try me on Runbot

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

This module intends to provide the base function for currencies to adjust the number of decimal places
for the unit price in QWeb reports.
Installing this module alone does not affect the presentation of existing QWeb reports.
Individual adjustments need to be done in separate modules in a manner similar to the following:

.. code-block:: xml
<template
id="report_saleorder_document_inherit"
inherit_id="sale.report_saleorder_document"
>
<xpath expr="//td[@name='td_priceunit']/span" position="replace">
<t t-set="currency" t-value="doc.currency_id" />
<t t-set="price_unit" t-value="line.price_unit" />
<t t-call="report_qweb_decimal_place.price_unit_value_format" />
</xpath>
</template>
Background:
~~~~~~~~~~~

Odoo default reports display price unit with the decimal accuracy of product price configuration.
However, globally applying the decimal accuracy setting is sometimes not appropriate under multi-currency settings
where how unit prices should be presented differs depending on the currency.

For example, unit prices in JPY usually do not have decimals (with some exceptions depending on the industry),
while those in USD may require up to 2-4 decimals. If we configure the decimal accuracy based on USD, the unit price
presentation on PDF reports for JPY transactions may appear a bit unconventional.

**Table of contents**

.. contents::
:local:

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

To apply price unit format:

#. Go to Invoicing --> Configuration --> Currencies
#. Check apply_price_decimal_place field
#. Define decimal place in price_decimal_place field

Inherit this module in your xxx_report_qweb_decimal_place module and format the price unit in reports.

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

Bugs are tracked on `GitHub Issues <https://github.com/OCA/reporting-engine/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/reporting-engine/issues/new?body=module:%20report_qweb_decimal_place%0Aversion:%2015.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
~~~~~~~

* Quartile Limited

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/reporting-engine <https://github.com/OCA/reporting-engine/tree/15.0/report_qweb_decimal_place>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
1 change: 1 addition & 0 deletions report_qweb_decimal_place/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
from . import models
16 changes: 16 additions & 0 deletions report_qweb_decimal_place/__manifest__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Copyright 2022 Quartile Limited
# License LGPL-3.0 or later (https://www.gnu.org/licenses/lgpl).
{
"name": "Report Qweb Decimal Place",
"category": "Reporting",
"version": "15.0.1.0.0",
"author": "Quartile Limited, Odoo Community Association (OCA)",
"website": "https://github.com/OCA/reporting-engine",
"license": "LGPL-3",
"depends": ["base"],
"data": [
"reports/price_unit_value_format.xml",
"views/res_currency_views.xml",
],
"installable": True,
}
1 change: 1 addition & 0 deletions report_qweb_decimal_place/models/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
from . import res_currency
16 changes: 16 additions & 0 deletions report_qweb_decimal_place/models/res_currency.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Copyright 2022 Quartile Limited
# License LGPL-3.0 or later (https://www.gnu.org/licenses/lgpl).

from odoo import fields, models


class ResCurrency(models.Model):
_inherit = "res.currency"

apply_price_decimal_place = fields.Boolean(
help="Apply this decimal place to the unit price field of relevant PDF reports "
"where appropriate customization is done."
)
price_decimal_places = fields.Integer(
help="Define decimal places for the unit price field of relevant PDF reports"
)
7 changes: 7 additions & 0 deletions report_qweb_decimal_place/readme/CONFIGURE.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
To apply price unit format:

#. Go to Invoicing --> Configuration --> Currencies
#. Check apply_price_decimal_place field
#. Define decimal place in price_decimal_place field

Inherit this module in your xxx_report_qweb_decimal_place module and format the price unit in reports.
28 changes: 28 additions & 0 deletions report_qweb_decimal_place/readme/DESCRIPTION.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
This module intends to provide the base function for currencies to adjust the number of decimal places
for the unit price in QWeb reports.
Installing this module alone does not affect the presentation of existing QWeb reports.
Individual adjustments need to be done in separate modules in a manner similar to the following:

.. code-block:: xml
<template
id="report_saleorder_document_inherit"
inherit_id="sale.report_saleorder_document"
>
<xpath expr="//td[@name='td_priceunit']/span" position="replace">
<t t-set="currency" t-value="doc.currency_id" />
<t t-set="price_unit" t-value="line.price_unit" />
<t t-call="report_qweb_decimal_place.price_unit_value_format" />
</xpath>
</template>
Background:
~~~~~~~~~~~

Odoo default reports display price unit with the decimal accuracy of product price configuration.
However, globally applying the decimal accuracy setting is sometimes not appropriate under multi-currency settings
where how unit prices should be presented differs depending on the currency.

For example, unit prices in JPY usually do not have decimals (with some exceptions depending on the industry),
while those in USD may require up to 2-4 decimals. If we configure the decimal accuracy based on USD, the unit price
presentation on PDF reports for JPY transactions may appear a bit unconventional.
15 changes: 15 additions & 0 deletions report_qweb_decimal_place/reports/price_unit_value_format.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<?xml version="1.0" encoding="utf-8" ?>
<odoo>
<template id="price_unit_value_format">
<t t-if="currency.apply_price_decimal_place">
<span
class="text-nowrap"
t-esc="price_unit"
t-options='{"widget": "float", "precision": currency.price_decimal_places}'
/>
</t>
<t t-else="">
<span class="text-nowrap" t-field="line.price_unit" />
</t>
</template>
</odoo>
Loading

0 comments on commit f0e5a69

Please sign in to comment.