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

915 lines
21 KiB
HTML

<!-- title: Opportunity -->
<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/crm/doctype/opportunity"
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>tabOpportunity</code></p>
Potential Sales Deal
<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>from_section</code></td>
<td >
Section Break</td>
<td >
</td>
<td>
<pre>icon-user</pre>
</td>
</tr>
<tr >
<td>2</td>
<td class="danger" title="Mandatory"><code>naming_series</code></td>
<td >
Select</td>
<td >
Series
</td>
<td>
<pre>OPTY-</pre>
</td>
</tr>
<tr >
<td>3</td>
<td class="danger" title="Mandatory"><code>enquiry_from</code></td>
<td >
Select</td>
<td >
Opportunity From
</td>
<td>
<pre>
Lead
Customer</pre>
</td>
</tr>
<tr >
<td>4</td>
<td ><code>customer</code></td>
<td >
Link</td>
<td >
Customer
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/selling/customer">Customer</a>
</td>
</tr>
<tr >
<td>5</td>
<td ><code>lead</code></td>
<td >
Link</td>
<td >
Lead
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/crm/lead">Lead</a>
</td>
</tr>
<tr >
<td>6</td>
<td ><code>customer_name</code></td>
<td >
Data</td>
<td >
Customer / Lead Name
</td>
<td></td>
</tr>
<tr >
<td>7</td>
<td ><code>column_break0</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>8</td>
<td ><code>title</code></td>
<td >
Data</td>
<td class="text-muted" title="Hidden">
Title
</td>
<td></td>
</tr>
<tr >
<td>9</td>
<td class="danger" title="Mandatory"><code>enquiry_type</code></td>
<td >
Select</td>
<td >
Opportunity Type
</td>
<td>
<pre>Sales
Maintenance</pre>
</td>
</tr>
<tr >
<td>10</td>
<td class="danger" title="Mandatory"><code>status</code></td>
<td >
Select</td>
<td >
Status
</td>
<td>
<pre>Open
Quotation
Lost
Replied
Closed</pre>
</td>
</tr>
<tr >
<td>11</td>
<td ><code>order_lost_reason</code></td>
<td >
Small Text</td>
<td >
Lost Reason
</td>
<td></td>
</tr>
<tr >
<td>12</td>
<td ><code>with_items</code></td>
<td >
Check</td>
<td >
With Items
</td>
<td></td>
</tr>
<tr class="info">
<td>13</td>
<td ><code>items_section</code></td>
<td >
Section Break</td>
<td >
</td>
<td>
<pre>icon-shopping-cart</pre>
</td>
</tr>
<tr >
<td>14</td>
<td ><code>items</code></td>
<td >
Table</td>
<td >
Items
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/crm/opportunity_item">Opportunity Item</a>
</td>
</tr>
<tr class="info">
<td>15</td>
<td ><code>contact_info</code></td>
<td >
Section Break</td>
<td >
Contact Info
</td>
<td>
<pre>icon-bullhorn</pre>
</td>
</tr>
<tr >
<td>16</td>
<td ><code>customer_address</code></td>
<td >
Link</td>
<td >
Customer / Lead Address
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/utilities/address">Address</a>
</td>
</tr>
<tr >
<td>17</td>
<td ><code>address_display</code></td>
<td >
Small Text</td>
<td class="text-muted" title="Hidden">
Address
</td>
<td></td>
</tr>
<tr >
<td>18</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 >
<td>19</td>
<td ><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>20</td>
<td ><code>column_break3</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>21</td>
<td ><code>contact_person</code></td>
<td >
Link</td>
<td >
Contact Person
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/utilities/contact">Contact</a>
</td>
</tr>
<tr >
<td>22</td>
<td ><code>contact_display</code></td>
<td >
Small Text</td>
<td >
Contact
</td>
<td></td>
</tr>
<tr >
<td>23</td>
<td ><code>contact_email</code></td>
<td >
Small Text</td>
<td >
Contact Email
</td>
<td></td>
</tr>
<tr >
<td>24</td>
<td ><code>contact_mobile</code></td>
<td >
Small Text</td>
<td >
Contact Mobile No
</td>
<td></td>
</tr>
<tr class="info">
<td>25</td>
<td ><code>more_info</code></td>
<td >
Section Break</td>
<td >
Source
</td>
<td>
<pre>icon-file-text</pre>
</td>
</tr>
<tr >
<td>26</td>
<td ><code>source</code></td>
<td >
Select</td>
<td >
Source
</td>
<td>
<pre>
Existing Customer
Reference
Advertisement
Cold Calling
Exhibition
Supplier Reference
Mass Mailing
Customer's Vendor
Campaign
Walk In</pre>
</td>
</tr>
<tr >
<td>27</td>
<td ><code>campaign</code></td>
<td >
Link</td>
<td >
Campaign
<p class="text-muted small">
Enter name of campaign if source of enquiry is campaign</p>
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/selling/campaign">Campaign</a>
</td>
</tr>
<tr >
<td>28</td>
<td ><code>column_break1</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>29</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>30</td>
<td class="danger" title="Mandatory"><code>transaction_date</code></td>
<td >
Date</td>
<td >
Opportunity Date
</td>
<td></td>
</tr>
<tr >
<td>31</td>
<td class="danger" title="Mandatory"><code>fiscal_year</code></td>
<td >
Link</td>
<td >
Fiscal Year
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/accounts/fiscal_year">Fiscal Year</a>
</td>
</tr>
<tr class="info">
<td>32</td>
<td ><code>next_contact</code></td>
<td >
Section Break</td>
<td >
Next Contact
</td>
<td></td>
</tr>
<tr >
<td>33</td>
<td ><code>contact_by</code></td>
<td >
Link</td>
<td >
Next Contact By
<p class="text-muted small">
Your sales person who will contact the customer in future</p>
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/core/user">User</a>
</td>
</tr>
<tr >
<td>34</td>
<td ><code>contact_date</code></td>
<td >
Datetime</td>
<td >
Next Contact Date
<p class="text-muted small">
Your sales person will get a reminder on this date to contact the customer</p>
</td>
<td></td>
</tr>
<tr >
<td>35</td>
<td ><code>column_break2</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>36</td>
<td ><code>to_discuss</code></td>
<td >
Small Text</td>
<td >
To Discuss
</td>
<td></td>
</tr>
<tr >
<td>37</td>
<td ><code>amended_from</code></td>
<td >
Link</td>
<td >
Amended From
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/crm/opportunity">Opportunity</a>
</td>
</tr>
</tbody>
</table>
<hr>
<h3>Controller</h3>
<h4>erpnext.crm.doctype.opportunity.opportunity</h4>
<h3 style="font-weight: normal;">Class <b>Opportunity</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="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="after_insert" href="#after_insert" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>after_insert</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="declare_enquiry_lost" href="#declare_enquiry_lost" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>declare_enquiry_lost</b>
<i class="text-muted">(self, arg)</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_cust_address" href="#get_cust_address" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_cust_address</b>
<i class="text-muted">(self, 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="has_ordered_quotation" href="#has_ordered_quotation" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>has_ordered_quotation</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_quotation" href="#has_quotation" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>has_quotation</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="make_new_lead_if_required" href="#make_new_lead_if_required" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>make_new_lead_if_required</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>Set lead against new opportunity</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="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_cust_name" href="#validate_cust_name" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>validate_cust_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="validate_item_details" href="#validate_item_details" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>validate_item_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_lead_cust" href="#validate_lead_cust" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>validate_lead_cust</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><span class="label label-info">Public API</span>
<br><code>/api/method/erpnext.crm.doctype.opportunity.opportunity.get_item_details</code>
</p>
<p class="docs-attr-name">
<a name="erpnext.crm.doctype.opportunity.opportunity.get_item_details" href="#erpnext.crm.doctype.opportunity.opportunity.get_item_details" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
erpnext.crm.doctype.opportunity.opportunity.<b>get_item_details</b>
<i class="text-muted">(item_code)</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.opportunity.opportunity.make_quotation</code>
</p>
<p class="docs-attr-name">
<a name="erpnext.crm.doctype.opportunity.opportunity.make_quotation" href="#erpnext.crm.doctype.opportunity.opportunity.make_quotation" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
erpnext.crm.doctype.opportunity.opportunity.<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>
<p><span class="label label-info">Public API</span>
<br><code>/api/method/erpnext.crm.doctype.opportunity.opportunity.set_multiple_status</code>
</p>
<p class="docs-attr-name">
<a name="erpnext.crm.doctype.opportunity.opportunity.set_multiple_status" href="#erpnext.crm.doctype.opportunity.opportunity.set_multiple_status" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
erpnext.crm.doctype.opportunity.opportunity.<b>set_multiple_status</b>
<i class="text-muted">(names, status)</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/crm/opportunity">Opportunity</a>
</li>
</ul>
<!-- autodoc -->
<!-- jinja -->
<!-- static -->