Update documentation of account stock landed cost

This commit is contained in:
Cédric Krier
2024-10-17 10:41:39 +02:00
parent 4fb1f4b277
commit 2b188f1f0a
5 changed files with 118 additions and 22 deletions
@@ -21,18 +21,22 @@ Version 6.6.0 - 2022-10-31
* Show cost allocation before and after posting
Version 6.4.0 - 2022-05-02
--------------------------
* Bug fixes (see mercurial logs for details)
* Add support for Python 3.10
* Remove support for Python 3.6
* Store allocation factors
Version 6.2.0 - 2021-11-01
--------------------------
* Bug fixes (see mercurial logs for details)
Version 6.0.0 - 2021-05-03
--------------------------
* Bug fixes (see mercurial logs for details)
Version 5.8.0 - 2020-11-02
--------------------------
* Bug fixes (see mercurial logs for details)
* Remove support for Python 3.5
* Add stock move filter per category and product
@@ -41,35 +45,45 @@ Version 5.8.0 - 2020-11-02
* Rename landed cost state from cancel to cancelled
Version 5.6.0 - 2020-05-04
--------------------------
* Bug fixes (see mercurial logs for details)
Version 5.4.0 - 2019-11-04
--------------------------
* Bug fixes (see mercurial logs for details)
Version 5.2.0 - 2019-05-06
--------------------------
* Bug fixes (see mercurial logs for details)
Version 5.0.0 - 2018-10-01
--------------------------
* Bug fixes (see mercurial logs for details)
* Remove support for Python 2.7
Version 4.8.0 - 2018-04-23
--------------------------
* Bug fixes (see mercurial logs for details)
Version 4.6.0 - 2017-10-30
--------------------------
* Bug fixes (see mercurial logs for details)
* Move landed_cost inside checkboxes group
Version 4.4.0 - 2017-05-01
--------------------------
* Bug fixes (see mercurial logs for details)
Version 4.2.0 - 2016-11-28
--------------------------
* Bug fixes (see mercurial logs for details)
Version 4.0.0 - 2016-05-02
--------------------------
* Bug fixes (see mercurial logs for details)
* Rename Landed Cost code into number
* Add Python3 support
Version 3.8.0 - 2015-11-02
--------------------------
* Initial release
@@ -0,0 +1,83 @@
******
Design
******
The *Account Stock Landed Cost Module* introduces and extends the following
concepts:
.. _model-account.landed_cost:
Landed Cost
===========
The *Landed Cost* defines how posted supplier `Invoice
<account_invoice:model-account.invoice>` lines with landed cost `Products
<concept-product>` are allocated to `Supplier Shipments
<stock:model-stock.shipment.in>`.
When a *Landed Cost* is posted, the :guilabel:`Unit Price` of each incoming
`Move <stock:model-stock.move>` from the supplier shipments is updated
according to the :guilabel:`Allocation Method`.
The default allocation method is :guilabel:`By Value` which allocates the cost
according to the value of each incoming move calculated as the
:guilabel:`Quantity` times the :guilabel:`Unit Price`.
.. note::
The updated incoming moves can be filtered by `Categories
<product:model-product.category>` or by `Products
<product:model-product.product>`.
.. seealso::
The Landed Costs can be found by opening the main menu item:
|Financial --> Invoices --> Landed Costs|__
.. |Financial --> Invoices --> Landed Costs| replace:: :menuselection:`Financial --> Invoices --> Landed Costs`
__ https://demo.tryton.org/model/account.landed_cost
Wizards
-------
.. _wizard-account.landed_cost.post:
Post
^^^^
The *Post* wizard first shows how the costs will be allocated before posting
the *Landed Cost*.
.. _wizard-account.landed_cost.show:
Show
^^^^
The *Show* wizard displays the allocation that was applied by a posted *Landed
Cost*.
.. _model-account.configuration:
Account Configuration
=====================
When the *Account Stock Landed Cost Module* is activated, a `Sequence
<trytond:model-ir.sequence>` is set up in the *Account Configuration* to number
the `Landed Costs <model-account.landed_cost>`.
.. seealso::
The `Account Configuration <account:model-account.configuration>` concept is
introduced by the :doc:`Account Module <account:index>`.
.. _concept-product:
Product
=======
When the *Account Stock Landed Cost Module* is activated, *Products* gain an
additional property that is used to mark which services are a landed cost.
.. seealso::
The `Product <product:concept-product>` concept is introduced by the
:doc:`Product Module <product:index>`.
@@ -1,25 +1,12 @@
################################
Account Stock Landed Cost Module
################################
The account_stock_landed_cost module allows to allocate landed cost on
*Supplier Shipments* after their reception.
The *Account Stock Landed Cost Module* allows the allocation of the landed
costs to supplier shipments after they have been received.
A new field is added to *Product*:
.. toctree::
:maxdepth: 2
- *Landed Cost*: Only available for service, it allows such invoiced product to
be used as a landed cost.
A new document *Landed Cost* defines how posted supplier invoice lines are
allocated to many shipments.
The allocation methods are:
- *By Value*: The cost will be allocated according to the value of each
line. (The value is: *Quantity* * *Unit *Price*)
Once posted, the *Landed Cost* updates the unit price of each incoming moves of
the shipments using the cost of all the invoice lines according to the
allocation method.
To update the cost price, the *Update Cost Price* wizard must be run on the
affected products.
design
releases
@@ -0,0 +1,7 @@
.. _releases-index:
=============
Release notes
=============
.. include:: ../CHANGELOG
+7 -2
View File
@@ -11,9 +11,12 @@ from setuptools import find_packages, setup
def read(fname):
return io.open(
content = io.open(
os.path.join(os.path.dirname(__file__), fname),
'r', encoding='utf-8').read()
content = re.sub(
r'(?m)^\.\. toctree::\r?\n((^$|^\s.*$)\r?\n)*', '', content)
return content
def get_require_version(name):
@@ -59,7 +62,9 @@ setup(name=name,
download_url=download_url,
project_urls={
"Bug Tracker": 'https://bugs.tryton.org/',
"Documentation": 'https://docs.tryton.org/',
"Documentation": (
'https://docs.tryton.org/latest/'
'modules-account-stock-landed-cost'),
"Forum": 'https://www.tryton.org/forum',
"Source Code": 'https://code.tryton.org/tryton',
},