# School dashboard & branches

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

Category: School office
Guide: https://avkul.in/docs/guides/module-school/
Guided sample demo: https://avkul.in/docs/demo/module-school/
Snapshot: 11 October 2026

## Features

- Overview metrics
- Daily Action Center
- School profile
- Branch counts
- Campus creation and update

## Access and 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.

Permission keys: dashboard:view, settings:create, settings:update, settings:delete

## Workflow

1. Review the school dashboard and current session.
2. Open an outstanding action in the relevant module.
3. Inspect the campus counts and permitted branch settings.
4. Review the consequences before closing a campus.

## Fields and controls

- code (string, declared required)
- name (string, declared required)
- addressLine1 (string, optional)
- city (string, optional)
- phone (string, optional)
- isMain (boolean, optional)

## Current limits

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

## Actual application access

- https://avkul.in/en/school/branches
- https://avkul.in/en/school

## API reference

- 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
- PATCH /api/v1/school/branches/:id — Rename a campus, or make it the main one; settings:update
- DELETE /api/v1/school/branches/:id — Close a campus (refused while anyone is posted to it); settings:delete

## Demo access

No login is required for the guided sample demo. Its fictional records and actions stay in this browser tab; they do not modify ERP records or send messages/payments. An assigned account is required for the actual ERP links.

Source inventory checked on 11 October 2026. This source inventory is not a certification of every external provider or device flow.