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

1125 lines
26 KiB
HTML

<!-- title: BOM -->
<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/manufacturing/doctype/bom"
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>tabBOM</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 >
<td>1</td>
<td class="danger" title="Mandatory"><code>item</code></td>
<td >
Link</td>
<td >
Item
<p class="text-muted small">
Item to be manufactured or repacked</p>
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/stock/item">Item</a>
</td>
</tr>
<tr >
<td>2</td>
<td ><code>item_name</code></td>
<td >
Data</td>
<td >
Item Name
</td>
<td></td>
</tr>
<tr >
<td>3</td>
<td ><code>rm_cost_as_per</code></td>
<td >
Select</td>
<td >
Rate Of Materials Based On
</td>
<td>
<pre>Valuation Rate
Last Purchase Rate
Price List</pre>
</td>
</tr>
<tr >
<td>4</td>
<td ><code>buying_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>5</td>
<td ><code>cb0</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>6</td>
<td ><code>is_active</code></td>
<td >
Check</td>
<td >
Is Active
</td>
<td></td>
</tr>
<tr >
<td>7</td>
<td ><code>is_default</code></td>
<td >
Check</td>
<td >
Is Default
</td>
<td></td>
</tr>
<tr >
<td>8</td>
<td ><code>with_operations</code></td>
<td >
Check</td>
<td >
With Operations
<p class="text-muted small">
Manage cost of operations</p>
</td>
<td></td>
</tr>
<tr class="info">
<td>9</td>
<td ><code>operations_section</code></td>
<td >
Section Break</td>
<td >
Operations
<p class="text-muted small">
Specify the operations, operating cost and give a unique Operation no to your operations.</p>
</td>
<td></td>
</tr>
<tr >
<td>10</td>
<td ><code>operations</code></td>
<td >
Table</td>
<td >
Operations
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/manufacturing/bom_operation">BOM Operation</a>
</td>
</tr>
<tr class="info">
<td>11</td>
<td ><code>materials_section</code></td>
<td >
Section Break</td>
<td >
Materials
</td>
<td></td>
</tr>
<tr >
<td>12</td>
<td ><code>items</code></td>
<td >
Table</td>
<td >
Items
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/manufacturing/bom_item">BOM Item</a>
</td>
</tr>
<tr >
<td>13</td>
<td class="danger" title="Mandatory"><code>quantity</code></td>
<td >
Float</td>
<td >
Quantity
<p class="text-muted small">
Quantity of item obtained after manufacturing / repacking from given quantities of raw materials</p>
</td>
<td></td>
</tr>
<tr class="info">
<td>14</td>
<td ><code>costing</code></td>
<td >
Section Break</td>
<td >
Costing
</td>
<td></td>
</tr>
<tr >
<td>15</td>
<td ><code>operating_cost</code></td>
<td >
Currency</td>
<td >
Operating Cost
</td>
<td>
<pre>Company:company:default_currency</pre>
</td>
</tr>
<tr >
<td>16</td>
<td ><code>raw_material_cost</code></td>
<td >
Currency</td>
<td >
Raw Material Cost
</td>
<td>
<pre>Company:company:default_currency</pre>
</td>
</tr>
<tr >
<td>17</td>
<td ><code>cb1</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>18</td>
<td ><code>total_cost</code></td>
<td >
Currency</td>
<td >
Total Cost
</td>
<td>
<pre>Company:company:default_currency</pre>
</td>
</tr>
<tr class="info">
<td>19</td>
<td ><code>more_info_section</code></td>
<td >
Section Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>20</td>
<td ><code>project_name</code></td>
<td >
Link</td>
<td >
Project Name
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/projects/project">Project</a>
</td>
</tr>
<tr >
<td>21</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>22</td>
<td ><code>amended_from</code></td>
<td >
Link</td>
<td >
Amended From
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/manufacturing/bom">BOM</a>
</td>
</tr>
<tr >
<td>23</td>
<td ><code>col_break23</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>24</td>
<td ><code>uom</code></td>
<td >
Link</td>
<td >
Item UOM
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/setup/uom">UOM</a>
</td>
</tr>
<tr class="info">
<td>25</td>
<td ><code>section_break_25</code></td>
<td >
Section Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>26</td>
<td ><code>description</code></td>
<td >
Small Text</td>
<td >
Item Desription
</td>
<td></td>
</tr>
<tr >
<td>27</td>
<td ><code>column_break_27</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>28</td>
<td ><code>image</code></td>
<td >
Attach</td>
<td >
Image
</td>
<td></td>
</tr>
<tr >
<td>29</td>
<td ><code>image_view</code></td>
<td >
Image</td>
<td >
Image View
</td>
<td>
<pre>image</pre>
</td>
</tr>
<tr class="info">
<td>30</td>
<td ><code>section_break0</code></td>
<td >
Section Break</td>
<td >
Materials Required (Exploded)
</td>
<td></td>
</tr>
<tr >
<td>31</td>
<td ><code>exploded_items</code></td>
<td >
Table</td>
<td >
Exploded_items
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/manufacturing/bom_explosion_item">BOM Explosion Item</a>
</td>
</tr>
</tbody>
</table>
<hr>
<h3>Controller</h3>
<h4>erpnext.manufacturing.doctype.bom.bom</h4>
<h3 style="font-weight: normal;">Class <b>BOM</b></h3>
<p style="padding-left: 30px;"><i>Inherits from frappe.model.document.Document</i></h4>
<div class="docs-attr-desc"><p></p>
</div>
<div style="padding-left: 30px;">
<p class="docs-attr-name">
<a name="add_exploded_items" href="#add_exploded_items" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>add_exploded_items</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>Add items to Flat BOM table</p>
</div>
<br>
<p class="docs-attr-name">
<a name="add_to_cur_exploded_items" href="#add_to_cur_exploded_items" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>add_to_cur_exploded_items</b>
<i class="text-muted">(self, args)</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="calculate_cost" href="#calculate_cost" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>calculate_cost</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>Calculate bom totals</p>
</div>
<br>
<p class="docs-attr-name">
<a name="calculate_op_cost" href="#calculate_op_cost" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>calculate_op_cost</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>Update workstation rate and calculates totals</p>
</div>
<br>
<p class="docs-attr-name">
<a name="calculate_rm_cost" href="#calculate_rm_cost" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>calculate_rm_cost</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>Fetch RM rate as per today's valuation rate and calculate totals</p>
</div>
<br>
<p class="docs-attr-name">
<a name="check_recursion" href="#check_recursion" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>check_recursion</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>Check whether recursion occurs in any bom</p>
</div>
<br>
<p class="docs-attr-name">
<a name="clear_operations" href="#clear_operations" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>clear_operations</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_bom_material_detail" href="#get_bom_material_detail" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_bom_material_detail</b>
<i class="text-muted">(self, args=None)</i>
</p>
<div class="docs-attr-desc"><p>Get raw material details like uom, desc and rate</p>
</div>
<br>
<p class="docs-attr-name">
<a name="get_bom_unitcost" href="#get_bom_unitcost" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_bom_unitcost</b>
<i class="text-muted">(self, bom_no)</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_child_exploded_items" href="#get_child_exploded_items" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_child_exploded_items</b>
<i class="text-muted">(self, bom_no, qty)</i>
</p>
<div class="docs-attr-desc"><p>Add all items from Flat BOM of child BOM</p>
</div>
<br>
<p class="docs-attr-name">
<a name="get_exploded_items" href="#get_exploded_items" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_exploded_items</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>Get all raw materials including items from child bom</p>
</div>
<br>
<p class="docs-attr-name">
<a name="get_item_det" href="#get_item_det" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_item_det</b>
<i class="text-muted">(self, item_code)</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_rm_rate" href="#get_rm_rate" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_rm_rate</b>
<i class="text-muted">(self, arg)</i>
</p>
<div class="docs-attr-desc"><pre><code>Get raw material rate as per selected method, if bom exists takes bom cost
</code></pre>
</div>
<br>
<p class="docs-attr-name">
<a name="get_valuation_rate" href="#get_valuation_rate" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_valuation_rate</b>
<i class="text-muted">(self, args)</i>
</p>
<div class="docs-attr-desc"><p>Get weighted average of valuation rate from all warehouses </p>
</div>
<br>
<p class="docs-attr-name">
<a name="manage_default_bom" href="#manage_default_bom" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>manage_default_bom</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>Uncheck others if current one is selected as default,
update default bom in item master</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="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="on_update_after_submit" href="#on_update_after_submit" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>on_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="set_bom_material_details" href="#set_bom_material_details" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>set_bom_material_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="traverse_tree" href="#traverse_tree" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>traverse_tree</b>
<i class="text-muted">(self, bom_list=[])</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_cost" href="#update_cost" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>update_cost</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_cost_and_exploded_items" href="#update_cost_and_exploded_items" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>update_cost_and_exploded_items</b>
<i class="text-muted">(self, bom_list=[])</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_exploded_items" href="#update_exploded_items" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>update_exploded_items</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>Update Flat BOM, following will be correct data</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_bom_links" href="#validate_bom_links" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>validate_bom_links</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_main_item" href="#validate_main_item" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>validate_main_item</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>Validate main FG item</p>
</div>
<br>
<p class="docs-attr-name">
<a name="validate_materials" href="#validate_materials" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>validate_materials</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>Validate raw material entries </p>
</div>
<br>
<p class="docs-attr-name">
<a name="validate_operations" href="#validate_operations" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>validate_operations</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_rm_item" href="#validate_rm_item" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>validate_rm_item</b>
<i class="text-muted">(self, item)</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.manufacturing.doctype.bom.bom.get_bom_items</code>
</p>
<p class="docs-attr-name">
<a name="erpnext.manufacturing.doctype.bom.bom.get_bom_items" href="#erpnext.manufacturing.doctype.bom.bom.get_bom_items" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
erpnext.manufacturing.doctype.bom.bom.<b>get_bom_items</b>
<i class="text-muted">(bom, company, qty=1, fetch_exploded=1)</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.manufacturing.doctype.bom.bom.get_bom_items_as_dict" href="#erpnext.manufacturing.doctype.bom.bom.get_bom_items_as_dict" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
erpnext.manufacturing.doctype.bom.bom.<b>get_bom_items_as_dict</b>
<i class="text-muted">(bom, company, qty=1, fetch_exploded=1)</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.manufacturing.doctype.bom.bom.validate_bom_no" href="#erpnext.manufacturing.doctype.bom.bom.validate_bom_no" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
erpnext.manufacturing.doctype.bom.bom.<b>validate_bom_no</b>
<i class="text-muted">(item, bom_no)</i>
</p>
<div class="docs-attr-desc"><p>Validate BOM No of sub-contracted items</p>
</div>
<br>
<h4>Linked In:</h4>
<ul>
<li>
<a href="https://frappe.github.io/erpnext/current/models/manufacturing/bom">BOM</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/manufacturing/bom_item">BOM Item</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/manufacturing/bom_replace_tool">BOM Replace Tool</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/stock/item">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/buying/purchase_order_item">Purchase Order Item</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/stock/purchase_receipt_item">Purchase Receipt Item</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/stock/stock_entry_detail">Stock Entry Detail</a>
</li>
</ul>
<!-- autodoc -->
<!-- jinja -->
<!-- static -->