Go to file
Sergio Morillo 1324b4e518 "Define image policy in drone.yml [SKIP CI]." 2021-02-11 20:44:00 +01:00
doc Allow UoM conversion between different categories 2019-07-08 17:34:44 +02:00
icons Use material design icons 2018-08-19 20:02:58 +02:00
locale Update translations 2019-05-01 18:05:24 +02:00
tests Allow UoM conversion between different categories 2019-07-08 17:34:44 +02:00
view Add variants on list view 2019-06-16 15:42:42 +02:00
.drone.yml "Define image policy in drone.yml [SKIP CI]." 2021-02-11 20:44:00 +01:00
CHANGELOG Allow UoM conversion between different categories 2019-07-08 17:34:44 +02:00
COPYRIGHT Prepare release 5.2.0 2019-05-06 15:05:21 +02:00
LICENSE Use GPLv3 2008-09-24 14:54:39 +02:00
MANIFEST.in Merge README and doc and remove INSTALL 2019-04-06 17:38:56 +02:00
README.rst Merge README and doc and remove INSTALL 2019-04-06 17:38:56 +02:00
__init__.py Add product identifiers 2019-06-06 19:20:43 +02:00
category.py Use tree mixin 2018-05-12 00:49:18 +02:00
category.xml Remove safe_eval 2015-03-09 19:41:50 +01:00
configuration.py Remove Property fields 2017-04-01 00:31:59 +02:00
configuration.xml Remove Property fields 2017-04-01 00:31:59 +02:00
exceptions.py Add product identifiers 2019-06-06 19:20:43 +02:00
message.xml Add product identifiers 2019-06-06 19:20:43 +02:00
product.py Use ImportError instead of ModuleNotFoundError for py3.5 support 2019-06-06 19:32:36 +02:00
product.xml Add product identifiers 2019-06-06 19:20:43 +02:00
setup.py Add product identifiers 2019-06-06 19:20:43 +02:00
tox.ini "Define image policy in drone.yml [SKIP CI]." 2021-02-11 20:44:00 +01:00
tryton.cfg Add missing message xml file 2019-06-03 16:04:14 +02:00
uom.py Allow UoM conversion between different categories 2019-07-08 17:34:44 +02:00
uom.xml Fix carat conversion ratio 2017-02-14 23:43:04 +01:00

README.rst

Product Module
##############

The Product module defines the following models: Category of Unit of
Measure, Unit of Measure, Product Template, Product and Product
Category.


Category of Unit of Measure
***************************

A Category of Unit of Measure is simply defined by a name.


Unit of Measure
***************

A Unit of Measure is defined by:

- Name.
- Symbol.
- UOM category.
- Rate and a Factor (the later is the inverse of the former).
- Rounding Precision and Display Digits, used to round and display
  quantities expressed in the given UOM.
- Active, allow to disable a UOM.


Product category
****************

The Product Category Model is just composed of a name. Product
Categories are organised in a tree structure.


Product Template and Product
****************************

The product concept in Tryton is composed of two models: Product
Template and Product.

The Product Template model contains the following fields: 

- Name.
- Type, whose value can be *Goods*, *Assets*, *Service*.
- Category.
- List Price, the default sale price expressed in the List Price UOM.
  product.
- List Price UOM.
- Cost Price, the cost for one unit of this product expressed in the
  Cost Price UOM.
- Cost Price UOM.
- Cost Price Method, which can be *Fixed* or *Average*. Defines how
  the cost price should be updated. *Fixed* means that the cost price
  stay unchanged. *Average* means that the cost price is the average
  cost of all the items that are in stock.
- Default UOM. The default UOM for this product. Used for example to
  express stock levels.
- Active, allow to disable a product.


The Product model extend the Product Template with two fields: Code
and Description. It's also possible to define a list of identifiers on product.
An identifier is composed by a type and a code. The following types are
available:

    * International Article Number (EAN)
    * International Standard Audiovisual Number (ISAN)
    * International Standard Book Number (ISBN)
    * International Standard Identifier for Libraries (ISIL)
    * International Securities Identification Number (ISIN)
    * International Standard Music Number (ISMN)

Configuration
*************

The product module uses the section `product` to retrieve some parameters:

- `price_decimal`: defines the number of decimal digits with which the unit
  prices are stored. The default value is `4`.

- `uom_conversion_decimal`: defines the number of decimal digits with which the
  conversion rates and factors of UoM are stored. The default value is `12`.

.. warning::
    They can not be lowered once a database is created.
..