Compare commits

...
8 Commits
Author SHA1 Message Date
niteshandClaude Opus 5.5 936e21dcf6 Merge branch 'feature/fd-interest-posting' into dev-latest
Fineract Build & Cucumber tests (without E2E tests) / verify (main, build-core) (push) Canceled after 0s
Fineract Build & Cucumber tests (without E2E tests) / verify (main, cucumber) (push) Canceled after 0s
Fineract Build & Cucumber tests (without E2E tests) / verify (progressive-loan, build-progressive-loan) (push) Canceled after 0s
Fineract Docker Builds / build (false, docker-compose-postgresql.yml, postgresql) (push) Canceled after 0s
Fineract Cargo & Unit- & Integration tests - MariaDB / test (test-core-2) (push) Canceled after 0s
Fineract Cargo & Unit- & Integration tests - MariaDB / test (test-core-3) (push) Canceled after 0s
Fineract Cargo & Unit- & Integration tests - MariaDB / test (test-core-4) (push) Canceled after 0s
Fineract Docker Builds / build (true, docker-compose.yml, mariadb) (push) Canceled after 0s
Fineract Documentation build / build (push) Canceled after 0s
Fineract E2E Tests / E2E Tests (Shard 1 of 10) (push) Canceled after 0s
Fineract E2E Tests / E2E Tests (Shard 10 of 10) (push) Canceled after 0s
Fineract E2E Tests / E2E Tests (Shard 2 of 10) (push) Canceled after 0s
Fineract E2E Tests / E2E Tests (Shard 3 of 10) (push) Canceled after 0s
Fineract E2E Tests / E2E Tests (Shard 4 of 10) (push) Canceled after 0s
Fineract E2E Tests / E2E Tests (Shard 5 of 10) (push) Canceled after 0s
Fineract E2E Tests / E2E Tests (Shard 6 of 10) (push) Canceled after 0s
Fineract E2E Tests / E2E Tests (Shard 7 of 10) (push) Canceled after 0s
Fineract E2E Tests / E2E Tests (Shard 8 of 10) (push) Canceled after 0s
Fineract E2E Tests / E2E Tests (Shard 9 of 10) (push) Canceled after 0s
Fineract Cargo & Unit- & Integration tests - MariaDB / test (test-core-1) (push) Canceled after 0s
Fineract Cargo & Unit- & Integration tests - MariaDB / test (test-core-5) (push) Canceled after 0s
Fineract Cargo & Unit- & Integration tests - MySQL / test (test-core-1) (push) Canceled after 0s
Fineract Cargo & Unit- & Integration tests - MySQL / test (test-core-2) (push) Canceled after 0s
Fineract Cargo & Unit- & Integration tests - MySQL / test (test-core-3) (push) Canceled after 0s
Fineract Cargo & Unit- & Integration tests - MySQL / test (test-core-4) (push) Canceled after 0s
Fineract Cargo & Unit- & Integration tests - MySQL / test (test-core-5) (push) Canceled after 0s
Fineract Cargo & Unit- & Integration tests - PostgreSQL / test (test-core-1) (push) Canceled after 0s
Fineract Cargo & Unit- & Integration tests - PostgreSQL / test (test-core-2) (push) Canceled after 0s
Fineract Cargo & Unit- & Integration tests - PostgreSQL / test (test-core-3) (push) Canceled after 0s
Fineract Cargo & Unit- & Integration tests - PostgreSQL / test (test-core-4) (push) Canceled after 0s
Fineract Cargo & Unit- & Integration tests - PostgreSQL / test (test-core-5) (push) Canceled after 0s
Fineract Liquibase Only mode - PostgreSQL / test (push) Canceled after 0s
Fineract Messaging Smoke Tests / Smoke Test with ActiveMQ (push) Canceled after 0s
Fineract Messaging Smoke Tests / Smoke Test with Kafka (push) Canceled after 0s
Brings the FD interest posting work into dev-latest:
- FD interest posting approval with pooled GL postings, posting period
  shown per line, maturity postings surfaced, double-posting guard
- FD maturity approval report added and then reverted (maturity now
  runs directly through the scheduler, no approval step)
- Pending user approval encodes the password and emails it
- New-tenant user personalisation, with the 'system' username kept so
  scheduler jobs and COB can still find the system user

Conflicts resolved:
- SavingsAccountReadPlatformServiceImpl#retrieveAllSavingsDataForInterestPosting:
  kept both exclusions. Recurring deposits (deposit_type_enum 300) stay
  out of the generic interest posting job (dev-latest), and fixed
  deposits are also left out when FD interest posting approval is
  enabled (feature branch), so FD interest is not paid twice.
  Comments from both sides merged.
- final-changelog-tenant.xml: kept dev-latest's 0592-0598 TDS and
  recurring deposit changelogs and added
  0593_fd_interest_posting_approval.xml after them. The file keeps its
  name although its number clashes with 0593_tds_...: Liquibase tracks
  changesets by file path, so renaming it would re-run it on databases
  that already applied it. Changeset ids in the two files differ.

Verified with :fineract-provider:compileJava.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-12 12:23:55 +05:30
niteshandClaude Opus 5.5 aceea89c5c fix(tenants): keep the 'system' username when provisioning a new tenant
Fineract Cargo & Unit- & Integration tests - MySQL / test (test-core-1) (push) Canceled after 0s
Fineract Build & Cucumber tests (without E2E tests) / verify (main, build-core) (push) Canceled after 0s
Fineract Build & Cucumber tests (without E2E tests) / verify (main, cucumber) (push) Canceled after 0s
Fineract Build & Cucumber tests (without E2E tests) / verify (progressive-loan, build-progressive-loan) (push) Canceled after 0s
Fineract Docker Builds / build (false, docker-compose-postgresql.yml, postgresql) (push) Canceled after 0s
Fineract Docker Builds / build (true, docker-compose.yml, mariadb) (push) Canceled after 0s
Fineract Cargo & Unit- & Integration tests - MySQL / test (test-core-2) (push) Canceled after 0s
Fineract Documentation build / build (push) Canceled after 0s
Fineract E2E Tests / E2E Tests (Shard 1 of 10) (push) Canceled after 0s
Fineract E2E Tests / E2E Tests (Shard 10 of 10) (push) Canceled after 0s
Fineract E2E Tests / E2E Tests (Shard 2 of 10) (push) Canceled after 0s
Fineract E2E Tests / E2E Tests (Shard 3 of 10) (push) Canceled after 0s
Fineract E2E Tests / E2E Tests (Shard 4 of 10) (push) Canceled after 0s
Fineract E2E Tests / E2E Tests (Shard 5 of 10) (push) Canceled after 0s
Fineract E2E Tests / E2E Tests (Shard 6 of 10) (push) Canceled after 0s
Fineract E2E Tests / E2E Tests (Shard 7 of 10) (push) Canceled after 0s
Fineract E2E Tests / E2E Tests (Shard 8 of 10) (push) Canceled after 0s
Fineract E2E Tests / E2E Tests (Shard 9 of 10) (push) Canceled after 0s
Fineract Cargo & Unit- & Integration tests - MariaDB / test (test-core-1) (push) Canceled after 0s
Fineract Cargo & Unit- & Integration tests - MariaDB / test (test-core-2) (push) Canceled after 0s
Fineract Cargo & Unit- & Integration tests - MariaDB / test (test-core-3) (push) Canceled after 0s
Fineract Cargo & Unit- & Integration tests - MariaDB / test (test-core-4) (push) Canceled after 0s
Fineract Cargo & Unit- & Integration tests - MariaDB / test (test-core-5) (push) Canceled after 0s
Fineract Cargo & Unit- & Integration tests - MySQL / test (test-core-3) (push) Canceled after 0s
Fineract Cargo & Unit- & Integration tests - MySQL / test (test-core-4) (push) Canceled after 0s
Fineract Cargo & Unit- & Integration tests - MySQL / test (test-core-5) (push) Canceled after 0s
Fineract Cargo & Unit- & Integration tests - PostgreSQL / test (test-core-1) (push) Canceled after 0s
Fineract Cargo & Unit- & Integration tests - PostgreSQL / test (test-core-2) (push) Canceled after 0s
Fineract Cargo & Unit- & Integration tests - PostgreSQL / test (test-core-3) (push) Canceled after 0s
Fineract Cargo & Unit- & Integration tests - PostgreSQL / test (test-core-4) (push) Canceled after 0s
Fineract Cargo & Unit- & Integration tests - PostgreSQL / test (test-core-5) (push) Canceled after 0s
Fineract Liquibase Only mode - PostgreSQL / test (push) Canceled after 0s
Fineract Messaging Smoke Tests / Smoke Test with ActiveMQ (push) Canceled after 0s
Fineract Messaging Smoke Tests / Smoke Test with Kafka (push) Canceled after 0s
Problem
Commit 3d3ce92e9 personalised the three users seeded into a brand-new
tenant database and renamed user id 2 from 'system' to
'<tenant>_system' (for example 'default_system'). Fineract looks this
user up by the fixed name AppUserConstants.SYSTEM_USER_NAME ('system')
through AppUserRepositoryWrapper.fetchSystemUser(), so on every fresh
tenant:
- every scheduler job failed once a minute with
  "UserNotFoundException: User with name 'system' does not exist"
  (seen with the Send Asynchronous Events job);
- COB initialisation, savings escheat, current account closure and the
  stuck-job listener would fail in the same way.
Existing tenants were not affected because the provisioner only runs
right after the very first migration of a new tenant.

Fix
- TenantInitialUserProvisioner now sets user id 2's username to
  AppUserConstants.SYSTEM_USER_NAME and only replaces its password.
- Admin and interop users are still personalised as
  '<tenant>_admin' and '<tenant>_interop'.
- Javadoc and the startup log line now say the system user keeps its
  name and why.

Resulting users on a new tenant
- <tenant>_admin    (password: initial-user-password or built-in default)
- system            (same password, name unchanged)
- <tenant>_interop  (same password)

Tenants already created with '<tenant>_system' need a one-off fix:
  UPDATE m_appuser SET username = 'system' WHERE id = 2;

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-12 11:55:18 +05:30
niteshandClaude Sonnet 5 1fd94615a9 revert(fixed-deposits): remove FD maturity approval report
Fineract Cargo & Unit- & Integration tests - MariaDB / test (test-core-1) (push) Canceled after 0s
Fineract Cargo & Unit- & Integration tests - MariaDB / test (test-core-2) (push) Canceled after 0s
Fineract Cargo & Unit- & Integration tests - MariaDB / test (test-core-3) (push) Canceled after 0s
Fineract Cargo & Unit- & Integration tests - MariaDB / test (test-core-4) (push) Canceled after 0s
Fineract Cargo & Unit- & Integration tests - MariaDB / test (test-core-5) (push) Canceled after 0s
Fineract Cargo & Unit- & Integration tests - MySQL / test (test-core-1) (push) Canceled after 0s
Fineract Cargo & Unit- & Integration tests - MySQL / test (test-core-2) (push) Canceled after 0s
Fineract Cargo & Unit- & Integration tests - MySQL / test (test-core-3) (push) Canceled after 0s
Fineract Cargo & Unit- & Integration tests - MySQL / test (test-core-4) (push) Canceled after 0s
Fineract Cargo & Unit- & Integration tests - MySQL / test (test-core-5) (push) Canceled after 0s
Fineract Build & Cucumber tests (without E2E tests) / verify (main, build-core) (push) Canceled after 0s
Fineract Build & Cucumber tests (without E2E tests) / verify (main, cucumber) (push) Canceled after 0s
Fineract Build & Cucumber tests (without E2E tests) / verify (progressive-loan, build-progressive-loan) (push) Canceled after 0s
Fineract E2E Tests / E2E Tests (Shard 5 of 10) (push) Canceled after 0s
Fineract E2E Tests / E2E Tests (Shard 6 of 10) (push) Canceled after 0s
Fineract E2E Tests / E2E Tests (Shard 7 of 10) (push) Canceled after 0s
Fineract E2E Tests / E2E Tests (Shard 8 of 10) (push) Canceled after 0s
Fineract Docker Builds / build (false, docker-compose-postgresql.yml, postgresql) (push) Canceled after 0s
Fineract E2E Tests / E2E Tests (Shard 1 of 10) (push) Canceled after 0s
Fineract E2E Tests / E2E Tests (Shard 10 of 10) (push) Canceled after 0s
Fineract E2E Tests / E2E Tests (Shard 2 of 10) (push) Canceled after 0s
Fineract E2E Tests / E2E Tests (Shard 3 of 10) (push) Canceled after 0s
Fineract E2E Tests / E2E Tests (Shard 4 of 10) (push) Canceled after 0s
Fineract Cargo & Unit- & Integration tests - PostgreSQL / test (test-core-3) (push) Canceled after 0s
Fineract Cargo & Unit- & Integration tests - PostgreSQL / test (test-core-4) (push) Canceled after 0s
Fineract Cargo & Unit- & Integration tests - PostgreSQL / test (test-core-5) (push) Canceled after 0s
Fineract E2E Tests / E2E Tests (Shard 9 of 10) (push) Canceled after 0s
Fineract Docker Builds / build (true, docker-compose.yml, mariadb) (push) Canceled after 0s
Fineract Documentation build / build (push) Canceled after 0s
Fineract Cargo & Unit- & Integration tests - PostgreSQL / test (test-core-1) (push) Canceled after 0s
Fineract Cargo & Unit- & Integration tests - PostgreSQL / test (test-core-2) (push) Canceled after 0s
Fineract Liquibase Only mode - PostgreSQL / test (push) Canceled after 0s
Fineract Messaging Smoke Tests / Smoke Test with ActiveMQ (push) Canceled after 0s
Fineract Messaging Smoke Tests / Smoke Test with Kafka (push) Canceled after 0s
A fixed deposit's maturity is settled directly by the nightly
updateMaturityDetails job again, unconditionally, for every deposit
type and every closure instruction — the approval gate this introduced
turned out to risk more than it protected and is being removed before
it ever shipped enabled by default.

