brotherton-erpnext/erpnext/docs/current/models/selling/customer.html
2015-11-10 18:58:56 +05:30

1129 lines
25 KiB
HTML

<!-- title: Customer -->
<div class="dev-header">
<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.7.7</a>
<a class="btn btn-default btn-sm" href="https://github.com/frappe/erpnext/tree/develop/erpnext/selling/doctype/customer"
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>tabCustomer</code></p>
Buyer of Goods and Services.
<h3>Fields</h3>
<table class="table table-bordered" style="table-layout: fixed;">
<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>basic_info</code></td>
<td >
Section Break</td>
<td >
</td>
<td>
<pre>icon-user</pre>
</td>
</tr>
<tr >
<td>2</td>
<td ><code>naming_series</code></td>
<td >
Select</td>
<td >
Series
</td>
<td>
<pre>CUST-</pre>
</td>
</tr>
<tr >
<td>3</td>
<td class="danger" title="Mandatory"><code>customer_name</code></td>
<td >
Data</td>
<td >
Full Name
</td>
<td></td>
</tr>
<tr >
<td>4</td>
<td class="danger" title="Mandatory"><code>customer_type</code></td>
<td >
Select</td>
<td >
Type
</td>
<td>
<pre>
Company
Individual</pre>
</td>
</tr>
<tr >
<td>5</td>
<td ><code>lead_name</code></td>
<td >
Link</td>
<td >
From Lead
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/crm/lead">Lead</a>
</td>
</tr>
<tr >
<td>6</td>
<td ><code>column_break0</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>7</td>
<td class="danger" title="Mandatory"><code>customer_group</code></td>
<td >
Link</td>
<td >
Customer Group
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/setup/customer_group">Customer Group</a>
</td>
</tr>
<tr >
<td>8</td>
<td class="danger" title="Mandatory"><code>territory</code></td>
<td >
Link</td>
<td >
Territory
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/setup/territory">Territory</a>
</td>
</tr>
<tr >
<td>9</td>
<td ><code>tax_id</code></td>
<td >
Data</td>
<td >
Tax ID
</td>
<td></td>
</tr>
<tr >
<td>10</td>
<td ><code>is_frozen</code></td>
<td >
Check</td>
<td >
Is Frozen
</td>
<td></td>
</tr>
<tr class="info">
<td>11</td>
<td ><code>currency_and_price_list</code></td>
<td >
Section Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>12</td>
<td ><code>default_currency</code></td>
<td >
Link</td>
<td >
Billing Currency
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/geo/currency">Currency</a>
</td>
</tr>
<tr >
<td>13</td>
<td ><code>default_price_list</code></td>
<td >
Link</td>
<td >
Default Price List
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/stock/price_list">Price List</a>
</td>
</tr>
<tr >
<td>14</td>
<td ><code>column_break_14</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>15</td>
<td ><code>default_taxes_and_charges</code></td>
<td >
Link</td>
<td >
Default Taxes and Charges
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/accounts/sales_taxes_and_charges_template">Sales Taxes and Charges Template</a>
</td>
</tr>
<tr class="info">
<td>16</td>
<td ><code>address_contacts</code></td>
<td >
Section Break</td>
<td >
Address and Contact
</td>
<td>
<pre>icon-map-marker</pre>
</td>
</tr>
<tr >
<td>17</td>
<td ><code>address_html</code></td>
<td >
HTML</td>
<td >
Address HTML
</td>
<td></td>
</tr>
<tr >
<td>18</td>
<td ><code>column_break1</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>19</td>
<td ><code>contact_html</code></td>
<td >
HTML</td>
<td >
Contact HTML
</td>
<td></td>
</tr>
<tr class="info">
<td>20</td>
<td ><code>default_receivable_accounts</code></td>
<td >
Section Break</td>
<td >
Default Receivable Accounts
</td>
<td></td>
</tr>
<tr >
<td>21</td>
<td ><code>accounts</code></td>
<td >
Table</td>
<td >
Accounts
<p class="text-muted small">
Mention if non-standard receivable account</p>
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/accounts/party_account">Party Account</a>
</td>
</tr>
<tr class="info">
<td>22</td>
<td ><code>column_break2</code></td>
<td >
Section Break</td>
<td >
Credit Limit
</td>
<td></td>
</tr>
<tr >
<td>23</td>
<td ><code>credit_days_based_on</code></td>
<td >
Select</td>
<td >
Credit Days Based On
</td>
<td>
<pre>
Fixed Days
Last Day of the Next Month</pre>
</td>
</tr>
<tr >
<td>24</td>
<td ><code>credit_days</code></td>
<td >
Int</td>
<td >
Credit Days
</td>
<td></td>
</tr>
<tr >
<td>25</td>
<td ><code>credit_limit</code></td>
<td >
Currency</td>
<td >
Credit Limit
</td>
<td></td>
</tr>
<tr class="info">
<td>26</td>
<td ><code>more_info</code></td>
<td >
Section Break</td>
<td >
Customer Details
</td>
<td>
<pre>icon-file-text</pre>
</td>
</tr>
<tr >
<td>27</td>
<td ><code>customer_details</code></td>
<td >
Text</td>
<td >
Customer Details
<p class="text-muted small">
Additional information regarding the customer.</p>
</td>
<td></td>
</tr>
<tr >
<td>28</td>
<td ><code>website</code></td>
<td >
Data</td>
<td >
Website
</td>
<td></td>
</tr>
<tr class="info">
<td>29</td>
<td ><code>sales_team_section_break</code></td>
<td >
Section Break</td>
<td >
Sales Partner and Commission
</td>
<td>
<pre>icon-group</pre>
</td>
</tr>
<tr >
<td>30</td>
<td ><code>default_sales_partner</code></td>
<td >
Link</td>
<td >
Sales Partner
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/setup/sales_partner">Sales Partner</a>
</td>
</tr>
<tr >
<td>31</td>
<td ><code>default_commission_rate</code></td>
<td >
Float</td>
<td >
Commission Rate
</td>
<td></td>
</tr>
<tr class="info">
<td>32</td>
<td ><code>sales_team_section</code></td>
<td >
Section Break</td>
<td >
Sales Team
</td>
<td></td>
</tr>
<tr >
<td>33</td>
<td ><code>sales_team</code></td>
<td >
Table</td>
<td >
Sales Team Details
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/selling/sales_team">Sales Team</a>
</td>
</tr>
<tr >
<td>34</td>
<td ><code>communications</code></td>
<td >
Table</td>
<td class="text-muted" title="Hidden">
Communications
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/core/communication">Communication</a>
</td>
</tr>
</tbody>
</table>
<hr>
<h3>Controller</h3>
<h4>erpnext.selling.doctype.customer.customer</h4>
<h3 style="font-weight: normal;">Class <b>Customer</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="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, olddn, newdn, 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="create_lead_address_contact" href="#create_lead_address_contact" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>create_lead_address_contact</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="delete_customer_address" href="#delete_customer_address" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>delete_customer_address</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="delete_customer_contact" href="#delete_customer_contact" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>delete_customer_contact</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_customer_name" href="#get_customer_name" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_customer_name</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_feed" href="#get_feed" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_feed</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>Load address and contacts in <code>__onload</code></p>
</div>
<br>
<p class="docs-attr-name">
<a name="update_address" href="#update_address" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>update_address</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_contact" href="#update_contact" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>update_contact</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_customer_address" href="#update_customer_address" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>update_customer_address</b>
<i class="text-muted">(self, newdn, set_field)</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_lead_status" href="#update_lead_status" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>update_lead_status</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" 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_name_with_customer_group" href="#validate_name_with_customer_group" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>validate_name_with_customer_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>
</div>
<hr>
<p class="docs-attr-name">
<a name="erpnext.selling.doctype.customer.customer.check_credit_limit" href="#erpnext.selling.doctype.customer.customer.check_credit_limit" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
erpnext.selling.doctype.customer.customer.<b>check_credit_limit</b>
<i class="text-muted">(customer, 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.selling.doctype.customer.customer.get_credit_limit" href="#erpnext.selling.doctype.customer.customer.get_credit_limit" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
erpnext.selling.doctype.customer.customer.<b>get_credit_limit</b>
<i class="text-muted">(customer, 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.selling.doctype.customer.customer.get_customer_list" href="#erpnext.selling.doctype.customer.customer.get_customer_list" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
erpnext.selling.doctype.customer.customer.<b>get_customer_list</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>
<p class="docs-attr-name">
<a name="erpnext.selling.doctype.customer.customer.get_customer_outstanding" href="#erpnext.selling.doctype.customer.customer.get_customer_outstanding" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
erpnext.selling.doctype.customer.customer.<b>get_customer_outstanding</b>
<i class="text-muted">(customer, company)</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.selling.doctype.customer.customer.get_dashboard_info</code>
</p>
<p class="docs-attr-name">
<a name="erpnext.selling.doctype.customer.customer.get_dashboard_info" href="#erpnext.selling.doctype.customer.customer.get_dashboard_info" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
erpnext.selling.doctype.customer.customer.<b>get_dashboard_info</b>
<i class="text-muted">(customer)</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/utilities/address">Address</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/accounts/c_form">C-Form</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/utilities/contact">Contact</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/stock/delivery_note">Delivery Note</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/selling/installation_note">Installation Note</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/support/issue">Issue</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/stock/item_customer_detail">Item Customer Detail</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/crm/lead">Lead</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/support/maintenance_schedule">Maintenance Schedule</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/support/maintenance_visit">Maintenance Visit</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/crm/opportunity">Opportunity</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/pricing_rule">Pricing Rule</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/manufacturing/production_plan_sales_order">Production Plan Sales Order</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/manufacturing/production_planning_tool">Production Planning Tool</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/projects/project">Project</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/buying/purchase_order">Purchase Order</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/selling/quotation">Quotation</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/selling/sales_order">Sales Order</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/stock/serial_no">Serial No</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/selling/sms_center">SMS Center</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/accounts/tax_rule">Tax Rule</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/support/warranty_claim">Warranty Claim</a>
</li>
</ul>
<!-- autodoc -->
<!-- jinja -->
<!-- static -->