Integration of reconciliations on home overview

lucasdillmann · lucasdillmann · commit fe1eaf7cb4a4 · 2025-10-05T03:06:55.000-03:00
diff --git a/android/src/main/kotlin/br/com/dillmann/fireflycompanion/android/home/main/HomeOverview.kt b/android/src/main/kotlin/br/com/dillmann/fireflycompanion/android/home/main/HomeOverview.kt
@@ -98,16 +98,27 @@ fun HomeOverview() {
                 valueProvider = { it.spent?.abs() },
             )
             DetailBlock(
-                title = i18n(R.string.left_to_spend),
+                title = i18n(R.string.reconciliation),
                 summary = summary,
                 tintColor = AppColors.Blue,
+                valueProvider = { it.reconciliations },
+            )
+            DetailBlock(
+                title = i18n(R.string.left_to_spend),
+                summary = summary,
+                tintColor = AppColors.Yellow,
                 valueProvider = { it.leftToSpend },
             )
             DetailBlock(
-                title = i18n(R.string.balance),
+                title = i18n(R.string.gross_balance),
                 summary = summary,
                 valueProvider = { it.balance },
             )
+            DetailBlock(
+                title = i18n(R.string.net_balance),
+                summary = summary,
+                valueProvider = { it.balance?.plus(it.reconciliations ?: BigDecimal.ZERO) },
+            )
         }
     }
 }
diff --git a/android/src/main/res/values-pt/strings.xml b/android/src/main/res/values-pt/strings.xml
@@ -24,7 +24,7 @@
     <string name="earned">Ganhos</string>
     <string name="spent">Gastos</string>
     <string name="left_to_spend">Orçamento restante</string>
-    <string name="balance">Balanço geral</string>
+    <string name="gross_balance">Balanço bruto</string>
     <string name="onboarding_main_title">Olá 👋</string>
     <string name="onboarding_main_message">Bem-vindo ao Firefly Companion. Antes de usar o aplicativo, precisamos nos
         conectar ao seu servidor Firefly III.
@@ -143,4 +143,5 @@
     <string name="to">até</string>
     <string name="to_pay_at">a pagar em</string>
     <string name="paid_at">pago em</string>
+    <string name="net_balance">Balanço final</string>
 </resources>
diff --git a/android/src/main/res/values/strings.xml b/android/src/main/res/values/strings.xml
@@ -24,7 +24,7 @@
     <string name="earned">Earned</string>
     <string name="spent">Spent</string>
     <string name="left_to_spend">Left to spend</string>
-    <string name="balance">Balance</string>
+    <string name="gross_balance">Gross balance</string>
     <string name="onboarding_main_title">Hello there 👋</string>
     <string name="onboarding_main_message">Welcome to Firefly Companion. Before using the app, we need to connect to
         your Firefly III server.
@@ -142,4 +142,5 @@
     <string name="to">to</string>
     <string name="to_pay_at">to pay at</string>
     <string name="paid_at">paid at</string>
+    <string name="net_balance">Net balance</string>
 </resources>
diff --git a/business/src/main/kotlin/br/com/dillmann/fireflycompanion/business/overview/model/SummaryOverview.kt b/business/src/main/kotlin/br/com/dillmann/fireflycompanion/business/overview/model/SummaryOverview.kt
@@ -13,4 +13,5 @@ data class SummaryOverview(
     val unpaidBills: BigDecimal? = null,
     val leftToSpend: BigDecimal? = null,
     val balance: BigDecimal? = null,
+    val reconciliations: BigDecimal? = null,
 ) : Serializable
diff --git a/http-client/firefly.http b/http-client/firefly.http
@@ -10,6 +10,10 @@ Authorization: Bearer {{token}}
 GET {{base-url}}/v1/accounts?type=asset&active=true
 Authorization: Bearer {{token}}
 
+### Transactions
+GET {{base-url}}/v1/transactions?start=2025-10-01&end=2025-10-31&type=reconciliation
+Authorization: Bearer {{token}}
+
 ### Expenses by category
 GET {{base-url}}/v1/insight/expense/category?start=2025-08-01&end=2025-08-30
 Authorization: Bearer {{token}}
diff --git a/third-party/src/main/kotlin/br/com/dillmann/fireflycompanion/thirdparty/summary/Module.kt b/third-party/src/main/kotlin/br/com/dillmann/fireflycompanion/thirdparty/summary/Module.kt
@@ -10,5 +10,5 @@ internal val SummaryModule =
     module {
         single { SummaryApi(get(Qualifiers.API_BASE_URL), get()) }
         single<SummaryConverter> { getConverter() }
-        single<OverviewRepository> { OverviewHttpRepository(get(), get(),get()) }
+        single<OverviewRepository> { OverviewHttpRepository(get(), get(), get(),get()) }
     }
