Update documentation of sale complaint

2025-12-15 11:58:01 +01:00
parent 626c61b3c1
commit 044ad2f1c0
4 changed files with 90 additions and 42 deletions
@@ -42,56 +42,70 @@ Version 6.6.0 - 2022-10-31
 * Remove address on complaint

 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

 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)
 * Make an invoice correction for credit note action
 * Compute amount of complaint action
 * Add active field to complaint type

 Version 5.8.0 - 2020-11-02
+--------------------------
 * Bug fixes (see mercurial logs for details)
 * Remove support for Python 3.5

 Version 5.6.0 - 2020-05-04
+--------------------------
 * Bug fixes (see mercurial logs for details)
 * Allow partial return sale and credit invoice
 * Allow entering origin before customer

 Version 5.4.0 - 2019-11-04
+--------------------------
 * Bug fixes (see mercurial logs for details)
 * Use processing delay to process approved complaint
 * Allow reset to draft approved and rejected complaint

 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)

 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 Complaint reference into number and add reference
 * Add Python3 support

 Version 3.8.0 - 2015-11-02
+--------------------------
 * Initial release
@@ -0,0 +1,63 @@
+******
+Design
+******
+
+The *Sale Complaint Module* introduces or extends the following concepts:
+
+.. _model-sale.complaint:
+
+Complaint
+=========
+
+A complaint is a customer issue relating to a `sale <sale:model-sale.sale>` or
+`invoice <account_invoice:model-account.invoice>`.
+Each complaint, at any time, can be in one of several different states.
+A complaint progresses through these states until it is either done or gets
+cancelled.
+When a state change occurs, the `Employee <company:model-company.employee>`
+that triggered the change is also recorded.
+
+Each complaint contains details of the `Customer <party:model-party.party>` and
+either the sale, the sale line, the customer invoice or the customer invoice
+line.
+Actions can be registered such as creating a sale return or a credit note,
+which will be processed if the complaint is approved.
+
+.. seealso::
+
+   The list of *Complaints* can be found by opening the main menu item:
+
+      |Sales --> Complaints|__
+
+      .. |Sales --> Complaints| replace:: :menuselection:`Sales --> Complaints`
+      __ https://demo.tryton.org/model/sale.complaint
+
+.. _model-sale.complaint.type:
+
+Complaint Type
+==============
+
+The *Complaint Type* categorises the `complaints <model-sale.complaint>`.
+
+.. seealso::
+
+   The *Complaint Types* can be found by opening the main menu item:
+
+      |Sales --> Configuration --> Customer Complaint --> Types|__
+
+      .. |Sales --> Configuration --> Customer Complaint --> Types| replace:: :menuselection:`Sales --> Configuration --> Customer Complaint --> Types`
+      __ https://demo.tryton.org/model/sale.complaint.type
+
+.. _model-sale.configuration:
+
+Sale Configuration
+==================
+
+When the *Sale Complaint Module* is activated, the sale configuration gains a
+new property to set up the numbering `sequence <trytond:model-ir.sequence>` of
+`complaints <model-sale.complaint>`.
+
+.. seealso::
+
+   The `Sale Configuration <sale:model-sale.configuration>` concept is
+   introduced by the :doc:`Sale Module <sale:index>`.
@@ -1,47 +1,11 @@
+#####################
 Sale Complaint Module
 #####################

-The sale_complaint module defines Complaint model.
+The *Sale Complaint Module* handles complaints relating to sales.

-Complaint
-*********
+.. toctree::
+    :maxdepth: 2

-The complaint is mainly defined by a customer which complains about a sale or
-an invoice. Actions can be taken to solve the complaint. Here is the extensive
-list of the fields, most of them are optional:
-
- Customer: The customer.
- Address: The main address of the customer.
- Date: The date the complaint is filled.
- Number: The internal reference of the complaint (will be generated
-  automatically on creation).
- Reference: The optional external reference of the complaint.
- Employee: The employee responsible of the complaint.
- Type: The type of complaint
- Origin: The original document for which the complaint if filled.
- Company: The company against which the complaint is filled.
- Description: The description of the complaint.
- Actions: The actions to take to solve it.
- State:
-
-  - Draft
-  - Waiting: The complaint is waiting for approval.
-  - Approved: The complaint has been approved by a sale admin.
-  - Rejected: The complaint has been rejected by a sale admin.
-  - Done: The complaint's actions have been executed.
-  - Cancelled
-
-Action
-******
-
-A complaint action defines an action to execute to solve the complaint.
-There are two types of action: *Create Sale Return* and *Create Credit Note*.
-When the origin of the complaint is a line, only this line will proceeded and
-it will be possible to define the quantity and the unit price otherwise it is
-the all document.
-
-Type
-****
-
-It defines the type of complaint per document: *Sale*, *Sale Line*, *Customer
-Invoice* and *Customer Invoice Line*.
+    design
+    releases
@@ -0,0 +1,7 @@
+.. _releases-index:
+
+=============
+Release notes
+=============
+
+.. include:: ../CHANGELOG