@adminide-stack/clock-tik-browser 12.0.22-alpha.0 → 12.0.22-alpha.2

package/lib/templates/content/docs/books/books-overview.md

@@ -0,0 +1,93 @@
+---
+id: books-overview
+title: Books (Accounting & Finance)
+sidebar_label: Books Overview
+---
+
+## Books Module
+
+Clockbook's **Books** module provides a complete accounting and finance suite for managing your organization's purchases, sales, expenses, vendors, and financial notes — all from one centralized interface.
+
+### Accessing Books
+
+Click **Books** in the left sidebar to expand the Books menu. The module contains the following sub-sections:
+
+![Books Sidebar Navigation](/static/img/books/books-sidebar-expanded.png)
+
+| Sub-module | Description |
+|------------|-------------|
+| [**Purchase Orders**](/docs/books/purchase-orders) | Create and manage purchase orders to vendors |
+| [**Expenses**](/docs/books/expenses) | Track, categorize, and manage business expenses |
+| [**Vendors**](/docs/books/vendors) | Maintain your vendor/supplier directory |
+| [**Vendor Credits**](/docs/books/vendor-credits) | Issue and track credit notes against vendors |
+| [**Quotes**](/docs/books/quotes) | Create and send sales quotes to customers |
+| [**Sales Orders**](/docs/books/sales-orders) | Manage confirmed sales orders |
+| [**Notes**](/docs/books/notes) | Organize financial notes and memos |
+| [**Dashboard**](/docs/books/dashboard) | Visual analytics and customizable panels |
+
+---
+
+### Sidebar Structure
+
+The Books sidebar organizes pages into two main groups:
+
+```
+Books
+├── Purchase
+│   ├── Purchase Orders
+│   ├── Expenses
+│   ├── Vendors
+│   └── Vendor Credits
+├── Sales
+│   ├── Quotes
+│   └── Sales Orders
+└── Notes
+```
+
+---
+
+### Key Features at a Glance
+
+- **Purchase management** — Create purchase orders, track delivery status, and manage vendor relationships
+- **Expense tracking** — Log expenses with receipt uploads, categorize by account, and set up recurring expenses
+- **Vendor directory** — Maintain a full vendor database with contacts, bank details, and payment terms
+- **Vendor credits** — Issue credit notes with PDF generation and attachment support
+- **Sales quotes** — Generate professional quotes with line items, taxes, and terms & conditions
+- **Sales orders** — Convert quotes into confirmed orders with shipment tracking
+- **Notes** — Color-coded note cards with tags, pinning, and archiving
+- **Dashboard** — Customizable panels for timesheet, project, and distribution analytics
+- **Role-based permissions** — Granular control over who can view, create, edit, approve, and manage each resource
+- **Auto-generated numbers** — Purchase orders, quotes, sales orders, and vendor credits get auto-incrementing reference numbers with configurable prefixes
+- **Tax support** — TDS/TCS tax type selection with predefined rate tables
+- **File attachments** — Drag-and-drop file uploads on quotes, sales orders, vendor credits, and expense receipts
+- **PDF export** — Generate PDF documents for vendor credits
+
+---
+
+### How Books Works with Other Modules
+
+The Books module integrates with several other Clockbook features:
+
+- **Dashboard** — Custom dashboard panels pull data from timesheets and projects for financial insights
+- **Members** — Salesperson fields in quotes and sales orders link to organization members
+- **Time Tracker** — Dashboard panels display timesheet approval rates and time distribution analytics
+- **Projects** — Expenses can be linked to specific projects; quotes and sales orders reference project data
+
+---
+
+### Permissions
+
+The Books module uses role-based permissions following the pattern `organization.{resource}.{self|others}.{action}`. Resources include:
+
+| Resource | Available Actions |
+|----------|------------------|
+| **expenses** | view, create, edit, delete, manage, approve |
+| **purchases** | view, create, edit, delete, manage, approve |
+| **vendors** | view, create, edit, delete, manage |
+| **vendorCredits** | view, create, edit, delete, manage, approve |
+| **quotes** | view, create, edit, delete, manage, convert |
+| **salesOrders** | view, create, edit, delete, manage, approve |
+| **notes** | view, create, edit, delete, manage |
+| **dashboards** | view, create, edit, delete, manage |
+
+Permissions can be configured per role through the organization's settings.

