Search 1.9 billion lines of Odoo code on GitHub

budget_control

Author: Ecosoft, Odoo Community Association (OCA)
License: AGPL-3
Branch: 15.0-add-budget_control_basic
Repository: ecosoft-odoo/account-budgeting
Dependencies: account, analytic, base, date_range, l10n_generic_coa, and web_widget_x2many_2d_matrix
Languages: HTML (505, 7.0%), Python (3719, 51.9%), XML (2686, 37.5%), and reStructuredText (255, 3.6%)
Other branches: 12.0-add-budget_control, 14.0, 14.0-add-budget_control, 14.0-add-budget_control_basic, 14.0-add-ecosoft-budget_management, 14.0-fix-budget_control_basic-20221004, 14.0-fix-budget_transfer_and_report, 14.0-fix-check_budget_only_active, 14.0-fix-filter_not_affect_budget_expense, 14.0-fix-kpi_in_commit, 14.0-fix-performance_bplan, kittiu-add-budget-adjustment, and kittiu-fix-advance-over_return

<h1 class="title">Budget Control</h1> <p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Alpha" src="https://img.shields.io/badge/maturity-Alpha-red.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/account-budgeting/tree/14.0/budget_control"><img alt="OCA/account-budgeting" src="https://img.shields.io/badge/github-OCA%2Faccount--budgeting-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/account-budgeting-14-0/account-budgeting-14-0-budget_control"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/88/14.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p> <p>This module is the main module from a set of budget control modules. This module alone will allow you to work in full cycle of budget control process. Other modules, each one are the small enhancement of this module, to fullfill additional needs. Having said that, following will describe the full cycle of budget control already provided by this module,</p> <p><strong>Notes:</strong></p> <p>Mis Buidler (mis_builder_budget) is used as the core engine to calculate the budgeting figure. The budget_control modules are aimed to ease the use of budgeting in organization.</p> <p>In order to understand how this module works, you should first understand budgeting concept of mis_builder_budget.</p> <a name="budget-control-core-features"></a> <h2>Budget Control Core Features:</h2> <ul> <li><p class="first"><strong>Budget Commitment (base.budget.move)</strong></p> <p>Probably the most crucial part of budget_control.</p> <ul class="simple"> <li>Budget Balance = Budget Allocated - (Budget Actuals - Budget Commitments)</li> </ul> <p>Actual amount are from <cite>account.move.line</cite> from posted invoice. Commitments can be sales/purchase, expense, purchase request, etc. Document required to be budget commitment can extend base.budget.move. For example, the module budget_control_expense will create budget commitment <cite>expense.budget.move</cite> for approved expense. These budget commitments will be used as alternate data source on mis_builder_budget. Note that, in this budget_control module, there is no extension for budget commitment yet.</p> </li> <li><p class="first"><strong>Budget Period (budget.period)</strong></p> <p>Budget Period is the first thing to do for new budget year, and is used to govern how budget will be controlled over the defined date range, i.e.,</p> <ul class="simple"> <li>Duration of budget year</li> <li>KPI to control (mis.report.instance)</li> <li>Document to do budget checking</li> <li>Analytic account in controlled</li> <li>Control Level</li> </ul> <p>Although not mandatory, an organization will most likely use fiscal year as budget period. In such case, there will be 1 budget period per fiscal year, and multiple budget control sheet (one per analytic).</p> </li> <li><p class="first"><strong>Budget Control Sheet (budget.control)</strong></p> <p>Each analytic account can have one budget control sheet per budget period. The budget control is used to allocate budget amount in a simpler way. In the backend it simply create mis.budget.item, nothing too fancy. Once we have budget allocations, the system is ready to perform budget check.</p> </li> <li><p class="first"><strong>Budget Checking</strong></p> <p>By calling function -- check_budget(), system will check whether the confirmation of such document can result in negative budget balance. If so, it throw error message. In this module, budget check occur during posting of invoice and journal entry. To check budget also on more documents, do install budget_control_xxx relevant to that document.</p> </li> <li><p class="first"><strong>Budget Reports</strong></p> <p>Currently there are 2 types of report.</p> <ol class="arabic simple"> <li>MIS Builder Reports: inherited from MIS Builder, to shows overall budget condition, overall or by each analytic.</li> <li>Budget Monitor Report: combine all budget related transactions, and show them in Standard Odoo BI view.</li> </ol> </li> <li><p class="first"><strong>Budget Commitment Move Forward</strong></p> <p>In case budget commitment is being used. Sometime user has committed budget withing this year but not ready to use it and want to move the commitment amount to next year budget. Budget Commitment Forward can be use to change the budget move's date to the designated year.</p> </li> </ul> <a name="extended-modules"></a> <h2>Extended Modules:</h2> <p>Following are brief explanation of what the extended module will do.</p> <p><strong>Budget Transfer</strong></p> <p>This module allow transferring allocated budget from one budget control sheet to other</p> <ul class="simple"> <li>budget_control_transfer</li> </ul> <p><strong>Budget Move extension</strong></p> <p>These modules extend base.budget.move for other document budget commitment.</p> <ul class="simple"> <li>budget_control_expense</li> <li>budget_control_purchase</li> <li>budget_control_purchase_request</li> <li>budget_control_sale</li> </ul> <p><strong>Budget Source of Fund</strong></p> <p>This module allow create Master Data source of fund. there is relation between source of fund and budget control sheet for allocated source of fund from one budget control sheet to many source of fund. Users can view source of fund monitoring report</p> <ul class="simple"> <li>budget_source_fund</li> </ul> <p><strong>Tier Validation</strong></p> <p>Extend base_tier_validation for budget control sheet</p> <ul class="simple"> <li>budget_control_tier_validation</li> </ul> <p><strong>Analytic Tag Dimension Enhancements</strong></p> <p>When 1 dimension (analytic account) is not enough, we can use dimension to create persistent dimension columns</p> <ul class="simple"> <li>analytic_tag_dimension</li> <li>account_tag_dimension_enhanced</li> </ul> <p>Following modules ensure that, analytic_tag_dimension will work with all new budget control objects. These are important for reporting purposes.</p> <ul class="simple"> <li>budget_control_tag_dimension</li> <li>budget_control_expense_tag_dimension</li> <li>budget_control_purchase_tag_dimension</li> </ul> <div class="admonition important"> <p class="first admonition-title">Important</p> <p class="last">This is an alpha version, the data model and design can change at any time without warning. Only for development or testing purpose, do not use in production. <a class="reference external" href="https://odoo-community.org/page/development-status">More details on development status</a></p> </div> <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="id1">Usage</a></li> <li><a class="reference internal" href="#bug-tracker" id="id2">Bug Tracker</a></li> <li><a class="reference internal" href="#credits" id="id3">Credits</a></li> </ul> </div> <a name="usage"></a> <h3><a class="toc-backref" href="#id1">Usage</a></h3> <dl class="docutils"> <dt>Before start using this module, following access right must be set.</dt> <dd><ul class="first last simple"> <li>Budget User for Budget Control Sheet, Budget Report</li> <li>Budget Manager for Budget Period</li> </ul> </dd> </dl> <p>Followings are sample steps to start with,</p> <ol class="arabic"> <li><p class="first">Create new Budget Period</p> <blockquote> <ul class="simple"> <li>Choose KPI template (KPI should filter 'not_affect_budget' in KPI i.e., balp[510000]['|', ('move_id', '=', False), ('move_id.not_affect_budget', '=', False)])</li> <li>Identify date range, i.e., 1 fiscal year</li> <li>Plan Date Range, i.e., Quarter, the slot to fill allocation in budget control will split by quarter</li> <li>Budget Control - On Account = True</li> </ul> </blockquote> <p>Note: Upon creation, the MIS Budget (mis.budget) will be created automatically. The following steps will create mis.budget.item for it.</p> </li> <li><p class="first">Create Budget Control Sheet</p> <p>To create budget control sheet, you can either create manually one by one or by using the helper, Action &gt; Create Budget Control Sheet</p> <blockquote> <ul class="simple"> <li>Choose Analytic budget_control_purchase_tag_dimension</li> <li>Check All Analytic Account, this will list all analytic account in selected groups</li> <li>Uncheck Initial Budget By Commitment, this is used only on following year to init budget allocation if they were committed amount carried over.</li> <li>Click &quot;Create Budget Control Sheet&quot;, and then view the newly created control sheets.</li> </ul> </blockquote> </li> <li><p class="first">Allocate amount in Budget Control Sheets</p> <p>Each analytic account will have its own sheet. Form Budget Period, click on the icon &quot;Budget Control Sheets&quot; or by Menu &gt; Budgeting &gt; Budget Control Sheet, to open them.</p> <blockquote> <ul class="simple"> <li>Based on &quot;Plan Date Range&quot; period, Plan table will show all KPI split by Plan Date Range</li> <li>Allocate budget amount as appropriate.</li> <li>Click Control button, state will change to Controlled.</li> </ul> </blockquote> <p>Note: Make sure the Plan Date Rang period already has date ranges that covers entire budget period. Once ready, you can click on &quot;Reset Plan&quot; anytime.</p> </li> <li><p class="first">Budget Reports</p> <p>After some document transaction (i.e., invoice for actuals), you can view report anytime.</p> <blockquote> <ul class="simple"> <li>On both Budget Period and Budget Control sheet, click on Preview/Run/Export for MIS Report</li> <li>Menu Budgeting &gt; Budget Monitoring, to show budget report in standard Odoo BI view.</li> </ul> </blockquote> </li> <li><p class="first">Budget Checking</p> <p>As we have checked Budget Control - On Account = True in first step, checking will occur every time an invoice is validated. You can test by validate invoice with big amount to exceed.</p> </li> </ol> <a name="bug-tracker"></a> <h3><a class="toc-backref" href="#id2">Bug Tracker</a></h3> <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/account-budgeting/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 smashing it by providing a detailed and welcomed <a class="reference external" href="https://github.com/OCA/account-budgeting/issues/new?body=module:%20budget_control%0Aversion:%2014.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> <a name="credits"></a> <h3><a class="toc-backref" href="#id3">Credits</a></h3> <a name="authors"></a> <h2>Authors</h2> <ul class="simple"> <li>Ecosoft</li> </ul> <a name="contributors"></a> <h2>Contributors</h2> <ul class="simple"> <li>Kitti Upariphutthiphong &lt;<a class="reference external" href="mailto:kittiu&#64;ecosoft.co.th">kittiu&#64;ecosoft.co.th</a>&gt;</li> <li>Saran Lim. &lt;<a class="reference external" href="mailto:saranl&#64;ecosoft.co.th">saranl&#64;ecosoft.co.th</a>&gt;</li> </ul> <a name="maintainers"></a> <h2>Maintainers</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 mission is to support the collaborative development of Odoo features and promote its widespread use.</p> <p>Current <a class="reference external" href="https://odoo-community.org/page/maintainer-role">maintainer</a>:</p> <p><a class="reference external" href="https://github.com/kittiu"><img alt="kittiu" src="https://github.com/kittiu.png?size=40px" /></a></p> <p>This module is part of the <a class="reference external" href="https://github.com/OCA/account-budgeting/tree/14.0/budget_control">OCA/account-budgeting</a> project on GitHub.</p> <p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>