Skip to main content

CLIENT

👥 Technical Specification: Client Setup


📋 Feature Overview

Attribute Detail
Module 📂 Directory (CLIENT)
Feature Name Client Profile Management
Description Manages client profiles, including billing details, contact info, and delivery addresses. Supports linking Client entity to a System User.
Page & Detail
1. Listing Page: /listing-client-profile
Displays grid of clients, filters, and delete/assign-user actions.
2. Add/Edit Page: /add-client-profile-manage
Form for creating new clients, updating profiles, and managing delivery addresses.
3. Assign User Dialog: /assign-user-dialog
Additional function for adding user to the client.
User Guide 📄 [Ekajaya Admin User Guide - Directory Module, Section 5]

🛠️ Technical Implementation

A. Permissions & Access Control

Note: Access is controlled via PermissionGuard and component-level checks.
Scope Permission Code Description & Page Usage
Menu Visibility CLIENT.MENU

Sidebar menu visibility.

\listing-client-profile

\add-client-profile-manage
Page Routing CLIENT.LISTING Access to listing route.
\listing-client-profile
Page Routing CLIENT.VIEW

Access to add route.

\add-client-profile-manage
Create Action CLIENT.CREATE Visibility of the + Add button.
\listing-client-profile
View Access CLIENT.VIEW Controls visibility of the Edit icon.
\listing-client-profile
Delete Action CLIENT.DELETE Visibility of the Delete 🗑️ icon.
\listing-client-profile
Update Action CLIENT.UPDATE Ability to save changes on Edit screen.
\add-client-profile-manage

B. API Interaction

Base URL: ${environment.baseApiUrl}
1. Listing Client Profile \listing-client-profile
/clients/getQuery
POST
Filter: clientName, registrationNumber, clientCode, isDeleted=0
/client/delete
POST
Purpose: Delete Client
2. Add Client Profile Manage \add-client-profile-manage
/countries/getQuery
POST
Purpose: Populate countryDataSource
/states/getQuery
POST
Filter: countryId
/districts/getQuery
POST
Filter: stateId
/settings/getQuery
POST
Filter: type='Client Type'
/clients/getQuery
POST
Filter: id (Fetch specific record)
/clients/getQuery
POST
Filter: clientCode (Uniqueness Check)
/clients/mdCreate
POST
Purpose: Master-Detail Create
/clients/mdUpdate
POST
Purpose: Master-Detail Update
Back to top