diff --git a/docs/assets/images/sell/complete_shipment.png b/docs/assets/images/sell/complete_shipment.png new file mode 100644 index 0000000..f94341f Binary files /dev/null and b/docs/assets/images/sell/complete_shipment.png differ diff --git a/docs/assets/images/sell/complete_shipment_action.png b/docs/assets/images/sell/complete_shipment_action.png new file mode 100644 index 0000000..989c3e3 Binary files /dev/null and b/docs/assets/images/sell/complete_shipment_action.png differ diff --git a/docs/assets/images/sell/completed_shipments.png b/docs/assets/images/sell/completed_shipments.png new file mode 100644 index 0000000..4a1f7db Binary files /dev/null and b/docs/assets/images/sell/completed_shipments.png differ diff --git a/docs/assets/images/sell/edit_shipment.png b/docs/assets/images/sell/edit_shipment.png new file mode 100644 index 0000000..693dfde Binary files /dev/null and b/docs/assets/images/sell/edit_shipment.png differ diff --git a/docs/assets/images/sell/pending_shipments.png b/docs/assets/images/sell/pending_shipments.png new file mode 100644 index 0000000..80d0a10 Binary files /dev/null and b/docs/assets/images/sell/pending_shipments.png differ diff --git a/docs/companies/manufacturer.md b/docs/buy/manufacturer.md similarity index 100% rename from docs/companies/manufacturer.md rename to docs/buy/manufacturer.md diff --git a/docs/companies/po.md b/docs/buy/po.md similarity index 100% rename from docs/companies/po.md rename to docs/buy/po.md diff --git a/docs/companies/supplier.md b/docs/buy/supplier.md similarity index 100% rename from docs/companies/supplier.md rename to docs/buy/supplier.md diff --git a/docs/features.md b/docs/features.md index 78d76e4..521dff9 100644 --- a/docs/features.md +++ b/docs/features.md @@ -22,7 +22,7 @@ Parts are the fundamental element of any inventory. InvenTree groups parts into InvenTree allows you to easily create, modify or delete suppliers and supplier items linked to any part in your inventory. -[Read more...](./companies/supplier.md) +[Read more...](./buy/supplier.md) ## Instant Stock Knowledge diff --git a/docs/part/create.md b/docs/part/create.md index dfdef97..178e829 100644 --- a/docs/part/create.md +++ b/docs/part/create.md @@ -30,7 +30,7 @@ Once the form is completed, the browser window is redirected to the new part det If the *Create Initial Stock* setting is enabled, then an extra section is available in the part creation form to create an initial quantity of stock for the newly created part: -{% with id="setting", url="part/create_initial_stock_option.png", descript="Create stock option" %} +{% with id="setting", url="part/create_initial_stock_option.png", description="Create stock option" %} {% include "img.html" %} {% endwith %} diff --git a/docs/part/part.md b/docs/part/part.md index 274ab93..dd48507 100644 --- a/docs/part/part.md +++ b/docs/part/part.md @@ -55,7 +55,7 @@ Trackable parts can be assigned batch numbers or serial numbers which uniquely i ### Purchaseable -If a part is designated as *Purchaseable* it can be purchased from external suppliers. Setting this flag allows parts to be added to [purchase orders](../companies/po.md). +If a part is designated as *Purchaseable* it can be purchased from external suppliers. Setting this flag allows parts to be added to [purchase orders](../buy/po.md). ### Salable diff --git a/docs/part/pricing.md b/docs/part/pricing.md index 4c5d7d1..d1c7a4e 100644 --- a/docs/part/pricing.md +++ b/docs/part/pricing.md @@ -54,9 +54,9 @@ If a part is an assembly this panel will show the cost (possibly as range) for a ### Sale cost / prices -Sale prices are always to customers (through [sale orders](../companies/so.md)) and support [price ranges](#price-ranges). +Sale prices are always to customers (through [sale orders](../sell/so.md)) and support [price ranges](#price-ranges). -The panel also shows historical sale price information collected from past [purchase orders](../companies/po.md). +The panel also shows historical sale price information collected from past [purchase orders](../buy/po.md). ## Currency conversion diff --git a/docs/part/trackable.md b/docs/part/trackable.md index cac2484..e9c015c 100644 --- a/docs/part/trackable.md +++ b/docs/part/trackable.md @@ -8,7 +8,7 @@ Denoting a part as *Trackble* changes the way that [stock items](../../stock/sto For many parts in an InvenTree database, simply tracking current stock levels (and locations) is sufficient. However, some parts require more extensive tracking than simple stock level knowledge. -Any stock item associated with a trackable part *must* have either a batch number or a serial number. This includes stock created manually or via an internal process (such as a [Purchase Order](../companies/po.md) or a [Build Order](../build/build.md)). +Any stock item associated with a trackable part *must* have either a batch number or a serial number. This includes stock created manually or via an internal process (such as a [Purchase Order](../buy/po.md) or a [Build Order](../build/build.md)). ## Assign Serial Numbers diff --git a/docs/releases/0.1.8.md b/docs/releases/0.1.8.md index 50d6874..6e8cd20 100644 --- a/docs/releases/0.1.8.md +++ b/docs/releases/0.1.8.md @@ -29,7 +29,7 @@ title: Release 0.1.8 ### Assign by Serial Number -[#1426](https://github.com/inventree/InvenTree/pull/1426) introduces a new feature which allows stock items to be allocated to a sales order using serial number references. This provides a much more streamlined user experience. Refer to the [sales order documentation](../companies/so.md) for further information. +[#1426](https://github.com/inventree/InvenTree/pull/1426) introduces a new feature which allows stock items to be allocated to a sales order using serial number references. This provides a much more streamlined user experience. Refer to the [sales order documentation](../sell/so.md) for further information. ## Major Bug Fixes diff --git a/docs/releases/0.2.1.md b/docs/releases/0.2.1.md index 2e23fba..339ee11 100644 --- a/docs/releases/0.2.1.md +++ b/docs/releases/0.2.1.md @@ -26,7 +26,7 @@ sourcing information for a part. Soon, InvenTree will allow the use of manufacturer data directly in purchase orders. Details on how to create and manage manufacturer parts were added -[here](../companies/manufacturer.md#add-manufacturer-part). +[here](../buy/manufacturer.md#add-manufacturer-part). ### URL-style QR Code for StockItem diff --git a/docs/releases/0.8.0.md b/docs/releases/0.8.0.md new file mode 100644 index 0000000..80bf16d --- /dev/null +++ b/docs/releases/0.8.0.md @@ -0,0 +1,18 @@ +--- +title: Release 0.8.0 +--- + +## Release: 0.8.0 + +0.8.0 is a major feature release of the InvenTree software project. For a comprehsive list of changes associated with this release, please refer to the [InvenTree GitHub page](https://github.com/inventree/InvenTree/milestone/14). + +## New Features + +### Shipment Features + +[#3058](https://github.com/inventree/InvenTree/pull/3058) implements new data fields for the [Sales Order Shipment](../sell/shipment.md). + +## Bug Fixes + +| Pull Request | Description | +| --- | --- | diff --git a/docs/companies/customer.md b/docs/sell/customer.md similarity index 100% rename from docs/companies/customer.md rename to docs/sell/customer.md diff --git a/docs/sell/shipment.md b/docs/sell/shipment.md new file mode 100644 index 0000000..855abc6 --- /dev/null +++ b/docs/sell/shipment.md @@ -0,0 +1,71 @@ +--- +title: Shipments +--- + +## Shipments + +Shipments are used to track sales items when they are shipped to customers. Multiple shipments can be created against a [Sales Order](./so.md), allowing line items to be sent to customers in multiple deliveries. + +On the main Sales Order detail page, the order shipments are split into two categories, *Pending Shipments* and *Completed Shipments*: + +### Pending Shipments + +The *Pending Shipments* panel displays the shipments which have not yet been sent to the customer. + +- Each shipment displays the items which have been allocated to it +- Pending sales order items can be allocated to these shipments +- New shipments can be created if the order is still open + +{% with id="pending-shipments", url="sell/pending_shipments.png", description="Pending shipments" %} +{% include "img.html" %} +{% endwith %} + +#### Creating a new Shipment + +To create a new shipment for a sales order, press the *New Shipment* button above the pending shipments table. + +#### Completing a Shipment + +To complete a shipment, press the *Complete Shipment* button associated with the particular shipment: + +{% with id="complete-shipment", url="sell/complete_shipment.png", description="Complete shipment" %} +{% include "img.html" %} +{% endwith %} + +Alternatively, pending shipments can be completed by selecting the *Complete Shipments* action from the sales order actions menu: + +{% with id="complete-shipment-action", url="sell/complete_shipment_action.png", description="Complete shipment" %} +{% include "img.html" %} +{% endwith %} + +### Completed Shipments + +{% with id="completed-shipments", url="sell/completed_shipments.png", description="Completed shipments" %} +{% include "img.html" %} +{% endwith %} + +### Shipment Data + +Each shipment provides the following data fields: + +#### Reference + +A unique number for the shipment, used to identify each shipment within a sales order. By default, this value starts at `1` for the first shipment (for each order) and automatically increments for each new shipment. + +#### Tracking Number + +An optional field used to store tracking number information for the shipment. + +#### Invoice Number + +An optional field used to store an invoice reference for the shipment. + +#### Link + +An optional URL field which can be used to provide a link to an external URL. + +All these fields can be edited by the user: + +{% with id="edit-shipment", url="sell/edit_shipment.png", description="Edit shipment" %} +{% include "img.html" %} +{% endwith %} diff --git a/docs/companies/so.md b/docs/sell/so.md similarity index 97% rename from docs/companies/so.md rename to docs/sell/so.md index 58dc050..221f6cb 100644 --- a/docs/companies/so.md +++ b/docs/sell/so.md @@ -32,7 +32,7 @@ Fill out the rest of the form then click on