mirror of
https://github.com/erpnext/foundation.git
synced 2026-10-16 18:00:47 +02:00
530 lines
16 KiB
HTML
530 lines
16 KiB
HTML
<!-- title: erpnext.accounts.utils -->
|
|
<!-- add-breadcrumbs --><h1>erpnext.accounts.utils</h1>
|
|
<div class="dev-header">
|
|
|
|
<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
|
|
Version 10.1.37</a>
|
|
|
|
|
|
<a class="btn btn-default btn-sm" href="https://github.com/frappe/erpnext/blob/develop/erpnext/accounts/utils.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>FiscalYearError</b></h3>
|
|
|
|
<p style="padding-left: 30px;"><i>Inherits from frappe.exceptions.ValidationError</i></h4>
|
|
|
|
<div class="docs-attr-desc"><p></p>
|
|
</div>
|
|
<div style="padding-left: 30px;">
|
|
|
|
</div>
|
|
<hr>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p><span class="label label-info">Public API</span>
|
|
<br><code>/api/method/erpnext.accounts.utils.add_ac</code>
|
|
</p>
|
|
<p class="docs-attr-name">
|
|
<a name="erpnext.accounts.utils.add_ac" href="#erpnext.accounts.utils.add_ac" class="text-muted small">
|
|
<i class="fa fa-link small" style="color: #ccc;"></i></a>
|
|
erpnext.accounts.utils.<b>add_ac</b>
|
|
<i class="text-muted">(args=None)</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.accounts.utils.add_cc</code>
|
|
</p>
|
|
<p class="docs-attr-name">
|
|
<a name="erpnext.accounts.utils.add_cc" href="#erpnext.accounts.utils.add_cc" class="text-muted small">
|
|
<i class="fa fa-link small" style="color: #ccc;"></i></a>
|
|
erpnext.accounts.utils.<b>add_cc</b>
|
|
<i class="text-muted">(args=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.accounts.utils.check_if_advance_entry_modified" href="#erpnext.accounts.utils.check_if_advance_entry_modified" class="text-muted small">
|
|
<i class="fa fa-link small" style="color: #ccc;"></i></a>
|
|
erpnext.accounts.utils.<b>check_if_advance_entry_modified</b>
|
|
<i class="text-muted">(args)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><pre><code> check if there is already a voucher reference
|
|
check if amount is same
|
|
check if jv is submitted
|
|
</code></pre>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="erpnext.accounts.utils.create_payment_gateway_account" href="#erpnext.accounts.utils.create_payment_gateway_account" class="text-muted small">
|
|
<i class="fa fa-link small" style="color: #ccc;"></i></a>
|
|
erpnext.accounts.utils.<b>create_payment_gateway_account</b>
|
|
<i class="text-muted">(gateway)</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.accounts.utils.fix_total_debit_credit" href="#erpnext.accounts.utils.fix_total_debit_credit" class="text-muted small">
|
|
<i class="fa fa-link small" style="color: #ccc;"></i></a>
|
|
erpnext.accounts.utils.<b>fix_total_debit_credit</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.accounts.utils.get_account_name" href="#erpnext.accounts.utils.get_account_name" class="text-muted small">
|
|
<i class="fa fa-link small" style="color: #ccc;"></i></a>
|
|
erpnext.accounts.utils.<b>get_account_name</b>
|
|
<i class="text-muted">(account_type=None, root_type=None, is_group=None, account_currency=None, company=None)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>return account based on matching conditions</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p><span class="label label-info">Public API</span>
|
|
<br><code>/api/method/erpnext.accounts.utils.get_balance_on</code>
|
|
</p>
|
|
<p class="docs-attr-name">
|
|
<a name="erpnext.accounts.utils.get_balance_on" href="#erpnext.accounts.utils.get_balance_on" class="text-muted small">
|
|
<i class="fa fa-link small" style="color: #ccc;"></i></a>
|
|
erpnext.accounts.utils.<b>get_balance_on</b>
|
|
<i class="text-muted">(account=None, date=None, party_type=None, party=None, company=None, in_account_currency=True)</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.accounts.utils.get_children</code>
|
|
</p>
|
|
<p class="docs-attr-name">
|
|
<a name="erpnext.accounts.utils.get_children" href="#erpnext.accounts.utils.get_children" class="text-muted small">
|
|
<i class="fa fa-link small" style="color: #ccc;"></i></a>
|
|
erpnext.accounts.utils.<b>get_children</b>
|
|
<i class="text-muted">(doctype, parent, company, is_root=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.accounts.utils.get_companies</code>
|
|
</p>
|
|
<p class="docs-attr-name">
|
|
<a name="erpnext.accounts.utils.get_companies" href="#erpnext.accounts.utils.get_companies" class="text-muted small">
|
|
<i class="fa fa-link small" style="color: #ccc;"></i></a>
|
|
erpnext.accounts.utils.<b>get_companies</b>
|
|
<i class="text-muted">()</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>get a list of companies based on permission</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p><span class="label label-info">Public API</span>
|
|
<br><code>/api/method/erpnext.accounts.utils.get_company_default</code>
|
|
</p>
|
|
<p class="docs-attr-name">
|
|
<a name="erpnext.accounts.utils.get_company_default" href="#erpnext.accounts.utils.get_company_default" class="text-muted small">
|
|
<i class="fa fa-link small" style="color: #ccc;"></i></a>
|
|
erpnext.accounts.utils.<b>get_company_default</b>
|
|
<i class="text-muted">(company, 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="erpnext.accounts.utils.get_count_on" href="#erpnext.accounts.utils.get_count_on" class="text-muted small">
|
|
<i class="fa fa-link small" style="color: #ccc;"></i></a>
|
|
erpnext.accounts.utils.<b>get_count_on</b>
|
|
<i class="text-muted">(account, fieldname, date)</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.accounts.utils.get_currency_precision" href="#erpnext.accounts.utils.get_currency_precision" class="text-muted small">
|
|
<i class="fa fa-link small" style="color: #ccc;"></i></a>
|
|
erpnext.accounts.utils.<b>get_currency_precision</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.accounts.utils.get_doc_name_autoname" href="#erpnext.accounts.utils.get_doc_name_autoname" class="text-muted small">
|
|
<i class="fa fa-link small" style="color: #ccc;"></i></a>
|
|
erpnext.accounts.utils.<b>get_doc_name_autoname</b>
|
|
<i class="text-muted">(field_value, doc_title, name, company)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>append title with prefix as number and suffix as company's abbreviation separated by '-' </p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p><span class="label label-info">Public API</span>
|
|
<br><code>/api/method/erpnext.accounts.utils.get_fiscal_year</code>
|
|
</p>
|
|
<p class="docs-attr-name">
|
|
<a name="erpnext.accounts.utils.get_fiscal_year" href="#erpnext.accounts.utils.get_fiscal_year" class="text-muted small">
|
|
<i class="fa fa-link small" style="color: #ccc;"></i></a>
|
|
erpnext.accounts.utils.<b>get_fiscal_year</b>
|
|
<i class="text-muted">(date=None, fiscal_year=None, label=Date, verbose=1, company=None, as_dict=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="erpnext.accounts.utils.get_fiscal_years" href="#erpnext.accounts.utils.get_fiscal_years" class="text-muted small">
|
|
<i class="fa fa-link small" style="color: #ccc;"></i></a>
|
|
erpnext.accounts.utils.<b>get_fiscal_years</b>
|
|
<i class="text-muted">(transaction_date=None, fiscal_year=None, label=Date, verbose=1, company=None, as_dict=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="erpnext.accounts.utils.get_held_invoices" href="#erpnext.accounts.utils.get_held_invoices" class="text-muted small">
|
|
<i class="fa fa-link small" style="color: #ccc;"></i></a>
|
|
erpnext.accounts.utils.<b>get_held_invoices</b>
|
|
<i class="text-muted">(party_type, party)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><pre><code>Returns a list of names Purchase Invoices for the given party that are on hold
|
|
</code></pre>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="erpnext.accounts.utils.get_outstanding_invoices" href="#erpnext.accounts.utils.get_outstanding_invoices" class="text-muted small">
|
|
<i class="fa fa-link small" style="color: #ccc;"></i></a>
|
|
erpnext.accounts.utils.<b>get_outstanding_invoices</b>
|
|
<i class="text-muted">(party_type, party, account, condition=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.accounts.utils.get_stock_and_account_difference" href="#erpnext.accounts.utils.get_stock_and_account_difference" class="text-muted small">
|
|
<i class="fa fa-link small" style="color: #ccc;"></i></a>
|
|
erpnext.accounts.utils.<b>get_stock_and_account_difference</b>
|
|
<i class="text-muted">(account_list=None, posting_date=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.accounts.utils.get_stock_rbnb_difference" href="#erpnext.accounts.utils.get_stock_rbnb_difference" class="text-muted small">
|
|
<i class="fa fa-link small" style="color: #ccc;"></i></a>
|
|
erpnext.accounts.utils.<b>get_stock_rbnb_difference</b>
|
|
<i class="text-muted">(posting_date, company)</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.accounts.utils.reconcile_against_document" href="#erpnext.accounts.utils.reconcile_against_document" class="text-muted small">
|
|
<i class="fa fa-link small" style="color: #ccc;"></i></a>
|
|
erpnext.accounts.utils.<b>reconcile_against_document</b>
|
|
<i class="text-muted">(args)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><pre><code> Cancel JV, Update aginst document, split if required and resubmit jv
|
|
</code></pre>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="erpnext.accounts.utils.remove_ref_doc_link_from_jv" href="#erpnext.accounts.utils.remove_ref_doc_link_from_jv" class="text-muted small">
|
|
<i class="fa fa-link small" style="color: #ccc;"></i></a>
|
|
erpnext.accounts.utils.<b>remove_ref_doc_link_from_jv</b>
|
|
<i class="text-muted">(ref_type, ref_no)</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.accounts.utils.remove_ref_doc_link_from_pe" href="#erpnext.accounts.utils.remove_ref_doc_link_from_pe" class="text-muted small">
|
|
<i class="fa fa-link small" style="color: #ccc;"></i></a>
|
|
erpnext.accounts.utils.<b>remove_ref_doc_link_from_pe</b>
|
|
<i class="text-muted">(ref_type, ref_no)</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.accounts.utils.unlink_ref_doc_from_payment_entries" href="#erpnext.accounts.utils.unlink_ref_doc_from_payment_entries" class="text-muted small">
|
|
<i class="fa fa-link small" style="color: #ccc;"></i></a>
|
|
erpnext.accounts.utils.<b>unlink_ref_doc_from_payment_entries</b>
|
|
<i class="text-muted">(ref_doc)</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.accounts.utils.update_number_field</code>
|
|
</p>
|
|
<p class="docs-attr-name">
|
|
<a name="erpnext.accounts.utils.update_number_field" href="#erpnext.accounts.utils.update_number_field" class="text-muted small">
|
|
<i class="fa fa-link small" style="color: #ccc;"></i></a>
|
|
erpnext.accounts.utils.<b>update_number_field</b>
|
|
<i class="text-muted">(doctype_name, name, field_name, field_value, company)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><pre><code> doctype_name = Name of the DocType
|
|
name = Docname being referred
|
|
field_name = Name of the field thats holding the 'number' attribute
|
|
field_value = Numeric value entered in field_name
|
|
|
|
Stores the number entered in the dialog to the DocType's field.
|
|
|
|
Renames the document by adding the number as a prefix to the current name and updates
|
|
all transaction where it was present.
|
|
</code></pre>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="erpnext.accounts.utils.update_reference_in_journal_entry" href="#erpnext.accounts.utils.update_reference_in_journal_entry" class="text-muted small">
|
|
<i class="fa fa-link small" style="color: #ccc;"></i></a>
|
|
erpnext.accounts.utils.<b>update_reference_in_journal_entry</b>
|
|
<i class="text-muted">(d, jv_obj)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><pre><code> Updates against document, if partial amount splits into rows
|
|
</code></pre>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="erpnext.accounts.utils.update_reference_in_payment_entry" href="#erpnext.accounts.utils.update_reference_in_payment_entry" class="text-muted small">
|
|
<i class="fa fa-link small" style="color: #ccc;"></i></a>
|
|
erpnext.accounts.utils.<b>update_reference_in_payment_entry</b>
|
|
<i class="text-muted">(d, payment_entry)</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.accounts.utils.validate_allocated_amount" href="#erpnext.accounts.utils.validate_allocated_amount" class="text-muted small">
|
|
<i class="fa fa-link small" style="color: #ccc;"></i></a>
|
|
erpnext.accounts.utils.<b>validate_allocated_amount</b>
|
|
<i class="text-muted">(args)</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.accounts.utils.validate_field_number" href="#erpnext.accounts.utils.validate_field_number" class="text-muted small">
|
|
<i class="fa fa-link small" style="color: #ccc;"></i></a>
|
|
erpnext.accounts.utils.<b>validate_field_number</b>
|
|
<i class="text-muted">(doctype_name, name, field_value, company, field_name)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Validate if the number entered isn't already assigned to some other document. </p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="erpnext.accounts.utils.validate_fiscal_year" href="#erpnext.accounts.utils.validate_fiscal_year" class="text-muted small">
|
|
<i class="fa fa-link small" style="color: #ccc;"></i></a>
|
|
erpnext.accounts.utils.<b>validate_fiscal_year</b>
|
|
<i class="text-muted">(date, fiscal_year, company, label=Date, doc=None)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<!-- autodoc --> |