AVKUL ERPDocs
MODULE GUIDE · 11 OCT 2026

School dashboard & branches

See school-wide priorities and manage the campus context used by the ERP.

Try guided demo →Download guide ↓
School dashboard & branches — illustrated workflow banner
OVERVIEW

What you can do

01

Overview metrics

02

Daily Action Center

03

School profile

04

Branch counts

05

Campus creation and update

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
dashboard:viewsettings:createsettings:updatesettings:delete

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

    Review the school dashboard and current session

    An assigned school account with the required permissions.

  2. 02

    Open an outstanding action in the relevant module

    Daily Action Center is part of the documented workflow.

  3. 03

    Inspect the campus counts and permitted branch settings

    School profile is part of the documented workflow.

  4. 04

    Review the consequences before closing a campus

    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
codestringRequired by declaration
namestringRequired by declaration
addressLine1stringOptional
citystringOptional
phonestringOptional
isMainbooleanOptional
CURRENT BEHAVIOUR

Rules & current limits

  • Closing a populated campus is refused. The dashboard aggregates scoped records rather than replacing each module workflow.

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 school dashboard & branches

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.

8 source-declared operations
GET/api/v1/school/overview

School Admin dashboard KPIs (today + footprint)

dashboard:view
GET/api/v1/school/action-center

Daily Action Center: everything pending today, scoped to the caller

dashboard:view
GET/api/v1/school/profile

Current school, branches and active session

dashboard:view
GET/api/v1/school/staff

Staff directory (id + name) for dropdowns

dashboard:view
GET/api/v1/school/branches/stats

Per-branch student/staff counts and fee collection

dashboard:view
POST/api/v1/school/branches

Open another campus (counts against the plan)

settings:create

Declared request fields: code (required), name (required), addressLine1 (optional), city (optional), phone (optional).

PATCH/api/v1/school/branches/:id

Rename a campus, or make it the main one

settings:update

Declared request fields: isMain (optional).

DELETE/api/v1/school/branches/:id

Close a campus (refused while anyone is posted to it)

settings:delete

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/branchesOpen ↗/en/schoolOpen ↗

Keep exploring

Screen guideBranch & campus management →Screen guideSchool dashboard →