brotherton-erpnext/erpnext/docs/current/models/accounts/account.html
2016-01-12 17:08:33 +05:30

990 lines
21 KiB
HTML

<!-- title: Account -->
<div class="dev-header">
<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>
<a class="btn btn-default btn-sm" href="https://github.com/frappe/erpnext/tree/develop/erpnext/accounts/doctype/account"
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a>
</div>
<p><b>Table Name:</b> <code>tabAccount</code></p>
Heads (or groups) against which Accounting Entries are made and balances are maintained.
<h3>Fields</h3>
<table class="table table-bordered">
<thead>
<tr>
<th style="width: 5%">Sr</th>
<th style="width: 25%">Fieldname</th>
<th style="width: 20%">Type</th>
<th style="width: 25%">Label</th>
<th style="width: 25%">Options</th>
</tr>
</thead>
<tbody>
<tr class="info">
<td>1</td>
<td ><code>properties</code></td>
<td >
Section Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>2</td>
<td ><code>column_break0</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>3</td>
<td class="danger" title="Mandatory"><code>account_name</code></td>
<td >
Data</td>
<td >
Account Name
</td>
<td></td>
</tr>
<tr >
<td>4</td>
<td ><code>is_group</code></td>
<td >
Check</td>
<td >
Is Group
</td>
<td></td>
</tr>
<tr >
<td>5</td>
<td class="danger" title="Mandatory"><code>company</code></td>
<td >
Link</td>
<td >
Company
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/setup/company">Company</a>
</td>
</tr>
<tr >
<td>6</td>
<td ><code>root_type</code></td>
<td >
Select</td>
<td >
Root Type
</td>
<td>
<pre>
Asset
Liability
Income
Expense
Equity</pre>
</td>
</tr>
<tr >
<td>7</td>
<td ><code>report_type</code></td>
<td >
Select</td>
<td >
Report Type
</td>
<td>
<pre>
Balance Sheet
Profit and Loss</pre>
</td>
</tr>
<tr >
<td>8</td>
<td ><code>account_currency</code></td>
<td >
Link</td>
<td >
Currency
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/geo/currency">Currency</a>
</td>
</tr>
<tr >
<td>9</td>
<td ><code>column_break1</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>10</td>
<td class="danger" title="Mandatory"><code>parent_account</code></td>
<td >
Link</td>
<td >
Parent Account
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/accounts/account">Account</a>
</td>
</tr>
<tr >
<td>11</td>
<td ><code>account_type</code></td>
<td >
Select</td>
<td >
Account Type
<p class="text-muted small">
Setting Account Type helps in selecting this Account in transactions.</p>
</td>
<td>
<pre>
Bank
Cash
Depreciation
Tax
Chargeable
Warehouse
Receivable
Payable
Equity
Fixed Asset
Cost of Goods Sold
Expense Account
Round Off
Income Account
Stock Received But Not Billed
Expenses Included In Valuation
Stock Adjustment
Stock
Temporary</pre>
</td>
</tr>
<tr >
<td>12</td>
<td ><code>tax_rate</code></td>
<td >
Float</td>
<td >
Rate
<p class="text-muted small">
Rate at which this tax is applied</p>
</td>
<td></td>
</tr>
<tr >
<td>13</td>
<td ><code>freeze_account</code></td>
<td >
Select</td>
<td >
Frozen
<p class="text-muted small">
If the account is frozen, entries are allowed to restricted users.</p>
</td>
<td>
<pre>No
Yes</pre>
</td>
</tr>
<tr >
<td>14</td>
<td ><code>warehouse</code></td>
<td >
Link</td>
<td >
Warehouse
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/stock/warehouse">Warehouse</a>
</td>
</tr>
<tr >
<td>15</td>
<td ><code>balance_must_be</code></td>
<td >
Select</td>
<td >
Balance must be
</td>
<td>
<pre>
Debit
Credit</pre>
</td>
</tr>
<tr >
<td>16</td>
<td ><code>lft</code></td>
<td >
Int</td>
<td class="text-muted" title="Hidden">
Lft
</td>
<td></td>
</tr>
<tr >
<td>17</td>
<td ><code>rgt</code></td>
<td >
Int</td>
<td class="text-muted" title="Hidden">
Rgt
</td>
<td></td>
</tr>
<tr >
<td>18</td>
<td ><code>old_parent</code></td>
<td >
Data</td>
<td class="text-muted" title="Hidden">
Old Parent
</td>
<td></td>
</tr>
</tbody>
</table>
<hr>
<h3>Controller</h3>
<h4>erpnext.accounts.doctype.account.account</h4>
<h3 style="font-weight: normal;">Class <b>Account</b></h3>
<p style="padding-left: 30px;"><i>Inherits from frappe.model.document.Document</i></h4>
<div class="docs-attr-desc"><p></p>
</div>
<div style="padding-left: 30px;">
<p class="docs-attr-name">
<a name="after_rename" href="#after_rename" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>after_rename</b>
<i class="text-muted">(self, old, new, merge=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="autoname" href="#autoname" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>autoname</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="before_rename" href="#before_rename" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>before_rename</b>
<i class="text-muted">(self, old, new, merge=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="check_gle_exists" href="#check_gle_exists" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>check_gle_exists</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="check_if_child_exists" href="#check_if_child_exists" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>check_if_child_exists</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="convert_group_to_ledger" href="#convert_group_to_ledger" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>convert_group_to_ledger</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="convert_ledger_to_group" href="#convert_ledger_to_group" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>convert_ledger_to_group</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_trash" href="#on_trash" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>on_trash</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" href="#on_update" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>on_update</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="icon-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_root_and_report_type" href="#set_root_and_report_type" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>set_root_and_report_type</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_nsm_model" href="#update_nsm_model" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>update_nsm_model</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>update lft, rgt indices for nested set model</p>
</div>
<br>
<p class="docs-attr-name">
<a name="validate" href="#validate" class="text-muted small">
<i class="icon-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="icon-link small" style="color: #ccc;"></i></a>
<b>validate_account_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_balance_must_be_debit_or_credit" href="#validate_balance_must_be_debit_or_credit" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>validate_balance_must_be_debit_or_credit</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_frozen_accounts_modifier" href="#validate_frozen_accounts_modifier" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>validate_frozen_accounts_modifier</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_mandatory" href="#validate_mandatory" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>validate_mandatory</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_parent" href="#validate_parent" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>validate_parent</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>Fetch Parent Details and validate parent account</p>
</div>
<br>
<p class="docs-attr-name">
<a name="validate_root_details" href="#validate_root_details" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>validate_root_details</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_trash" href="#validate_trash" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>validate_trash</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>checks gl entries and if child exists</p>
</div>
<br>
<p class="docs-attr-name">
<a name="validate_warehouse" href="#validate_warehouse" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>validate_warehouse</b>
<i class="text-muted">(self, warehouse)</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_warehouse_account" href="#validate_warehouse_account" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>validate_warehouse_account</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>
<h3 style="font-weight: normal;">Class <b>RootNotEditable</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 class="docs-attr-name">
<a name="erpnext.accounts.doctype.account.account.get_account_currency" href="#erpnext.accounts.doctype.account.account.get_account_currency" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
erpnext.accounts.doctype.account.account.<b>get_account_currency</b>
<i class="text-muted">(account)</i>
</p>
<div class="docs-attr-desc"><p>Helper function to get account currency</p>
</div>
<br>
<p class="docs-attr-name">
<a name="erpnext.accounts.doctype.account.account.get_parent_account" href="#erpnext.accounts.doctype.account.account.get_parent_account" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
erpnext.accounts.doctype.account.account.<b>get_parent_account</b>
<i class="text-muted">(doctype, txt, searchfield, start, page_len, filters)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<h4>Linked In:</h4>
<ul>
<li>
<a href="https://frappe.github.io/erpnext/current/models/accounts/account">Account</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/accounts/bank_reconciliation">Bank Reconciliation</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/accounts/budget_detail">Budget Detail</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/setup/company">Company</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/stock/delivery_note_item">Delivery Note Item</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/hr/expense_claim_detail">Expense Claim Detail</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/hr/expense_claim_type">Expense Claim Type</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/accounts/gl_entry">GL Entry</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/stock/item">Item</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/setup/item_group">Item Group</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/stock/item_tax">Item Tax</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/accounts/journal_entry_account">Journal Entry Account</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/accounts/mode_of_payment_account">Mode of Payment Account</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/accounts/party_account">Party Account</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/accounts/payment_reconciliation">Payment Reconciliation</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/accounts/payment_tool">Payment Tool</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/accounts/period_closing_voucher">Period Closing Voucher</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/accounts/pos_profile">POS Profile</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/accounts/purchase_invoice">Purchase Invoice</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/accounts/purchase_invoice_item">Purchase Invoice Item</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/accounts/purchase_taxes_and_charges">Purchase Taxes and Charges</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/accounts/sales_invoice">Sales Invoice</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/accounts/sales_invoice_item">Sales Invoice Item</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/accounts/sales_taxes_and_charges">Sales Taxes and Charges</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/accounts/shipping_rule">Shipping Rule</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/stock/stock_entry">Stock Entry</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/stock/stock_entry_detail">Stock Entry Detail</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/stock/stock_reconciliation">Stock Reconciliation</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/stock/warehouse">Warehouse</a>
</li>
</ul>
<!-- autodoc -->
<!-- jinja -->
<!-- static -->