AVKUL ERPDocs
MODULE GUIDE · 11 OCT 2026

Staff directory & lifecycle

Maintain staff profiles, inspect connected responsibilities and record departure or reinstatement.

Try guided demo →Download guide ↓
Staff directory & lifecycle — illustrated workflow banner
OVERVIEW

What you can do

01

Directory

02

Staff creation

03

Profile 360

04

Clearance

05

Offboarding

06

Reinstatement

BEFORE YOU BEGIN

Access & setup

Intended access: Assigned account with the required permissions.

  • An assigned school account with the required permissions.
  • The academic, student or staff setup used by this workflow.
Required permission keys
hr:viewhr:createhr:updatehr:manage

Use the public sample demo to learn this flow. Your assigned ERP account determines access to actual school records.

STEP BY STEP

How the workflow works

  1. 01

    Find or create the staff profile

    An assigned school account with the required permissions.

  2. 02

    Review employment details and linked responsibilities

    Staff creation is part of the documented workflow.

  3. 03

    Inspect clearance before offboarding

    Profile 360 is part of the documented workflow.

  4. 04

    Use reinstatement when returning a former staff member

    Review the result in the connected record or workspace before moving on.

Request fields to understand

Source-declared fields used by related operations; each operation has its own validation and scope.

FieldDeclared typeInput
employeeCodestringRequired by declaration
firstNamestringRequired by declaration
lastNamestringOptional
genderstringOptional
dateOfBirthstringOptional
emailstringOptional
phonestringOptional
branchIdstringOptional
departmentIdstringOptional
designationIdstringOptional
reportsToIdstringOptional
joiningDatestringOptional
contractTypestringOptional
qualificationsunknownOptional
exitStatus'RESIGNED' | 'TERMINATED' | 'RETIRED'Optional
exitDatestringOptional
reasonstringOptional
forcebooleanOptional
CURRENT BEHAVIOUR

Rules & current limits

  • Offboarding is separate from deleting historical school activity. Permission and dependency checks govern each action.

Source inventory checked on 11 October 2026. Guide availability confirms documentation publication, not certification of every external service or device flow.

LEARN BY DOING

Try staff directory & lifecycle

Open a guided sample workspace, try the available actions, then reset whenever you like. No login required.

Launch guided demo →
FOR IMPLEMENTERS

API & permissions reference

This is the module’s source-declared endpoint catalogue. Reading this reference does not execute any request.

9 source-declared operations
GET/api/v1/staff

List

hr:view
GET/api/v1/staff/former

List Former

hr:view
POST/api/v1/staff

Add a staff member

hr:create

Declared request fields: employeeCode (required), firstName (required), lastName (optional), gender (optional), dateOfBirth (optional), email (optional), phone (optional), branchId (optional), departmentId (optional), designationId (optional), reportsToId (optional), joiningDate (optional), contractType (optional), qualifications (optional).

PATCH/api/v1/staff/:id

Update

hr:update
GET/api/v1/staff/:id/clearance

What still depends on this person

hr:view
POST/api/v1/staff/:id/offboard

Mark a staff member as having left

hr:manage

Declared request fields: exitStatus (optional), exitDate (optional), reason (optional), force (optional).

POST/api/v1/staff/:id/reinstate

Reinstate

hr:manage
GET/api/v1/staff/:id

Get

hr:view
GET/api/v1/staff/:id/profile-360

Get Profile360

hr:view

Open the actual application

ERP links use your assigned account. Record-specific pages start from the list so you can choose a real record.

/en/school/staffOpen ↗/en/school/staff/[id]Open ↗

Keep exploring

Screen guideStaff directory & lifecycle →Screen guideStaff profile & clearance →