FINERACT-1681: Filter Journal entry by submitted on date

Author: adamsaghy

fineract-provider/src/main/java/org/apache/fineract/accounting/journalentry/api/JournalEntriesApiResource.java

@@ -79,10 +79,10 @@
 @RequiredArgsConstructor
 public class JournalEntriesApiResource {
 
-    private static final Set<String> RESPONSE_DATA_PARAMETERS = new HashSet<>(
-            Arrays.asList("id", "officeId", "officeName", "glAccountName", "glAccountId", "glAccountCode", "glAccountType",
-                    "transactionDate", "entryType", "amount", "transactionId", "manualEntry", "entityType", "entityId", "createdByUserId",
-                    "createdDate", "createdByUserName", "comments", "reversed", "referenceNumber", "currency", "transactionDetails"));
+    private static final Set<String> RESPONSE_DATA_PARAMETERS = new HashSet<>(Arrays.asList("id", "officeId", "officeName", "glAccountName",
+            "glAccountId", "glAccountCode", "glAccountType", "transactionDate", "entryType", "amount", "transactionId", "manualEntry",
+            "entityType", "entityId", "createdByUserId", "createdDate", "submittedOnDate", "createdByUserName", "comments", "reversed",
+            "referenceNumber", "currency", "transactionDetails"));
 
     private final String resourceNameForPermission = "JOURNALENTRY";
 
@@ -111,6 +111,8 @@ public String retrieveAll(@Context final UriInfo uriInfo,
             @QueryParam("manualEntriesOnly") @Parameter(description = "manualEntriesOnly") final Boolean onlyManualEntries,
             @QueryParam("fromDate") @Parameter(description = "fromDate") final DateParam fromDateParam,
             @QueryParam("toDate") @Parameter(description = "toDate") final DateParam toDateParam,
+            @QueryParam("submittedOnDateFrom") @Parameter(description = "submittedOnDateFrom") final DateParam submittedOnDateFromParam,
+            @QueryParam("submittedOnDateTo") @Parameter(description = "submittedOnDateTo") final DateParam submittedOnDateToParam,
             @QueryParam("transactionId") @Parameter(description = "transactionId") final String transactionId,
             @QueryParam("entityType") @Parameter(description = "entityType") final Integer entityType,
             @QueryParam("offset") @Parameter(description = "offset") final Integer offset,
@@ -135,13 +137,23 @@ public String retrieveAll(@Context final UriInfo uriInfo,
             toDate = toDateParam.getDate("toDate", dateFormat, locale);
         }
 
+        LocalDate submittedOnDateFrom = null;
+        if (submittedOnDateFromParam != null) {
+            submittedOnDateFrom = submittedOnDateFromParam.getDate("submittedOnDateFrom", dateFormat, locale);
+        }
+        LocalDate submittedOnDateTo = null;
+        if (submittedOnDateToParam != null) {
+            submittedOnDateTo = submittedOnDateToParam.getDate("submittedOnDateTo", dateFormat, locale);
+        }
+
         final SearchParameters searchParameters = SearchParameters.forJournalEntries(officeId, offset, limit, orderBy, sortOrder, loanId,
                 savingsId);
         JournalEntryAssociationParametersData associationParametersData = new JournalEntryAssociationParametersData(transactionDetails,
                 runningBalance);
 
         final Page<JournalEntryData> glJournalEntries = this.journalEntryReadPlatformService.retrieveAll(searchParameters, glAccountId,
-                onlyManualEntries, fromDate, toDate, transactionId, entityType, associationParametersData);
+                onlyManualEntries, fromDate, toDate, submittedOnDateFrom, submittedOnDateTo, transactionId, entityType,
+                associationParametersData);
         final ApiRequestJsonSerializationSettings settings = this.apiRequestParameterHelper.process(uriInfo.getQueryParameters());
         return this.apiJsonSerializerService.serialize(settings, glJournalEntries, RESPONSE_DATA_PARAMETERS);
     }
