Author: |
Numigi |
License: |
LGPL-3 |
Branch: |
11.0 |
Repository: |
Numigi/odoo-project-addons |
Dependencies: |
analytic_line_revenue,
product,
project,
project_task_analytic_lines,
project_task_type,
project_type,
purchase,
and
web |
Languages: |
JavaScript (307, 16.3%),
LESS (71, 3.8%),
PO File (127, 6.7%),
Python (836, 44.3%),
XML (464, 24.6%),
and
reStructuredText (84, 4.4%) |
Other branches: |
timesheet_analytic_update |
<h1 class="title">Project Cost Report</h1>
<div class="contents topic" id="table-of-contents">
<p class="topic-title">Table of Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#summary" id="id1">Summary</a></li>
<li><a class="reference internal" href="#usage" id="id2">Usage</a></li>
<li><a class="reference internal" href="#header" id="id3">Header</a></li>
<li><a class="reference internal" href="#cost-sections" id="id4">Cost Sections</a><ul>
<li><a class="reference internal" href="#cost-subdivisions-categories" id="id5">Cost Subdivisions (Categories)</a></li>
<li><a class="reference internal" href="#products" id="id6">Products</a></li>
<li><a class="reference internal" href="#time" id="id7">Time</a><ul>
<li><a class="reference internal" href="#employee-column" id="id8">Employee Column</a></li>
</ul>
</li>
<li><a class="reference internal" href="#outsourcing" id="id9">Outsourcing</a></li>
</ul>
</li>
<li><a class="reference internal" href="#unreceived-invoices" id="id10">Unreceived Invoices</a></li>
<li><a class="reference internal" href="#fold-unfold" id="id11">Fold / Unfold</a></li>
<li><a class="reference internal" href="#target-suggested-profit" id="id12">Target / Suggested / Profit</a><ul>
<li><a class="reference internal" href="#target-ratios" id="id13">Target Ratios</a></li>
<li><a class="reference internal" href="#target-hourly-rate" id="id14">Target Hourly Rate</a></li>
<li><a class="reference internal" href="#hide-show-summary" id="id15">Hide / Show Summary</a></li>
</ul>
</li>
<li><a class="reference internal" href="#pdf-version" id="id16">PDF Version</a></li>
<li><a class="reference internal" href="#contributors" id="id17">Contributors</a></li>
</ul>
</div>
<a name="summary"></a>
<h2><a class="toc-backref" href="#id1">Summary</a></h2>
<p>This module adds a dynamic cost report to the <cite>Project</cite> application.</p>
<img alt="static/description/report_overview.png" src="static/description/report_overview.png" />
<a name="usage"></a>
<h2><a class="toc-backref" href="#id2">Usage</a></h2>
<p>To open the report, go to the form view of a project and click on the smart button <cite>Cost Report</cite></p>
<img alt="static/description/project_smart_button.png" src="static/description/project_smart_button.png" />
<a name="header"></a>
<h2><a class="toc-backref" href="#id3">Header</a></h2>
<p>The header of the report contains the following elements:</p>
<ol class="arabic simple">
<li>The print date</li>
<li>The name of the partner related to the project</li>
<li>The project name</li>
<li>The project type (see module project_type from the same repository)</li>
</ol>
<img alt="static/description/report_overview.png" src="static/description/report_overview.png" />
<a name="cost-sections"></a>
<h2><a class="toc-backref" href="#id4">Cost Sections</a></h2>
<p>The body of the report is divided into 2 tables.</p>
<p>The first table contains the costs of the the project.
The amounts are aggregations based on analytic lines.</p>
<img alt="static/description/report_costs.png" src="static/description/report_costs.png" />
<p>These costs are seperated into the following sections:</p>
<ul class="simple">
<li>Products</li>
<li>Time</li>
<li>Outsourcing</li>
</ul>
<p>Each section contains subdivisions that can be folded / unfolded to show / hide the details (analytic lines).</p>
<img alt="static/description/report_subdivision_unfold.png" src="static/description/report_subdivision_unfold.png" />
<p>By clicking on the amount of a subdivision, the list of analytic lines related to this amount is displayed.</p>
<img alt="static/description/subdivision_amount_click.png" src="static/description/subdivision_amount_click.png" />
<img alt="static/description/analytic_line_list.png" src="static/description/analytic_line_list.png" />
<p>By clicking on an analytic line, the form view of the analytic line is opened.</p>
<img alt="static/description/analytic_line_click.png" src="static/description/analytic_line_click.png" />
<img alt="static/description/analytic_line_form.png" src="static/description/analytic_line_form.png" />
<a name="cost-subdivisions-categories"></a>
<h3><a class="toc-backref" href="#id5">Cost Subdivisions (Categories)</a></h3>
<p>The complete list of subdivision (categories) found in the report is available under <code>Project / Configuration</code>.</p>
<img alt="static/description/cost_category_list.png" src="static/description/cost_category_list.png" />
<a name="products"></a>
<h3><a class="toc-backref" href="#id6">Products</a></h3>
<p>This section contains analytic lines with stockable or consumable products.</p>
<p>It is subdivided into cost categories.</p>
<img alt="static/description/report_section_products.png" src="static/description/report_section_products.png" />
<p>These cost categories are defined on product categories.</p>
<img alt="static/description/product_category_form.png" src="static/description/product_category_form.png" />
<blockquote>
The subdivision <cite>Products</cite> is a default category. It includes all products not bound to a specific cost category.</blockquote>
<a name="time"></a>
<h3><a class="toc-backref" href="#id7">Time</a></h3>
<p>This section contains analytic lines from timesheets.</p>
<p>It is subdivided into cost categories.</p>
<img alt="static/description/report_section_time.png" src="static/description/report_section_time.png" />
<p>These categories are defined on task types (see module project_task_type from the same repository).</p>
<img alt="static/description/task_type_form.png" src="static/description/task_type_form.png" />
<blockquote>
The subdivision <cite>Labour</cite> is a default category. It contains all timesheet lines not bound to a specific category.</blockquote>
<a name="employee-column"></a>
<h4><a class="toc-backref" href="#id8">Employee Column</a></h4>
<p>Since version 1.1.0 of the module, the <code>Employee</code> is shown in the <code>Time</code> section.</p>
<img alt="static/description/report_employee_column.png" src="static/description/report_employee_column.png" />
<a name="outsourcing"></a>
<h3><a class="toc-backref" href="#id9">Outsourcing</a></h3>
<p>This section contains analytic lines with products of type service that are not timesheets.</p>
<p>It contains only one subdivision with the same name.</p>
<img alt="static/description/report_section_outsourcing.png" src="static/description/report_section_outsourcing.png" />
<a name="unreceived-invoices"></a>
<h2><a class="toc-backref" href="#id10">Unreceived Invoices</a></h2>
<p>The report contains a special section named <cite>WAITING FOR INVOICES</cite>.</p>
<p>This section contains a list of purchase orders related to the project
for which the supplier invoice has not been received.</p>
<img alt="static/description/report_unreceived_invoices.png" src="static/description/report_unreceived_invoices.png" />
<p>The amount displayed on each line is computed as follow:</p>
<blockquote>
(Ordered Quantity - Invoiced Quantity) * Unit Price</blockquote>
<p>By clicking on the PO number, the form view of the PO is opened.</p>
<img alt="static/description/purchase_order_form.png" src="static/description/purchase_order_form.png" />
<a name="fold-unfold"></a>
<h2><a class="toc-backref" href="#id11">Fold / Unfold</a></h2>
<p>You may fold or unfold every sections of the report by clicking on the
buttons in the control panel of the report.</p>
<img alt="static/description/unfold_button.png" src="static/description/unfold_button.png" />
<a name="target-suggested-profit"></a>
<h2><a class="toc-backref" href="#id12">Target / Suggested / Profit</a></h2>
<p>Since the version 1.3.0 of the module, 3 new columns are added to the report.</p>
<img alt="static/description/report_summary_columns.png" src="static/description/report_summary_columns.png" />
<p>These columns show respectively:</p>
<ul class="simple">
<li>the target sale margin</li>
<li>the suggested sale price based on the target margin</li>
<li>the profit based on the suggested sale price</li>
</ul>
<a name="target-ratios"></a>
<h3><a class="toc-backref" href="#id13">Target Ratios</a></h3>
<p>Under each sections (except TIME), the target is a margin ratio.</p>
<img alt="static/description/product_section_target.png" src="static/description/product_section_target.png" />
<p>This ratio is defined on the cost category.</p>
<img alt="static/description/product_category_sale_ratio.png" src="static/description/product_category_sale_ratio.png" />
<a name="target-hourly-rate"></a>
<h3><a class="toc-backref" href="#id14">Target Hourly Rate</a></h3>
<p>Under the TIME section, the target is an hourly rate.</p>
<img alt="static/description/time_section_target.png" src="static/description/time_section_target.png" />
<p>This hourly rate is defined on the cost category.</p>
<img alt="static/description/time_category_hourly_rate.png" src="static/description/time_category_hourly_rate.png" />
<a name="hide-show-summary"></a>
<h3><a class="toc-backref" href="#id15">Hide / Show Summary</a></h3>
<p>The 3 columns Target / Suggested / Profit can be hidden by clicking on <code>HIDE SUMMARY</code></p>
<img alt="static/description/hide_summary_button.png" src="static/description/hide_summary_button.png" />
<p>They can be displayed again by clicking on <code>SHOW SUMMARY</code>.</p>
<img alt="static/description/show_summary_button.png" src="static/description/show_summary_button.png" />
<a name="pdf-version"></a>
<h2><a class="toc-backref" href="#id16">PDF Version</a></h2>
<p>You may print or doaload a PDF version of the report by clicking on the <cite>PRINT</cite> button
in the control panel of the report.</p>
<img alt="static/description/print_button.png" src="static/description/print_button.png" />
<a name="contributors"></a>
<h2><a class="toc-backref" href="#id17">Contributors</a></h2>
<ul class="simple">
<li>Numigi (tm) and all its contributors (<a class="reference external" href="https://bit.ly/numigiens">https://bit.ly/numigiens</a>)</li>
</ul>