brotherton-erpnext/erpnext/docs/current/models/selling/quotation.html

1514 lines
34 KiB
HTML

<!-- title: Quotation -->
<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/selling/doctype/quotation"
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>tabQuotation</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>customer_section</code></td>
<td >
Section Break</td>
<td >
</td>
<td>
<pre>icon-user</pre>
</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 ><code>title</code></td>
<td >
Data</td>
<td class="text-muted" title="Hidden">
Title
</td>
<td></td>
</tr>
<tr >
<td>4</td>
<td class="danger" title="Mandatory"><code>naming_series</code></td>
<td >
Select</td>
<td >
Series
</td>
<td>
<pre>QTN-</pre>
</td>
</tr>
<tr >
<td>5</td>
<td class="danger" title="Mandatory"><code>quotation_to</code></td>
<td >
Select</td>
<td >
Quotation To
</td>
<td>
<pre>
Lead
Customer</pre>
</td>
</tr>
<tr >
<td>6</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>7</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>8</td>
<td ><code>customer_name</code></td>
<td >
Data</td>
<td class="text-muted" title="Hidden">
Customer / Lead Name
</td>
<td></td>
</tr>
<tr >
<td>9</td>
<td ><code>address_display</code></td>
<td >
Small Text</td>
<td class="text-muted" title="Hidden">
Address
</td>
<td></td>
</tr>
<tr >
<td>10</td>
<td ><code>contact_display</code></td>
<td >
Small Text</td>
<td class="text-muted" title="Hidden">
Contact
</td>
<td></td>
</tr>
<tr >
<td>11</td>
<td ><code>contact_mobile</code></td>
<td >
Small Text</td>
<td class="text-muted" title="Hidden">
Mobile No
</td>
<td></td>
</tr>
<tr >
<td>12</td>
<td ><code>contact_email</code></td>
<td >
Small Text</td>
<td class="text-muted" title="Hidden">
Contact Email
</td>
<td></td>
</tr>
<tr >
<td>13</td>
<td ><code>column_break1</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>14</td>
<td ><code>amended_from</code></td>
<td >
Link</td>
<td >
Amended From
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/selling/quotation">Quotation</a>
</td>
</tr>
<tr >
<td>15</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>16</td>
<td class="danger" title="Mandatory"><code>transaction_date</code></td>
<td >
Date</td>
<td >
Date
</td>
<td></td>
</tr>
<tr >
<td>17</td>
<td class="danger" title="Mandatory"><code>order_type</code></td>
<td >
Select</td>
<td >
Order Type
</td>
<td>
<pre>
Sales
Maintenance
Shopping Cart</pre>
</td>
</tr>
<tr class="info">
<td>18</td>
<td ><code>currency_and_price_list</code></td>
<td >
Section Break</td>
<td >
Currency and Price List
</td>
<td>
<pre>icon-tag</pre>
</td>
</tr>
<tr >
<td>19</td>
<td class="danger" title="Mandatory"><code>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>20</td>
<td class="danger" title="Mandatory"><code>conversion_rate</code></td>
<td >
Float</td>
<td >
Exchange Rate
<p class="text-muted small">
Rate at which customer's currency is converted to company's base currency</p>
</td>
<td></td>
</tr>
<tr >
<td>21</td>
<td ><code>column_break2</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>22</td>
<td class="danger" title="Mandatory"><code>selling_price_list</code></td>
<td >
Link</td>
<td >
Price List
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/stock/price_list">Price List</a>
</td>
</tr>
<tr >
<td>23</td>
<td class="danger" title="Mandatory"><code>price_list_currency</code></td>
<td >
Link</td>
<td >
Price List Currency
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/geo/currency">Currency</a>
</td>
</tr>
<tr >
<td>24</td>
<td class="danger" title="Mandatory"><code>plc_conversion_rate</code></td>
<td >
Float</td>
<td >
Price List Exchange Rate
<p class="text-muted small">
Rate at which Price list currency is converted to company's base currency</p>
</td>
<td></td>
</tr>
<tr >
<td>25</td>
<td ><code>ignore_pricing_rule</code></td>
<td >
Check</td>
<td >
Ignore Pricing Rule
</td>
<td></td>
</tr>
<tr class="info">
<td>26</td>
<td ><code>items_section</code></td>
<td >
Section Break</td>
<td >
</td>
<td>
<pre>icon-shopping-cart</pre>
</td>
</tr>
<tr >
<td>27</td>
<td ><code>items</code></td>
<td >
Table</td>
<td >
Items
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/selling/quotation_item">Quotation Item</a>
</td>
</tr>
<tr class="info">
<td>28</td>
<td ><code>sec_break23</code></td>
<td >
Section Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>29</td>
<td ><code>base_total</code></td>
<td >
Currency</td>
<td >
Total (Company Currency)
</td>
<td>
<pre>Company:company:default_currency</pre>
</td>
</tr>
<tr >
<td>30</td>
<td ><code>base_net_total</code></td>
<td >
Currency</td>
<td >
Net Total (Company Currency)
</td>
<td>
<pre>Company:company:default_currency</pre>
</td>
</tr>
<tr >
<td>31</td>
<td ><code>column_break_28</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>32</td>
<td ><code>total</code></td>
<td >
Currency</td>
<td >
Total
</td>
<td>
<pre>currency</pre>
</td>
</tr>
<tr >
<td>33</td>
<td ><code>net_total</code></td>
<td >
Currency</td>
<td >
Net Total
</td>
<td>
<pre>currency</pre>
</td>
</tr>
<tr class="info">
<td>34</td>
<td ><code>taxes_section</code></td>
<td >
Section Break</td>
<td >
Taxes and Charges
</td>
<td>
<pre>icon-money</pre>
</td>
</tr>
<tr >
<td>35</td>
<td ><code>taxes_and_charges</code></td>
<td >
Link</td>
<td >
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 >
<td>36</td>
<td ><code>column_break_34</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>37</td>
<td ><code>shipping_rule</code></td>
<td >
Link</td>
<td >
Shipping Rule
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/accounts/shipping_rule">Shipping Rule</a>
</td>
</tr>
<tr class="info">
<td>38</td>
<td ><code>section_break_36</code></td>
<td >
Section Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>39</td>
<td ><code>taxes</code></td>
<td >
Table</td>
<td >
Sales Taxes and Charges
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/accounts/sales_taxes_and_charges">Sales Taxes and Charges</a>
</td>
</tr>
<tr >
<td>40</td>
<td ><code>other_charges_calculation</code></td>
<td >
HTML</td>
<td >
Taxes and Charges Calculation
</td>
<td></td>
</tr>
<tr class="info">
<td>41</td>
<td ><code>section_break_39</code></td>
<td >
Section Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>42</td>
<td ><code>base_total_taxes_and_charges</code></td>
<td >
Currency</td>
<td >
Total Taxes and Charges (Company Currency)
</td>
<td>
<pre>Company:company:default_currency</pre>
</td>
</tr>
<tr >
<td>43</td>
<td ><code>column_break_42</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>44</td>
<td ><code>total_taxes_and_charges</code></td>
<td >
Currency</td>
<td >
Total Taxes and Charges
</td>
<td>
<pre>currency</pre>
</td>
</tr>
<tr class="info">
<td>45</td>
<td ><code>section_break_44</code></td>
<td >
Section Break</td>
<td >
Additional Discount
</td>
<td></td>
</tr>
<tr >
<td>46</td>
<td ><code>apply_discount_on</code></td>
<td >
Select</td>
<td >
Apply Additional Discount On
</td>
<td>
<pre>
Grand Total
Net Total</pre>
</td>
</tr>
<tr >
<td>47</td>
<td ><code>base_discount_amount</code></td>
<td >
Currency</td>
<td >
Additional Discount Amount (Company Currency)
</td>
<td>
<pre>Company:company:default_currency</pre>
</td>
</tr>
<tr >
<td>48</td>
<td ><code>column_break_46</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>49</td>
<td ><code>additional_discount_percentage</code></td>
<td >
Float</td>
<td >
Additional Discount Percentage
</td>
<td></td>
</tr>
<tr >
<td>50</td>
<td ><code>discount_amount</code></td>
<td >
Currency</td>
<td >
Additional Discount Amount
</td>
<td>
<pre>currency</pre>
</td>
</tr>
<tr class="info">
<td>51</td>
<td ><code>totals</code></td>
<td >
Section Break</td>
<td >
</td>
<td>
<pre>icon-money</pre>
</td>
</tr>
<tr >
<td>52</td>
<td ><code>base_grand_total</code></td>
<td >
Currency</td>
<td >
Grand Total (Company Currency)
</td>
<td>
<pre>Company:company:default_currency</pre>
</td>
</tr>
<tr >
<td>53</td>
<td ><code>base_rounded_total</code></td>
<td >
Currency</td>
<td >
Rounded Total (Company Currency)
</td>
<td>
<pre>Company:company:default_currency</pre>
</td>
</tr>
<tr >
<td>54</td>
<td ><code>base_in_words</code></td>
<td >
Data</td>
<td >
In Words (Company Currency)
<p class="text-muted small">
In Words will be visible once you save the Quotation.</p>
</td>
<td></td>
</tr>
<tr >
<td>55</td>
<td ><code>column_break3</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>56</td>
<td ><code>grand_total</code></td>
<td >
Currency</td>
<td >
Grand Total
</td>
<td>
<pre>currency</pre>
</td>
</tr>
<tr >
<td>57</td>
<td ><code>rounded_total</code></td>
<td >
Currency</td>
<td >
Rounded Total
</td>
<td>
<pre>currency</pre>
</td>
</tr>
<tr >
<td>58</td>
<td ><code>in_words</code></td>
<td >
Data</td>
<td >
In Words
</td>
<td></td>
</tr>
<tr class="info">
<td>59</td>
<td ><code>terms_section_break</code></td>
<td >
Section Break</td>
<td >
Terms and Conditions
</td>
<td>
<pre>icon-legal</pre>
</td>
</tr>
<tr >
<td>60</td>
<td ><code>tc_name</code></td>
<td >
Link</td>
<td >
Terms
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/setup/terms_and_conditions">Terms and Conditions</a>
</td>
</tr>
<tr >
<td>61</td>
<td ><code>terms</code></td>
<td >
Text Editor</td>
<td >
Term Details
</td>
<td></td>
</tr>
<tr class="info">
<td>62</td>
<td ><code>contact_section</code></td>
<td >
Section Break</td>
<td >
Contact Details
</td>
<td>
<pre>icon-bullhorn</pre>
</td>
</tr>
<tr >
<td>63</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>64</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>65</td>
<td ><code>shipping_address_name</code></td>
<td >
Link</td>
<td >
Shipping Address
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/utilities/address">Address</a>
</td>
</tr>
<tr >
<td>66</td>
<td ><code>shipping_address</code></td>
<td >
Small Text</td>
<td class="text-muted" title="Hidden">
Shipping Address
</td>
<td></td>
</tr>
<tr >
<td>67</td>
<td ><code>col_break98</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>68</td>
<td ><code>customer_address</code></td>
<td >
Link</td>
<td >
Customer Address
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/utilities/address">Address</a>
</td>
</tr>
<tr >
<td>69</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 class="info">
<td>70</td>
<td ><code>print_settings</code></td>
<td >
Section Break</td>
<td >
Print Settings
</td>
<td></td>
</tr>
<tr >
<td>71</td>
<td ><code>letter_head</code></td>
<td >
Link</td>
<td >
Letter Head
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/print/letter_head">Letter Head</a>
</td>
</tr>
<tr >
<td>72</td>
<td ><code>select_print_heading</code></td>
<td >
Link</td>
<td >
Print Heading
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/setup/print_heading">Print Heading</a>
</td>
</tr>
<tr class="info">
<td>73</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>74</td>
<td ><code>campaign</code></td>
<td >
Link</td>
<td >
Campaign
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/selling/campaign">Campaign</a>
</td>
</tr>
<tr >
<td>75</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</pre>
</td>
</tr>
<tr >
<td>76</td>
<td ><code>order_lost_reason</code></td>
<td >
Small Text</td>
<td >
Quotation Lost Reason
</td>
<td></td>
</tr>
<tr >
<td>77</td>
<td ><code>column_break4</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>78</td>
<td class="danger" title="Mandatory"><code>status</code></td>
<td >
Select</td>
<td >
Status
</td>
<td>
<pre>Draft
Submitted
Ordered
Lost
Cancelled
Open
Replied</pre>
</td>
</tr>
<tr >
<td>79</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 >
<td>80</td>
<td ><code>enq_det</code></td>
<td >
Text</td>
<td class="text-muted" title="Hidden">
Opportunity Item
</td>
<td></td>
</tr>
</tbody>
</table>
<hr>
<h3>Controller</h3>
<h4>erpnext.selling.doctype.quotation.quotation</h4>
<h3 style="font-weight: normal;">Class <b>Quotation</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="check_item_table" href="#check_item_table" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>check_item_table</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_order_lost" href="#declare_order_lost" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>declare_order_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="has_sales_order" href="#has_sales_order" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>has_sales_order</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_cancel" href="#on_cancel" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>on_cancel</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_submit" href="#on_submit" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>on_submit</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="print_other_charges" href="#print_other_charges" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>print_other_charges</b>
<i class="text-muted">(self, docname)</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_opportunity" href="#update_opportunity" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>update_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="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_order_type" href="#validate_order_type" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>validate_order_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="validate_quotation_to" href="#validate_quotation_to" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>validate_quotation_to</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.quotation.quotation._make_customer" href="#erpnext.selling.doctype.quotation.quotation._make_customer" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
erpnext.selling.doctype.quotation.quotation.<b>_make_customer</b>
<i class="text-muted">(source_name, ignore_permissions=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.selling.doctype.quotation.quotation._make_sales_order" href="#erpnext.selling.doctype.quotation.quotation._make_sales_order" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
erpnext.selling.doctype.quotation.quotation.<b>_make_sales_order</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.selling.doctype.quotation.quotation.make_sales_order</code>
</p>
<p class="docs-attr-name">
<a name="erpnext.selling.doctype.quotation.quotation.make_sales_order" href="#erpnext.selling.doctype.quotation.quotation.make_sales_order" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
erpnext.selling.doctype.quotation.quotation.<b>make_sales_order</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/selling/quotation">Quotation</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/selling/sales_order_item">Sales Order Item</a>
</li>
</ul>
<!-- autodoc -->
<!-- jinja -->
<!-- static -->