From 14a3db3d5b0bcfbbee703bba26cab6483a82d190 Mon Sep 17 00:00:00 2001
From: Oliver <oliver.henry.walters@gmail.com>
Date: Thu, 30 Mar 2023 23:53:37 +1100
Subject: [PATCH] Order status codes (#460)
* Add status code information for Sales Orders
* Add status codes for purchase orders
---
docs/buy/po.md | 17 ++++++++++++++---
docs/sell/return.md | 6 +++---
docs/sell/so.md | 17 ++++++++++++++---
3 files changed, 31 insertions(+), 9 deletions(-)
diff --git a/docs/buy/po.md b/docs/buy/po.md
index 1750767..fa3be33 100644
--- a/docs/buy/po.md
+++ b/docs/buy/po.md
@@ -12,11 +12,18 @@ To access the purchase order page, click on the <span class="badge inventree nav
{% include "img.html" %}
{% endwith %}
-### Purchase Order Reference
+### Purchase Order Status Codes
-Each Purchase Order is uniquely identified by its *Reference* field. Read more about [reference fields](../settings/reference.md).
+Each Purchase Order has a specific status code which indicates the current state of the order:
-### Create Purchase Order
+| Status | Description |
+| --- | --- |
+| Pending | The purchase order has been created, but has not been submitted to the supplier |
+| In Progress | The purchase order has been issued to the supplier, and is in progress |
+| Complete | The purchase order has been completed, and is now closed |
+| Cancelled | The purchase order was cancelled, and is now closed |
+
+## Create Purchase Order
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.
@@ -27,6 +34,10 @@ A purchase order is linked to a specific supplier, select one in the list of exi
Fill out the rest of the form with the purchase order information then click on <span class="badge inventree confirm">Submit</span>
+### Purchase Order Reference
+
+Each Purchase Order is uniquely identified by its *Reference* field. Read more about [reference fields](../settings/reference.md).
+
### 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.
diff --git a/docs/sell/return.md b/docs/sell/return.md
index be577ba..c2c0164 100644
--- a/docs/sell/return.md
+++ b/docs/sell/return.md
@@ -44,9 +44,9 @@ Each Return Order has a specific status code, as follows:
| Status | Description |
| --- | --- |
| Pending | The return order has been created, but not sent to the customer |
-| In Progress | The return order has been sent to the customer |
-| Complete | The return order was marked as complete |
-| Cancelled | The return order was cancelled |
+| In Progress | The return order has been issued to the customer |
+| Complete | The return order was marked as complete, and is now closed |
+| Cancelled | The return order was cancelled, and is now closed |
## Create a Return Order
diff --git a/docs/sell/so.md b/docs/sell/so.md
index 8c0321f..78e2471 100644
--- a/docs/sell/so.md
+++ b/docs/sell/so.md
@@ -12,11 +12,18 @@ To access the sales order page, click on the <span class="badge inventree nav ma
{% include "img.html" %}
{% endwith %}
-### Sales Order Reference
+### Sales Order Status Codes
-Each Sales Order is uniquely identified by its *Reference* field. Read more about [reference fields](../settings/reference.md).
+Each Sales Order has a specific status code, which represents the state of the order:
-### Create a Sales Order
+| Status | Description |
+| --- | --- |
+| Pending | The sales order has been created, but has not been finalized or submitted |
+| In Progress | The sales order has been issued, and is in progress |
+| Complete | The sales order has been completed, and is now closed |
+| Cancelled | The sales order was cancelled, and is now closed |
+
+## Create a Sales Order
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.
@@ -27,6 +34,10 @@ A Sales Order is linked to a specific customer, select one in the list of existi
Fill out the rest of the form with the sales order information then click on <span class="badge inventree confirm">Submit</span> to create the order.
+### Sales Order Reference
+
+Each Sales Order is uniquely identified by its *Reference* field. Read more about [reference fields](../settings/reference.md).
+
#### 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-ol'></span> Line Items</span> tab then clicking on the <span class="badge inventree add"><span class='fas fa-plus-circle'></span> Add Line Item</span> button.