Fee Payments API Documentation

1. Save Fee Payment

Save or update a fee payment.

Endpoint:

POST /fees/payment/save

Required Parameters:

• paymentData (object) - The main payment data.
• student_id (int) - The ID of the student making the payment.
• fee_structure_id (int) - The ID of the fee structure being paid.
• amount_paid (decimal) - The amount paid.
• payment_method (enum) - The method of payment (e.g., "cash", "credit_card", "bank_transfer", "online_payment").
• payment_date (date, optional) - The date of the payment.
• transaction_id (string, optional) - The transaction ID for the payment.

Example cURL Request:

curl -X POST https://your-domain.com/fees/payment/save \
-H "Content-Type: application/json" \
-d '{
    "paymentData": {
        "student_id": 1,
        "fee_structure_id": 2,
        "amount_paid": 500.00,
        "payment_method": "cash",
        "payment_date": "2024-09-01",
        "transaction_id": "TXN123456"
    }
}'

2. Delete Fee Payment

Delete a fee payment by its ID.

Endpoint:

POST /fees/payment/delete

Required Parameters:

• fee_payment_id (int) - The ID of the fee payment to delete.

Example cURL Request:

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

3. List Fee Payments

Retrieve a paginated list of fee payments.

Endpoint:

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

4. Get Fee Payment

Retrieve details of a specific fee payment by its ID.

Endpoint:

POST /fees/payment/get

Required Parameters:

• fee_payment_id (int) - The ID of the fee payment to retrieve.

Example cURL Request:

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