@@ -234,8 +246,8 @@ public String retrieveJournalEntries(@QueryParam("offset") final Integer offset,
         this.context.authenticatedUser();
         String transactionId = "P" + entryId;
         SearchParameters params = SearchParameters.forPagination(offset, limit);
-        Page<JournalEntryData> entries = this.journalEntryReadPlatformService.retrieveAll(params, null, null, null, null, transactionId,
-                PortfolioProductType.PROVISIONING.getValue(), null);
+        Page<JournalEntryData> entries = this.journalEntryReadPlatformService.retrieveAll(params, null, null, null, null, null, null,
+                transactionId, PortfolioProductType.PROVISIONING.getValue(), null);
         final ApiRequestJsonSerializationSettings settings = this.apiRequestParameterHelper.process(uriInfo.getQueryParameters());
         return this.apiJsonSerializerService.serialize(settings, entries, RESPONSE_DATA_PARAMETERS);
     }

fineract-provider/src/main/java/org/apache/fineract/accounting/journalentry/data/JournalEntryData.java

@@ -21,6 +21,7 @@
 import java.math.BigDecimal;
 import java.time.LocalDate;
 import java.util.List;
+import lombok.Getter;
 import org.apache.fineract.accounting.glaccount.data.GLAccountData;
 import org.apache.fineract.infrastructure.core.data.EnumOptionData;
 import org.apache.fineract.organisation.monetary.data.CurrencyData;
@@ -30,6 +31,7 @@
  *
  * Note: no getter/setters required as google will produce json from fields of object.
  */
