Fee Dashboard API Documentation

Fee Dashboard API Documentation

1. Dashboard Overview

Get an overview of fee payments including unpaid students, paid students, overdue payments, and late fees collected, grouped by fee groups.

Endpoint:

POST /fees/dashboard/overview

Optional Parameters:

• group_id (int) - Filter by group ID. If omitted, the overview will include all groups.

Example cURL Request:

curl -X POST https://your-domain.com/fees/dashboard/overview \
-H "Content-Type: application/json" \
-d '{
    "group_id": 1
}'

1.1. List Unpaid Students

Retrieve a list of students who have not fully paid their fees, with pagination and optional class filter.

Endpoint:

POST /fees/dashboard/unpaid

Optional Parameters:

• class_id (int) - Filter by class ID.
• offset (int) - The number of records to skip. Default is 0.
• limit (int) - The number of records to return. Default is 10.

Example cURL Request:

curl -X POST https://your-domain.com/fees/dashboard/unpaid \
-H "Content-Type: application/json" \
-d '{
    "class_id": 1,
    "offset": 0,
    "limit": 10
}'

2. Search Students

Search for students with filters like paid/unpaid status and class, with pagination.

Endpoint:

POST /fees/dashboard/search

Optional Parameters:

• status (string) - Filter by status ('paid', 'unpaid').
• class_id (int) - Filter by class ID.
• offset (int) - The number of records to skip. Default is 0.
• limit (int) - The number of records to return. Default is 10.

Example cURL Request:

curl -X POST https://your-domain.com/fees/dashboard/search \
-H "Content-Type: application/json" \
-d '{
    "status": "unpaid",
    "class_id": 2,
    "offset": 0,
    "limit": 10
}'

3. Check and Apply Late Fees

Automatically check for late payments and apply late fees to the students.

Endpoint:

POST /fees/dashboard/latefees

No Parameters Required

Example cURL Request:

curl -X POST https://your-domain.com/fees/dashboard/latefees \
-H "Content-Type: application/json"

4. Apply Discount for a Student

Apply a discount to a student's fee structure.

Endpoint:

POST /fees/dashboard/applydiscount

Required Parameters:

• student_id (int) - The ID of the student.
• fee_structure_id (int) - The ID of the fee structure.
• discount_amount (decimal) - The amount of the discount.

Example cURL Request:

curl -X POST https://your-domain.com/fees/dashboard/applydiscount \
-H "Content-Type: application/json" \
-d '{
    "student_id": 1,
    "fee_structure_id": 2,
    "discount_amount": 50.00
}'