Create a Loan Product
-Mandatory Fields |
Additional Mandatory Fields for Cash(2) based accounting |
+
| fundSourceAccountId, loanPortfolioAccountId, interestOnLoanAccountId, + incomeFromFeeAccountId, incomeFromPenaltyAccountId, + writeOffAccountId | +
Additional Mandatory Fields for Accrual(3) based accounting |
+
| fundSourceAccountId, loanPortfolioAccountId, interestOnLoanAccountId, + incomeFromFeeAccountId, incomeFromPenaltyAccountId, + writeOffAccountId, receivableInterestAccountId, receivableFeeAccountId, + receivablePenaltyAccountId |
@@ -4411,6 +4722,76 @@ Request Body:
"resourceId": 1
}
+
+POST loanproducts
+Content-Type: application/json
+Request Body:
+{
+ "name": "A new loan product for me",
+ "currencyCode": "USD",
+ "locale": "en_GB",
+ "digitsAfterDecimal": "2",
+ "principal": "100,000.00",
+ "numberOfRepayments": "12",
+ "repaymentEvery": "1",
+ "repaymentFrequencyType": 2,
+ "transactionProcessingStrategyId": 1,
+ "interestRatePerPeriod": "1.75",
+ "interestRateFrequencyType": 2,
+ "amortizationType": 1,
+ "interestType": 0,
+ "interestCalculationPeriodType": 1,
+ "accountingRule":"3",
+ "fundSourceAccountId":"15",
+ "loanPortfolioAccountId":"16",
+ "interestOnLoanAccountId":"14",
+ "incomeFromFeeAccountId":"13",
+ "incomeFromPenaltyAccountId":"12",
+ "writeOffAccountId":"11"
+}
+
+
+{
+ "resourceId": 2
+}
+
+
+POST loanproducts
+Content-Type: application/json
+Request Body:
+{
+ "name": "A new loan product for me",
+ "currencyCode": "USD",
+ "locale": "en_GB",
+ "digitsAfterDecimal": "2",
+ "principal": "100,000.00",
+ "numberOfRepayments": "12",
+ "repaymentEvery": "1",
+ "repaymentFrequencyType": 2,
+ "transactionProcessingStrategyId": 1,
+ "interestRatePerPeriod": "1.75",
+ "interestRateFrequencyType": 2,
+ "amortizationType": 1,
+ "interestType": 0,
+ "interestCalculationPeriodType": 1,
+ "accountingRule":"3",
+ "fundSourceAccountId":"15",
+ "loanPortfolioAccountId":"16",
+ "receivableInterestAccountId":"10",
+ "receivableFeeAccountId":"9",
+ "receivablePenaltyAccountId":"8",
+ "interestOnLoanAccountId":"14",
+ "incomeFromFeeAccountId":"13",
+ "incomeFromPenaltyAccountId":"12",
+ "writeOffAccountId":"11"
+}
+
+
+{
+ "resourceId": 3
+}
+
+
@@ -6985,6 +7366,390 @@ GET https://DomainName/api/v1/permissions
+
+
+
+
+
+
+
+
+
+
+ General Ledger Account
+Ledger accounts represent an Individual account within an Organizations Chart
+ Of Accounts(COA) and are assigned a name and unique number by which they can
+ be identified.
+ All transactions relating to a company's assets, liabilities, owners' equity,
+ revenue and expenses are recorded against these accounts
+
Field Descriptions |
+
| name | +
| The name of the account | +
| glCode | +
| The Ledger code associated with the
+ Account These codes are mandatory and should be unique within + an organization |
+
| disabled | +
| A boolean flag that indicates whether an account + is currently in use | +
| type | +
| Classifies the account into one of the following Types
+ Asset accounts: represent the different types of economic resources + owned or controlled by business, common examples of Asset accounts are cash, + cash in bank, building, inventory, prepaid rent, goodwill, accounts receivable + Liability accounts: represent the different types of economic obligations + by a business, such as accounts payable, bank loan, bonds payable + Income accounts: represent the company's gross earnings and common examples + include Interest Income, Sales and Service revenue + Expense accounts: represent the company's expenditures to enable itself to + operate. Common examples are electricity and water, rentals, depreciation, + doubtful accounts, insurance. + Equity accounts: represent the residual equity of a business (after + deducting from Assets all the liabilities) including Retained Earnings + and Appropriations + The options are fully listed in Retrieve + General Ledger Accounts Template. + |
+
| usage | +
| Determines how the account shall be used + "Header" accounts specify the title of a group of accounts. Header accounts are used + only to group detail accounts that have a similar purpose; that is, detail accounts + are assigned to specific header accounts + + "Detail" accounts may have transactions logged against them + The options are fully listed in Retrieve + General Ledger Accounts Template. + |
+
| manualEntriesAllowed | +
| Specifies if manual adjustments can be made + against this account using the + Create Journal Entries API | +
| description | +
| Human understandable description for the Ledger Account + | +
+
+
+
+
+
+
+
+ List General Ledger Accounts
+Arguments
+-
+
- type +
- + Integer optional + +
- manualAdjustmentsAllowed +
- + boolean optional + +
- usage +
- + Integer optional + +
- disabled +
- + boolean optional + +
Example Requests:
+glaccounts
+ +
+
glaccounts?type=1&manualAdjustmentsAllowed=true&usage=1&disabled=false
+
+
+
+GET https://DomainName/api/v1/glaccounts
+
+
+[
+ {
+ "id": 16,
+ "name": "Cash",
+ "glCode": "100001",
+ "disabled": false,
+ "manualEntriesAllowed": true,
+ "type": {
+ "id": 1,
+ "code": "accountType.asset",
+ "value": "ASSET"
+ },
+ "usage": {
+ "id": 1,
+ "code": "accountUsage.detail",
+ "value": "DETAIL"
+ },
+ "description": "Desc"
+ },
+ {
+ "id": 15,
+ "name": "Fund Source For Loan",
+ "glCode": "100002",
+ "disabled": false,
+ "manualEntriesAllowed": true,
+ "type": {
+ "id": 1,
+ "code": "accountType.asset",
+ "value": "ASSET"
+ },
+ "usage": {
+ "id": 1,
+ "code": "accountUsage.detail",
+ "value": "DETAIL"
+ },
+ "description": "Desc"
+ }
+]
+
+
+
+
+
+
+
+
+ Retrieve GL Accounts Template
+This is a convenience resource. It can be useful when + building maintenance user interface screens for client + applications. The template data returned consists of any or all + of: +
-
+
- Field Defaults +
- Allowed Value Lists +
Example Request:
+glaccounts/template
+
+
+
+GET https://DomainName/api/v1/glaccounts/template
+
+
+{
+ "disabled": false,
+ "manualEntriesAllowed": true,
+ "type": {
+ "id": 1,
+ "code": "accountType.asset",
+ "value": "ASSET"
+ },
+ "usage": {
+ "id": 1,
+ "code": "accountUsage.detail",
+ "value": "DETAIL"
+ },
+ "accountTypeOptions": [
+ {
+ "id": 1,
+ "code": "accountType.asset",
+ "value": "ASSET"
+ },
+ {
+ "id": 2,
+ "code": "accountType.liability",
+ "value": "LIABILITY"
+ },
+ {
+ "id": 3,
+ "code": "accountType.equity",
+ "value": "EQUITY"
+ },
+ {
+ "id": 4,
+ "code": "accountType.income",
+ "value": "INCOME"
+ },
+ {
+ "id": 5,
+ "code": "accountType.expense",
+ "value": "EXPENSE"
+ }
+ ],
+ "usageOptions": [
+ {
+ "id": 1,
+ "code": "accountUsage.detail",
+ "value": "DETAIL"
+ },
+ {
+ "id": 2,
+ "code": "accountUsage.header",
+ "value": "HEADER"
+ }
+ ]
+}
+
+
+
+
+
+
+
+
+
+
+
+ Retrieve a General Ledger Account
+Example Requests:
+glaccounts/1
+ +
+
glaccounts/1?template=true
+ +
+
glaccounts/1?fields=name,glCode
+
+
+
+GET https://DomainName/api/v1/glaccounts/{glaccountsId}
+
+
+{
+ "id": 1,
+ "name": "Cash",
+ "glCode": "100001",
+ "disabled": false,
+ "manualEntriesAllowed": true,
+ "type": {
+ "id": 1,
+ "code": "accountType.asset1",
+ "value": "ASSET"
+ },
+ "usage": {
+ "id": 1,
+ "code": "accountUsage.detail",
+ "value": "DETAIL"
+ },
+ "description": "Desc"
+}
+
+
+
+
+
+
+
+
+
+ Create a General Ledger Account
+
+ Note: You can optionally
+ create a Hierarchical Chart of Account by using the "parentId"
+ property of an Account
+
Mandatory Fields |
+
| name, glCode, classification, usage and manualEntriesAllowed + | +
+
+
+POST https://DomainName/api/v1/glaccounts_update
+
+
+POST glaccounts
+Content-Type: application/json
+Request Body:
+{
+ "name": "Cash at Bangalore",
+ "glCode": "100017",
+ "manualEntriesAllowed": true,
+ "classification": 1,
+ "usage": 1,
+ "description": "Cash at Bangalore Branch"
+}
+
+
+{
+ "resourceId": 22
+}
+
+
+
+
+
+
+
+ Update a General Ledger Account
+
+
+
+PUT https://DomainName/api/v1/glaccounts/{glaccountId}
+
+
+PUT glaccounts/1
+Content-Type: application/json
+Request Body:
+{
+ "name": "Cash at Tumkur"
+}
+
+
+{
+ "resourceId": 1,
+}
+
+
+
+
+
diff --git a/mifosng-provider/src/main/java/org/mifosplatform/accounting/api/GLAccountsApiResource.java b/mifosng-provider/src/main/java/org/mifosplatform/accounting/api/GLAccountsApiResource.java
index a26122e0c..bdc622e9c 100644
--- a/mifosng-provider/src/main/java/org/mifosplatform/accounting/api/GLAccountsApiResource.java
+++ b/mifosng-provider/src/main/java/org/mifosplatform/accounting/api/GLAccountsApiResource.java
@@ -70,7 +70,7 @@ public class GLAccountsApiResource {
@GET
@Consumes({ MediaType.APPLICATION_JSON })
@Produces({ MediaType.APPLICATION_JSON })
- public String retrieveAllAccounts(@Context final UriInfo uriInfo, @QueryParam("classification") final Integer classification,
+ public String retrieveAllAccounts(@Context final UriInfo uriInfo, @QueryParam("type") final Integer classification,
@QueryParam("searchParam") final String searchParam, @QueryParam("usage") final Integer usage,
@QueryParam("manualAdjustmentsAllowed") final Boolean manualTransactionsAllowed, @QueryParam("disabled") final Boolean disabled) {
diff --git a/mifosng-provider/src/main/java/org/mifosplatform/accounting/api/GLJournalEntriesApiResource.java b/mifosng-provider/src/main/java/org/mifosplatform/accounting/api/GLJournalEntriesApiResource.java
index 7a16871bc..b106a1a6f 100755
--- a/mifosng-provider/src/main/java/org/mifosplatform/accounting/api/GLJournalEntriesApiResource.java
+++ b/mifosng-provider/src/main/java/org/mifosplatform/accounting/api/GLJournalEntriesApiResource.java
@@ -15,6 +15,7 @@ import javax.ws.rs.core.Context;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.UriInfo;
+import org.apache.commons.lang.StringUtils;
import org.mifosplatform.accounting.api.commands.GLJournalEntryCommand;
import org.mifosplatform.accounting.api.data.GLJournalEntryData;
import org.mifosplatform.accounting.api.data.JournalEntryIdentifier;
@@ -24,6 +25,7 @@ import org.mifosplatform.accounting.api.infrastructure.DateParam;
import org.mifosplatform.accounting.service.GLJournalEntryReadPlatformService;
import org.mifosplatform.accounting.service.GLJournalEntryWritePlatformService;
import org.mifosplatform.infrastructure.core.api.ApiParameterHelper;
+import org.mifosplatform.infrastructure.core.exception.UnrecognizedQueryParamException;
import org.mifosplatform.infrastructure.security.service.PlatformSecurityContext;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Scope;
@@ -58,9 +60,9 @@ public class GLJournalEntriesApiResource {
@Consumes({ MediaType.APPLICATION_JSON })
@Produces({ MediaType.APPLICATION_JSON })
public String retrieveAllJournalEntries(@Context final UriInfo uriInfo, @QueryParam("officeId") final Long officeId,
- @QueryParam("glAccountId") final Long glAccountId,
- @QueryParam("portfolioGenerated") final Boolean portfolioGenerated, @QueryParam("fromDate") final DateParam fromDateParam,
- @QueryParam("toDate") final DateParam toDateParam) {
+ @QueryParam("glAccountId") final Long glAccountId, @QueryParam("portfolioGenerated") final Boolean portfolioGenerated,
+ @QueryParam("fromDate") final DateParam fromDateParam, @QueryParam("toDate") final DateParam toDateParam,
+ @QueryParam("transactionId") String transactionId) {
// TODO: Vishwas Add pagination, approach at
// http://www.javaworld.com/community/node/8295 looks good
@@ -79,8 +81,13 @@ public class GLJournalEntriesApiResource {
if (toDateParam != null) {
toDate = toDateParam.getDate();
}
- glJournalEntryDatas = this.glJournalEntryReadPlatformService.retrieveAllGLJournalEntries(officeId, glAccountId,
- portfolioGenerated, fromDate, toDate);
+ if (StringUtils.isBlank(transactionId)) {
+ glJournalEntryDatas = this.glJournalEntryReadPlatformService.retrieveAllGLJournalEntries(officeId, glAccountId,
+ portfolioGenerated, fromDate, toDate);
+ } else {
+ glJournalEntryDatas = this.glJournalEntryReadPlatformService.retrieveRelatedJournalEntries(transactionId);
+ }
+
return this.apiJsonSerializerService.serializeGLJournalEntryDataToJson(prettyPrint, responseParameters, glJournalEntryDatas);
}
@@ -88,7 +95,7 @@ public class GLJournalEntriesApiResource {
@Path("{glJournalEntryId}")
@Consumes({ MediaType.APPLICATION_JSON })
@Produces({ MediaType.APPLICATION_JSON })
- public String retreiveAccount(@PathParam("glJournalEntryId") final Long glJournalEntryId, @Context final UriInfo uriInfo) {
+ public String retreiveJournalEntryById(@PathParam("glJournalEntryId") final Long glJournalEntryId, @Context final UriInfo uriInfo) {
context.authenticatedUser().validateHasReadPermission(entityType);
@@ -111,13 +118,21 @@ public class GLJournalEntriesApiResource {
}
@POST
- @Path("{transactionId}/reversal")
+ @Path("{transactionId}")
@Consumes({ MediaType.APPLICATION_JSON })
@Produces({ MediaType.APPLICATION_JSON })
- public String createReversalJournalEntry(@PathParam("transactionId") final String transactionId) {
-
- this.glJournalEntryWritePlatformService.revertJournalEntry(transactionId);
+ public String createReversalJournalEntry(@PathParam("transactionId") final String transactionId,
+ @QueryParam("command") final String commandParam) {
+ if (is(commandParam, "reverse")) {
+ this.glJournalEntryWritePlatformService.revertJournalEntry(transactionId);
+ } else {
+ throw new UnrecognizedQueryParamException("command", commandParam);
+ }
return this.apiJsonSerializerService.serializeJournalEntryIdentifier(new JournalEntryIdentifier(transactionId));
}
+
+ private boolean is(final String commandParam, final String commandValue) {
+ return StringUtils.isNotBlank(commandParam) && commandParam.trim().equalsIgnoreCase(commandValue);
+ }
}
\ No newline at end of file
diff --git a/mifosng-provider/src/main/java/org/mifosplatform/accounting/exceptions/GLJournalEntryNotFoundException.java b/mifosng-provider/src/main/java/org/mifosplatform/accounting/exceptions/GLJournalEntryNotFoundException.java
new file mode 100755
index 000000000..fbb9e0219
--- /dev/null
+++ b/mifosng-provider/src/main/java/org/mifosplatform/accounting/exceptions/GLJournalEntryNotFoundException.java
@@ -0,0 +1,18 @@
+package org.mifosplatform.accounting.exceptions;
+
+import org.mifosplatform.infrastructure.core.exception.AbstractPlatformResourceNotFoundException;
+
+/**
+ * A {@link RuntimeException} thrown when journal entry resources are not found.
+ */
+public class GLJournalEntryNotFoundException extends AbstractPlatformResourceNotFoundException {
+
+ public GLJournalEntryNotFoundException(final String transactionId) {
+ super("error.msg.journalEntries.transactionId.invalid", "Journal Entries with transaction Identifier " + transactionId
+ + " does not exist or are not system generated/reversible ", transactionId);
+ }
+
+ public GLJournalEntryNotFoundException(final Long entryId) {
+ super("error.msg.journalEntries.id.invalid", "Journal Entry with entry Id " + entryId + " does not exist ", entryId);
+ }
+}
\ No newline at end of file
diff --git a/mifosng-provider/src/main/java/org/mifosplatform/accounting/service/GLAccountCommandValidator.java b/mifosng-provider/src/main/java/org/mifosplatform/accounting/service/GLAccountCommandValidator.java
index 15ace6697..8f2b2684f 100755
--- a/mifosng-provider/src/main/java/org/mifosplatform/accounting/service/GLAccountCommandValidator.java
+++ b/mifosng-provider/src/main/java/org/mifosplatform/accounting/service/GLAccountCommandValidator.java
@@ -30,7 +30,7 @@ public class GLAccountCommandValidator {
baseDataValidator.reset().parameter("parentId").value(command.getParentId()).ignoreIfNull().integerGreaterThanZero();
- baseDataValidator.reset().parameter("classification").value(command.getClassification())
+ baseDataValidator.reset().parameter("classification").value(command.getClassification()).notNull()
.inMinMaxRange(GLAccountType.getMinValue(), GLAccountType.getMaxValue());
baseDataValidator.reset().parameter("usage").value(command.getUsage())
diff --git a/mifosng-provider/src/main/java/org/mifosplatform/accounting/service/GLJournalEntryReadPlatformService.java b/mifosng-provider/src/main/java/org/mifosplatform/accounting/service/GLJournalEntryReadPlatformService.java
index 891b0eb47..7cbe1e93a 100755
--- a/mifosng-provider/src/main/java/org/mifosplatform/accounting/service/GLJournalEntryReadPlatformService.java
+++ b/mifosng-provider/src/main/java/org/mifosplatform/accounting/service/GLJournalEntryReadPlatformService.java
@@ -10,6 +10,8 @@ public interface GLJournalEntryReadPlatformService {
List
+
+ Delete a General Ledger Account
++ Note: Only Ledger Accounts against which no transactions have been logged + (either manually or by the loan or Savings portfolio) can be deleted. +
+
+
+
+DELETE https://DomainName/api/v1/glaccounts/{glaccountId}
+
+
+DELETE glaccounts/1
+Content-Type: application/json
+No Request Body:
+
+
+{
+ "resourceId": 1
+}
+
+