package/lib/templates/content/docs/books/dashboard.md

@@ -0,0 +1,133 @@
+---
+id: books-dashboard
+title: Dashboard
+sidebar_label: Dashboard
+---
+
+## Dashboard
+
+The **Dashboard** provides customizable visual analytics and reporting panels. Navigate to `/dashboard` to access it.
+
+![Dashboard Overview](/static/img/books/dashboard-overview.png)
+
+---
+
+### Overview
+
+The Dashboard is a flexible, panel-based reporting tool that displays key metrics from your timesheets, projects, and team activity. You can create multiple dashboards, each with a different set of panels tailored to your needs.
+
+---
+
+### Managing Dashboards
+
+#### Creating a Dashboard
+
+1. Click the **dashboard selector** dropdown
+2. Click **Create Dashboard**
+3. Enter a name for the dashboard
+4. Configure access control (see below)
+5. Click **Save**
+
+#### Editing a Dashboard
+
+1. Select the dashboard from the dropdown
+2. Click the **Edit** (pencil) icon
+3. Modify the name or access settings
+4. Click **Save**
+
+#### Deleting a Dashboard
+
+1. Select the dashboard from the dropdown
+2. Click the **Delete** icon
+3. Confirm the deletion
+
+#### Setting a Default Dashboard
+
+You can mark one dashboard as your default, which loads automatically when you visit the Dashboard page.
+
+---
+
+### Access Control
+
+Each dashboard has an access level that determines who can see it:
+
+| Access Level | Description |
+|-------------|-------------|
+| **Only Me** | Only you can view this dashboard |
+| **Selected Users** | Share with specific users and/or roles |
+| **Everyone** | Visible to all organization members |
+
+When choosing **Selected Users**, you can add individual users or entire roles to the sharing list.
+
+---
+
+### Dashboard Panels
+
+Panels are the building blocks of your dashboard. Each panel displays a specific metric or visualization.
+
+#### Available Panel Types
+
+| Panel | Description |
+|-------|-------------|
+| **Active Projects** | Shows currently active projects and their status |
+| **Billable Time** | Displays billable vs. non-billable time breakdown |
+| **Project Distribution** | Chart showing time distribution across projects |
+| **Project Logs** | Recent project activity and log entries |
+| **Project Timing** | Time spent per project with comparisons |
+| **Task Distribution** | Breakdown of time by task type |
+| **Time Distribution** | Overall time distribution analytics |
+| **Timesheet Approval Rate** | Percentage of approved vs. pending timesheets |
+| **Timesheet** | Timesheet summary and status overview |
+| **Timesheet Status** | Breakdown of timesheet statuses |
+| **User Timing** | Time tracking per team member |
+| **Weekly Summary** | Week-over-week summary of key metrics |
+| **Custom Panel** | Create a custom panel with your own configuration |
+
+#### Panel Categories
+
+Panels are grouped into these categories for easy browsing:
+
+- **Timesheet** — Timesheet-related metrics and statuses
+- **Project Timing** — Project time tracking analytics
+- **Time Distribution** — How time is distributed across categories
+- **Project Distribution** — Project-level distribution charts
+- **Timesheet Status** — Timesheet approval and status breakdowns
+- **User Timing** — Per-user time tracking data
+- **Project Logs** — Activity and logging data
+
+---
+
+### Adding Panels
+
+1. Open the dashboard you want to customize
+2. Click **Manage Panels** or the **Add Panel** button
+3. Browse available panel types
+4. Select the panels you want to add
+5. Click **Save**
+
+---
+
+### Configuring Panels
+
+Each panel has configurable preferences:
+
+| Setting | Description |
+|---------|-------------|
+| **Time Period** | Select the time range for data (e.g., This Week, This Month, Custom) |
+| **Date Range** | Custom start and end dates |
+| **Group By** | How data is grouped (e.g., by project, by user, by day) |
+| **Filters** | Additional filters to narrow the displayed data |
+
+---
+
+### Reordering Panels
+
+Drag and drop panels to reorder them on your dashboard. The layout is saved automatically and persists across sessions.
+
+---
+
+### Removing Panels
+
+1. Open **Manage Panels**
+2. Click the **Remove** button on the panel you want to remove
+3. The panel is removed from the dashboard (it can be re-added later)

