Appearance
API
All endpoints are on the university's own address, e.g. https://<university>.<platform domain>, and need a logged-in user. Each call only returns and changes what the user's roles allow (roles).
| Entity | Endpoint |
|---|---|
| Concession / Scholarship | /api/fees/concession |
| Student Fee Demand | /api/fees/fee_demand |
| Fee Demand Component | /api/fees/fee_demand_component |
| Fee Head | /api/fees/fee_head |
| Fee Notice | /api/fees/fee_notice |
| Fee Remark | /api/fees/fee_remark |
| Fee Structure | /api/fees/fee_structure |
| Fee Structure Component | /api/fees/fee_structure_component |
| Installment | /api/fees/installment |
| Other Fee Charge | /api/fees/other_fee |
| Other Fee Type | /api/fees/other_fee_type |
| Programme Transfer | /api/fees/programme_transfer |
| Fee Receipt | /api/fees/receipt |
| Student Refund | /api/fees/refund |
Events
| Direction | Event |
|---|---|
| emits | fees.payment.received |
| emits | fees.demand.created |
| emits | fees.demand.paid |
| emits | fees.demand.cancelled |
| emits | fees.refund.paid |
| listens to | payments.payment.received |
| listens to | payments.payment.failed |
| listens to | payments.refund.completed |
Settings
Each university sets these from its admin screen.
| Setting | Type | Default | Label |
|---|---|---|---|
receiptPrefix | text | "RCPT" | Receipt number prefix |
allowPartialPayment | check | true | Allow part payment above the minimum fee |
holdWhenIntakeFull | check | true | Put first payment on hold when intake is full |
lateFeeEnabled | check | false | Charge late fee after the due date |
lateFeePerDay | number | 0 | Late fee per day (paise) when structure says Per day |
lateFeePerMonth | number | 0 | Late fee per month (paise) when structure says Per month |
installmentReminderDays | number | 10 | Days before an installment due date to remind |
dueDateReminderDays | number | 7 | Days before the fee due date to remind |
notifyOnPayment | check | true | Email student and parent when a payment is applied |
studentRefundRequests | check | true | Students can request a refund |
offlineModes | text | "Cash,Cheque,Demand draft,NEFT/RTGS,UPI" | Offline payment modes accepted at the counter |