# Projects

<p class="doc-lead">A Project is the central record for a job — it links a customer, supervisor, tasks, budget, and all related sale, purchase, inventory, and account transactions. Track progress from Not Started through completion, pause, or cancellation.</p>

<div class="doc-toc">
<p class="doc-toc-title">On this page</p>
<div class="doc-toc-section">
<span class="doc-toc-group-title">Getting started</span>
<div class="doc-toc-links">
<a href="#/project/projects?id=overview">Overview &amp; List View</a>
<a href="#/project/projects?id=quick-start">Quick Start</a>
</div>
</div>
<div class="doc-toc-section">
<span class="doc-toc-group-title">Form reference</span>
<div class="doc-toc-links">
<a href="#/project/projects?id=header-fields">Header Fields</a>
<a href="#/project/projects?id=cost-settings">Cost Settings</a>
<a href="#/project/projects?id=status-lifecycle">Status Lifecycle</a>
</div>
</div>
<div class="doc-toc-section">
<span class="doc-toc-group-title">Project view</span>
<div class="doc-toc-links">
<a href="#/project/projects?id=view-tabs">View Tabs</a>
<a href="#/project/projects?id=project-view-dashboard">Project View Dashboard</a>
<a href="#/project/projects?id=embedded-sale">Sale Tab</a>
<a href="#/project/projects?id=embedded-purchase">Purchase Tab</a>
<a href="#/project/projects?id=embedded-inventory">Inventory Tab</a>
<a href="#/project/projects?id=embedded-accounts">Accounts Tab</a>
</div>
</div>
<div class="doc-toc-section">
<span class="doc-toc-group-title">More</span>
<div class="doc-toc-links">
<a href="#/project/projects?id=actions-status">Actions &amp; Status</a>
<a href="#/project/projects?id=example">Example Workflows</a>
<a href="#/project/projects?id=best-practices">Best Practices</a>
<a href="#/project/projects?id=faq">FAQ</a>
<a href="#/project/projects?id=related">Related</a>
</div>
</div>
</div>

<hr class="doc-section-divider">

<h2 id="overview">Overview &amp; List View</h2>

Go to <b>Project → Projects</b>. The list shows every project with its reference, customer, supervisor, key dates, and status. Use quick-filter tabs or Advanced Filters to narrow the list. You can export the list, select multiple rows, and open any project in the full-page project view.

> Screenshot pending — `project/images/projects-list.webp`

<b>List columns</b>

| **Column** | **Shows** |
|------------|-----------|
| Id | Internal reference number. |
| Number # | Project code. |
| Name | Project name. |
| Customer | Linked customer. |
| Supervisor | Primary supervisor (employee). |
| PWO Number | Purchase work order number (when enabled in settings). |
| Executing Officer | Executing officer name (when enabled in settings). |
| Start Date | Project start date and time. |
| Due Date | Target due date and time. |
| Status | Current project status. |

<b>Quick filter tabs</b>

| **Tab** | **Shows** |
|---------|-----------|
| Default | All projects except Cancelled. |
| On Going | Projects with status On Going. |
| Completed | Completed projects. |
| Not Started | Projects not yet started. |
| Paused | Paused projects. |
| Stopped | Stopped projects. |
| Cancelled | Cancelled projects. |

<b>Advanced Filters</b>

Name, Number #, Customer, Supervisor, PWO Number, Executing Officer, Description, Ship Number, Status, Created date.

<b>List row actions</b>

| **Action** | **Available when status is** |
|------------|------------------------------|
| Edit | Not Started, On Going |
| Delete | Not Started, On Going |
| View | Any |

<b>List toolbar</b>

| **Action** | **Description** |
|------------|-----------------|
| New | Create a new project. |
| Export | Export the current list to Excel. |

<hr class="doc-section-divider">

<h2 id="quick-start">Quick Start</h2>

1. Go to <b>Project → Projects</b> and click <b>New</b>.
2. Enter <b>Project Name</b>, <b>Customer</b>, and <b>Project Code</b> (or leave blank if auto-numbering is enabled).
3. Set <b>Supervisor</b>, <b>Start Date</b>, and <b>Due Date</b>.
4. Click <b>Save</b> — the project opens in the project view.
5. From the more menu (⋮), click <b>Start</b> when work begins.