package/lib/templates/content/docs/books/expenses.md

@@ -0,0 +1,151 @@
+---
+id: books-expenses
+title: Expense Management
+sidebar_label: Expenses
+---
+
+## Expense Management
+
+The **Expenses** module (`Books > Purchase > Expenses`) lets you track, categorize, and manage all business expenses. Navigate to `/books/purchase/expenses` to access it.
+
+![Expenses List](/static/img/books/expenses-list.png)
+
+---
+
+### Overview
+
+The Expenses page provides a centralized interface for recording business expenses, uploading receipts, categorizing them by account, and tracking their approval status.
+
+---
+
+### Expense List
+
+The main page displays a data table of all expenses with:
+
+| Column | Description |
+|--------|-------------|
+| **Date** | Date the expense was incurred |
+| **Expense Account** | Category/account the expense is charged to |
+| **Amount** | Expense amount with currency |
+| **Vendor** | Vendor or payee |
+| **Status** | Current status of the expense |
+| **Actions** | View, edit, or delete the expense |
+
+#### Searching & Filtering
+
+- **Search bar** — Find expenses by description, vendor, or invoice number
+- **Status filter** — Filter by expense status
+- **Expense Account** — Filter by account category
+- **Vendor** — Filter by specific vendor
+- **Customer** — Filter by associated customer
+- **Date range** — Filter by date range (From / To)
+- **Pagination** — Navigate through results
+
+---
+
+### Expense Statuses
+
+| Status | Description |
+|--------|-------------|
+| **Draft** | Expense recorded but not yet submitted |
+| **Submitted** | Expense submitted for approval |
+| **Approved** | Expense has been approved |
+| **Rejected** | Expense has been rejected |
+| **Paid** | Expense has been reimbursed or paid |
+
+---
+
+### Creating an Expense
+
+![Expense Form](/static/img/books/expense-form.png)
+
+1. Navigate to **Books > Purchase > Expenses**
+2. Click **New Expense**
+3. Fill in the form fields
+4. Optionally upload receipts
+5. Click **Save**
+
+#### Form Fields
+
+| Field | Required | Description |
+|-------|----------|-------------|
+| **Date** | Yes | Date the expense was incurred |
+| **Expense Account** | Yes | Select from categorized account list |
+| **Amount** | Yes | Expense amount |
+| **Currency** | Yes | Transaction currency |
+| **Paid Through** | No | Account/method used for payment |
+| **Vendor** | No | Vendor or payee |
+| **Invoice Number** | No | Vendor's invoice reference number |
+| **Notes** | No | Additional details or description |
+| **Customer** | No | Customer to associate with this expense |
+| **Reporting Tags** | No | Tags for reporting and categorization |
+| **Is Billable** | No | Whether this expense is billable to a customer |
+| **Project** | No | Link expense to a specific project |
+| **Tax Amount** | No | Tax portion of the expense |
+| **Tax Rate** | No | Applicable tax rate |
+
+#### Receipt Upload
+
+You can attach receipt images or documents to any expense:
+
+1. Click the **Upload Receipt** area in the form
+2. Select or drag-and-drop your receipt file
+3. The receipt is uploaded and linked to the expense
+
+---
+
+### Expense Account Categories
+
+Expenses are organized into the following account categories:
+
+| Category | Examples |
+|----------|---------|
+| **Cost of Goods Sold** | Direct materials, manufacturing costs |
+| **Expense** | Advertising & Marketing, Bank Fees & Charges, Consultant Expense, IT & Internet Expenses, Janitorial Expense, Meals & Entertainment, Office Supplies, Postage, Printing & Stationery, Rent Expense, Repairs & Maintenance, Salaries & Employee Wages, Telephone Expense, Travel Expense, and more (30+ accounts) |
+| **Non Current Liability** | Long-term obligations |
+| **Other Current Liability** | Short-term obligations |
+| **Fixed Asset** | Equipment, furniture, vehicles |
+| **Other Current Asset** | Prepaid expenses, deposits |
+
+---
+
+### Bulk Expense Entry
+
+For entering multiple expenses at once:
+
+1. Navigate to **Books > Purchase > Expenses**
+2. Click **Bulk Add**
+3. Enter multiple expense rows in the bulk entry form
+4. Submit all rows at once
+
+This is useful for recording several expenses from a single trip or event.
+
+---
+
+### Recurring Expenses
+
+You can set up recurring expenses that are automatically created on a schedule:
+
+| Field | Description |
+|-------|-------------|
+| **Profile Name** | Name for the recurring expense profile |
+| **Repeat Every** | Frequency (e.g., every month, every week) |
+| **Start Date** | When to begin recurring |
+| **End Date** | When to stop recurring (optional) |
+| **Never Expires** | Toggle to make the expense recur indefinitely |
+
+To set up a recurring expense:
+
+1. Create a new expense
+2. Enable the **Recurring** toggle
+3. Fill in the recurrence fields
+4. Save the expense
+
+---
+
+### Approval Workflow
+
+1. **Employee** records an expense and submits it
+2. **Manager/Admin** reviews the expense
+3. Expense is either **Approved** or **Rejected**
+4. Approved expenses can be marked as **Paid** once reimbursed