+@Getter
 public class JournalEntryData {
 
     private final Long id;
@@ -76,6 +78,8 @@ public class JournalEntryData {
 
     @SuppressWarnings("unused")
     private final TransactionDetailData transactionDetails;
+    @SuppressWarnings("unused")
+    private final LocalDate submittedOnDate;
 
     // import fields
     private transient Integer rowIndex;
@@ -132,6 +136,7 @@ public JournalEntryData(Long officeId, LocalDate transactionDate, String currenc
         this.organizationRunningBalance = null;
         this.runningBalanceComputed = null;
         this.transactionDetails = null;
+        this.submittedOnDate = null;
     }
 
     public static JournalEntryData importInstance(Long officeId, LocalDate transactionDate, String currencyCode, Long paymentTypeId,
@@ -179,6 +184,7 @@ private JournalEntryData(Long officeId, LocalDate transactionDate, String curren
         this.entityType = null;
         this.entityId = null;
         this.createdByUserId = null;
+        this.submittedOnDate = null;
         this.createdDate = null;
         this.createdByUserName = null;
         this.reversed = null;
@@ -209,7 +215,7 @@ public void addCredits(CreditDebit credit) {
     public JournalEntryData(final Long id, final Long officeId, final String officeName, final String glAccountName, final Long glAccountId,
             final String glAccountCode, final EnumOptionData glAccountClassification, final LocalDate transactionDate,
             final EnumOptionData entryType, final BigDecimal amount, final String transactionId, final Boolean manualEntry,
-            final EnumOptionData entityType, final Long entityId, final Long createdByUserId, final LocalDate createdDate,
+            final EnumOptionData entityType, final Long entityId, final Long createdByUserId, final LocalDate submittedOnDate,
             final String createdByUserName, final String comments, final Boolean reversed, final String referenceNumber,
             final BigDecimal officeRunningBalance, final BigDecimal organizationRunningBalance, final Boolean runningBalanceComputed,
             final TransactionDetailData transactionDetailData, final CurrencyData currency) {
@@ -228,7 +234,8 @@ public JournalEntryData(final Long id, final Long officeId, final String officeN
         this.entityType = entityType;
         this.entityId = entityId;
         this.createdByUserId = createdByUserId;
-        this.createdDate = createdDate;
+        this.createdDate = submittedOnDate;
+        this.submittedOnDate = submittedOnDate;
         this.createdByUserName = createdByUserName;
         this.comments = comments;
         this.reversed = reversed;
@@ -240,40 +247,6 @@ public JournalEntryData(final Long id, final Long officeId, final String officeN
         this.currency = currency;
     }
 
-    public JournalEntryData(final Long id, final Long officeId, final String glAccountName, final Long glAccountId,
-            final String glAccountCode, final EnumOptionData glAccountClassification, final LocalDate transactionDate,
-            final EnumOptionData entryType, final BigDecimal amount, final String transactionId, final Boolean manualEntry,
-            final EnumOptionData entityType, final Long entityId, final LocalDate createdDate, final String currencyCode,
-            final Long savingTransactionId) {
-        this.id = id;
-        this.officeId = officeId;
-        this.officeName = null;
-        this.glAccountName = glAccountName;
-        this.glAccountId = glAccountId;
-        this.glAccountCode = glAccountCode;
-        this.glAccountType = glAccountClassification;
-        this.transactionDate = transactionDate;
-        this.entryType = entryType;
-        this.amount = amount;
-        this.transactionId = transactionId;
-        this.savingTransactionId = savingTransactionId;
-        this.manualEntry = manualEntry;
-        this.entityType = entityType;
-        this.entityId = entityId;
-        this.createdByUserId = null;
-        this.createdDate = createdDate;
-        this.createdByUserName = null;
-        this.comments = null;
-        this.reversed = false;
-        this.referenceNumber = null;
-        this.officeRunningBalance = null;
-        this.organizationRunningBalance = null;
-        this.runningBalanceComputed = null;
-        this.transactionDetails = null;
-        this.currency = null;
-        this.currencyCode = currencyCode;
-    }
-
     public static JournalEntryData fromGLAccountData(final GLAccountData glAccountData) {
 
         final Long id = null;
@@ -291,7 +264,7 @@ public static JournalEntryData fromGLAccountData(final GLAccountData glAccountDa
         final EnumOptionData entityType = null;
         final Long entityId = null;
         final Long createdByUserId = null;
-        final LocalDate createdDate = null;
+        final LocalDate submittedOnDate = null;
         final String createdByUserName = null;
         final String comments = null;
         final Boolean reversed = null;
@@ -302,65 +275,8 @@ public static JournalEntryData fromGLAccountData(final GLAccountData glAccountDa
         final TransactionDetailData transactionDetailData = null;
         final CurrencyData currency = null;
         return new JournalEntryData(id, officeId, officeName, glAccountName, glAccountId, glAccountCode, glAccountClassification,
-                transactionDate, entryType, amount, transactionId, manualEntry, entityType, entityId, createdByUserId, createdDate,
+                transactionDate, entryType, amount, transactionId, manualEntry, entityType, entityId, createdByUserId, submittedOnDate,
                 createdByUserName, comments, reversed, referenceNumber, officeRunningBalance, organizationRunningBalance,
                 runningBalanceComputed, transactionDetailData, currency);
     }
-
-    public Long getId() {
-        return this.id;
-    }
-
-    public Long getGlAccountId() {
-        return this.glAccountId;
-    }
-
-    public EnumOptionData getGlAccountType() {
-        return this.glAccountType;
-    }
-
-    public BigDecimal getAmount() {
-        return this.amount;
-    }
-
-    public EnumOptionData getEntryType() {
-        return this.entryType;
-    }
-
-    public Long getOfficeId() {
-        return this.officeId;
-    }
-
-    public String getTransactionId() {
-        return transactionId;
-    }
-
-    public Long getSavingTransactionId() {
-        return this.savingTransactionId;
-    }
-
-    public String getCurrencyCode() {
-        return this.currencyCode;
-    }
-
-    public boolean isManualEntry() {
-        return this.manualEntry;
-    }
-
-    public EnumOptionData getEntityType() {
-        return this.entityType;
-    }
-
-    public Long getEntityId() {
-        return this.entityId;
-    }
-
-    public LocalDate getCreatedDate() {
-        return this.createdDate;
-    }
-
-    public Long getPaymentTypeId() {
-        return this.paymentTypeId;
-    }
-
 }

fineract-provider/src/main/java/org/apache/fineract/accounting/journalentry/service/JournalEntryReadPlatformService.java

@@ -30,7 +30,8 @@ public interface JournalEntryReadPlatformService {
     JournalEntryData retrieveGLJournalEntryById(long glJournalEntryId, JournalEntryAssociationParametersData associationParametersData);
 
     Page<JournalEntryData> retrieveAll(SearchParameters searchParameters, Long glAccountId, Boolean onlyManualEntries, LocalDate fromDate,
-            LocalDate toDate, String transactionId, Integer entityType, JournalEntryAssociationParametersData associationParametersData);
+            LocalDate toDate, LocalDate submittedOnDateFrom, LocalDate submittedOnDateTo, String transactionId, Integer entityType,
+            JournalEntryAssociationParametersData associationParametersData);
 
     OfficeOpeningBalancesData retrieveOfficeOpeningBalances(Long officeId, String currencyCode);