<hr class="doc-section-divider">

<h2 id="header-fields">Header Fields</h2>

<b>Basic Information</b>

| **Field** | **Required** | **Description** |
|-----------|--------------|-----------------|
| Project Name | Yes | Display name of the project. |
| Customer | Yes | Customer the project is for. |
| Project Code | Conditional | Project reference number; hidden when auto-numbering is on. |
| Project Type | No | External or Internal (shown when enabled in <a href="#/project/project-settings">Project Settings</a>). |

<b>Team &amp; Personnel</b>

| **Field** | **Description** |
|-----------|-----------------|
| Supervisor | Primary employee in charge. |
| Sub Supervisors | Additional supervisors (multi-select). |

<b>Project Details &amp; Timeline</b>

| **Field** | **Description** |
|-----------|-----------------|
| PWO Number | Purchase work order reference (optional field). |
| Executing Officer | Officer responsible for execution (optional field). |
| Ship Name | Vessel or site name (optional field). |
| Ship Number | Vessel or site number (optional field). |
| Start Date | When the project is scheduled to start. |
| Due Date | Target completion date (must be on or after Start Date). |
| Project Value | Estimated contract value (optional field). |

<b>Notes</b>

| **Field** | **Description** |
|-----------|-----------------|
| Description | Rich-text notes about the project. |

<b>View-only fields</b> (shown after status changes)

| **Field** | **When shown** |
|-----------|----------------|
| Completion Date | After the project is completed. |
| Completion Notes | Notes entered on completion. |
| Cancellation Date | After the project is cancelled. |
| Cancel Notes | Reason entered on cancellation. |
| Progress (%) | After a progress update. |

<hr class="doc-section-divider">

<h2 id="cost-settings">Cost Settings</h2>

Optional rates used in <a href="#/project/reports/project-summary">Project Summary</a> and profit reports. Leave empty to skip that extra cost.

| **Field** | **Description** |
|-----------|-----------------|
| Additional Cost per Hour | Added to project cost as this rate × <b>total labour hours</b> (for example bonus, food, or other overhead not already booked on the project). Example: 10 × 300 hours = 3,000. |
| Unconsidered Hours Cost per Hour | Approximate salary for labour hours that do not overlap a posted or paid payslip. Applied as this rate × <b>unconsidered hours</b>. |

<b>How they affect reports</b>

<ul>
<li><b>Payslip Cost</b> is salary allocated only to hours that overlap a posted or paid payslip (considered hours). A payslip with amount 0 still counts those hours as considered. Draft pay runs do not.</li>
<li><b>Unconsidered hours</b> are attendance hours with no overlapping posted or paid payslip. They are not included in Payslip Cost.</li>
<li><b>Additional Cost</b> = Additional Cost per Hour × total man hours (shown only when this rate is set).</li>
<li><b>Unconsidered Hours Cost</b> = Unconsidered Hours Cost per Hour × unconsidered hours (shown only when this rate is set).</li>
<li><b>Total Cost</b> = consumables + Payslip Cost + expenses + purchases + Additional Cost + Unconsidered Hours Cost.</li>
</ul>

<hr class="doc-section-divider">

<h2 id="status-lifecycle">Status Lifecycle</h2>

| **Status** | **Meaning** |
|------------|-------------|
| Not Started | Project created but work has not begun. |
| On Going | Work is in progress. |
| Completed | Project finished successfully. |
| Paused | Temporarily halted. |
| Stopped | Work halted without cancellation. |
| Cancelled | Project abandoned. |

Typical flow: <b>Not Started</b> → <b>Start</b> → <b>On Going</b> → <b>Complete</b> → <b>Completed</b>. A completed project can be <b>Reopen</b>ed to On Going. On Going projects can be <b>Pause</b>d, <b>Stop</b>ped, or eventually <b>Cancel</b>led from Paused or Stopped.

<hr class="doc-section-divider">

<h2 id="view-tabs">View Tabs</h2>

Opening a project shows a left navigation panel. Each tab filters data to the current project.

