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
Allocation Line	/api/budget/allocation_line
Budget Allocation	/api/budget/budget_allocation
Budget Head	/api/budget/budget_head
Budget Sub-head	/api/budget/budget_sub_head
Expenditure	/api/budget/expenditure
Expenditure Request	/api/budget/expenditure_request
Financial Year	/api/budget/financial_year
Re-appropriation	/api/budget/reappropriation
Sub-department	/api/budget/sub_department

Events

Direction	Event
emits	budget.expenditure_request.submitted
emits	budget.expenditure_request.approved
emits	budget.expenditure_request.rejected
emits	budget.expenditure.recorded
emits	budget.reappropriation.approved
emits	budget.allocation.exceeded

Settings

Each university sets these from its admin screen.

Setting	Type	Default	Label
financialYearStartMonth	number	4	Financial year starts in month (1-12)
approvalLevels	select	"1"	Expenditure approval levels (1 = HOD, 2 = HOD then Finance)
reserveOnRequest	check	true	Reserve the amount from the budget when a request is raised
allowPostFacto	check	true	Allow post-facto top-up requests on approved requests
referenceNumberRequired	check	false	Require an office reference number on every request