Removes the fdmaturity package entire (report service, orchestrator,
API resource, noon-generation job), its migration and global
configuration, the day-close integration in BranchDayRegisterApiResource,
and FixedDepositAccount#previewMaturityInterestPeriods, which existed
only for this report's preview and has no other caller.

The periodic FD interest posting approval report (0593) is untouched —
a matured deposit's final interest, paid directly by the nightly job,
already surfaces there under "Posted outside approval", same as it did
before this report existed.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
2026-10-09 12:50:11 +05:30
niteshandClaude Sonnet 5 3d3ce92e93 feat(tenants): personalise seeded user credentials for a brand-new tenant
Adds TenantInitialUserProvisioner: right after the very first Liquibase
migration of a tenant that was never on Flyway, renames the three
seeded users (ids 1-3, otherwise shipping as mifos/system/interopUser
with the public default password) to <tenantIdentifier>_admin/_system/
_interop, with a password from fineract.tenant.initial-user-password
or a built-in default. An existing (Flyway-era) tenant already has its
real users and is left untouched. Wired through TenantDatabaseUpgradeService
and its two test configurations.

Also fixes the two pooled interest-posting services' system-user
lookup, which read username = 'system' — now wrong since that username
is personalised per tenant — to find the seeded system user by its
fixed id (2) instead.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
2026-10-08 22:41:25 +05:30
niteshandClaude Sonnet 5 1a914a3de0 feat(fixed-deposits): maturity approval report, scoped to deposits with no closure instruction
Adds the FD maturity approval workflow: a deposit with no closure
instruction of its own (Maturity Instructions left "Not selected")
waits — status, final interest and whatever renewal is later chosen
from the FD Dashboard all run together in one real maturity run, only
once a second user approves the report, as the branch closes its day.

A deposit that already named Transfer to Savings or a Reinvest option
settles itself the moment it matures, unchanged — a decision the
customer already made in writing needs no second approval. The
nightly job is narrowed to skip only the undecided ones;
FixedDepositAccount#previewMaturityInterestPeriods reads the same
maturity-interest calculation the real posting uses, without writing
anything down, so the report's figure is never a guess.

Posting an approved report calls the existing, unchanged
DepositAccountWritePlatformService#updateMaturityDetails per deposit,
each in its own transaction — one with a bad closure target does not
hold up the others, and a retry only touches what did not post last
time.

Adds a reconciliation view (outside-approval) listing deposits that
matured via their own closure instruction, same reasoning as the
interest report's: found by what has no report line, not by naming
the instruction, so a future direct path is caught here too.

Day-close integration mirrors the interest report exactly: blocks on
a pending maturity report, posts approved ones alongside approved
interest reports, independently so one failing does not stop the
other.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
2026-10-08 19:06:40 +05:30
niteshandClaude Opus 5 6e7eb94776 fix(users): encode password and email it when approving a pending user creation
finalizeCreateUser() (run when a checker approves a CREATE_USER request queued
in m_user_pending_request) saved AppUser.fromJson()'s result straight to
m_appuser via appUserRepository.saveAndFlush() with no encoding step for the
password AppUser.fromJson() auto-generates when the maker ticks "send password
to email" -- AppUser's constructor stores whatever string it is given
verbatim, so that random password was landing in m_appuser.password as plain
text. Only the maker-chosen-password case (request.getPasswordHash() != null)
was ever hashed, because that happens earlier, at submitCreateUser() time.

It also never called the email service at all, in either case. The live
create-user flow (JpaUserDomainService.create()) captures the unencoded
password, encodes it, saves, then emails the welcome message --
finalizeCreateUser() duplicates everything up to the save but stops there, so
a user created through this maker-checker flow never received their
credentials regardless of what sendPasswordToEmail said in the submitted
payload.

Fix: capture the auto-generated plaintext right after AppUser.fromJson(),
encode it with this class's own PasswordEncoder bean (already used the same
way for the maker-chosen-password branch, consistent within the file) before
saving, and call PlatformEmailService.sendToUserAccount() afterwards when
sendPasswordToEmail was true and no maker-chosen password overrides it. A
maker-chosen password is unrecoverable by approval time (submitCreateUser()
redacts it to "[PROTECTED]" immediately), so that case still cannot be
emailed, and isn't -- there is nothing wrong to fix there.

Found by manually submitting a CREATE_USER request locally and reading both
AppUser.fromJson() and the approval path end to end; no existing approved user
was re-created to verify in place, since doing so would need resetting a real
password.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-10-08 19:03:17 +05:30
niteshandClaude Sonnet 5 6fbc3a85a8 feat(fixed-deposits): show the period each posting covers, surface maturity postings, guard against double-posting
Adds interest_period_from to the report line so each posting shows the
span it covers (e.g. "01 Oct - 31 Dec, Quarterly"), not just the date
it ends on, and a postingPeriodLabel on the report itself.

Adds a reconciliation endpoint (outside-approval) that lists fixed
deposit interest posted without this report's approval — chiefly a
deposit that matured before its own posting cycle completed, whose
last period the maturity job settles directly. Read-only, so a branch
can see every rupee of deposit interest it has paid, approved or not.

Guards posting itself against the same situation: before crediting a
line, checks whether its deposit already carries an interest posting
for that exact date (raised by the maturity job in the window between
this report being generated and being posted). If so, the line is
linked to what actually paid it instead of being paid again, and its
amount is reconciled off the report's approved total rather than
failing the whole posting.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
2026-10-08 00:06:14 +05:30
niteshandClaude Sonnet 5 949f45c4cd feat(fixed-deposits): FD interest posting approval with pooled GL postings
Adds a maker-checker approval report in front of fixed deposit interest
posting, mirroring the existing savings interest posting report: a
report is generated per branch and product (SINGLE/DOUBLE/SPECIAL), a
second user approves it, and it posts when the branch closes its day.
Day close is blocked until deposit interest due that day is approved.

