# razdeep/openconsignment architecture

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

- Interactive diagram: https://gitdiagram.com/razdeep/openconsignment
- Repository: https://github.com/razdeep/openconsignment

## Overview

OpenConsignment is a JavaFX desktop application for consignment accounting. Its principal workflow is entering bills and their lorry-receipt details, then recording buyer collections and supplier payments against pending bills; users can review history and generate buyer, supplier, and transport ledgers, including agewise reports. The code is organized around feature controllers, domain services, and JDBC repositories, with local SQLite storage and JasperReports PDF generation. Some feature links and subsystem details are documented in the README or indicated by the SOURCE INDEX; unsampled implementation calls are not asserted.

Main entry points: [`src/main/java/openconsignment/service/BuyerService.java`](https://github.com/razdeep/openconsignment/blob/main/src/main/java/openconsignment/service/BuyerService.java) (Buyer service), [`src/main/java/openconsignment/service/SupplierService.java`](https://github.com/razdeep/openconsignment/blob/main/src/main/java/openconsignment/service/SupplierService.java) (Supplier service), [`src/main/java/openconsignment/service/CollectionService.java`](https://github.com/razdeep/openconsignment/blob/main/src/main/java/openconsignment/service/CollectionService.java) (Collection service), [`src/main/java/openconsignment/service/PaymentService.java`](https://github.com/razdeep/openconsignment/blob/main/src/main/java/openconsignment/service/PaymentService.java) (Payment service)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_ui["Desktop interface"]
  node_main["Main navigation"]
  node_viewloader["View loader<br/>[ViewLoader.java]"]
  node_masterui["Master data screens"]
  node_billui["Bill entry and history"]
  node_collectionui["Collection screens"]
  node_paymentui["Payment screens"]
  node_historyui["Transaction history"]
  node_reportui["Ledger screens"]
end

subgraph group_operations["Consignment operations"]
  node_billservice["Bill service<br/>[BillService.java]"]
  node_collectionservice["Collection service"]
  node_paymentservice["Payment service"]
  node_buyer["Buyer service<br/>[BuyerService.java]"]
  node_supplier["Supplier service"]
  node_transport["Transport service"]
end

subgraph group_reporting["Ledgers and reports"]
  node_pdf["PDF generation<br/>[Utils.java]"]
end

subgraph group_data["Domain and persistence"]
  node_entities["Transaction entities"]
  node_models["Ledger read models"]
  node_billrepo["Bill repository"]
  node_collectionrepo["Collection repository"]
  node_paymentrepo["Payment repository"]
  node_buyerrepo["Buyer repository"]
  node_supplierrepo["Supplier repository"]
  node_transportrepo["Transport repository"]
end

node_user(("User"))
node_sqlite[("SQLite database")]

node_user -->|"uses"| node_main
node_main -->|"loads views"| node_viewloader
node_billui -->|"calls"| node_billservice
node_collectionui -->|"calls"| node_collectionservice
node_paymentui -->|"calls"| node_paymentservice
node_masterui -->|"manages buyers"| node_buyer
node_masterui -->|"manages suppliers"| node_supplier
node_masterui -->|"manages transports"| node_transport
node_reportui -->|"requests ledgers"| node_buyer
node_reportui -->|"requests ledgers"| node_supplier
node_reportui -->|"requests ledgers"| node_transport
node_historyui -->|"reads history"| node_billservice
node_billservice -->|"delegates"| node_billrepo
node_collectionservice -->|"delegates"| node_collectionrepo
node_paymentservice -->|"delegates"| node_paymentrepo
node_buyer -->|"delegates"| node_buyerrepo
node_supplier -->|"delegates"| node_supplierrepo
node_billrepo -.->|"reads and writes"| node_sqlite
node_collectionrepo -.->|"reads and writes"| node_sqlite
node_paymentrepo -.->|"reads and writes"| node_sqlite
node_buyerrepo -.->|"reads and writes"| node_sqlite
node_supplierrepo -.->|"reads and writes"| node_sqlite
node_transportrepo -.->|"reads and writes"| node_sqlite
node_buyer -->|"fetches collection data"| node_collectionservice
node_supplier -->|"fetches payment data"| node_paymentservice
node_buyer -->|"generates ledger PDF"| node_pdf
node_supplier -->|"generates ledger PDF"| node_pdf
node_collectionservice -->|"generates voucher PDF"| node_pdf
node_paymentservice -->|"generates voucher PDF"| node_pdf

click node_main "https://github.com/razdeep/openconsignment/blob/main/src/main/java/openconsignment/controller/MainController.java"
click node_viewloader "https://github.com/razdeep/openconsignment/blob/main/src/main/java/openconsignment/common/ViewLoader.java"
click node_masterui "https://github.com/razdeep/openconsignment/tree/main/src/main/java/openconsignment/controller/master"
click node_billui "https://github.com/razdeep/openconsignment/tree/main/src/main/java/openconsignment/controller/entry/bill"
click node_collectionui "https://github.com/razdeep/openconsignment/tree/main/src/main/java/openconsignment/controller/entry/collection"
click node_paymentui "https://github.com/razdeep/openconsignment/tree/main/src/main/java/openconsignment/controller/entry/payment"
click node_historyui "https://github.com/razdeep/openconsignment/tree/main/src/main/java/openconsignment/controller/history"
click node_reportui "https://github.com/razdeep/openconsignment/tree/main/src/main/java/openconsignment/controller/report"
click node_billservice "https://github.com/razdeep/openconsignment/blob/main/src/main/java/openconsignment/service/BillService.java"
click node_collectionservice "https://github.com/razdeep/openconsignment/blob/main/src/main/java/openconsignment/service/CollectionService.java"
click node_paymentservice "https://github.com/razdeep/openconsignment/blob/main/src/main/java/openconsignment/service/PaymentService.java"
click node_buyer "https://github.com/razdeep/openconsignment/blob/main/src/main/java/openconsignment/service/BuyerService.java"
click node_supplier "https://github.com/razdeep/openconsignment/blob/main/src/main/java/openconsignment/service/SupplierService.java"
click node_transport "https://github.com/razdeep/openconsignment/blob/main/src/main/java/openconsignment/service/TransportService.java"
click node_entities "https://github.com/razdeep/openconsignment/tree/main/src/main/java/openconsignment/entity"
click node_models "https://github.com/razdeep/openconsignment/tree/main/src/main/java/openconsignment/model"
click node_billrepo "https://github.com/razdeep/openconsignment/blob/main/src/main/java/openconsignment/repository/BillRepository.java"
click node_collectionrepo "https://github.com/razdeep/openconsignment/blob/main/src/main/java/openconsignment/repository/CollectionRepository.java"
click node_paymentrepo "https://github.com/razdeep/openconsignment/blob/main/src/main/java/openconsignment/repository/PaymentRepository.java"
click node_buyerrepo "https://github.com/razdeep/openconsignment/blob/main/src/main/java/openconsignment/repository/BuyerRepository.java"
click node_supplierrepo "https://github.com/razdeep/openconsignment/blob/main/src/main/java/openconsignment/repository/SupplierRepository.java"
click node_transportrepo "https://github.com/razdeep/openconsignment/blob/main/src/main/java/openconsignment/repository/TransportRepository.java"
click node_pdf "https://github.com/razdeep/openconsignment/blob/main/src/main/java/openconsignment/common/Utils.java"

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_main,node_viewloader,node_masterui,node_billui,node_collectionui,node_paymentui,node_historyui,node_reportui,node_user toneBlue
class node_billservice,node_collectionservice,node_paymentservice,node_buyer,node_supplier,node_transport,node_sqlite toneAmber
class node_pdf toneMint
class node_entities,node_models,node_billrepo,node_collectionrepo,node_paymentrepo,node_buyerrepo,node_supplierrepo,node_transportrepo toneRose
```

## Components

### Desktop interface

- [Main navigation](https://github.com/razdeep/openconsignment/blob/main/src/main/java/openconsignment/controller/MainController.java): `src/main/java/openconsignment/controller/MainController.java`
- [View loader](https://github.com/razdeep/openconsignment/blob/main/src/main/java/openconsignment/common/ViewLoader.java): `src/main/java/openconsignment/common/ViewLoader.java`
- [Master data screens](https://github.com/razdeep/openconsignment/tree/main/src/main/java/openconsignment/controller/master): `src/main/java/openconsignment/controller/master`
- [Bill entry and history](https://github.com/razdeep/openconsignment/tree/main/src/main/java/openconsignment/controller/entry/bill): `src/main/java/openconsignment/controller/entry/bill`
- [Collection screens](https://github.com/razdeep/openconsignment/tree/main/src/main/java/openconsignment/controller/entry/collection): `src/main/java/openconsignment/controller/entry/collection`
- [Payment screens](https://github.com/razdeep/openconsignment/tree/main/src/main/java/openconsignment/controller/entry/payment): `src/main/java/openconsignment/controller/entry/payment`
- [Transaction history](https://github.com/razdeep/openconsignment/tree/main/src/main/java/openconsignment/controller/history): `src/main/java/openconsignment/controller/history`
- [Ledger screens](https://github.com/razdeep/openconsignment/tree/main/src/main/java/openconsignment/controller/report): `src/main/java/openconsignment/controller/report`

### Consignment operations

- [Bill service](https://github.com/razdeep/openconsignment/blob/main/src/main/java/openconsignment/service/BillService.java): `src/main/java/openconsignment/service/BillService.java`
- [Collection service](https://github.com/razdeep/openconsignment/blob/main/src/main/java/openconsignment/service/CollectionService.java): `src/main/java/openconsignment/service/CollectionService.java`
- [Payment service](https://github.com/razdeep/openconsignment/blob/main/src/main/java/openconsignment/service/PaymentService.java): `src/main/java/openconsignment/service/PaymentService.java`
- [Buyer service](https://github.com/razdeep/openconsignment/blob/main/src/main/java/openconsignment/service/BuyerService.java): `src/main/java/openconsignment/service/BuyerService.java`
- [Supplier service](https://github.com/razdeep/openconsignment/blob/main/src/main/java/openconsignment/service/SupplierService.java): `src/main/java/openconsignment/service/SupplierService.java`
- [Transport service](https://github.com/razdeep/openconsignment/blob/main/src/main/java/openconsignment/service/TransportService.java): `src/main/java/openconsignment/service/TransportService.java`

### Ledgers and reports

- [PDF generation](https://github.com/razdeep/openconsignment/blob/main/src/main/java/openconsignment/common/Utils.java): `src/main/java/openconsignment/common/Utils.java`

### Domain and persistence

- [Transaction entities](https://github.com/razdeep/openconsignment/tree/main/src/main/java/openconsignment/entity): `src/main/java/openconsignment/entity`
- [Ledger read models](https://github.com/razdeep/openconsignment/tree/main/src/main/java/openconsignment/model): `src/main/java/openconsignment/model`
- [Bill repository](https://github.com/razdeep/openconsignment/blob/main/src/main/java/openconsignment/repository/BillRepository.java): `src/main/java/openconsignment/repository/BillRepository.java`
- [Collection repository](https://github.com/razdeep/openconsignment/blob/main/src/main/java/openconsignment/repository/CollectionRepository.java): `src/main/java/openconsignment/repository/CollectionRepository.java`
- [Payment repository](https://github.com/razdeep/openconsignment/blob/main/src/main/java/openconsignment/repository/PaymentRepository.java): `src/main/java/openconsignment/repository/PaymentRepository.java`
- [Buyer repository](https://github.com/razdeep/openconsignment/blob/main/src/main/java/openconsignment/repository/BuyerRepository.java): `src/main/java/openconsignment/repository/BuyerRepository.java`
- [Supplier repository](https://github.com/razdeep/openconsignment/blob/main/src/main/java/openconsignment/repository/SupplierRepository.java): `src/main/java/openconsignment/repository/SupplierRepository.java`
- [Transport repository](https://github.com/razdeep/openconsignment/blob/main/src/main/java/openconsignment/repository/TransportRepository.java): `src/main/java/openconsignment/repository/TransportRepository.java`

### Other components

- **User**
- **SQLite database**

## Connections

- User → Main navigation: uses
- Main navigation → View loader: loads views (evidence: `src/main/java/openconsignment/controller/MainController.java`)
- Bill entry and history → Bill service: calls (evidence: `src/main/java/openconsignment/controller/entry/bill/AddBillController.java`)
- Collection screens → Collection service: calls (evidence: `src/main/java/openconsignment/controller/entry/collection/AddCollectionController.java`)
- Payment screens → Payment service: calls (evidence: `src/main/java/openconsignment/controller/entry/payment/AddPaymentController.java`)
- Master data screens → Buyer service: manages buyers (evidence: `src/main/java/openconsignment/controller/master/SupplierController.java`)
- Master data screens → Supplier service: manages suppliers (evidence: `src/main/java/openconsignment/controller/master/SupplierController.java`)
- Master data screens → Transport service: manages transports (evidence: `src/main/java/openconsignment/controller/master/TransportController.java`)
- Ledger screens → Buyer service: requests ledgers (evidence: `src/main/java/openconsignment/controller/report/SupplierLedgerController.java`)
- Ledger screens → Supplier service: requests ledgers (evidence: `src/main/java/openconsignment/controller/report/SupplierLedgerController.java`)
- Ledger screens → Transport service: requests ledgers (evidence: `src/main/java/openconsignment/controller/report/TransportLedgerController.java`)
- Transaction history → Bill service: reads history (evidence: `src/main/java/openconsignment/controller/history/BillHistoryController.java`)
- Bill service → Bill repository: delegates (evidence: `src/main/java/openconsignment/service/BillService.java`)
- Collection service → Collection repository: delegates (evidence: `src/main/java/openconsignment/service/CollectionService.java`)
- Payment service → Payment repository: delegates (evidence: `src/main/java/openconsignment/service/PaymentService.java`)
- Buyer service → Buyer repository: delegates (evidence: `src/main/java/openconsignment/service/BuyerService.java`)
- Supplier service → Supplier repository: delegates (evidence: `src/main/java/openconsignment/service/SupplierService.java`)
- Bill repository → SQLite database: reads and writes
- Collection repository → SQLite database: reads and writes
- Payment repository → SQLite database: reads and writes
- Buyer repository → SQLite database: reads and writes
- Supplier repository → SQLite database: reads and writes
- Transport repository → SQLite database: reads and writes
- Buyer service → Collection service: fetches collection data (evidence: `src/main/java/openconsignment/service/BuyerService.java`)
- Supplier service → Payment service: fetches payment data (evidence: `src/main/java/openconsignment/service/SupplierService.java`)
- Buyer service → PDF generation: generates ledger PDF (evidence: `src/main/java/openconsignment/service/BuyerService.java`)
- Supplier service → PDF generation: generates ledger PDF (evidence: `src/main/java/openconsignment/service/SupplierService.java`)
- Collection service → PDF generation: generates voucher PDF (evidence: `src/main/java/openconsignment/service/CollectionService.java`)
- Payment service → PDF generation: generates voucher PDF (evidence: `src/main/java/openconsignment/service/PaymentService.java`)
