| /** |
| * 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.accounting.common; |
| |
| import java.util.ArrayList; |
| import java.util.HashMap; |
| import java.util.List; |
| import java.util.Map; |
| import org.apache.fineract.accounting.financialactivityaccount.data.FinancialActivityData; |
| import org.apache.fineract.accounting.glaccount.domain.GLAccountType; |
| |
| public final class AccountingConstants { |
| |
| private AccountingConstants() { |
| |
| } |
| |
| /*** |
| * Accounting placeholders for cash based accounting for loan products |
| ***/ |
| public enum CashAccountsForLoan { |
| |
| FUND_SOURCE(1), // |
| LOAN_PORTFOLIO(2), // |
| INTEREST_ON_LOANS(3), // |
| INCOME_FROM_FEES(4), // |
| INCOME_FROM_PENALTIES(5), // |
| LOSSES_WRITTEN_OFF(6), // |
| TRANSFERS_SUSPENSE(10), // |
| OVERPAYMENT(11), // |
| INCOME_FROM_RECOVERY(12), // |
| GOODWILL_CREDIT(13), // |
| INCOME_FROM_CHARGE_OFF_INTEREST(14), // |
| INCOME_FROM_CHARGE_OFF_FEES(15), // |
| CHARGE_OFF_EXPENSE(16), // |
| CHARGE_OFF_FRAUD_EXPENSE(17), // |
| INCOME_FROM_CHARGE_OFF_PENALTY(18), // |
| INCOME_FROM_GOODWILL_CREDIT_INTEREST(19), // |
| INCOME_FROM_GOODWILL_CREDIT_FEES(20), // |
| INCOME_FROM_GOODWILL_CREDIT_PENALTY(21); // |
| |
| private final Integer value; |
| |
| CashAccountsForLoan(final Integer value) { |
| this.value = value; |
| } |
| |
| @Override |
| public String toString() { |
| return name().toString().replaceAll("_", " "); |
| } |
| |
| public Integer getValue() { |
| return this.value; |
| } |
| |
| private static final Map<Integer, CashAccountsForLoan> intToEnumMap = new HashMap<>(); |
| |
| static { |
| for (final CashAccountsForLoan type : CashAccountsForLoan.values()) { |
| intToEnumMap.put(type.value, type); |
| } |
| } |
| |
| public static CashAccountsForLoan fromInt(final int i) { |
| final CashAccountsForLoan type = intToEnumMap.get(Integer.valueOf(i)); |
| return type; |
| } |
| } |
| |
| /*** |
| * Accounting placeholders for accrual based accounting for loan products |
| ***/ |
| public enum AccrualAccountsForLoan { |
| |
| FUND_SOURCE(1), // |
| LOAN_PORTFOLIO(2), // |
| INTEREST_ON_LOANS(3), // |
| INCOME_FROM_FEES(4), // |
| INCOME_FROM_PENALTIES(5), // |
| LOSSES_WRITTEN_OFF(6), // |
| INTEREST_RECEIVABLE(7), // |
| FEES_RECEIVABLE(8), // |
| PENALTIES_RECEIVABLE(9), // |
| TRANSFERS_SUSPENSE(10), // |
| OVERPAYMENT(11), // |
| INCOME_FROM_RECOVERY(12), // |
| GOODWILL_CREDIT(13), // |
| INCOME_FROM_CHARGE_OFF_INTEREST(14), // |
| INCOME_FROM_CHARGE_OFF_FEES(15), // |
| CHARGE_OFF_EXPENSE(16), // |
| CHARGE_OFF_FRAUD_EXPENSE(17), // |
| INCOME_FROM_CHARGE_OFF_PENALTY(18), // |
| INCOME_FROM_GOODWILL_CREDIT_INTEREST(19), // |
| INCOME_FROM_GOODWILL_CREDIT_FEES(20), // |
| INCOME_FROM_GOODWILL_CREDIT_PENALTY(21); // |
| |
| private final Integer value; |
| |
| AccrualAccountsForLoan(final Integer value) { |
| this.value = value; |
| } |
| |
| @Override |
| public String toString() { |
| return name().toString().replaceAll("_", " "); |
| } |
| |
| public Integer getValue() { |
| return this.value; |
| } |
| |
| private static final Map<Integer, AccrualAccountsForLoan> intToEnumMap = new HashMap<>(); |
| |
| static { |
| for (final AccrualAccountsForLoan type : AccrualAccountsForLoan.values()) { |
| intToEnumMap.put(type.value, type); |
| } |
| } |
| |
| public static AccrualAccountsForLoan fromInt(final int i) { |
| final AccrualAccountsForLoan type = intToEnumMap.get(Integer.valueOf(i)); |
| return type; |
| } |
| |
| } |
| |
| /*** |
| * Enum of all accounting related input parameter names used while creating/updating a loan product |
| ***/ |
| public enum LoanProductAccountingParams { |
| |
| FUND_SOURCE("fundSourceAccountId"), // |
| LOAN_PORTFOLIO("loanPortfolioAccountId"), // |
| INTEREST_ON_LOANS("interestOnLoanAccountId"), // |
| INCOME_FROM_FEES("incomeFromFeeAccountId"), // |
| INCOME_FROM_PENALTIES("incomeFromPenaltyAccountId"), // |
| LOSSES_WRITTEN_OFF("writeOffAccountId"), // |
| GOODWILL_CREDIT("goodwillCreditAccountId"), // |
| OVERPAYMENT("overpaymentLiabilityAccountId"), // |
| INTEREST_RECEIVABLE("receivableInterestAccountId"), // |
| FEES_RECEIVABLE("receivableFeeAccountId"), // |
| PENALTIES_RECEIVABLE("receivablePenaltyAccountId"), // |
| TRANSFERS_SUSPENSE("transfersInSuspenseAccountId"), // |
| PAYMENT_CHANNEL_FUND_SOURCE_MAPPING("paymentChannelToFundSourceMappings"), // |
| PAYMENT_TYPE("paymentTypeId"), // |
| FEE_INCOME_ACCOUNT_MAPPING("feeToIncomeAccountMappings"), // |
| PENALTY_INCOME_ACCOUNT_MAPPING("penaltyToIncomeAccountMappings"), // |
| CHARGE_ID("chargeId"), // |
| INCOME_ACCOUNT_ID("incomeAccountId"), // |
| INCOME_FROM_RECOVERY("incomeFromRecoveryAccountId"), // |
| INCOME_FROM_CHARGE_OFF_INTEREST("incomeFromChargeOffInterestAccountId"), // |
| INCOME_FROM_CHARGE_OFF_FEES("incomeFromChargeOffFeesAccountId"), // |
| CHARGE_OFF_EXPENSE("chargeOffExpenseAccountId"), // |
| CHARGE_OFF_FRAUD_EXPENSE("chargeOffFraudExpenseAccountId"), // |
| INCOME_FROM_CHARGE_OFF_PENALTY("incomeFromChargeOffPenaltyAccountId"), // |
| INCOME_FROM_GOODWILL_CREDIT_INTEREST("incomeFromGoodwillCreditInterestAccountId"), // |
| INCOME_FROM_GOODWILL_CREDIT_FEES("incomeFromGoodwillCreditFeesAccountId"), // |
| INCOME_FROM_GOODWILL_CREDIT_PENALTY("incomeFromGoodwillCreditPenaltyAccountId"); // |
| |
| private final String value; |
| |
| LoanProductAccountingParams(final String value) { |
| this.value = value; |
| } |
| |
| @Override |
| public String toString() { |
| return name().toString().replaceAll("_", " "); |
| } |
| |
| public String getValue() { |
| return this.value; |
| } |
| } |
| |
| public enum LoanProductAccountingDataParams { |
| |
| FUND_SOURCE("fundSourceAccount"), // |
| LOAN_PORTFOLIO("loanPortfolioAccount"), // |
| INTEREST_ON_LOANS("interestOnLoanAccount"), // |
| INCOME_FROM_FEES("incomeFromFeeAccount"), // |
| INCOME_FROM_PENALTIES("incomeFromPenaltyAccount"), // |
| LOSSES_WRITTEN_OFF("writeOffAccount"), // |
| GOODWILL_CREDIT("goodwillCreditAccount"), // |
| OVERPAYMENT("overpaymentLiabilityAccount"), // |
| INTEREST_RECEIVABLE("receivableInterestAccount"), // |
| FEES_RECEIVABLE("receivableFeeAccount"), // |
| PENALTIES_RECEIVABLE("receivablePenaltyAccount"), // |
| TRANSFERS_SUSPENSE("transfersInSuspenseAccount"), // |
| INCOME_ACCOUNT_ID("incomeAccount"), // |
| INCOME_FROM_RECOVERY("incomeFromRecoveryAccount"), // |
| LIABILITY_TRANSFER_SUSPENSE("liabilityTransferInSuspenseAccount"), // |
| INCOME_FROM_CHARGE_OFF_INTEREST("incomeFromChargeOffInterestAccount"), // |
| INCOME_FROM_CHARGE_OFF_FEES("incomeFromChargeOffFeesAccount"), // |
| CHARGE_OFF_EXPENSE("chargeOffExpenseAccount"), // |
| CHARGE_OFF_FRAUD_EXPENSE("chargeOffFraudExpenseAccount"), // |
| INCOME_FROM_CHARGE_OFF_PENALTY("incomeFromChargeOffPenaltyAccount"), // |
| INCOME_FROM_GOODWILL_CREDIT_INTEREST("incomeFromGoodwillCreditInterestAccount"), // |
| INCOME_FROM_GOODWILL_CREDIT_FEES("incomeFromGoodwillCreditFeesAccount"), // |
| INCOME_FROM_GOODWILL_CREDIT_PENALTY("incomeFromGoodwillCreditPenaltyAccount"); // |
| |
| private final String value; |
| |
| LoanProductAccountingDataParams(final String value) { |
| this.value = value; |
| } |
| |
| @Override |
| public String toString() { |
| return name().toString().replaceAll("_", " "); |
| } |
| |
| public String getValue() { |
| return this.value; |
| } |
| } |
| |
| /*** |
| * Accounting placeholders for cash based accounting for savings products |
| ***/ |
| public enum CashAccountsForSavings { |
| |
| SAVINGS_REFERENCE(1), // |
| SAVINGS_CONTROL(2), // |
| INTEREST_ON_SAVINGS(3), // |
| INCOME_FROM_FEES(4), // |
| INCOME_FROM_PENALTIES(5), // |
| TRANSFERS_SUSPENSE(10), // |
| OVERDRAFT_PORTFOLIO_CONTROL(11), // |
| INCOME_FROM_INTEREST(12), // |
| LOSSES_WRITTEN_OFF(13), // |
| ESCHEAT_LIABILITY(14); // |
| |
| private final Integer value; |
| |
| CashAccountsForSavings(final Integer value) { |
| this.value = value; |
| } |
| |
| @Override |
| public String toString() { |
| return name().toString().replaceAll("_", " "); |
| } |
| |
| public Integer getValue() { |
| return this.value; |
| } |
| |
| private static final Map<Integer, CashAccountsForSavings> intToEnumMap = new HashMap<>(); |
| |
| static { |
| for (final CashAccountsForSavings type : CashAccountsForSavings.values()) { |
| intToEnumMap.put(type.value, type); |
| } |
| } |
| |
| public static CashAccountsForSavings fromInt(final int i) { |
| final CashAccountsForSavings type = intToEnumMap.get(Integer.valueOf(i)); |
| return type; |
| } |
| } |
| |
| /*** |
| * Accounting placeholders for periodic accrual based accounting for savings products |
| ***/ |
| public enum AccrualAccountsForSavings { |
| |
| SAVINGS_REFERENCE(1), // |
| SAVINGS_CONTROL(2), // |
| INTEREST_ON_SAVINGS(3), // |
| INCOME_FROM_FEES(4), // |
| INCOME_FROM_PENALTIES(5), // |
| TRANSFERS_SUSPENSE(10), // |
| OVERDRAFT_PORTFOLIO_CONTROL(11), // |
| INCOME_FROM_INTEREST(12), // |
| LOSSES_WRITTEN_OFF(13), // |
| ESCHEAT_LIABILITY(14), // |
| FEES_RECEIVABLE(15), // |
| PENALTIES_RECEIVABLE(16), // |
| INTEREST_PAYABLE(17); |
| |
| private final Integer value; |
| |
| AccrualAccountsForSavings(final Integer value) { |
| this.value = value; |
| } |
| |
| @Override |
| public String toString() { |
| return name().toString().replaceAll("_", " "); |
| } |
| |
| public Integer getValue() { |
| return this.value; |
| } |
| |
| private static final Map<Integer, AccrualAccountsForSavings> intToEnumMap = new HashMap<>(); |
| |
| static { |
| for (final AccrualAccountsForSavings type : AccrualAccountsForSavings.values()) { |
| intToEnumMap.put(type.value, type); |
| } |
| } |
| |
| public static AccrualAccountsForSavings fromInt(final int i) { |
| final AccrualAccountsForSavings type = intToEnumMap.get(Integer.valueOf(i)); |
| return type; |
| } |
| } |
| |
| /*** |
| * Enum of all accounting related input parameter names used while creating/updating a savings product |
| ***/ |
| public enum SavingProductAccountingParams { |
| |
| SAVINGS_REFERENCE("savingsReferenceAccountId"), // |
| SAVINGS_CONTROL("savingsControlAccountId"), // |
| INCOME_FROM_FEES("incomeFromFeeAccountId"), // |
| INCOME_FROM_PENALTIES("incomeFromPenaltyAccountId"), // |
| INTEREST_ON_SAVINGS("interestOnSavingsAccountId"), // |
| PAYMENT_CHANNEL_FUND_SOURCE_MAPPING("paymentChannelToFundSourceMappings"), // |
| PAYMENT_TYPE("paymentTypeId"), // |
| FUND_SOURCE("fundSourceAccountId"), // |
| TRANSFERS_SUSPENSE("transfersInSuspenseAccountId"), // |
| FEE_INCOME_ACCOUNT_MAPPING("feeToIncomeAccountMappings"), // |
| PENALTY_INCOME_ACCOUNT_MAPPING("penaltyToIncomeAccountMappings"), // |
| CHARGE_ID("chargeId"), // |
| INCOME_ACCOUNT_ID("incomeAccountId"), // |
| OVERDRAFT_PORTFOLIO_CONTROL("overdraftPortfolioControlId"), // |
| INCOME_FROM_INTEREST("incomeFromInterestId"), // |
| LOSSES_WRITTEN_OFF("writeOffAccountId"), // |
| ESCHEAT_LIABILITY("escheatLiabilityId"), // |
| PENALTIES_RECEIVABLE("penaltiesReceivableAccountId"), // |
| FEES_RECEIVABLE("feesReceivableAccountId"), // |
| INTEREST_PAYABLE("interestPayableAccountId"); |
| |
| private final String value; |
| |
| SavingProductAccountingParams(final String value) { |
| this.value = value; |
| } |
| |
| @Override |
| public String toString() { |
| return name().toString().replaceAll("_", " "); |
| } |
| |
| public String getValue() { |
| return this.value; |
| } |
| } |
| |
| public enum SavingProductAccountingDataParams { |
| |
| SAVINGS_REFERENCE("savingsReferenceAccount"), // |
| SAVINGS_CONTROL("savingsControlAccount"), // |
| INCOME_FROM_FEES("incomeFromFeeAccount"), // |
| INCOME_FROM_PENALTIES("incomeFromPenaltyAccount"), // |
| INTEREST_ON_SAVINGS("interestOnSavingsAccount"), // |
| PAYMENT_TYPE("paymentType"), // |
| FUND_SOURCE("fundSourceAccount"), // |
| TRANSFERS_SUSPENSE("transfersInSuspenseAccount"), // |
| PENALTY_INCOME_ACCOUNT_MAPPING("penaltyToIncomeAccountMappings"), // |
| CHARGE_ID("charge"), // |
| INCOME_ACCOUNT_ID("incomeAccount"), // |
| OVERDRAFT_PORTFOLIO_CONTROL("overdraftPortfolioControl"), // |
| INCOME_FROM_INTEREST("incomeFromInterest"), // |
| LOSSES_WRITTEN_OFF("writeOffAccount"), // |
| ESCHEAT_LIABILITY("escheatLiabilityAccount"), // |
| FEES_RECEIVABLE("feeReceivableAccount"), // |
| PENALTIES_RECEIVABLE("penaltyReceivableAccount"), // |
| INTEREST_PAYABLE("interestPayableAccount"); // |
| |
| private final String value; |
| |
| SavingProductAccountingDataParams(final String value) { |
| this.value = value; |
| } |
| |
| @Override |
| public String toString() { |
| return name().toString().replaceAll("_", " "); |
| } |
| |
| public String getValue() { |
| return this.value; |
| } |
| } |
| |
| public enum FinancialActivity { |
| |
| ASSET_TRANSFER(100, "assetTransfer", GLAccountType.ASSET), // |
| LIABILITY_TRANSFER(200, "liabilityTransfer", GLAccountType.LIABILITY), // |
| CASH_AT_MAINVAULT(101, "cashAtMainVault", GLAccountType.ASSET), // |
| CASH_AT_TELLER(102, "cashAtTeller", GLAccountType.ASSET), // |
| OPENING_BALANCES_TRANSFER_CONTRA(300, "openingBalancesTransferContra", GLAccountType.EQUITY), // |
| ASSET_FUND_SOURCE(103, "fundSource", GLAccountType.ASSET), // |
| PAYABLE_DIVIDENDS(201, "payableDividends", GLAccountType.LIABILITY); // |
| |
| private final Integer value; |
| private final String code; |
| private final GLAccountType mappedGLAccountType; |
| |
| private static List<FinancialActivityData> financialActivities; |
| |
| static { |
| financialActivities = new ArrayList<>(); |
| for (final FinancialActivity type : FinancialActivity.values()) { |
| FinancialActivityData financialActivityData = convertToFinancialActivityData(type); |
| financialActivities.add(financialActivityData); |
| } |
| } |
| |
| FinancialActivity(final Integer value, final String code, final GLAccountType mappedGLAccountType) { |
| this.value = value; |
| this.code = code; |
| this.mappedGLAccountType = mappedGLAccountType; |
| } |
| |
| @Override |
| public String toString() { |
| return name().toString().replaceAll("_", " "); |
| } |
| |
| public Integer getValue() { |
| return this.value; |
| } |
| |
| public String getCode() { |
| return this.code; |
| } |
| |
| public GLAccountType getMappedGLAccountType() { |
| return mappedGLAccountType; |
| } |
| |
| public String getValueAsString() { |
| return this.value.toString(); |
| } |
| |
| private static final Map<Integer, FinancialActivity> intToEnumMap = new HashMap<>(); |
| |
| static { |
| for (final FinancialActivity type : FinancialActivity.values()) { |
| intToEnumMap.put(type.value, type); |
| } |
| } |
| |
| public static FinancialActivity fromInt(final int financialActivityId) { |
| final FinancialActivity type = intToEnumMap.get(Integer.valueOf(financialActivityId)); |
| return type; |
| } |
| |
| public static FinancialActivityData toFinancialActivityData(final int financialActivityId) { |
| final FinancialActivity type = fromInt(financialActivityId); |
| return convertToFinancialActivityData(type); |
| } |
| |
| public static List<FinancialActivityData> getAllFinancialActivities() { |
| return financialActivities; |
| } |
| |
| private static FinancialActivityData convertToFinancialActivityData(final FinancialActivity type) { |
| FinancialActivityData financialActivityData = new FinancialActivityData(type.value, type.code, type.getMappedGLAccountType()); |
| return financialActivityData; |
| } |
| } |
| |
| /*** |
| * Accounting placeholders for cash based accounting for Share products |
| ***/ |
| public enum CashAccountsForShares { |
| |
| SHARES_REFERENCE(1), SHARES_SUSPENSE(2), INCOME_FROM_FEES(3), SHARES_EQUITY(4); |
| |
| private final Integer value; |
| |
| CashAccountsForShares(final Integer value) { |
| this.value = value; |
| } |
| |
| @Override |
| public String toString() { |
| return name().toString().replaceAll("_", " "); |
| } |
| |
| public Integer getValue() { |
| return this.value; |
| } |
| |
| private static final Map<Integer, CashAccountsForShares> intToEnumMap = new HashMap<>(); |
| |
| static { |
| for (final CashAccountsForShares type : CashAccountsForShares.values()) { |
| intToEnumMap.put(type.value, type); |
| } |
| } |
| |
| public static CashAccountsForShares fromInt(final int i) { |
| final CashAccountsForShares type = intToEnumMap.get(Integer.valueOf(i)); |
| return type; |
| } |
| } |
| |
| /*** |
| * Enum of all accounting related input parameter names used while creating/updating a savings product |
| ***/ |
| public enum SharesProductAccountingParams { |
| |
| SHARES_REFERENCE("shareReferenceId"), // |
| SHARES_SUSPENSE("shareSuspenseId"), // |
| INCOME_FROM_FEES("incomeFromFeeAccountId"), // |
| SHARES_EQUITY("shareEquityId"); // |
| |
| private final String value; |
| |
| SharesProductAccountingParams(final String value) { |
| this.value = value; |
| } |
| |
| @Override |
| public String toString() { |
| return name().toString().replaceAll("_", " "); |
| } |
| |
| public String getValue() { |
| return this.value; |
| } |
| } |
| |
| public static final String ASSESTS_TAG_OPTION_CODE_NAME = "AssetAccountTags"; |
| public static final String LIABILITIES_TAG_OPTION_CODE_NAME = "LiabilityAccountTags"; |
| public static final String EQUITY_TAG_OPTION_CODE_NAME = "EquityAccountTags"; |
| public static final String INCOME_TAG_OPTION_CODE_NAME = "IncomeAccountTags"; |
| public static final String EXPENSES_TAG_OPTION_CODE_NAME = "ExpenseAccountTags"; |
| |
| } |