| **Tab** | **What it shows** |
|---------|-------------------|
| Project Details | Summary of project header fields and status. |
| Dashboard | Per-project KPIs and chart — see <a href="#/project/projects?id=project-view-dashboard">below</a>. |
| Project Tasks | Tasks linked to this project. |
| Purchase | Purchase documents for this project — see <a href="#/project/projects?id=embedded-purchase">below</a>. |
| Sale | Sale documents for this project — see <a href="#/project/projects?id=embedded-sale">below</a>. |
| Inventory | Inventory documents for this project — see <a href="#/project/projects?id=embedded-inventory">below</a>. |
| Accounts | Expenses and vouchers for this project — see <a href="#/project/projects?id=embedded-accounts">below</a>. |
| Documents | File attachments for the project. |
| Project Category | Category mappings for this project. |
| Summary Report | Embedded <a href="#/project/reports/project-summary">Project Summary</a> for this project. |
| Schedule Report | Embedded <a href="#/project/reports/project-schedule">Project Schedule</a> for this project. |
| Budget Report | Embedded <a href="#/project/reports/budget-report">Budget Report</a> for this project. |

<hr class="doc-section-divider">

<h2 id="project-view-dashboard">Project View Dashboard</h2>

The <b>Dashboard</b> tab inside a project shows financial KPIs and a chart for that project only.

<b>KPI widgets</b>

| **Widget** | **What it shows** |
|------------|-------------------|
| Project Value | Estimated or entered project value. |
| Total Sales | Count and value of approved sale invoices linked to the project. |
| Total Purchases | Count and value of approved purchase invoices linked to the project. |
| Total Expenses | Count and value of approved expenses linked to the project. |
| Uninvoiced | Project value minus invoiced sale value. |
| Open Sales | Count and value of open (non-closed) sale documents. |
| Open Purchases | Count and value of open purchase documents. |
| Open Expenses | Count and value of open expenses. |

<b>Chart</b>

<b>Sales vs Purchase &amp; Expense</b> — a line chart comparing monthly sale, purchase, and expense totals for the project.

> Screenshot pending — `project/images/project-view-dashboard.webp`

<hr class="doc-section-divider">

<h2 id="embedded-sale">Sale Tab</h2>

The <b>Sale</b> tab lists sale documents filtered to the current project. Each sub-tab has a <b>New</b> button that pre-fills the project (and customer where applicable).

| **Sub-tab** | **Related documentation** |
|-------------|----------------------------|
| Sale Quotations | <a href="#/sales/sale-quotation">Sale Quotation</a> |
| Sale Orders | <a href="#/sales/sale-order">Sale Order</a> |
| Pro Forma Invoice | <a href="#/sales/sale-invoice">Sale Invoice</a> (pro forma) |
| Commercial Invoice | <a href="#/sales/sale-invoice">Sale Invoice</a> (commercial) |
| Sale Invoice | <a href="#/sales/sale-invoice">Sale Invoice</a> |
| Return Order | <a href="#/sales/sale-order">Sale Return Order</a> |
| Credit Note | <a href="#/sales/credit-note">Credit Note</a> |

<hr class="doc-section-divider">

<h2 id="embedded-purchase">Purchase Tab</h2>

The <b>Purchase</b> tab lists purchase documents filtered to the current project. <b>New</b> pre-fills the project on each form.

| **Sub-tab** | **Related documentation** |
|-------------|----------------------------|
| Purchase Quotations | <a href="#/purchase/purchase-quotations">Purchase Quotations</a> |
| Purchase Orders | <a href="#/purchase/purchase-order">Purchase Order</a> |
| Purchase Invoice | <a href="#/purchase/purchase-invoice">Purchase Invoice</a> |
| Return Order | <a href="#/purchase/purchase-return-order">Purchase Return Order</a> |
| Debit Note | <a href="#/purchase/debit-note">Debit Note</a> |

<hr class="doc-section-divider">

<h2 id="embedded-inventory">Inventory Tab</h2>

The <b>Inventory</b> tab lists inventory documents filtered to the current project. <b>New</b> pre-fills the project.

