brotherton-erpnext/erpnext/docs/current/models/crm/lead.html
2015-12-10 17:58:12 +05:30

865 lines
19 KiB
HTML

<!-- title: Lead -->
<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/crm/doctype/lead"
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>tabLead</code></p>
<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>lead_details</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>LEAD-</pre>
</td>
</tr>
<tr >
<td>3</td>
<td class="danger" title="Mandatory"><code>lead_name</code></td>
<td >
Data</td>
<td >
Person Name
</td>
<td></td>
</tr>
<tr >
<td>4</td>
<td ><code>company_name</code></td>
<td >
Data</td>
<td >
Organization Name
</td>
<td></td>
</tr>
<tr >
<td>5</td>
<td ><code>email_id</code></td>
<td >
Data</td>
<td >
Email Id
</td>
<td>
<pre>Email</pre>
</td>
</tr>
<tr >
<td>6</td>
<td ><code>col_break123</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>7</td>
<td class="danger" title="Mandatory"><code>status</code></td>
<td >
Select</td>
<td >
Status
</td>
<td>
<pre>Lead
Open
Replied
Opportunity
Interested
Converted
Do Not Contact</pre>
</td>
</tr>
<tr >
<td>8</td>
<td ><code>source</code></td>
<td >
Select</td>
<td >
Source
</td>
<td>
<pre>
Advertisement
Blog Post
Campaign
Call
Customer
Exhibition
Supplier
Website
Email</pre>
</td>
</tr>
<tr >
<td>9</td>
<td ><code>customer</code></td>
<td >
Link</td>
<td >
From Customer
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/selling/customer">Customer</a>
</td>
</tr>
<tr >
<td>10</td>
<td ><code>campaign_name</code></td>
<td >
Link</td>
<td >
Campaign Name
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/selling/campaign">Campaign</a>
</td>
</tr>
<tr class="info">
<td>11</td>
<td ><code>section_break_12</code></td>
<td >
Section Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>12</td>
<td ><code>lead_owner</code></td>
<td >
Link</td>
<td >
Lead Owner
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/core/user">User</a>
</td>
</tr>
<tr >
<td>13</td>
<td ><code>column_break_14</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>14</td>
<td ><code>contact_by</code></td>
<td >
Link</td>
<td >
Next Contact By
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/core/user">User</a>
</td>
</tr>
<tr >
<td>15</td>
<td ><code>contact_date</code></td>
<td >
Datetime</td>
<td >
Next Contact Date
<p class="text-muted small">
Add to calendar on this date</p>
</td>
<td></td>
</tr>
<tr class="info">
<td>16</td>
<td ><code>contact_info</code></td>
<td >
Section Break</td>
<td >
Address & Contact
</td>
<td>
<pre>icon-map-marker</pre>
</td>
</tr>
<tr >
<td>17</td>
<td ><code>address_desc</code></td>
<td >
HTML</td>
<td >
Address Desc
</td>
<td></td>
</tr>
<tr >
<td>18</td>
<td ><code>address_html</code></td>
<td >
HTML</td>
<td >
Address HTML
</td>
<td></td>
</tr>
<tr >
<td>19</td>
<td ><code>column_break2</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>20</td>
<td ><code>phone</code></td>
<td >
Data</td>
<td >
Phone
</td>
<td></td>
</tr>
<tr >
<td>21</td>
<td ><code>mobile_no</code></td>
<td >
Data</td>
<td >
Mobile No.
</td>
<td></td>
</tr>
<tr >
<td>22</td>
<td ><code>fax</code></td>
<td >
Data</td>
<td >
Fax
</td>
<td></td>
</tr>
<tr >
<td>23</td>
<td ><code>website</code></td>
<td >
Data</td>
<td >
Website
</td>
<td></td>
</tr>
<tr >
<td>24</td>
<td ><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 class="info">
<td>25</td>
<td ><code>more_info</code></td>
<td >
Section Break</td>
<td >
More Information
</td>
<td>
<pre>icon-file-text</pre>
</td>
</tr>
<tr >
<td>26</td>
<td ><code>type</code></td>
<td >
Select</td>
<td >
Lead Type
</td>
<td>
<pre>
Client
Channel Partner
Consultant</pre>
</td>
</tr>
<tr >
<td>27</td>
<td ><code>market_segment</code></td>
<td >
Select</td>
<td >
Market Segment
</td>
<td>
<pre>
Lower Income
Middle Income
Upper Income</pre>
</td>
</tr>
<tr >
<td>28</td>
<td ><code>industry</code></td>
<td >
Link</td>
<td >
Industry
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/selling/industry_type">Industry Type</a>
</td>
</tr>
<tr >
<td>29</td>
<td ><code>request_type</code></td>
<td >
Select</td>
<td >
Request Type
</td>
<td>
<pre>
Product Enquiry
Request for Information
Suggestions
Other</pre>
</td>
</tr>
<tr >
<td>30</td>
<td ><code>fiscal_year</code></td>
<td >
Link</td>
<td class="text-muted" title="Hidden">
Fiscal Year
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/accounts/fiscal_year">Fiscal Year</a>
</td>
</tr>
<tr >
<td>31</td>
<td ><code>column_break3</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>32</td>
<td ><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>33</td>
<td ><code>unsubscribed</code></td>
<td >
Check</td>
<td >
Unsubscribed
</td>
<td></td>
</tr>
<tr >
<td>34</td>
<td ><code>blog_subscriber</code></td>
<td >
Check</td>
<td >
Blog Subscriber
</td>
<td></td>
</tr>
</tbody>
</table>
<hr>
<h3>Controller</h3>
<h4>erpnext.crm.doctype.lead.lead</h4>
<h3 style="font-weight: normal;">Class <b>Lead</b></h3>
<p style="padding-left: 30px;"><i>Inherits from erpnext.controllers.selling_controller.SellingController</i></h4>
<div class="docs-attr-desc"><p></p>
</div>
<div style="padding-left: 30px;">
<p class="docs-attr-name">
<a name="add_calendar_event" href="#add_calendar_event" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>add_calendar_event</b>
<i class="text-muted">(self, opts=None, force=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_email_id_is_unique" href="#check_email_id_is_unique" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>check_email_id_is_unique</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="has_customer" href="#has_customer" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>has_customer</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="has_opportunity" href="#has_opportunity" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>has_opportunity</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="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>
</div>
<hr>
<p class="docs-attr-name">
<a name="erpnext.crm.doctype.lead.lead._make_customer" href="#erpnext.crm.doctype.lead.lead._make_customer" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
erpnext.crm.doctype.lead.lead.<b>_make_customer</b>
<i class="text-muted">(source_name, target_doc=None, ignore_permissions=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.crm.doctype.lead.lead.get_lead_details</code>
</p>
<p class="docs-attr-name">
<a name="erpnext.crm.doctype.lead.lead.get_lead_details" href="#erpnext.crm.doctype.lead.lead.get_lead_details" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
erpnext.crm.doctype.lead.lead.<b>get_lead_details</b>
<i class="text-muted">(lead)</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.crm.doctype.lead.lead.make_customer</code>
</p>
<p class="docs-attr-name">
<a name="erpnext.crm.doctype.lead.lead.make_customer" href="#erpnext.crm.doctype.lead.lead.make_customer" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
erpnext.crm.doctype.lead.lead.<b>make_customer</b>
<i class="text-muted">(source_name, target_doc=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.crm.doctype.lead.lead.make_opportunity</code>
</p>
<p class="docs-attr-name">
<a name="erpnext.crm.doctype.lead.lead.make_opportunity" href="#erpnext.crm.doctype.lead.lead.make_opportunity" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
erpnext.crm.doctype.lead.lead.<b>make_opportunity</b>
<i class="text-muted">(source_name, target_doc=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.crm.doctype.lead.lead.make_quotation</code>
</p>
<p class="docs-attr-name">
<a name="erpnext.crm.doctype.lead.lead.make_quotation" href="#erpnext.crm.doctype.lead.lead.make_quotation" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
erpnext.crm.doctype.lead.lead.<b>make_quotation</b>
<i class="text-muted">(source_name, target_doc=None)</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/selling/customer">Customer</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/crm/opportunity">Opportunity</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/selling/quotation">Quotation</a>
</li>
</ul>
<!-- autodoc -->
<!-- jinja -->
<!-- static -->