Fee Structures API Documentation

1. Save Fee Structure

Save or update a fee structure along with its details.

Endpoint:

POST /fees/structure/save

Required Parameters:

• structureData (object) - The main structure data.
• group_id (int) - The ID of the fee group.
• class_id (int) - The ID of the class.
• class_level (string) - The level of the class (e.g., "10").
• due_date (date) - The due date for the fee structure.
• academic_year_id (int) - The ID of the academic year.
• structDetails (array) - An array of fee structure details.
• fee_category_id (int) - The ID of the fee category.
• amount (decimal) - The amount for the fee category.

Example cURL Request:

curl -X POST https://your-domain.com/fees/structure/save \
-H "Content-Type: application/json" \
-d '{
    "structureData": {
        "group_id": 1,
        "class_id": 2,
        "class_level": "10",
        "due_date": "2024-09-01",
        "academic_year_id": 3
    },
    "structDetails": [
        {
            "fee_category_id": 1,
            "amount": 500.00
        },
        {
            "fee_category_id": 2,
            "amount": 300.00
        }
    ]
}'

2. Delete Fee Structure

Delete a fee structure by its ID.

Endpoint:

POST /fees/structure/delete

Required Parameters:

• fee_structure_id (int) - The ID of the fee structure to delete.

Example cURL Request:

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

3. List Fee Structures

Retrieve a paginated list of fee structures.

Endpoint:

POST /fees/structure/list

Optional Parameters:

• 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/structure/list \
-H "Content-Type: application/json" \
-d '{
    "offset": 0,
    "limit": 10
}'

4. Get Fee Structure

Retrieve details of a specific fee structure by its ID.

Endpoint:

POST /fees/structure/get

Required Parameters:

• fee_structure_id (int) - The ID of the fee structure to retrieve.

Example cURL Request:

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