Ledger entries are pooled per the report's interestPostingDate rather
than raised per deposit: Dr Interest Expense and the Payable/Paid legs
are each raised once for the group's total, and only the final leg
crediting each deposit's own GL is per account — the same pattern the
savings interest posting report already uses, instead of repeating the
full three-stage chain for every deposit.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
2026-10-08 00:06:00 +05:30
24 changed files with 2715 additions and 9 deletions
@@ -32,6 +32,7 @@ public final class GlobalConfigurationConstants {
public static final String FORCE_PASSWORD_RESET_DAYS = "force-password-reset-days";
public static final String GRACE_ON_PENALTY_POSTING = "grace-on-penalty-posting";
public static final String SAVINGS_INTEREST_POSTING_CURRENT_PERIOD_END = "savings-interest-posting-current-period-end";
public static final String FD_INTEREST_POSTING_APPROVAL = "fd-interest-posting-approval";
public static final String FINANCIAL_YEAR_BEGINNING_MONTH = "financial-year-beginning-month";
public static final String MIN_CLIENTS_IN_GROUP = "min-clients-in-group";
public static final String MAX_CLIENTS_IN_GROUP = "max-clients-in-group";
@@ -69,6 +69,12 @@ public interface ConfigurationDomainService {
boolean isSavingsInterestPostingAtCurrentPeriodEnd();
/**
* Whether fixed deposit interest is reported and approved before it is posted, instead of being
* posted directly by the nightly job.
*/
boolean isFixedDepositInterestPostingApprovalEnabled();
Integer retrieveFinancialYearBeginningMonth();
Integer retrieveMinAllowedClientsInGroup();
@@ -44,6 +44,7 @@ public enum JobName {
APPLY_KYC_EXPIRY_RESTRICTIONS("Apply KYC Expiry Restrictions"), //
SAVINGS_DAILY_INTEREST("Savings Daily Interest Accrual And Posting"), //
SAVINGS_INTEREST_POSTING_REPORT("Generate Savings Interest Posting Report"), //
FD_INTEREST_POSTING_REPORT("Generate Fixed Deposit Interest Posting Report"), //
ADD_PERIODIC_ACCRUAL_ENTRIES_FOR_LOANS_WITH_INCOME_POSTED_AS_TRANSACTIONS(
"Add Accrual Transactions For Loans With Income Posted As Transactions"), //
EXECUTE_REPORT_MAILING_JOBS("Execute Report Mailing Jobs"), //
@@ -0,0 +1,100 @@
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.fineract.portfolio.savings;
import java.util.Locale;
/**
* The deposit scheme a fixed deposit product is sold under, held as {@code m_savings_product.fd_type}.
*
* <p>
* The three schemes differ in where a posting of interest ends up, which is what the interest posting
* report has to show and the posting itself has to honour:
*
* <ul>
* <li>{@link #SINGLE} — short deposits, priced from a slab table in days. Interest stays in the
* deposit and is paid with the principal at maturity.</li>
* <li>{@link #DOUBLE} — deposits of a year or more, priced from a slab table in years. Interest is
* compounded back into the deposit, so the maturity value is principal plus interest.</li>
* <li>{@link #SPECIAL} — the monthly income scheme. Interest is posted monthly and swept out to the
* customer's linked savings account, which is why a special deposit cannot be opened without one;
* the deposit itself matures at its principal, the interest having already been paid away.</li>
* </ul>
*
* <p>
* The database column is a string rather than an enum ordinal, so the names here are the stored
* values and must not be renamed. {@link #fromString(String)} is lenient about case and blanks
* because the column carries a default of SINGLE and older products predate the column entirely.
*/
public enum FixedDepositType {
/** Interest is held in the deposit and paid at maturity. The default for a product that names none. */
SINGLE,
/** Interest is compounded into the deposit; the maturity value includes it. */
DOUBLE,
/** Interest is posted monthly and transferred to the linked savings account. */
SPECIAL;
/**
* The scheme named by a stored {@code fd_type}, defaulting to {@link #SINGLE}.
*
* <p>
* A null, blank or unrecognised value reads as SINGLE: that is the column's own default, and a
* product carrying something else is a misconfiguration that must not stop its customers' interest
* from being reported.
*/
public static FixedDepositType fromString(final String fdType) {
if (fdType == null || fdType.isBlank()) {
return SINGLE;
}
for (final FixedDepositType candidate : values()) {
if (candidate.name().equalsIgnoreCase(fdType.trim())) {
return candidate;
}
}
return SINGLE;
}
public static boolean isValid(final String fdType) {
if (fdType == null || fdType.isBlank()) {
return false;
}
for (final FixedDepositType candidate : values()) {
if (candidate.name().equalsIgnoreCase(fdType.trim())) {
return true;
}
}
return false;
}
/** Whether interest leaves the deposit for the linked savings account each time it is posted. */
public boolean isPaidOutMonthly() {
return this == SPECIAL;
}
/** Whether a posting of interest adds to the deposit's own balance. */
public boolean isRetainedInDeposit() {
return this != SPECIAL;
}
/** What a customer sees: "FD Special", "FD Double", "FD Single". */
public String displayName() {
return "FD " + name().charAt(0) + name().substring(1).toLowerCase(Locale.ENGLISH);
}
}
@@ -84,4 +84,8 @@ public final class LedgerTxnPrefix {
// ── Savings ───────────────────────────────────────────────────────────────
/** Pooled savings interest posting for one product and date. */
public static final String SAVINGS_INTEREST_POOLED = "SAVINT";
// ── Fixed deposits ────────────────────────────────────────────────────────
/** Approved fixed deposit interest posting report, for one product, branch and date. */
public static final String FD_INTEREST_POSTED = "FDINT";
}
@@ -191,6 +191,16 @@ public class ConfigurationDomainServiceJpa implements ConfigurationDomainService
return property.isEnabled();
}
/**
* Read on every run of the interest posting job and of the day close, so the two paths can never
* both pay the same deposit: with this on the job leaves fixed deposits alone and they are paid
* from an approved report, with it off the job pays them directly as it always did.
*/
@Override
public boolean isFixedDepositInterestPostingApprovalEnabled() {
return getGlobalConfigurationPropertyData(GlobalConfigurationConstants.FD_INTEREST_POSTING_APPROVAL).isEnabled();
}
@Override
public Integer retrieveFinancialYearBeginningMonth() {
final GlobalConfigurationPropertyData property = getGlobalConfigurationPropertyData(
@@ -68,6 +68,7 @@ public class TenantDatabaseUpgradeService implements InitializingBean {
private final ExtendedSpringLiquibaseFactory liquibaseFactory;
private final TenantDataSourceFactory tenantDataSourceFactory;
private final Environment environment;
private final TenantInitialUserProvisioner initialUserProvisioner;
// DO NOT REMOVE! Required for liquibase custom task initialization
private final List<CustomTaskChange> customTaskChangesForDependencyInjection;
@@ -195,10 +196,15 @@ public class TenantDatabaseUpgradeService implements InitializingBean {
// configuration
// settings, and we should not use them to control the script order
if (databaseStateVerifier.isFirstLiquibaseMigration(tenantDataSource)) {
// a Flyway-era database already has its real users; only a brand-new tenant gets the seeded ones
final boolean brandNewTenant = !databaseStateVerifier.isFlywayPresent(tenantDataSource);
ExtendedSpringLiquibase liquibase = liquibaseFactory.create(tenantDataSource, TENANT_DB_CONTEXT,
CUSTOM_CHANGELOG_CONTEXT, INITIAL_SWITCH_CONTEXT, tenant.getTenantIdentifier());
applyInitialLiquibase(tenantDataSource, liquibase, tenant.getTenantIdentifier(),
(ds) -> !databaseStateVerifier.isTenantOnLatestUpgradableVersion(ds));
if (brandNewTenant) {
initialUserProvisioner.provision(tenantDataSource, tenant.getTenantIdentifier());
}
}
SpringLiquibase tenantLiquibase = liquibaseFactory.create(tenantDataSource, TENANT_DB_CONTEXT, CUSTOM_CHANGELOG_CONTEXT,
tenant.getTenantIdentifier());
@@ -0,0 +1,90 @@
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.fineract.infrastructure.core.service.migration;
import java.util.Locale;
import javax.sql.DataSource;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.apache.fineract.useradministration.service.AppUserConstants;
import org.springframework.core.env.Environment;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.security.crypto.factory.PasswordEncoderFactories;
import org.springframework.security.crypto.password.PasswordEncoder;
import org.springframework.stereotype.Component;
/**
* Personalises the three users that the initial Liquibase data seeds into every brand-new tenant database (ids 1-3,
* which otherwise ship with the well-known {@code mifos} / {@code system} / {@code interopUser} usernames and the
* public default password).
*
* Runs only right after the very first migration of a tenant that was never on Flyway, so existing tenants are never
* touched. The seeded changeSet itself is deliberately left alone: editing it would change its Liquibase checksum and
* break validation on every tenant that already ran it.
*
* Usernames become {@code <tenantIdentifier>_admin} and {@code <tenantIdentifier>_interop}. The system user keeps the
* {@link AppUserConstants#SYSTEM_USER_NAME} username because scheduler jobs, COB and other background processes look it
* up by that name; only its password is changed. All three share one password: the value of
* {@code fineract.tenant.initial-user-password} (env {@code FINERACT_TENANT_INITIAL_USER_PASSWORD}) when set,
* otherwise {@link #DEFAULT_PASSWORD}.
*/
@Component
@Slf4j
@RequiredArgsConstructor
public class TenantInitialUserProvisioner {
static final String PASSWORD_PROPERTY = "fineract.tenant.initial-user-password";
private static final long ADMIN_ID = 1L;
private static final long SYSTEM_ID = 2L;
private static final long INTEROP_ID = 3L;
// Meets the "strong" password policy (upper, lower, digit, special, no space, under 50 chars).
static final String DEFAULT_PASSWORD = "Cbs@Nexora#2026!Secure";
private final Environment environment;
public void provision(final DataSource dataSource, final String tenantIdentifier) {
final JdbcTemplate jdbc = new JdbcTemplate(dataSource);
final String prefix = usernamePrefix(tenantIdentifier);
final String configured = environment.getProperty(PASSWORD_PROPERTY);
final boolean overridden = configured != null && !configured.isBlank();
final String password = overridden ? configured : DEFAULT_PASSWORD;
final PasswordEncoder encoder = PasswordEncoderFactories.createDelegatingPasswordEncoder();
final String encoded = encoder.encode(password);
update(jdbc, ADMIN_ID, prefix + "_admin", encoded);
update(jdbc, SYSTEM_ID, AppUserConstants.SYSTEM_USER_NAME, encoded);
update(jdbc, INTEROP_ID, prefix + "_interop", encoded);
log.warn("Tenant '{}' initial users created: {}_admin, {}, {}_interop (password: {}). Change it after first login.",
tenantIdentifier, prefix, AppUserConstants.SYSTEM_USER_NAME, prefix, overridden ? "from " + PASSWORD_PROPERTY : "built-in default");
}
private void update(final JdbcTemplate jdbc, final long id, final String username, final String encodedPassword) {
jdbc.update("UPDATE m_appuser SET username = ?, password = ?, last_time_password_updated = CURRENT_DATE WHERE id = ?", username,
encodedPassword, id);
}
static String usernamePrefix(final String tenantIdentifier) {
final String cleaned = tenantIdentifier.toLowerCase(Locale.ROOT).replaceAll("[^a-z0-9]+", "_").replaceAll("^_+|_+$", "");
return cleaned.isEmpty() ? "tenant" : cleaned;
}
}
@@ -48,6 +48,8 @@ import org.apache.fineract.portfolio.cashreport.service.VaultPositionService;
import org.apache.fineract.portfolio.denominationmaster.service.CountedCashLedger;
import org.apache.fineract.portfolio.savings.dailyinterest.SavingsDailyInterestOrchestrator;
import org.apache.fineract.portfolio.savings.dailyinterest.SavingsInterestPostingReportService;
import org.apache.fineract.portfolio.savings.fdinterest.FixedDepositInterestPostingOrchestrator;
import org.apache.fineract.portfolio.savings.fdinterest.FixedDepositInterestPostingReportService;
import org.apache.fineract.useradministration.domain.AppUser;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.stereotype.Component;
@@ -91,6 +93,8 @@ public class BranchDayRegisterApiResource {
private final VaultPositionService vaultPositionService;
private final SavingsInterestPostingReportService interestPostingReportService;
private final SavingsDailyInterestOrchestrator savingsDailyInterestOrchestrator;
private final FixedDepositInterestPostingReportService fdInterestPostingReportService;
private final FixedDepositInterestPostingOrchestrator fdInterestPostingOrchestrator;
private final Gson gson = new Gson();
// ── GET /v1/branchday ── the register itself ──────────────────────────────
@@ -247,6 +251,16 @@ public class BranchDayRegisterApiResource {
result.put("denominationIn", countedIn);
result.put("denominationOut", countedOut);
// What will stop this close, so the screen can say so before the button is pressed rather than
// after. The same lists closeDay() refuses on, read-only here.
result.put("savingsInterestPending", interestPostingReportService.reportsBlockingDayClose(officeId, businessDate));
// One call for the deposits: what is blocking, and the products and amounts behind it, so the
// branch sees what it is being asked to approve without leaving the close screen. Pricing a
// branch's deposits is the expensive part and is done once.
final Map<String, Object> fdInterest = fdInterestPostingReportService.dayCloseInterestView(officeId, businessDate);
result.put("fdInterestPending", fdInterest.get("pending"));
result.put("fdInterestDue", fdInterest.get("due"));
return gson.toJson(result);
}
@@ -625,6 +639,17 @@ public class BranchDayRegisterApiResource {
+ ". Approve it under Reports → Interest Posting Reports, then close the day.");
}
// ── And its fixed deposit interest reports, on the same grounds ──
// Only while deposits are on the approval path at all; with that switched off the posting job
// pays them directly and there is nothing here to approve.
final List<String> fdInterestPending = fdInterestPostingReportService.reportsBlockingDayClose(officeId, businessDate);
if (!fdInterestPending.isEmpty()) {
throw new PlatformDataIntegrityException("error.msg.branchday.fd.interest.report.pending",
"Cannot close the day — this branch's fixed deposit interest posting report is not approved for: "
+ String.join(", ", fdInterestPending)
+ ". Approve it under Reports → FD Interest Posting Reports, then close the day.");
}
// ── The head office closes last ──
// Every branch that opened the day closes first and posts its own interest; a branch that
// never opened is not waited for.
@@ -760,6 +785,23 @@ public class BranchDayRegisterApiResource {
}
}
// ── And the branch's approved fixed deposit interest, the same way ──
// Separate from the savings run so a deposit product with a GL problem cannot stop savings
// interest that has already posted cleanly, and so the refusal names which of the two failed.
final List<Long> fdToPost = new ArrayList<>(fdInterestPostingReportService.approvedReportIds(officeId, businessDate));
if (isHeadOffice) {
fdToPost.addAll(fdInterestPostingReportService.approvedReportIdsOfBranchesNotOpened(businessDate, officeId));
}
if (!fdToPost.isEmpty()) {
log.info("Day close {}: office {} posting {} approved FD interest report(s)", businessDate, officeId, fdToPost.size());
final List<String> fdFailures = fdInterestPostingOrchestrator.postReports(fdToPost);
if (!fdFailures.isEmpty()) {
throw new PlatformDataIntegrityException("error.msg.branchday.fd.interest.posting.failed",
"Cannot close the day — fixed deposit interest could not be posted: " + String.join("; ", fdFailures)
+ ". The report is still approved; fix the cause and close the day again.");
}
}
// "closed_at IS NULL" in the WHERE, not just the read above: the already-closed check and
// this write are two separate statements, so two managers pressing Close at once (or one
// double-click) both got past the check. The second UPDATE then overwrote the first's
@@ -424,8 +424,8 @@ public class SavingsPooledInterestPostingService {
* columns are NOT NULL, so entries are stamped to the system account the scheduler uses.
*/
private Long systemUserId() {
final List<Long> ids = jdbcTemplate.queryForList(
"SELECT id FROM m_appuser WHERE username = 'system' ORDER BY id LIMIT 1", Long.class);
// id 2 is the seeded system user; its username is per-tenant now, so it is found by id
final List<Long> ids = jdbcTemplate.queryForList("SELECT id FROM m_appuser WHERE id = 2", Long.class);
return ids.isEmpty() ? 1L : ids.get(0);
}
@@ -0,0 +1,93 @@
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.fineract.portfolio.savings.fdinterest;
import java.math.BigDecimal;
import java.time.LocalDate;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.stereotype.Service;
import org.springframework.transaction.PlatformTransactionManager;
import org.springframework.transaction.TransactionDefinition;
import org.springframework.transaction.support.TransactionTemplate;
/**
* Posts approved fixed deposit interest reports, one transaction each.
*
* <p>
* Called as a branch closes its day. A report that cannot be posted does not take the others down
* with it: its failure is written to the report, which stays APPROVED, and reported back to the
* caller so the close can be refused with a reason the branch can act on. Closing again once the
* cause is fixed posts it.
*/
@Service
@Slf4j
@RequiredArgsConstructor
public class FixedDepositInterestPostingOrchestrator {
private final JdbcTemplate jdbcTemplate;
private final FixedDepositInterestPostingService postingService;
private final FixedDepositInterestPostingReportService reportService;
private final PlatformTransactionManager transactionManager;
/**
* Posts each report in a transaction of its own.
*
* @return one message per report that could not be posted, empty where all of them were
*/
public List<String> postReports(final List<Long> reportIds) {
final TransactionTemplate newTransaction = new TransactionTemplate(this.transactionManager);
newTransaction.setPropagationBehavior(TransactionDefinition.PROPAGATION_REQUIRES_NEW);
final List<String> failures = new ArrayList<>();
for (final Long reportId : reportIds) {
final Map<String, Object> report = this.jdbcTemplate
.queryForMap("SELECT fd_product_id, posting_date FROM m_fd_interest_posting_report WHERE id = ?", reportId);
final long productId = ((Number) report.get("fd_product_id")).longValue();
final LocalDate postingDate = ((java.sql.Date) report.get("posting_date")).toLocalDate();
try {
final BigDecimal paid = newTransaction.execute(status -> this.postingService.postReport(reportId));
log.info("FD interest: report {} for product {} posted {} for {}", reportId, productId, paid, postingDate);
} catch (final RuntimeException e) {
log.error("FD interest: report {} for product {} failed to post for {}", reportId, productId, postingDate, e);
newTransaction.executeWithoutResult(status -> {
this.reportService.recordPostingFailure(reportId, e.getMessage());
this.jdbcTemplate.update("""
UPDATE m_fd_interest_posting_run
SET status = 'FAILED', failure_reason = ?
WHERE report_id = ?
""", truncate(e.getMessage()), reportId);
});
failures.add("report " + reportId + " (product " + productId + "): " + e.getMessage());
}
}
return failures;
}
private static String truncate(final String reason) {
if (reason == null) {
return "unknown failure";
}
return reason.length() > 1000 ? reason.substring(0, 1000) : reason;
}
}
@@ -0,0 +1,527 @@
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.fineract.portfolio.savings.fdinterest;
import java.math.BigDecimal;
import java.math.RoundingMode;
import java.time.LocalDate;
import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.apache.fineract.accounting.glaccount.validation.GLAccountTransactionGuard;
import org.apache.fineract.accounting.journalentry.service.LedgerTransactionId;
import org.apache.fineract.accounting.journalentry.service.LedgerTxnPrefix;
import org.apache.fineract.infrastructure.core.exception.PlatformDataIntegrityException;
import org.apache.fineract.infrastructure.core.service.DateUtils;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;
/**
* Pays an approved fixed deposit interest posting report.
*
* <p>
* Nothing is recomputed here. The report's lines are the authority: each deposit is credited exactly
* what was approved for it, and interest that accrued after the report was generated is not added,
* because the approver signed off on these figures and not on others. The payable and paid accounts
* are those recorded on the report when it was generated.
*
* <p>
* The ledger entries are the three stages fixed deposit interest has always posted through, raised
* once for the whole report rather than once per deposit — the same pooling the savings interest
* posting report uses, for the same reason: a bank's interest cost is one figure in its books, not
* one line per customer repeated three times over.
*
* <pre>
* Dr Interest Expense (report total) → Cr Fixed Deposit Interest Payable
* Dr Interest Payable (report total) → Cr Fixed Deposit Interest Paid
* Dr Interest Paid (report total, once)
* Cr Savings Control (per deposit, naming the account and its own amount)
* </pre>
*
* A product that names no paid account posts the two-stage form, and one that names neither falls
* back to the plain Dr Expense / Cr Control pair — pooled the same way, one expense debit against many
* credits. Where one report holds deposits due for more than one period — a deposit owed two unpaid
* cycles, or a branch posting a stale cycle alongside today's — each {@code interestPostingDate}
* pools on its own: the chain above is raised once per date present on the report, not once overall,
* because the narration and the ledger date belong to the cycle, not to the day it happened to post.
*
* <p>
* Where the interest then goes is the product's scheme, and it is not decided here. A
* {@code SPECIAL} deposit carries {@code transfer_interest_to_linked_account}, and the existing
* transfer-interest-to-savings job sweeps the posted interest to the customer's linked savings
* account as it always has; {@code SINGLE} and {@code DOUBLE} keep it in the deposit. Posting is the
* same act for all three — the money reaches the customer's deposit — so this service does one thing
* and the sweep is left where it already works.
*
* <p>
* A deposit can mature between its report being generated and being posted, and a matured deposit's
* last period is settled directly by the maturity job the moment it matures — see
* {@code FixedDepositAccount#postMaturityInterest}, which this report's generation step cannot see
* coming and does not block on. Posting checks for that first: a line whose deposit already carries an
* interest posting for its exact date is linked to what actually paid it rather than paid again, and
* its amount is reconciled off the report's approved total rather than failing the whole posting over
* money that was never going to move twice.
*
* <p>
* The whole report settles in one transaction: a failure leaves nobody half paid and the report still
* APPROVED for the next attempt.
*/
@Service
@Slf4j
@RequiredArgsConstructor
public class FixedDepositInterestPostingService {
private static final int MONEY_SCALE = 2;
private static final RoundingMode MONEY_ROUNDING = RoundingMode.HALF_EVEN;
/** m_savings_account_transaction.transaction_type_enum */
private static final int INTEREST_POSTING = 3;
/** acc_gl_journal_entry.entity_type_enum for a savings entry. */
private static final int ENTITY_TYPE_SAVINGS = 2;
/** {@code CashAccountsForSavings.SAVINGS_CONTROL} */
private static final int GL_SAVINGS_CONTROL = 2;
/** {@code CashAccountsForSavings.INTEREST_ON_SAVINGS} — the expense interest is charged to. */
private static final int GL_INTEREST_ON_SAVINGS = 3;
/** {@code AccrualAccountsForSavings.INTEREST_PAYABLE} — the Interest Payable row on the product. */
private static final int GL_INTEREST_PAYABLE = 17;
/**
* The reserved names a deposit product may map its payable and paid accounts under, most specific
* first. The same lists the scheduler reads, so a product configured for the old path needs no
* change for the new one.
*/
private static final String[] PAYABLE_NAMES = { "Fixed Deposit Interest Payable", "Savings Interest Payable",
"Recurring Deposit Interest Payable", "Interest Payable", "Interest Payable Account" };
private static final String[] PAID_NAMES = { "Fixed Deposit Interest Paid", "Savings Interest Paid",
"Recurring Deposit Interest Paid", "Interest Paid", "Interest Paid Account" };
private final JdbcTemplate jdbcTemplate;
/** The payable and paid accounts a product's interest passes through. */
public record PostingGlAccounts(Long payableGl, Long paidGl) {}
/**
* One deposit's credit, after its transaction and balances are written but before the pooled ledger
* legs are raised — grouped with the others of its {@code interestDate} so the whole group is posted
* as one chain.
*/
private record PaidLine(Long accountId, BigDecimal amount, LocalDate interestDate, Long transactionId) {}
/**
* What one line's posting came to: either a new credit to pool with the rest of its date-group, or
* an amount that turned out to be settled already — a deposit that matured, and had this exact
* period's interest posted directly by the maturity job, between this report being generated and
* being posted. {@code paid} is null in that case, and {@code reconciledAway} carries the amount so
* the report's approved total can be reconciled down by it rather than the whole posting failing a
* balance check over money that was never going to move twice.
*/
private record DepositOutcome(PaidLine paid, BigDecimal reconciledAway) {}
/**
* The payable and paid accounts as the product maps them now, read when a report is generated so a
* product missing one is refused before anybody approves figures that could never be posted.
*
* <p>
* Unlike savings, neither is required: a deposit product that names no payable posts the plain two
* legs it always did, and nulls here say so rather than stopping the report.
*/
public PostingGlAccounts resolvePostingGlAccounts(final long productId) {
if (optionalMappedGlAccount(productId, GL_INTEREST_ON_SAVINGS) == null) {
final String productName = this.jdbcTemplate.queryForObject("SELECT name FROM m_savings_product WHERE id = ?", String.class,
productId);
throw new PlatformDataIntegrityException("error.msg.fdinterestreport.gl.not.mapped",
"Fixed deposit product '" + productName + "' has no Interest On Savings GL mapped. Set it under the product's"
+ " Accounting and generate the report again.");
}
Long payableGl = optionalMappedGlAccount(productId, GL_INTEREST_PAYABLE);
if (payableGl == null) {
payableGl = namedGlAccount(productId, PAYABLE_NAMES);
}
return new PostingGlAccounts(payableGl, namedGlAccount(productId, PAID_NAMES));
}
/**
* Posts one approved report, crediting each deposit exactly what was approved for it.
*
* <p>
* Everything is dated the day it is actually posted — the business date — not the cycle's end: a
* branch that was shut on its posting date posts when it next closes, into a day that is still
* open, and the narration names the date the interest is for.
*
* @return the amount distributed
*/
@Transactional
public BigDecimal postReport(final long reportId) {
final List<Map<String, Object>> reports = this.jdbcTemplate.queryForList("""
SELECT id, fd_product_id, fd_type, office_id, posting_date, status, total_interest, payable_gl_account_id,
paid_gl_account_id
FROM m_fd_interest_posting_report
WHERE id = ?
FOR UPDATE
""", reportId);
if (reports.isEmpty()) {
throw new IllegalStateException("Fixed deposit interest posting report " + reportId + " does not exist");
}
final Map<String, Object> report = reports.get(0);
if (!FixedDepositInterestPostingReportService.APPROVED.equals(report.get("status"))) {
throw new IllegalStateException(
"Fixed deposit interest posting report " + reportId + " is " + report.get("status") + ", not APPROVED");
}
final long productId = ((Number) report.get("fd_product_id")).longValue();
final long officeId = ((Number) report.get("office_id")).longValue();
final LocalDate interestFor = ((java.sql.Date) report.get("posting_date")).toLocalDate();
final LocalDate postedOn = DateUtils.getBusinessLocalDate();
final BigDecimal approved = ((BigDecimal) report.get("total_interest")).setScale(MONEY_SCALE, MONEY_ROUNDING);
final List<Map<String, Object>> lines = this.jdbcTemplate.queryForList("""
SELECT l.id AS line_id, l.fd_account_id, l.interest_posting_date, l.interest_amount, l.fd_transaction_id,
sa.currency_code
FROM m_fd_interest_posting_report_line l
JOIN m_savings_account sa ON sa.id = l.fd_account_id
WHERE l.report_id = ?
ORDER BY l.interest_posting_date, l.fd_account_id
""", reportId);
if (lines.isEmpty()) {
throw new IllegalStateException("Fixed deposit interest posting report " + reportId + " has no deposits to pay");
}
final long runId = openRun(reportId, productId, officeId, interestFor, lines.size());
final Long expenseGl = mappedGlAccount(productId, GL_INTEREST_ON_SAVINGS);
final Long controlGl = mappedGlAccount(productId, GL_SAVINGS_CONTROL);
final PostingGlAccounts current = resolvePostingGlAccounts(productId);
final Long payableGl = report.get("payable_gl_account_id") != null ? ((Number) report.get("payable_gl_account_id")).longValue()
: current.payableGl();
final Long paidGl = report.get("paid_gl_account_id") != null ? ((Number) report.get("paid_gl_account_id")).longValue()
: current.paidGl();
final String currency = (String) lines.get(0).get("currency_code");
// One per report, and deterministic: a retried posting carries the same reference as the legs a
// failed attempt rolled back, and two branches posting the same product never share one.
final String reference = LedgerTransactionId.forDatedSeries(LedgerTxnPrefix.FD_INTEREST_POSTED, postedOn, reportId);
// Each deposit's transaction and balances are settled first; the ledger is raised after, pooled
// by the date its interest belongs to, so a report spanning two cycles raises two chains rather
// than crediting one period's money under the other's date.
final Map<LocalDate, List<PaidLine>> byDate = new LinkedHashMap<>();
BigDecimal distributed = BigDecimal.ZERO;
BigDecimal reconciledAway = BigDecimal.ZERO;
for (final Map<String, Object> line : lines) {
final DepositOutcome outcome = payDeposit(line, officeId, postedOn);
if (outcome.paid() != null) {
byDate.computeIfAbsent(outcome.paid().interestDate(), key -> new ArrayList<>()).add(outcome.paid());
distributed = distributed.add(outcome.paid().amount());
}
reconciledAway = reconciledAway.add(outcome.reconciledAway());
}
// A line reconciled away was never going to move twice: its amount is taken off what this
// posting is expected to distribute rather than failing the whole report over money that is
// already in the customer's deposit by another, older path. What was actually paid here still
// has to add up exactly to what is left.
final BigDecimal expected = approved.subtract(reconciledAway);
if (expected.compareTo(distributed) != 0) {
throw new IllegalStateException(
String.format("Fixed deposit interest posting report %d did not balance: approved %s, reconciled away %s,"
+ " distributed %s", reportId, approved, reconciledAway, distributed));
}
for (final Map.Entry<LocalDate, List<PaidLine>> group : byDate.entrySet()) {
postPooledLedgerLegs(officeId, currency, group.getKey(), postedOn, group.getValue(), reference, expenseGl, payableGl, paidGl,
controlGl);
}
completeReport(reportId, productId, interestFor, approved, distributed, runId, lines.size());
return distributed;
}
/**
* One deposit's interest transaction and balances, settled without raising any ledger entry — the
* caller pools this with the rest of its date-group before the GL is touched.
*
* <p>
* The transaction carries the date the interest engine gave the period, not the day the branch is
* closing. That is not presentation: the engine decides a period has already been paid by looking
* for an interest transaction on exactly that date, so a posting written under the close date would
* be invisible to it and the same period would be computed and paid again at the next run. The
* close date is kept as the submitted-on stamp, which is what the scheduler has always done.
*
* <p>
* Checked first against the deposit's own transactions for one this report did not put there: a
* deposit can mature between its report being generated and being posted, and the maturity job
* settles a matured deposit's last period itself, directly, the moment it matures — see
* {@code FixedDepositAccount#postMaturityInterest}. Where that has already happened for this exact
* date, the line is linked to what actually paid it rather than paying it again.
*/
private DepositOutcome payDeposit(final Map<String, Object> line, final long officeId, final LocalDate postedOn) {
final BigDecimal amount = ((BigDecimal) line.get("interest_amount")).setScale(MONEY_SCALE, MONEY_ROUNDING);
final long accountId = ((Number) line.get("fd_account_id")).longValue();
final long lineId = ((Number) line.get("line_id")).longValue();
if (amount.compareTo(BigDecimal.ZERO) <= 0) {
return new DepositOutcome(null, BigDecimal.ZERO);
}
final LocalDate interestDate = ((java.sql.Date) line.get("interest_posting_date")).toLocalDate();
// A resumed or duplicated attempt must not pay anybody twice. The line itself records the
// payment, so this holds even where one deposit has two periods on one report.
if (line.get("fd_transaction_id") != null) {
throw new IllegalStateException("Fixed deposit " + accountId + " was already paid by this report");
}
final Long existing = findExistingInterestPosting(accountId, interestDate);
if (existing != null) {
log.warn(
"FD interest report line {}: deposit {} already has an interest posting for {} (transaction {}) not raised by this"
+ " report — most likely matured in the meantime. Linking to it instead of posting again.",
lineId, accountId, interestDate, existing);
this.jdbcTemplate.update("UPDATE m_fd_interest_posting_report_line SET fd_transaction_id = ? WHERE id = ?", existing, lineId);
return new DepositOutcome(null, amount);
}
// The balance as it stands now, not as the report showed it: money may have moved since the
// report was generated, and the transaction's running balance has to follow the deposit.
final BigDecimal currentBalance = this.jdbcTemplate.queryForObject(
"SELECT COALESCE(account_balance_derived, 0) FROM m_savings_account WHERE id = ?", BigDecimal.class, accountId);
final BigDecimal newBalance = currentBalance.add(amount);
final long transactionId = createInterestPostingTransaction(accountId, officeId, interestDate, postedOn, amount, newBalance);
// Earned is only ever raised to what has now been posted, never added to: the engine may
// already have counted this interest as earned, and adding on top of that doubles it. Screens
// read unposted interest as earned - posted, so earned must not fall below posted either.
//
// interest_posted_till_date is what takes the deposit out of the next report's candidates; the
// interest transaction itself is what stops the engine recomputing the same period.
this.jdbcTemplate.update("""
UPDATE m_savings_account
SET account_balance_derived = COALESCE(account_balance_derived, 0) + ?,
total_interest_posted_derived = COALESCE(total_interest_posted_derived, 0) + ?,
total_interest_earned_derived = GREATEST(COALESCE(total_interest_earned_derived, 0),
COALESCE(total_interest_posted_derived, 0) + ?),
interest_posted_till_date = GREATEST(COALESCE(interest_posted_till_date, ?), ?)
WHERE id = ?
""", amount, amount, amount, interestDate, interestDate, accountId);
this.jdbcTemplate.update("UPDATE m_fd_interest_posting_report_line SET fd_transaction_id = ? WHERE id = ?", transactionId,
lineId);
return new DepositOutcome(new PaidLine(accountId, amount, interestDate, transactionId), BigDecimal.ZERO);
}
/** A non-reversed interest posting this deposit already carries for this exact date, if any. */
private Long findExistingInterestPosting(final long accountId, final LocalDate interestDate) {
final List<Long> found = this.jdbcTemplate.queryForList("""
SELECT id FROM m_savings_account_transaction
WHERE savings_account_id = ? AND transaction_type_enum = ? AND transaction_date = ? AND is_reversed = false
ORDER BY id DESC LIMIT 1
""", Long.class, accountId, INTEREST_POSTING, interestDate);
return found.isEmpty() ? null : found.get(0);
}
/**
* One date-group's chain, pooled: the report's cost moves through the fewer-or-more intermediate
* accounts the product's mappings support as one figure, and only the last leg — crediting each
* deposit — is raised per account. The group's own total is what moves, not the report's, so two
* periods on one report each carry their own entries under their own date.
*/
private void postPooledLedgerLegs(final long officeId, final String currency, final LocalDate interestDate, final LocalDate postedOn,
final List<PaidLine> group, final String reference, final Long expenseGl, final Long payableGl, final Long paidGl,
final Long controlGl) {
final String narration = "Fixed deposit interest for " + interestDate;
BigDecimal total = BigDecimal.ZERO;
for (final PaidLine paid : group) {
total = total.add(paid.amount());
}
final boolean hasPayable = payableGl != null && payableGl != 0 && !payableGl.equals(controlGl);
final boolean hasPaid = paidGl != null && paidGl != 0 && !paidGl.equals(payableGl);
// The chain of pooled accounts the group's cost passes through before it is split: Expense, then
// Payable and Paid where the product maps them — each consecutive pair raised once for the whole
// total. The last account in the chain is what Stage 2 debits before crediting each deposit.
final List<Long> chain = new ArrayList<>();
chain.add(expenseGl);
if (hasPayable) {
chain.add(payableGl);
if (hasPaid) {
chain.add(paidGl);
}
}
for (int i = 0; i < chain.size() - 1; i++) {
journalEntry(officeId, currency, chain.get(i), interestDate, postedOn, total, true, reference, null, null, narration);
journalEntry(officeId, currency, chain.get(i + 1), interestDate, postedOn, total, false, reference, null, null, narration);
}
// Stage 2: one debit for the group's total, and under it a credit to each deposit. Every leg
// carries the report's one transaction id, and every credit names its account and interest
// transaction, so who was paid what reads back from the journal alone.
journalEntry(officeId, currency, chain.get(chain.size() - 1), interestDate, postedOn, total, true, reference, null, null,
narration);
for (final PaidLine paid : group) {
journalEntry(officeId, currency, controlGl, interestDate, postedOn, paid.amount(), false, reference, paid.accountId(),
paid.transactionId(), narration);
}
}
private void completeReport(final long reportId, final long productId, final LocalDate interestFor, final BigDecimal approved,
final BigDecimal distributed, final long runId, final int accountCount) {
this.jdbcTemplate.update("""
UPDATE m_fd_interest_posting_run
SET pooled_amount = ?, distributed_amount = ?, rounding_residual = 0,
status = 'COMPLETED', completed_at = CURRENT_TIMESTAMP
WHERE id = ?
""", approved, distributed, runId);
this.jdbcTemplate.update("""
UPDATE m_fd_interest_posting_report
SET status = 'POSTED', posted_at = CURRENT_TIMESTAMP, posting_run_id = ?, failure_reason = NULL
WHERE id = ?
""", runId, reportId);
log.info("FD interest posting: report {} (product {}, for {}) paid {} across {} deposits", reportId, productId, interestFor,
distributed, accountCount);
}
/** One run per report. A retry of the same report reuses its run. */
private long openRun(final long reportId, final long productId, final long officeId, final LocalDate postingDate,
final int accountCount) {
this.jdbcTemplate.update("""
INSERT INTO m_fd_interest_posting_run
(report_id, fd_product_id, office_id, posting_date, account_count, status)
VALUES (?, ?, ?, ?, ?, 'PENDING')
ON CONFLICT (report_id) DO UPDATE SET
account_count = EXCLUDED.account_count, status = 'PENDING',
started_at = CURRENT_TIMESTAMP, failure_reason = NULL
""", reportId, productId, officeId, postingDate, accountCount);
return this.jdbcTemplate.queryForObject("SELECT id FROM m_fd_interest_posting_run WHERE report_id = ?", Long.class, reportId);
}
/**
* @param interestDate
* the period the interest is for, which is the transaction's own date
* @param postedOn
* the business date it is being written on, kept as the submitted-on stamp
*/
private long createInterestPostingTransaction(final long accountId, final long officeId, final LocalDate interestDate,
final LocalDate postedOn, final BigDecimal amount, final BigDecimal runningBalance) {
this.jdbcTemplate.update("""
INSERT INTO m_savings_account_transaction
(savings_account_id, office_id, is_reversed, is_reversal, is_lien_transaction,
transaction_type_enum, transaction_date, amount, running_balance_derived,
submitted_on_date, created_by, last_modified_by, created_on_utc, last_modified_on_utc)
VALUES (?, ?, false, false, false, ?, ?, ?, ?, ?, ?, ?, CURRENT_TIMESTAMP, CURRENT_TIMESTAMP)
""", accountId, officeId, INTEREST_POSTING, interestDate, amount, runningBalance, postedOn, systemUserId(),
systemUserId());
return this.jdbcTemplate.queryForObject("""
SELECT id FROM m_savings_account_transaction
WHERE savings_account_id = ? AND transaction_date = ? AND transaction_type_enum = ?
ORDER BY id DESC LIMIT 1
""", Long.class, accountId, interestDate, INTEREST_POSTING);
}
/**
* One journal entry leg. Fineract's {@code type_enum} is 2 = DEBIT, 1 = CREDIT — {@code
* JournalEntryType} declares {@code CREDIT(1)} first.
*
* <p>
* Dated the period the interest is for, as the scheduler dates its own legs, with the business date
* kept as the submitted-on stamp.
*/
private void journalEntry(final long officeId, final String currency, final Long glAccountId, final LocalDate interestDate,
final LocalDate postedOn, final BigDecimal amount, final boolean debit, final String reference, final Long savingsAccountId,
final Long transactionId, final String narration) {
GLAccountTransactionGuard.assertPostable(this.jdbcTemplate, glAccountId);
this.jdbcTemplate.update("""
INSERT INTO acc_gl_journal_entry
(office_id, account_id, currency_code, transaction_id, entry_date, transaction_date, type_enum,
amount, description, entity_type_enum, entity_id, is_running_balance_calculated,
savings_transaction_id, reversed, manual_entry, office_running_balance,
organization_running_balance, created_by, last_modified_by, created_date, lastmodified_date,
created_on_utc, last_modified_on_utc, submitted_on_date)
VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, false, ?, false, false, 0, 0, ?, ?,
CURRENT_TIMESTAMP, CURRENT_TIMESTAMP, CURRENT_TIMESTAMP, CURRENT_TIMESTAMP, ?)
""", officeId, glAccountId, currency, reference, interestDate, interestDate, debit ? 2 : 1, amount, narration,
savingsAccountId == null ? null : ENTITY_TYPE_SAVINGS, savingsAccountId, transactionId, systemUserId(), systemUserId(),
postedOn);
}
/**
* The user these rows are attributed to. A day close has a user, but the nightly retry does not and
* the audit columns are NOT NULL, so entries are stamped to the system account either way — as the
* scheduler's own postings always were.
*/
private Long systemUserId() {
// id 2 is the seeded system user; its username is per-tenant now, so it is found by id
final List<Long> ids = this.jdbcTemplate.queryForList("SELECT id FROM m_appuser WHERE id = 2", Long.class);
return ids.isEmpty() ? 1L : ids.get(0);
}
private Long mappedGlAccount(final long productId, final int financialAccountType) {
final Long found = optionalMappedGlAccount(productId, financialAccountType);
if (found == null) {
throw new IllegalStateException("Fixed deposit product " + productId + " has no GL account mapped for financial account type "
+ financialAccountType + ". Set the product's Accounting tab before its interest can be posted.");
}
return found;
}
private Long optionalMappedGlAccount(final long productId, final int financialAccountType) {
final List<Long> found = this.jdbcTemplate.queryForList("""
SELECT gl_account_id FROM acc_product_mapping
WHERE product_id = ? AND product_type = 2 AND financial_account_type = ?
LIMIT 1
""", Long.class, productId, financialAccountType);
return found.isEmpty() ? null : found.get(0);
}
/**
* The GL account a product maps under one of the reserved names in {@code other_gl_mappings}, tried
* in order of preference. The column holds an empty string on a product saved with no named
* mappings and casting that to jsonb is an error, so the cast sits inside a subquery that has
* already filtered those rows out.
*/
private Long namedGlAccount(final long productId, final String... accountNames) {
for (final String accountName : accountNames) {
final List<Long> found = this.jdbcTemplate.queryForList("""
SELECT gl.id
FROM (SELECT other_gl_mappings::jsonb AS doc
FROM m_savings_product
WHERE id = ?
AND other_gl_mappings IS NOT NULL
AND other_gl_mappings <> ''
AND other_gl_mappings LIKE '{%') sp
CROSS JOIN LATERAL jsonb_array_elements(
COALESCE(sp.doc -> 'assets', '[]'::jsonb)
|| COALESCE(sp.doc -> 'liabilities', '[]'::jsonb)
|| COALESCE(sp.doc -> 'expenses', '[]'::jsonb)
|| COALESCE(sp.doc -> 'income', '[]'::jsonb)
) AS m(entry)
JOIN acc_gl_account gl ON gl.gl_code = m.entry ->> 'glCode'
WHERE lower(trim(m.entry ->> 'accountName')) = lower(trim(?))
LIMIT 1
""", Long.class, productId, accountName);
if (!found.isEmpty()) {
return found.get(0);
}
}
return null;
}
}
@@ -0,0 +1,245 @@
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.fineract.portfolio.savings.fdinterest.api;
import com.google.gson.Gson;
import jakarta.ws.rs.Consumes;
import jakarta.ws.rs.GET;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.PathParam;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.QueryParam;
import jakarta.ws.rs.core.MediaType;
import java.sql.Timestamp;
import java.time.LocalDate;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import lombok.RequiredArgsConstructor;
import org.apache.fineract.infrastructure.configuration.domain.ConfigurationDomainService;
import org.apache.fineract.infrastructure.core.exception.PlatformDataIntegrityException;
import org.apache.fineract.infrastructure.core.serialization.FromJsonHelper;
import org.apache.fineract.infrastructure.core.service.DateUtils;
import org.apache.fineract.infrastructure.security.service.PlatformSecurityContext;
import org.apache.fineract.portfolio.savings.fdinterest.FixedDepositInterestPostingReportService;
import org.apache.fineract.useradministration.domain.AppUser;
import org.springframework.stereotype.Component;
/**
* The fixed deposit interest posting reports, per branch and product: list, detail, generate, approve,
* the day-close check, and the head office's branch-wise summary.
*
* <p>
* Posting is not offered here. A branch's approved reports are posted when that branch closes the
* day, so there is exactly one way interest reaches a customer's deposit.
*/
@Path("/v1/fixeddepositinterestpostingreports")
@Component
@RequiredArgsConstructor
@Produces({ MediaType.APPLICATION_JSON })
public class FixedDepositInterestPostingReportApiResource {
private static final String RESOURCE = "FDINTERESTREPORT";
private final FixedDepositInterestPostingReportService reportService;
private final ConfigurationDomainService configurationDomainService;
private final PlatformSecurityContext context;
private final FromJsonHelper fromJsonHelper;
private final Gson gson = new Gson();
/** A branch user sees their own branch; a head office user every branch, or one with officeId. */
@GET
public String list(@QueryParam("postingDate") final String postingDate, @QueryParam("status") final String status,
@QueryParam("productId") final Long productId, @QueryParam("officeId") final Long officeId,
@QueryParam("scope") final String scope) {
final AppUser user = this.context.authenticatedUser();
user.validateHasReadPermission(RESOURCE);
return this.gson
.toJson(this.reportService.list(parseDate(postingDate), status, productId, officeId, scope, user).stream()
.map(this::plain).toList());
}
/**
* Who is looking: their branch, whether it is the head office (which gets the Other branches tab),
* and whether deposits are on the approval path at all — with the switch off every screen here is
* empty by design, and the UI should say so rather than look broken.
*/
@GET
@Path("/context")
public String userContext() {
final AppUser user = this.context.authenticatedUser();
final Long officeId = user.getOffice().getId();
final Map<String, Object> result = new LinkedHashMap<>();
result.put("officeId", officeId);
result.put("officeName", user.getOffice().getName());
result.put("headOffice", this.reportService.isHeadOffice(officeId));
result.put("approvalEnabled", this.configurationDomainService.isFixedDepositInterestPostingApprovalEnabled());
return this.gson.toJson(result);
}
/** Branch and product pairs with deposit interest due by the date and no report yet. */
@GET
@Path("/due-without-report")
public String dueWithoutReport(@QueryParam("postingDate") final String postingDate, @QueryParam("scope") final String scope) {
final AppUser user = this.context.authenticatedUser();
user.validateHasReadPermission(RESOURCE);
final LocalDate date = postingDate == null || postingDate.isBlank() ? DateUtils.getBusinessLocalDate() : parseDate(postingDate);
return this.gson.toJson(this.reportService.dueWithoutReport(date, user, scope));
}
/**
* What stops a branch closing the business day: its own deposit reports due and not yet approved,
* and the products and amounts behind them. The day-close screen reads it to warn before the close
* is attempted.
*/
@GET
@Path("/day-close-check")
public String dayCloseCheck(@QueryParam("date") final String date, @QueryParam("officeId") final Long officeIdParam) {
final AppUser user = this.context.authenticatedUser();
final LocalDate businessDate = date == null || date.isBlank() ? DateUtils.getBusinessLocalDate() : parseDate(date);
final Long officeId = officeIdParam != null ? officeIdParam : user.getOffice().getId();
final Map<String, Object> view = this.reportService.dayCloseInterestView(officeId, businessDate);
@SuppressWarnings("unchecked")
final List<String> blocking = (List<String>) view.get("pending");
final Map<String, Object> result = new LinkedHashMap<>();
result.put("businessDate", businessDate.toString());
result.put("canClose", blocking.isEmpty());
result.put("pendingProducts", blocking);
result.put("due", view.get("due"));
return this.gson.toJson(result);
}
/** What each deposit has earned and not been paid, as if posted today. View only — nothing is saved. */
@GET
@Path("/preview")
public String preview(@QueryParam("officeId") final Long officeId) {
final AppUser user = this.context.authenticatedUser();
user.validateHasReadPermission(RESOURCE);
return this.gson.toJson(this.reportService.preview(officeId, user).stream().map(this::plain).toList());
}
/** The head office's view: per branch and product, deposits paid and interest, over a date range. */
@GET
@Path("/summary")
public String summary(@QueryParam("fromDate") final String fromDate, @QueryParam("toDate") final String toDate,
@QueryParam("productId") final Long productId) {
final AppUser user = this.context.authenticatedUser();
user.validateHasReadPermission(RESOURCE);
if (!this.reportService.isHeadOffice(user.getOffice().getId())) {
throw new PlatformDataIntegrityException("error.msg.fdinterestreport.summary.head.office.only",
"The branch-wise fixed deposit interest summary is for the head office.");
}
return this.gson
.toJson(this.reportService.summary(parseDate(fromDate), parseDate(toDate), productId).stream().map(this::plain).toList());
}
/**
* Deposit interest posted without this report ever seeing it — chiefly a deposit maturing before
* its posting cycle completed, whose last period a different, older path settles directly. Here so
* a branch can see every rupee of deposit interest it has paid, approved or not.
*/
@GET
@Path("/outside-approval")
public String outsideApproval(@QueryParam("fromDate") final String fromDate, @QueryParam("toDate") final String toDate,
@QueryParam("officeId") final Long officeId, @QueryParam("scope") final String scope) {
final AppUser user = this.context.authenticatedUser();
user.validateHasReadPermission(RESOURCE);
return this.gson.toJson(
this.reportService.outsideApproval(parseDate(fromDate), parseDate(toDate), officeId, user, scope).stream()
.map(this::plain).toList());
}
@GET
@Path("/{reportId}")
public String detail(@PathParam("reportId") final Long reportId) {
this.context.authenticatedUser().validateHasReadPermission(RESOURCE);
final Map<String, Object> report = plain(this.reportService.detail(reportId));
@SuppressWarnings("unchecked")
final List<Map<String, Object>> lines = (List<Map<String, Object>>) report.get("lines");
report.put("lines", lines.stream().map(this::plain).toList());
return this.gson.toJson(report);
}
/** {@code ?command=regenerate} with {@code {"productId": .., "officeId": .., "postingDate": "yyyy-MM-dd"}}. */
@POST
@Consumes({ MediaType.APPLICATION_JSON })
public String command(@QueryParam("command") final String command, final String body) {
if (!"regenerate".equalsIgnoreCase(command)) {
throw new PlatformDataIntegrityException("error.msg.fdinterestreport.unknown.command", "Unsupported command: " + command);
}
final AppUser user = this.context.authenticatedUser();
user.validateHasPermissionTo("REGENERATE_" + RESOURCE);
final var root = this.fromJsonHelper.parse(body);
final Long productId = this.fromJsonHelper.extractLongNamed("productId", root);
final Long officeIdParam = this.fromJsonHelper.extractLongNamed("officeId", root);
final String postingDate = this.fromJsonHelper.extractStringNamed("postingDate", root);
if (productId == null) {
throw new PlatformDataIntegrityException("error.msg.fdinterestreport.product.required", "Which product?");
}
final Long officeId = officeIdParam != null ? officeIdParam : user.getOffice().getId();
final LocalDate date = postingDate == null || postingDate.isBlank() ? DateUtils.getBusinessLocalDate() : parseDate(postingDate);
final Long reportId = this.reportService.regenerate(productId, officeId, date, user);
return this.gson.toJson(Map.of("reportId", reportId, "status", FixedDepositInterestPostingReportService.GENERATED));
}
/**
* {@code ?command=approve}. A user of the report's branch who did not generate it approves it; see
* the service for the head office's one exception.
*/
@POST
@Path("/{reportId}")
@Consumes({ MediaType.APPLICATION_JSON })
public String reportCommand(@PathParam("reportId") final Long reportId, @QueryParam("command") final String command) {
if (!"approve".equalsIgnoreCase(command)) {
throw new PlatformDataIntegrityException("error.msg.fdinterestreport.unknown.command", "Unsupported command: " + command);
}
final AppUser user = this.context.authenticatedUser();
user.validateHasPermissionTo("APPROVE_" + RESOURCE);
this.reportService.approve(reportId, user);
return this.gson.toJson(Map.of("reportId", reportId, "status", FixedDepositInterestPostingReportService.APPROVED));
}
private static LocalDate parseDate(final String raw) {
if (raw == null || raw.isBlank()) {
return null;
}
try {
return LocalDate.parse(raw.trim());
} catch (final RuntimeException e) {
throw new PlatformDataIntegrityException("error.msg.fdinterestreport.invalid.date",
"Dates are expected as yyyy-MM-dd, not " + raw);
}
}
/** JDBC dates and timestamps as ISO strings; Gson would otherwise write them in its own locale format. */
private Map<String, Object> plain(final Map<String, Object> row) {
final Map<String, Object> out = new LinkedHashMap<>();
row.forEach((key, value) -> {
if (value instanceof java.sql.Date d) {
out.put(key, d.toLocalDate().toString());
} else if (value instanceof Timestamp t) {
out.put(key, t.toLocalDateTime().toString());
} else {
out.put(key, value);
}
});
return out;
}
}
@@ -0,0 +1,52 @@
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.fineract.portfolio.savings.fdinterest.jobs;
import org.apache.fineract.infrastructure.jobs.service.JobName;
import org.springframework.batch.core.Job;
import org.springframework.batch.core.Step;
import org.springframework.batch.core.job.builder.JobBuilder;
import org.springframework.batch.core.launch.support.RunIdIncrementer;
import org.springframework.batch.core.repository.JobRepository;
import org.springframework.batch.core.step.builder.StepBuilder;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.transaction.PlatformTransactionManager;
@Configuration
public class FixedDepositInterestPostingReportConfig {
@Autowired
private JobRepository jobRepository;
@Autowired
private PlatformTransactionManager transactionManager;
@Bean
protected Step fdInterestPostingReportStep(final FixedDepositInterestPostingReportTasklet fdInterestPostingReportTasklet) {
return new StepBuilder(JobName.FD_INTEREST_POSTING_REPORT.name(), jobRepository)
.tasklet(fdInterestPostingReportTasklet, transactionManager).build();
}
@Bean
public Job fdInterestPostingReportJob(final FixedDepositInterestPostingReportTasklet fdInterestPostingReportTasklet) {
return new JobBuilder(JobName.FD_INTEREST_POSTING_REPORT.name(), jobRepository)
.start(fdInterestPostingReportStep(fdInterestPostingReportTasklet)).incrementer(new RunIdIncrementer()).build();
}
}
@@ -0,0 +1,57 @@
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.fineract.portfolio.savings.fdinterest.jobs;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.apache.fineract.infrastructure.configuration.domain.ConfigurationDomainService;
import org.apache.fineract.infrastructure.core.service.DateUtils;
import org.apache.fineract.portfolio.savings.fdinterest.FixedDepositInterestPostingReportService;
import org.springframework.batch.core.StepContribution;
import org.springframework.batch.core.scope.context.ChunkContext;
import org.springframework.batch.core.step.tasklet.Tasklet;
import org.springframework.batch.repeat.RepeatStatus;
import org.springframework.stereotype.Component;
/**
* Noon on the business date: generates the interest posting report for every fixed deposit product
* whose interest falls due, so a branch can review and approve it before it closes the day.
*
* <p>
* Does nothing while deposits are off the approval path — the posting job is paying them directly,
* and a report generated alongside it would be approved against money that has already moved.
*/
@RequiredArgsConstructor
@Component
@Slf4j
public class FixedDepositInterestPostingReportTasklet implements Tasklet {
private final FixedDepositInterestPostingReportService reportService;
private final ConfigurationDomainService configurationDomainService;
@Override
public RepeatStatus execute(final StepContribution contribution, final ChunkContext chunkContext) throws Exception {
if (!this.configurationDomainService.isFixedDepositInterestPostingApprovalEnabled()) {
log.info("FD interest posting report: skipped — fixed deposit interest is posted directly by the posting job");
return RepeatStatus.FINISHED;
}
this.reportService.generateDue(DateUtils.getBusinessLocalDate());
return RepeatStatus.FINISHED;
}
}
@@ -36,6 +36,7 @@ import java.util.List;
import org.apache.commons.lang3.StringUtils;
import org.apache.fineract.accounting.common.AccountingRuleType;
import org.apache.fineract.accounting.glaccount.data.GLAccountData;
import org.apache.fineract.infrastructure.configuration.domain.ConfigurationDomainService;
import org.apache.fineract.infrastructure.core.data.EnumOptionData;
import org.apache.fineract.infrastructure.core.domain.ExternalId;
import org.apache.fineract.infrastructure.core.domain.JdbcSupport;
@@ -109,16 +110,24 @@ public class SavingsAccountReadPlatformServiceImpl implements SavingsAccountRead
private final SavingsAccountRepositoryWrapper savingsAccountRepositoryWrapper;
private final SavingsDailyInterestService savingsDailyInterestService;
private final ConfigurationDomainService configurationDomainService;
/** m_savings_account.status_enum for an active account. */
private static final Integer ACTIVE_STATUS = 300;
/** m_savings_product.deposit_type_enum for a fixed deposit. */
private static final Integer DEPOSIT_TYPE_FIXED = 200;
public SavingsAccountReadPlatformServiceImpl(final PlatformSecurityContext context, final JdbcTemplate jdbcTemplate,
final SavingsAccountAssembler savingAccountAssembler, PaginationHelper paginationHelper, ColumnValidator columnValidator,
DatabaseSpecificSQLGenerator sqlGenerator, SavingsAccountRepositoryWrapper savingsAccountRepositoryWrapper,
final SavingsDailyInterestService savingsDailyInterestService) {
final SavingsDailyInterestService savingsDailyInterestService,
final ConfigurationDomainService configurationDomainService) {
this.context = context;
this.jdbcTemplate = jdbcTemplate;
this.sqlGenerator = sqlGenerator;
this.savingsAccountRepositoryWrapper = savingsAccountRepositoryWrapper;
this.savingsDailyInterestService = savingsDailyInterestService;
this.configurationDomainService = configurationDomainService;
this.transactionTemplateMapper = new SavingsAccountTransactionTemplateMapper();
this.transactionsMapper = new SavingsAccountTransactionsMapper();
this.savingsAccountTransactionsForBatchMapper = new SavingsAccountTransactionsForBatchMapper();
@@ -442,10 +451,18 @@ public class SavingsAccountReadPlatformServiceImpl implements SavingsAccountRead
// 300) is left out: its posting periods are credited by the nightly deposit maturity job instead
// (RecurringDepositAccount#postPeriodicInterest), at the chart rate and on deposits alone. The filters sit inside the paging subquery so a page is never cut short by
// accounts that are then dropped.
//
// Fixed deposits come out on the same grounds once their interest goes through an approved
// report (FixedDepositInterestPostingReportService): the report's figures are posted when the
// branch closes its day, and this job running over the same deposits would pay them twice.
final String fixedDepositFilter = this.configurationDomainService.isFixedDepositInterestPostingApprovalEnabled()
? "and a.deposit_type_enum <> " + DEPOSIT_TYPE_FIXED + " "
: "";
String sql = "select " + this.savingAccountMapperForInterestPosting.schema()
+ "join (select a.id from m_savings_account a where a.id > ? and a.status_enum = ? and a.deposit_type_enum <> 300 "
+ "and not exists (select 1 from m_savings_interest_posting_schedule s "
+ "where s.savings_product_id = a.product_id and s.is_active = true) limit ?) b on b.id = sa.id ";
+ "where s.savings_product_id = a.product_id and s.is_active = true) " + fixedDepositFilter
+ "limit ?) b on b.id = sa.id ";
if (backdatedTxnsAllowedTill) {
sql = sql
+ "where (CASE WHEN sa.interest_posted_till_date is not null THEN tr.transaction_date >= sa.interest_posted_till_date ELSE tr.transaction_date >= sa.activatedon_date END) ";
@@ -463,6 +480,55 @@ public class SavingsAccountReadPlatformServiceImpl implements SavingsAccountRead
return savingsAccountDataList;
}
/**
* The fixed deposits of one branch, and optionally one product, whose interest may be due on the
* posting date — the candidates an interest posting report is drawn from.
*
* <p>
* "May be" is deliberate. A deposit is selected here on the same cheap test the posting job has
* always used, that its interest has not been posted past the day before, and whether a posting
* period has actually ended is then settled by the interest engine, which is the only thing that
* knows a product's compounding and posting periods. A candidate the engine finds nothing for
* simply contributes no line to the report.
*
* <p>
* Unpaged, unlike the posting job: a report covers one branch and one product and is read in full
* before anybody approves it, so there is no page for a deposit to fall off the end of.
*/
@Override
public List<SavingsAccountData> retrieveFixedDepositsDueForInterestPosting(final boolean backdatedTxnsAllowedTill,
final LocalDate postingDate, final Long officeId, final Long productId) {
final StringBuilder candidates = new StringBuilder("select a.id from m_savings_account a ")
.append("left join m_client ic on ic.id = a.client_id ")
.append("left join m_group ig on ig.id = a.group_id ")
.append("where a.status_enum = ? and a.deposit_type_enum = ? ")
.append("and (a.interest_posted_till_date is null or a.interest_posted_till_date <= ?) ");
final List<Object> params = new ArrayList<>(List.of(ACTIVE_STATUS, DEPOSIT_TYPE_FIXED, postingDate.minusDays(1)));
if (officeId != null) {
candidates.append("and coalesce(ic.office_id, ig.office_id) = ? ");
params.add(officeId);
}
if (productId != null) {
candidates.append("and a.product_id = ? ");
params.add(productId);
}
String sql = "select " + this.savingAccountMapperForInterestPosting.schema() + "join (" + candidates
+ ") b on b.id = sa.id ";
if (backdatedTxnsAllowedTill) {
sql = sql
+ "where (CASE WHEN sa.interest_posted_till_date is not null THEN tr.transaction_date >= sa.interest_posted_till_date ELSE tr.transaction_date >= sa.activatedon_date END) ";
}
sql = sql + " order by sa.id, tr.transaction_date, tr." + CREATED_DATE_DB_FIELD + ", tr.created_date, tr.id";
final List<SavingsAccountData> deposits = this.jdbcTemplate.query(sql, this.savingAccountMapperForInterestPosting, // NOSONAR
params.toArray());
for (final SavingsAccountData deposit : deposits) {
this.savingAccountAssembler.assembleSavings(deposit);
}
return deposits;
}
private static final class SavingAccountMapperForInterestPosting implements ResultSetExtractor<List<SavingsAccountData>> {
private final String schemaSql;
@@ -434,9 +434,9 @@ public class SavingsConfiguration {
SavingsAccountRepositoryWrapper savingsAccountRepositoryWrapper, ColumnValidator columnValidator,
// @Lazy because the accrual service depends on beans from this same package: resolving
// both eagerly closes a cycle and the context fails to start.
@Lazy SavingsDailyInterestService savingsDailyInterestService) {
@Lazy SavingsDailyInterestService savingsDailyInterestService, ConfigurationDomainService configurationDomainService) {
return new SavingsAccountReadPlatformServiceImpl(context, jdbcTemplate, savingAccountAssembler, paginationHelper, columnValidator,
sqlGenerator, savingsAccountRepositoryWrapper, savingsDailyInterestService);
sqlGenerator, savingsAccountRepositoryWrapper, savingsDailyInterestService, configurationDomainService);
}
@Bean
@@ -40,6 +40,7 @@ import org.apache.fineract.infrastructure.core.exception.GeneralPlatformDomainRu
import org.apache.fineract.infrastructure.core.exception.PlatformDataIntegrityException;
import org.apache.fineract.infrastructure.core.serialization.FromJsonHelper;
import org.apache.fineract.infrastructure.core.serialization.GoogleGsonSerializerHelper;
import org.apache.fineract.infrastructure.core.service.PlatformEmailService;
import org.apache.fineract.infrastructure.security.service.PlatformSecurityContext;
import org.apache.fineract.organisation.office.domain.Office;
import org.apache.fineract.organisation.office.domain.OfficeRepositoryWrapper;
@@ -82,6 +83,7 @@ public class UserPendingWritePlatformServiceImpl implements UserPendingWritePlat
private final PasswordEncoder passwordEncoder;
private final UserDataValidator fromApiJsonDeserializer;
private final FromJsonHelper fromApiJsonHelper;
private final PlatformEmailService emailService;
@Override
@Transactional
@@ -293,13 +295,40 @@ public class UserPendingWritePlatformServiceImpl implements UserPendingWritePlat
appUser.updatePasswordResetRequired(true);
}
// Set pre-hashed password
// AppUser.fromJson() already generated a random plaintext password here when the maker ticked
// "send password to email" (it ignores whatever password the maker typed in that case) -- the
// field still holds that plaintext at this point, since nothing has encoded it yet. If the
// maker instead supplied their own password, request.getPasswordHash() carries the bcrypt
// hash submitCreateUser() produced from it; that plaintext was redacted to "[PROTECTED]"
// immediately and is gone for good, so there is nothing to email in that case.
final boolean sendPasswordToEmail = Boolean.TRUE.equals(replay.booleanObjectValueOfParameterNamed("sendPasswordToEmail"));
final String unencodedPassword = appUser.getPassword();
if (request.getPasswordHash() != null) {
// Maker-chosen password: already hashed, used as-is.
appUser.updatePassword(request.getPasswordHash());
} else {
// Auto-generated password (the normal "send password to email" case): this service's own
// generic PasswordEncoder, not the salted PlatformPasswordEncoder the live create-user flow
// uses -- consistent with how the maker-chosen-password branch above and submitCreateUser()
// already hash a password in this file. Encoding it here is not optional: AppUser's
// constructor stores whatever string it is given verbatim (see AppUser(Office, User, ...)),
// so skipping this would persist the plaintext password straight into m_appuser.password.
appUser.updatePassword(this.passwordEncoder.encode(unencodedPassword));
}
this.appUserRepository.saveAndFlush(appUser);
// Mirrors JpaUserDomainService.create(): the welcome email the live create-user flow sends is
// the one thing this parallel, pending-request flow never did -- sendPasswordToEmail was
// accepted and stored in the payload but nothing here ever acted on it, so a user created this
// way never received their password. Only fires for the auto-generated password: there is no
// plaintext to send for a maker-chosen one, per the comment above.
if (sendPasswordToEmail && request.getPasswordHash() == null) {
this.emailService.sendToUserAccount(userOffice.getName(), appUser.getFirstname(), appUser.getEmail(), appUser.getUsername(),
unencodedPassword);
}
// MFA Enrollment
final String otpDeliveryMethod = replay.stringValueOfParameterNamed("otpDeliveryMethod");
if (otpDeliveryMethod != null) {
@@ -172,4 +172,5 @@
<include file="parts/0596_recurring_deposit_missed_installment_penalty.xml" relativeToChangelogFile="true"/>
<include file="parts/0597_enable_recurring_deposit_product_maker_checker.xml" relativeToChangelogFile="true"/>
<include file="parts/0598_recurring_deposit_extend_tenure_permission.xml" relativeToChangelogFile="true"/>
<include file="parts/0593_fd_interest_posting_approval.xml" relativeToChangelogFile="true"/>
</databaseChangeLog>
@@ -0,0 +1,349 @@
<?xml version="1.1" encoding="UTF-8" standalone="no"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<databaseChangeLog xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-4.9.xsd">
<!--
Fixed deposit interest stops posting itself.
Until now an FD was paid by the nightly posting job the moment its posting date arrived: the
amount was worked out in memory and written straight to the customer's account, with nothing
in between that anybody could look at, question or sign. The branch learnt what it had paid
by reading the transactions afterwards.
This is the same gate savings interest was put behind in 0589, built for deposits. On a
posting date a report is generated listing every deposit of one branch and one product, what
it has earned, and where that interest is going; an authorised user who did not generate it
approves it; and only the approved figures are posted, as the branch closes its day. A branch
with an unapproved report cannot close.
Where the interest goes is the part that is particular to deposits, and it follows the
product's scheme (m_savings_product.fd_type):
SINGLE interest stays in the deposit and is paid with the principal at maturity
DOUBLE interest is compounded into the deposit, so maturity pays principal plus interest
SPECIAL interest is posted monthly and swept to the customer's linked savings account
so a SPECIAL line also records the savings account the money leaves for, and the transfer it
left on. The report keeps the figures rather than recomputing them at posting time: the
approved list is the authority, and the posting pays exactly what was approved, deposit by
deposit. A regeneration supersedes its predecessor instead of overwriting it, so what was
shown and what was approved stay on the record.
-->
<changeSet author="fineract" id="0593-1-fd-interest-posting-report">
<preConditions onFail="MARK_RAN">
<not><tableExists tableName="m_fd_interest_posting_report"/></not>
</preConditions>
<createTable tableName="m_fd_interest_posting_report">
<column name="id" type="BIGINT" autoIncrement="true">
<constraints primaryKey="true" nullable="false"/>
</column>
<!-- Fixed deposit products are savings products with deposit_type_enum 200. -->
<column name="fd_product_id" type="BIGINT">
<constraints nullable="false" foreignKeyName="fk_fdipr_product" referencedTableName="m_savings_product"
referencedColumnNames="id"/>
</column>
<!-- SINGLE, DOUBLE or SPECIAL as the product carried it when the report was generated:
the scheme decides where the interest goes, and a product retyped afterwards must not
change the meaning of figures somebody has already approved. -->
<column name="fd_type" type="VARCHAR(20)" defaultValue="SINGLE">
<constraints nullable="false"/>
</column>
<column name="office_id" type="BIGINT">
<constraints nullable="false" foreignKeyName="fk_fdipr_office" referencedTableName="m_office"
referencedColumnNames="id"/>
</column>
<column name="posting_date" type="DATE">
<constraints nullable="false"/>
</column>
<!-- GENERATED, APPROVED, POSTED, or SUPERSEDED by a regeneration. -->
<column name="status" type="VARCHAR(20)">
<constraints nullable="false"/>
</column>
<column name="total_interest" type="DECIMAL(19,6)" defaultValueNumeric="0">
<constraints nullable="false"/>
</column>
<column name="account_count" type="INT" defaultValueNumeric="0">
<constraints nullable="false"/>
</column>
<!-- As the product mapped them when the report was generated, for display and checking. -->
<column name="payable_gl_account_id" type="BIGINT"/>
<column name="paid_gl_account_id" type="BIGINT"/>
<!-- AUTO from the scheduled run, MANUAL from a regeneration. -->
<column name="generation_mode" type="VARCHAR(10)">
<constraints nullable="false"/>
</column>
<column name="generated_by" type="BIGINT"/>
<column name="generated_at" type="TIMESTAMP" defaultValueComputed="CURRENT_TIMESTAMP">
<constraints nullable="false"/>
</column>
<column name="approved_by" type="BIGINT"/>
<column name="approved_at" type="TIMESTAMP"/>
<!-- True where the head office approved for a branch that did not open that day. -->
<column name="approved_on_behalf" type="BOOLEAN" defaultValueBoolean="false"/>
<column name="posted_at" type="TIMESTAMP"/>
<column name="posting_run_id" type="BIGINT"/>
<!-- Why an approved report could not be posted; the next close retries it. -->
<column name="failure_reason" type="VARCHAR(1000)"/>
</createTable>
<createIndex tableName="m_fd_interest_posting_report" indexName="idx_fdipr_product_date">
<column name="fd_product_id"/>
<column name="posting_date"/>
</createIndex>
<createIndex tableName="m_fd_interest_posting_report" indexName="idx_fdipr_status_date">
<column name="status"/>
<column name="posting_date"/>
</createIndex>
<createIndex tableName="m_fd_interest_posting_report" indexName="idx_fdipr_office_date">
<column name="office_id"/>
<column name="posting_date"/>
</createIndex>
</changeSet>
<changeSet author="fineract" id="0593-2-fd-interest-posting-report-line">
<preConditions onFail="MARK_RAN">
<not><tableExists tableName="m_fd_interest_posting_report_line"/></not>
</preConditions>
<createTable tableName="m_fd_interest_posting_report_line">
<column name="id" type="BIGINT" autoIncrement="true">
<constraints primaryKey="true" nullable="false"/>
</column>
<column name="report_id" type="BIGINT">
<constraints nullable="false" foreignKeyName="fk_fdiprl_report"
referencedTableName="m_fd_interest_posting_report" referencedColumnNames="id"/>
</column>
<!-- The fixed deposit itself, which is a row of m_savings_account. -->
<column name="fd_account_id" type="BIGINT">
<constraints nullable="false" foreignKeyName="fk_fdiprl_account" referencedTableName="m_savings_account"
referencedColumnNames="id"/>
</column>
<column name="account_no" type="VARCHAR(50)"/>
<column name="client_name" type="VARCHAR(300)"/>
<column name="office_id" type="BIGINT"/>
<!--
The date the interest engine itself assigned to this posting — the end of the period the
interest was earned in, not the day the branch happens to close.
It is the line's identity, not decoration. The engine decides a period is already paid by
looking for an interest transaction ON that date, so a posting written under any other
date is invisible to it and the same period is computed, reported and paid again. It also
means one deposit can have more than one line on a report: a branch that did not close for
two quarters owes two postings, on two dates, and they stay two.
-->
<column name="interest_posting_date" type="DATE">
<constraints nullable="false"/>
</column>
<column name="interest_amount" type="DECIMAL(19,6)">
<constraints nullable="false"/>
</column>
<column name="balance_before" type="DECIMAL(19,6)">
<constraints nullable="false"/>
</column>
<column name="balance_after" type="DECIMAL(19,6)">
<constraints nullable="false"/>
</column>
<!-- What the deposit is, shown beside what it earned: the checker is approving interest
against a principal, a rate and a term, not against a number on its own. -->
<column name="deposit_amount" type="DECIMAL(19,6)"/>
<column name="interest_rate" type="DECIMAL(19,6)"/>
<column name="maturity_date" type="DATE"/>
<!-- SPECIAL only: the linked savings account this interest is swept to, and the transfer
it left on. Null for SINGLE and DOUBLE, where the interest stays in the deposit. -->
<column name="payout_savings_account_id" type="BIGINT"/>
<column name="payout_account_no" type="VARCHAR(50)"/>
<column name="payout_transaction_id" type="BIGINT"/>
<!-- The interest posting transaction, written when the report is posted. -->
<column name="fd_transaction_id" type="BIGINT"/>
</createTable>
<createIndex tableName="m_fd_interest_posting_report_line" indexName="idx_fdiprl_report">
<column name="report_id"/>
</createIndex>
<createIndex tableName="m_fd_interest_posting_report_line" indexName="idx_fdiprl_account">
<column name="fd_account_id"/>
<column name="interest_posting_date"/>
</createIndex>
</changeSet>
<changeSet author="fineract" id="0593-3-fd-interest-posting-run">
<preConditions onFail="MARK_RAN">
<not><tableExists tableName="m_fd_interest_posting_run"/></not>
</preConditions>
<createTable tableName="m_fd_interest_posting_run">
<column name="id" type="BIGINT" autoIncrement="true">
<constraints primaryKey="true" nullable="false"/>
</column>
<!-- One run per report: a retried posting reuses its run rather than opening a second. -->
<column name="report_id" type="BIGINT">
<constraints nullable="false" unique="true" uniqueConstraintName="uq_fdipru_report"/>
</column>
<column name="fd_product_id" type="BIGINT">
<constraints nullable="false"/>
</column>
<column name="office_id" type="BIGINT"/>
<column name="posting_date" type="DATE">
<constraints nullable="false"/>
</column>
<column name="account_count" type="INT" defaultValueNumeric="0">
<constraints nullable="false"/>
</column>
<column name="pooled_amount" type="DECIMAL(19,6)"/>
<column name="distributed_amount" type="DECIMAL(19,6)"/>
<column name="rounding_residual" type="DECIMAL(19,6)"/>
<!-- PENDING, COMPLETED or FAILED. -->
<column name="status" type="VARCHAR(20)">
<constraints nullable="false"/>
</column>
<column name="failure_reason" type="VARCHAR(1000)"/>
<column name="started_at" type="TIMESTAMP" defaultValueComputed="CURRENT_TIMESTAMP"/>
<column name="completed_at" type="TIMESTAMP"/>
</createTable>
</changeSet>
<!--
The scheduled generation. Runs at noon like the savings one, and for the same reason: the
branch has the afternoon to look at the figures and approve them before it closes.
-->
<changeSet author="fineract" id="0593-4-fd-interest-posting-report-job">
<preConditions onFail="MARK_RAN">
<sqlCheck expectedResult="0">SELECT COUNT(*) FROM job WHERE name = 'Generate Fixed Deposit Interest Posting Report'</sqlCheck>
</preConditions>
<insert tableName="job">
<column name="name" value="Generate Fixed Deposit Interest Posting Report"/>
<column name="display_name" value="Generate Fixed Deposit Interest Posting Report"/>
<column name="short_name" value="FD_IPRPT"/>
<column name="cron_expression" value="0 0 12 1/1 * ? *"/>
<column name="create_time" valueDate="${current_datetime}"/>
<column name="task_priority" valueNumeric="5"/>
<column name="group_name"/>
<column name="previous_run_start_time"/>
<column name="job_key" value="Generate Fixed Deposit Interest Posting ReportJobDetail1 _ DEFAULT"/>
<column name="initializing_errorlog"/>
<column name="is_active" valueBoolean="true"/>
<column name="currently_running" valueBoolean="false"/>
<column name="updates_allowed" valueBoolean="true"/>
<column name="scheduler_group" valueNumeric="1"/>
<column name="is_misfired" valueBoolean="false"/>
<column name="node_id" valueNumeric="1"/>
<column name="is_mismatched_job" valueBoolean="true"/>
</insert>
</changeSet>
<changeSet author="fineract" id="0593-5-fd-interest-posting-report-permissions">
<preConditions onFail="MARK_RAN">
<sqlCheck expectedResult="0">
SELECT COUNT(*) FROM m_permission WHERE code IN ('READ_FDINTERESTREPORT',
'REGENERATE_FDINTERESTREPORT', 'APPROVE_FDINTERESTREPORT')
</sqlCheck>
</preConditions>
<insert tableName="m_permission">
<column name="grouping" value="portfolio"/>
<column name="code" value="READ_FDINTERESTREPORT"/>
<column name="entity_name" value="FDINTERESTREPORT"/>
<column name="action_name" value="READ"/>
<column name="can_maker_checker" valueBoolean="false"/>
</insert>
<insert tableName="m_permission">
<column name="grouping" value="portfolio"/>
<column name="code" value="REGENERATE_FDINTERESTREPORT"/>
<column name="entity_name" value="FDINTERESTREPORT"/>
<column name="action_name" value="REGENERATE"/>
<column name="can_maker_checker" valueBoolean="false"/>
</insert>
<!--
can_maker_checker stays false on APPROVE: the report IS the maker-checker record. The user
who generates it is the maker and the one who approves it the checker, both held on the
report itself, and the approval is refused if they are the same person. Routing this
through the generic command queue as well would park the approval behind a second approval
and replay it against a staging table it cannot see.
-->
<insert tableName="m_permission">
<column name="grouping" value="portfolio"/>
<column name="code" value="APPROVE_FDINTERESTREPORT"/>
<column name="entity_name" value="FDINTERESTREPORT"/>
<column name="action_name" value="APPROVE"/>
<column name="can_maker_checker" valueBoolean="false"/>
</insert>
</changeSet>
<changeSet author="fineract" id="0593-6-grant-fd-interest-posting-report-permissions">
<preConditions onFail="MARK_RAN">
<sqlCheck expectedResult="0">
SELECT COUNT(*) FROM m_role_permission rp
JOIN m_permission p ON p.id = rp.permission_id
WHERE p.code IN ('READ_FDINTERESTREPORT', 'REGENERATE_FDINTERESTREPORT',
'APPROVE_FDINTERESTREPORT')
</sqlCheck>
</preConditions>
<!-- Super user and manager-named roles, as 0589 grants the savings equivalent. -->
<sql>
INSERT INTO m_role_permission (role_id, permission_id)
SELECT r.id, p.id
FROM m_role r
CROSS JOIN m_permission p
WHERE p.code IN ('READ_FDINTERESTREPORT', 'REGENERATE_FDINTERESTREPORT',
'APPROVE_FDINTERESTREPORT')
AND (LOWER(r.name) LIKE '%manager%' OR LOWER(r.name) = 'super user')
AND NOT EXISTS (
SELECT 1 FROM m_role_permission rp
WHERE rp.role_id = r.id AND rp.permission_id = p.id
)
</sql>
</changeSet>
<!--
The switch back. With this on, fixed deposits are held out of the nightly posting job and paid
only through an approved report; with it off, the job pays them directly as it always did and
the report screens simply have nothing to show. It is here so a bank that hits trouble on the
new path can return to the old one without a code change, and so the two never run at once —
every query that selects deposits for posting reads this same flag.
-->
<!--
The period a line's interest was earned over, not just the date it ends on: a checker reading
"Quarterly: 01 Oct - 31 Dec" is told what it is approving in a way a bare end date never said.
Nullable because a line already posted before this column existed has no retroactive start date
and is shown as an open-ended period rather than invented.
-->
<changeSet author="fineract" id="0593-8-fd-interest-posting-report-line-period-from">
<preConditions onFail="MARK_RAN">
<not><columnExists tableName="m_fd_interest_posting_report_line" columnName="interest_period_from"/></not>
</preConditions>
<addColumn tableName="m_fd_interest_posting_report_line">
<column name="interest_period_from" type="DATE"/>
</addColumn>
</changeSet>
<changeSet author="fineract" id="0593-7-fd-interest-posting-approval-configuration">
<preConditions onFail="MARK_RAN">
<sqlCheck expectedResult="0">SELECT COUNT(*) FROM c_configuration WHERE name = 'fd-interest-posting-approval'</sqlCheck>
</preConditions>
<insert tableName="c_configuration">
<column name="name" value="fd-interest-posting-approval"/>
<column name="value" valueNumeric="0"/>
<column name="enabled" valueBoolean="true"/>
<column name="is_trap_door" valueBoolean="false"/>
<column name="description"
value="Fixed deposit interest is reported and approved before it is posted, and posts when the branch closes its day. Turn this off to let the nightly job post fixed deposit interest directly, as it did before."/>
</insert>
</changeSet>
</databaseChangeLog>
@@ -159,7 +159,9 @@ public class TestConfiguration {
FineractProperties fineractProperties, Environment environment,
List<CustomTaskChange> customTaskChangesForDependencyInjection) {
return new TenantDatabaseUpgradeService(tenantDetailsService, tenantDataSource, fineractProperties, tenantDatabaseStateVerifier,
liquibaseFactory, tenantDataSourceFactory, environment, customTaskChangesForDependencyInjection);
liquibaseFactory, tenantDataSourceFactory, environment,
new org.apache.fineract.infrastructure.core.service.migration.TenantInitialUserProvisioner(environment),
customTaskChangesForDependencyInjection);
}
/**
@@ -189,6 +189,8 @@ public class LiquibaseStepDefinitions implements En {
.willReturn(tenantLiquibase);
tenantDatabaseUpgradeService = new TenantDatabaseUpgradeService(tenantDetailsService, tenantStoreDataSource, fineractProperties,
databaseStateVerifier, liquibaseFactory, tenantDataSourceFactory, environment, Arrays.asList(tenantPasswordEncryptor));
databaseStateVerifier, liquibaseFactory, tenantDataSourceFactory, environment,
new org.apache.fineract.infrastructure.core.service.migration.TenantInitialUserProvisioner(environment),
Arrays.asList(tenantPasswordEncryptor));
}
}
@@ -68,6 +68,18 @@ public interface SavingsAccountReadPlatformService {
List<SavingsAccountData> retrieveAllSavingsDataForInterestPosting(boolean backdatedTxnsAllowedTill, int pageSize, Integer status,
Long maxSavingsId);
/**
* The active fixed deposits of one branch — and one product, where given — whose interest may be
* due for posting on the date. The interest engine settles whether any actually is.
*
* @param officeId
* the branch the deposit's customer belongs to, or null for every branch
* @param productId
* one fixed deposit product, or null for every product
*/
List<SavingsAccountData> retrieveFixedDepositsDueForInterestPosting(boolean backdatedTxnsAllowedTill, LocalDate postingDate,
Long officeId, Long productId);
List<SavingsAccountTransactionData> retrieveAllTransactionData(List<String> refNo);
Long retrieveAccountIdByExternalId(ExternalId externalId);