| **Sub-tab** | **Related documentation** |
|-------------|----------------------------|
| Delivery Note | <a href="#/inventory/goods-delivery-note">Goods Delivery Note</a> |
| Receipt Note | <a href="#/inventory/goods-receipt-note">Goods Receipt Note</a> |
| Consumable Issue | <a href="#/inventory/consumable-issue">Consumable Issue</a> |
| Inventory Adjustment | <a href="#/inventory/inventory-adjustment">Inventory Adjustment</a> |
| Inventory Conversion | <a href="#/inventory/inventory-conversion">Inventory Conversion</a> |

<hr class="doc-section-divider">

<h2 id="embedded-accounts">Accounts Tab</h2>

The <b>Accounts</b> tab lists account transactions filtered to the current project. <b>New</b> pre-fills the project.

| **Sub-tab** | **Related documentation** |
|-------------|----------------------------|
| Expenses | <a href="#/accounts/expense-entry">Expense</a> |
| Payment Voucher | <a href="#/accounts/payment-voucher">Payment Voucher</a> |
| Receipt Voucher | <a href="#/accounts/receipt-voucher">Receipt Voucher</a> |

<hr class="doc-section-divider">

<h2 id="actions-status">Actions &amp; Status</h2>

<b>Toolbar actions</b>

| **Action** | **Available when status is** |
|------------|------------------------------|
| Edit | Not Started, On Going |
| Delete | Not Started |
| Clone | Any |
| Print | Any |

<b>More menu (⋮) actions</b>

| **Action** | **Available when status is** | **Effect** |
|------------|------------------------------|------------|
| Start | Not Started | Moves to On Going. |
| Complete | On Going | Moves to Completed; sets progress to 100%. |
| Reopen | Completed | Moves back to On Going. |
| Pause | On Going | Moves to Paused. |
| Resume | Paused, Stopped | Moves back to On Going. |
| Stop | On Going, Paused | Moves to Stopped. |
| Cancel | Paused, Stopped | Moves to Cancelled. |
| Project Budget | Any | Opens the <a href="#/project/project-budget">Project Budget</a> for this project. |
| Update Progress | Not Started, Completed, On Going | Enter <b>Progress (%)</b> (0–100). |
| Assign Template | Not Started, On Going | Apply a <a href="#/project/project-template">Project Template</a> to create tasks and category mappings. |
| Print | Any | Print the project details. |

<hr class="doc-section-divider">

<h2 id="example">Example Workflows</h2>

<b>Ship-repair project</b>

1. In <a href="#/project/project-settings">Project Settings</a>, enable <b>PWO Number</b>, <b>Ship Name</b>, and <b>Ship Number</b>.
2. Create a project for the vessel owner, enter PWO and ship details, and set a due date.
3. Click <b>Start</b>, add tasks under <b>Project Tasks</b>, and raise purchase orders from the <b>Purchase</b> tab for spare parts.
4. Issue consumables from the <b>Inventory</b> tab and invoice the customer from the <b>Sale</b> tab.
5. Run <b>Summary Report</b> from the left nav to review revenue, cost, and profit.

<b>Template-based rollout</b>

1. Create a <a href="#/project/project-template">Project Template</a> with standard tasks.
2. Create a new project and choose <b>Assign Template</b> from the more menu.
3. Select the template — tasks and category mappings are created automatically.
4. Adjust planned dates on individual <a href="#/project/project-task">Project Tasks</a> as needed.

<b>Purchase from project view</b>

1. Open an On Going project and go to <b>Purchase → Purchase Orders</b>.
2. Click <b>New</b> — the project is already selected.
3. Add lines, save, and approve — the PO appears in both the project Purchase tab and the main Purchase module.

<hr class="doc-section-divider">

<h2 id="best-practices">Best Practices</h2>