package/lib/templates/content/docs/books/notes.md

@@ -0,0 +1,102 @@
+---
+id: books-notes
+title: Notes
+sidebar_label: Notes
+---
+
+## Notes
+
+The **Notes** module (`Books > Notes`) provides a simple, visual way to organize financial notes and memos. Navigate to `/books/notes` to access it.
+
+![Notes Page](/static/img/books/notes-page.png)
+
+---
+
+### Overview
+
+Notes are displayed as color-coded cards in a grid layout — similar to sticky notes. Use them for keeping track of financial reminders, meeting notes, vendor follow-ups, or any other information related to your books.
+
+---
+
+### Notes Grid
+
+Unlike other Books pages that use data tables, Notes uses a **card-based grid layout**:
+
+- Each note appears as a colored card
+- Cards show the **title**, a **content preview**, **tags**, and the **date**
+- Pinned notes appear at the top
+- Use the **search bar** to find notes by title or content
+- Use the **tags filter** to filter by specific tags
+- Toggle between **active**, **pinned**, and **archived** views
+
+---
+
+### Creating a Note
+
+1. Navigate to **Books > Notes**
+2. Click **New Note**
+3. Fill in the note details
+4. Click **Save**
+
+#### Form Fields
+
+| Field | Required | Description |
+|-------|----------|-------------|
+| **Title** | Yes | Note title/heading |
+| **Content** | No | Rich text content of the note |
+| **Color** | No | Background color for the note card (default: white) |
+| **Tags** | No | Tags for categorization and filtering |
+
+---
+
+### Note Actions
+
+Each note card provides the following actions:
+
+| Action | Description |
+|--------|-------------|
+| **Edit** | Open the note for editing |
+| **Delete** | Permanently remove the note |
+| **Pin** | Pin the note to the top of the grid |
+| **Archive** | Move the note to the archive |
+
+---
+
+### Pinning Notes
+
+Pin important notes so they always appear at the top of your notes grid:
+
+1. Click the **Pin** action on a note card
+2. The note moves to the top of the grid and stays there
+3. Click **Unpin** to return it to normal position
+
+---
+
+### Archiving Notes
+
+Archive notes you no longer need in your active view but want to keep:
+
+1. Click the **Archive** action on a note card
+2. The note is removed from the active view
+3. Switch to the **Archived** view to see archived notes
+4. Unarchive a note to restore it to the active view
+
+---
+
+### Color Coding
+
+Assign colors to your notes for visual organization:
+
+- Use the **color picker** when creating or editing a note
+- Different colors can represent categories (e.g., red for urgent, green for completed, blue for follow-up)
+- The default color is white (`#ffffff`)
+
+---
+
+### Tags
+
+Tags help you categorize and filter notes:
+
+- Add one or more tags when creating or editing a note
+- Use the **tags filter** on the Notes page to show only notes with specific tags
+- Tags appear on each note card for quick identification

package/lib/templates/content/docs/books/purchase-orders.md