diff --git a/third-party/src/main/kotlin/br/com/dillmann/fireflycompanion/thirdparty/summary/OverviewHttpRepository.kt b/third-party/src/main/kotlin/br/com/dillmann/fireflycompanion/thirdparty/summary/OverviewHttpRepository.kt
@@ -5,30 +5,86 @@ import br.com.dillmann.fireflycompanion.business.overview.OverviewRepository
 import br.com.dillmann.fireflycompanion.business.overview.model.SummaryOverview
 import br.com.dillmann.fireflycompanion.thirdparty.firefly.apis.InsightApi
 import br.com.dillmann.fireflycompanion.thirdparty.firefly.apis.SummaryApi
+import br.com.dillmann.fireflycompanion.thirdparty.firefly.apis.TransactionsApi
+import br.com.dillmann.fireflycompanion.thirdparty.firefly.models.AccountTypeProperty
+import br.com.dillmann.fireflycompanion.thirdparty.firefly.models.BasicSummaryEntry
+import br.com.dillmann.fireflycompanion.thirdparty.firefly.models.TransactionTypeFilter
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.Deferred
+import kotlinx.coroutines.async
+import kotlinx.coroutines.coroutineScope
+import java.math.BigDecimal
 import java.time.LocalDate
 
 internal class OverviewHttpRepository(
     private val summaryApi: SummaryApi,
+    private val transactions: TransactionsApi,
     private val insightApi: InsightApi,
     private val converter: SummaryConverter,
 ) : OverviewRepository {
     override suspend fun getSummaryByCurrency(
         startDate: LocalDate,
         endDate: LocalDate,
         currency: Currency,
-    ): SummaryOverview? {
-        val response =
+    ): SummaryOverview =
+        coroutineScope {
+            val basicSummary = getBasicSummary(startDate, endDate, currency)
+            val reconciliationAmount = getReconciliationAmount(startDate, endDate, currency)
+
+            converter.toDomain(
+                currency = currency,
+                summary = basicSummary.await(),
+                reconciliationAmount = reconciliationAmount.await(),
+            )
+        }
+
+    override suspend fun getExpensesByCategory(startDate: LocalDate, endDate: LocalDate) =
+        insightApi.insightExpenseCategory(start = startDate, end = endDate).map(converter::toDomain)
+
+    private fun CoroutineScope.getReconciliationAmount(
+        startDate: LocalDate,
+        endDate: LocalDate,
+        currency: Currency,
+    ): Deferred<BigDecimal> =
+        async {
+            var pageNumber = 1
+            val data = mutableListOf<BigDecimal>()
+
+            do {
+                val page =
+                    transactions.listTransaction(
+                        start = startDate,
+                        end = endDate,
+                        type = TransactionTypeFilter.RECONCILIATION,
+                        page = pageNumber++,
+                    )
+
+                data += page
+                    .data
+                    .flatMap { it.attributes.transactions }
+                    .filter { it.currencyId == currency.id }
+                    .map {
+                        if (it.sourceType == AccountTypeProperty.RECONCILIATION_ACCOUNT)
+                            it.amount.abs()
+                        else
+                            it.amount.abs().negate()
+                    }
+
+            } while (page.data.isNotEmpty())
+
+            data.sumOf { it }
+        }
+
+    private fun CoroutineScope.getBasicSummary(
+        startDate: LocalDate,
+        endDate: LocalDate,
+        currency: Currency,
+    ): Deferred<Map<String, BasicSummaryEntry>> =
+        async {
             summaryApi.getBasicSummary(
                 start = startDate,
                 end = endDate,
                 currencyCode = currency.code,
             )
-
-        return response
-            .takeIf { it.isNotEmpty() }
-            ?.let { converter.toDomain(currency, it) }
-    }
-
-    override suspend fun getExpensesByCategory(startDate: LocalDate, endDate: LocalDate) =
-        insightApi.insightExpenseCategory(start = startDate, end = endDate).map(converter::toDomain)
+        }
 }
