Skip to content

Payments — permissions

Scaffolded stub — replace with proper documentation when this module is next touched.

Returned by PaymentsModule.get_permissions() (relative names; the registry namespaces them as payments.<name>).

PermissionAllowsRequired by
payments.record.readDescribe what this allows.List the endpoints.
payments.record.writeDescribe what this allows.List the endpoints.
payments.record.refundDescribe what this allows.List the endpoints.
payments.reports.readDescribe what this allows.List the endpoints.

Role assignment

See backend/app/core/auth/permissions.py for the canonical role table.

Adding a new permission

  1. Add the relative name to get_permissions() in backend/app/modules/payments/__init__.py (or module.py).
  2. Add the namespaced form to the relevant role(s) in backend/app/core/auth/permissions.py.
  3. Add a row to the table above.
  4. Annotate the endpoint(s) with Depends(require_permission(...)).
  5. Update frontend/app/config/permissions.ts if it gates UI.