diff --git a/account-query/README.md b/account-query/README.md index 7c8bd539abd083ec98cbae1526e1436d327c8ed9..0f9db2696861a48bc06670085d5c74074dd0805e 100644 --- a/account-query/README.md +++ b/account-query/README.md @@ -1,6 +1,22 @@ # PA165 Balance Service -<p>The Balance Service, allows to view transaction history, provides a dashboard for bank employees to monitor all customers bank transactions. The system also provides a statistical module for employees, which can report total and average (per account) transactions (deposits, withdrawals, outgoing and incoming payments) in a selected date range.</p> +<p>The Balance Service, allows to view current balance of an account and +transaction history of an account from some date range. It also provides bank +employees an ability to monitor all customers bank transactions. +The service also provides a statistical module (for employees), which can +report total and average (per account) transactions (deposits, withdrawals, +outgoing and incoming payments) in a selected date range.</p> +<p>This service is composed of classes as can be seen on the diagram, +in repository there are balances of accounts stored. Every balance class has +current balance stored in itself together with a list of transactions which +led to this balance. Transaction consist of amount of money, transaction type, + time when it was stored, and processID created by transaction processor service. + +This service allows also creation of reports, which are computed from issued transactions. + Report class consists of six transactionStatistics classes, one for each type of + transaction and one for all transactions together. In this transactionStatistics +class, there is the total amount incoming/outgoing to/from account stored, with how many + times there was incoming/outgoing transaction.</p> 