# tsea2010/sacco_manager architecture

> Architecture diagram of the GitHub repository tsea2010/sacco_manager, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/tsea2010/sacco_manager
- Repository: https://github.com/tsea2010/sacco_manager

## Overview

Sacco Manager is a Frappe app for SACCO membership, savings, shares, lending, branch remittances, and member-facing portal access. The main member workflow links a member to a customer, exposes savings and loan information, and supports loan applications with guarantor security; staff workflows manage postings and periodic runs. Components are grouped by product domain. Source excerpts show selected portal, member, remittance, and loan behavior; other listed DocTypes and reports are represented from the tree, so their internal links are left out where calls were not evidenced.

Main entry points: [`sacco_manager/api/member_portal.py`](https://github.com/tsea2010/sacco_manager/blob/main/sacco_manager/api/member_portal.py) (Portal identity and summary), [`sacco_manager/sacco_manager/doctype/sacco_member/sacco_member.py`](https://github.com/tsea2010/sacco_manager/blob/main/sacco_manager/sacco_manager/doctype/sacco_member/sacco_member.py) (Member records), [`sacco_manager/www/sacco-portal.py`](https://github.com/tsea2010/sacco_manager/blob/main/sacco_manager/www/sacco-portal.py) (SACCO portal page), [`sacco_manager/sacco_manager/doctype/loan_top_up/loan_top_up.py`](https://github.com/tsea2010/sacco_manager/blob/main/sacco_manager/sacco_manager/doctype/loan_top_up/loan_top_up.py) (Loan top-ups)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_membership["Membership"]
  node_member["Member records<br/>[sacco_member.py]"]
end

subgraph group_savings["Savings and shares"]
  node_savings_account["Savings accounts"]
  node_savings_txn["Savings transactions"]
  node_shares["Share ledger"]
  node_savings_run["Monthly savings run"]
  node_withdrawal["Withdrawal requests"]
  node_interest_run["Interest runs"]
end

subgraph group_lending["Lending"]
  node_loan_application["Loan applications"]
  node_guarantor["Loan guarantors"]
  node_loan_topup["Loan top-ups<br/>[loan_top_up.py]"]
  node_loan_repayment["Loan repayment override<br/>[loan_repayment.py]"]
  node_delinquency["Delinquency interest"]
end

subgraph group_operations["Operations and reporting"]
  node_remittance["Branch remittances"]
  node_registration_fee["Registration fees"]
  node_account_type["SACCO account types"]
  node_settings["SACCO settings<br/>[sacco_settings.py]"]
  node_reports["Branch and member reports"]
  node_api["API endpoints<br/>[api.py]"]
  node_print_patch["Print footer patch<br/>[print_patches.py]"]
end

subgraph group_portal["Member portal"]
  node_member_api["Portal identity and summary<br/>[member_portal.py]"]
  node_sacco_api["SACCO portal services<br/>[sacco_portal.py]"]
  node_portal_page["SACCO portal page<br/>[sacco-portal.py]"]
end

node_staff(("SACCO staff"))
node_member_user(("Member user"))
node_erp["Frappe / ERPNext"]

node_staff -->|"manages"| node_member
node_member -->|"creates linked customer"| node_erp
node_member_user -.->|"requests portal data"| node_member_api
node_member_api -->|"resolves member"| node_member
node_member_api -->|"reads account"| node_savings_account
node_member_api -->|"queries loans and shares"| node_erp
node_portal_page -->|"reads portal records"| node_erp
node_portal_page -->|"creates loan security"| node_erp
node_sacco_api -->|"reads loans and savings"| node_erp
node_staff -.->|"runs monthly process"| node_savings_run
node_staff -.->|"runs interest process"| node_interest_run
node_staff -.->|"records remittance"| node_remittance
node_remittance -->|"posts transactions and journals"| node_erp
node_staff -.->|"handles requests"| node_withdrawal
node_staff -.->|"records fees"| node_registration_fee
node_staff -.->|"records shares"| node_shares
node_staff -.->|"validates applications"| node_loan_application
node_staff -.->|"submits top-up"| node_loan_topup
node_loan_topup -->|"creates disbursement"| node_erp
node_delinquency -->|"creates loan demand"| node_erp
node_reports -.->|"queries report data"| node_erp
node_settings -.->|"provides configuration"| node_erp
node_api -.->|"exposes services"| node_erp
node_print_patch -->|"patches print rendering"| node_erp

click node_member "https://github.com/tsea2010/sacco_manager/blob/main/sacco_manager/sacco_manager/doctype/sacco_member/sacco_member.py"
click node_member_api "https://github.com/tsea2010/sacco_manager/blob/main/sacco_manager/api/member_portal.py"
click node_sacco_api "https://github.com/tsea2010/sacco_manager/blob/main/sacco_manager/api/sacco_portal.py"
click node_portal_page "https://github.com/tsea2010/sacco_manager/blob/main/sacco_manager/www/sacco-portal.py"
click node_savings_account "https://github.com/tsea2010/sacco_manager/blob/main/sacco_manager/sacco_manager/doctype/sacco_savings_account/sacco_savings_account.py"
click node_savings_txn "https://github.com/tsea2010/sacco_manager/blob/main/sacco_manager/sacco_manager/doctype/sacco_savings_transaction/sacco_savings_transaction.py"
click node_shares "https://github.com/tsea2010/sacco_manager/blob/main/sacco_manager/sacco_manager/doctype/sacco_share_ledger/sacco_share_ledger.py"
click node_savings_run "https://github.com/tsea2010/sacco_manager/blob/main/sacco_manager/sacco_manager/doctype/sacco_monthly_savings_run/sacco_monthly_savings_run.py"
click node_withdrawal "https://github.com/tsea2010/sacco_manager/blob/main/sacco_manager/sacco_manager/doctype/withdrawal_request/withdrawal_request.py"
click node_loan_application "https://github.com/tsea2010/sacco_manager/blob/main/sacco_manager/overrides/loan_application.py"
click node_guarantor "https://github.com/tsea2010/sacco_manager/blob/main/sacco_manager/sacco_manager/doctype/sacco_loan_guarantor/sacco_loan_guarantor.py"
click node_loan_topup "https://github.com/tsea2010/sacco_manager/blob/main/sacco_manager/sacco_manager/doctype/loan_top_up/loan_top_up.py"
click node_loan_repayment "https://github.com/tsea2010/sacco_manager/blob/main/sacco_manager/overrides/loan_repayment.py"
click node_delinquency "https://github.com/tsea2010/sacco_manager/blob/main/sacco_manager/overrides/delinquency_interest.py"
click node_interest_run "https://github.com/tsea2010/sacco_manager/blob/main/sacco_manager/sacco_manager/doctype/sacco_interest_run/sacco_interest_run.py"
click node_remittance "https://github.com/tsea2010/sacco_manager/blob/main/sacco_manager/sacco_manager/doctype/sacco_branch_remittance/sacco_branch_remittance.py"
click node_registration_fee "https://github.com/tsea2010/sacco_manager/blob/main/sacco_manager/sacco_manager/doctype/sacco_registration_fee/sacco_registration_fee.py"
click node_account_type "https://github.com/tsea2010/sacco_manager/blob/main/sacco_manager/sacco_manager/doctype/sacco_account_type/sacco_account_type.py"
click node_settings "https://github.com/tsea2010/sacco_manager/blob/main/sacco_manager/sacco_manager/doctype/sacco_settings/sacco_settings.py"
click node_reports "https://github.com/tsea2010/sacco_manager/tree/main/sacco_manager/sacco_manager/report"
click node_api "https://github.com/tsea2010/sacco_manager/blob/main/sacco_manager/api/api.py"
click node_print_patch "https://github.com/tsea2010/sacco_manager/blob/main/sacco_manager/print_patches.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_member,node_member_user toneBlue
class node_savings_account,node_savings_txn,node_shares,node_savings_run,node_withdrawal,node_interest_run toneAmber
class node_loan_application,node_guarantor,node_loan_topup,node_loan_repayment,node_delinquency toneMint
class node_remittance,node_registration_fee,node_account_type,node_settings,node_reports,node_api,node_print_patch toneRose
class node_member_api,node_sacco_api,node_portal_page,node_staff,node_erp toneIndigo
```

## Components

### Membership

- [Member records](https://github.com/tsea2010/sacco_manager/blob/main/sacco_manager/sacco_manager/doctype/sacco_member/sacco_member.py): `sacco_manager/sacco_manager/doctype/sacco_member/sacco_member.py`

### Savings and shares

- [Savings accounts](https://github.com/tsea2010/sacco_manager/blob/main/sacco_manager/sacco_manager/doctype/sacco_savings_account/sacco_savings_account.py): `sacco_manager/sacco_manager/doctype/sacco_savings_account/sacco_savings_account.py`
- [Savings transactions](https://github.com/tsea2010/sacco_manager/blob/main/sacco_manager/sacco_manager/doctype/sacco_savings_transaction/sacco_savings_transaction.py): `sacco_manager/sacco_manager/doctype/sacco_savings_transaction/sacco_savings_transaction.py`
- [Share ledger](https://github.com/tsea2010/sacco_manager/blob/main/sacco_manager/sacco_manager/doctype/sacco_share_ledger/sacco_share_ledger.py): `sacco_manager/sacco_manager/doctype/sacco_share_ledger/sacco_share_ledger.py`
- [Monthly savings run](https://github.com/tsea2010/sacco_manager/blob/main/sacco_manager/sacco_manager/doctype/sacco_monthly_savings_run/sacco_monthly_savings_run.py): `sacco_manager/sacco_manager/doctype/sacco_monthly_savings_run/sacco_monthly_savings_run.py`
- [Withdrawal requests](https://github.com/tsea2010/sacco_manager/blob/main/sacco_manager/sacco_manager/doctype/withdrawal_request/withdrawal_request.py): `sacco_manager/sacco_manager/doctype/withdrawal_request/withdrawal_request.py`
- [Interest runs](https://github.com/tsea2010/sacco_manager/blob/main/sacco_manager/sacco_manager/doctype/sacco_interest_run/sacco_interest_run.py): `sacco_manager/sacco_manager/doctype/sacco_interest_run/sacco_interest_run.py`

### Lending

- [Loan applications](https://github.com/tsea2010/sacco_manager/blob/main/sacco_manager/overrides/loan_application.py): `sacco_manager/overrides/loan_application.py`
- [Loan guarantors](https://github.com/tsea2010/sacco_manager/blob/main/sacco_manager/sacco_manager/doctype/sacco_loan_guarantor/sacco_loan_guarantor.py): `sacco_manager/sacco_manager/doctype/sacco_loan_guarantor/sacco_loan_guarantor.py`
- [Loan top-ups](https://github.com/tsea2010/sacco_manager/blob/main/sacco_manager/sacco_manager/doctype/loan_top_up/loan_top_up.py): `sacco_manager/sacco_manager/doctype/loan_top_up/loan_top_up.py`
- [Loan repayment override](https://github.com/tsea2010/sacco_manager/blob/main/sacco_manager/overrides/loan_repayment.py): `sacco_manager/overrides/loan_repayment.py`
- [Delinquency interest](https://github.com/tsea2010/sacco_manager/blob/main/sacco_manager/overrides/delinquency_interest.py): `sacco_manager/overrides/delinquency_interest.py`

### Operations and reporting

- [Branch remittances](https://github.com/tsea2010/sacco_manager/blob/main/sacco_manager/sacco_manager/doctype/sacco_branch_remittance/sacco_branch_remittance.py): `sacco_manager/sacco_manager/doctype/sacco_branch_remittance/sacco_branch_remittance.py`
- [Registration fees](https://github.com/tsea2010/sacco_manager/blob/main/sacco_manager/sacco_manager/doctype/sacco_registration_fee/sacco_registration_fee.py): `sacco_manager/sacco_manager/doctype/sacco_registration_fee/sacco_registration_fee.py`
- [SACCO account types](https://github.com/tsea2010/sacco_manager/blob/main/sacco_manager/sacco_manager/doctype/sacco_account_type/sacco_account_type.py): `sacco_manager/sacco_manager/doctype/sacco_account_type/sacco_account_type.py`
- [SACCO settings](https://github.com/tsea2010/sacco_manager/blob/main/sacco_manager/sacco_manager/doctype/sacco_settings/sacco_settings.py): `sacco_manager/sacco_manager/doctype/sacco_settings/sacco_settings.py`
- [Branch and member reports](https://github.com/tsea2010/sacco_manager/tree/main/sacco_manager/sacco_manager/report): `sacco_manager/sacco_manager/report`
- [API endpoints](https://github.com/tsea2010/sacco_manager/blob/main/sacco_manager/api/api.py): `sacco_manager/api/api.py`
- [Print footer patch](https://github.com/tsea2010/sacco_manager/blob/main/sacco_manager/print_patches.py): `sacco_manager/print_patches.py`

### Member portal

- [Portal identity and summary](https://github.com/tsea2010/sacco_manager/blob/main/sacco_manager/api/member_portal.py): `sacco_manager/api/member_portal.py`
- [SACCO portal services](https://github.com/tsea2010/sacco_manager/blob/main/sacco_manager/api/sacco_portal.py): `sacco_manager/api/sacco_portal.py`
- [SACCO portal page](https://github.com/tsea2010/sacco_manager/blob/main/sacco_manager/www/sacco-portal.py): `sacco_manager/www/sacco-portal.py`

### Other components

- **SACCO staff**
- **Member user**
- **Frappe / ERPNext**

## Connections

- SACCO staff → Member records: manages
- Member records → Frappe / ERPNext: creates linked customer (evidence: `sacco_manager/sacco_manager/doctype/sacco_member/sacco_member.py`)
- Member user → Portal identity and summary: requests portal data
- Portal identity and summary → Member records: resolves member (evidence: `sacco_manager/api/member_portal.py`)
- Portal identity and summary → Savings accounts: reads account (evidence: `sacco_manager/api/member_portal.py`)
- Portal identity and summary → Frappe / ERPNext: queries loans and shares (evidence: `sacco_manager/api/member_portal.py`)
- SACCO portal page → Frappe / ERPNext: reads portal records (evidence: `sacco_manager/www/sacco-portal.py`)
- SACCO portal page → Frappe / ERPNext: creates loan security (evidence: `sacco_manager/www/sacco-portal.py`)
- SACCO portal services → Frappe / ERPNext: reads loans and savings (evidence: `sacco_manager/api/sacco_portal.py`)
- SACCO staff → Monthly savings run: runs monthly process
- SACCO staff → Interest runs: runs interest process
- SACCO staff → Branch remittances: records remittance
- Branch remittances → Frappe / ERPNext: posts transactions and journals (evidence: `sacco_manager/sacco_manager/doctype/sacco_branch_remittance/sacco_branch_remittance.py`)
- SACCO staff → Withdrawal requests: handles requests
- SACCO staff → Registration fees: records fees
- SACCO staff → Share ledger: records shares
- SACCO staff → Loan applications: validates applications
- SACCO staff → Loan top-ups: submits top-up
- Loan top-ups → Frappe / ERPNext: creates disbursement (evidence: `sacco_manager/sacco_manager/doctype/loan_top_up/loan_top_up.py`)
- Delinquency interest → Frappe / ERPNext: creates loan demand (evidence: `sacco_manager/overrides/delinquency_interest.py`)
- Branch and member reports → Frappe / ERPNext: queries report data
- SACCO settings → Frappe / ERPNext: provides configuration
- API endpoints → Frappe / ERPNext: exposes services
- Print footer patch → Frappe / ERPNext: patches print rendering (evidence: `sacco_manager/print_patches.py`)