diff --git a/third-party/src/main/kotlin/br/com/dillmann/fireflycompanion/thirdparty/summary/SummaryConverter.kt b/third-party/src/main/kotlin/br/com/dillmann/fireflycompanion/thirdparty/summary/SummaryConverter.kt
@@ -18,14 +18,19 @@ internal interface SummaryConverter {
     fun toDomain(input: InsightGroupEntry): ExpensesByCategoryOverview
 
     @Mapping(target = "currency", source = "currency")
-    @Mapping(target = "balance", expression = "java(getValue(\"balance\", currency, data))")
-    @Mapping(target = "spent", expression = "java(getValue(\"spent\", currency, data))")
-    @Mapping(target = "earned", expression = "java(getValue(\"earned\", currency, data))")
-    @Mapping(target = "billsPaid", expression = "java(getValue(\"bills-paid\", currency, data))")
-    @Mapping(target = "unpaidBills", expression = "java(getValue(\"bills-unpaid\", currency, data))")
-    @Mapping(target = "leftToSpend", expression = "java(getValue(\"left-to-spend\", currency, data))")
-    @Mapping(target = "netWorth", expression = "java(getValue(\"net-worth\", currency, data))")
-    fun toDomain(currency: Currency, data: Map<String, BasicSummaryEntry>): SummaryOverview
+    @Mapping(target = "balance", expression = "java(getValue(\"balance\", currency, summary))")
+    @Mapping(target = "spent", expression = "java(getValue(\"spent\", currency, summary))")
+    @Mapping(target = "earned", expression = "java(getValue(\"earned\", currency, summary))")
+    @Mapping(target = "billsPaid", expression = "java(getValue(\"bills-paid\", currency, summary))")
+    @Mapping(target = "unpaidBills", expression = "java(getValue(\"bills-unpaid\", currency, summary))")
+    @Mapping(target = "leftToSpend", expression = "java(getValue(\"left-to-spend\", currency, summary))")
+    @Mapping(target = "netWorth", expression = "java(getValue(\"net-worth\", currency, summary))")
+    @Mapping(target = "reconciliations", source = "reconciliationAmount")
+    fun toDomain(
+        currency: Currency,
+        summary: Map<String, BasicSummaryEntry>,
+        reconciliationAmount: BigDecimal,
+    ): SummaryOverview
 
     fun getValue(type: String, currency: Currency, data: Map<String, BasicSummaryEntry>): BigDecimal? =
         data["$type-in-${currency.code}"]?.monetaryValue
diff --git a/third-party/src/main/resources/spec/firefly-iii-v1.yaml b/third-party/src/main/resources/spec/firefly-iii-v1.yaml

Original file line number	Diff line number	Diff line change
`@@ -98,16 +98,27 @@ fun HomeOverview() {`
`98`	`98`	`valueProvider = { it.spent?.abs() },`
`99`	`99`	`)`
`100`	`100`	`DetailBlock(`
`101`		`- title = i18n(R.string.left_to_spend),`
	`101`	`+ title = i18n(R.string.reconciliation),`
`102`	`102`	`summary = summary,`
`103`	`103`	`tintColor = AppColors.Blue,`
	`104`	`+ valueProvider = { it.reconciliations },`
	`105`	`+ )`
	`106`	`+ DetailBlock(`
	`107`	`+ title = i18n(R.string.left_to_spend),`
	`108`	`+ summary = summary,`
	`109`	`+ tintColor = AppColors.Yellow,`
`104`	`110`	`valueProvider = { it.leftToSpend },`
`105`	`111`	`)`
`106`	`112`	`DetailBlock(`
`107`		`- title = i18n(R.string.balance),`
	`113`	`+ title = i18n(R.string.gross_balance),`
`108`	`114`	`summary = summary,`
`109`	`115`	`valueProvider = { it.balance },`
`110`	`116`	`)`
	`117`	`+ DetailBlock(`
	`118`	`+ title = i18n(R.string.net_balance),`
	`119`	`+ summary = summary,`
	`120`	`+ valueProvider = { it.balance?.plus(it.reconciliations ?: BigDecimal.ZERO) },`
	`121`	`+ )`
`111`	`122`	`}`
`112`	`123`	`}`
`113`	`124`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,5 +10,5 @@ internal val SummaryModule =`
`10`	`10`	`module {`
`11`	`11`	`single { SummaryApi(get(Qualifiers.API_BASE_URL), get()) }`
`12`	`12`	`single<SummaryConverter> { getConverter() }`
`13`		`- single<OverviewRepository> { OverviewHttpRepository(get(), get(),get()) }`
	`13`	`+ single<OverviewRepository> { OverviewHttpRepository(get(), get(), get(),get()) }`
`14`	`14`	`}`