From 2634a1a464078852a45dc06e1619aab36b23dad7 Mon Sep 17 00:00:00 2001 From: goutham-M Date: Fri, 10 May 2013 19:23:11 +0530 Subject: [PATCH 1/2] Api Docuentation Updation for GLAccount recent changes --- api-docs/apiLive.htm | 200 +++++++++++++++++- .../glaccount/data/GLAccountData.java | 6 +- 2 files changed, 199 insertions(+), 7 deletions(-) diff --git a/api-docs/apiLive.htm b/api-docs/apiLive.htm index 8de5d816e..0739eeec6 100644 --- a/api-docs/apiLive.htm +++ b/api-docs/apiLive.htm @@ -12522,6 +12522,19 @@ Request Body: Human understandable description for the Ledger Account + + + parentId + + + To assign a parent for this GLAccount + + + tagId + + + Used for tagging the AccountHeads, based on GLAccount types. + @@ -12548,6 +12561,14 @@ Request Body:
disabled
boolean optional +
+
parentId
+
+ Long optional +
+
tagId
+
+ Long optional

Example Requests:

@@ -12565,6 +12586,7 @@ GET https://DomainName/api/v1/glaccounts { "id": 16, "name": "Cash", + "parentId": 1, "glCode": "100001", "disabled": false, "manualEntriesAllowed": true, @@ -12578,7 +12600,12 @@ GET https://DomainName/api/v1/glaccounts "code": "accountUsage.detail", "value": "DETAIL" }, - "description": "Desc" + "description": "Desc", + "nameDecorated": "....Cash", + "tagId": { + "id": 10, + "name": "asset tag" + } }, { "id": 15, @@ -12618,11 +12645,13 @@ GET https://DomainName/api/v1/glaccounts

Example Request:

