From 931d27d92df8e731d0ddca200df2cb121a1d26cc Mon Sep 17 00:00:00 2001 From: HafizMMoaz Date: Thu, 16 Jul 2026 18:48:09 +0500 Subject: [PATCH] Remove em dashes from docs Mostly punctuation in prose. Two changes are not: The reference generator used an em dash as the placeholder for "no methods", so it kept regenerating them into the package pages. It now says "none", which reads better anyway. The last four came from the real-estate and restaurant composer.json descriptions, fixed in those packages. The reference pages here are regenerated from that metadata rather than edited by hand. --- .github/CODEOWNERS | 2 +- README.md | 4 +- .../10-getting-started/getting-started.md | 16 +- .../10-getting-started/introduction.md | 4 +- .../20-architecture/media-library.md | 22 +- .../20-architecture/module-development.md | 16 +- docs-developer/30-guides/contributing.md | 6 +- docs-developer/30-guides/docker-and-ci.md | 10 +- .../30-guides/publishing-a-package.md | 4 +- docs-developer/50-reference/account.md | 132 +++---- docs-developer/50-reference/aiassistant.md | 6 +- docs-developer/50-reference/budget-planner.md | 28 +- docs-developer/50-reference/calendar.md | 8 +- docs-developer/50-reference/contract.md | 48 +-- docs-developer/50-reference/double-entry.md | 26 +- docs-developer/50-reference/form-builder.md | 22 +- docs-developer/50-reference/goal.md | 40 +-- docs-developer/50-reference/google-captcha.md | 2 +- docs-developer/50-reference/google-meet.md | 10 +- docs-developer/50-reference/hrm.md | 336 +++++++++--------- docs-developer/50-reference/index.md | 4 +- docs-developer/50-reference/jitsi.md | 10 +- docs-developer/50-reference/landing-page.md | 20 +- docs-developer/50-reference/lead.md | 150 ++++---- .../50-reference/package-template.md | 10 +- docs-developer/50-reference/paypal.md | 6 +- docs-developer/50-reference/performance.md | 78 ++-- docs-developer/50-reference/pos.md | 14 +- .../50-reference/product-service.md | 22 +- docs-developer/50-reference/quotation.md | 12 +- docs-developer/50-reference/real-estate.md | 28 +- docs-developer/50-reference/recruitment.md | 138 +++---- docs-developer/50-reference/restaurant.md | 90 ++--- docs-developer/50-reference/slack.md | 2 +- docs-developer/50-reference/stripe.md | 6 +- docs-developer/50-reference/support-ticket.md | 122 +++---- docs-developer/50-reference/taskly.md | 62 ++-- docs-developer/50-reference/telegram.md | 2 +- docs-developer/50-reference/timesheet.md | 10 +- docs-developer/50-reference/training.md | 38 +- docs-developer/50-reference/twilio.md | 2 +- docs-developer/50-reference/webhook.md | 6 +- docs-developer/50-reference/zoom-meeting.md | 10 +- .../03-super-admin-access-and-capabilities.md | 2 +- docs-user/08-sales-invoice.md | 8 +- docs-user/09-purchase-management.md | 2 +- docs-user/17-hrm-management.md | 40 +-- docs-user/18-performance-management.md | 4 +- docs-user/20-recruitment-management.md | 22 +- docs-user/22-crm-management.md | 12 +- ...026-07-10-zerp-1.0-release-and-dev-docs.md | 32 +- ...10-zerp-1.0-release-and-dev-docs-design.md | 26 +- scripts/gen-package-reference.mjs | 8 +- src/pages/index.tsx | 4 +- 54 files changed, 872 insertions(+), 872 deletions(-) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index d88ad10..18cd3ea 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,4 +1,4 @@ # Default reviewers for every change in this repo. -# Outside contributors: fork the repo and open a PR against the default branch — +# Outside contributors: fork the repo and open a PR against the default branch, # you do NOT need write access. A code owner below must approve before merge. * @zerp-pk/maintainers diff --git a/README.md b/README.md index 02b9aa8..ba0d88d 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,8 @@ User and developer documentation for [Zerp](https://github.com/zerp-pk/zerp), bu Two doc sets live side by side: -- `docs-user/` — User Docs (served at `/docs`) -- `docs-developer/` — Developer Docs (served at `/developer`) +- `docs-user/` - User Docs (served at `/docs`) +- `docs-developer/` - Developer Docs (served at `/developer`) ## Local development diff --git a/docs-developer/10-getting-started/getting-started.md b/docs-developer/10-getting-started/getting-started.md index 812f319..d73d048 100644 --- a/docs-developer/10-getting-started/getting-started.md +++ b/docs-developer/10-getting-started/getting-started.md @@ -5,7 +5,7 @@ sidebar_position: 2 This is a condensed walkthrough. The [`zerp-pk/zerp` README](https://github.com/zerp-pk/zerp#readme) is the -source of truth — check it if anything here goes stale. +source of truth - check it if anything here goes stale. ## Prerequisites @@ -21,7 +21,7 @@ core app, matching what `composer.json`'s path repositories expect: ``` some-folder/ -├── zerp/ # core app — github.com/zerp-pk/zerp +├── zerp/ # core app - github.com/zerp-pk/zerp └── ZerpPackages/ ├── hrm/ # github.com/zerp-pk/hrm ├── account/ # github.com/zerp-pk/account @@ -30,7 +30,7 @@ some-folder/ ``` The full module → repository table is in the core app's README. You don't -need every module for local development — only clone the ones you're +need every module for local development - only clone the ones you're working on or testing against; `composer install` just won't symlink the ones that are missing. @@ -54,7 +54,7 @@ php artisan storage:link ``` This runs `migrate:fresh` (drops all tables) then prompts for a module -preset — `Full Suite`, `HR Only`, `Sales & CRM`, or a `Custom selection` +preset - `Full Suite`, `HR Only`, `Sales & CRM`, or a `Custom selection` picker (see `config/module-presets.php` in the core app). Every module found under `vendor/zerp/*` still gets registered into the `add_ons` table via `PackageSeeder`, but only the ones you select are enabled and @@ -72,7 +72,7 @@ npm run dev Visit `http://localhost:8000`, log in with the seeded super-admin (`company@example.com` / `1234`). -## Module images are symlinks — know this before you debug them +## Module images are symlinks - know this before you debug them Each module ships its own images (favicon, and for the Landing Page module the hero/gallery/module art). They are **not copied** into `public/`. At module @@ -92,7 +92,7 @@ So a working image URL depends on a two-hop symlink chain. Two consequences: fresh clone inherited symlinks pointing at the original author's home directory, and *every module image 404'd*. If you ever see links like `/home/someone/...` in `public/packages`, your checkout predates the fix. -- **A module you didn't clone leaves a dangling link.** That's harmless — only +- **A module you didn't clone leaves a dangling link.** That's harmless - only that module's images 404. Images not loading? Check for dangling links first, then republish: @@ -112,7 +112,7 @@ re-run. Note it only runs on install, so nothing repairs these automatically. Two related traps: - `php artisan storage:link` covers `public/storage` (uploaded media, served via - `imageUrlPrefix`). That's a **separate** link from the ones above — having one + `imageUrlPrefix`). That's a **separate** link from the ones above - having one working tells you nothing about the other. - **On Windows**, git only materialises real symlinks with Developer Mode or an elevated shell; otherwise it checks them out as small text files containing the @@ -121,7 +121,7 @@ Two related traps: ## Prefer Docker? -`docker compose up -d --build` from the core app repo works the same way — +`docker compose up -d --build` from the core app repo works the same way, see [Docker & CI](../30-guides/docker-and-ci.md). The sibling `ZerpPackages/` checkout is still required either way, since the Docker build context is the **parent** directory of `zerp/`. diff --git a/docs-developer/10-getting-started/introduction.md b/docs-developer/10-getting-started/introduction.md index 5620efc..dad3a8f 100644 --- a/docs-developer/10-getting-started/introduction.md +++ b/docs-developer/10-getting-started/introduction.md @@ -5,7 +5,7 @@ sidebar_position: 1 Zerp is a Laravel 12 + Inertia.js + React (TypeScript) ERP/SaaS platform. The [main app](https://github.com/zerp-pk/zerp) is a thin core (auth, tenancy, -billing, the Media Library, module loader) — almost every business feature +billing, the Media Library, module loader) - almost every business feature (HRM, CRM, Accounting, POS, Support Ticket, ...) ships as a separate, independently versioned Composer package under the [`zerp-pk`](https://github.com/orgs/zerp-pk/repositories) GitHub org. @@ -40,7 +40,7 @@ directory (commonly checked out as `ZerpPackages/` next to `zerp/`): Composer symlinks each package into `vendor/zerp/`. In production, the same `require` line instead resolves against the module's real tagged -release on Packagist/VCS — no path repository needed. +release on Packagist/VCS - no path repository needed. ## Where things live diff --git a/docs-developer/20-architecture/media-library.md b/docs-developer/20-architecture/media-library.md index 89c4bf1..48b2e47 100644 --- a/docs-developer/20-architecture/media-library.md +++ b/docs-developer/20-architecture/media-library.md @@ -3,9 +3,9 @@ title: The Media Library sidebar_position: 4 --- -Every file a business uploads in Zerp — employee documents, contract +Every file a business uploads in Zerp - employee documents, contract attachments, project files, lead/deal files, candidate resumes, support -ticket attachments, avatars — goes through one shared system: the Media +ticket attachments, avatars - goes through one shared system: the Media Library, backed by `App\Services\MediaAttachmentService`. ## Why one shared service @@ -23,26 +23,26 @@ App\Services\MediaAttachmentService::ensureDirectory(...) App\Services\MediaAttachmentService::deleteMedia(...) ``` -- **`upload()`** — stores an `UploadedFile`, creates a `Media` row, links it +- **`upload()`** - stores an `UploadedFile`, creates a `Media` row, links it to a directory/collection/owner. -- **`resolveOrBackfill()`** — idempotent link-or-create: given an existing +- **`resolveOrBackfill()`** - idempotent link-or-create: given an existing path-based reference (from before a table had a `media_id` column), finds or creates the matching `Media` row without duplicating it on repeat runs. Used by the backfill command below. -- **`ensureDirectory()`** — gets-or-creates a `MediaDirectory` (e.g. one +- **`ensureDirectory()`** - gets-or-creates a `MediaDirectory` (e.g. one per module/collection) to keep the library organized. -- **`deleteMedia()`** — deletes both the `Media` row and the underlying +- **`deleteMedia()`** - deletes both the `Media` row and the underlying file. ## Storage layout is deliberately flat -Files are stored flat — `media/{file_name}`, occasionally with one extra -subpath segment (e.g. `employee_documents/xxx.pdf`) — rather than using +Files are stored flat - `media/{file_name}`, occasionally with one extra +subpath segment (e.g. `employee_documents/xxx.pdf`) - rather than using Spatie Media Library's default per-model/per-collection nested directory structure. This is intentional: 35+ `MediaPicker` frontend consumers across every module reconstruct file URLs assuming this flat shape. Spatie's real `addMedia()` pipeline and conversions, and the registered `MediaPathGenerator` -class, exist in the dependency tree but are **not used** — don't wire a new +class, exist in the dependency tree but are **not used** - don't wire a new feature directly against Spatie's native API, go through `MediaAttachmentService` instead so URL construction stays consistent. @@ -55,7 +55,7 @@ paths) instead of a `media_id` foreign key: 2. Wire the controller's store/update/destroy to call `MediaAttachmentService::upload()` / `deleteMedia()`. 3. Backfill existing rows with `php artisan media:backfill ` (see - `app/Console/Commands/BackfillMediaAttachments.php`) — it's idempotent + `app/Console/Commands/BackfillMediaAttachments.php`) - it's idempotent and supports `--dry-run`, and has a declarative `sources()` map you add an entry to (path-column sources) or `jsonArraySources()` (for a column storing a JSON array of paths, e.g. support-ticket attachments). @@ -64,7 +64,7 @@ paths) instead of a `media_id` foreign key: At least one pre-existing module (support-ticket) casts an `attachments` column as `'array'` in Eloquent but its controllers were calling -`json_encode()` on the value before passing it to `create()`/`update()` — +`json_encode()` on the value before passing it to `create()`/`update()`, double-encoding it. If you add code that reads that column back through the model's cast accessor, check for this rather than assuming the column is clean JSON; linking through `MediaAttachmentService` from the pre-encode diff --git a/docs-developer/20-architecture/module-development.md b/docs-developer/20-architecture/module-development.md index 28a02b0..017818a 100644 --- a/docs-developer/20-architecture/module-development.md +++ b/docs-developer/20-architecture/module-development.md @@ -22,7 +22,7 @@ ZerpPackages/product-service/ └── ... ``` -`composer.json` — standard Composer package metadata, PSR-4 autoload, and a +`composer.json` - standard Composer package metadata, PSR-4 autoload, and a Laravel `extra.laravel.providers` entry so the core app auto-discovers the service provider: @@ -41,7 +41,7 @@ service provider: } ``` -`module.json` — metadata the core app reads at seed/runtime (not a Laravel +`module.json` - metadata the core app reads at seed/runtime (not a Laravel convention, a Zerp-specific file `App\Classes\Module` and `PackageSeeder` look for): @@ -64,7 +64,7 @@ look for): the legacy in-repo `packages/local/*` path) for a `module.json` in each directory, and for every one it finds: -1. Creates an `AddOn` row (module, price, priority) if one doesn't exist — +1. Creates an `AddOn` row (module, price, priority) if one doesn't exist, `is_enable` is set based on whether the module was selected during `app:install` (see below); every discovered module gets a row either way, enabled or not. @@ -74,12 +74,12 @@ directory, and for every one it finds: This runs automatically as part of `php artisan app:install`, which prompts for which modules to enable (a preset bundle or a custom -selection) — see [Getting Started](../10-getting-started/getting-started.md). +selection) - see [Getting Started](../10-getting-started/getting-started.md). ## Cross-module integration: events, not direct calls Modules never call into each other directly. The core app fires domain -events (`app/Events/*.php` — `CreatePurchaseInvoice`, `CreateSalesInvoice`, +events (`app/Events/*.php` - `CreatePurchaseInvoice`, `CreateSalesInvoice`, `CreateUser`, `CreateWarehouse`, etc.) and modules that care register a listener via their own `EventServiceProvider`: @@ -105,7 +105,7 @@ class PostPurchaseInvoiceListener This is how `product-service` adjusts warehouse stock when an invoice is posted, how `calendar`/`slack`/`telegram` react to the same invoice events -to create calendar entries or send notifications, and so on — check +to create calendar entries or send notifications, and so on - check `app/Events/` in the core app for the full list of events you can listen for before adding a new one. @@ -117,7 +117,7 @@ for roles/permissions, plus a plan/module-enable layer on top: - `AddOn` + `UserActiveModule` (seeded by `PackageSeeder`, see above) determine whether a module is enabled for a given company at all. - `App\Classes\Module::isEnabled($name)` / `allEnabled()` check this at - runtime — gate any module-specific route/controller/view behind it if the + runtime - gate any module-specific route/controller/view behind it if the module can be toggled off. - Regular Spatie roles/permissions (`client`, `staff`, custom roles) then control what an individual *user* can do within an enabled module. @@ -126,7 +126,7 @@ for roles/permissions, plus a plan/module-enable layer on top: Once a module works locally against its path repository, cut a tagged release so the core app (and anyone else) can depend on a real version -instead of a local symlink — see +instead of a local symlink - see [Publishing a Module Package](../30-guides/publishing-a-package.md). Every class in every module is catalogued in the diff --git a/docs-developer/30-guides/contributing.md b/docs-developer/30-guides/contributing.md index 49015bf..b2e49ef 100644 --- a/docs-developer/30-guides/contributing.md +++ b/docs-developer/30-guides/contributing.md @@ -3,13 +3,13 @@ title: Contributing sidebar_position: 7 --- -Zerp is a multi-repo project — the core app and each module are separate +Zerp is a multi-repo project - the core app and each module are separate repositories under [zerp-pk](https://github.com/orgs/zerp-pk/repositories). Full contribution guidelines, including which repo a given change belongs in, live in the core app: - [CONTRIBUTING.md](https://github.com/zerp-pk/zerp/blob/main/CONTRIBUTING.md) -- [SECURITY.md](https://github.com/zerp-pk/zerp/blob/main/SECURITY.md) — how to report a vulnerability +- [SECURITY.md](https://github.com/zerp-pk/zerp/blob/main/SECURITY.md) - how to report a vulnerability - [CODE_OF_CONDUCT.md](https://github.com/zerp-pk/zerp/blob/main/CODE_OF_CONDUCT.md) Quick pointers specific to working on the codebase: @@ -23,5 +23,5 @@ Quick pointers specific to working on the codebase: changing how modules integrate. This docs site itself ([zerp-pk/docs](https://github.com/zerp-pk/docs)) is -also open to PRs — fixes to unclear wording, missing steps, or outdated +also open to PRs - fixes to unclear wording, missing steps, or outdated screenshots are always welcome. diff --git a/docs-developer/30-guides/docker-and-ci.md b/docs-developer/30-guides/docker-and-ci.md index cdf9bf5..9a37ea5 100644 --- a/docs-developer/30-guides/docker-and-ci.md +++ b/docs-developer/30-guides/docker-and-ci.md @@ -19,14 +19,14 @@ build: ``` This is required because `vendor/zerp/*` is a set of symlinks pointing at -the sibling `ZerpPackages/` directories — if the build context were +the sibling `ZerpPackages/` directories - if the build context were just `zerp/`, those directories wouldn't be visible to Docker at all and every module symlink would point at nothing. Every build stage that runs `composer install` or otherwise touches `vendor/zerp/*` also does `COPY ZerpPackages /ZerpPackages` first. `docker-compose.yml` runs three services: `app` (the built image, port -`8000:80`), `db` (`mysql:8`), `redis` (`redis:7`) — `.env`'s `DB_HOST`/ +`8000:80`), `db` (`mysql:8`), `redis` (`redis:7`) - `.env`'s `DB_HOST`/ `REDIS_HOST` are overridden to the service names (`db`/`redis`) so the app container can reach them. @@ -46,7 +46,7 @@ to choose modules non-interactively instead. `.github/workflows/ci.yml` runs on every push/PR to `main`. It's deliberately narrow: `composer validate`, a PHP lint pass over `app/`, and -an `npm run build` of the **core app only** — it does not run +an `npm run build` of the **core app only** - it does not run `composer install`, PHPUnit, or anything that needs a module package present. @@ -58,8 +58,8 @@ locally (see [Getting Started](../10-getting-started/getting-started.md)). Two smaller things worth knowing if you touch the workflow: -- No `cache: "npm"` on `actions/setup-node` — that requires a committed +- No `cache: "npm"` on `actions/setup-node` - that requires a committed `package-lock.json`, which this repo doesn't commit. -- `npm install`, not `npm ci` — same reason, `npm ci` requires an existing +- `npm install`, not `npm ci` - same reason, `npm ci` requires an existing lock file. diff --git a/docs-developer/30-guides/publishing-a-package.md b/docs-developer/30-guides/publishing-a-package.md index f99f80a..fae10b3 100644 --- a/docs-developer/30-guides/publishing-a-package.md +++ b/docs-developer/30-guides/publishing-a-package.md @@ -9,7 +9,7 @@ other installs can depend on a real version. ## Version tags are immutable **Never re-tag a version that's already been published.** If `v1.0.1` is -already out and you need to fix something in it, cut `v1.0.2` — don't +already out and you need to fix something in it, cut `v1.0.2` - don't force-push over the existing tag. Anyone who already resolved `v1.0.1` (a lockfile, a deployed environment) would silently get different code under the same version number, which is exactly the class of bug semantic @@ -26,7 +26,7 @@ git push origin v1.0.2 are correct and `module.json` metadata (`name`, `alias`, `package_name`, pricing) matches what you want the core app to seed. 2. Commit and push to the module's own repo (`zerp-pk/`). -3. Tag a new version (patch/minor/major per semver — a bug fix is a patch, +3. Tag a new version (patch/minor/major per semver - a bug fix is a patch, a new feature is a minor, a breaking change to the module's public API/events is a major). 4. If the core app's `composer.json` should track the new version instead diff --git a/docs-developer/50-reference/account.md b/docs-developer/50-reference/account.md index 827a49b..0bac589 100644 --- a/docs-developer/50-reference/account.md +++ b/docs-developer/50-reference/account.md @@ -15,181 +15,181 @@ Accounting module for the Zerp ERP platform ### `AccountCategory` -Eloquent model — 7 fillable fields, relations: accountTypes. +Eloquent model - 7 fillable fields, relations: accountTypes. ### `AccountType` -Eloquent model — 10 fillable fields, relations: category, chartOfAccounts. +Eloquent model - 10 fillable fields, relations: category, chartOfAccounts. ### `BankAccount` -Eloquent model — 15 fillable fields, relations: glAccount, gl_account. +Eloquent model - 15 fillable fields, relations: glAccount, gl_account. ### `BankTransaction` -Eloquent model — 11 fillable fields, relations: bankAccount, creator. +Eloquent model - 11 fillable fields, relations: bankAccount, creator. ### `BankTransfer` -Eloquent model — 12 fillable fields, relations: fromAccount, toAccount, journalEntry, creator. +Eloquent model - 12 fillable fields, relations: fromAccount, toAccount, journalEntry, creator. ### `ChartOfAccount` -Eloquent model — 13 fillable fields, relations: accountType, account_type, parent_account, journalEntryItems. +Eloquent model - 13 fillable fields, relations: accountType, account_type, parent_account, journalEntryItems. ### `CreditNote` -Eloquent model — 17 fillable fields, relations: items, customer, invoice, salesReturn, approvedBy, applications. +Eloquent model - 17 fillable fields, relations: items, customer, invoice, salesReturn, approvedBy, applications. ### `CreditNoteApplication` -Eloquent model — 6 fillable fields, relations: creditNote, payment. +Eloquent model - 6 fillable fields, relations: creditNote, payment. ### `CreditNoteItem` -Eloquent model — 9 fillable fields, relations: creditNote, product, taxes. +Eloquent model - 9 fillable fields, relations: creditNote, product, taxes. ### `CreditNoteItemTax` -Eloquent model — 3 fillable fields, relations: item. +Eloquent model - 3 fillable fields, relations: item. ### `Customer` -Eloquent model — 14 fillable fields, relations: user. +Eloquent model - 14 fillable fields, relations: user. ### `CustomerPayment` -Eloquent model — 10 fillable fields, relations: customer, bankAccount, allocations, creditNoteApplications. +Eloquent model - 10 fillable fields, relations: customer, bankAccount, allocations, creditNoteApplications. ### `CustomerPaymentAllocation` -Eloquent model — 5 fillable fields, relations: payment, invoice. +Eloquent model - 5 fillable fields, relations: payment, invoice. ### `DebitNote` -Eloquent model — 17 fillable fields, relations: items, vendor, invoice, purchaseReturn, approvedBy, applications. +Eloquent model - 17 fillable fields, relations: items, vendor, invoice, purchaseReturn, approvedBy, applications. ### `DebitNoteApplication` -Eloquent model — 6 fillable fields, relations: debitNote, payment. +Eloquent model - 6 fillable fields, relations: debitNote, payment. ### `DebitNoteItem` -Eloquent model — 11 fillable fields, relations: debitNote, product, taxes. +Eloquent model - 11 fillable fields, relations: debitNote, product, taxes. ### `DebitNoteItemTax` -Eloquent model — 3 fillable fields, relations: item. +Eloquent model - 3 fillable fields, relations: item. ### `Expense` -Eloquent model — 12 fillable fields, relations: category, bankAccount, chartOfAccount, approvedBy. +Eloquent model - 12 fillable fields, relations: category, bankAccount, chartOfAccount, approvedBy. ### `ExpenseCategories` -Eloquent model — 7 fillable fields, relations: gl_account. +Eloquent model - 7 fillable fields, relations: gl_account. ### `JournalEntry` -Eloquent model — 11 fillable fields, relations: items. +Eloquent model - 11 fillable fields, relations: items. ### `JournalEntryItem` -Eloquent model — 7 fillable fields, relations: journalEntry, account. +Eloquent model - 7 fillable fields, relations: journalEntry, account. ### `OpeningBalance` -Eloquent model — 7 fillable fields, relations: account. +Eloquent model - 7 fillable fields, relations: account. ### `Revenue` -Eloquent model — 12 fillable fields, relations: category, bankAccount, chartOfAccount, approvedBy. +Eloquent model - 12 fillable fields, relations: category, bankAccount, chartOfAccount, approvedBy. ### `RevenueCategories` -Eloquent model — 7 fillable fields, relations: gl_account. +Eloquent model - 7 fillable fields, relations: gl_account. ### `Vendor` -Eloquent model — 19 fillable fields, relations: user. +Eloquent model - 19 fillable fields, relations: user. ### `VendorPayment` -Eloquent model — 10 fillable fields, relations: vendor, bankAccount, allocations, debitNoteApplications. +Eloquent model - 10 fillable fields, relations: vendor, bankAccount, allocations, debitNoteApplications. ### `VendorPaymentAllocation` -Eloquent model — 3 fillable fields, relations: payment, invoice. +Eloquent model - 3 fillable fields, relations: payment, invoice. ## Controllers ### `AccountTypeController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `BankAccountController` -HTTP controller — actions: index, store, update, destroy, bankAccounts. +HTTP controller - actions: index, store, update, destroy, bankAccounts. ### `BankTransactionController` -HTTP controller — actions: index, markReconciled. +HTTP controller - actions: index, markReconciled. ### `BankTransferController` -HTTP controller — actions: index, store, update, destroy, process. +HTTP controller - actions: index, store, update, destroy, process. ### `ChartOfAccountController` -HTTP controller — actions: index, store, update, show, destroy. +HTTP controller - actions: index, store, update, show, destroy. ### `CreditNoteController` -HTTP controller — actions: index, show, approve, destroy. +HTTP controller - actions: index, show, approve, destroy. ### `CustomerController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `CustomerPaymentController` -HTTP controller — actions: index, store, getOutstandingInvoices, updateStatus, destroy. +HTTP controller - actions: index, store, getOutstandingInvoices, updateStatus, destroy. ### `DashboardController` -HTTP controller — actions: index. +HTTP controller - actions: index. ### `DebitNoteController` -HTTP controller — actions: index, show, approve, destroy. +HTTP controller - actions: index, show, approve, destroy. ### `ExpenseCategoriesController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `ExpenseController` -HTTP controller — actions: index, store, update, destroy, approve, post. +HTTP controller - actions: index, store, update, destroy, approve, post. ### `ReportsController` -HTTP controller — actions: index, invoiceAging, billAging, taxSummary, customerBalance, vendorBalance, printInvoiceAging, printBillAging, printTaxSummary, printCustomerBalance, printVendorBalance, customerDetail, vendorDetail, printCustomerDetail, printVendorDetail. +HTTP controller - actions: index, invoiceAging, billAging, taxSummary, customerBalance, vendorBalance, printInvoiceAging, printBillAging, printTaxSummary, printCustomerBalance, printVendorBalance, customerDetail, vendorDetail, printCustomerDetail, printVendorDetail. ### `RevenueCategoriesController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `RevenueController` -HTTP controller — actions: index, store, update, destroy, approve, post. +HTTP controller - actions: index, store, update, destroy, approve, post. ### `VendorController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `VendorPaymentController` -HTTP controller — actions: index, store, getOutstandingInvoices, updateStatus, destroy. +HTTP controller - actions: index, store, getOutstandingInvoices, updateStatus, destroy. ## Events @@ -467,91 +467,91 @@ Event listener. ### `StoreAccountTypeRequest` -Form request — validation rules for StoreAccountType. +Form request - validation rules for StoreAccountType. ### `StoreBankAccountRequest` -Form request — validation rules for StoreBankAccount. +Form request - validation rules for StoreBankAccount. ### `StoreBankTransferRequest` -Form request — validation rules for StoreBankTransfer. +Form request - validation rules for StoreBankTransfer. ### `StoreChartOfAccountRequest` -Form request — validation rules for StoreChartOfAccount. +Form request - validation rules for StoreChartOfAccount. ### `StoreCustomerPaymentRequest` -Form request — validation rules for StoreCustomerPayment. +Form request - validation rules for StoreCustomerPayment. ### `StoreCustomerRequest` -Form request — validation rules for StoreCustomer. +Form request - validation rules for StoreCustomer. ### `StoreExpenseCategoriesRequest` -Form request — validation rules for StoreExpenseCategories. +Form request - validation rules for StoreExpenseCategories. ### `StoreExpenseRequest` -Form request — validation rules for StoreExpense. +Form request - validation rules for StoreExpense. ### `StoreRevenueCategoriesRequest` -Form request — validation rules for StoreRevenueCategories. +Form request - validation rules for StoreRevenueCategories. ### `StoreRevenueRequest` -Form request — validation rules for StoreRevenue. +Form request - validation rules for StoreRevenue. ### `StoreVendorPaymentRequest` -Form request — validation rules for StoreVendorPayment. +Form request - validation rules for StoreVendorPayment. ### `StoreVendorRequest` -Form request — validation rules for StoreVendor. +Form request - validation rules for StoreVendor. ### `UpdateAccountTypeRequest` -Form request — validation rules for UpdateAccountType. +Form request - validation rules for UpdateAccountType. ### `UpdateBankAccountRequest` -Form request — validation rules for UpdateBankAccount. +Form request - validation rules for UpdateBankAccount. ### `UpdateBankTransferRequest` -Form request — validation rules for UpdateBankTransfer. +Form request - validation rules for UpdateBankTransfer. ### `UpdateChartOfAccountRequest` -Form request — validation rules for UpdateChartOfAccount. +Form request - validation rules for UpdateChartOfAccount. ### `UpdateCustomerRequest` -Form request — validation rules for UpdateCustomer. +Form request - validation rules for UpdateCustomer. ### `UpdateExpenseCategoriesRequest` -Form request — validation rules for UpdateExpenseCategories. +Form request - validation rules for UpdateExpenseCategories. ### `UpdateExpenseRequest` -Form request — validation rules for UpdateExpense. +Form request - validation rules for UpdateExpense. ### `UpdateRevenueCategoriesRequest` -Form request — validation rules for UpdateRevenueCategories. +Form request - validation rules for UpdateRevenueCategories. ### `UpdateRevenueRequest` -Form request — validation rules for UpdateRevenue. +Form request - validation rules for UpdateRevenue. ### `UpdateVendorRequest` -Form request — validation rules for UpdateVendor. +Form request - validation rules for UpdateVendor. ## Providers diff --git a/docs-developer/50-reference/aiassistant.md b/docs-developer/50-reference/aiassistant.md index f569e1b..8f120e1 100644 --- a/docs-developer/50-reference/aiassistant.md +++ b/docs-developer/50-reference/aiassistant.md @@ -15,17 +15,17 @@ AI-powered assistant module for the Zerp ERP platform ### `AIPrompt` -Eloquent model — 6 fillable fields. +Eloquent model - 6 fillable fields. ## Controllers ### `AIAssistantSettingsController` -HTTP controller — actions: index, store. +HTTP controller - actions: index, store. ### `AIGeneratorController` -HTTP controller — actions: generate. +HTTP controller - actions: generate. ## Providers diff --git a/docs-developer/50-reference/budget-planner.md b/docs-developer/50-reference/budget-planner.md index 53308c4..0203d5a 100644 --- a/docs-developer/50-reference/budget-planner.md +++ b/docs-developer/50-reference/budget-planner.md @@ -15,37 +15,37 @@ Budget planning module for the Zerp ERP platform ### `Budget` -Eloquent model — 8 fillable fields, relations: budgetPeriod, approvedBy, allocations. +Eloquent model - 8 fillable fields, relations: budgetPeriod, approvedBy, allocations. ### `BudgetAllocation` -Eloquent model — 7 fillable fields, relations: budget, account. +Eloquent model - 7 fillable fields, relations: budget, account. ### `BudgetMonitoring` -Eloquent model — 9 fillable fields, relations: budget. +Eloquent model - 9 fillable fields, relations: budget. ### `BudgetPeriod` -Eloquent model — 8 fillable fields, relations: approvedBy, budgets. +Eloquent model - 8 fillable fields, relations: approvedBy, budgets. ## Controllers ### `BudgetAllocationController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `BudgetController` -HTTP controller — actions: index, store, update, approve, active, close, destroy. +HTTP controller - actions: index, store, update, approve, active, close, destroy. ### `BudgetMonitoringController` -HTTP controller — actions: index. +HTTP controller - actions: index. ### `BudgetPeriodController` -HTTP controller — actions: index, store, update, approve, active, close, destroy. +HTTP controller - actions: index, store, update, approve, active, close, destroy. ## Events @@ -119,27 +119,27 @@ Event listener. ### `StoreBudgetAllocationRequest` -Form request — validation rules for StoreBudgetAllocation. +Form request - validation rules for StoreBudgetAllocation. ### `StoreBudgetPeriodRequest` -Form request — validation rules for StoreBudgetPeriod. +Form request - validation rules for StoreBudgetPeriod. ### `StoreBudgetRequest` -Form request — validation rules for StoreBudget. +Form request - validation rules for StoreBudget. ### `UpdateBudgetAllocationRequest` -Form request — validation rules for UpdateBudgetAllocation. +Form request - validation rules for UpdateBudgetAllocation. ### `UpdateBudgetPeriodRequest` -Form request — validation rules for UpdateBudgetPeriod. +Form request - validation rules for UpdateBudgetPeriod. ### `UpdateBudgetRequest` -Form request — validation rules for UpdateBudget. +Form request - validation rules for UpdateBudget. ## Providers diff --git a/docs-developer/50-reference/calendar.md b/docs-developer/50-reference/calendar.md index 0cc3ff6..d11ee4c 100644 --- a/docs-developer/50-reference/calendar.md +++ b/docs-developer/50-reference/calendar.md @@ -15,21 +15,21 @@ Calendar and scheduling module for the Zerp ERP platform ### `CalenderUtility` -Eloquent model — 0 fillable fields. +Eloquent model - 0 fillable fields. ### `GoogleCalendarSetting` -Eloquent model — 3 fillable fields. +Eloquent model - 3 fillable fields. ## Controllers ### `CalendarController` -HTTP controller — actions: index. +HTTP controller - actions: index. ### `CalendarSettingsController` -HTTP controller — actions: index, store. +HTTP controller - actions: index, store. ## Listeners diff --git a/docs-developer/50-reference/contract.md b/docs-developer/50-reference/contract.md index 56cb7dc..ea645e8 100644 --- a/docs-developer/50-reference/contract.md +++ b/docs-developer/50-reference/contract.md @@ -15,69 +15,69 @@ Contract management module for the Zerp ERP platform ### `Contract` -Eloquent model — 13 fillable fields, relations: user, contractType, attachments, comments, notes, renewals, signatures. +Eloquent model - 13 fillable fields, relations: user, contractType, attachments, comments, notes, renewals, signatures. ### `ContractAttachment` -Eloquent model — 7 fillable fields, relations: contract, uploader, media. +Eloquent model - 7 fillable fields, relations: contract, uploader, media. ### `ContractComment` -Eloquent model — 6 fillable fields, relations: contract, user. +Eloquent model - 6 fillable fields, relations: contract, user. ### `ContractNote` -Eloquent model — 6 fillable fields, relations: contract, user. +Eloquent model - 6 fillable fields, relations: contract, user. ### `ContractRenewal` -Eloquent model — 8 fillable fields, relations: contract, creator. +Eloquent model - 8 fillable fields, relations: contract, creator. ### `ContractSignature` -Eloquent model — 7 fillable fields, relations: contract, user, creator. +Eloquent model - 7 fillable fields, relations: contract, user, creator. ### `ContractType` -Eloquent model — 4 fillable fields, relations: contracts. +Eloquent model - 4 fillable fields, relations: contracts. ### `ContractUtility` -Eloquent model — 0 fillable fields. +Eloquent model - 0 fillable fields. ## Controllers ### `ContractAttachmentController` -HTTP controller — actions: store, destroy. +HTTP controller - actions: store, destroy. ### `ContractCommentController` -HTTP controller — actions: store, update, destroy. +HTTP controller - actions: store, update, destroy. ### `ContractController` -HTTP controller — actions: index, store, update, updateStatus, destroy, show, preview, duplicate. +HTTP controller - actions: index, store, update, updateStatus, destroy, show, preview, duplicate. ### `ContractNoteController` -HTTP controller — actions: store, update, destroy. +HTTP controller - actions: store, update, destroy. ### `ContractRenewalController` -HTTP controller — actions: store, update, destroy. +HTTP controller - actions: store, update, destroy. ### `ContractSettingsController` -HTTP controller — actions: store. +HTTP controller - actions: store. ### `ContractSignatureController` -HTTP controller — actions: store. +HTTP controller - actions: store. ### `ContractTypeController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ## Events @@ -111,35 +111,35 @@ Event listener. ### `DuplicateContractRequest` -Form request — validation rules for DuplicateContract. +Form request - validation rules for DuplicateContract. ### `StoreContractRenewalRequest` -Form request — validation rules for StoreContractRenewal. +Form request - validation rules for StoreContractRenewal. ### `StoreContractRequest` -Form request — validation rules for StoreContract. +Form request - validation rules for StoreContract. ### `StoreContractSignatureRequest` -Form request — validation rules for StoreContractSignature. +Form request - validation rules for StoreContractSignature. ### `StoreContractTypeRequest` -Form request — validation rules for StoreContractType. +Form request - validation rules for StoreContractType. ### `UpdateContractRenewalRequest` -Form request — validation rules for UpdateContractRenewal. +Form request - validation rules for UpdateContractRenewal. ### `UpdateContractRequest` -Form request — validation rules for UpdateContract. +Form request - validation rules for UpdateContract. ### `UpdateContractTypeRequest` -Form request — validation rules for UpdateContractType. +Form request - validation rules for UpdateContractType. ## Providers diff --git a/docs-developer/50-reference/double-entry.md b/docs-developer/50-reference/double-entry.md index d7056ab..d102e13 100644 --- a/docs-developer/50-reference/double-entry.md +++ b/docs-developer/50-reference/double-entry.md @@ -15,41 +15,41 @@ Double-entry bookkeeping module for the Zerp ERP platform ### `BalanceSheet` -Eloquent model — 9 fillable fields, relations: items, notes. +Eloquent model - 9 fillable fields, relations: items, notes. ### `BalanceSheetItem` -Eloquent model — 7 fillable fields, relations: balanceSheet, account. +Eloquent model - 7 fillable fields, relations: balanceSheet, account. ### `BalanceSheetNote` -Eloquent model — 6 fillable fields, relations: balanceSheet. +Eloquent model - 6 fillable fields, relations: balanceSheet. ### `ComparativeBalanceSheet` -Eloquent model — 5 fillable fields, relations: currentPeriod, previousPeriod. +Eloquent model - 5 fillable fields, relations: currentPeriod, previousPeriod. ## Controllers ### `BalanceSheetController` -HTTP controller — actions: index, list, store, show, finalize, destroy, addNote, deleteNote, compare, comparisons, showComparison, yearEndClose, print, comparisonPrint. +HTTP controller - actions: index, list, store, show, finalize, destroy, addNote, deleteNote, compare, comparisons, showComparison, yearEndClose, print, comparisonPrint. ### `LedgerSummaryController` -HTTP controller — actions: index, print. +HTTP controller - actions: index, print. ### `ProfitLossController` -HTTP controller — actions: index, print. +HTTP controller - actions: index, print. ### `ReportController` -HTTP controller — actions: index, generalLedger, printGeneralLedger, accountStatement, printAccountStatement, journalEntry, printJournalEntry, accountBalance, printAccountBalance, cashFlow, printCashFlow, expenseReport, printExpenseReport. +HTTP controller - actions: index, generalLedger, printGeneralLedger, accountStatement, printAccountStatement, journalEntry, printJournalEntry, accountBalance, printAccountBalance, cashFlow, printCashFlow, expenseReport, printExpenseReport. ### `TrialBalanceController` -HTTP controller — actions: index, print. +HTTP controller - actions: index, print. ## Events @@ -81,19 +81,19 @@ Domain event. ### `CompareBalanceSheetRequest` -Form request — validation rules for CompareBalanceSheet. +Form request - validation rules for CompareBalanceSheet. ### `StoreBalanceSheetNoteRequest` -Form request — validation rules for StoreBalanceSheetNote. +Form request - validation rules for StoreBalanceSheetNote. ### `StoreBalanceSheetRequest` -Form request — validation rules for StoreBalanceSheet. +Form request - validation rules for StoreBalanceSheet. ### `YearEndCloseRequest` -Form request — validation rules for YearEndClose. +Form request - validation rules for YearEndClose. ## Providers diff --git a/docs-developer/50-reference/form-builder.md b/docs-developer/50-reference/form-builder.md index 2e9f471..8e086fa 100644 --- a/docs-developer/50-reference/form-builder.md +++ b/docs-developer/50-reference/form-builder.md @@ -15,33 +15,33 @@ Custom form builder module for the Zerp ERP platform ### `Form` -Eloquent model — 7 fillable fields, relations: fields, responses, conversion. +Eloquent model - 7 fillable fields, relations: fields, responses, conversion. ### `FormBuilderUtility` -Eloquent model — 0 fillable fields. +Eloquent model - 0 fillable fields. ### `FormConversion` -Eloquent model — 7 fillable fields, relations: form. +Eloquent model - 7 fillable fields, relations: form. ### `FormField` -Eloquent model — 9 fillable fields, relations: form. +Eloquent model - 9 fillable fields, relations: form. ### `FormResponse` -Eloquent model — 4 fillable fields, relations: form. +Eloquent model - 4 fillable fields, relations: form. ## Controllers ### `FormController` -HTTP controller — actions: index, create, store, update, destroy, edit, responses, destroyResponse, updateFields, destroyField, updateConversion, getConversionData, conversion. +HTTP controller - actions: index, create, store, update, destroy, edit, responses, destroyResponse, updateFields, destroyField, updateConversion, getConversionData, conversion. ### `PublicFormController` -HTTP controller — actions: show, submit. +HTTP controller - actions: show, submit. ## Events @@ -75,19 +75,19 @@ Event listener. ### `FormFieldRequest` -Form request — validation rules for FormField. +Form request - validation rules for FormField. ### `StoreFormConversionRequest` -Form request — validation rules for StoreFormConversion. +Form request - validation rules for StoreFormConversion. ### `StoreFormRequest` -Form request — validation rules for StoreForm. +Form request - validation rules for StoreForm. ### `UpdateFormRequest` -Form request — validation rules for UpdateForm. +Form request - validation rules for UpdateForm. ## Providers diff --git a/docs-developer/50-reference/goal.md b/docs-developer/50-reference/goal.md index caafbef..caa3dc1 100644 --- a/docs-developer/50-reference/goal.md +++ b/docs-developer/50-reference/goal.md @@ -15,45 +15,45 @@ Financial goal tracking module for the Zerp ERP platform ### `Goal` -Eloquent model — 13 fillable fields, relations: category, account, milestones, contributions, tracking. +Eloquent model - 13 fillable fields, relations: category, account, milestones, contributions, tracking. ### `GoalCategory` -Eloquent model — 6 fillable fields, relations: goals. +Eloquent model - 6 fillable fields, relations: goals. ### `GoalContribution` -Eloquent model — 9 fillable fields, relations: goal. +Eloquent model - 9 fillable fields, relations: goal. ### `GoalMilestone` -Eloquent model — 10 fillable fields, relations: goal. +Eloquent model - 10 fillable fields, relations: goal. ### `GoalTracking` -Eloquent model — 11 fillable fields, relations: goal. +Eloquent model - 11 fillable fields, relations: goal. ## Controllers ### `GoalCategoryController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `GoalContributionController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `GoalController` -HTTP controller — actions: index, store, update, show, active, destroy. +HTTP controller - actions: index, store, update, show, active, destroy. ### `GoalMilestoneController` -HTTP controller — actions: index, store, update, show, destroy. +HTTP controller - actions: index, store, update, show, destroy. ### `GoalTrackingController` -HTTP controller — actions: index, store, update, show, destroy. +HTTP controller - actions: index, store, update, show, destroy. ## Events @@ -127,43 +127,43 @@ Event listener. ### `StoreCategoryRequest` -Form request — validation rules for StoreCategory. +Form request - validation rules for StoreCategory. ### `StoreContributionRequest` -Form request — validation rules for StoreContribution. +Form request - validation rules for StoreContribution. ### `StoreGoalRequest` -Form request — validation rules for StoreGoal. +Form request - validation rules for StoreGoal. ### `StoreMilestoneRequest` -Form request — validation rules for StoreMilestone. +Form request - validation rules for StoreMilestone. ### `StoreTrackingRequest` -Form request — validation rules for StoreTracking. +Form request - validation rules for StoreTracking. ### `UpdateCategoryRequest` -Form request — validation rules for UpdateCategory. +Form request - validation rules for UpdateCategory. ### `UpdateContributionRequest` -Form request — validation rules for UpdateContribution. +Form request - validation rules for UpdateContribution. ### `UpdateGoalRequest` -Form request — validation rules for UpdateGoal. +Form request - validation rules for UpdateGoal. ### `UpdateMilestoneRequest` -Form request — validation rules for UpdateMilestone. +Form request - validation rules for UpdateMilestone. ### `UpdateTrackingRequest` -Form request — validation rules for UpdateTracking. +Form request - validation rules for UpdateTracking. ## Providers diff --git a/docs-developer/50-reference/google-captcha.md b/docs-developer/50-reference/google-captcha.md index acce276..6602a1c 100644 --- a/docs-developer/50-reference/google-captcha.md +++ b/docs-developer/50-reference/google-captcha.md @@ -15,7 +15,7 @@ Google reCAPTCHA (v2/v3) module for the Zerp ERP platform ### `GoogleCaptchaSettingsController` -HTTP controller — actions: update. +HTTP controller - actions: update. ## Providers diff --git a/docs-developer/50-reference/google-meet.md b/docs-developer/50-reference/google-meet.md index 410d9c4..e8b46ae 100644 --- a/docs-developer/50-reference/google-meet.md +++ b/docs-developer/50-reference/google-meet.md @@ -15,17 +15,17 @@ Google Meet integration module for the Zerp ERP platform ### `GoogleMeeting` -Eloquent model — 12 fillable fields, relations: host. +Eloquent model - 12 fillable fields, relations: host. ## Controllers ### `GoogleMeetController` -HTTP controller — actions: index, store, update, destroy, updateStatus. +HTTP controller - actions: index, store, update, destroy, updateStatus. ### `GoogleMeetSettingsController` -HTTP controller — actions: update. +HTTP controller - actions: update. ## Events @@ -51,11 +51,11 @@ Event listener. ### `StoreGoogleMeetingRequest` -Form request — validation rules for StoreGoogleMeeting. +Form request - validation rules for StoreGoogleMeeting. ### `UpdateGoogleMeetingRequest` -Form request — validation rules for UpdateGoogleMeeting. +Form request - validation rules for UpdateGoogleMeeting. ## Providers diff --git a/docs-developer/50-reference/hrm.md b/docs-developer/50-reference/hrm.md index 4afe202..c4513af 100644 --- a/docs-developer/50-reference/hrm.md +++ b/docs-developer/50-reference/hrm.md @@ -15,367 +15,367 @@ Human Resource Management module for the Zerp ERP platform ### `Acknowledgment` -Eloquent model — 11 fillable fields, relations: employee, document, assignedBy. +Eloquent model - 11 fillable fields, relations: employee, document, assignedBy. ### `Allowance` -Eloquent model — 6 fillable fields, relations: employee, user, allowanceType. +Eloquent model - 6 fillable fields, relations: employee, user, allowanceType. ### `AllowanceType` -Eloquent model — 4 fillable fields. +Eloquent model - 4 fillable fields. ### `Announcement` -Eloquent model — 10 fillable fields, relations: announcementCategory, departments, approvedBy. +Eloquent model - 10 fillable fields, relations: announcementCategory, departments, approvedBy. ### `AnnouncementCategory` -Eloquent model — 3 fillable fields. +Eloquent model - 3 fillable fields. ### `AnnouncementDepartment` -Eloquent model — 4 fillable fields, relations: announcement, department, creator, createdBy. +Eloquent model - 4 fillable fields, relations: announcement, department, creator, createdBy. ### `Attendance` -Eloquent model — 13 fillable fields, relations: user, shift. +Eloquent model - 13 fillable fields, relations: user, shift. ### `Award` -Eloquent model — 7 fillable fields, relations: awardType, employee. +Eloquent model - 7 fillable fields, relations: awardType, employee. ### `AwardType` -Eloquent model — 4 fillable fields. +Eloquent model - 4 fillable fields. ### `Branch` -Eloquent model — 3 fillable fields. +Eloquent model - 3 fillable fields. ### `Complaint` -Eloquent model — 12 fillable fields, relations: employee, againstEmployee, complaintType, resolvedBy. +Eloquent model - 12 fillable fields, relations: employee, againstEmployee, complaintType, resolvedBy. ### `ComplaintType` -Eloquent model — 3 fillable fields. +Eloquent model - 3 fillable fields. ### `Deduction` -Eloquent model — 6 fillable fields, relations: deductionType, employee. +Eloquent model - 6 fillable fields, relations: deductionType, employee. ### `DeductionType` -Eloquent model — 4 fillable fields. +Eloquent model - 4 fillable fields. ### `Department` -Eloquent model — 4 fillable fields, relations: branch, employees, announcements. +Eloquent model - 4 fillable fields, relations: branch, employees, announcements. ### `Designation` -Eloquent model — 5 fillable fields, relations: branch, department. +Eloquent model - 5 fillable fields, relations: branch, department. ### `DocumentCategory` -Eloquent model — 4 fillable fields. +Eloquent model - 4 fillable fields. ### `Employee` -Eloquent model — 31 fillable fields, relations: user, branch, department, designation, shift. +Eloquent model - 31 fillable fields, relations: user, branch, department, designation, shift. ### `EmployeeDocument` -Eloquent model — 6 fillable fields, relations: user, documentType, media. +Eloquent model - 6 fillable fields, relations: user, documentType, media. ### `EmployeeDocumentType` -Eloquent model — 5 fillable fields. +Eloquent model - 5 fillable fields. ### `EmployeeTransfer` -Eloquent model — 15 fillable fields, relations: employee, from_branch, from_department, from_designation, to_branch, to_department, to_designation, approved_by. +Eloquent model - 15 fillable fields, relations: employee, from_branch, from_department, from_designation, to_branch, to_department, to_designation, approved_by. ### `Event` -Eloquent model — 12 fillable fields, relations: eventType, approvedBy, departments, creator. +Eloquent model - 12 fillable fields, relations: eventType, approvedBy, departments, creator. ### `EventType` -Eloquent model — 3 fillable fields. +Eloquent model - 3 fillable fields. ### `Holiday` -Eloquent model — 10 fillable fields, relations: holidayType. +Eloquent model - 10 fillable fields, relations: holidayType. ### `HolidayType` -Eloquent model — 3 fillable fields. +Eloquent model - 3 fillable fields. ### `HrmDocument` -Eloquent model — 11 fillable fields, relations: documentCategory, uploadedBy, approvedBy, creator, media. +Eloquent model - 11 fillable fields, relations: documentCategory, uploadedBy, approvedBy, creator, media. ### `HrmItem` -Eloquent model — 5 fillable fields. +Eloquent model - 5 fillable fields. ### `HrmModel` -Eloquent model — 0 fillable fields. +Eloquent model - 0 fillable fields. ### `IpRestrict` -Eloquent model — 3 fillable fields. +Eloquent model - 3 fillable fields. ### `LeaveApplication` -Eloquent model — 14 fillable fields, relations: employee, leave_type, approved_by, media. +Eloquent model - 14 fillable fields, relations: employee, leave_type, approved_by, media. ### `LeaveType` -Eloquent model — 7 fillable fields. +Eloquent model - 7 fillable fields. ### `Loan` -Eloquent model — 10 fillable fields, relations: loanType, employee. +Eloquent model - 10 fillable fields, relations: loanType, employee. ### `LoanType` -Eloquent model — 4 fillable fields. +Eloquent model - 4 fillable fields. ### `Overtime` -Eloquent model — 11 fillable fields, relations: employee. +Eloquent model - 11 fillable fields, relations: employee. ### `Payroll` -Eloquent model — 15 fillable fields, relations: payrollEntries. +Eloquent model - 15 fillable fields, relations: payrollEntries. ### `PayrollEntry` -Eloquent model — 31 fillable fields, relations: payroll, employee. +Eloquent model - 31 fillable fields, relations: payroll, employee. ### `Promotion` -Eloquent model — 13 fillable fields, relations: employee, previousBranch, previousDepartment, previousDesignation, currentBranch, currentDepartment, currentDesignation, approvedBy. +Eloquent model - 13 fillable fields, relations: employee, previousBranch, previousDepartment, previousDesignation, currentBranch, currentDepartment, currentDesignation, approvedBy. ### `Resignation` -Eloquent model — 9 fillable fields, relations: employee, approvedBy. +Eloquent model - 9 fillable fields, relations: employee, approvedBy. ### `Shift` -Eloquent model — 11 fillable fields, relations: creator. +Eloquent model - 11 fillable fields, relations: creator. ### `Termination` -Eloquent model — 11 fillable fields, relations: employee, terminationType, approvedBy. +Eloquent model - 11 fillable fields, relations: employee, terminationType, approvedBy. ### `TerminationType` -Eloquent model — 3 fillable fields. +Eloquent model - 3 fillable fields. ### `Warning` -Eloquent model — 10 fillable fields, relations: employee, warningBy, warningType. +Eloquent model - 10 fillable fields, relations: employee, warningBy, warningType. ### `WarningType` -Eloquent model — 3 fillable fields. +Eloquent model - 3 fillable fields. ## Controllers ### `AcknowledgmentController` -HTTP controller — actions: index, store, update, destroy, updateStatus. +HTTP controller - actions: index, store, update, destroy, updateStatus. ### `AllowanceController` -HTTP controller — actions: store, update, destroy. +HTTP controller - actions: store, update, destroy. ### `AllowanceTypeController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `AnnouncementCategoryController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `AnnouncementController` -HTTP controller — actions: index, store, update, updateStatus, destroy. +HTTP controller - actions: index, store, update, updateStatus, destroy. ### `AttendanceController` -HTTP controller — actions: index, store, update, destroy, clockIn, clockOut, getClockStatus. +HTTP controller - actions: index, store, update, destroy, clockIn, clockOut, getClockStatus. ### `AwardController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `AwardTypeController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `BranchController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `ComplaintController` -HTTP controller — actions: index, store, update, updateStatus, destroy. +HTTP controller - actions: index, store, update, updateStatus, destroy. ### `ComplaintTypeController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `DashboardController` -HTTP controller — actions: index. +HTTP controller - actions: index. ### `DeductionController` -HTTP controller — actions: store, update, destroy. +HTTP controller - actions: store, update, destroy. ### `DeductionTypeController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `DepartmentController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `DesignationController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `DocumentCategoryController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `EmployeeController` -HTTP controller — actions: index, create, store, edit, update, destroy, show, card, deleteDocument. +HTTP controller - actions: index, create, store, edit, update, destroy, show, card, deleteDocument. ### `EmployeeDocumentTypeController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `EmployeeTransferController` -HTTP controller — actions: index, store, update, destroy, updateStatus. +HTTP controller - actions: index, store, update, destroy, updateStatus. ### `EventController` -HTTP controller — actions: index, store, update, destroy, statusUpdate, calendar. +HTTP controller - actions: index, store, update, destroy, statusUpdate, calendar. ### `EventTypeController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `HolidayController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `HolidayTypeController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `HrmDocumentController` -HTTP controller — actions: index, store, update, updateStatus, destroy. +HTTP controller - actions: index, store, update, updateStatus, destroy. ### `IpRestrictController` -HTTP controller — actions: index, store, update, destroy, toggleSetting. +HTTP controller - actions: index, store, update, destroy, toggleSetting. ### `LeaveApplicationController` -HTTP controller — actions: index, store, update, destroy, updateStatus, getLeaveBalance, getLeaveTypesByEmployee. +HTTP controller - actions: index, store, update, destroy, updateStatus, getLeaveBalance, getLeaveTypesByEmployee. ### `LeaveBalanceController` -HTTP controller — actions: index. +HTTP controller - actions: index. ### `LeaveTypeController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `LoanController` -HTTP controller — actions: store, update, destroy. +HTTP controller - actions: store, update, destroy. ### `LoanTypeController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `OvertimeController` -HTTP controller — actions: store, update, destroy. +HTTP controller - actions: store, update, destroy. ### `PayrollController` -HTTP controller — actions: index, store, update, show, destroy, runPayroll, destroyEntry, printPayslip, paySalary. +HTTP controller - actions: index, store, update, show, destroy, runPayroll, destroyEntry, printPayslip, paySalary. ### `PromotionController` -HTTP controller — actions: index, store, update, destroy, updateStatus. +HTTP controller - actions: index, store, update, destroy, updateStatus. ### `ResignationController` -HTTP controller — actions: index, store, update, destroy, updateStatus. +HTTP controller - actions: index, store, update, destroy, updateStatus. ### `SetSalaryController` -HTTP controller — actions: index, show, update. +HTTP controller - actions: index, show, update. ### `ShiftController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `TerminationController` -HTTP controller — actions: index, store, update, destroy, updateStatus. +HTTP controller - actions: index, store, update, destroy, updateStatus. ### `TerminationTypeController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `WarningController` -HTTP controller — actions: index, store, update, destroy, response. +HTTP controller - actions: index, store, update, destroy, response. ### `WarningTypeController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `WorkingDaysController` -HTTP controller — actions: index, update. +HTTP controller - actions: index, update. ## API Controllers ### `AttendanceApiController` -HTTP controller — actions: clockInOut, history. +HTTP controller - actions: clockInOut, history. ### `DashboardApiController` -HTTP controller — actions: index, getEvents. +HTTP controller - actions: index, getEvents. ### `HolidayApiController` -HTTP controller — actions: index. +HTTP controller - actions: index. ### `LeaveApiController` -HTTP controller — actions: index, store. +HTTP controller - actions: index, store. ### `LeaveTypeApiController` -HTTP controller — actions: index. +HTTP controller - actions: index. ## Events @@ -857,315 +857,315 @@ Event listener. ### `StoreAcknowledgmentRequest` -Form request — validation rules for StoreAcknowledgment. +Form request - validation rules for StoreAcknowledgment. ### `StoreAllowanceRequest` -Form request — validation rules for StoreAllowance. +Form request - validation rules for StoreAllowance. ### `StoreAllowanceTypeRequest` -Form request — validation rules for StoreAllowanceType. +Form request - validation rules for StoreAllowanceType. ### `StoreAnnouncementCategoryRequest` -Form request — validation rules for StoreAnnouncementCategory. +Form request - validation rules for StoreAnnouncementCategory. ### `StoreAnnouncementRequest` -Form request — validation rules for StoreAnnouncement. +Form request - validation rules for StoreAnnouncement. ### `StoreAttendanceRequest` -Form request — validation rules for StoreAttendance. +Form request - validation rules for StoreAttendance. ### `StoreAwardRequest` -Form request — validation rules for StoreAward. +Form request - validation rules for StoreAward. ### `StoreAwardTypeRequest` -Form request — validation rules for StoreAwardType. +Form request - validation rules for StoreAwardType. ### `StoreBranchRequest` -Form request — validation rules for StoreBranch. +Form request - validation rules for StoreBranch. ### `StoreComplaintRequest` -Form request — validation rules for StoreComplaint. +Form request - validation rules for StoreComplaint. ### `StoreComplaintTypeRequest` -Form request — validation rules for StoreComplaintType. +Form request - validation rules for StoreComplaintType. ### `StoreDeductionRequest` -Form request — validation rules for StoreDeduction. +Form request - validation rules for StoreDeduction. ### `StoreDeductionTypeRequest` -Form request — validation rules for StoreDeductionType. +Form request - validation rules for StoreDeductionType. ### `StoreDepartmentRequest` -Form request — validation rules for StoreDepartment. +Form request - validation rules for StoreDepartment. ### `StoreDesignationRequest` -Form request — validation rules for StoreDesignation. +Form request - validation rules for StoreDesignation. ### `StoreDocumentCategoryRequest` -Form request — validation rules for StoreDocumentCategory. +Form request - validation rules for StoreDocumentCategory. ### `StoreDocumentRequest` -Form request — validation rules for StoreDocument. +Form request - validation rules for StoreDocument. ### `StoreEmployeeDocumentTypeRequest` -Form request — validation rules for StoreEmployeeDocumentType. +Form request - validation rules for StoreEmployeeDocumentType. ### `StoreEmployeeRequest` -Form request — validation rules for StoreEmployee. +Form request - validation rules for StoreEmployee. ### `StoreEmployeeTransferRequest` -Form request — validation rules for StoreEmployeeTransfer. +Form request - validation rules for StoreEmployeeTransfer. ### `StoreEventRequest` -Form request — validation rules for StoreEvent. +Form request - validation rules for StoreEvent. ### `StoreEventTypeRequest` -Form request — validation rules for StoreEventType. +Form request - validation rules for StoreEventType. ### `StoreHolidayRequest` -Form request — validation rules for StoreHoliday. +Form request - validation rules for StoreHoliday. ### `StoreHolidayTypeRequest` -Form request — validation rules for StoreHolidayType. +Form request - validation rules for StoreHolidayType. ### `StoreHrmDocumentRequest` -Form request — validation rules for StoreHrmDocument. +Form request - validation rules for StoreHrmDocument. ### `StoreIpRestrictRequest` -Form request — validation rules for StoreIpRestrict. +Form request - validation rules for StoreIpRestrict. ### `StoreLeaveApplicationRequest` -Form request — validation rules for StoreLeaveApplication. +Form request - validation rules for StoreLeaveApplication. ### `StoreLeaveTypeRequest` -Form request — validation rules for StoreLeaveType. +Form request - validation rules for StoreLeaveType. ### `StoreLoanRequest` -Form request — validation rules for StoreLoan. +Form request - validation rules for StoreLoan. ### `StoreLoanTypeRequest` -Form request — validation rules for StoreLoanType. +Form request - validation rules for StoreLoanType. ### `StoreOvertimeRequest` -Form request — validation rules for StoreOvertime. +Form request - validation rules for StoreOvertime. ### `StorePayrollRequest` -Form request — validation rules for StorePayroll. +Form request - validation rules for StorePayroll. ### `StorePromotionRequest` -Form request — validation rules for StorePromotion. +Form request - validation rules for StorePromotion. ### `StoreResignationRequest` -Form request — validation rules for StoreResignation. +Form request - validation rules for StoreResignation. ### `StoreShiftRequest` -Form request — validation rules for StoreShift. +Form request - validation rules for StoreShift. ### `StoreTerminationRequest` -Form request — validation rules for StoreTermination. +Form request - validation rules for StoreTermination. ### `StoreTerminationTypeRequest` -Form request — validation rules for StoreTerminationType. +Form request - validation rules for StoreTerminationType. ### `StoreWarningRequest` -Form request — validation rules for StoreWarning. +Form request - validation rules for StoreWarning. ### `StoreWarningTypeRequest` -Form request — validation rules for StoreWarningType. +Form request - validation rules for StoreWarningType. ### `UpdateAcknowledgmentRequest` -Form request — validation rules for UpdateAcknowledgment. +Form request - validation rules for UpdateAcknowledgment. ### `UpdateAllowanceRequest` -Form request — validation rules for UpdateAllowance. +Form request - validation rules for UpdateAllowance. ### `UpdateAllowanceTypeRequest` -Form request — validation rules for UpdateAllowanceType. +Form request - validation rules for UpdateAllowanceType. ### `UpdateAnnouncementCategoryRequest` -Form request — validation rules for UpdateAnnouncementCategory. +Form request - validation rules for UpdateAnnouncementCategory. ### `UpdateAnnouncementRequest` -Form request — validation rules for UpdateAnnouncement. +Form request - validation rules for UpdateAnnouncement. ### `UpdateAttendanceRequest` -Form request — validation rules for UpdateAttendance. +Form request - validation rules for UpdateAttendance. ### `UpdateAwardRequest` -Form request — validation rules for UpdateAward. +Form request - validation rules for UpdateAward. ### `UpdateAwardTypeRequest` -Form request — validation rules for UpdateAwardType. +Form request - validation rules for UpdateAwardType. ### `UpdateBranchRequest` -Form request — validation rules for UpdateBranch. +Form request - validation rules for UpdateBranch. ### `UpdateComplaintRequest` -Form request — validation rules for UpdateComplaint. +Form request - validation rules for UpdateComplaint. ### `UpdateComplaintTypeRequest` -Form request — validation rules for UpdateComplaintType. +Form request - validation rules for UpdateComplaintType. ### `UpdateDeductionRequest` -Form request — validation rules for UpdateDeduction. +Form request - validation rules for UpdateDeduction. ### `UpdateDeductionTypeRequest` -Form request — validation rules for UpdateDeductionType. +Form request - validation rules for UpdateDeductionType. ### `UpdateDepartmentRequest` -Form request — validation rules for UpdateDepartment. +Form request - validation rules for UpdateDepartment. ### `UpdateDesignationRequest` -Form request — validation rules for UpdateDesignation. +Form request - validation rules for UpdateDesignation. ### `UpdateDocumentCategoryRequest` -Form request — validation rules for UpdateDocumentCategory. +Form request - validation rules for UpdateDocumentCategory. ### `UpdateDocumentRequest` -Form request — validation rules for UpdateDocument. +Form request - validation rules for UpdateDocument. ### `UpdateEmployeeDocumentTypeRequest` -Form request — validation rules for UpdateEmployeeDocumentType. +Form request - validation rules for UpdateEmployeeDocumentType. ### `UpdateEmployeeRequest` -Form request — validation rules for UpdateEmployee. +Form request - validation rules for UpdateEmployee. ### `UpdateEmployeeTransferRequest` -Form request — validation rules for UpdateEmployeeTransfer. +Form request - validation rules for UpdateEmployeeTransfer. ### `UpdateEventRequest` -Form request — validation rules for UpdateEvent. +Form request - validation rules for UpdateEvent. ### `UpdateEventTypeRequest` -Form request — validation rules for UpdateEventType. +Form request - validation rules for UpdateEventType. ### `UpdateHolidayRequest` -Form request — validation rules for UpdateHoliday. +Form request - validation rules for UpdateHoliday. ### `UpdateHolidayTypeRequest` -Form request — validation rules for UpdateHolidayType. +Form request - validation rules for UpdateHolidayType. ### `UpdateHrmDocumentRequest` -Form request — validation rules for UpdateHrmDocument. +Form request - validation rules for UpdateHrmDocument. ### `UpdateIpRestrictRequest` -Form request — validation rules for UpdateIpRestrict. +Form request - validation rules for UpdateIpRestrict. ### `UpdateLeaveApplicationRequest` -Form request — validation rules for UpdateLeaveApplication. +Form request - validation rules for UpdateLeaveApplication. ### `UpdateLeaveTypeRequest` -Form request — validation rules for UpdateLeaveType. +Form request - validation rules for UpdateLeaveType. ### `UpdateLoanRequest` -Form request — validation rules for UpdateLoan. +Form request - validation rules for UpdateLoan. ### `UpdateLoanTypeRequest` -Form request — validation rules for UpdateLoanType. +Form request - validation rules for UpdateLoanType. ### `UpdateOvertimeRequest` -Form request — validation rules for UpdateOvertime. +Form request - validation rules for UpdateOvertime. ### `UpdatePayrollRequest` -Form request — validation rules for UpdatePayroll. +Form request - validation rules for UpdatePayroll. ### `UpdatePromotionRequest` -Form request — validation rules for UpdatePromotion. +Form request - validation rules for UpdatePromotion. ### `UpdateResignationRequest` -Form request — validation rules for UpdateResignation. +Form request - validation rules for UpdateResignation. ### `UpdateShiftRequest` -Form request — validation rules for UpdateShift. +Form request - validation rules for UpdateShift. ### `UpdateTerminationRequest` -Form request — validation rules for UpdateTermination. +Form request - validation rules for UpdateTermination. ### `UpdateTerminationTypeRequest` -Form request — validation rules for UpdateTerminationType. +Form request - validation rules for UpdateTerminationType. ### `UpdateWarningRequest` -Form request — validation rules for UpdateWarning. +Form request - validation rules for UpdateWarning. ### `UpdateWarningTypeRequest` -Form request — validation rules for UpdateWarningType. +Form request - validation rules for UpdateWarningType. ## Providers diff --git a/docs-developer/50-reference/index.md b/docs-developer/50-reference/index.md index eada9d9..489ad7c 100644 --- a/docs-developer/50-reference/index.md +++ b/docs-developer/50-reference/index.md @@ -29,9 +29,9 @@ Auto-generated class reference for all `zerp/*` packages. Regenerate with `npm r | [zerp/pos](./pos) | Point of Sale module for the Zerp ERP platform | 14 | | [zerp/product-service](./product-service) | Product and service catalog module for the Zerp ERP platform | 37 | | [zerp/quotation](./quotation) | Sales quotation module for the Zerp ERP platform | 20 | -| [zerp/real-estate](./real-estate) | Real Estate Brokerage module for Zerp — property/listing management and viewings | 22 | +| [zerp/real-estate](./real-estate) | Real Estate Brokerage module for Zerp - property/listing management and viewings | 22 | | [zerp/recruitment](./recruitment) | Recruitment and hiring module for the Zerp ERP platform | 149 | -| [zerp/restaurant](./restaurant) | Restaurant management module for Zerp — menu, orders and kitchen | 51 | +| [zerp/restaurant](./restaurant) | Restaurant management module for Zerp - menu, orders and kitchen | 51 | | [zerp/slack](./slack) | Slack notification integration module for the Zerp ERP platform | 92 | | [zerp/stripe](./stripe) | Stripe payment gateway integration module for the Zerp ERP platform | 12 | | [zerp/support-ticket](./support-ticket) | Support ticket and helpdesk module for the Zerp ERP platform | 104 | diff --git a/docs-developer/50-reference/jitsi.md b/docs-developer/50-reference/jitsi.md index 1f873e8..57d0cbd 100644 --- a/docs-developer/50-reference/jitsi.md +++ b/docs-developer/50-reference/jitsi.md @@ -15,17 +15,17 @@ Jitsi Meet integration module for the Zerp ERP platform ### `JitsiMeeting` -Eloquent model — 12 fillable fields, relations: host. +Eloquent model - 12 fillable fields, relations: host. ## Controllers ### `JitsiController` -HTTP controller — actions: index, store, update, destroy, updateStatus. +HTTP controller - actions: index, store, update, destroy, updateStatus. ### `JitsiSettingsController` -HTTP controller — actions: update. +HTTP controller - actions: update. ## Events @@ -51,11 +51,11 @@ Event listener. ### `StoreJitsiMeetingRequest` -Form request — validation rules for StoreJitsiMeeting. +Form request - validation rules for StoreJitsiMeeting. ### `UpdateJitsiMeetingRequest` -Form request — validation rules for UpdateJitsiMeeting. +Form request - validation rules for UpdateJitsiMeeting. ## Providers diff --git a/docs-developer/50-reference/landing-page.md b/docs-developer/50-reference/landing-page.md index 58aba12..9d2dac4 100644 --- a/docs-developer/50-reference/landing-page.md +++ b/docs-developer/50-reference/landing-page.md @@ -15,37 +15,37 @@ Landing page, CMS, and marketplace module for the Zerp ERP platform ### `CustomPage` -Eloquent model — 7 fillable fields. +Eloquent model - 7 fillable fields. ### `LandingPageSetting` -Eloquent model — 5 fillable fields. +Eloquent model - 5 fillable fields. ### `MarketplaceSetting` -Eloquent model — 4 fillable fields. +Eloquent model - 4 fillable fields. ### `NewsletterSubscriber` -Eloquent model — 16 fillable fields. +Eloquent model - 16 fillable fields. ## Controllers ### `CustomPageController` -HTTP controller — actions: index, create, store, edit, update, destroy, show. +HTTP controller - actions: index, create, store, edit, update, destroy, show. ### `LandingPageController` -HTTP controller — actions: index, pricing, contact, submitContact, settings, store. +HTTP controller - actions: index, pricing, contact, submitContact, settings, store. ### `MarketplaceController` -HTTP controller — actions: index, settings, storeSettings. +HTTP controller - actions: index, settings, storeSettings. ### `NewsletterSubscriberController` -HTTP controller — actions: index, store, destroy, export. +HTTP controller - actions: index, store, destroy, export. ## Events @@ -61,11 +61,11 @@ Domain event. ### `StoreContactMessageRequest` -Form request — validation rules for StoreContactMessage. +Form request - validation rules for StoreContactMessage. ### `StoreNewsletterSubscriberRequest` -Form request — validation rules for StoreNewsletterSubscriber. +Form request - validation rules for StoreNewsletterSubscriber. ## Providers diff --git a/docs-developer/50-reference/lead.md b/docs-developer/50-reference/lead.md index 186b466..bfbbcbc 100644 --- a/docs-developer/50-reference/lead.md +++ b/docs-developer/50-reference/lead.md @@ -15,187 +15,187 @@ CRM and lead management module for the Zerp ERP platform ### `ClientDeal` -Eloquent model — 2 fillable fields, relations: deal, client. +Eloquent model - 2 fillable fields, relations: deal, client. ### `ClientPermission` -Eloquent model — 3 fillable fields, relations: client, deal. +Eloquent model - 3 fillable fields, relations: client, deal. ### `Deal` -Eloquent model — 16 fillable fields, relations: pipeline, stage, lostReason, creator, userDeals, users, tasks, emails, discussions, calls, activities, complete_tasks, clientDeals, files. +Eloquent model - 16 fillable fields, relations: pipeline, stage, lostReason, creator, userDeals, users, tasks, emails, discussions, calls, activities, complete_tasks, clientDeals, files. ### `DealActivityLog` -Eloquent model — 4 fillable fields, relations: user, deal. +Eloquent model - 4 fillable fields, relations: user, deal. ### `DealCall` -Eloquent model — 7 fillable fields, relations: deal, user, assignee. +Eloquent model - 7 fillable fields, relations: deal, user, assignee. ### `DealDiscussion` -Eloquent model — 4 fillable fields, relations: deal, creator. +Eloquent model - 4 fillable fields, relations: deal, creator. ### `DealEmail` -Eloquent model — 4 fillable fields, relations: deal. +Eloquent model - 4 fillable fields, relations: deal. ### `DealFile` -Eloquent model — 4 fillable fields, relations: deal, media. +Eloquent model - 4 fillable fields, relations: deal, media. ### `DealStage` -Eloquent model — 6 fillable fields, relations: pipeline. +Eloquent model - 6 fillable fields, relations: pipeline. ### `DealTask` -Eloquent model — 9 fillable fields, relations: deal. +Eloquent model - 9 fillable fields, relations: deal. ### `Label` -Eloquent model — 5 fillable fields, relations: pipeline. +Eloquent model - 5 fillable fields, relations: pipeline. ### `Lead` -Eloquent model — 20 fillable fields, relations: stage, user, userLeads, tasks, complete_tasks, emails, discussions, files, calls, activities, pipeline, sources, products. +Eloquent model - 20 fillable fields, relations: stage, user, userLeads, tasks, complete_tasks, emails, discussions, files, calls, activities, pipeline, sources, products. ### `LeadActivityLog` -Eloquent model — 4 fillable fields, relations: user, lead. +Eloquent model - 4 fillable fields, relations: user, lead. ### `LeadCall` -Eloquent model — 7 fillable fields, relations: lead, user, assignee. +Eloquent model - 7 fillable fields, relations: lead, user, assignee. ### `LeadDiscussion` -Eloquent model — 4 fillable fields, relations: lead, creator. +Eloquent model - 4 fillable fields, relations: lead, creator. ### `LeadEmail` -Eloquent model — 4 fillable fields, relations: lead. +Eloquent model - 4 fillable fields, relations: lead. ### `LeadFile` -Eloquent model — 4 fillable fields, relations: lead, media. +Eloquent model - 4 fillable fields, relations: lead, media. ### `LeadScoreRule` -Eloquent model — 8 fillable fields. +Eloquent model - 8 fillable fields. ### `LeadStage` -Eloquent model — 6 fillable fields, relations: pipeline. +Eloquent model - 6 fillable fields, relations: pipeline. ### `LeadTask` -Eloquent model — 9 fillable fields, relations: lead. +Eloquent model - 9 fillable fields, relations: lead. ### `LeadUtility` -Eloquent model — 0 fillable fields. +Eloquent model - 0 fillable fields. ### `LostReason` -Eloquent model — 3 fillable fields. +Eloquent model - 3 fillable fields. ### `Pipeline` -Eloquent model — 3 fillable fields. +Eloquent model - 3 fillable fields. ### `Source` -Eloquent model — 3 fillable fields. +Eloquent model - 3 fillable fields. ### `User` -Eloquent model — 0 fillable fields, relations: deals, leads, clientDeals, clientEstimations, clientContracts. +Eloquent model - 0 fillable fields, relations: deals, leads, clientDeals, clientEstimations, clientContracts. ### `UserDeal` -Eloquent model — 2 fillable fields, relations: user, deal. +Eloquent model - 2 fillable fields, relations: user, deal. ### `UserLead` -Eloquent model — 2 fillable fields, relations: user, lead. +Eloquent model - 2 fillable fields, relations: user, lead. ## Controllers ### `ActivityController` -HTTP controller — actions: index. +HTTP controller - actions: index. ### `DashboardController` -HTTP controller — actions: index. +HTTP controller - actions: index. ### `DealController` -HTTP controller — actions: index, store, show, update, destroy, updateLabels, assignUsers, removeUser, assignProducts, removeProduct, assignSources, removeSource, storeEmail, storeDiscussion, assignClients, removeClient, callStore, callUpdate, callDestroy, storeFile, deleteFile, order, changeStatus, markWon, markLost. +HTTP controller - actions: index, store, show, update, destroy, updateLabels, assignUsers, removeUser, assignProducts, removeProduct, assignSources, removeSource, storeEmail, storeDiscussion, assignClients, removeClient, callStore, callUpdate, callDestroy, storeFile, deleteFile, order, changeStatus, markWon, markLost. ### `DealStageController` -HTTP controller — actions: index, store, update, destroy, updateOrder. +HTTP controller - actions: index, store, update, destroy, updateOrder. ### `DealTaskController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `LabelController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `LeadController` -HTTP controller — actions: index, store, show, edit, update, destroy, getStagesByPipeline, updateLabels, getAvailableUsers, assignUsers, removeUser, getAvailableProducts, assignProducts, removeProduct, getAvailableSources, assignSources, removeSource, storeEmail, storeDiscussion, storeFile, deleteFile, callStore, callUpdate, callDestroy, order, getExistingClients, convertToDeal. +HTTP controller - actions: index, store, show, edit, update, destroy, getStagesByPipeline, updateLabels, getAvailableUsers, assignUsers, removeUser, getAvailableProducts, assignProducts, removeProduct, getAvailableSources, assignSources, removeSource, storeEmail, storeDiscussion, storeFile, deleteFile, callStore, callUpdate, callDestroy, order, getExistingClients, convertToDeal. ### `LeadScoreRuleController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `LeadStageController` -HTTP controller — actions: index, store, update, destroy, updateOrder. +HTTP controller - actions: index, store, update, destroy, updateOrder. ### `LeadTaskController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `LostReasonController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `PipelineController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `ReportController` -HTTP controller — actions: index, leadReports, dealReports. +HTTP controller - actions: index, leadReports, dealReports. ### `SourceController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ## API Controllers ### `DashboardApiController` -HTTP controller — actions: index, chartData. +HTTP controller - actions: index, chartData. ### `LeadApiController` -HTTP controller — actions: index, leadCreateAndUpdate, createLead, updateLead, leadStageUpdate, leadDetails, destroy, getUsers, getRequestData. +HTTP controller - actions: index, leadCreateAndUpdate, createLead, updateLead, leadStageUpdate, leadDetails, destroy, getUsers, getRequestData. ### `LeadStageApiController` -HTTP controller — actions: index, leadstageCreateAndUpdate, createLeadstage, updateLeadstage. +HTTP controller - actions: index, leadstageCreateAndUpdate, createLeadstage, updateLeadstage. ### `PipelineApiController` -HTTP controller — actions: index, pipelineCreateAndUpdate. +HTTP controller - actions: index, pipelineCreateAndUpdate. ## Events @@ -449,115 +449,115 @@ Event listener. ### `AssignUsersRequest` -Form request — validation rules for AssignUsers. +Form request - validation rules for AssignUsers. ### `ConvertToDealRequest` -Form request — validation rules for ConvertToDeal. +Form request - validation rules for ConvertToDeal. ### `StoreDealCallRequest` -Form request — validation rules for StoreDealCall. +Form request - validation rules for StoreDealCall. ### `StoreDealDiscussionRequest` -Form request — validation rules for StoreDealDiscussion. +Form request - validation rules for StoreDealDiscussion. ### `StoreDealEmailRequest` -Form request — validation rules for StoreDealEmail. +Form request - validation rules for StoreDealEmail. ### `StoreDealRequest` -Form request — validation rules for StoreDeal. +Form request - validation rules for StoreDeal. ### `StoreDealStageRequest` -Form request — validation rules for StoreDealStage. +Form request - validation rules for StoreDealStage. ### `StoreDealTaskRequest` -Form request — validation rules for StoreDealTask. +Form request - validation rules for StoreDealTask. ### `StoreLabelRequest` -Form request — validation rules for StoreLabel. +Form request - validation rules for StoreLabel. ### `StoreLeadCallRequest` -Form request — validation rules for StoreLeadCall. +Form request - validation rules for StoreLeadCall. ### `StoreLeadDiscussionRequest` -Form request — validation rules for StoreLeadDiscussion. +Form request - validation rules for StoreLeadDiscussion. ### `StoreLeadEmailRequest` -Form request — validation rules for StoreLeadEmail. +Form request - validation rules for StoreLeadEmail. ### `StoreLeadRequest` -Form request — validation rules for StoreLead. +Form request - validation rules for StoreLead. ### `StoreLeadStageRequest` -Form request — validation rules for StoreLeadStage. +Form request - validation rules for StoreLeadStage. ### `StoreLeadTaskRequest` -Form request — validation rules for StoreLeadTask. +Form request - validation rules for StoreLeadTask. ### `StorePipelineRequest` -Form request — validation rules for StorePipeline. +Form request - validation rules for StorePipeline. ### `StoreSourceRequest` -Form request — validation rules for StoreSource. +Form request - validation rules for StoreSource. ### `UpdateDealCallRequest` -Form request — validation rules for UpdateDealCall. +Form request - validation rules for UpdateDealCall. ### `UpdateDealRequest` -Form request — validation rules for UpdateDeal. +Form request - validation rules for UpdateDeal. ### `UpdateDealStageRequest` -Form request — validation rules for UpdateDealStage. +Form request - validation rules for UpdateDealStage. ### `UpdateDealTaskRequest` -Form request — validation rules for UpdateDealTask. +Form request - validation rules for UpdateDealTask. ### `UpdateLabelRequest` -Form request — validation rules for UpdateLabel. +Form request - validation rules for UpdateLabel. ### `UpdateLeadCallRequest` -Form request — validation rules for UpdateLeadCall. +Form request - validation rules for UpdateLeadCall. ### `UpdateLeadRequest` -Form request — validation rules for UpdateLead. +Form request - validation rules for UpdateLead. ### `UpdateLeadStageRequest` -Form request — validation rules for UpdateLeadStage. +Form request - validation rules for UpdateLeadStage. ### `UpdateLeadTaskRequest` -Form request — validation rules for UpdateLeadTask. +Form request - validation rules for UpdateLeadTask. ### `UpdatePipelineRequest` -Form request — validation rules for UpdatePipeline. +Form request - validation rules for UpdatePipeline. ### `UpdateSourceRequest` -Form request — validation rules for UpdateSource. +Form request - validation rules for UpdateSource. ## Providers @@ -573,11 +573,11 @@ Service provider. ### `Activities` -Support class — methods: —. +Support class - methods: none. ### `LeadScoring` -Support class — methods: —. +Support class - methods: none. ## Seeders diff --git a/docs-developer/50-reference/package-template.md b/docs-developer/50-reference/package-template.md index daa382e..d0b96d1 100644 --- a/docs-developer/50-reference/package-template.md +++ b/docs-developer/50-reference/package-template.md @@ -15,27 +15,27 @@ Description for example-package package ### `ExamplePackageItem` -Eloquent model — 5 fillable fields. +Eloquent model - 5 fillable fields. ## Controllers ### `DashboardController` -HTTP controller — actions: index. +HTTP controller - actions: index. ### `ExamplePackageItemController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ## Requests ### `StoreExamplePackageItemRequest` -Form request — validation rules for StoreExamplePackageItem. +Form request - validation rules for StoreExamplePackageItem. ### `UpdateExamplePackageItemRequest` -Form request — validation rules for UpdateExamplePackageItem. +Form request - validation rules for UpdateExamplePackageItem. ## Providers diff --git a/docs-developer/50-reference/paypal.md b/docs-developer/50-reference/paypal.md index c348cb9..6cc11ed 100644 --- a/docs-developer/50-reference/paypal.md +++ b/docs-developer/50-reference/paypal.md @@ -15,11 +15,11 @@ PayPal payment gateway integration module for the Zerp ERP platform ### `PaypalController` -HTTP controller — actions: planPayWithPaypal, planGetPaypalStatus, bookingPayWithPaypal, bookingGetPaypalStatus, beautySpaPayWithPaypal, beautySpaGetPaypalStatus, lmsPayWithPaypal, lmsGetPaypalStatus, parkingPayWithPaypal, parkingGetPaypalStatus, laundryPayWithPaypal, laundryGetPaypalStatus, eventsPayWithPaypal, eventsGetPaypalStatus. +HTTP controller - actions: planPayWithPaypal, planGetPaypalStatus, bookingPayWithPaypal, bookingGetPaypalStatus, beautySpaPayWithPaypal, beautySpaGetPaypalStatus, lmsPayWithPaypal, lmsGetPaypalStatus, parkingPayWithPaypal, parkingGetPaypalStatus, laundryPayWithPaypal, laundryGetPaypalStatus, eventsPayWithPaypal, eventsGetPaypalStatus. ### `PaypalSettingsController` -HTTP controller — actions: update. +HTTP controller - actions: update. ## Events @@ -43,7 +43,7 @@ Domain event. ### `UpdatePaypalSettingsRequest` -Form request — validation rules for UpdatePaypalSettings. +Form request - validation rules for UpdatePaypalSettings. ## Providers diff --git a/docs-developer/50-reference/performance.md b/docs-developer/50-reference/performance.md index 0c7a42d..4f6a58e 100644 --- a/docs-developer/50-reference/performance.md +++ b/docs-developer/50-reference/performance.md @@ -15,57 +15,57 @@ Employee performance review module for the Zerp ERP platform ### `PerformanceEmployeeGoal` -Eloquent model — 11 fillable fields, relations: employee, goalType, creator, createdBy. +Eloquent model - 11 fillable fields, relations: employee, goalType, creator, createdBy. ### `PerformanceEmployeeReview` -Eloquent model — 11 fillable fields, relations: user, reviewer, reviewCycle, creator, createdBy. +Eloquent model - 11 fillable fields, relations: user, reviewer, reviewCycle, creator, createdBy. ### `PerformanceGoalType` -Eloquent model — 5 fillable fields, relations: employeeGoals, creator, createdBy. +Eloquent model - 5 fillable fields, relations: employeeGoals, creator, createdBy. ### `PerformanceIndicator` -Eloquent model — 8 fillable fields, relations: category, creator, createdBy. +Eloquent model - 8 fillable fields, relations: category, creator, createdBy. ### `PerformanceIndicatorCategory` -Eloquent model — 5 fillable fields, relations: indicators, creator, createdBy. +Eloquent model - 5 fillable fields, relations: indicators, creator, createdBy. ### `PerformanceReviewCycle` -Eloquent model — 6 fillable fields, relations: employeeReviews, creator, createdBy. +Eloquent model - 6 fillable fields, relations: employeeReviews, creator, createdBy. ### `PerformanceUtility` -Eloquent model — 0 fillable fields. +Eloquent model - 0 fillable fields. ## Controllers ### `EmployeeGoalController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `EmployeeReviewController` -HTTP controller — actions: index, store, update, show, destroy, conduct, conductStore. +HTTP controller - actions: index, store, update, show, destroy, conduct, conductStore. ### `GoalTypeController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `PerformanceIndicatorCategoryController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `PerformanceIndicatorController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `ReviewCycleController` -HTTP controller — actions: index, store, update, show, destroy. +HTTP controller - actions: index, store, update, show, destroy. ## Events @@ -151,107 +151,107 @@ Event listener. ### `StoreCompetencyCategoryRequest` -Form request — validation rules for StoreCompetencyCategory. +Form request - validation rules for StoreCompetencyCategory. ### `StoreCompetencyRequest` -Form request — validation rules for StoreCompetency. +Form request - validation rules for StoreCompetency. ### `StoreEmployeeCompetencyRequest` -Form request — validation rules for StoreEmployeeCompetency. +Form request - validation rules for StoreEmployeeCompetency. ### `StoreEmployeeFeedbackRequest` -Form request — validation rules for StoreEmployeeFeedback. +Form request - validation rules for StoreEmployeeFeedback. ### `StoreEmployeeGoalRequest` -Form request — validation rules for StoreEmployeeGoal. +Form request - validation rules for StoreEmployeeGoal. ### `StoreEmployeeReviewRequest` -Form request — validation rules for StoreEmployeeReview. +Form request - validation rules for StoreEmployeeReview. ### `StoreFeedbackTypeRequest` -Form request — validation rules for StoreFeedbackType. +Form request - validation rules for StoreFeedbackType. ### `StoreGoalTypeRequest` -Form request — validation rules for StoreGoalType. +Form request - validation rules for StoreGoalType. ### `StorePerformanceIndicatorCategoryRequest` -Form request — validation rules for StorePerformanceIndicatorCategory. +Form request - validation rules for StorePerformanceIndicatorCategory. ### `StorePerformanceIndicatorRequest` -Form request — validation rules for StorePerformanceIndicator. +Form request - validation rules for StorePerformanceIndicator. ### `StorePerformanceItemRequest` -Form request — validation rules for StorePerformanceItem. +Form request - validation rules for StorePerformanceItem. ### `StoreReviewCycleRequest` -Form request — validation rules for StoreReviewCycle. +Form request - validation rules for StoreReviewCycle. ### `StoreReviewTemplateRequest` -Form request — validation rules for StoreReviewTemplate. +Form request - validation rules for StoreReviewTemplate. ### `UpdateCompetencyCategoryRequest` -Form request — validation rules for UpdateCompetencyCategory. +Form request - validation rules for UpdateCompetencyCategory. ### `UpdateCompetencyRequest` -Form request — validation rules for UpdateCompetency. +Form request - validation rules for UpdateCompetency. ### `UpdateEmployeeCompetencyRequest` -Form request — validation rules for UpdateEmployeeCompetency. +Form request - validation rules for UpdateEmployeeCompetency. ### `UpdateEmployeeFeedbackRequest` -Form request — validation rules for UpdateEmployeeFeedback. +Form request - validation rules for UpdateEmployeeFeedback. ### `UpdateEmployeeGoalRequest` -Form request — validation rules for UpdateEmployeeGoal. +Form request - validation rules for UpdateEmployeeGoal. ### `UpdateEmployeeReviewRequest` -Form request — validation rules for UpdateEmployeeReview. +Form request - validation rules for UpdateEmployeeReview. ### `UpdateFeedbackTypeRequest` -Form request — validation rules for UpdateFeedbackType. +Form request - validation rules for UpdateFeedbackType. ### `UpdateGoalTypeRequest` -Form request — validation rules for UpdateGoalType. +Form request - validation rules for UpdateGoalType. ### `UpdatePerformanceIndicatorCategoryRequest` -Form request — validation rules for UpdatePerformanceIndicatorCategory. +Form request - validation rules for UpdatePerformanceIndicatorCategory. ### `UpdatePerformanceIndicatorRequest` -Form request — validation rules for UpdatePerformanceIndicator. +Form request - validation rules for UpdatePerformanceIndicator. ### `UpdatePerformanceItemRequest` -Form request — validation rules for UpdatePerformanceItem. +Form request - validation rules for UpdatePerformanceItem. ### `UpdateReviewCycleRequest` -Form request — validation rules for UpdateReviewCycle. +Form request - validation rules for UpdateReviewCycle. ### `UpdateReviewTemplateRequest` -Form request — validation rules for UpdateReviewTemplate. +Form request - validation rules for UpdateReviewTemplate. ## Providers diff --git a/docs-developer/50-reference/pos.md b/docs-developer/50-reference/pos.md index 5820460..ae34abb 100644 --- a/docs-developer/50-reference/pos.md +++ b/docs-developer/50-reference/pos.md @@ -15,29 +15,29 @@ Point of Sale module for the Zerp ERP platform ### `Pos` -Eloquent model — 7 fillable fields, relations: customer, warehouse, items, payment. +Eloquent model - 7 fillable fields, relations: customer, warehouse, items, payment. ### `PosItem` -Eloquent model — 10 fillable fields, relations: sale, product. +Eloquent model - 10 fillable fields, relations: sale, product. ### `PosPayment` -Eloquent model — 6 fillable fields, relations: sale. +Eloquent model - 6 fillable fields, relations: sale. ## Controllers ### `DashboardController` -HTTP controller — actions: index. +HTTP controller - actions: index. ### `PosController` -HTTP controller — actions: index, create, getProducts, store, show, barcode, printBarcode, print, getNextPosNumber. +HTTP controller - actions: index, create, getProducts, store, show, barcode, printBarcode, print, getNextPosNumber. ### `PosReportController` -HTTP controller — actions: sales, products, customers. +HTTP controller - actions: sales, products, customers. ## Events @@ -49,7 +49,7 @@ Domain event. ### `StorePosRequest` -Form request — validation rules for StorePos. +Form request - validation rules for StorePos. ## Providers diff --git a/docs-developer/50-reference/product-service.md b/docs-developer/50-reference/product-service.md index 47721de..ac9a741 100644 --- a/docs-developer/50-reference/product-service.md +++ b/docs-developer/50-reference/product-service.md @@ -15,41 +15,41 @@ Product and service catalog module for the Zerp ERP platform ### `ProductServiceCategory` -Eloquent model — 4 fillable fields. +Eloquent model - 4 fillable fields. ### `ProductServiceItem` -Eloquent model — 14 fillable fields, relations: category, unitRelation, warehouseStocks. +Eloquent model - 14 fillable fields, relations: category, unitRelation, warehouseStocks. ### `ProductServiceTax` -Eloquent model — 4 fillable fields. +Eloquent model - 4 fillable fields. ### `ProductServiceUnit` -Eloquent model — 3 fillable fields. +Eloquent model - 3 fillable fields. ### `WarehouseStock` -Eloquent model — 3 fillable fields, relations: product, warehouse. +Eloquent model - 3 fillable fields, relations: product, warehouse. ## Controllers ### `CategoryController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `ProductServiceItemController` -HTTP controller — actions: index, create, store, show, edit, update, destroy, stockIndex, apiIndex, stockStore. +HTTP controller - actions: index, create, store, show, edit, update, destroy, stockIndex, apiIndex, stockStore. ### `TaxController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `UnitController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ## Events @@ -131,11 +131,11 @@ Event listener. ### `StoreProductServiceItemRequest` -Form request — validation rules for StoreProductServiceItem. +Form request - validation rules for StoreProductServiceItem. ### `UpdateProductServiceItemRequest` -Form request — validation rules for UpdateProductServiceItem. +Form request - validation rules for UpdateProductServiceItem. ## Providers diff --git a/docs-developer/50-reference/quotation.md b/docs-developer/50-reference/quotation.md index 1aa6820..9db14a2 100644 --- a/docs-developer/50-reference/quotation.md +++ b/docs-developer/50-reference/quotation.md @@ -15,21 +15,21 @@ Sales quotation module for the Zerp ERP platform ### `SalesQuotation` -Eloquent model — 18 fillable fields, relations: customer, items, warehouse, customerDetails, parentQuotation, revisions. +Eloquent model - 18 fillable fields, relations: customer, items, warehouse, customerDetails, parentQuotation, revisions. ### `SalesQuotationItem` -Eloquent model — 11 fillable fields, relations: quotation, product, taxes. +Eloquent model - 11 fillable fields, relations: quotation, product, taxes. ### `SalesQuotationItemTax` -Eloquent model — 5 fillable fields, relations: item. +Eloquent model - 5 fillable fields, relations: item. ## Controllers ### `QuotationController` -HTTP controller — actions: index, create, store, show, edit, update, destroy, sent, approve, reject, print, createRevision, duplicate, convertToInvoice, getWarehouseProducts. +HTTP controller - actions: index, create, store, show, edit, update, destroy, sent, approve, reject, print, createRevision, duplicate, convertToInvoice, getWarehouseProducts. ## Events @@ -71,11 +71,11 @@ Event listener. ### `StoreQuotationRequest` -Form request — validation rules for StoreQuotation. +Form request - validation rules for StoreQuotation. ### `UpdateQuotationRequest` -Form request — validation rules for UpdateQuotation. +Form request - validation rules for UpdateQuotation. ## Providers diff --git a/docs-developer/50-reference/real-estate.md b/docs-developer/50-reference/real-estate.md index b9ccbc8..eb7a5b4 100644 --- a/docs-developer/50-reference/real-estate.md +++ b/docs-developer/50-reference/real-estate.md @@ -5,7 +5,7 @@ sidebar_position: 21 # `zerp/real-estate` -Real Estate Brokerage module for Zerp — property/listing management and viewings +Real Estate Brokerage module for Zerp - property/listing management and viewings **Module version:** 1 @@ -15,59 +15,59 @@ Real Estate Brokerage module for Zerp — property/listing management and viewin ### `Amenity` -Eloquent model — 2 fillable fields, relations: properties. +Eloquent model - 2 fillable fields, relations: properties. ### `Property` -Eloquent model — 24 fillable fields, relations: type, agent, amenities, images, viewings. +Eloquent model - 24 fillable fields, relations: type, agent, amenities, images, viewings. ### `PropertyImage` -Eloquent model — 5 fillable fields, relations: property, media. +Eloquent model - 5 fillable fields, relations: property, media. ### `PropertyType` -Eloquent model — 3 fillable fields, relations: properties. +Eloquent model - 3 fillable fields, relations: properties. ### `PropertyViewing` -Eloquent model — 8 fillable fields, relations: property, agent. +Eloquent model - 8 fillable fields, relations: property, agent. ## Controllers ### `AmenityController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `DashboardController` -HTTP controller — actions: index. +HTTP controller - actions: index. ### `PropertyController` -HTTP controller — actions: index, create, store, show, edit, update, destroy. +HTTP controller - actions: index, create, store, show, edit, update, destroy. ### `PropertyTypeController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `PropertyViewingController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ## Requests ### `StorePropertyRequest` -Form request — validation rules for StoreProperty. +Form request - validation rules for StoreProperty. ### `StorePropertyViewingRequest` -Form request — validation rules for StorePropertyViewing. +Form request - validation rules for StorePropertyViewing. ### `UpdatePropertyRequest` -Form request — validation rules for UpdateProperty. +Form request - validation rules for UpdateProperty. ## Providers diff --git a/docs-developer/50-reference/recruitment.md b/docs-developer/50-reference/recruitment.md index 7c7fe58..ac4aaab 100644 --- a/docs-developer/50-reference/recruitment.md +++ b/docs-developer/50-reference/recruitment.md @@ -15,149 +15,149 @@ Recruitment and hiring module for the Zerp ERP platform ### `Candidate` -Eloquent model — 34 fillable fields, relations: job_posting, candidate_source, profileMedia, resumeMedia, coverLetterMedia, interviews, candidateAssessments. +Eloquent model - 34 fillable fields, relations: job_posting, candidate_source, profileMedia, resumeMedia, coverLetterMedia, interviews, candidateAssessments. ### `CandidateAssessment` -Eloquent model — 10 fillable fields, relations: candidate, conductedBy. +Eloquent model - 10 fillable fields, relations: candidate, conductedBy. ### `CandidateOnboarding` -Eloquent model — 7 fillable fields, relations: candidate, checklist, buddy. +Eloquent model - 7 fillable fields, relations: candidate, checklist, buddy. ### `CandidateSources` -Eloquent model — 5 fillable fields. +Eloquent model - 5 fillable fields. ### `ChecklistItem` -Eloquent model — 11 fillable fields, relations: checklist. +Eloquent model - 11 fillable fields, relations: checklist. ### `CustomQuestion` -Eloquent model — 8 fillable fields. +Eloquent model - 8 fillable fields. ### `Interview` -Eloquent model — 15 fillable fields, relations: candidate, jobPosting, interviewRound, interviewType, interviewFeedbacks. +Eloquent model - 15 fillable fields, relations: candidate, jobPosting, interviewRound, interviewType, interviewFeedbacks. ### `InterviewFeedback` -Eloquent model — 12 fillable fields, relations: interview, interviewer. +Eloquent model - 12 fillable fields, relations: interview, interviewer. ### `InterviewRound` -Eloquent model — 7 fillable fields, relations: job_posting. +Eloquent model - 7 fillable fields, relations: job_posting. ### `InterviewType` -Eloquent model — 5 fillable fields. +Eloquent model - 5 fillable fields. ### `Job` -Eloquent model — 6 fillable fields. +Eloquent model - 6 fillable fields. ### `JobLocation` -Eloquent model — 10 fillable fields. +Eloquent model - 10 fillable fields. ### `JobPosting` -Eloquent model — 30 fillable fields, relations: jobType, location, department. +Eloquent model - 30 fillable fields, relations: jobType, location, department. ### `JobType` -Eloquent model — 5 fillable fields. +Eloquent model - 5 fillable fields. ### `Offer` -Eloquent model — 21 fillable fields, relations: candidate, job, approvedBy, department. +Eloquent model - 21 fillable fields, relations: candidate, job, approvedBy, department. ### `OfferLetter` -Eloquent model — 4 fillable fields. +Eloquent model - 4 fillable fields. ### `OnboardingChecklist` -Eloquent model — 6 fillable fields, relations: checklistItems. +Eloquent model - 6 fillable fields, relations: checklistItems. ### `RecruitmentSetting` -Eloquent model — 3 fillable fields. +Eloquent model - 3 fillable fields. ## Controllers ### `CandidateAssessmentController` -HTTP controller — actions: index, create, store, edit, update, destroy. +HTTP controller - actions: index, create, store, edit, update, destroy. ### `CandidateController` -HTTP controller — actions: index, create, edit, store, update, destroy, show, getSourcesByJobPosting, getCustomQuestionsByJobPosting, getCandidateJobLocation, updateStatus. +HTTP controller - actions: index, create, edit, store, update, destroy, show, getSourcesByJobPosting, getCustomQuestionsByJobPosting, getCandidateJobLocation, updateStatus. ### `CandidateOnboardingController` -HTTP controller — actions: index, create, store, edit, update, destroy, getChecklistsByCandidate. +HTTP controller - actions: index, create, store, edit, update, destroy, getChecklistsByCandidate. ### `CandidateSourcesController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `ChecklistItemController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `CustomQuestionController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `DashboardController` -HTTP controller — actions: index. +HTTP controller - actions: index. ### `FrontendController` -HTTP controller — actions: jobListings, jobDetails, jobApply, applicationSuccess, trackingForm, trackingVerify, trackingDetails, jobTerms, offerResponse, submitApplication. +HTTP controller - actions: jobListings, jobDetails, jobApply, applicationSuccess, trackingForm, trackingVerify, trackingDetails, jobTerms, offerResponse, submitApplication. ### `InterviewController` -HTTP controller — actions: index, create, store, edit, update, destroy, getInterviewRoundsByCandidate. +HTTP controller - actions: index, create, store, edit, update, destroy, getInterviewRoundsByCandidate. ### `InterviewFeedbackController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `InterviewRoundController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `InterviewTypeController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `JobLocationController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `JobPostingController` -HTTP controller — actions: index, create, edit, store, update, destroy, togglePublish, show, getJobPostingSettings. +HTTP controller - actions: index, create, edit, store, update, destroy, togglePublish, show, getJobPostingSettings. ### `JobTypeController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `OfferController` -HTTP controller — actions: index, create, edit, store, update, updateApprovalStatus, destroy, downloadOfferLetter, sendEmail, showConvertToEmployeeForm, convertToEmployee, getJobsByCandidate. +HTTP controller - actions: index, create, edit, store, update, updateApprovalStatus, destroy, downloadOfferLetter, sendEmail, showConvertToEmployeeForm, convertToEmployee, getJobsByCandidate. ### `OnboardingChecklistController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `RecruitmentSettingController` -HTTP controller — actions: index, update, aboutCompany, updateAboutCompany, applicationTips, updateApplicationTips, whatHappensNext, updateWhatHappensNext, needHelp, updateNeedHelp, trackingFaq, updateTrackingFaq, offerLetterTemplate, updateOfferLetterTemplate, getPlaceholders, dashboardWelcomeCard, updateDashboardWelcomeCard. +HTTP controller - actions: index, update, aboutCompany, updateAboutCompany, applicationTips, updateApplicationTips, whatHappensNext, updateWhatHappensNext, needHelp, updateNeedHelp, trackingFaq, updateTrackingFaq, offerLetterTemplate, updateOfferLetterTemplate, getPlaceholders, dashboardWelcomeCard, updateDashboardWelcomeCard. ## Events @@ -395,135 +395,135 @@ Event listener. ### `ConvertToEmployeeRequest` -Form request — validation rules for ConvertToEmployee. +Form request - validation rules for ConvertToEmployee. ### `StoreCandidateAssessmentRequest` -Form request — validation rules for StoreCandidateAssessment. +Form request - validation rules for StoreCandidateAssessment. ### `StoreCandidateOnboardingRequest` -Form request — validation rules for StoreCandidateOnboarding. +Form request - validation rules for StoreCandidateOnboarding. ### `StoreCandidateRequest` -Form request — validation rules for StoreCandidate. +Form request - validation rules for StoreCandidate. ### `StoreCandidateSourcesRequest` -Form request — validation rules for StoreCandidateSources. +Form request - validation rules for StoreCandidateSources. ### `StoreChecklistItemRequest` -Form request — validation rules for StoreChecklistItem. +Form request - validation rules for StoreChecklistItem. ### `StoreCustomQuestionRequest` -Form request — validation rules for StoreCustomQuestion. +Form request - validation rules for StoreCustomQuestion. ### `StoreDashboardWelcomeCardRequest` -Form request — validation rules for StoreDashboardWelcomeCard. +Form request - validation rules for StoreDashboardWelcomeCard. ### `StoreInterviewFeedbackRequest` -Form request — validation rules for StoreInterviewFeedback. +Form request - validation rules for StoreInterviewFeedback. ### `StoreInterviewRequest` -Form request — validation rules for StoreInterview. +Form request - validation rules for StoreInterview. ### `StoreInterviewRoundRequest` -Form request — validation rules for StoreInterviewRound. +Form request - validation rules for StoreInterviewRound. ### `StoreInterviewTypeRequest` -Form request — validation rules for StoreInterviewType. +Form request - validation rules for StoreInterviewType. ### `StoreJobLocationRequest` -Form request — validation rules for StoreJobLocation. +Form request - validation rules for StoreJobLocation. ### `StoreJobPostingRequest` -Form request — validation rules for StoreJobPosting. +Form request - validation rules for StoreJobPosting. ### `StoreJobTypeRequest` -Form request — validation rules for StoreJobType. +Form request - validation rules for StoreJobType. ### `StoreOfferRequest` -Form request — validation rules for StoreOffer. +Form request - validation rules for StoreOffer. ### `StoreOnboardingChecklistRequest` -Form request — validation rules for StoreOnboardingChecklist. +Form request - validation rules for StoreOnboardingChecklist. ### `SubmitApplicationRequest` -Form request — validation rules for SubmitApplication. +Form request - validation rules for SubmitApplication. ### `UpdateCandidateAssessmentRequest` -Form request — validation rules for UpdateCandidateAssessment. +Form request - validation rules for UpdateCandidateAssessment. ### `UpdateCandidateOnboardingRequest` -Form request — validation rules for UpdateCandidateOnboarding. +Form request - validation rules for UpdateCandidateOnboarding. ### `UpdateCandidateRequest` -Form request — validation rules for UpdateCandidate. +Form request - validation rules for UpdateCandidate. ### `UpdateCandidateSourcesRequest` -Form request — validation rules for UpdateCandidateSources. +Form request - validation rules for UpdateCandidateSources. ### `UpdateChecklistItemRequest` -Form request — validation rules for UpdateChecklistItem. +Form request - validation rules for UpdateChecklistItem. ### `UpdateCustomQuestionRequest` -Form request — validation rules for UpdateCustomQuestion. +Form request - validation rules for UpdateCustomQuestion. ### `UpdateInterviewFeedbackRequest` -Form request — validation rules for UpdateInterviewFeedback. +Form request - validation rules for UpdateInterviewFeedback. ### `UpdateInterviewRequest` -Form request — validation rules for UpdateInterview. +Form request - validation rules for UpdateInterview. ### `UpdateInterviewRoundRequest` -Form request — validation rules for UpdateInterviewRound. +Form request - validation rules for UpdateInterviewRound. ### `UpdateInterviewTypeRequest` -Form request — validation rules for UpdateInterviewType. +Form request - validation rules for UpdateInterviewType. ### `UpdateJobLocationRequest` -Form request — validation rules for UpdateJobLocation. +Form request - validation rules for UpdateJobLocation. ### `UpdateJobPostingRequest` -Form request — validation rules for UpdateJobPosting. +Form request - validation rules for UpdateJobPosting. ### `UpdateJobTypeRequest` -Form request — validation rules for UpdateJobType. +Form request - validation rules for UpdateJobType. ### `UpdateOfferRequest` -Form request — validation rules for UpdateOffer. +Form request - validation rules for UpdateOffer. ### `UpdateOnboardingChecklistRequest` -Form request — validation rules for UpdateOnboardingChecklist. +Form request - validation rules for UpdateOnboardingChecklist. ## Providers diff --git a/docs-developer/50-reference/restaurant.md b/docs-developer/50-reference/restaurant.md index cbd77fe..35f7a89 100644 --- a/docs-developer/50-reference/restaurant.md +++ b/docs-developer/50-reference/restaurant.md @@ -5,7 +5,7 @@ sidebar_position: 23 # `zerp/restaurant` -Restaurant management module for Zerp — menu, orders and kitchen +Restaurant management module for Zerp - menu, orders and kitchen **Module version:** 1 @@ -15,171 +15,171 @@ Restaurant management module for Zerp — menu, orders and kitchen ### `Area` -Eloquent model — 5 fillable fields, relations: tables. +Eloquent model - 5 fillable fields, relations: tables. ### `KitchenStation` -Eloquent model — 5 fillable fields. +Eloquent model - 5 fillable fields. ### `MenuCategory` -Eloquent model — 7 fillable fields, relations: items. +Eloquent model - 7 fillable fields, relations: items. ### `MenuItem` -Eloquent model — 11 fillable fields, relations: category, station, variations, recipe, modifierGroups. +Eloquent model - 11 fillable fields, relations: category, station, variations, recipe, modifierGroups. ### `MenuItemVariation` -Eloquent model — 4 fillable fields, relations: item. +Eloquent model - 4 fillable fields, relations: item. ### `ModifierGroup` -Eloquent model — 7 fillable fields, relations: options. +Eloquent model - 7 fillable fields, relations: options. ### `ModifierOption` -Eloquent model — 4 fillable fields, relations: group. +Eloquent model - 4 fillable fields, relations: group. ### `Order` -Eloquent model — 17 fillable fields, relations: items, table. +Eloquent model - 17 fillable fields, relations: items, table. ### `OrderItem` -Eloquent model — 9 fillable fields, relations: order, menuItem, modifiers. +Eloquent model - 9 fillable fields, relations: order, menuItem, modifiers. ### `OrderItemModifier` -Eloquent model — 4 fillable fields, relations: orderItem. +Eloquent model - 4 fillable fields, relations: orderItem. ### `Recipe` -Eloquent model — 4 fillable fields, relations: menuItem. +Eloquent model - 4 fillable fields, relations: menuItem. ### `Reservation` -Eloquent model — 9 fillable fields, relations: table. +Eloquent model - 9 fillable fields, relations: table. ### `RestaurantTable` -Eloquent model — 12 fillable fields, relations: area, waiter, mergedInto, mergedTables. +Eloquent model - 12 fillable fields, relations: area, waiter, mergedInto, mergedTables. ## Controllers ### `AreaController` -HTTP controller — actions: store, update, destroy. +HTTP controller - actions: store, update, destroy. ### `FloorController` -HTTP controller — actions: index. +HTTP controller - actions: index. ### `KitchenController` -HTTP controller — actions: index, itemStatus, orderReady. +HTTP controller - actions: index, itemStatus, orderReady. ### `KitchenStationController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `MenuCategoryController` -HTTP controller — actions: store, update, destroy. +HTTP controller - actions: store, update, destroy. ### `MenuController` -HTTP controller — actions: index. +HTTP controller - actions: index. ### `MenuItemController` -HTTP controller — actions: store, update, destroy, syncRecipe, toggleAvailability. +HTTP controller - actions: store, update, destroy, syncRecipe, toggleAvailability. ### `ModifierGroupController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `OrderController` -HTTP controller — actions: pos, index, store, update, settle, cancel. +HTTP controller - actions: pos, index, store, update, settle, cancel. ### `ReservationController` -HTTP controller — actions: index, store, update, destroy, seat, cancel, noShow. +HTTP controller - actions: index, store, update, destroy, seat, cancel, noShow. ### `RestaurantTableController` -HTTP controller — actions: store, update, destroy, setStatus, assignWaiter, position, merge, split. +HTTP controller - actions: store, update, destroy, setStatus, assignWaiter, position, merge, split. ## Requests ### `SettleOrderRequest` -Form request — validation rules for SettleOrder. +Form request - validation rules for SettleOrder. ### `StoreAreaRequest` -Form request — validation rules for StoreArea. +Form request - validation rules for StoreArea. ### `StoreKitchenStationRequest` -Form request — validation rules for StoreKitchenStation. +Form request - validation rules for StoreKitchenStation. ### `StoreMenuCategoryRequest` -Form request — validation rules for StoreMenuCategory. +Form request - validation rules for StoreMenuCategory. ### `StoreMenuItemRequest` -Form request — validation rules for StoreMenuItem. +Form request - validation rules for StoreMenuItem. ### `StoreModifierGroupRequest` -Form request — validation rules for StoreModifierGroup. +Form request - validation rules for StoreModifierGroup. ### `StoreOrderRequest` -Form request — validation rules for StoreOrder. +Form request - validation rules for StoreOrder. ### `StoreReservationRequest` -Form request — validation rules for StoreReservation. +Form request - validation rules for StoreReservation. ### `StoreTableRequest` -Form request — validation rules for StoreTable. +Form request - validation rules for StoreTable. ### `UpdateAreaRequest` -Form request — validation rules for UpdateArea. +Form request - validation rules for UpdateArea. ### `UpdateKitchenStationRequest` -Form request — validation rules for UpdateKitchenStation. +Form request - validation rules for UpdateKitchenStation. ### `UpdateMenuCategoryRequest` -Form request — validation rules for UpdateMenuCategory. +Form request - validation rules for UpdateMenuCategory. ### `UpdateMenuItemRequest` -Form request — validation rules for UpdateMenuItem. +Form request - validation rules for UpdateMenuItem. ### `UpdateModifierGroupRequest` -Form request — validation rules for UpdateModifierGroup. +Form request - validation rules for UpdateModifierGroup. ### `UpdateOrderRequest` -Form request — validation rules for UpdateOrder. +Form request - validation rules for UpdateOrder. ### `UpdateReservationRequest` -Form request — validation rules for UpdateReservation. +Form request - validation rules for UpdateReservation. ### `UpdateTableRequest` -Form request — validation rules for UpdateTable. +Form request - validation rules for UpdateTable. ## Providers @@ -195,15 +195,15 @@ Service provider. ### `OrderBuilder` -Support class — methods: —. +Support class - methods: none. ### `RevenuePoster` -Support class — methods: —. +Support class - methods: none. ### `StockDeductor` -Support class — methods: —. +Support class - methods: none. ## Seeders diff --git a/docs-developer/50-reference/slack.md b/docs-developer/50-reference/slack.md index 40763e8..4003bdf 100644 --- a/docs-developer/50-reference/slack.md +++ b/docs-developer/50-reference/slack.md @@ -15,7 +15,7 @@ Slack notification integration module for the Zerp ERP platform ### `SlackSettingsController` -HTTP controller — actions: index, store. +HTTP controller - actions: index, store. ## Listeners diff --git a/docs-developer/50-reference/stripe.md b/docs-developer/50-reference/stripe.md index 4a088ed..3ba830c 100644 --- a/docs-developer/50-reference/stripe.md +++ b/docs-developer/50-reference/stripe.md @@ -15,11 +15,11 @@ Stripe payment gateway integration module for the Zerp ERP platform ### `StripeController` -HTTP controller — actions: planPayWithStripe, planGetStripeStatus, bookingPayWithStripe, bookingGetStripeStatus, beautySpaPayWithStripe, beautySpaGetStripeStatus, lmsPayWithStripe, lmsGetStripeStatus, laundryPayWithStripe, laundryGetStripeStatus, parkingPayWithStripe, parkingGetStripeStatus, eventsPayWithStripe, eventsGetStripeStatus. +HTTP controller - actions: planPayWithStripe, planGetStripeStatus, bookingPayWithStripe, bookingGetStripeStatus, beautySpaPayWithStripe, beautySpaGetStripeStatus, lmsPayWithStripe, lmsGetStripeStatus, laundryPayWithStripe, laundryGetStripeStatus, parkingPayWithStripe, parkingGetStripeStatus, eventsPayWithStripe, eventsGetStripeStatus. ### `StripeSettingsController` -HTTP controller — actions: update. +HTTP controller - actions: update. ## Events @@ -43,7 +43,7 @@ Domain event. ### `UpdateStripeSettingsRequest` -Form request — validation rules for UpdateStripeSettings. +Form request - validation rules for UpdateStripeSettings. ## Providers diff --git a/docs-developer/50-reference/support-ticket.md b/docs-developer/50-reference/support-ticket.md index fda523d..1aad45f 100644 --- a/docs-developer/50-reference/support-ticket.md +++ b/docs-developer/50-reference/support-ticket.md @@ -15,139 +15,139 @@ Support ticket and helpdesk module for the Zerp ERP platform ### `Contact` -Eloquent model — 8 fillable fields. +Eloquent model - 8 fillable fields. ### `Conversion` -Eloquent model — 6 fillable fields, relations: ticket. +Eloquent model - 6 fillable fields, relations: ticket. ### `Faq` -Eloquent model — 4 fillable fields. +Eloquent model - 4 fillable fields. ### `KnowledgeBase` -Eloquent model — 6 fillable fields, relations: category. +Eloquent model - 6 fillable fields, relations: category. ### `KnowledgeBaseCategory` -Eloquent model — 3 fillable fields, relations: knowledgeBases. +Eloquent model - 3 fillable fields, relations: knowledgeBases. ### `QuickLink` -Eloquent model — 6 fillable fields. +Eloquent model - 6 fillable fields. ### `SupportTicketCustomPage` -Eloquent model — 7 fillable fields. +Eloquent model - 7 fillable fields. ### `SupportTicketSetting` -Eloquent model — 4 fillable fields. +Eloquent model - 4 fillable fields. ### `SupporUtility` -Eloquent model — 0 fillable fields. +Eloquent model - 0 fillable fields. ### `Ticket` -Eloquent model — 13 fillable fields, relations: conversions, tcategory. +Eloquent model - 13 fillable fields, relations: conversions, tcategory. ### `TicketCategory` -Eloquent model — 4 fillable fields, relations: tickets. +Eloquent model - 4 fillable fields, relations: tickets. ### `TicketField` -Eloquent model — 10 fillable fields. +Eloquent model - 10 fillable fields. ### `TicketFieldValue` -Eloquent model — 3 fillable fields, relations: field, ticket. +Eloquent model - 3 fillable fields, relations: field, ticket. ## Controllers ### `ContactController` -HTTP controller — actions: index, store, show, destroy. +HTTP controller - actions: index, store, show, destroy. ### `ContactInformationController` -HTTP controller — actions: index, store. +HTTP controller - actions: index, store. ### `ConversationController` -HTTP controller — actions: store, sendEmail, replyEmail. +HTTP controller - actions: store, sendEmail, replyEmail. ### `CtaSectionController` -HTTP controller — actions: index, store. +HTTP controller - actions: index, store. ### `CustomPageController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `DashboardController` -HTTP controller — actions: index, clientDashboard, vendorDashboard, staffDashboard. +HTTP controller - actions: index, clientDashboard, vendorDashboard, staffDashboard. ### `FaqController` -HTTP controller — actions: index, store, update, destroy, fileImportExport, fileImport, faqImportdata. +HTTP controller - actions: index, store, update, destroy, fileImportExport, fileImport, faqImportdata. ### `FrontendController` -HTTP controller — actions: index, create, store, search, searchTicket, knowledge, faq, knowledgeArticle, contact, storeContact, showByTicketId, customPage, privacyPolicy, termsConditions, storeReply, show. +HTTP controller - actions: index, create, store, search, searchTicket, knowledge, faq, knowledgeArticle, contact, storeContact, showByTicketId, customPage, privacyPolicy, termsConditions, storeReply, show. ### `KnowledgebaseCategoryController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `KnowledgeController` -HTTP controller — actions: index, store, update, destroy, fileImportExport, fileImport, knowledgeImportdata. +HTTP controller - actions: index, store, update, destroy, fileImportExport, fileImport, knowledgeImportdata. ### `QuickLinkController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `SupportInformationController` -HTTP controller — actions: index, store. +HTTP controller - actions: index, store. ### `SupportTicketController` -HTTP controller — actions: index, create, store, edit, update, destroy, destroyAttachment, getUserData, storeNote, storeCustomFields, storeconverison, editReply, updateReply, deleteReply, downloadAttachment, grid. +HTTP controller - actions: index, create, store, edit, update, destroy, destroyAttachment, getUserData, storeNote, storeCustomFields, storeconverison, editReply, updateReply, deleteReply, downloadAttachment, grid. ### `SupportTicketSettingController` -HTTP controller — actions: brandSettings, updateBrandSettings. +HTTP controller - actions: brandSettings, updateBrandSettings. ### `TicketCategoryController` -HTTP controller — actions: index, store, update, destroy, supportCategories. +HTTP controller - actions: index, store, update, destroy, supportCategories. ### `TitleSectionController` -HTTP controller — actions: index, store. +HTTP controller - actions: index, store. ## API Controllers ### `DashboardApiController` -HTTP controller — actions: index, clientDashboard, vendorDashboard, staffDashboard. +HTTP controller - actions: index, clientDashboard, vendorDashboard, staffDashboard. ### `FaqApiController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `KnowledgeApiController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `TicketApiContollerController` -HTTP controller — actions: index, getRequestData, store, update, destroy, storeNote, addReply. +HTTP controller - actions: index, getRequestData, store, update, destroy, storeNote, addReply. ## Events @@ -273,115 +273,115 @@ Event listener. ### `ReplyEmailRequest` -Form request — validation rules for ReplyEmail. +Form request - validation rules for ReplyEmail. ### `StoreBrandSettingsRequest` -Form request — validation rules for StoreBrandSettings. +Form request - validation rules for StoreBrandSettings. ### `StoreContactInformationRequest` -Form request — validation rules for StoreContactInformation. +Form request - validation rules for StoreContactInformation. ### `StoreContactRequest` -Form request — validation rules for StoreContact. +Form request - validation rules for StoreContact. ### `StoreConversationRequest` -Form request — validation rules for StoreConversation. +Form request - validation rules for StoreConversation. ### `StoreConversionRequest` -Form request — validation rules for StoreConversion. +Form request - validation rules for StoreConversion. ### `StoreCtaSectionRequest` -Form request — validation rules for StoreCtaSection. +Form request - validation rules for StoreCtaSection. ### `StoreCustomPageRequest` -Form request — validation rules for StoreCustomPage. +Form request - validation rules for StoreCustomPage. ### `StoreFaqRequest` -Form request — validation rules for StoreFaq. +Form request - validation rules for StoreFaq. ### `StoreFrontendContactRequest` -Form request — validation rules for StoreFrontendContact. +Form request - validation rules for StoreFrontendContact. ### `StoreFrontendTicketRequest` -Form request — validation rules for StoreFrontendTicket. +Form request - validation rules for StoreFrontendTicket. ### `StoreKnowledgeBaseCategoryRequest` -Form request — validation rules for StoreKnowledgeBaseCategory. +Form request - validation rules for StoreKnowledgeBaseCategory. ### `StoreKnowledgeBaseRequest` -Form request — validation rules for StoreKnowledgeBase. +Form request - validation rules for StoreKnowledgeBase. ### `StoreQuickLinkRequest` -Form request — validation rules for StoreQuickLink. +Form request - validation rules for StoreQuickLink. ### `StoreSupportInformationRequest` -Form request — validation rules for StoreSupportInformation. +Form request - validation rules for StoreSupportInformation. ### `StoreSupportTicketItemRequest` -Form request — validation rules for StoreSupportTicketItem. +Form request - validation rules for StoreSupportTicketItem. ### `StoreSupportTicketRequest` -Form request — validation rules for StoreSupportTicket. +Form request - validation rules for StoreSupportTicket. ### `StoreTicketCategoryRequest` -Form request — validation rules for StoreTicketCategory. +Form request - validation rules for StoreTicketCategory. ### `StoreTicketReplyRequest` -Form request — validation rules for StoreTicketReply. +Form request - validation rules for StoreTicketReply. ### `StoreTitleSectionRequest` -Form request — validation rules for StoreTitleSection. +Form request - validation rules for StoreTitleSection. ### `UpdateCustomPageRequest` -Form request — validation rules for UpdateCustomPage. +Form request - validation rules for UpdateCustomPage. ### `UpdateFaqRequest` -Form request — validation rules for UpdateFaq. +Form request - validation rules for UpdateFaq. ### `UpdateKnowledgeBaseCategoryRequest` -Form request — validation rules for UpdateKnowledgeBaseCategory. +Form request - validation rules for UpdateKnowledgeBaseCategory. ### `UpdateKnowledgeBaseRequest` -Form request — validation rules for UpdateKnowledgeBase. +Form request - validation rules for UpdateKnowledgeBase. ### `UpdateQuickLinkRequest` -Form request — validation rules for UpdateQuickLink. +Form request - validation rules for UpdateQuickLink. ### `UpdateSupportTicketItemRequest` -Form request — validation rules for UpdateSupportTicketItem. +Form request - validation rules for UpdateSupportTicketItem. ### `UpdateSupportTicketRequest` -Form request — validation rules for UpdateSupportTicket. +Form request - validation rules for UpdateSupportTicket. ### `UpdateTicketCategoryRequest` -Form request — validation rules for UpdateTicketCategory. +Form request - validation rules for UpdateTicketCategory. ## Providers diff --git a/docs-developer/50-reference/taskly.md b/docs-developer/50-reference/taskly.md index 07aeea3..ad8c2da 100644 --- a/docs-developer/50-reference/taskly.md +++ b/docs-developer/50-reference/taskly.md @@ -15,99 +15,99 @@ Project management module for the Zerp ERP platform ### `ActivityLog` -Eloquent model — 5 fillable fields, relations: user. +Eloquent model - 5 fillable fields, relations: user. ### `BugComment` -Eloquent model — 3 fillable fields, relations: bug, user. +Eloquent model - 3 fillable fields, relations: bug, user. ### `BugStage` -Eloquent model — 6 fillable fields. +Eloquent model - 6 fillable fields. ### `Project` -Eloquent model — 8 fillable fields, relations: teamMembers, clients, milestones, tasks, bugs, activityLogs, files. +Eloquent model - 8 fillable fields, relations: teamMembers, clients, milestones, tasks, bugs, activityLogs, files. ### `ProjectBug` -Eloquent model — 8 fillable fields, relations: project, bugStage, assignedUser, comments. +Eloquent model - 8 fillable fields, relations: project, bugStage, assignedUser, comments. ### `ProjectClient` -Eloquent model — 2 fillable fields. +Eloquent model - 2 fillable fields. ### `ProjectFile` -Eloquent model — 4 fillable fields, relations: project, media. +Eloquent model - 4 fillable fields, relations: project, media. ### `ProjectMilestone` -Eloquent model — 8 fillable fields, relations: project. +Eloquent model - 8 fillable fields, relations: project. ### `ProjectTask` -Eloquent model — 10 fillable fields, relations: project, milestone, taskStage, assignedUser, comments, subtasks. +Eloquent model - 10 fillable fields, relations: project, milestone, taskStage, assignedUser, comments, subtasks. ### `ProjectUser` -Eloquent model — 2 fillable fields. +Eloquent model - 2 fillable fields. ### `TaskComment` -Eloquent model — 3 fillable fields, relations: task, user. +Eloquent model - 3 fillable fields, relations: task, user. ### `TaskStage` -Eloquent model — 6 fillable fields. +Eloquent model - 6 fillable fields. ### `TaskSubtask` -Eloquent model — 5 fillable fields, relations: task, user. +Eloquent model - 5 fillable fields, relations: task, user. ## Controllers ### `BugStageController` -HTTP controller — actions: index, store, update, destroy, reorder. +HTTP controller - actions: index, store, update, destroy, reorder. ### `DashboardController` -HTTP controller — actions: index. +HTTP controller - actions: index. ### `ProjectBugController` -HTTP controller — actions: index, kanban, store, show, update, destroy, move, getBugs, getComments, storeComment, destroyComment. +HTTP controller - actions: index, kanban, store, show, update, destroy, move, getBugs, getComments, storeComment, destroyComment. ### `ProjectController` -HTTP controller — actions: index, store, show, edit, update, destroy, duplicate, invite, deleteMember, inviteClient, deleteClient, storeMilestone, updateMilestone, deleteMilestone, storeFiles, deleteFile, apiIndex. +HTTP controller - actions: index, store, show, edit, update, destroy, duplicate, invite, deleteMember, inviteClient, deleteClient, storeMilestone, updateMilestone, deleteMilestone, storeFiles, deleteFile, apiIndex. ### `ProjectReportController` -HTTP controller — actions: index, show. +HTTP controller - actions: index, show. ### `ProjectTaskController` -HTTP controller — actions: index, store, kanban, calendar, move, update, getTasks, show, destroy, getComments, storeComment, destroyComment, getSubtasks, storeSubtask, toggleSubtask, apiTasks. +HTTP controller - actions: index, store, kanban, calendar, move, update, getTasks, show, destroy, getComments, storeComment, destroyComment, getSubtasks, storeSubtask, toggleSubtask, apiTasks. ### `TaskStageController` -HTTP controller — actions: index, store, update, destroy, reorder. +HTTP controller - actions: index, store, update, destroy, reorder. ## API Controllers ### `DashboardApiController` -HTTP controller — actions: index. +HTTP controller - actions: index. ### `ProjectApiController` -HTTP controller — actions: index, projectCreateAndUpdate, getUsers, destroyProject, projectDetails, projectStatusUpdate, projectActivity, projectFileUpload. +HTTP controller - actions: index, projectCreateAndUpdate, getUsers, destroyProject, projectDetails, projectStatusUpdate, projectActivity, projectFileUpload. ### `TaskApiController` -HTTP controller — actions: index, taskCreateAndUpdate, taskDelete, taskDetails, taskStageUpdate, taskboard. +HTTP controller - actions: index, taskCreateAndUpdate, taskDelete, taskDetails, taskStageUpdate, taskboard. ## Events @@ -241,35 +241,35 @@ Event listener. ### `StoreMilestoneRequest` -Form request — validation rules for StoreMilestone. +Form request - validation rules for StoreMilestone. ### `StoreProjectBugRequest` -Form request — validation rules for StoreProjectBug. +Form request - validation rules for StoreProjectBug. ### `StoreProjectRequest` -Form request — validation rules for StoreProject. +Form request - validation rules for StoreProject. ### `StoreProjectTaskRequest` -Form request — validation rules for StoreProjectTask. +Form request - validation rules for StoreProjectTask. ### `UpdateMilestoneRequest` -Form request — validation rules for UpdateMilestone. +Form request - validation rules for UpdateMilestone. ### `UpdateProjectBugRequest` -Form request — validation rules for UpdateProjectBug. +Form request - validation rules for UpdateProjectBug. ### `UpdateProjectRequest` -Form request — validation rules for UpdateProject. +Form request - validation rules for UpdateProject. ### `UpdateProjectTaskRequest` -Form request — validation rules for UpdateProjectTask. +Form request - validation rules for UpdateProjectTask. ## Providers diff --git a/docs-developer/50-reference/telegram.md b/docs-developer/50-reference/telegram.md index a07d047..1c396eb 100644 --- a/docs-developer/50-reference/telegram.md +++ b/docs-developer/50-reference/telegram.md @@ -15,7 +15,7 @@ Telegram notification integration module for the Zerp ERP platform ### `TelegramSettingsController` -HTTP controller — actions: index, store. +HTTP controller - actions: index, store. ## Listeners diff --git a/docs-developer/50-reference/timesheet.md b/docs-developer/50-reference/timesheet.md index 7195a64..6f98405 100644 --- a/docs-developer/50-reference/timesheet.md +++ b/docs-developer/50-reference/timesheet.md @@ -15,17 +15,17 @@ Employee timesheet tracking module for the Zerp ERP platform ### `Timesheet` -Eloquent model — 10 fillable fields, relations: user, project, task. +Eloquent model - 10 fillable fields, relations: user, project, task. ### `TimesheetUtility` -Eloquent model — 0 fillable fields. +Eloquent model - 0 fillable fields. ## Controllers ### `TimesheetController` -HTTP controller — actions: index, store, update, destroy, getAttendanceHours, fetchAttendanceHours, getRemainingHours. +HTTP controller - actions: index, store, update, destroy, getAttendanceHours, fetchAttendanceHours, getRemainingHours. ## Events @@ -51,11 +51,11 @@ Event listener. ### `StoreTimesheetRequest` -Form request — validation rules for StoreTimesheet. +Form request - validation rules for StoreTimesheet. ### `UpdateTimesheetRequest` -Form request — validation rules for UpdateTimesheet. +Form request - validation rules for UpdateTimesheet. ## Providers diff --git a/docs-developer/50-reference/training.md b/docs-developer/50-reference/training.md index 5c349ad..ef67ceb 100644 --- a/docs-developer/50-reference/training.md +++ b/docs-developer/50-reference/training.md @@ -15,45 +15,45 @@ Employee training management module for the Zerp ERP platform ### `Trainer` -Eloquent model — 10 fillable fields, relations: branch, department. +Eloquent model - 10 fillable fields, relations: branch, department. ### `Training` -Eloquent model — 16 fillable fields, relations: trainingType, trainer, branch, department, tasks. +Eloquent model - 16 fillable fields, relations: trainingType, trainer, branch, department, tasks. ### `TrainingFeedback` -Eloquent model — 6 fillable fields, relations: trainingTask, user. +Eloquent model - 6 fillable fields, relations: trainingTask, user. ### `TrainingTask` -Eloquent model — 8 fillable fields, relations: training, assignedUser, feedbacks. +Eloquent model - 8 fillable fields, relations: training, assignedUser, feedbacks. ### `TrainingType` -Eloquent model — 6 fillable fields, relations: branch, department. +Eloquent model - 6 fillable fields, relations: branch, department. ## Controllers ### `TrainerController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `TrainingController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ### `TrainingFeedbackController` -HTTP controller — actions: index, store. +HTTP controller - actions: index, store. ### `TrainingTaskController` -HTTP controller — actions: index, store, update, complete, destroy. +HTTP controller - actions: index, store, update, complete, destroy. ### `TrainingTypeController` -HTTP controller — actions: index, store, update, destroy. +HTTP controller - actions: index, store, update, destroy. ## Events @@ -113,39 +113,39 @@ Domain event. ### `StoreTrainerRequest` -Form request — validation rules for StoreTrainer. +Form request - validation rules for StoreTrainer. ### `StoreTrainingFeedbackRequest` -Form request — validation rules for StoreTrainingFeedback. +Form request - validation rules for StoreTrainingFeedback. ### `StoreTrainingRequest` -Form request — validation rules for StoreTraining. +Form request - validation rules for StoreTraining. ### `StoreTrainingTaskRequest` -Form request — validation rules for StoreTrainingTask. +Form request - validation rules for StoreTrainingTask. ### `StoreTrainingTypeRequest` -Form request — validation rules for StoreTrainingType. +Form request - validation rules for StoreTrainingType. ### `UpdateTrainerRequest` -Form request — validation rules for UpdateTrainer. +Form request - validation rules for UpdateTrainer. ### `UpdateTrainingRequest` -Form request — validation rules for UpdateTraining. +Form request - validation rules for UpdateTraining. ### `UpdateTrainingTaskRequest` -Form request — validation rules for UpdateTrainingTask. +Form request - validation rules for UpdateTrainingTask. ### `UpdateTrainingTypeRequest` -Form request — validation rules for UpdateTrainingType. +Form request - validation rules for UpdateTrainingType. ## Providers diff --git a/docs-developer/50-reference/twilio.md b/docs-developer/50-reference/twilio.md index 7487c63..3ab0d9e 100644 --- a/docs-developer/50-reference/twilio.md +++ b/docs-developer/50-reference/twilio.md @@ -15,7 +15,7 @@ Twilio SMS integration module for the Zerp ERP platform ### `TwilioSettingsController` -HTTP controller — actions: index, store. +HTTP controller - actions: index, store. ## Listeners diff --git a/docs-developer/50-reference/webhook.md b/docs-developer/50-reference/webhook.md index 0162a15..d82f1f9 100644 --- a/docs-developer/50-reference/webhook.md +++ b/docs-developer/50-reference/webhook.md @@ -15,17 +15,17 @@ Webhook management module for the Zerp ERP platform ### `Webhook` -Eloquent model — 6 fillable fields, relations: webhookModule, creator, createdBy. +Eloquent model - 6 fillable fields, relations: webhookModule, creator, createdBy. ### `WebhookModule` -Eloquent model — 3 fillable fields, relations: webhooks. +Eloquent model - 3 fillable fields, relations: webhooks. ## Controllers ### `WebhookController` -HTTP controller — actions: index, store, update, destroy, toggle. +HTTP controller - actions: index, store, update, destroy, toggle. ## Listeners diff --git a/docs-developer/50-reference/zoom-meeting.md b/docs-developer/50-reference/zoom-meeting.md index fc95117..c1814d3 100644 --- a/docs-developer/50-reference/zoom-meeting.md +++ b/docs-developer/50-reference/zoom-meeting.md @@ -15,17 +15,17 @@ Zoom meeting integration module for the Zerp ERP platform ### `ZoomMeeting` -Eloquent model — 17 fillable fields, relations: host. +Eloquent model - 17 fillable fields, relations: host. ## Controllers ### `ZoomMeetingController` -HTTP controller — actions: index, store, update, destroy, updateStatus. +HTTP controller - actions: index, store, update, destroy, updateStatus. ### `ZoomMeetingSettingsController` -HTTP controller — actions: update. +HTTP controller - actions: update. ## Events @@ -51,11 +51,11 @@ Event listener. ### `StoreZoomMeetingRequest` -Form request — validation rules for StoreZoomMeeting. +Form request - validation rules for StoreZoomMeeting. ### `UpdateZoomMeetingRequest` -Form request — validation rules for UpdateZoomMeeting. +Form request - validation rules for UpdateZoomMeeting. ## Providers diff --git a/docs-user/03-super-admin-access-and-capabilities.md b/docs-user/03-super-admin-access-and-capabilities.md index e9832e9..a776750 100644 --- a/docs-user/03-super-admin-access-and-capabilities.md +++ b/docs-user/03-super-admin-access-and-capabilities.md @@ -891,7 +891,7 @@ Toggle on or off the following email notification: Configure Google reCAPTCHA for form protection to prevent spam and automated submissions. - **Enable reCAPTCHA:** Toggle on to enable Google reCAPTCHA protection on forms. -- **reCAPTCHA Version:** Select the version to use — reCAPTCHA v2 (checkbox) or v3 (invisible). +- **reCAPTCHA Version:** Select the version to use - reCAPTCHA v2 (checkbox) or v3 (invisible). - **Site Key:** Enter the public site key from the Google reCAPTCHA console. - **Secret Key:** Enter the secret key from the Google reCAPTCHA console. - **To get your Google reCAPTCHA keys:** go to the Google reCAPTCHA Admin Console, click **“Create”** to create a new site, enter a label and select the reCAPTCHA type, add your domain to the domains list, accept the terms and submit, then copy the Site Key and Secret Key into the fields above. diff --git a/docs-user/08-sales-invoice.md b/docs-user/08-sales-invoice.md index 3994035..33960fe 100644 --- a/docs-user/08-sales-invoice.md +++ b/docs-user/08-sales-invoice.md @@ -30,7 +30,7 @@ The table displays the following columns: - **Tax:** The tax amount applied to the invoice. - **Total Amount:** The final amount, including tax. - **Balance:** The remaining unpaid balance. -- **Status:** The current status of the invoice — Draft, Posted, or Paid. +- **Status:** The current status of the invoice - Draft, Posted, or Paid. - **Actions:** Quick action buttons that vary depending on the invoice status. Action icons available per invoice: @@ -50,7 +50,7 @@ At the top right of the Sales Invoice Details section, select the invoice type: - **Product-wise:** Use this when the invoice is for physical products. - **Service Wise:** Use this when the invoice is for services rendered. -##### Create Sales Invoice — Product Wise +##### Create Sales Invoice - Product Wise ###### Sales Invoice Details: @@ -82,7 +82,7 @@ At the top right of the Sales Invoice Details section, select the invoice type: - **Tax:** Total tax applied. - **Total:** Final payable amount. -##### Create Sales Invoice — Service Wise +##### Create Sales Invoice - Service Wise ###### Sales Invoice Details: @@ -136,7 +136,7 @@ The table displays the following columns: - **Return Date:** The date the return was created. - **Total Amount:** The total value of the returned items. - **Items:** The name of the returned product. -- **Status:** The current status of the return — Draft, Approved, or Completed. +- **Status:** The current status of the return - Draft, Approved, or Completed. - **Actions:** Quick action buttons that vary depending on the return status. Action icons available per return: diff --git a/docs-user/09-purchase-management.md b/docs-user/09-purchase-management.md index 760f433..cfc4d1e 100644 --- a/docs-user/09-purchase-management.md +++ b/docs-user/09-purchase-management.md @@ -98,7 +98,7 @@ The table displays the following columns: - **Return Date:** The date the return was created. - **Total Amount:** The total value of the returned items. - **Items:** The name and quantity of the returned products. -- **Status:** The current status of the return — Draft, Approved, or Completed. +- **Status:** The current status of the return - Draft, Approved, or Completed. - **Actions:** Quick action buttons that vary depending on the return status. Action icons available per return: diff --git a/docs-user/17-hrm-management.md b/docs-user/17-hrm-management.md index bd468fe..166298a 100644 --- a/docs-user/17-hrm-management.md +++ b/docs-user/17-hrm-management.md @@ -8,7 +8,7 @@ The HRM (Human Resource Management) module gives your organisation complete cont - Click **“Create”** to create a new employee, which will open the Create Employee form. This form is divided into six tabs that must be completed in order: Personal, Employment, Contact, Banking, Hours & Rates, and Documents. Click Next to proceed to the next tab and Previous to go back. - On the Personal tab, the Employee ID is auto-generated by the system. You need to enter the Date of Birth and select the Gender (Male, Female, or Other). -- On the Employment tab, you need to enter the User (only company users are applicable), Shift, Employment Type (default is Full Time — options include Full Time, Part Time, Temporary, and Contract), and Date of Joining. Select the Branch first, then Department (which depends on the selected Branch), and then Designation (which depends on the selected Department). +- On the Employment tab, you need to enter the User (only company users are applicable), Shift, Employment Type (default is Full Time - options include Full Time, Part Time, Temporary, and Contract), and Date of Joining. Select the Branch first, then Department (which depends on the selected Branch), and then Designation (which depends on the selected Department). - On the Contact tab, you need to enter the full residential address, including Address Line 1, City, State, Country, and Postal Code. You must also provide Emergency Contact Name, Emergency Contact Relationship, and Emergency Contact Number (include country code, e.g., +11233567890). Address Line 2 is optional. - On the Banking tab, you need to enter the Bank Name, Account Holder Name, Account Number, Bank Identifier Code, and Bank Branch. Tax Payer ID is optional. - On the Hours & Rates tab, you need to enter the Basic Salary, Hours Per Day, Days Per Week, and Rate Per Hour. @@ -85,7 +85,7 @@ Below the summary, the Employee Salary Details table provides a row-by-row break - You may also add Clock Out Time (if the employee has already clocked out) and optional Notes for any relevant remarks about this attendance record. - The Manage Attendances page displays a complete log of employee attendance, showing Employee Name, Date, Shift, Clock In Time, Clock Out Time, Total Hours, Break Hours, Overtime, and Status. - Use the Search bar or filters (Employee, Status, Date From, Date To) to locate specific attendance records. Click Apply to filter and Clear to reset. -- Attendance statuses are color-coded: Present (green — employee completed the shift), Absent (red — employee did not clock in), and Half Day (yellow — employee worked less than the required shift hours). +- Attendance statuses are color-coded: Present (green - employee completed the shift), Absent (red - employee did not clock in), and Half Day (yellow - employee worked less than the required shift hours). - All attendance records can be Viewed, Edited, or Deleted using the action icons. ### 17.4 Leave Management @@ -107,7 +107,7 @@ Below the summary, the Employee Salary Details table provides a row-by-row break #### 17.4.3 Leave Balance - The **Leave Balance** page provides a real-time overview of each employee’s leave entitlement across all leave types. Each employee is displayed as a separate card showing their name and a breakdown of every leave type with three columns: **Total** (maximum days allowed per year), **Used** (days already taken, shown in red), and **Available** (remaining days, shown in green). -- This page is automatically updated whenever a leave application is approved — no manual entry is required. Use this page to quickly check how many leave days any employee has remaining before approving a new leave request. +- This page is automatically updated whenever a leave application is approved - no manual entry is required. Use this page to quickly check how many leave days any employee has remaining before approving a new leave request. ### 17.5 Manage Holidays @@ -191,20 +191,20 @@ Below the summary, the Employee Salary Details table provides a row-by-row break The System Setup section allows administrators to configure foundational data used throughout the system. It is accessible from the left-side navigation panel and includes the following sections: Branches, Departments, Designations, Document Types, Award Types, Termination Types, Warning Types, Complaint Types, Holiday Types, Document Categories, Announcement Categories, Event Types, Allowance Types, Deduction Types, Loan Types, Working Days, and IP Restricts. Each section lists existing entries and provides Edit and Delete action icons for managing records. -- **Branches** — Displays a list of all branches with their Branch Name. Click **“Create”** to open the Create Branch form, where you enter the Branch Name and click Create. -- **Departments** — Displays all departments with their Department Name and associated Branch. Click **“Create”** to open the Create Department form, where you enter the Department Name and select a Branch, then click Create. -- **Designations** — Displays all designations with their Designation Name, Branch, and Department. Click **“Create”** to open the Create Designation form, where you enter the Designation Name, select a Branch, and then select a Department. Note that a Branch must be selected first before the Department dropdown becomes available. -- **Document Types** — Displays all document types with their Document Name, Description, and whether the document Is Required. Click **“Create”** to open the Document Type form, where you enter the Document Name, an optional Description, and toggle the Is Required switch as needed, then click Create. -- **Award Types** — Displays all award types with their Name and Description. Click **“Create”** to open the Create Award Type form, where you enter the Name and an optional Description, then click Create. -- **Termination Types** — Displays all termination types with their Termination Type name. Click **“Create”** to add a new termination type. All entries can be Edited and Deleted using the action icons. -- **Warning Types** — Displays all warning types with their Warning Type Name. Click **“Create”** to open the Create Warning Type form, where you enter the Warning Type Name and click Create. All entries can be Edited and Deleted using the action icons. -- **Complaint Types** — Displays all complaint types with their Complaint Type name. Click **“Create”** to open the Create Complaint Type form, where you enter the Complaint Type and click Create. All entries can be Edited and Deleted using the action icons. -- **Holiday Types** — Displays all holiday types with their Holiday Type name. Click **“Create”** to open the Create Holiday Type form, where you enter the Holiday Type and click Create. All entries can be Edited and Deleted using the action icons. -- **Document Categories** — Displays all document categories with their Document Type name and Status (Enabled or Disabled). Click **“Create”** to open the Create Document Category form, where you enter the Document Type name and toggle the Enable/Disable switch to set its status, then click Create. All entries can be Edited and Deleted using the action icons. -- **Announcement Categories** — Displays all announcement categories with their Announcement Category name. Click **“Create”** to open the Create Announcement Category form, where you enter the Announcement Category and click Create. All entries can be Edited and Deleted using the action icons. -- **Event Types** — Displays all event types with their Event Type name. Click **“Create”** to open the Create Event Type form, where you enter the Event Type and click Create. All entries can be Edited and Deleted using the action icons. -- **Allowance Types** — Displays all allowance types with their Name and Description. Click **“Create”** to open the Create Allowance Type form, where you enter the Name and an optional Description, then click Create. All entries can be Edited and Deleted using the action icons. -- **Deduction Types** — Displays all deduction types with their Name and Description. Click **“Create”** to open the Create Deduction Type form, where you enter the Name and an optional Description, then click Create. All entries can be Edited and Deleted using the action icons. -- **Loan Types** — Displays all loan types with their Name and Description. Click **“Create”** to open the Create Loan Type form, where you enter the Name and an optional Description, then click Create. All entries can be Edited and Deleted using the action icons. -- **Working Days** — Allows administrators to define the working days for the organization. Check or uncheck the boxes next to each day of the week (Monday through Sunday) to mark them as working days. Click Save to apply the changes. -- **IP Restricts** — Displays a list of allowed IP addresses with their IP value. Use the IP Restrict toggle at the top right to turn IP restriction On or Off for the entire system. Click **“Create”** to open the Create IP Restrict form, where you enter the IP address and click Create. All IP entries can be Edited and Deleted using the action icons. +- **Branches** - Displays a list of all branches with their Branch Name. Click **“Create”** to open the Create Branch form, where you enter the Branch Name and click Create. +- **Departments** - Displays all departments with their Department Name and associated Branch. Click **“Create”** to open the Create Department form, where you enter the Department Name and select a Branch, then click Create. +- **Designations** - Displays all designations with their Designation Name, Branch, and Department. Click **“Create”** to open the Create Designation form, where you enter the Designation Name, select a Branch, and then select a Department. Note that a Branch must be selected first before the Department dropdown becomes available. +- **Document Types** - Displays all document types with their Document Name, Description, and whether the document Is Required. Click **“Create”** to open the Document Type form, where you enter the Document Name, an optional Description, and toggle the Is Required switch as needed, then click Create. +- **Award Types** - Displays all award types with their Name and Description. Click **“Create”** to open the Create Award Type form, where you enter the Name and an optional Description, then click Create. +- **Termination Types** - Displays all termination types with their Termination Type name. Click **“Create”** to add a new termination type. All entries can be Edited and Deleted using the action icons. +- **Warning Types** - Displays all warning types with their Warning Type Name. Click **“Create”** to open the Create Warning Type form, where you enter the Warning Type Name and click Create. All entries can be Edited and Deleted using the action icons. +- **Complaint Types** - Displays all complaint types with their Complaint Type name. Click **“Create”** to open the Create Complaint Type form, where you enter the Complaint Type and click Create. All entries can be Edited and Deleted using the action icons. +- **Holiday Types** - Displays all holiday types with their Holiday Type name. Click **“Create”** to open the Create Holiday Type form, where you enter the Holiday Type and click Create. All entries can be Edited and Deleted using the action icons. +- **Document Categories** - Displays all document categories with their Document Type name and Status (Enabled or Disabled). Click **“Create”** to open the Create Document Category form, where you enter the Document Type name and toggle the Enable/Disable switch to set its status, then click Create. All entries can be Edited and Deleted using the action icons. +- **Announcement Categories** - Displays all announcement categories with their Announcement Category name. Click **“Create”** to open the Create Announcement Category form, where you enter the Announcement Category and click Create. All entries can be Edited and Deleted using the action icons. +- **Event Types** - Displays all event types with their Event Type name. Click **“Create”** to open the Create Event Type form, where you enter the Event Type and click Create. All entries can be Edited and Deleted using the action icons. +- **Allowance Types** - Displays all allowance types with their Name and Description. Click **“Create”** to open the Create Allowance Type form, where you enter the Name and an optional Description, then click Create. All entries can be Edited and Deleted using the action icons. +- **Deduction Types** - Displays all deduction types with their Name and Description. Click **“Create”** to open the Create Deduction Type form, where you enter the Name and an optional Description, then click Create. All entries can be Edited and Deleted using the action icons. +- **Loan Types** - Displays all loan types with their Name and Description. Click **“Create”** to open the Create Loan Type form, where you enter the Name and an optional Description, then click Create. All entries can be Edited and Deleted using the action icons. +- **Working Days** - Allows administrators to define the working days for the organization. Check or uncheck the boxes next to each day of the week (Monday through Sunday) to mark them as working days. Click Save to apply the changes. +- **IP Restricts** - Displays a list of allowed IP addresses with their IP value. Use the IP Restrict toggle at the top right to turn IP restriction On or Off for the entire system. Click **“Create”** to open the Create IP Restrict form, where you enter the IP address and click Create. All IP entries can be Edited and Deleted using the action icons. diff --git a/docs-user/18-performance-management.md b/docs-user/18-performance-management.md index fb98399..c9f88ac 100644 --- a/docs-user/18-performance-management.md +++ b/docs-user/18-performance-management.md @@ -34,5 +34,5 @@ The Performance Management module gives your organisation a structured way to me The Performance System Setup section allows administrators to configure the foundational data used in the Performance module. It includes two sections accessible from the left-side navigation panel: Indicator Categories and Goal Types. -- **Indicator Categories** — Displays all indicator categories with their Name, Description, and Status. Click **“Create”** to open the Create Indicator Category form, where you enter the Name, an optional Description, and set the Status, then click Create. All entries can be Edited and Deleted using the action icons. -- **Goal Types** — Displays all goal types with their Name, Description, and Status. Click **“Create”** to open the Create Goal Type form, where you enter the Name, an optional Description, and set the Status, then click Create. All entries can be Edited and Deleted using the action icons. +- **Indicator Categories** - Displays all indicator categories with their Name, Description, and Status. Click **“Create”** to open the Create Indicator Category form, where you enter the Name, an optional Description, and set the Status, then click Create. All entries can be Edited and Deleted using the action icons. +- **Goal Types** - Displays all goal types with their Name, Description, and Status. Click **“Create”** to open the Create Goal Type form, where you enter the Name, an optional Description, and set the Status, then click Create. All entries can be Edited and Deleted using the action icons. diff --git a/docs-user/20-recruitment-management.md b/docs-user/20-recruitment-management.md index 4295c42..0042c07 100644 --- a/docs-user/20-recruitment-management.md +++ b/docs-user/20-recruitment-management.md @@ -112,26 +112,26 @@ The Recruitment Management module helps your team handle the entire hiring proce The Recruitment System Setup section allows administrators to configure the foundational data used in the Recruitment module. It includes multiple sections accessible from the left-side navigation panel: Job Types, Candidate Sources, Interview Types, Onboarding Checklists, Brand Settings, About Company Section, Application Tips Section, What Happens Next Section, Need Help Section, Tracking FAQ, and Offer Letter Template. -- **Job Types** — Displays all job types with their Name, Description, and Is Active status. Click **“Create”** to open the Create Job Type form, where you enter the Name, an optional Description, and toggle Is Active, then click Create. All entries can be Edited and Deleted using the action icons. +- **Job Types** - Displays all job types with their Name, Description, and Is Active status. Click **“Create”** to open the Create Job Type form, where you enter the Name, an optional Description, and toggle Is Active, then click Create. All entries can be Edited and Deleted using the action icons. - Once saved, these job types will appear in the Job Type dropdown when creating Job Postings, allowing you to specify the employment arrangement for each position. -- **Candidate Sources** — Displays all candidate sources with their Name, Description, and Is Active status. Click **“Create”** to open the Create Candidate Sources form, where you enter the Name, an optional Description, and toggle Is Active, then click Create. All entries can be Edited and Deleted using the action icons. +- **Candidate Sources** - Displays all candidate sources with their Name, Description, and Is Active status. Click **“Create”** to open the Create Candidate Sources form, where you enter the Name, an optional Description, and toggle Is Active, then click Create. All entries can be Edited and Deleted using the action icons. - Once saved, these candidate sources will appear in the Candidate Source dropdown when adding candidates in the Manage Candidate section, helping you track where your applicants are coming from. -- **Interview Types** — Displays all interview types with their Name, Description, and Is Active status. Click **“Create”** to open the Create Interview Type form, where you enter the Name, an optional Description, and toggle Is Active, then click Create. All entries can be Edited and Deleted using the action icons. +- **Interview Types** - Displays all interview types with their Name, Description, and Is Active status. Click **“Create”** to open the Create Interview Type form, where you enter the Name, an optional Description, and toggle Is Active, then click Create. All entries can be Edited and Deleted using the action icons. - Once saved, these interview types will appear in the Interview Type dropdown when scheduling interviews in the Manage Interview section, allowing you to specify the format of each interview. -- **Onboarding Checklists** — Displays all onboarding checklists with their Name, Items count, Is Default status, and Status. Click **“Create”** to open the Create Onboarding Checklist form, where you enter the Name, an optional Description, toggle Is Default, and set the Status, then click Create. All entries can be Viewed, Edited, and Deleted using the action icons. +- **Onboarding Checklists** - Displays all onboarding checklists with their Name, Items count, Is Default status, and Status. Click **“Create”** to open the Create Onboarding Checklist form, where you enter the Name, an optional Description, toggle Is Default, and set the Status, then click Create. All entries can be Viewed, Edited, and Deleted using the action icons. - Once saved, these onboarding checklists will appear in the dropdown when creating Checklist Items and when starting Candidate Onboarding, providing structured task lists for new employee integration. -- **Brand Settings** — Allows administrators to configure the recruitment portal’s branding by uploading a Logo and Favicon, and entering the Title Text and Footer Text. This page also includes the Dashboard Welcome Card Settings section, where administrators can configure the Card Title, Card Description, Button Text, and Button Icon displayed on the recruitment dashboard. Click **“Save Changes”** in each section to apply the updates. +- **Brand Settings** - Allows administrators to configure the recruitment portal’s branding by uploading a Logo and Favicon, and entering the Title Text and Footer Text. This page also includes the Dashboard Welcome Card Settings section, where administrators can configure the Card Title, Card Description, Button Text, and Button Icon displayed on the recruitment dashboard. Click **“Save Changes”** in each section to apply the updates. - Once saved, your Company Logo and Favicon will appear throughout your career portal website. The Title Text will display in the header section, while the Footer Text will automatically appear at the bottom of every page on your frontend career portal, creating a consistent branded experience for candidates visiting your job site. - The welcome card will appear on your dashboard with your customised title and description. The button will display with your chosen text and icon, providing users with a clear call-to-action to access your career portal or other key features directly from the dashboard home screen. -- **About Company Section** — Allows administrators to define the company’s public-facing profile by entering the Our Mission statement, Company Size, and Industry. Click **“Save Changes”** to apply the updates. +- **About Company Section** - Allows administrators to define the company’s public-facing profile by entering the Our Mission statement, Company Size, and Industry. Click **“Save Changes”** to apply the updates. - Once saved, this information will automatically display in the About the Company section on the Job Details Page of your frontend career portal, giving candidates insight into your organisation when they view job openings. -- **Application Tips Section** — Allows administrators to add and manage tips displayed to applicants during the application process. Each tip has an individual text field with a character limit. Click **“Add Tip”** to add a new tip, and use the delete icon to remove any existing tip. Click **“Save Changes”** to apply the updates. +- **Application Tips Section** - Allows administrators to add and manage tips displayed to applicants during the application process. Each tip has an individual text field with a character limit. Click **“Add Tip”** to add a new tip, and use the delete icon to remove any existing tip. Click **“Save Changes”** to apply the updates. - Once saved, these application tips will automatically display on the Job Application Page of your frontend career portal, guiding candidates on how to submit strong applications. -- **What Happens Next Section** — Allows administrators to configure the step-by-step process shown to applicants after they submit an application. Each step includes a Title, Icon, and Description. Click **“Add Step”** to add more steps, and click **“Save Changes”** to apply the updates. +- **What Happens Next Section** - Allows administrators to configure the step-by-step process shown to applicants after they submit an application. Each step includes a Title, Icon, and Description. Click **“Add Step”** to add more steps, and click **“Save Changes”** to apply the updates. - Once saved, this information will automatically display on the Application Success Page of your frontend career portal after candidates submit their applications, helping them understand the timeline and next steps in your recruitment process. -- **Need Help Section** — Allows administrators to configure the support information displayed to applicants, including a Description, Email, and Phone number. Click **“Save Changes”** to apply the updates. +- **Need Help Section** - Allows administrators to configure the support information displayed to applicants, including a Description, Email, and Phone number. Click **“Save Changes”** to apply the updates. - Once saved, this contact information will automatically display in the Need Help section on both the Application Success Page and Application Details Page of your frontend career portal, giving candidates a way to reach out if they have questions about their application. -- **Tracking FAQ** — Allows administrators to manage frequently asked questions related to application tracking. Each FAQ entry includes a Question and an Answer. Click **“+ Add FAQ”** to add new entries, and use the delete icon to remove any existing entry. Click **“Save Changes”** to apply the updates. +- **Tracking FAQ** - Allows administrators to manage frequently asked questions related to application tracking. Each FAQ entry includes a Question and an Answer. Click **“+ Add FAQ”** to add new entries, and use the delete icon to remove any existing entry. Click **“Save Changes”** to apply the updates. - Once saved, these FAQs will automatically display on the Application Tracking Page of your frontend career portal, helping candidates understand how to track and what to expect from their application status. -- **Offer Letter Template** — Allows administrators to configure the default offer letter template using available placeholders such as Applicant Name, Job Title, Salary, Start Date, and more. The template content can be formatted using the built-in text editor. A language selector is available to manage templates in multiple languages. Click **“Save Changes”** to apply the updates. +- **Offer Letter Template** - Allows administrators to configure the default offer letter template using available placeholders such as Applicant Name, Job Title, Salary, Start Date, and more. The template content can be formatted using the built-in text editor. A language selector is available to manage templates in multiple languages. Click **“Save Changes”** to apply the updates. - Once saved, this template will be used when you click Send Offer Letter or Download Offer Letter from the Manage Offer section, automatically generating personalised offer letters for candidates with their specific details filled in. diff --git a/docs-user/22-crm-management.md b/docs-user/22-crm-management.md index 2e7165d..6f42d64 100644 --- a/docs-user/22-crm-management.md +++ b/docs-user/22-crm-management.md @@ -8,18 +8,18 @@ The CRM (Customer Relationship Management) module helps your team track and mana The CRM System Setup section allows administrators to configure the foundational data used in the CRM module. It includes five sections accessible from the left-side navigation panel: Pipelines, Lead Stages, Deal Stages, Labels, and Sources. -- **Pipelines** — Displays all pipelines with their Name and Action columns. Click **“Create”** to open the Create Pipeline form, where you enter the Name, then click Create. All entries can be Edited and Deleted using the action icons. -- **Lead Stages** — Displays all lead stages organized by pipeline tabs. Switch between available pipelines using the tabs at the top to view their respective stages. Each stage is displayed with a numbered order indicator and can be reordered using the drag handle. Click **“Create”** to open the Create Lead Stage form, where you enter the Name and select the Pipeline from a dropdown, then click Create. All entries can be Edited and Deleted using the action icons. -- **Deal Stages** — Displays all deal stages organized by pipeline tabs. Switch between available pipelines using the tabs at the top to view their respective stages. Each stage is displayed with a numbered order indicator and can be reordered using the drag handle. Click **“Create”** to open the Create Deal Stage form, where you enter the Name and select the Pipeline from a dropdown, then click Create. All entries can be Edited and Deleted using the action icons. -- **Labels** — Displays all labels organized by pipeline tabs. Switch between available pipelines using the tabs at the top to view their respective labels. Each label is displayed as a colored badge. Click **“Create”** to open the Create Label form, where you enter the Name, select the Pipeline from a dropdown, and choose a Color for the label, then click Create. All entries can be Edited and Deleted using the action icons. -- **Sources** — Displays all lead sources with their Source name and Action columns. Click **“Create”** to open the Create Source form, where you enter the Name, then click Create. All entries can be Edited and Deleted using the action icons. +- **Pipelines** - Displays all pipelines with their Name and Action columns. Click **“Create”** to open the Create Pipeline form, where you enter the Name, then click Create. All entries can be Edited and Deleted using the action icons. +- **Lead Stages** - Displays all lead stages organized by pipeline tabs. Switch between available pipelines using the tabs at the top to view their respective stages. Each stage is displayed with a numbered order indicator and can be reordered using the drag handle. Click **“Create”** to open the Create Lead Stage form, where you enter the Name and select the Pipeline from a dropdown, then click Create. All entries can be Edited and Deleted using the action icons. +- **Deal Stages** - Displays all deal stages organized by pipeline tabs. Switch between available pipelines using the tabs at the top to view their respective stages. Each stage is displayed with a numbered order indicator and can be reordered using the drag handle. Click **“Create”** to open the Create Deal Stage form, where you enter the Name and select the Pipeline from a dropdown, then click Create. All entries can be Edited and Deleted using the action icons. +- **Labels** - Displays all labels organized by pipeline tabs. Switch between available pipelines using the tabs at the top to view their respective labels. Each label is displayed as a colored badge. Click **“Create”** to open the Create Label form, where you enter the Name, select the Pipeline from a dropdown, and choose a Color for the label, then click Create. All entries can be Edited and Deleted using the action icons. +- **Sources** - Displays all lead sources with their Source name and Action columns. Click **“Create”** to open the Create Source form, where you enter the Name, then click Create. All entries can be Edited and Deleted using the action icons. ### 22.2 Manage Leads - To view all your leads, go to the Manage Leads page. If your company uses different sales pipelines (like **“Marketing”** or **“Lead Qualification”**), you can switch between them using the dropdown at the top right. You can also change how the list looks by clicking the Kanban View icon, this lets you see your leads as cards on a board instead of rows in a table. - To add a new lead, click the **“Create”** button. A form will appear where you fill in the lead’s Name, Email, what the lead is about (Subject), and which team member is responsible (User). You can also add a Phone Number and a Follow Up Date as a reminder to check back with the lead. Once done, click Create. - The leads page shows all your leads in a list with key details like their name, what they’re interested in, which stage they’re at in the sales process, how many tasks are linked to them, and when you need to follow up. You can search for a specific lead using the search bar, or narrow down the list by filtering by team member or stage. Click Apply to see the filtered results, or Clear to go back to the full list. -- For each lead in the list, you have a few quick action options. Click View to open the full details of that lead. Click the Label icon to tag the lead with a colored label (like **“MQL Ready”** or **“Form Submitted”**) to help you organize and identify leads at a glance — select the labels you want and click Save. You can also Edit a lead to update its information, or Delete it if it’s no longer needed. +- For each lead in the list, you have a few quick action options. Click View to open the full details of that lead. Click the Label icon to tag the lead with a colored label (like **“MQL Ready”** or **“Form Submitted”**) to help you organize and identify leads at a glance - select the labels you want and click Save. You can also Edit a lead to update its information, or Delete it if it’s no longer needed. ### 22.3 Manage Deals diff --git a/docs/superpowers/plans/2026-07-10-zerp-1.0-release-and-dev-docs.md b/docs/superpowers/plans/2026-07-10-zerp-1.0-release-and-dev-docs.md index 2f3c2e2..2c317e0 100644 --- a/docs/superpowers/plans/2026-07-10-zerp-1.0-release-and-dev-docs.md +++ b/docs/superpowers/plans/2026-07-10-zerp-1.0-release-and-dev-docs.md @@ -6,7 +6,7 @@ **Architecture:** A single Node script in `zerp-docs/` shallow-parses each sibling `ZerpPackages/*/src` tree and emits committed Markdown reference pages (descriptions synthesized from structure, since <1% of classes have docblocks). Existing dev pages move into folders so the autogenerated Docusaurus sidebar renders sections. The release is git tag + GitHub Release on the main app. -**Tech Stack:** Node 24 (ESM, no test framework — self-check via `--selfcheck` assert block), Docusaurus 3.10, git/gh. +**Tech Stack:** Node 24 (ESM, no test framework - self-check via `--selfcheck` assert block), Docusaurus 3.10, git/gh. ## Global Constraints @@ -15,18 +15,18 @@ - Do not modify or commit `zerp/.env`. - Do not re-tag or version-bump any of the 33 packages (already at `v1.0.x`, immutable). - Generated reference `.md` files are committed to git (Pages builds without `ZerpPackages/` present). -- Reference covers PHP classes only — exclude Migrations and React/TS resources. +- Reference covers PHP classes only - exclude Migrations and React/TS resources. - All paths are absolute from `/home/hafiz/Projects/ZERP/`. --- ## File Structure -- `zerp-docs/scripts/gen-package-reference.mjs` — the generator + self-check (single file, one responsibility: source → markdown). -- `zerp-docs/package.json` — add `gen:reference` script. -- `zerp-docs/docs-developer/{10-getting-started,20-architecture,30-guides}/` — relocated existing pages + `_category_.json`. -- `zerp-docs/docs-developer/50-reference/` — generated `index.md`, `.md` × 33, `_category_.json`. -- `zerp/CHANGELOG.md` — release notes source. +- `zerp-docs/scripts/gen-package-reference.mjs` - the generator + self-check (single file, one responsibility: source → markdown). +- `zerp-docs/package.json` - add `gen:reference` script. +- `zerp-docs/docs-developer/{10-getting-started,20-architecture,30-guides}/` - relocated existing pages + `_category_.json`. +- `zerp-docs/docs-developer/50-reference/` - generated `index.md`, `.md` × 33, `_category_.json`. +- `zerp/CHANGELOG.md` - release notes source. --- @@ -88,7 +88,7 @@ if (process.argv.includes('--selfcheck')) selfcheck(); - [ ] **Step 2: Run it to verify it fails** Run: `cd /home/hafiz/Projects/ZERP/zerp-docs && node scripts/gen-package-reference.mjs --selfcheck` -Expected: FAIL — `AssertionError` (info is null / `Cannot read properties of null`). +Expected: FAIL - `AssertionError` (info is null / `Cannot read properties of null`). - [ ] **Step 3: Implement `parsePhp` + `describe`** @@ -116,18 +116,18 @@ export function describe(info) { const top = info.kind.split('/').pop(); if (top === 'Models') { const rel = info.relations.length ? `, relations: ${info.relations.join(', ')}` : ''; - return `Eloquent model — ${info.fillable.length} fillable field${info.fillable.length === 1 ? '' : 's'}${rel}.`; + return `Eloquent model - ${info.fillable.length} fillable field${info.fillable.length === 1 ? '' : 's'}${rel}.`; } if (top.endsWith('Controllers') || info.kind.includes('Controllers')) { - return `HTTP controller — actions: ${info.methods.join(', ') || '—'}.`; + return `HTTP controller - actions: ${info.methods.join(', ') || 'none'}.`; } - if (top === 'Requests') return `Form request — validation rules for ${info.name.replace(/Request$/, '')}.`; + if (top === 'Requests') return `Form request - validation rules for ${info.name.replace(/Request$/, '')}.`; if (top === 'Events') return `Domain event.`; if (top === 'Listeners') return `Event listener.`; if (top === 'Seeders') return `Database seeder.`; if (top === 'Providers') return `Service provider.`; const ext = info.extends ? ` (extends ${info.extends})` : ''; - return `${top} class${ext} — methods: ${info.methods.join(', ') || '—'}.`; + return `${top} class${ext} - methods: ${info.methods.join(', ') || 'none'}.`; } ``` @@ -230,7 +230,7 @@ In `zerp-docs/package.json` scripts, add: `"gen:reference": "node scripts/gen-pa Run: `cd /home/hafiz/Projects/ZERP/zerp-docs && npm run gen:reference` Expected: `Generated 33 package pages + index.` and `docs-developer/50-reference/` contains `index.md`, `_category_.json`, and 33 `.md` files. -Spot-check: `sed -n '1,30p' docs-developer/50-reference/lead.md` shows Models with `Eloquent model — N fillable fields, relations: ...`. +Spot-check: `sed -n '1,30p' docs-developer/50-reference/lead.md` shows Models with `Eloquent model - N fillable fields, relations: ...`. - [ ] **Step 8: Commit** @@ -345,9 +345,9 @@ Create `zerp/CHANGELOG.md`: ```markdown # Changelog -## v1.0.0 — 2026-07-10 +## v1.0.0 - 2026-07-10 -First stable release of Zerp — an open, modular ERP platform. +First stable release of Zerp - an open, modular ERP platform. ### Core - Multi-company ERP core: authentication, roles/permissions, plan & module gating, media library. @@ -408,6 +408,6 @@ No action if nothing changed in docs for the release. Done. - 1.0 release (changelog, tag, GitHub Release, I publish) → Task 4. ✓ - Global constraints (no brand/coauthor, don't touch .env, don't re-tag packages, PHP-only) → Global Constraints + enforced in tasks. ✓ -**Placeholder scan:** No TBD/TODO; all code shown; self-check has real asserts. Step 3 of Task 2 references a grep to find links rather than hardcoding every one — acceptable because the exact set is discovered at runtime, and the two known cases are named explicitly. ✓ +**Placeholder scan:** No TBD/TODO; all code shown; self-check has real asserts. Step 3 of Task 2 references a grep to find links rather than hardcoding every one - acceptable because the exact set is discovered at runtime, and the two known cases are named explicitly. ✓ **Type consistency:** `parsePhp`/`describe` signatures identical across self-check (Task 1 Step 1) and implementation (Step 3); `kind` values match `INCLUDE` keys and `GROUP_LABEL` keys. ✓ diff --git a/docs/superpowers/specs/2026-07-10-zerp-1.0-release-and-dev-docs-design.md b/docs/superpowers/specs/2026-07-10-zerp-1.0-release-and-dev-docs-design.md index f6c47cf..0292d29 100644 --- a/docs/superpowers/specs/2026-07-10-zerp-1.0-release-and-dev-docs-design.md +++ b/docs/superpowers/specs/2026-07-10-zerp-1.0-release-and-dev-docs-design.md @@ -1,4 +1,4 @@ -# Zerp 1.0 Release + Developer-Docs Overhaul — Design +# Zerp 1.0 Release + Developer-Docs Overhaul - Design **Date:** 2026-07-10 **Status:** Approved (design), pending implementation plan @@ -7,9 +7,9 @@ Three deliverables: -1. **Zerp 1.0 release** — tag the main app `v1.0.0`, cut a GitHub Release with notes. Publish it (run the git/gh commands). -2. **Developer-docs restructure** — group the existing 7 dev pages into labeled sidebar sections; no theme/color rewrite. -3. **Per-package class reference** — an auto-generated, committed Markdown reference (one page per `zerp/*` package, 33 packages) inside the developer docs. +1. **Zerp 1.0 release** - tag the main app `v1.0.0`, cut a GitHub Release with notes. Publish it (run the git/gh commands). +2. **Developer-docs restructure** - group the existing 7 dev pages into labeled sidebar sections; no theme/color rewrite. +3. **Per-package class reference** - an auto-generated, committed Markdown reference (one page per `zerp/*` package, 33 packages) inside the developer docs. ## Key findings from exploration @@ -18,15 +18,15 @@ Three deliverables: - **Docblocks are effectively absent:** 2 of 716 sampled classes (lead, account, restaurant, pos, hrm) have a class-level docblock (0.3%). **The reference must synthesize each class's description from structure, not prose.** - **Structure is richly extractable:** models expose `$fillable`, `casts()`, relationship methods; controllers expose public action methods with typed `Request` params; events/listeners pair up. This is enough to describe every class usefully. - **Versions:** packages already carry git tags `v1.0.0` / `v1.0.1`. Main app (`github.com/zerp-pk/zerp`, branch `main`, last commit `fbc110e`) has **no tags**. `.env` is dirty (do not touch/commit it). -- **Docs config:** two Docusaurus doc instances — `docs-user` (`routeBasePath: docs`) and `developer` (`path: docs-developer`, `routeBasePath: developer`). Developer sidebar is `{type: 'autogenerated', dirName: '.'}`, so **folder structure = sidebar structure**. +- **Docs config:** two Docusaurus doc instances - `docs-user` (`routeBasePath: docs`) and `developer` (`path: docs-developer`, `routeBasePath: developer`). Developer sidebar is `{type: 'autogenerated', dirName: '.'}`, so **folder structure = sidebar structure**. -## Piece 1 — Class-reference generator +## Piece 1 - Class-reference generator **Location:** `zerp-docs/scripts/gen-package-reference.mjs`, wired as `npm run gen:reference` in `zerp-docs/package.json`. Node, because the docs toolchain is already Node. **Input:** `../ZerpPackages/*/src` (siblings) + each package's `composer.json` and `module.json`. -**Parse (shallow, per `.php` file — no autoloading, no PHP AST):** +**Parse (shallow, per `.php` file - no autoloading, no PHP AST):** - `namespace`, class name, `extends` / `implements`. - `public function` signatures (name + param type hints). - For models: `$fillable` entries, `casts()` keys, relationship methods (public method whose body returns `belongsTo|hasMany|hasOne|belongsToMany|morph*`). @@ -41,9 +41,9 @@ Three deliverables: **Grouping:** classes bucketed by their top `src/` folder (Models, Controllers, Api Controllers, Events, Listeners, Requests, Providers, Support, Seeders). Migrations and React/TS resources are **excluded** from the class reference (migrations are schema, not classes; JS is out of scope). **Output (committed to git):** -- `docs-developer/50-reference/index.md` — package index: table of all 33 packages with title, description, class counts, link. -- `docs-developer/50-reference/.md` — one page per package: header (composer name, description, module.json version), then classes grouped by type with synthesized one-liners and method lists. -- `docs-developer/50-reference/_category_.json` — sidebar label "Package Reference". +- `docs-developer/50-reference/index.md` - package index: table of all 33 packages with title, description, class counts, link. +- `docs-developer/50-reference/.md` - one page per package: header (composer name, description, module.json version), then classes grouped by type with synthesized one-liners and method lists. +- `docs-developer/50-reference/_category_.json` - sidebar label "Package Reference". **Why committed:** GitHub Pages builds without the sibling `ZerpPackages/` present, so generated `.md` must already exist in the repo. Regenerate on demand (and before each release) via `npm run gen:reference`. @@ -51,7 +51,7 @@ Three deliverables: > `ponytail:` shallow regex/token parse, not a real PHP AST. Ceiling: won't handle multi-class files, traits-as-primary, or exotic syntax. Upgrade path: swap the parser for `nikic/php-parser` via a PHP sub-script if method-level depth is ever needed. Current class density (single class per file, PSR-4) makes shallow parsing safe today. -## Piece 2 — Developer-docs restructure +## Piece 2 - Developer-docs restructure Keep all 7 existing (well-written) pages; move them into folders so the autogenerated sidebar renders labeled sections. Each folder gets `_category_.json`. @@ -66,9 +66,9 @@ Keep all 7 existing (well-written) pages; move them into folders so the autogene - Light tidy pass on the 7 pages: fix internal `./page` links broken by the folder move, and add cross-links into the new reference where natural (e.g. module-development → package reference). - **URL change is accepted:** e.g. `/developer/module-development` → `/developer/architecture/module-development`. Fine for a 1.0. -## Piece 3 — Zerp 1.0 release (main app) +## Piece 3 - Zerp 1.0 release (main app) -- Add `zerp/CHANGELOG.md` with a `v1.0.0` entry summarizing the 1.0 surface (core ERP + the 33 modules), framed as **original Zerp software** — no prior-brand mentions. +- Add `zerp/CHANGELOG.md` with a `v1.0.0` entry summarizing the 1.0 surface (core ERP + the 33 modules), framed as **original Zerp software** - no prior-brand mentions. - `git tag v1.0.0` on `main` at current `HEAD`, `git push origin v1.0.0`, `gh release create v1.0.0` with notes derived from the changelog. - **Do not** touch `.env`. **Do not** re-tag any package (already at `v1.0.x`; immutable). **No** `Co-Authored-By: Claude` trailer on any commit (Zerp-repo rule). diff --git a/scripts/gen-package-reference.mjs b/scripts/gen-package-reference.mjs index 92c0645..0ad3402 100644 --- a/scripts/gen-package-reference.mjs +++ b/scripts/gen-package-reference.mjs @@ -24,18 +24,18 @@ export function describe(info) { const top = info.kind.split('/').pop(); if (top === 'Models') { const rel = info.relations.length ? `, relations: ${info.relations.join(', ')}` : ''; - return `Eloquent model — ${info.fillable.length} fillable field${info.fillable.length === 1 ? '' : 's'}${rel}.`; + return `Eloquent model - ${info.fillable.length} fillable field${info.fillable.length === 1 ? '' : 's'}${rel}.`; } if (top.endsWith('Controllers') || info.kind.includes('Controllers')) { - return `HTTP controller — actions: ${info.methods.join(', ') || '—'}.`; + return `HTTP controller - actions: ${info.methods.join(', ') || 'none'}.`; } - if (top === 'Requests') return `Form request — validation rules for ${info.name.replace(/Request$/, '')}.`; + if (top === 'Requests') return `Form request - validation rules for ${info.name.replace(/Request$/, '')}.`; if (top === 'Events') return `Domain event.`; if (top === 'Listeners') return `Event listener.`; if (top === 'Seeders') return `Database seeder.`; if (top === 'Providers') return `Service provider.`; const ext = info.extends ? ` (extends ${info.extends})` : ''; - return `${top} class${ext} — methods: ${info.methods.join(', ') || '—'}.`; + return `${top} class${ext} - methods: ${info.methods.join(', ') || 'none'}.`; } const HERE = dirname(fileURLToPath(import.meta.url)); diff --git a/src/pages/index.tsx b/src/pages/index.tsx index 2e72b5a..3205116 100644 --- a/src/pages/index.tsx +++ b/src/pages/index.tsx @@ -33,7 +33,7 @@ function DocsCards() {

- Learn how to use Zerp — logging in, managing users, and + Learn how to use Zerp - logging in, managing users, and every feature module from Accounting to Support Ticket.

@@ -53,7 +53,7 @@ function DocsCards() {

- Learn how Zerp is built — the core app + module package + Learn how Zerp is built - the core app + module package architecture, local dev setup, Docker/CI, the Media Library, and how to contribute.