<ul>
<li>Enable optional fields in <a href="#/project/project-settings">Project Settings</a> before creating projects so forms show the fields your team needs.</li>
<li>Start the project when work actually begins so status and reports stay accurate.</li>
<li>Link every sale, purchase, and expense to the project so the Summary and Profit reports reflect true job costing.</li>
<li>Set <b>Additional Cost per Hour</b> and <b>Unconsidered Hours Cost per Hour</b> on the project when you need overhead or unpaid-hour salary in job cost. Leave them empty if those extras should not appear on reports.</li>
<li>Use <b>Assign Template</b> for repeatable project types instead of re-entering the same task list.</li>
<li>Update progress regularly or complete the project when finished so dashboards and schedule reports stay current.</li>
</ul>

<hr class="doc-section-divider">

<h2 id="faq">FAQ</h2>

<b>Is a budget created automatically when I save a new project?</b><br>
Yes. A default project budget is created in the background when you save a new project. Open it via <b>Project Budget</b> in the more menu.

<b>Can I edit a completed project?</b><br>
Use <b>Reopen</b> from the more menu to move it back to On Going, then <b>Edit</b> becomes available again.

<b>Why do I not see PWO Number or Ship Name on the form?</b><br>
Those fields are optional. Enable them under <a href="#/project/project-settings">Project Settings</a> → <b>Select additional project fields you will like to Add</b>.

<b>Where is the difference between module dashboard and project dashboard?</b><br>
<b>Project → Dashboard</b> shows company-wide operational KPIs and, when you have Project Wise Profit access, financial totals, charts, and top projects for a selected period. The <b>Dashboard</b> tab inside a single project shows that project's sale, purchase, and expense KPIs only.

<b>Can I delete a project that has transactions?</b><br>
Delete is available only when status is <b>Not Started</b>. Once sale, purchase, or expense documents are linked, use <b>Stop</b> or <b>Cancel</b> instead of delete.

<b>Why can't I edit this project?</b><br>
<b>Edit</b> is available when status is Not Started or On Going. For Completed projects, use <b>Reopen</b> from the more menu first.

<b>How do I link sale and purchase documents to a project?</b><br>
Select the project on each document header, or use <b>New</b> from the project's Sale, Purchase, Inventory, or Accounts tabs — the project is pre-filled.

<b>What happens when I click Complete on a project?</b><br>
Status moves to Completed and progress is set to 100%. You can still view reports and linked documents; use <b>Reopen</b> to resume editing.

<b>Can I pause a Not Started project?</b><br>
No. <b>Pause</b> is available only when status is On Going. Start the project first, then pause if work is temporarily halted.

<b>Why is Assign Template unavailable?</b><br>
Assign Template appears when status is Not Started or On Going. Completed, Cancelled, Paused, and Stopped projects cannot receive a new template assignment from the more menu.

<b>Do service completion notes count toward project revenue?</b><br>
Revenue in project reports comes from approved <a href="#/sales/sale-invoice">Sale Invoices</a>. Service Completion Notes confirm delivery; invoice the customer to reflect revenue on the project dashboard.

<b>What is the difference between Project Supervisor and Sub Supervisors?</b><br>
The primary supervisor is set on the project header. Sub Supervisors are additional employees tracked on the project form for reporting and access — they do not replace the main supervisor on profit reports unless filtered separately.

<b>When should I set Additional Cost per Hour?</b><br>
Use it for overhead that is not already tagged to the project (for example bonus or food). The amount on reports is this rate × total labour hours. Leave empty if you do not want that extra cost.

<b>What are unconsidered hours?</b><br>
Labour hours whose date does not overlap a posted or paid payslip. Payslip Cost covers only considered hours. Set <b>Unconsidered Hours Cost per Hour</b> if you want an estimated salary for those hours on profit reports.

<b>Why is progress not updating from the project list?</b><br>
Use <b>Update Progress</b> from the more menu on the project view, or update task progress on <a href="#/project/project-task">Project Tasks</a> and the <a href="#/project/reports/project-schedule">Project Schedule</a> report.

<hr class="doc-section-divider">

<h2 id="related">Related</h2>

<ul>
<li><a href="#/project/project-task">Project Task</a></li>
<li><a href="#/project/project-budget">Project Budget</a></li>
<li><a href="#/project/project-template">Project Template</a></li>
<li><a href="#/project/project-settings">Project Settings</a></li>
<li><a href="#/project/reports/">Project Reports</a></li>
</ul>
