Skip to content

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).

EntityEndpoint
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 ​

DirectionEvent
emitsfees.payment.received
emitsfees.demand.created
emitsfees.demand.paid
emitsfees.demand.cancelled
emitsfees.refund.paid
listens topayments.payment.received
listens topayments.payment.failed
listens topayments.refund.completed

Settings ​

Each university sets these from its admin screen.

SettingTypeDefaultLabel
receiptPrefixtext"RCPT"Receipt number prefix
allowPartialPaymentchecktrueAllow part payment above the minimum fee
holdWhenIntakeFullchecktruePut first payment on hold when intake is full
lateFeeEnabledcheckfalseCharge late fee after the due date
lateFeePerDaynumber0Late fee per day (paise) when structure says Per day
lateFeePerMonthnumber0Late fee per month (paise) when structure says Per month
installmentReminderDaysnumber10Days before an installment due date to remind
dueDateReminderDaysnumber7Days before the fee due date to remind
notifyOnPaymentchecktrueEmail student and parent when a payment is applied
studentRefundRequestschecktrueStudents can request a refund
offlineModestext"Cash,Cheque,Demand draft,NEFT/RTGS,UPI"Offline payment modes accepted at the counter

Edulab Bench developer documentation