diff --git a/docs/docs/assets/images/sell/complete_shipment.png b/docs/docs/assets/images/order/complete_shipment.png similarity index 100% rename from docs/docs/assets/images/sell/complete_shipment.png rename to docs/docs/assets/images/order/complete_shipment.png diff --git a/docs/docs/assets/images/sell/complete_shipment_action.png b/docs/docs/assets/images/order/complete_shipment_action.png similarity index 100% rename from docs/docs/assets/images/sell/complete_shipment_action.png rename to docs/docs/assets/images/order/complete_shipment_action.png diff --git a/docs/docs/assets/images/sell/completed_shipments.png b/docs/docs/assets/images/order/completed_shipments.png similarity index 100% rename from docs/docs/assets/images/sell/completed_shipments.png rename to docs/docs/assets/images/order/completed_shipments.png diff --git a/docs/docs/assets/images/order/contact_list.png b/docs/docs/assets/images/order/contact_list.png new file mode 100644 index 0000000000..cf168489ce Binary files /dev/null and b/docs/docs/assets/images/order/contact_list.png differ diff --git a/docs/docs/assets/images/sell/edit_shipment.png b/docs/docs/assets/images/order/edit_shipment.png similarity index 100% rename from docs/docs/assets/images/sell/edit_shipment.png rename to docs/docs/assets/images/order/edit_shipment.png diff --git a/docs/docs/assets/images/buy/manufacturer_list.png b/docs/docs/assets/images/order/manufacturer_list.png similarity index 100% rename from docs/docs/assets/images/buy/manufacturer_list.png rename to docs/docs/assets/images/order/manufacturer_list.png diff --git a/docs/docs/assets/images/sell/pending_shipments.png b/docs/docs/assets/images/order/pending_shipments.png similarity index 100% rename from docs/docs/assets/images/sell/pending_shipments.png rename to docs/docs/assets/images/order/pending_shipments.png diff --git a/docs/docs/assets/images/buy/po_duplicate.png b/docs/docs/assets/images/order/po_duplicate.png similarity index 100% rename from docs/docs/assets/images/buy/po_duplicate.png rename to docs/docs/assets/images/order/po_duplicate.png diff --git a/docs/docs/assets/images/buy/po_duplicate_2.png b/docs/docs/assets/images/order/po_duplicate_2.png similarity index 100% rename from docs/docs/assets/images/buy/po_duplicate_2.png rename to docs/docs/assets/images/order/po_duplicate_2.png diff --git a/docs/docs/assets/images/buy/po_duplicate_3.png b/docs/docs/assets/images/order/po_duplicate_3.png similarity index 100% rename from docs/docs/assets/images/buy/po_duplicate_3.png rename to docs/docs/assets/images/order/po_duplicate_3.png diff --git a/docs/docs/assets/images/buy/po_list.png b/docs/docs/assets/images/order/po_list.png similarity index 100% rename from docs/docs/assets/images/buy/po_list.png rename to docs/docs/assets/images/order/po_list.png diff --git a/docs/docs/assets/images/sell/return_order_create.png b/docs/docs/assets/images/order/return_order_create.png similarity index 100% rename from docs/docs/assets/images/sell/return_order_create.png rename to docs/docs/assets/images/order/return_order_create.png diff --git a/docs/docs/assets/images/sell/return_order_detail.png b/docs/docs/assets/images/order/return_order_detail.png similarity index 100% rename from docs/docs/assets/images/sell/return_order_detail.png rename to docs/docs/assets/images/order/return_order_detail.png diff --git a/docs/docs/assets/images/sell/return_order_enable.png b/docs/docs/assets/images/order/return_order_enable.png similarity index 100% rename from docs/docs/assets/images/sell/return_order_enable.png rename to docs/docs/assets/images/order/return_order_enable.png diff --git a/docs/docs/assets/images/sell/return_order_index.png b/docs/docs/assets/images/order/return_order_index.png similarity index 100% rename from docs/docs/assets/images/sell/return_order_index.png rename to docs/docs/assets/images/order/return_order_index.png diff --git a/docs/docs/assets/images/sell/return_order_navbar.png b/docs/docs/assets/images/order/return_order_navbar.png similarity index 100% rename from docs/docs/assets/images/sell/return_order_navbar.png rename to docs/docs/assets/images/order/return_order_navbar.png diff --git a/docs/docs/assets/images/sell/so_list.png b/docs/docs/assets/images/order/so_list.png similarity index 100% rename from docs/docs/assets/images/sell/so_list.png rename to docs/docs/assets/images/order/so_list.png diff --git a/docs/docs/assets/images/buy/supplier_list.png b/docs/docs/assets/images/order/supplier_list.png similarity index 100% rename from docs/docs/assets/images/buy/supplier_list.png rename to docs/docs/assets/images/order/supplier_list.png diff --git a/docs/docs/assets/images/buy/supplier_part_availability.png b/docs/docs/assets/images/order/supplier_part_availability.png similarity index 100% rename from docs/docs/assets/images/buy/supplier_part_availability.png rename to docs/docs/assets/images/order/supplier_part_availability.png diff --git a/docs/docs/assets/images/buy/update_availability.png b/docs/docs/assets/images/order/update_availability.png similarity index 100% rename from docs/docs/assets/images/buy/update_availability.png rename to docs/docs/assets/images/order/update_availability.png diff --git a/docs/docs/barcodes/barcodes.md b/docs/docs/barcodes/barcodes.md index e1a51ea44c..22c07cc37f 100644 --- a/docs/docs/barcodes/barcodes.md +++ b/docs/docs/barcodes/barcodes.md @@ -20,7 +20,7 @@ Barcodes can be linked with the following data model types: - [Part](../part/part.md#part) - [Stock Item](../stock/stock.md#stock-item) - [Stock Location](../stock/stock.md#stock-location) -- [Supplier Part](../buy/supplier.md#supplier-parts) +- [Supplier Part](../order/company.md#supplier-parts) ## Web Integration diff --git a/docs/docs/buy/manufacturer.md b/docs/docs/buy/manufacturer.md deleted file mode 100644 index 8b3a4ad1a8..0000000000 --- a/docs/docs/buy/manufacturer.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: Manufacturers ---- - -## 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. - -{% with id="manufacturer_list", url="buy/manufacturer_list.png", description="Manufacturer List" %} -{% include "img.html" %} -{% endwith %} - -!!! info - **Viewing**, **adding**, **editing** and **deleting** manufacturers require the corresponding [Purchase Orders user permissions](../settings/permissions.md) - -### Add Manufacturer - -Once the manufacturer page is loaded, click on the New Manufacturer button: the "Create new Manufacturer" form opens. Fill-in the manufacturer informations (`Company name` and `Company description` are required) then click on Submit - -!!! 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. - -### Edit Manufacturer - -To edit a manufacturer, click on its name in the list of manufacturers. - -After the manufacturer details are loaded, click on the icon under the manufacturer name. Edit the manufacturer information then click on Submit - -### Delete Manufacturer - -!!! warning - All manufacturer parts for this manufacturer will also be deleted! - -To delete a manufacturer, click on its name in the list of manufacturers. - -After the manufacturer details are loaded, click on the 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 Submit - -## Manufacturer Parts - -Manufacturer parts are linked to a manufacturer and defined as manufacturable items. - -!!! warning - **Viewing**, **adding**, **editing** and **deleting** manufacturer parts require the corresponding [Purchase Orders user permissions](../settings/permissions.md) - -### Add Manufacturer Part - -To create a manufacturer part, you have the following options: - -* either navigate to a Part detail page then click on the Suppliers tab -* or navigate to a Manufacturer detail page then click on the Manufactured Parts tab. - -Whichever you pick, click on the New Manufacturer Part button to load the "Create New Manufacturer Part" form. Fill out the form with the manufacturer part information then click on Submit - -### 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 Suppliers tab then, in the Part Manufacturers 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. - -After the manufacturer part details are loaded, click on the icon next to the manufacturer part image. Edit the manufacturer part information then click on Submit - -### 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 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 Submit diff --git a/docs/docs/buy/supplier.md b/docs/docs/buy/supplier.md deleted file mode 100644 index ddbe7d2a7c..0000000000 --- a/docs/docs/buy/supplier.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -title: Suppliers ---- - -## 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. - -{% with id="supplier_list", url="buy/supplier_list.png", description="Supplier List" %} -{% include "img.html" %} -{% endwith %} - -!!! info - **Viewing**, **adding**, **editing** and **deleting** suppliers require the corresponding [Purchase Orders user permissions](../settings/permissions.md) - -### Add Supplier - -Once the supplier page is loaded, click on the New Supplier button: the "Create new Supplier" form opens. Fill-in the supplier informations (`Company name` and `Company description` are required) then click on Submit - -!!! 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). - -### Edit Supplier - -To edit a supplier, click on its name in the list of suppliers. - -After the supplier details are loaded, click on the icon under the supplier name. Edit the supplier information then click on Submit - -### Delete Supplier - -!!! warning - All supplier parts for this supplier will also be deleted! - -To delete a supplier, click on its name in the list of suppliers. - -After the supplier details are loaded, click on the 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 Submit - -## Supplier Parts - -Supplier parts are linked to a supplier and defined as purchasable items. - -!!! warning - **Viewing**, **adding**, **editing** and **deleting** supplier parts require the corresponding [Purchase Orders user permissions](../settings/permissions.md) - -### Add Supplier Part - -To create a supplier part, you have the following options: - -1. navigate to a Part detail page then click on the Suppliers tab -0. navigate to a Supplier detail page then click on the Supplied Parts tab -0. navigate to a Manufacturer detail page then click on the Supplied Parts tab. - -Whichever you pick, click on the New Supplier Part button to load the "Create new Supplier Part" form. Fill out the form with the supplier part information then click on Submit - -### 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, in the Part Suppliers 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 Manufacturer detail page, click on the Supplied Parts tab then click on the corresponding _Supplier Part_ link. - -After the supplier part details are loaded, click on the icon next to the supplier part image. Edit the supplier part information then click on Submit - -### 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 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 Submit - -### Supplier Part Availability - -InvenTree supports tracking 'availability' information for supplier parts. While this information can be updated manually, it is more useful when used in conjunction with the InvenTree plugin system. - -A custom can periodically request availability information (via a supplier API), and update this availability information for each supplier part. - -If provided, availability information is displayed on the Supplier Part detail page. - -{% with id="supplier_part_availability", url="buy/supplier_part_availability.png", maxheight="240px", description="Supplier part availability" %} -{% include "img.html" %} -{% endwith %} - -Availability information can be manually updated via the user interface: - -{% with id="update_availability", url="buy/update_availability.png", maxheight="240px", description="Update availability" %} -{% include "img.html" %} -{% endwith %} diff --git a/docs/docs/features.md b/docs/docs/features.md index ee327aaaad..4b5f99be0f 100644 --- a/docs/docs/features.md +++ b/docs/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...](./buy/supplier.md) +[Read more...](./order/company.md#suppliers) ## Instant Stock Knowledge diff --git a/docs/docs/order/company.md b/docs/docs/order/company.md new file mode 100644 index 0000000000..ec383f1a30 --- /dev/null +++ b/docs/docs/order/company.md @@ -0,0 +1,180 @@ +--- +title: External Companies +--- + +## Companies + +External companies are represented by the *Company* database model. Each company may be classified into the following categories: + +- [Customer](#customers) +- [Supplier](#suppliers) +- [Manufacturer](#manufacturers) + +!!! tip Multi Purpose + A company may be allocated to multiple categories + +### Edit Company + +To edit a company, click on the Edit Company icon in the actions menu. Edit the company information, and then click on Submit. + +!!! warning "Permission Required" + The edit button will not be available to users who do not have the required permissions to edit the company + +### Delete Company + +To delete a company, click on the icon under the actions menu. Confirm the deletion using the checkbox then click on Submit + +!!! warning "Permission Required" + The edit button will not be available to users who do not have the required permissions to delete the company + +!!! danger "Take Care" + Deleting a company instance will also remove any orders or supplied parts associated with that company! + +### Contacts + +Each company can have multiple assigned *Contacts*. A contact identifies an individual who is associated with the company, including information such as name, email address, phone number, etc. + +The list of contacts associated with a particular company is available in the Contacts navigation tab: + +{% with id="contact_list", url="order/contact_list.png", description="Contact List" %} +{% include "img.html" %} +{% endwith %} + + +A *contact* can be assigned to orders, (such as [purchase orders](./purchase_order.md) or [sales orders](./sales_order.md)). + +## Customers + +A *customer* is an external client to whom parts or services are sold. + +To access the customer page, click on the Sell navigation tab and click on Customers option in the dropdown list. + +!!! warning + **Viewing**, **adding**, **editing** and **deleting** customers require the corresponding [Sales Orders user permissions](../settings/permissions.md) + +### Add Customer + +Once the customer page is loaded, click on the New Customer button: the "Create new Customer" form opens. Fill-in the manufacturer informations (`Company name` and `Company description` are required) then click on Submit + +## Manufacturers + +A manufacturer is an external **producer** of parts and raw materials. + +!!! info + **Viewing**, **adding**, **editing** and **deleting** manufacturers require the corresponding [Purchase Orders user permissions](../settings/permissions.md) + +To access the list of manufacturers , click on the Buy navigation tab and click on Manufacturers option in the dropdown list. + +{% with id="manufacturer_list", url="order/manufacturer_list.png", description="Manufacturer List" %} +{% include "img.html" %} +{% endwith %} + +### Add Manufacturer + +Once the manufacturer page is loaded, click on the New Manufacturer button: the "Create new Manufacturer" form opens. Fill-in the manufacturer informations (`Company name` and `Company description` are required) then click on Submit + +!!! 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-parts), therefore the manufacturer will need to be set as a supplier too. + + +### Manufacturer Parts + +Manufacturer parts are linked to a manufacturer and defined as manufacturable items. + +!!! warning + **Viewing**, **adding**, **editing** and **deleting** manufacturer parts require the corresponding [Purchase Orders user permissions](../settings/permissions.md) + +#### Add Manufacturer Part + +To create a manufacturer part, you have the following options: + +* either navigate to a Part detail page then click on the Suppliers tab +* or navigate to a Manufacturer detail page then click on the Manufactured Parts tab. + +Whichever you pick, click on the New Manufacturer Part button to load the "Create New Manufacturer Part" form. Fill out the form with the manufacturer part information then click on Submit + +#### 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 Suppliers tab then, in the Part Manufacturers 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. + +After the manufacturer part details are loaded, click on the icon next to the manufacturer part image. Edit the manufacturer part information then click on Submit + +#### 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 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 Submit + +## 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. + +{% with id="supplier_list", url="order/supplier_list.png", description="Supplier List" %} +{% include "img.html" %} +{% endwith %} + +!!! info + **Viewing**, **adding**, **editing** and **deleting** suppliers require the corresponding [Purchase Orders user permissions](../settings/permissions.md) + +### Add Supplier + +Once the supplier page is loaded, click on the New Supplier button: the "Create new Supplier" form opens. Fill-in the supplier informations (`Company name` and `Company description` are required) then click on Submit + +!!! 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). + +### Supplier Parts + +Supplier parts are linked to a supplier and defined as purchasable items. + +!!! warning + **Viewing**, **adding**, **editing** and **deleting** supplier parts require the corresponding [Purchase Orders user permissions](../settings/permissions.md) + +#### Add Supplier Part + +To create a supplier part, you have the following options: + +1. navigate to a Part detail page then click on the Suppliers tab +0. navigate to a Supplier detail page then click on the Supplied Parts tab +0. navigate to a Manufacturer detail page then click on the Supplied Parts tab. + +Whichever you pick, click on the New Supplier Part button to load the "Create new Supplier Part" form. Fill out the form with the supplier part information then click on Submit + +#### 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, in the Part Suppliers 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 Manufacturer detail page, click on the Supplied Parts tab then click on the corresponding _Supplier Part_ link. + +After the supplier part details are loaded, click on the icon next to the supplier part image. Edit the supplier part information then click on Submit + +#### 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 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 Submit + +#### Supplier Part Availability + +InvenTree supports tracking 'availability' information for supplier parts. While this information can be updated manually, it is more useful when used in conjunction with the InvenTree plugin system. + +A custom can periodically request availability information (via a supplier API), and update this availability information for each supplier part. + +If provided, availability information is displayed on the Supplier Part detail page. + +{% with id="supplier_part_availability", url="order/supplier_part_availability.png", maxheight="240px", description="Supplier part availability" %} +{% include "img.html" %} +{% endwith %} + +Availability information can be manually updated via the user interface: + +{% with id="update_availability", url="order/update_availability.png", maxheight="240px", description="Update availability" %} +{% include "img.html" %} +{% endwith %} diff --git a/docs/docs/buy/po.md b/docs/docs/order/purchase_order.md similarity index 92% rename from docs/docs/buy/po.md rename to docs/docs/order/purchase_order.md index 3ebe0a795d..b75a6a5d87 100644 --- a/docs/docs/buy/po.md +++ b/docs/docs/order/purchase_order.md @@ -8,7 +8,7 @@ Purchase orders allow to track which parts are bought from suppliers and manufac To access the purchase order page, click on the Buy navigation tab and click on Purchase Orders option in the dropdown list. -{% with id="purchase_order_list", url="buy/po_list.png", description="Purchase Order List" %} +{% with id="purchase_order_list", url="order/po_list.png", description="Purchase Order List" %} {% include "img.html" %} {% endwith %} @@ -25,7 +25,7 @@ Each Purchase Order has a specific status code which indicates the current state ### Purchase Order Currency -The currency code can be specified for an individual purchase order. If not specified, the default currency specified against the [supplier](./supplier.md) will be used. +The currency code can be specified for an individual purchase order. If not specified, the default currency specified against the [supplier](./company.md#suppliers) will be used. ## Create Purchase Order @@ -100,19 +100,19 @@ Duplicating a Purchase Order allows the user to quickly create a new *copy* of a To duplicate an existing order, select the *Duplicate Order* action from the menu in the top-right of the screen (as shown below): -{% with id="purchase_order_duplicate", url="buy/po_duplicate.png", description="Duplicate Purchase Order" %} +{% with id="purchase_order_duplicate", url="order/po_duplicate.png", description="Duplicate Purchase Order" %} {% include "img.html" %} {% endwith %} This opens the following dialog, where you can adjust the parameters of the new order before proceeding to actually create the new order. You can see in the screenshot below that some extra options are provided in this form, to control duplication of individual line items. -{% with id="purchase_order_duplicate_2", url="buy/po_duplicate_2.png", description="Duplicate Purchase Order" %} +{% with id="purchase_order_duplicate_2", url="order/po_duplicate_2.png", description="Duplicate Purchase Order" %} {% include "img.html" %} {% endwith %} A new purchase order is then created based on the currently selected order: -{% with id="purchase_order_duplicate_3", url="buy/po_duplicate_3.png", description="Duplicate Purchase Order" %} +{% with id="purchase_order_duplicate_3", url="order/po_duplicate_3.png", description="Duplicate Purchase Order" %} {% include "img.html" %} {% endwith %} diff --git a/docs/docs/sell/return.md b/docs/docs/order/return_order.md similarity index 86% rename from docs/docs/sell/return.md rename to docs/docs/order/return_order.md index 9626dccdea..de16d651ef 100644 --- a/docs/docs/sell/return.md +++ b/docs/docs/order/return_order.md @@ -13,13 +13,13 @@ Return Orders allow stock items (which have been sold or allocted to a customer) By default, Return Order functionality is not enabled - it must be enabled by a *staff* user from the settings page: -{% with id="enable-return-order", url="sell/return_order_enable.png", description="Enable Return Orders" %} +{% with id="enable-return-order", url="order/return_order_enable.png", description="Enable Return Orders" %} {% include "img.html" %} {% endwith %} Once this setting is enabled, you can access the "Return Orders" page from the main navigation bar: -{% with id="return-order-navbar", url="sell/return_order_navbar.png", description="Access Return Orders" %} +{% with id="return-order-navbar", url="order/return_order_navbar.png", description="Access Return Orders" %} {% include "img.html" %} {% endwith %} @@ -31,7 +31,7 @@ Once this setting is enabled, you can access the "Return Orders" page from the m A list of Return Orders is displayed on the *Return Order* index page: -{% with id="return-order-index", url="sell/return_order_index.png", description="Return Order Index" %} +{% with id="return-order-index", url="order/return_order_index.png", description="Return Order Index" %} {% include "img.html" %} {% endwith %} @@ -57,7 +57,7 @@ A Return Order is linked to a specific customer, which can be selected from the !!! warning "Customers Only" Only companies with the "Customer" attribute enabled will be shown and can be selected -{% with id="return-order-create", url="sell/return_order_create.png", description="Return Order Create" %} +{% with id="return-order-create", url="order/return_order_create.png", description="Return Order Create" %} {% include "img.html" %} {% endwith %} @@ -75,7 +75,7 @@ The order can be assigned to a responsible *owner*, which is either a user or gr Indvidual Return Orders can be viewed via the Return Order detail page: -{% with id="return-order-detail", url="sell/return_order_detail.png", description="Return Order Detail" %} +{% with id="return-order-detail", url="order/return_order_detail.png", description="Return Order Detail" %} {% include "img.html" %} {% endwith %} diff --git a/docs/docs/sell/so.md b/docs/docs/order/sales_order.md similarity index 66% rename from docs/docs/sell/so.md rename to docs/docs/order/sales_order.md index fe15b597bc..46fdfe2862 100644 --- a/docs/docs/sell/so.md +++ b/docs/docs/order/sales_order.md @@ -8,7 +8,7 @@ Sales orders allow tracking of which stock items are sold to customers, therefor To access the sales order page, click on the Sell navigation tab and click on Sales Orders option in the dropdown list. -{% with id="sales_order_list", url="sell/so_list.png", description="Sales Order List" %} +{% with id="sales_order_list", url="order/so_list.png", description="Sales Order List" %} {% include "img.html" %} {% endwith %} @@ -25,8 +25,7 @@ Each Sales Order has a specific status code, which represents the state of the o ### Sales Order Currency -The currency code can be specified for an individual sales order. If not specified, the default currency specified against the [customer](./customer.md) will be used. - +The currency code can be specified for an individual sales order. If not specified, the default currency specified against the [customer](./company.md#customers) will be used. ## Create a Sales Order @@ -56,7 +55,7 @@ Fill out the rest of the form then click on Sell navigation tab and click on Customers option in the dropdown list. - -!!! warning - **Viewing**, **adding**, **editing** and **deleting** customers require the corresponding [Sales Orders user permissions](../settings/permissions.md) - -### Add Customer - -Once the customer page is loaded, click on the New Customer button: the "Create new Customer" form opens. Fill-in the manufacturer informations (`Company name` and `Company description` are required) then click on Submit - -### Edit Customer - -To edit a customer, click on its name in the list of customers. - -After the customer details are loaded, click on the icon under the customer name. Edit the customer information then click on Submit - -### Delete Customer - -To delete a customer, click on its name in the list of customers. - -After the customer details are loaded, click on the icon under the customer name. Confirm the deletion using the checkbox then click on Submit diff --git a/docs/docs/sell/shipment.md b/docs/docs/sell/shipment.md deleted file mode 100644 index 855abc63e5..0000000000 --- a/docs/docs/sell/shipment.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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/docs/settings/reference.md b/docs/docs/settings/reference.md index 9e94d95634..261ff2ec10 100644 --- a/docs/docs/settings/reference.md +++ b/docs/docs/settings/reference.md @@ -4,7 +4,7 @@ title: Reference Patterns ## Reference Patterns -InvenTree contains a number of data models which require a *unique* reference field (such as [Purchase Orders](../buy/po.md)). In addition to being *unique* these reference values must conform to a specific *pattern* (which can be defined by the user). Defined reference patterns also make it simple for the user to control how references are generated. +InvenTree contains a number of data models which require a *unique* reference field (such as [Purchase Orders](../order/purchase_order.md)). In addition to being *unique* these reference values must conform to a specific *pattern* (which can be defined by the user). Defined reference patterns also make it simple for the user to control how references are generated. ### Default Patterns diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index d6beff9fcd..f53879fdbc 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -101,15 +101,11 @@ nav: - Bill of Materials: build/bom.md - Importing BOM Data: build/bom_import.md - Exporting BOM Data: build/bom_export.md - - Buy: - - Suppliers: buy/supplier.md - - Manufacturers: buy/manufacturer.md - - Purchase Orders: buy/po.md - - Sell: - - Customers: sell/customer.md - - Sales Orders: sell/so.md - - Shipments: sell/shipment.md - - Return Orders: sell/return.md + - Orders: + - Companies: order/company.md + - Purchase Orders: order/purchase_order.md + - Sales Orders: order/sales_order.md + - Return Orders: order/return_order.md - Report: - Templates: report/report.md - Report Types: