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

2419 lines
58 KiB
HTML
Raw Normal View History

2015-12-03 12:58:19 +00:00
<!-- title: Sales Order -->
<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/sales_order"
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>tabSales Order</code></p>
<h3>Fields</h3>
2015-12-10 11:47:41 +00:00
<table class="table table-bordered">
2015-12-03 12:58:19 +00:00
<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>SO-</pre>
</td>
</tr>
<tr >
<td>5</td>
<td class="danger" title="Mandatory"><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>6</td>
<td ><code>customer_name</code></td>
<td >
Data</td>
<td >
Customer Name
</td>
<td></td>
</tr>
<tr >
<td>7</td>
<td ><code>address_display</code></td>
<td >
Small Text</td>
<td class="text-muted" title="Hidden">
Address
</td>
<td></td>
</tr>
<tr >
<td>8</td>
<td ><code>contact_display</code></td>
<td >
Small Text</td>
<td class="text-muted" title="Hidden">
Contact
</td>
<td></td>
</tr>
<tr >
<td>9</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>10</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>11</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 >
<td>12</td>
<td ><code>column_break1</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>13</td>
<td ><code>amended_from</code></td>
<td >
Link</td>
<td class="text-muted" title="Hidden">
Amended From
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/selling/sales_order">Sales Order</a>
</td>
</tr>
<tr >
<td>14</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>15</td>
<td class="danger" title="Mandatory"><code>transaction_date</code></td>
<td >
Date</td>
<td >
Date
</td>
<td></td>
</tr>
<tr >
<td>16</td>
<td ><code>delivery_date</code></td>
<td >
Date</td>
<td >
Delivery Date
</td>
<td></td>
</tr>
<tr >
<td>17</td>
<td ><code>po_no</code></td>
<td >
Data</td>
<td >
Customer's Purchase Order
</td>
<td></td>
</tr>
<tr >
<td>18</td>
<td ><code>po_date</code></td>
<td >
Date</td>
<td >
Customer's Purchase Order Date
</td>
<td></td>
</tr>
<tr >
<td>19</td>
<td ><code>shipping_address_name</code></td>
<td >
Link</td>
<td class="text-muted" title="Hidden">
Shipping Address Name
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/utilities/address">Address</a>
</td>
</tr>
<tr >
<td>20</td>
<td ><code>shipping_address</code></td>
<td >
Small Text</td>
<td class="text-muted" title="Hidden">
Shipping Address
</td>
<td></td>
</tr>
<tr class="info">
<td>21</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>22</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>23</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>24</td>
<td ><code>column_break2</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>25</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>26</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>27</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>28</td>
<td ><code>ignore_pricing_rule</code></td>
<td >
Check</td>
<td >
Ignore Pricing Rule
</td>
<td></td>
</tr>
<tr class="info">
<td>29</td>
<td ><code>items_section</code></td>
<td >
Section Break</td>
<td >
</td>
<td>
<pre>icon-shopping-cart</pre>
</td>
</tr>
<tr >
<td>30</td>
<td class="danger" title="Mandatory"><code>items</code></td>
<td >
Table</td>
<td >
Items
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/selling/sales_order_item">Sales Order Item</a>
</td>
</tr>
<tr class="info">
<td>31</td>
<td ><code>section_break_31</code></td>
<td >
Section Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>32</td>
<td ><code>column_break_33a</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>33</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>34</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>35</td>
<td ><code>column_break_33</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>36</td>
<td ><code>total</code></td>
<td >
Currency</td>
<td >
Total
</td>
<td>
<pre>currency</pre>
</td>
</tr>
<tr >
<td>37</td>
<td ><code>net_total</code></td>
<td >
Currency</td>
<td >
Net Total
</td>
<td>
<pre>currency</pre>
</td>
</tr>
<tr class="info">
<td>38</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>39</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>40</td>
<td ><code>column_break_38</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>41</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>42</td>
<td ><code>section_break_40</code></td>
<td >
Section Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>43</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>44</td>
<td ><code>other_charges_calculation</code></td>
<td >
HTML</td>
<td >
Taxes and Charges Calculation
</td>
<td></td>
</tr>
<tr class="info">
<td>45</td>
<td ><code>section_break_43</code></td>
<td >
Section Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>46</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>47</td>
<td ><code>column_break_46</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>48</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>49</td>
<td ><code>section_break_48</code></td>
<td >
Section Break</td>
<td >
Additional Discount
</td>
<td></td>
</tr>
<tr >
<td>50</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>51</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>52</td>
2015-12-03 12:58:19 +00:00
<td ><code>column_break_50</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>53</td>
<td ><code>additional_discount_percentage</code></td>
2015-12-03 12:58:19 +00:00
<td >
Float</td>
2015-12-03 12:58:19 +00:00
<td >
Additional Discount Percentage
2015-12-03 12:58:19 +00:00
</td>
<td></td>
2015-12-03 12:58:19 +00:00
</tr>
<tr >
<td>54</td>
<td ><code>discount_amount</code></td>
2015-12-03 12:58:19 +00:00
<td >
Currency</td>
<td >
Additional Discount Amount
2015-12-03 12:58:19 +00:00
</td>
<td>
<pre>currency</pre>
2015-12-03 12:58:19 +00:00
</td>
</tr>
<tr class="info">
<td>55</td>
2015-12-03 12:58:19 +00:00
<td ><code>totals</code></td>
<td >
Section Break</td>
<td >
</td>
<td>
<pre>icon-money</pre>
</td>
</tr>
<tr >
<td>56</td>
2015-12-03 12:58:19 +00:00
<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>57</td>
2015-12-03 12:58:19 +00:00
<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>58</td>
2015-12-03 12:58:19 +00:00
<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 Sales Order.</p>
</td>
<td></td>
</tr>
<tr >
<td>59</td>
2015-12-03 12:58:19 +00:00
<td ><code>column_break3</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>60</td>
2015-12-03 12:58:19 +00:00
<td ><code>grand_total</code></td>
<td >
Currency</td>
<td >
Grand Total
</td>
<td>
<pre>currency</pre>
</td>
</tr>
<tr >
<td>61</td>
2015-12-03 12:58:19 +00:00
<td ><code>rounded_total</code></td>
<td >
Currency</td>
<td >
Rounded Total
</td>
<td>
<pre>currency</pre>
</td>
</tr>
<tr >
<td>62</td>
2015-12-03 12:58:19 +00:00
<td ><code>in_words</code></td>
<td >
Data</td>
<td >
In Words
</td>
<td></td>
</tr>
<tr >
<td>63</td>
2015-12-03 12:58:19 +00:00
<td ><code>advance_paid</code></td>
<td >
Currency</td>
<td >
Advance Paid
</td>
<td>
<pre>Company:company:default_currency</pre>
</td>
</tr>
<tr class="info">
<td>64</td>
2015-12-03 12:58:19 +00:00
<td ><code>packing_list</code></td>
<td >
Section Break</td>
<td >
Packing List
</td>
<td>
<pre>icon-suitcase</pre>
</td>
</tr>
<tr >
<td>65</td>
2015-12-03 12:58:19 +00:00
<td ><code>packed_items</code></td>
<td >
Table</td>
<td >
Packed Items
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/stock/packed_item">Packed Item</a>
</td>
</tr>
<tr class="info">
<td>66</td>
2015-12-03 12:58:19 +00:00
<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>67</td>
2015-12-03 12:58:19 +00:00
<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>68</td>
2015-12-03 12:58:19 +00:00
<td ><code>terms</code></td>
<td >
Text Editor</td>
<td >
Terms and Conditions Details
</td>
<td></td>
</tr>
<tr class="info">
<td>69</td>
2015-12-03 12:58:19 +00:00
<td ><code>contact_info</code></td>
<td >
Section Break</td>
<td >
Contact Details
</td>
<td>
<pre>icon-bullhorn</pre>
</td>
</tr>
<tr >
<td>70</td>
2015-12-03 12:58:19 +00:00
<td ><code>col_break45</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>71</td>
2015-12-03 12:58:19 +00:00
<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>72</td>
2015-12-03 12:58:19 +00:00
<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>73</td>
2015-12-03 12:58:19 +00:00
<td ><code>col_break46</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>74</td>
2015-12-03 12:58:19 +00:00
<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>75</td>
2015-12-03 12:58:19 +00:00
<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>76</td>
2015-12-03 12:58:19 +00:00
<td ><code>more_info</code></td>
<td >
Section Break</td>
<td >
More Information
</td>
<td>
<pre>icon-file-text</pre>
</td>
</tr>
<tr >
<td>77</td>
2015-12-03 12:58:19 +00:00
<td ><code>project_name</code></td>
<td >
Link</td>
<td >
Project Name
<p class="text-muted small">
Track this Sales Order against any Project</p>
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/projects/project">Project</a>
</td>
</tr>
<tr >
<td>78</td>
2015-12-03 12:58:19 +00:00
<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>79</td>
2015-12-03 12:58:19 +00:00
<td ><code>column_break_77</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>80</td>
2015-12-03 12:58:19 +00:00
<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>81</td>
2015-12-03 12:58:19 +00:00
<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 class="info">
<td>82</td>
2015-12-03 12:58:19 +00:00
<td ><code>printing_details</code></td>
<td >
Section Break</td>
<td >
Printing Details
</td>
<td></td>
</tr>
<tr >
<td>83</td>
2015-12-03 12:58:19 +00:00
<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>84</td>
2015-12-03 12:58:19 +00:00
<td ><code>column_break4</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>85</td>
2015-12-03 12:58:19 +00:00
<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>86</td>
2015-12-03 12:58:19 +00:00
<td ><code>section_break_78</code></td>
<td >
Section Break</td>
<td >
Billing and Delivery Status
</td>
<td></td>
</tr>
<tr >
<td>87</td>
2015-12-03 12:58:19 +00:00
<td class="danger" title="Mandatory"><code>status</code></td>
<td >
Select</td>
<td >
Status
</td>
<td>
<pre>
Draft
To Deliver and Bill
To Bill
To Deliver
Completed
Stopped
Cancelled
Closed</pre>
</td>
</tr>
<tr >
<td>88</td>
2015-12-03 12:58:19 +00:00
<td ><code>delivery_status</code></td>
<td >
Select</td>
<td class="text-muted" title="Hidden">
Delivery Status
</td>
<td>
<pre>Not Delivered
Fully Delivered
Partly Delivered
Closed
Not Applicable</pre>
</td>
</tr>
<tr >
<td>89</td>
2015-12-03 12:58:19 +00:00
<td ><code>per_delivered</code></td>
<td >
Percent</td>
<td >
% Delivered
<p class="text-muted small">
% of materials delivered against this Sales Order</p>
</td>
<td></td>
</tr>
<tr >
<td>90</td>
2015-12-03 12:58:19 +00:00
<td ><code>column_break_81</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>91</td>
2015-12-03 12:58:19 +00:00
<td ><code>per_billed</code></td>
<td >
Percent</td>
<td >
% Amount Billed
<p class="text-muted small">
% of materials billed against this Sales Order</p>
</td>
<td></td>
</tr>
<tr >
<td>92</td>
2015-12-03 12:58:19 +00:00
<td ><code>billing_status</code></td>
<td >
Select</td>
<td class="text-muted" title="Hidden">
Billing Status
</td>
<td>
<pre>Not Billed
Fully Billed
Partly Billed
Closed</pre>
</td>
</tr>
<tr class="info">
<td>93</td>
2015-12-03 12:58:19 +00:00
<td ><code>sales_team_section_break</code></td>
<td >
Section Break</td>
<td >
Commission
</td>
<td>
<pre>icon-group</pre>
</td>
</tr>
<tr >
<td>94</td>
2015-12-03 12:58:19 +00:00
<td ><code>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>95</td>
2015-12-03 12:58:19 +00:00
<td ><code>column_break7</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>96</td>
2015-12-03 12:58:19 +00:00
<td ><code>commission_rate</code></td>
<td >
Float</td>
<td >
Commission Rate
</td>
<td></td>
</tr>
<tr >
<td>97</td>
2015-12-03 12:58:19 +00:00
<td ><code>total_commission</code></td>
<td >
Currency</td>
<td >
Total Commission
</td>
<td>
<pre>Company:company:default_currency</pre>
</td>
</tr>
<tr class="info">
<td>98</td>
2015-12-03 12:58:19 +00:00
<td ><code>section_break1</code></td>
<td >
Section Break</td>
<td >
Sales Team
</td>
<td></td>
</tr>
<tr >
<td>99</td>
2015-12-03 12:58:19 +00:00
<td ><code>sales_team</code></td>
<td >
Table</td>
<td >
Sales Team1
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/selling/sales_team">Sales Team</a>
</td>
</tr>
<tr class="info">
<td>100</td>
2015-12-03 12:58:19 +00:00
<td ><code>recurring_order</code></td>
<td >
Section Break</td>
<td >
Recurring Order
</td>
<td>
<pre>icon-time</pre>
</td>
</tr>
<tr >
<td>101</td>
2015-12-03 12:58:19 +00:00
<td ><code>is_recurring</code></td>
<td >
Check</td>
<td >
Is Recurring
<p class="text-muted small">
Check if recurring order, uncheck to stop recurring or put proper End Date</p>
</td>
<td></td>
</tr>
<tr >
<td>102</td>
2015-12-03 12:58:19 +00:00
<td ><code>recurring_type</code></td>
<td >
Select</td>
<td >
Recurring Type
<p class="text-muted small">
Select the period when the invoice will be generated automatically</p>
</td>
<td>
<pre>
Monthly
Quarterly
Half-yearly
Yearly</pre>
</td>
</tr>
<tr >
<td>103</td>
2015-12-03 12:58:19 +00:00
<td ><code>from_date</code></td>
<td >
Date</td>
<td >
From Date
<p class="text-muted small">
Start date of current order's period</p>
</td>
<td></td>
</tr>
<tr >
<td>104</td>
2015-12-03 12:58:19 +00:00
<td ><code>to_date</code></td>
<td >
Date</td>
<td >
To Date
<p class="text-muted small">
End date of current order's period</p>
</td>
<td></td>
</tr>
<tr >
<td>105</td>
2015-12-03 12:58:19 +00:00
<td ><code>repeat_on_day_of_month</code></td>
<td >
Int</td>
<td >
Repeat on Day of Month
<p class="text-muted small">
The day of the month on which auto order will be generated e.g. 05, 28 etc </p>
</td>
<td></td>
</tr>
<tr >
<td>106</td>
2015-12-03 12:58:19 +00:00
<td ><code>end_date</code></td>
<td >
Date</td>
<td >
End Date
<p class="text-muted small">
The date on which recurring order will be stop</p>
</td>
<td></td>
</tr>
<tr >
<td>107</td>
2015-12-03 12:58:19 +00:00
<td ><code>column_break83</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>108</td>
2015-12-03 12:58:19 +00:00
<td ><code>next_date</code></td>
<td >
Date</td>
<td >
Next Date
<p class="text-muted small">
The date on which next invoice will be generated. It is generated on submit.</p>
</td>
<td></td>
</tr>
<tr >
<td>109</td>
2015-12-03 12:58:19 +00:00
<td ><code>recurring_id</code></td>
<td >
Data</td>
<td >
Recurring Id
</td>
<td></td>
</tr>
<tr >
<td>110</td>
2015-12-03 12:58:19 +00:00
<td ><code>notification_email_address</code></td>
<td >
Small Text</td>
<td >
Notification Email Address
<p class="text-muted small">
Enter email id separated by commas, order will be mailed automatically on particular date</p>
</td>
<td></td>
</tr>
<tr >
<td>111</td>
2015-12-03 12:58:19 +00:00
<td ><code>recurring_print_format</code></td>
<td >
Link</td>
<td >
Recurring Print Format
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/print/print_format">Print Format</a>
</td>
</tr>
</tbody>
</table>
<hr>
<h3>Controller</h3>
<h4>erpnext.selling.doctype.sales_order.sales_order</h4>
<h3 style="font-weight: normal;">Class <b>SalesOrder</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="before_update_after_submit" href="#before_update_after_submit" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>before_update_after_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="check_credit_limit" href="#check_credit_limit" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>check_credit_limit</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_modified_date" href="#check_modified_date" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>check_modified_date</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_nextdoc_docstatus" href="#check_nextdoc_docstatus" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>check_nextdoc_docstatus</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>
2016-01-27 06:52:27 +00:00
<p class="docs-attr-name">
<a name="on_recurring" href="#on_recurring" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>on_recurring</b>
<i class="text-muted">(self, reference_doc)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
2015-12-03 12:58:19 +00:00
<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="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="product_bundle_has_stock_item" href="#product_bundle_has_stock_item" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>product_bundle_has_stock_item</b>
<i class="text-muted">(self, product_bundle)</i>
</p>
<div class="docs-attr-desc"><p>Returns true if product bundle has stock item</p>
</div>
<br>
<p class="docs-attr-name">
<a name="set_indicator" href="#set_indicator" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>set_indicator</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>Set indicator for portal</p>
</div>
<br>
2015-12-03 12:58:19 +00:00
<p class="docs-attr-name">
<a name="update_delivery_status" href="#update_delivery_status" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>update_delivery_status</b>
2015-12-09 11:58:51 +00:00
<i class="text-muted">(self)</i>
2015-12-03 12:58:19 +00:00
</p>
<div class="docs-attr-desc"><p>Update delivery status from Purchase Order for drop shipping</p>
</div>
<br>
<p class="docs-attr-name">
<a name="update_enquiry_status" href="#update_enquiry_status" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>update_enquiry_status</b>
<i class="text-muted">(self, prevdoc, flag)</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_prevdoc_status" href="#update_prevdoc_status" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>update_prevdoc_status</b>
<i class="text-muted">(self, flag)</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_reserved_qty" href="#update_reserved_qty" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>update_reserved_qty</b>
<i class="text-muted">(self, so_item_rows=None)</i>
</p>
<div class="docs-attr-desc"><p>update requested qty (before ordered_qty is updated)</p>
</div>
<br>
<p class="docs-attr-name">
<a name="update_status" href="#update_status" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>update_status</b>
<i class="text-muted">(self, status)</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_delivery_date" href="#validate_delivery_date" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>validate_delivery_date</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_drop_ship" href="#validate_drop_ship" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>validate_drop_ship</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_for_items" href="#validate_for_items" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>validate_for_items</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_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_po" href="#validate_po" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>validate_po</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_proj_cust" href="#validate_proj_cust" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>validate_proj_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>
<p class="docs-attr-name">
<a name="validate_sales_mntc_quotation" href="#validate_sales_mntc_quotation" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>validate_sales_mntc_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="validate_supplier_after_submit" href="#validate_supplier_after_submit" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>validate_supplier_after_submit</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>Check that supplier is the same after submit if PO is already made</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)</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_with_previous_doc" href="#validate_with_previous_doc" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>validate_with_previous_doc</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>WarehouseRequired</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><span class="label label-info">Public API</span>
<br><code>/api/method/erpnext.selling.doctype.sales_order.sales_order.get_events</code>
</p>
<p class="docs-attr-name">
<a name="erpnext.selling.doctype.sales_order.sales_order.get_events" href="#erpnext.selling.doctype.sales_order.sales_order.get_events" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
erpnext.selling.doctype.sales_order.sales_order.<b>get_events</b>
<i class="text-muted">(start, end, filters=None)</i>
</p>
<div class="docs-attr-desc"><p>Returns events for Gantt / Calendar view rendering.</p>
<p><strong>Parameters:</strong></p>
<ul>
<li><strong><code>start</code></strong> - Start date-time.</li>
<li><strong><code>end</code></strong> - End date-time.</li>
<li><strong><code>filters</code></strong> - Filters (JSON).</li>
</ul>
</div>
<br>
<p class="docs-attr-name">
<a name="erpnext.selling.doctype.sales_order.sales_order.get_list_context" href="#erpnext.selling.doctype.sales_order.sales_order.get_list_context" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
erpnext.selling.doctype.sales_order.sales_order.<b>get_list_context</b>
<i class="text-muted">(context=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.selling.doctype.sales_order.sales_order.get_supplier</code>
</p>
<p class="docs-attr-name">
<a name="erpnext.selling.doctype.sales_order.sales_order.get_supplier" href="#erpnext.selling.doctype.sales_order.sales_order.get_supplier" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
erpnext.selling.doctype.sales_order.sales_order.<b>get_supplier</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><span class="label label-info">Public API</span>
<br><code>/api/method/erpnext.selling.doctype.sales_order.sales_order.make_delivery_note</code>
</p>
<p class="docs-attr-name">
<a name="erpnext.selling.doctype.sales_order.sales_order.make_delivery_note" href="#erpnext.selling.doctype.sales_order.sales_order.make_delivery_note" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
erpnext.selling.doctype.sales_order.sales_order.<b>make_delivery_note</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.selling.doctype.sales_order.sales_order.make_maintenance_schedule</code>
</p>
<p class="docs-attr-name">
<a name="erpnext.selling.doctype.sales_order.sales_order.make_maintenance_schedule" href="#erpnext.selling.doctype.sales_order.sales_order.make_maintenance_schedule" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
erpnext.selling.doctype.sales_order.sales_order.<b>make_maintenance_schedule</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.selling.doctype.sales_order.sales_order.make_maintenance_visit</code>
</p>
<p class="docs-attr-name">
<a name="erpnext.selling.doctype.sales_order.sales_order.make_maintenance_visit" href="#erpnext.selling.doctype.sales_order.sales_order.make_maintenance_visit" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
erpnext.selling.doctype.sales_order.sales_order.<b>make_maintenance_visit</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.selling.doctype.sales_order.sales_order.make_material_request</code>
</p>
<p class="docs-attr-name">
<a name="erpnext.selling.doctype.sales_order.sales_order.make_material_request" href="#erpnext.selling.doctype.sales_order.sales_order.make_material_request" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
erpnext.selling.doctype.sales_order.sales_order.<b>make_material_request</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.selling.doctype.sales_order.sales_order.make_purchase_order_for_drop_shipment</code>
</p>
<p class="docs-attr-name">
<a name="erpnext.selling.doctype.sales_order.sales_order.make_purchase_order_for_drop_shipment" href="#erpnext.selling.doctype.sales_order.sales_order.make_purchase_order_for_drop_shipment" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
erpnext.selling.doctype.sales_order.sales_order.<b>make_purchase_order_for_drop_shipment</b>
<i class="text-muted">(source_name, for_supplier, 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.selling.doctype.sales_order.sales_order.make_sales_invoice</code>
</p>
<p class="docs-attr-name">
<a name="erpnext.selling.doctype.sales_order.sales_order.make_sales_invoice" href="#erpnext.selling.doctype.sales_order.sales_order.make_sales_invoice" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
erpnext.selling.doctype.sales_order.sales_order.<b>make_sales_invoice</b>
<i class="text-muted">(source_name, target_doc=None, ignore_permissions=False)</i>
2015-12-03 12:58:19 +00:00
</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.sales_order.sales_order.stop_or_unstop_sales_orders</code>
</p>
<p class="docs-attr-name">
<a name="erpnext.selling.doctype.sales_order.sales_order.stop_or_unstop_sales_orders" href="#erpnext.selling.doctype.sales_order.sales_order.stop_or_unstop_sales_orders" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
erpnext.selling.doctype.sales_order.sales_order.<b>stop_or_unstop_sales_orders</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>
<p><span class="label label-info">Public API</span>
<br><code>/api/method/erpnext.selling.doctype.sales_order.sales_order.update_status</code>
</p>
<p class="docs-attr-name">
<a name="erpnext.selling.doctype.sales_order.sales_order.update_status" href="#erpnext.selling.doctype.sales_order.sales_order.update_status" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
erpnext.selling.doctype.sales_order.sales_order.<b>update_status</b>
<i class="text-muted">(status, name)</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/stock/delivery_note_item">Delivery Note Item</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/stock/material_request_item">Material Request Item</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/manufacturing/production_order">Production Order</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/manufacturing/production_plan_item">Production Plan Item</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/projects/project">Project</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/selling/sales_order">Sales Order</a>
</li>
</ul>
<!-- autodoc -->
<!-- jinja -->
<!-- static -->