Skip to content

Commit

Permalink
fixup! Fix Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
etobella committed Jan 8, 2024
1 parent b120350 commit aff8cec
Show file tree
Hide file tree
Showing 3 changed files with 51 additions and 12 deletions.
20 changes: 20 additions & 0 deletions pos_order_split_invoice/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,26 @@ be confusing.
.. contents::
:local:

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

Before using this module, you need to define pricelists and set them
complex. In order to do that, might be necessary to install **Sale**
App.

After that, you need to create a Pricelist with a Splitting partner
configured and a rule with type **Split Invoice**. On that rule you need
to set the base pricelist used to compute the total price, the pricelist
used to split and the amount payed by the splitting partner.

For example, if we have a Product with a Pricelist A of 100 and a
Pricelist B of 80, and we specify that we use Pricelist A and the
splitting partner pays 90% of Pricelist B, the final amount payed by the
Customer will be: 100 - 80*90% = 28.

All the pricelists must be included on the Point Of Sale Configuration
in order to proceed properly with the calculation.

Usage
=====

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,5 @@ After that, you need to create a Pricelist with a Splitting partner configured a
On that rule you need to set the base pricelist used to compute the total price, the pricelist used to split and the amount payed by the splitting partner.

For example, if we have a Product with a Pricelist A of 100 and a Pricelist B of 80, and we specify that we use Pricelist A and the splitting partner pays 90% of Pricelist B, the final amount payed by the Customer will be: 100 - 80*90% = 28.

All the pricelists must be included on the Point Of Sale Configuration in order to proceed properly with the calculation.
41 changes: 29 additions & 12 deletions pos_order_split_invoice/static/description/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -380,48 +380,65 @@ <h1 class="title">Pos Split Invoice</h1>
<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="toc-entry-1">Usage</a></li>
<li><a class="reference internal" href="#bug-tracker" id="toc-entry-2">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="toc-entry-3">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="toc-entry-4">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="toc-entry-5">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="toc-entry-6">Maintainers</a></li>
<li><a class="reference internal" href="#configuration" id="toc-entry-1">Configuration</a></li>
<li><a class="reference internal" href="#usage" id="toc-entry-2">Usage</a></li>
<li><a class="reference internal" href="#bug-tracker" id="toc-entry-3">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="toc-entry-4">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="toc-entry-5">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="toc-entry-6">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="toc-entry-7">Maintainers</a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="configuration">
<h1><a class="toc-backref" href="#toc-entry-1">Configuration</a></h1>
<p>Before using this module, you need to define pricelists and set them
complex. In order to do that, might be necessary to install <strong>Sale</strong>
App.</p>
<p>After that, you need to create a Pricelist with a Splitting partner
configured and a rule with type <strong>Split Invoice</strong>. On that rule you need
to set the base pricelist used to compute the total price, the pricelist
used to split and the amount payed by the splitting partner.</p>
<p>For example, if we have a Product with a Pricelist A of 100 and a
Pricelist B of 80, and we specify that we use Pricelist A and the
splitting partner pays 90% of Pricelist B, the final amount payed by the
Customer will be: 100 - 80*90% = 28.</p>
<p>All the pricelists must be included on the Point Of Sale Configuration
in order to proceed properly with the calculation.</p>
</div>
<div class="section" id="usage">
<h1><a class="toc-backref" href="#toc-entry-1">Usage</a></h1>
<h1><a class="toc-backref" href="#toc-entry-2">Usage</a></h1>
<p>Change the amount pricelist of products to a splitting one and the
amount will be correctly computed on PoS.</p>
<p>After PoS validation, the invoice to the splitting partner will be
created.</p>
</div>
<div class="section" id="bug-tracker">
<h1><a class="toc-backref" href="#toc-entry-2">Bug Tracker</a></h1>
<h1><a class="toc-backref" href="#toc-entry-3">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 to smash it by providing a detailed and welcomed
<a class="reference external" href="https://github.com/OCA/pos/issues/new?body=module:%20pos_order_split_invoice%0Aversion:%2017.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="#toc-entry-3">Credits</a></h1>
<h1><a class="toc-backref" href="#toc-entry-4">Credits</a></h1>
<div class="section" id="authors">
<h2><a class="toc-backref" href="#toc-entry-4">Authors</a></h2>
<h2><a class="toc-backref" href="#toc-entry-5">Authors</a></h2>
<ul class="simple">
<li>Dixmit</li>
<li>INVITU</li>
</ul>
</div>
<div class="section" id="contributors">
<h2><a class="toc-backref" href="#toc-entry-5">Contributors</a></h2>
<h2><a class="toc-backref" href="#toc-entry-6">Contributors</a></h2>
<ul class="simple">
<li>Enric Tobella</li>
</ul>
</div>
<div class="section" id="maintainers">
<h2><a class="toc-backref" href="#toc-entry-6">Maintainers</a></h2>
<h2><a class="toc-backref" href="#toc-entry-7">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
Expand Down

0 comments on commit aff8cec

Please sign in to comment.