Settings and permissions
Finance is the financial.book_keeper module. When the module is off, finance screens, gateway settings and the automation actions for payment plans are hidden. It is on by default, except in the Admissions Starter edition.
Where things are configured
| What | Where |
|---|---|
| Payment plan templates, with their fees, instalment options, discount templates and automation | Settings > General settings > Templates & documents > Payment plan templates |
| Payer templates | Settings > General settings > Templates & documents > Payer templates, in the classic settings |
| Payment gateways | Settings > General settings > Other integrations > Payments |
| Payment plans on application and registration templates | The template's Payment and Payment plan tabs |
| Fee reminder and publication emails | Email templates, like any other system email |
See Payment plan templates, Payers, Payment gateways and Automation and emails.
Institution features
Some finance behaviour is switched on per institution. All of these are off by default.
| Feature | Effect when on |
|---|---|
| Payment plan fee structure | Lets templates use the flexible fees structure, where applicants define their own fees. |
| External payers | Lets fees be allocated to external payers, and gives the new application experience its payer flow. |
| External payer discount codes | Lets external payers enter discount codes on their payment page. |
| Payer customisation | Lets payers be customised through payer templates. |
| Disable payment plan publication notification email | Stops the email sent to the profile when a plan is published. |
Permissions
Finance permissions sit in two places: profile-level features in the Core module, and finance records in the Finance module. Each needs the financial.book_keeper module to be on.
Profile finance
| Feature | Description |
|---|---|
core.institutions.profile_financials_access |
Access to the profile's Financials tab. |
core.institutions.profile_payment_plans_access |
View the payment plans of profiles, and the Payment plans list and its export. |
core.institutions.profile_payment_plans_change |
Create, edit and remove payment plans assigned to a profile, their fees, instalments and discounts. |
core.institutions.profile_transactions_access |
View the payment transactions of a profile. |
core.institutions.profile_transaction_change |
Add or remove transactions on a profile. |
core.institutions.profile_transactions_refund |
Refund a profile's Stripe transactions. |
Full profile access (profiles_full_access) includes the change features.
Templates and settings
| Feature | Description |
|---|---|
core.institutions.institution_payment_plan_templates_change |
Create, edit and delete payment plan templates and their fee and discount structures. Shows Payment plan templates in settings. |
core.institutions.global_integration_settings |
Set up payment gateways. |
Finance records
| Feature | Description |
|---|---|
financial.book_keeper.transactions_access |
View transactions: the Transactions list, its export, and transactions in search. |
financial.book_keeper.discounts_access |
View and manage discount rules and amounts. |
financial.book_keeper.external_payer_requests_access |
View and manage payment requests sent to external payers. |
financial.book_keeper.payer_templates_access |
View payer templates. |
financial.book_keeper.payer_templates_change |
Create, edit and delete payer templates. Included in institution settings change. |
financial.book_keeper.payers_access |
View and manage payers and who pays each fee. |
Related features elsewhere
applics.applications_changeincludes access to discounts, external payer requests, payer templates and payers, so staff editing applications can work with the plan chosen in them.applics.applications_paymentslets staff view and edit an application fee's payment details.
What applicants and payers can do
Applicants and students do not need staff features to work with their own finances. They can:
- see their own published plans, and the plans offered in an application they are filling in;
- on a plan where they define their own fees, add fees, choose who pays each one and how many instalments to pay their own fees in;
- apply discount codes where the application template allows it;
- pay through the plan's or fee's gateway, and download a statement.
An external payer needs no account: the payment link is their access, for one fee, until it expires. See Payers.