diff --git a/docs/docs/assets/images/order/assign_project_code.png b/docs/docs/assets/images/order/assign_project_code.png new file mode 100644 index 0000000000..07b1af9bfe Binary files /dev/null and b/docs/docs/assets/images/order/assign_project_code.png differ diff --git a/docs/docs/assets/images/order/filter_by_project.png b/docs/docs/assets/images/order/filter_by_project.png new file mode 100644 index 0000000000..4e31eeed36 Binary files /dev/null and b/docs/docs/assets/images/order/filter_by_project.png differ diff --git a/docs/docs/assets/images/settings/project_codes.png b/docs/docs/assets/images/settings/project_codes.png new file mode 100644 index 0000000000..01546019e0 Binary files /dev/null and b/docs/docs/assets/images/settings/project_codes.png differ diff --git a/docs/docs/order/project_codes.md b/docs/docs/order/project_codes.md new file mode 100644 index 0000000000..aa4d874a97 --- /dev/null +++ b/docs/docs/order/project_codes.md @@ -0,0 +1,37 @@ +--- +title: Project Codes +--- + +## Project Codes + +A project code is a unique identifier assigned to a specific project, which helps in tracking and organizing project-related activities and resources. It enables easy retrieval of project-related data and facilitates project management and reporting. + +Individual orders (such as [Purchase Orders](./purchase_order.md) or [Sales Orders](./sales_order.md)) can be assigned a *Project Code* to allocate the order against a particular internal project. + +### Managing Project Codes + +Management of project codes (such as creating or editing codes) is accessed via the [settings page](../settings/global.md). Select the *Project Codes* tab to access project code configuration options: + +{% with id="project_codes", url="settings/project_codes.png", description="Project Codes List" %} +{% include "img.html" %} +{% endwith %} + +#### Enable Project Code Support + +By default, project code support is disabled. Select the *Enable Project Codes* option to enable support for this feature + +## Assigning Project Codes + +Project codes can be assigned to an order when the order is created, or at any later stage by simply editing the order. If project code support is enabled, a *Project Code* field is available in the order details form: + +{% with id="assign_project_code", url="order/assign_project_code.png", description="Assign Project Code" %} +{% include "img.html" %} +{% endwith %} + +## Filtering by Project Codes + +The order tables can be easily filtered or sorted by project code: + +{% with id="filter-by-project", url="order/filter_by_project.png", description="Filter by Project Code" %} +{% include "img.html" %} +{% endwith %} diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index ec06820193..2844e8d83b 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -106,6 +106,7 @@ nav: - Purchase Orders: order/purchase_order.md - Sales Orders: order/sales_order.md - Return Orders: order/return_order.md + - Project Codes: order/project_codes.md - Report: - Templates: report/report.md - Report Types: