Merge pull request #158 from eeintech/orders

PO/SO doc

docs/build/bom.md

@@ -85,7 +85,7 @@ The `Create BOM Item` form will be displayed:
 {% include 'img.html' %}
 {% endwith %}
 
-Fill-out the `Quantity` (required), `Reference`, `Overage` and `Note` (optional) fields then click on the "Submit" button to add the BOM item to this part's BOM.
+Fill-out the `Quantity` (required), `Reference`, `Overage` and `Note` (optional) fields then click on <span class="badge inventree confirm">Submit</span> to add the BOM item to this part's BOM.
 
 ### Upload BOM
 
@@ -145,7 +145,7 @@ After [adding BOM items manually](#add-bom-item) or [uploading a BOM file](#uplo
 
 The first message in the red box `The BOM for PCBA TEST has changed, and must be validated.` points out that InvenTree BOM needs to be "validated". BOM validation is a way to ensure a BOM does not have duplicate items/parts.
 
-To process with BOM validation, click on the <span class='fas fa-clipboard-check'></span> icon and the `Validate BOM` form will be displayed. Click one the "Validate" switch then click on the "Submit" button.
+To process with BOM validation, click on the <span class='fas fa-clipboard-check'></span> icon and the `Validate BOM` form will be displayed. Click one the "Validate" switch then click on <span class="badge inventree confirm">Submit</span>
 
 Voilà, this Bill of Materials is validated <span class='far fa-smile'></span>
 

docs/companies/customer.md

@@ -6,23 +6,23 @@ title: Customers
 
 A customer is an external client to whom parts are sold.
 
-To access the customer page, click on the "Sell" navigation tab and click on "Customers" option in the dropdown list.
+To access the customer page, click on the <span class="badge inventree nav main"><span class='fas fa-truck'></span> Sell</span> navigation tab and click on <span class="badge inventree nav main"><span class='fas fa-user-tie'></span> Customers</span> option in the dropdown list.
 
 !!! warning
 	**Viewing**, **adding**, **editing** and **deleting** customers require the corresponding [Sales Orders user permissions](../admin/permissions.md)
 
 ### Add Customer
 
-Once the customer page is loaded, click on the "<span class='fas fa-plus-circle'></span> New Customer" button: the "Create new Customer" form opens. Fill-in the manufacturer informations (`Company name` and `Company description` are required) then click on the "Submit" button.
+Once the customer page is loaded, click on the <span class="badge inventree add"><span class='fas fa-plus-circle'></span> New Customer</span> button: the "Create new Customer" form opens. Fill-in the manufacturer informations (`Company name` and `Company description` are required) then click on <span class="badge inventree confirm">Submit</span>
 
 ### Edit Customer
 
 To edit a customer, click on its name in the list of customers.
 
-After the customer details are loaded, click on the <span class='fas fa-edit'></span> icon under the customer name. Edit the customer information then click on the "Submit" button.
+After the customer details are loaded, click on the <span class='fas fa-edit'></span> icon under the customer name. Edit the customer information then click on <span class="badge inventree confirm">Submit</span>
 
 ### Delete Customer
 
 To delete a customer, click on its name in the list of customers.
 
-After the customer details are loaded, click on the <span class='fas fa-trash-alt'></span> icon under the customer name. Confirm the deletion using the checkbox then click on the "Submit" button.
+After the customer details are loaded, click on the <span class='fas fa-trash-alt'></span> icon under the customer name. Confirm the deletion using the checkbox then click on <span class="badge inventree confirm">Submit</span>

docs/companies/manufacturer.md

@@ -6,14 +6,14 @@ title: Manufacturers
 
 A manufacturer is an external **producer** of parts and raw materials.
 
-To access the manufacturer page, click on the "Buy" navigation tab and click on "Manufacturers" option in the dropdown list.
+To access the manufacturer page, click on the <span class="badge inventree nav main"><span class='fas fa-shopping-cart'></span> Buy</span> navigation tab and click on <span class="badge inventree nav main"><span class='fas fa-industry'></span> Manufacturers</span> option in the dropdown list.
 
 !!! warning
 	**Viewing**, **adding**, **editing** and **deleting** manufacturers require the corresponding [Purchase Orders user permissions](../admin/permissions.md)
 
 ### Add Manufacturer
 
-Once the manufacturer page is loaded, click on the "<span class='fas fa-plus-circle'></span> New Manufacturer" button: the "Create new Manufacturer" form opens. Fill-in the manufacturer informations (`Company name` and `Company description` are required) then click on the "Submit" button.
+Once the manufacturer page is loaded, click on the <span class="badge inventree add"><span class='fas fa-plus-circle'></span> New Manufacturer</span> button: the "Create new Manufacturer" form opens. Fill-in the manufacturer informations (`Company name` and `Company description` are required) then click on <span class="badge inventree confirm">Submit</span>
 
 !!! info "Manufacturer vs Supplier"
 	In the case the manufacturer sells directly to customers, you may want to enable the checkbox `is supplier` before submitting the form (you can also enable it later on). Purchase orders rely exclusively on [supplier parts](./supplier.md#supplier-parts), therefore the manufacturer will need to be set as a supplier too.
@@ -22,7 +22,7 @@ Once the manufacturer page is loaded, click on the "<span class='fas fa-plus-cir
 
 To edit a manufacturer, click on its name in the list of manufacturers.
 
-After the manufacturer details are loaded, click on the <span class='fas fa-edit'></span> icon under the manufacturer name. Edit the manufacturer information then click on the "Submit" button.
+After the manufacturer details are loaded, click on the <span class='fas fa-edit'></span> icon under the manufacturer name. Edit the manufacturer information then click on <span class="badge inventree confirm">Submit</span>
 
 ### Delete Manufacturer
 
@@ -31,7 +31,7 @@ After the manufacturer details are loaded, click on the <span class='fas fa-edit
 
 To delete a manufacturer, click on its name in the list of manufacturers.
 
-After the manufacturer details are loaded, click on the <span class='fas fa-trash-alt'></span> icon under the manufacturer name. Review the list of manufacturer parts to be deleted in consequence of deleting this manufacturer. Confirm the deletion using the checkbox then click on the "Submit" button.
+After the manufacturer details are loaded, click on the <span class='fas fa-trash-alt'></span> icon under the manufacturer name. Review the list of manufacturer parts to be deleted in consequence of deleting this manufacturer. Confirm the deletion using the checkbox then click on <span class="badge inventree confirm">Submit</span>
 
 ## Manufacturer Parts
 
@@ -44,22 +44,22 @@ Manufacturer parts are linked to a manufacturer and defined as manufacturable it
 
 To create a manufacturer part, you have the following options:
 
-* either navigate to a Part detail page then click on the "Manufacturers" tab
+* either navigate to a Part detail page then click on the <span class="badge inventree nav side"><span class='fas fa-building'></span> Suppliers</span> tab
-* or navigate to a Manufacturer detail page then click on the "Manufactured Parts" tab.
+* or navigate to a Manufacturer detail page then click on the <span class="badge inventree nav side"><span class='fas fa-industry'></span> Manufactured Parts</span> tab.
 
-Whichever you pick, click on the "<span class='fas fa-plus-circle'></span> New Manufacturer Part" button to load the "Create New Manufacturer Part" form. Fill out the form with the manufacturer part information then click on the "Submit" button.
+Whichever you pick, click on the <span class="badge inventree add"><span class='fas fa-plus-circle'></span> New Manufacturer Part</span> button to load the "Create New Manufacturer Part" form. Fill out the form with the manufacturer part information then click on <span class="badge inventree confirm">Submit</span>
 
 ### Edit Manufacturer Part
 
 To edit a manufacturer part, first access the manufacturer part detail page with one of the following options:
 
-* either navigate to a Part detail page, click on the "Manufacturers" tab then click on the "MPN" link
+* either navigate to a Part detail page, click on the <span class="badge inventree nav side"><span class='fas fa-building'></span> Suppliers</span> tab then, in the <span class="badge inventree nav main">Part Manufacturers</span> table, click on the _MPN_ link
-* or navigate to a Manufacturer detail page, click on the "Manufactured Parts" tab then click on the "MPN" link.
+* or navigate to a Manufacturer detail page, click on the <span class="badge inventree nav side"><span class='fas fa-industry'></span> Manufactured Parts</span> tab then click on the _MPN_ link.
 
-After the manufacturer part details are loaded, click on the <span class='fas fa-edit'></span> icon next to the manufacturer part image. Edit the manufacturer part information then click on the "Submit" button.
+After the manufacturer part details are loaded, click on the <span class='fas fa-edit'></span> icon next to the manufacturer part image. Edit the manufacturer part information then click on <span class="badge inventree confirm">Submit</span>
 
 ### Delete Manufacturer Part
 
 To delete a manufacturer part, first access the manufacturer part detail page like in the [Edit Manufacturer Part](#edit-manufacturer-part) section.
 
-After the manufacturer part details are loaded, click on the <span class='fas fa-trash-alt'></span> icon next to the manufacturer part image. Review the the information for the manufacturer part to be deleted, confirm the deletion using the checkbox then click on the "Submit" button.
+After the manufacturer part details are loaded, click on the <span class='fas fa-trash-alt'></span> icon next to the manufacturer part image. Review the the information for the manufacturer part to be deleted, confirm the deletion using the checkbox then click on <span class="badge inventree confirm">Submit</span>

docs/companies/po.md

@@ -4,12 +4,66 @@ title: Purchase Order
 
 ## Purchase Orders
 
-To access the purchase order page, click on the "Buy" navigation tab and click on "Purchase Orders" option in the dropdown list.
+Purchase orders allow to track which parts are bought from suppliers and manufacturers, therefore converting externally bought items into stock items / inventory.
 
-!!! missing "TODO"
+To access the purchase order page, click on the <span class="badge inventree nav main"><span class='fas fa-shopping-cart'></span> Buy</span> navigation tab and click on <span class="badge inventree nav main"><span class='fas fa-list'></span> Purchase Orders</span> option in the dropdown list.
-	This section requires further work
 
-## Line Items
+### Create Purchase Order
 
-!!! missing "TODO"
+Once the purchase order page is loaded, click on <span class="badge inventree add"><span class='fas fa-plus-circle'></span> New Purchase Order</span> which opens the "Create Purchase Order" form.
-	This section requires further work
+
+A purchase order is linked to a specific supplier, select one in the list of existing suppliers.
+
+!!! warning
+	Only companies with the "Supplier" attribute enabled will be shown and can be selected
+
+Fill out the rest of the form with the purchase order information then click on <span class="badge inventree confirm">Submit</span> 
+
+### Add Line Items
+
+On the purchase order detail page, user can link parts to the purchase order selecting the <span class="badge inventree nav side"><span class='fas fa-list'></span> Order Items</span> tab then clicking on the <span class="badge inventree add"><span class='fas fa-plus-circle'></span> Add Line Item</span> button.
+
+Once the "Add Line Item" form opens, select a supplier part in the list.
+
+!!! warning
+    Only parts from the supplier selected for the purchase order will be shown and can be selected
+
+Fill out the rest of the form then click on <span class="badge inventree confirm">Submit</span> 
+
+#### Upload File
+
+It is possible to upload an exported purchase order from the supplier instead of manually entering each line item. To start the process, click on <span class="badge inventree confirm"><span class='fas fa-upload'></span> Upload File</span> button next to the <span class="badge inventree add"><span class='fas fa-plus-circle'></span> Add Line Item</span> button and follow the steps.
+
+!!! info "Supported Formats"
+	This process only supports tabular data and the following formats are supported: CSV, TSV, XLS, XLSX, JSON and YAML
+
+### Issue Order
+
+Once all the line items were added, click on the <span class='fas fa-paper-plane'></span> button on the main purchase order detail panel and confirm the order has been submitted.
+
+### Receive Line Items
+
+After receiving all the items from the order, the purchase order will convert the line items into stock items / inventory.
+
+There are two options to mark items as "received":
+
+* either individually: click on <span class='fas fa-clipboard-check'></span> button on each line item
+* or globally: click on the <span class='fas fa-clipboard-check'></span> button on the main purchase order detail panel and confirm all items in the order have been received.
+
+### Received Items
+
+Each item marked as "received" is automatically converted into a stock item.
+
+To see the list of stock items created from the purchase order, click on the <span class="badge inventree nav side"><span class='fas fa-sign-in-alt'></span> Received Items</span> tab.
+
+### Complete Order
+
+Once the quantity of all __received__ items is equal or above the quantity of all line items, the order will be automatically marked as __complete__.
+
+It is also possible to complete the order before all items were received (or if there were missing items).
+To do so, click on the <span class='fas fa-check-circle'></span> button on the main purchase order detail panel and confirm the order was completed.
+
+### Cancel Order
+
+In the event that the order won't be processed, user has the option of cancelling the order instead.
+To do so, simply click on the <span class='fas fa-times-circle'></span> button on the main purchase order detail panel and confirm the purchase order has been cancelled.

docs/companies/so.md

@@ -4,12 +4,46 @@ title: Sales Order
 
 ## Sales Orders
 
-To access the sales order page, click on the "Sell" navigation tab and click on "Sales Orders" option in the dropdown list.
+Sales orders allow to track which stock items are sold to customers, therefore converting stock items / inventory into externally sold items.
 
-!!! missing "TODO"
+To access the sales order page, click on the <span class="badge inventree nav main"><span class='fas fa-truck'></span> Sell</span> navigation tab and click on <span class="badge inventree nav main"><span class='fas fa-list'></span> Sales Orders</span> option in the dropdown list.
-	This section requires further work
 
-## Line Items
+### Create Sales Order
 
-!!! missing "TODO"
+Once the sales order page is loaded, click on <span class="badge inventree add"><span class='fas fa-plus-circle'></span> New Sales Order</span> which opens the "Create Sales Order" form.
-	This section requires further work
+
+A sales order is linked to a specific customer, select one in the list of existing customers.
+
+!!! warning
+	Only companies with the "Customer" attribute enabled will be shown and can be selected
+
+Fill out the rest of the form with the sales order information then click on <span class="badge inventree confirm">Submit</span> 
+
+### Add Line Items
+
+On the sales order detail page, user can link parts to the sales order selecting the <span class="badge inventree nav side"><span class='fas fa-list'></span> Order Items</span> tab then clicking on the <span class="badge inventree add"><span class='fas fa-plus-circle'></span> Add Line Item</span> button.
+
+Once the "Add Line Item" form opens, select a part in the list.
+
+!!! warning
+    Only parts that have the "Salable" attribute enabled will be shown and can be selected
+
+Fill out the rest of the form then click on <span class="badge inventree confirm">Submit</span> 
+
+### Allocate Stock Items
+
+After adding line item and connecting a part to the sales order, user can either:
+
+* allocate stock items for that part to the sales order (click on <span class='fas fa-sign-in-alt'></span> button)
+* or create a build order for that part to cover the quantity of the sales order (click on <span class='fas fa-tools'></span> button)
+
+### Ship Order
+
+After all parts and stock items have been allocated, click on the <span class='fas fa-paper-plane'></span> button on the main sales order detail panel and confirm the order has been sent.
+
+The sales order will be marked as __shipped__ and can __not__ be edited anymore.
+
+### Cancel Order
+
+In the event that the order won't be shipped out, user has the option of cancelling the order instead.
+To do so, simply click on the <span class='fas fa-times-circle'></span> button on the main sales order detail panel and confirm the sales order has been cancelled.

docs/companies/supplier.md

@@ -6,14 +6,14 @@ title: Suppliers
 
 A supplier is an external **vendor** of parts and raw materials.
 
-To access the supplier page, click on the "Buy" navigation tab and click on "Suppliers" option in the dropdown list.
+To access the supplier page, click on the <span class="badge inventree nav main"><span class='fas fa-shopping-cart'></span> Buy</span> navigation tab and click on <span class="badge inventree nav main"><span class='fas fa-building'></span> Suppliers</span> option in the dropdown list.
 
 !!! warning
 	**Viewing**, **adding**, **editing** and **deleting** suppliers require the corresponding [Purchase Orders user permissions](../admin/permissions.md)
 
 ### Add Supplier
 
-Once the supplier page is loaded, click on the "<span class='fas fa-plus-circle'></span> New Supplier" button: the "Create new Supplier" form opens. Fill-in the supplier informations (`Company name` and `Company description` are required) then click on the "Submit" button.
+Once the supplier page is loaded, click on the <span class="badge inventree add"><span class='fas fa-plus-circle'></span> New Supplier</span> button: the "Create new Supplier" form opens. Fill-in the supplier informations (`Company name` and `Company description` are required) then click on <span class="badge inventree confirm">Submit</span>
 
 !!! info "Supplier vs Manufacturer"
 	In the case the supplier is a manufacturer who sells directly to customers, you may want to enable the checkbox `is manufacturer` before submitting the form (you can also enable it later on).
@@ -22,7 +22,7 @@ Once the supplier page is loaded, click on the "<span class='fas fa-plus-circle'
 
 To edit a supplier, click on its name in the list of suppliers.
 
-After the supplier details are loaded, click on the <span class='fas fa-edit'></span> icon under the supplier name. Edit the supplier information then click on the "Submit" button.
+After the supplier details are loaded, click on the <span class='fas fa-edit'></span> icon under the supplier name. Edit the supplier information then click on <span class="badge inventree confirm">Submit</span>
 
 ### Delete Supplier
 
@@ -31,7 +31,7 @@ After the supplier details are loaded, click on the <span class='fas fa-edit'></
 
 To delete a supplier, click on its name in the list of suppliers.
 
-After the supplier details are loaded, click on the <span class='fas fa-trash-alt'></span> icon under the supplier name. Review the list of supplier parts to be deleted in consequence of deleting this supplier. Confirm the deletion using the checkbox then click on the "Submit" button.
+After the supplier details are loaded, click on the <span class='fas fa-trash-alt'></span> icon under the supplier name. Review the list of supplier parts to be deleted in consequence of deleting this supplier. Confirm the deletion using the checkbox then click on <span class="badge inventree confirm">Submit</span>
 
 ## Supplier Parts
 
@@ -44,24 +44,24 @@ Supplier parts are linked to a supplier and defined as purchasable items.
 
 To create a supplier part, you have the following options:
 
-1. navigate to a Part detail page then click on the "Suppliers" tab
+1. navigate to a Part detail page then click on the <span class="badge inventree nav side"><span class='fas fa-building'></span> Suppliers</span> tab
-0. navigate to a Supplier detail page then click on the "Supplied Parts" tab
+0. navigate to a Supplier detail page then click on the <span class="badge inventree nav side"><span class='fas fa-building'></span> Supplied Parts</span> tab
-0. navigate to a Manufacturer detail page then click on the "Supplied Parts" tab.
+0. navigate to a Manufacturer detail page then click on the <span class="badge inventree nav side"><span class='fas fa-building'></span> Supplied Parts</span> tab.
 
-Whichever you pick, click on the "<span class='fas fa-plus-circle'></span> New Supplier Part" button to load the "Create new Supplier Part" form. Fill out the form with the supplier part information then click on the "Submit" button.
+Whichever you pick, click on the <span class="badge inventree add"><span class='fas fa-plus-circle'></span> New Supplier Part</span> button to load the "Create new Supplier Part" form. Fill out the form with the supplier part information then click on <span class="badge inventree confirm">Submit</span>
 
 ### Edit Supplier Part
 
 To edit a supplier part, first access the supplier part detail page with one of the following options:
 
-1. navigate to a Part detail page, click on the "Suppliers" tab then click on the corresponding "Supplier Part" link
+1. navigate to a Part detail page, click on the <span class="badge inventree nav side"><span class='fas fa-building'></span> Suppliers</span> tab then, in the <span class="badge inventree nav main">Part Suppliers</span> table, click on the corresponding _Supplier Part_ link
-0. navigate to a Supplier detail page, click on the "Supplied Parts" tab then click on the corresponding "Supplier Part" link
+0. navigate to a Supplier detail page, click on the <span class="badge inventree nav side"><span class='fas fa-building'></span> Supplied Parts</span> tab then click on the corresponding _Supplier Part_ link
-0. navigate to a Manufacturer detail page, click on the "Supplied Parts" tab then click on the corresponding "Supplier Part" link.
+0. navigate to a Manufacturer detail page, click on the <span class="badge inventree nav side"><span class='fas fa-building'></span> Supplied Parts</span> tab then click on the corresponding _Supplier Part_ link.
 
-After the supplier part details are loaded, click on the <span class='fas fa-edit'></span> icon next to the supplier part image. Edit the supplier part information then click on the "Submit" button.
+After the supplier part details are loaded, click on the <span class='fas fa-edit'></span> icon next to the supplier part image. Edit the supplier part information then click on <span class="badge inventree confirm">Submit</span>
 
 ### Delete Supplier Part
 
 To delete a supplier part, first access the supplier part detail page like in the [Edit Supplier Part](#edit-supplier-part) section.
 
-After the supplier part details are loaded, click on the <span class='fas fa-trash-alt'></span> icon next to the supplier part image. Review the the information for the supplier part to be deleted, confirm the deletion using the checkbox then click on the "Submit" button.
+After the supplier part details are loaded, click on the <span class='fas fa-trash-alt'></span> icon next to the supplier part image. Review the the information for the supplier part to be deleted, confirm the deletion using the checkbox then click on <span class="badge inventree confirm">Submit</span>

docs/part/template.md

@@ -41,4 +41,4 @@ The `Create Variant` form will be displayed:
 {% include 'img.html' %}
 {% endwith %}
 
-Fill-out the form then click on the "Submit" button to create the variant.
+Fill-out the form then click on <span class="badge inventree confirm">Submit</span> to create the variant.

docs/stylesheets/extra.css

@@ -68,6 +68,10 @@ p {
 	text-align: justify;
 }
 
+div:nth-of-type(1) p {
+	padding-top: 12px;
+}
+
 /* Remove page title  */
 .md-content h1:first-child {
 	display: none;
@@ -89,3 +93,39 @@ p {
 .blue {
 	color: #55C;
 }
+
+.badge.inventree {
+	font-family: "Helvetica Neue",Helvetica,Arial,sans-serif;
+	font-size: 14px;
+	font-weight: 400;
+	border-radius: 5px;
+	padding: 6px 12px;
+	border-style: solid;
+	border-width: 1px;
+}
+
+.badge.inventree.nav.main {
+	background-color: #e7e7e7;
+	color: #777;
+	border-width: 0px;
+}
+
+.badge.inventree.nav.side {
+	background-color: #fff;
+	color: #337ab7;
+	border-color: #ddd;
+	font-size: 100%;
+	font-weight: 500;
+}
+
+.badge.inventree.add {
+	background-color: #449d44;
+	border-color: #398439;
+	color: #fff;
+}
+
+.badge.inventree.confirm {
+	background-color: #337ab7;
+	border-color: #2e6da4;
+	color: #fff;
+}