GET
/api/v1/school/branches/statsPer-branch student/staff counts and fee collection
dashboard:viewSCREEN GUIDE · 11 OCT 2026
Branch & campus management
Use branch & campus management in the school workspace. See school-wide priorities and manage the campus context used by the ERP.
OVERVIEW
What you can do
01
Make main
02
Per-branch student/staff counts and fee collection
03
Open another campus (counts against the plan)
04
Rename a campus, or make it the main one
05
Close a campus (refused while anyone is posted to it)
BEFORE YOU BEGIN
Access & setup
Intended access: Assigned account with the required permissions.
- A school account with the permissions shown below.
- Choose the relevant school, academic session or child before working.
Required permission keys
dashboard:viewsettings:createsettings:updatesettings:deleteUse 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
- 01
Review the school dashboard and current session
A school account with the permissions shown below.
- 02
Open an outstanding action in the relevant module
Per-branch student/staff counts and fee collection is part of the documented workflow.
- 03
Inspect the campus counts and permitted branch settings
Open another campus (counts against the plan) is part of the documented workflow.
- 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.
| Field | Declared type | Input |
|---|---|---|
code | string | Required by declaration |
name | string | Required by declaration |
addressLine1 | string | Optional |
city | string | Optional |
phone | string | Optional |
isMain | boolean | Optional |
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
Launch guided demo →Try branch & campus management
Open a guided sample workspace, try the available actions, then reset whenever you like. No login required.
FOR IMPLEMENTERS
API & permissions reference
These are the source-matched API operations connected to this guide. Reading this reference does not execute any request.
4 source-declared operations
POST
/api/v1/school/branchesOpen another campus (counts against the plan)
settings:createDeclared request fields: code (required), name (required), addressLine1 (optional), city (optional), phone (optional).
PATCH
/api/v1/school/branches/:idRename a campus, or make it the main one
settings:updateDeclared request fields: isMain (optional).
DELETE
/api/v1/school/branches/:idClose a campus (refused while anyone is posted to it)
settings:deleteOpen the actual application
ERP links use your assigned account. Record-specific pages start from the list so you can choose a real record.