Files
foundation/foundation/www/docs/current/api/controllers/erpnext.controllers.accounts_controller.html
Rushabh Mehta ecdaf31190 [docs]
2017-07-31 17:42:42 +05:30

667 lines
20 KiB
HTML

<!-- title: erpnext.controllers.accounts_controller -->
<!-- add-breadcrumbs --><h1>erpnext.controllers.accounts_controller</h1>
<div class="dev-header">
<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 8.6.5</a>
<a class="btn btn-default btn-sm" href="https://github.com/frappe/erpnext/blob/develop/erpnext/controllers/accounts_controller.py"
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a>
</div>
<h3 style="font-weight: normal;">Class <b>AccountsController</b></h3>
<p style="padding-left: 30px;"><i>Inherits from erpnext.utilities.transaction_base.TransactionBase</i></h4>
<div class="docs-attr-desc"><p></p>
</div>
<div style="padding-left: 30px;">
<p class="docs-attr-name">
<a name="__init__" href="#__init__" class="text-muted small">
<i class="fa fa-link small" style="color: #ccc;"></i></a>
<b>__init__</b>
<i class="text-muted">(self, arg1, arg2=None)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="append_taxes_from_master" href="#append_taxes_from_master" class="text-muted small">
<i class="fa fa-link small" style="color: #ccc;"></i></a>
<b>append_taxes_from_master</b>
<i class="text-muted">(self, tax_master_doctype=None)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="before_print" href="#before_print" class="text-muted small">
<i class="fa fa-link small" style="color: #ccc;"></i></a>
<b>before_print</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="calculate_taxes_and_totals" href="#calculate_taxes_and_totals" class="text-muted small">
<i class="fa fa-link small" style="color: #ccc;"></i></a>
<b>calculate_taxes_and_totals</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="clear_unallocated_advances" href="#clear_unallocated_advances" class="text-muted small">
<i class="fa fa-link small" style="color: #ccc;"></i></a>
<b>clear_unallocated_advances</b>
<i class="text-muted">(self, childtype, parentfield)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="delink_advance_entries" href="#delink_advance_entries" class="text-muted small">
<i class="fa fa-link small" style="color: #ccc;"></i></a>
<b>delink_advance_entries</b>
<i class="text-muted">(self, linked_doc_name)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="get_advance_entries" href="#get_advance_entries" class="text-muted small">
<i class="fa fa-link small" style="color: #ccc;"></i></a>
<b>get_advance_entries</b>
<i class="text-muted">(self, include_unallocated=True)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="get_company_default" href="#get_company_default" class="text-muted small">
<i class="fa fa-link small" style="color: #ccc;"></i></a>
<b>get_company_default</b>
<i class="text-muted">(self, fieldname)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="get_gl_dict" href="#get_gl_dict" class="text-muted small">
<i class="fa fa-link small" style="color: #ccc;"></i></a>
<b>get_gl_dict</b>
<i class="text-muted">(self, args, account_currency=None)</i>
</p>
<div class="docs-attr-desc"><p>this method populates the common properties of a gl entry record</p>
</div>
<br>
<p class="docs-attr-name">
<a name="get_party" href="#get_party" class="text-muted small">
<i class="fa fa-link small" style="color: #ccc;"></i></a>
<b>get_party</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="get_stock_items" href="#get_stock_items" class="text-muted small">
<i class="fa fa-link small" style="color: #ccc;"></i></a>
<b>get_stock_items</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="group_similar_items" href="#group_similar_items" class="text-muted small">
<i class="fa fa-link small" style="color: #ccc;"></i></a>
<b>group_similar_items</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="on_update_after_submit" href="#on_update_after_submit" class="text-muted small">
<i class="fa fa-link small" style="color: #ccc;"></i></a>
<b>on_update_after_submit</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="onload" href="#onload" class="text-muted small">
<i class="fa fa-link small" style="color: #ccc;"></i></a>
<b>onload</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="set_advances" href="#set_advances" class="text-muted small">
<i class="fa fa-link small" style="color: #ccc;"></i></a>
<b>set_advances</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>Returns list of advances against Account, Party, Reference</p>
</div>
<br>
<p class="docs-attr-name">
<a name="set_missing_item_details" href="#set_missing_item_details" class="text-muted small">
<i class="fa fa-link small" style="color: #ccc;"></i></a>
<b>set_missing_item_details</b>
<i class="text-muted">(self, for_validate=False)</i>
</p>
<div class="docs-attr-desc"><p>set missing item values</p>
</div>
<br>
<p class="docs-attr-name">
<a name="set_missing_values" href="#set_missing_values" class="text-muted small">
<i class="fa fa-link small" style="color: #ccc;"></i></a>
<b>set_missing_values</b>
<i class="text-muted">(self, for_validate=False)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="set_other_charges" href="#set_other_charges" class="text-muted small">
<i class="fa fa-link small" style="color: #ccc;"></i></a>
<b>set_other_charges</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="set_price_list_currency" href="#set_price_list_currency" class="text-muted small">
<i class="fa fa-link small" style="color: #ccc;"></i></a>
<b>set_price_list_currency</b>
<i class="text-muted">(self, buying_or_selling)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="set_taxes" href="#set_taxes" class="text-muted small">
<i class="fa fa-link small" style="color: #ccc;"></i></a>
<b>set_taxes</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="set_total_advance_paid" href="#set_total_advance_paid" class="text-muted small">
<i class="fa fa-link small" style="color: #ccc;"></i></a>
<b>set_total_advance_paid</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="update_against_document_in_jv" href="#update_against_document_in_jv" class="text-muted small">
<i class="fa fa-link small" style="color: #ccc;"></i></a>
<b>update_against_document_in_jv</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><pre><code> Links invoice and advance voucher:
1. cancel advance voucher
2. split into multiple rows if partially adjusted, assign against voucher
3. submit advance voucher
</code></pre>
</div>
<br>
<p class="docs-attr-name">
<a name="validate" href="#validate" class="text-muted small">
<i class="fa fa-link small" style="color: #ccc;"></i></a>
<b>validate</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="validate_account_currency" href="#validate_account_currency" class="text-muted small">
<i class="fa fa-link small" style="color: #ccc;"></i></a>
<b>validate_account_currency</b>
<i class="text-muted">(self, account, account_currency=None)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="validate_advance_entries" href="#validate_advance_entries" class="text-muted small">
<i class="fa fa-link small" style="color: #ccc;"></i></a>
<b>validate_advance_entries</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="validate_currency" href="#validate_currency" class="text-muted small">
<i class="fa fa-link small" style="color: #ccc;"></i></a>
<b>validate_currency</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="validate_date_with_fiscal_year" href="#validate_date_with_fiscal_year" class="text-muted small">
<i class="fa fa-link small" style="color: #ccc;"></i></a>
<b>validate_date_with_fiscal_year</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="validate_due_date" href="#validate_due_date" class="text-muted small">
<i class="fa fa-link small" style="color: #ccc;"></i></a>
<b>validate_due_date</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="validate_enabled_taxes_and_charges" href="#validate_enabled_taxes_and_charges" class="text-muted small">
<i class="fa fa-link small" style="color: #ccc;"></i></a>
<b>validate_enabled_taxes_and_charges</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="validate_fixed_asset" href="#validate_fixed_asset" class="text-muted small">
<i class="fa fa-link small" style="color: #ccc;"></i></a>
<b>validate_fixed_asset</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="validate_multiple_billing" href="#validate_multiple_billing" class="text-muted small">
<i class="fa fa-link small" style="color: #ccc;"></i></a>
<b>validate_multiple_billing</b>
<i class="text-muted">(self, ref_dt, item_ref_dn, based_on, parentfield)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="validate_paid_amount" href="#validate_paid_amount" class="text-muted small">
<i class="fa fa-link small" style="color: #ccc;"></i></a>
<b>validate_paid_amount</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="validate_party" href="#validate_party" class="text-muted small">
<i class="fa fa-link small" style="color: #ccc;"></i></a>
<b>validate_party</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
</div>
<hr>
<p class="docs-attr-name">
<a name="erpnext.controllers.accounts_controller.get_advance_journal_entries" href="#erpnext.controllers.accounts_controller.get_advance_journal_entries" class="text-muted small">
<i class="fa fa-link small" style="color: #ccc;"></i></a>
erpnext.controllers.accounts_controller.<b>get_advance_journal_entries</b>
<i class="text-muted">(party_type, party, party_account, amount_field, order_doctype, order_list, include_unallocated=True)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="erpnext.controllers.accounts_controller.get_advance_payment_entries" href="#erpnext.controllers.accounts_controller.get_advance_payment_entries" class="text-muted small">
<i class="fa fa-link small" style="color: #ccc;"></i></a>
erpnext.controllers.accounts_controller.<b>get_advance_payment_entries</b>
<i class="text-muted">(party_type, party, party_account, order_doctype, order_list=None, include_unallocated=True, against_all_orders=False)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p><span class="label label-info">Public API</span>
<br><code>/api/method/erpnext.controllers.accounts_controller.get_default_taxes_and_charges</code>
</p>
<p class="docs-attr-name">
<a name="erpnext.controllers.accounts_controller.get_default_taxes_and_charges" href="#erpnext.controllers.accounts_controller.get_default_taxes_and_charges" class="text-muted small">
<i class="fa fa-link small" style="color: #ccc;"></i></a>
erpnext.controllers.accounts_controller.<b>get_default_taxes_and_charges</b>
<i class="text-muted">(master_doctype)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p><span class="label label-info">Public API</span>
<br><code>/api/method/erpnext.controllers.accounts_controller.get_tax_rate</code>
</p>
<p class="docs-attr-name">
<a name="erpnext.controllers.accounts_controller.get_tax_rate" href="#erpnext.controllers.accounts_controller.get_tax_rate" class="text-muted small">
<i class="fa fa-link small" style="color: #ccc;"></i></a>
erpnext.controllers.accounts_controller.<b>get_tax_rate</b>
<i class="text-muted">(account_head)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p><span class="label label-info">Public API</span>
<br><code>/api/method/erpnext.controllers.accounts_controller.get_taxes_and_charges</code>
</p>
<p class="docs-attr-name">
<a name="erpnext.controllers.accounts_controller.get_taxes_and_charges" href="#erpnext.controllers.accounts_controller.get_taxes_and_charges" class="text-muted small">
<i class="fa fa-link small" style="color: #ccc;"></i></a>
erpnext.controllers.accounts_controller.<b>get_taxes_and_charges</b>
<i class="text-muted">(master_doctype, master_name)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="erpnext.controllers.accounts_controller.set_balance_in_account_currency" href="#erpnext.controllers.accounts_controller.set_balance_in_account_currency" class="text-muted small">
<i class="fa fa-link small" style="color: #ccc;"></i></a>
erpnext.controllers.accounts_controller.<b>set_balance_in_account_currency</b>
<i class="text-muted">(gl_dict, account_currency=None, conversion_rate=None, company_currency=None)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="erpnext.controllers.accounts_controller.update_invoice_status" href="#erpnext.controllers.accounts_controller.update_invoice_status" class="text-muted small">
<i class="fa fa-link small" style="color: #ccc;"></i></a>
erpnext.controllers.accounts_controller.<b>update_invoice_status</b>
<i class="text-muted">()</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="erpnext.controllers.accounts_controller.validate_conversion_rate" href="#erpnext.controllers.accounts_controller.validate_conversion_rate" class="text-muted small">
<i class="fa fa-link small" style="color: #ccc;"></i></a>
erpnext.controllers.accounts_controller.<b>validate_conversion_rate</b>
<i class="text-muted">(currency, conversion_rate, conversion_rate_label, company)</i>
</p>
<div class="docs-attr-desc"><p>common validation for currency and price list currency</p>
</div>
<br>
<p class="docs-attr-name">
<a name="erpnext.controllers.accounts_controller.validate_inclusive_tax" href="#erpnext.controllers.accounts_controller.validate_inclusive_tax" class="text-muted small">
<i class="fa fa-link small" style="color: #ccc;"></i></a>
erpnext.controllers.accounts_controller.<b>validate_inclusive_tax</b>
<i class="text-muted">(tax, doc)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="erpnext.controllers.accounts_controller.validate_taxes_and_charges" href="#erpnext.controllers.accounts_controller.validate_taxes_and_charges" class="text-muted small">
<i class="fa fa-link small" style="color: #ccc;"></i></a>
erpnext.controllers.accounts_controller.<b>validate_taxes_and_charges</b>
<i class="text-muted">(tax)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<!-- autodoc -->