@@ -0,0 +1,142 @@
+---
+id: books-purchase-orders
+title: Purchase Orders
+sidebar_label: Purchase Orders
+---
+
+## Purchase Orders
+
+The **Purchase Orders** module (`Books > Purchase > Purchase Orders`) lets you create and manage purchase orders to your vendors. Navigate to `/books/purchase/orders` to access it.
+
+![Purchase Orders List](/static/img/books/purchase-orders-list.png)
+
+---
+
+### Overview
+
+Purchase Orders (POs) formalize your procurement process by documenting what you're buying, from whom, at what price, and when it should be delivered.
+
+---
+
+### Purchase Order List
+
+The main page displays a data table of all purchase orders with:
+
+| Column | Description |
+|--------|-------------|
+| **PO Number** | Auto-generated purchase order number |
+| **Date** | Date the PO was created |
+| **Vendor** | Vendor/supplier the order is placed with |
+| **Status** | Current status of the order |
+| **Total Amount** | Order total with currency |
+| **Actions** | View, edit, or delete the purchase order |
+
+#### Searching & Filtering
+
+- **Search bar** — Find POs by number, vendor name, or reference
+- **Status filter** — Filter by PO status
+- **Date range** — Filter by date range (From / To)
+- **Pagination** — Navigate through results with offset/limit controls
+
+---
+
+### Purchase Order Statuses
+
+| Status | Description |
+|--------|-------------|
+| **Draft** | PO has been created but not yet sent to the vendor |
+| **Sent** | PO has been sent to the vendor |
+| **Partially Received** | Some items from the PO have been received |
+| **Received** | All items from the PO have been received |
+| **Cancelled** | PO has been cancelled |
+
+---
+
+### Creating a Purchase Order
+
+![Purchase Order Form](/static/img/books/purchase-order-form.png)
+
+1. Navigate to **Books > Purchase > Purchase Orders**
+2. Click **New Purchase Order**
+3. Fill in the form fields (see below)
+4. Add line items
+5. Click **Save as Draft** or **Send**
+
+#### Form Fields
+
+| Field | Required | Description |
+|-------|----------|-------------|
+| **PO Number** | Auto | Auto-generated with configurable prefix (see [Settings](#settings)) |
+| **Date** | Yes | Purchase order date |
+| **Vendor** | Yes | Select from your vendor directory |
+| **Delivery Address Type** | No | Choose between Organization address or Customer address |
+| **Customer** | No | Select customer (if delivery is to a customer) |
+| **Reference Number** | No | External reference number |
+| **Delivery Date** | No | Expected delivery date |
+| **Payment Terms** | No | Payment terms (e.g., Net 30, Net 60) |
+| **Shipment Preference** | No | Preferred shipping method |
+| **Notes** | No | Additional notes or instructions |
+
+#### Delivery Address
+
+When entering a delivery address, the following sub-fields are available:
+
+- Name
+- Address Line 1
+- Address Line 2
+- City
+- State
+- Zip Code
+- Country
+
+#### Line Items
+
+Each line item includes:
+
+| Field | Description |
+|-------|-------------|
+| **Item Details** | Description of the item being purchased |
+| **Quantity** | Number of units |
+| **Rate** | Price per unit |
+| **Amount** | Auto-calculated (Quantity × Rate) |
+
+#### Financial Summary
+
+| Field | Description |
+|-------|-------------|
+| **Sub Total** | Sum of all line item amounts |
+| **Discount** | Discount amount or percentage |
+| **Tax Amount** | Applicable tax |
+| **Total Amount** | Final amount after discount and tax |
+| **Currency** | Currency for the transaction (default: INR) |
+
+---
+
+### Editing a Purchase Order
+
+1. Click the **Edit** action on a purchase order in the list
+2. Modify the required fields
+3. Click **Save**
+
+> **Note:** Only POs in **Draft** status can be freely edited. Sent or received POs may have restricted editing.
+
+---
+
+### Viewing a Purchase Order
+
+Click the **View** action or the PO number link to open the detail page, which displays all PO information in a read-only format.
+
+---
+
+### Deleting a Purchase Order
+
+Click the **Delete** action on a purchase order in the list. A confirmation dialog will appear before the PO is permanently removed.
+
+---
+
+### Settings
+
+The PO number prefix can be configured in your organization settings:
+
+- **Setting:** `books.purchase.poNumberPrefix`
+- **Example:** Setting the prefix to `PO-` will generate numbers like `PO-0001`, `PO-0002`, etc.