All actions should be able to be completed using only the API. In BBv1, actions are performed from the API and from the UI. To create a separable web application, all UI code should be decoupled from the API.
- User creates a user account
- User account permisions can be elevated/lowered using ACLs
- User views what purchases they have made
- Committee Chair enters a budget
- Committee Chair submits a budget
- Treasurer approves a budget
- User makes a purchase request
- Committee Approvers approve purchase request
- User completes purchase
- Treasurer reimburses purchase
- Income is reported by Officers OR Income is received by BOSO
- Treasurer marks income status
- Treasurer and President view all financial transactions
- Reports filterable based on committe, type, year
- Committee Chairs view transactions for specific committee
- Users view their current paid dues
- Committee Chairs view all dues paying members and enter members
- Treasurer marks dues as paid or exempt
Each endpoint is prefaced with /api/v2/.
Authentication handled by API Token, Authorization handled by ACL on user account
/access: endpoint for setting ACLs/access/tresurers- GET: get a list of all current treasurers
- POST: Add a new treasurer
/access/officers- GET: get a list of all current officers
- POST: Add a new officer
/access/internals- GET: get a list of all current internal leads
- POST: Add a new internal lead
/access/approvals/{approver}- DELETE: remove approver from ACLs
/account: endpoint for user accounts/account/{user_id}- GET: user details
- PUT: update account details
- POST: change account password
/account/{user_id}/purchases- GET: all user purchases
/account/{user_id}/approvals- GET: all purchases user can approve
/account/{user_id}/completions- GET: all purchases user can complete
/account/{user_id}/reimbursements- GET: all purchases uer can reimburse
/account/{user_id}/checks- GET: any checks currently being mailed to a user
/account/{user_id}/balances- GET: all committee balances user can view
/account/{user_id}/committees- GET: all committee where user has approval powers
/account/{user_id}/dues- GET: any dues paid by the user
/account/{user_id}/committee/purchase- GET: last committee for which a user made a purchase
/account/{user_id}/committee/income- GET: last committee for which a user entered any income
/budgets: endpoint for budgets/budgets/years- GET: view all fiscal years
/budgets/{committee_id}- POST: submit a committee budget
- PUT: approve a committee budget
/budget/submitted- GET: view all submitted budgets
/committee: endpoint for committee finances- GET: list of all committees
/committee/{committee_id}/categories/{year?}- GET: list all committee budget categories
/committee/{committee_id}/balance- GET: view total committee balance
/committee/{committee_id}/credit- GET: view committee credit balance
/committee/{committee_id}/budget/{year?}- GET: view committee budget for an optional year
/committee/{committee_id}/expensetotal/{year?}- GET: view committee expenses total for an optional year
/committee/{committee_id}/incometotal/{year?}- GET: view committee income total for an optional year
/committee/{committee_id}/purchases/{year?}- GET: view committee expenses list for an optional year
/committee/{committee_id}/income/{year?}- GET: view committee income list for an optional year
/committee/{committee_id}/summary/{year?}- GET: view committee financial summary for an optional year
/committee/{committee_id}/csv- GET: export a CSV file of all committee purchases for a given time range
/dues: endpoint for dues tracking- POST: add a new dues member
/dues/committees- GET: list all dues committees (different from fiscal committees)
/dues/amount- GET: list all dues amounts for the current year
/dues/summary/{year?}- GET: view total counts of dues members for each committee
/dues/all/{year?}- GET: view all dues paying members for a year
/dues/income/{year}- GET: view actual dues deposits for a given year, but results may be wrong
/dues/expected/{year}- GET: get expected total dues income for a given year, excluding 'Exempt' members
/dues/{dues_id}- PUT: update the dues payment status OR the dues member details
/income: endpoint for committee income- POST: report a new income
- GET: view all reported income
/income/{income_id}- GET: view details for a specific income
- PUT: update income status
-
/login: endpoint for user/pass authentication- POST: create new user account
/login/password- POST: login with username and password
/login/forgot-user- POST: find all usernames associated with an email
/login/forgot-pass- POST: send password reset email to user
/login/reset- POST: reset a user account password
-
/oidc: endpoint for OIDC authentication/oidc/login- GET: start the login process
/oidc/callback- GET: return here after the IdP Server authenticates the user
/oidc/logout- GET: start the logout process
/oidc/userinfo- GET: after redirecting to UI, get some info for the UI to complete the login process
/oidc/register- POST: register a new user account
/purchase: endpoint for purchasing- POST: create a new purchase request
- GET: return all processing or reimbursed purchases
/purchase/treasurer- POST: reimburse purchases
/purchase/{purchase_id}- GET: view details of a purchase
- DELETE: cancel a purchase
- PUT: update a purchase if edited by a treasurer
/purchase/{purchase_id}/expire- POST: expire a purchase if after the fiscal year
/purchase/{purchase_id}/approve- POST: approve or deny purchase request
/purchase/{purchase_id}/complete- POST: complete a purchase request
/purchase/{purchase_id}/receipt- POST: upload a new receipt for a purchase
/purchase/{purchase_id}/checks- POST: mark a mailed check as received
/receipt: endpoint for purchase receipts/receipt/{file}- GET: view a purchase receipt