-
glaccounts/template
+
glaccounts/template?type=0
+
+ type is optional and integer value from 1 to 5.
-GET https://DomainName/api/v1/glaccounts/template +GET https://DomainName/api/v1/glaccounts/template?type=0 { @@ -12676,7 +12705,161 @@ GET https://DomainName/api/v1/glaccounts/template "code": "accountUsage.header", "value": "HEADER" } - ] + ], + "assetHeaderAccountOptions": [ + { + "id": 1, + "name": "Two wheeler loan", + "glCode": "10001", + "disabled": false, + "manualEntriesAllowed": true, + "type": { + "id": 1, + "code": "accountType.asset", + "value": "ASSET" + }, + "usage": { + "id": 2, + "code": "accountUsage.header", + "value": "HEADER" + }, + "nameDecorated": "Two wheeler loan", + "tagId": { + "id": 10, + "name": "asset tag" + } + }, + { + "id": 2, + "name": "VEHICLE LOAN", + "parentId": 1, + "glCode": "10002", + "disabled": false, + "manualEntriesAllowed": true, + "type": { + "id": 1, + "code": "accountType.asset", + "value": "ASSET" + }, + "usage": { + "id": 2, + "code": "accountUsage.header", + "value": "HEADER" + }, + "nameDecorated": "....VEHICLE LOAN", + "tagId": { + "id": 10, + "name": "asset tag" + } + } + ], + "liabilityHeaderAccountOptions": [ + { + "id": 15, + "name": "liabilitieschild", + "glCode": "ltchild", + "disabled": false, + "manualEntriesAllowed": true, + "type": { + "id": 2, + "code": "accountType.liability", + "value": "LIABILITY" + }, + "usage": { + "id": 2, + "code": "accountUsage.header", + "value": "HEADER" + }, + "nameDecorated": "liabilitieschild", + "tagId": { + "id": 11, + "name": "liability tag" + } + } + ], + "equityHeaderAccountOptions": [ + { + "id": 13, + "name": "testajax", + "glCode": "12345678", + "disabled": false, + "manualEntriesAllowed": true, + "type": { + "id": 3, + "code": "accountType.equity", + "value": "EQUITY" + }, + "usage": { + "id": 2, + "code": "accountUsage.header", + "value": "HEADER" + }, + "nameDecorated": "testajax", + "tagId": { + "id": 12, + "name": "Equity tag" + } + } + ], + "expenseHeaderAccountOptions": [ + { + "id": 8, + "name": "Salary", + "glCode": "450098", + "disabled": false, + "manualEntriesAllowed": true, + "type": { + "id": 5, + "code": "accountType.expense", + "value": "EXPENSE" + }, + "usage": { + "id": 2, + "code": "accountUsage.header", + "value": "HEADER" + }, + "nameDecorated": "Salary", + "tagId": { + "id": 14, + "name": "Expenses Tag" + } + } + ], + "allowedAssetsTagOptions": [ + { + "id": 10, + "name": "asset tag", + "position": 0 + } + ], + "allowedLiabilitiesTagOptions": [ + { + "id": 11, + "name": "liability tag", + "position": 0 + } + ], + "allowedEquityTagOptions": [ + { + "id": 12, + "name": "Equity tag", + "position": 0 + } + ], + "allowedIncomeTagOptions": [ + { + "id": 13, + "name": "Income Tag", + "position": 0 + } + ], + "allowedExpensesTagOptions": [ + { + "id": 14, + "name": "Expenses Tag", + "position": 0 + } + ] }
@@ -12756,6 +12939,8 @@ Request Body: "glCode": "100017", "manualEntriesAllowed": true, "type": 1, + "tagId": "10", + "parentId": "18", "usage": 1, "description": "Cash at Bangalore Branch" } @@ -13191,6 +13376,13 @@ No Request Body: for all credits that make up the Journal entry and vice-versa + + + referenceNumber + + + An additional field that is used to store additional information about the entry (Ex: chequeNo) + diff --git a/mifosng-provider/src/main/java/org/mifosplatform/accounting/glaccount/data/GLAccountData.java b/mifosng-provider/src/main/java/org/mifosplatform/accounting/glaccount/data/GLAccountData.java index 3b0a8aaf9..09aba58a0 100644 --- a/mifosng-provider/src/main/java/org/mifosplatform/accounting/glaccount/data/GLAccountData.java +++ b/mifosng-provider/src/main/java/org/mifosplatform/accounting/glaccount/data/GLAccountData.java @@ -108,7 +108,7 @@ public class GLAccountData { this.allowedExpensesTagOptions = allowedExpensesTagOptions; } - public static GLAccountData sensibleDefaultsForNewGLAccountCreation(final Integer GLAccType) { + public static GLAccountData sensibleDefaultsForNewGLAccountCreation(final Integer glAccType) { final Long id = null; final String name = null; final Long parentId = null; @@ -116,8 +116,8 @@ public class GLAccountData { final boolean disabled = false; final boolean manualEntriesAllowed = true; final EnumOptionData type; - if(GLAccType!=0) - type = AccountingEnumerations.gLAccountType(GLAccType); + if(glAccType != null && glAccType >= GLAccountType.getMinValue() && glAccType <= GLAccountType.getMaxValue()) + type = AccountingEnumerations.gLAccountType(glAccType); else type = AccountingEnumerations.gLAccountType(GLAccountType.ASSET); final EnumOptionData usage = AccountingEnumerations.gLAccountUsage(GLAccountUsage.DETAIL); From dbde325c27d2d5b11806dca8f1e0e7acbdf1244b Mon Sep 17 00:00:00 2001 From: goutham-M Date: Tue, 14 May 2013 10:33:23 +0530 Subject: [PATCH 2/2] Formatting apiLive.htm --- api-docs/apiLive.htm | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/api-docs/apiLive.htm b/api-docs/apiLive.htm index 0739eeec6..0ee96cbbd 100644 --- a/api-docs/apiLive.htm +++ b/api-docs/apiLive.htm @@ -12533,7 +12533,7 @@ Request Body: tagId - Used for tagging the AccountHeads, based on GLAccount types. + Used for tagging the Account Heads, based on GLAccount types. @@ -12586,7 +12586,7 @@ GET https://DomainName/api/v1/glaccounts { "id": 16, "name": "Cash", - "parentId": 1, + "parentId": 1, "glCode": "100001", "disabled": false, "manualEntriesAllowed": true, @@ -12645,13 +12645,20 @@ GET https://DomainName/api/v1/glaccounts

Example Request:

-
glaccounts/template?type=0
+
glaccounts/template
+
glaccounts/template?type=1

type is optional and integer value from 1 to 5.
+


1.Assets +
2.Liabilities +
3.Equity +
4.Income +
5.Expenses

-GET https://DomainName/api/v1/glaccounts/template?type=0 +GET https://DomainName/api/v1/glaccounts/template
+GET https://DomainName/api/v1/glaccounts/template?type=1 {