/api/v1/tuition/statsTuition center overview stats
student:viewManage tuition subjects, teaching batches, student enrollment and prospective demo classes.
Intended access: Assigned account with the required permissions.
student:viewstudent:createstudent:updatestudent:deleteUse the public sample demo to learn this flow. Your assigned ERP account determines access to actual school records.
An assigned school account with the required permissions.
Batches is part of the documented workflow.
Enrollment is part of the documented workflow.
Review the result in the connected record or workspace before moving on.
Source-declared fields used by related operations; each operation has its own validation and scope.
| Field | Declared type | Input |
|---|---|---|
name | string | Optional |
subjectId | string | Required by declaration |
teacherStaffId | string | Optional |
type | BatchType | Optional |
startDate | string | Required by declaration |
endDate | string | Optional |
maxStudents | number | Optional |
monthlyFee | number | Optional |
schedule | string | Optional |
roomNo | string | Optional |
status | DemoStatus | Optional |
batchId | string | Required by declaration |
studentId | string | Required by declaration |
enrolledAt | string | Optional |
discountAmount | number | Optional |
notes | string | Optional |
isActive | boolean | Optional |
prospectName | string | Required by declaration |
prospectPhone | string | Required by declaration |
prospectEmail | string | Optional |
scheduledAt | string | Optional |
feedbackNotes | string | Optional |
converted | boolean | Optional |
convertedStudentId | string | Optional |
Source inventory checked on 11 October 2026. Guide availability confirms documentation publication, not certification of every external service or device flow.
Open a guided sample workspace, try the available actions, then reset whenever you like. No login required.
This is the module’s source-declared endpoint catalogue. Reading this reference does not execute any request.
/api/v1/tuition/statsTuition center overview stats
student:view/api/v1/tuition/subjectsList subjects available for batches
student:view/api/v1/tuition/studentsList students (for enrollment)
student:view/api/v1/tuition/batchesList all batches
student:view/api/v1/tuition/batchesCreate a new batch
student:createDeclared request fields: name (required), subjectId (required), teacherStaffId (optional), type (required), startDate (required), endDate (optional), maxStudents (optional), monthlyFee (optional), schedule (optional), roomNo (optional).
/api/v1/tuition/batches/:idUpdate a batch
student:updateDeclared request fields: name (optional), teacherStaffId (optional), type (optional), endDate (optional), maxStudents (optional), monthlyFee (optional), schedule (optional), status (optional), roomNo (optional).
/api/v1/tuition/batches/:idDelete a batch
student:delete/api/v1/tuition/enrollmentsList enrollments (optionally filter by batchId)
student:view/api/v1/tuition/enrollmentsEnroll a student in a batch
student:createDeclared request fields: batchId (required), studentId (required), enrolledAt (optional), discountAmount (optional), notes (optional).
/api/v1/tuition/enrollments/:idUpdate enrollment (activate/deactivate, discount)
student:updateDeclared request fields: isActive (optional), discountAmount (optional), notes (optional).
/api/v1/tuition/demosList demo classes (filter by status)
student:view/api/v1/tuition/demosSchedule a demo class for a prospect
student:createDeclared request fields: prospectName (required), prospectPhone (required), prospectEmail (optional), subjectId (required), batchId (optional), scheduledAt (required), teacherStaffId (optional), notes (optional).
/api/v1/tuition/demos/:idUpdate demo class (status, feedback, conversion)
student:updateDeclared request fields: status (optional), scheduledAt (optional), teacherStaffId (optional), notes (optional), feedbackNotes (optional), converted (optional), convertedStudentId (optional).
/api/v1/tuition/progress-reportsList progress reports
student:view/api/v1/tuition/progress-reportsCreate a progress report
student:createDeclared request fields: studentId (required), batchId (required), period (optional), marksObtained (optional), maxMarks (optional), grade (optional), teacherRemarks (optional), attendancePercent (optional).
/api/v1/tuition/progress-reports/:idUpdate a progress report
student:updateDeclared request fields: marksObtained (optional), maxMarks (optional), grade (optional), teacherRemarks (optional), attendancePercent (optional).
ERP links use your assigned account. Record-specific pages start from the list so you can choose a real record.