Skip to main content

Company Setup

đŸĸ Technical Specification: Company Setup

 

📋 Feature Overview

Attribute Detail
Module ⚙ī¸ Settings
Feature Name Company Setup
Description Acts as the master data management tool for company entities. Supports creating internal/external companies and manages soft deletes.
User Guide 📄 [Ekajaya Admin User Guide - Setting Module, Page 3]

🕹ī¸ Functional Workflow (User Perspective)

  • 📍 Navigation: Settings > Company
  • 👁ī¸ Listing View: Paginated list with search (filters by name, description, remark).
  • ➕ Add Action: Opens the "Add Company" form.
  • ✏ī¸ Edit Action: Click the Pencil icon to modify details.
  • 🗑ī¸ Delete Action: Click the Trash icon to soft-delete (requires validation).

📝 UI Input Fields

Field Name Type Required Description
Company Name Text ✅ Yes Must be unique across active records.
Description Text ❌ No Optional details about the company.
Remark Text ❌ No Optional internal remarks.
Is Internal? Checkbox ❌ No Flag to mark the company as an internal entity.

🛠ī¸ Technical Implementation

🔐 A. Permissions & Access Control

Access is controlled via PermissionGuard and UI directives (*ngIf).

Scope Permission Code Description
Menu Visibility COMPANY.MENU Sidebar menu item visibility.
Page Access COMPANY.LISTING Access to /listing-company.
Create Action COMPANY.CREATE Visibility of the + Add button.
View/Edit Access COMPANY.VIEW Access to /add-company-manage.
Update Action COMPANY.UPDATE Ability to save changes on Edit screen.
Delete Action COMPANY.DELETE Visibility of the Delete 🗑ī¸ icon.

🔌 B. API Interaction

Base URL: ${environment.baseApiUrl}

đŸ“Ĩ 1. Retrieve Company List

  • Endpoint: /companies/getQuery
  • Method: POST
  • Purpose: Fetches paginated data for the grid.
  • Key Params:
    • filter: isDeleted||$eq||0 (plus dynamic search filters).
    • sort: companyName

🔍 2. Get Single Company (Edit Mode)

  • Endpoint: /companies/getOne
  • Method: GET
  • Query Params: id (Number)

✨ 3. Create Company

  • Endpoint: /companies/create
  • Method: POST
  • Payload:
Back to top