diff --git a/api-docs/apiLive.htm b/api-docs/apiLive.htm index e0cc50518..7984b8c38 100644 --- a/api-docs/apiLive.htm +++ b/api-docs/apiLive.htm @@ -232,108 +232,6 @@ - -

Loan

@@ -3152,51 +3050,111 @@ GET https://DomainName/mifosng-provider/api/v1/centers/9?associations=groupMembe
-   +  

List Centers

+

The list capability of centers can support pagination and sorting.

+
Optional Arguments
+
+
offset
+
+ Integer optional, defaults to 0 +
+
Indicates from what result to start from.
+ +
limit
+
+ Integer optional, defaults to 200 +
+
Restricts the size of results returned.
+ +
orderBy
+
+ String optional, one of displayName, accountNo, officeId, officeName +
+
Orders the results by the field indicated.
+ +
sortBy
+
+ String optional, one of ASC, DESC +
+
Indicates what way to order results if orderBy is used.
+ +
officeId
+
+ Integer optional +
+
Provides ability to restrict list of centers returned based on the office there associated with.
+
underHierarchy
+
+ String optional +
+
Use the office hierarchy string to return all centers under a given hierarchy.
+ +
name
+
+ String optional +
+
Use name of centers to restrict results.
+ +
externalId
+
+ String optional +
+
Use externalId of center to restrict results.
+ +
sqlSearch
+
+ String optional +
+
Use an sql fragment valid for the underlying center schema to filter results. e.g. display_name like %K%
+

Example Requests:

centers
+
+
centers?fields=name,officeName,joinedDate
+
+
centers?offset=10&limit=50
+
+
centers?orderBy=name,sortOrder=DESC
GET https://DomainName/mifosng-provider/api/v1/centers -[ - { - "id": 8, - "status": { - "id": 100, - "code": "groupingStatusType.pending", - "value": "Pending" +{ + "totalFilteredRecords": 2, + "pageItems": [ + { + "id": 2, + "status": { + "id": 100, + "code": "groupingStatusType.pending", + "value": "Pending" + }, + "active": false, + "name": "Center 1", + "officeId": 1, + "officeName": "Head Office", + "hierarchy": ".2." }, - "active": false, - "name": "First Center (No groups)", - "officeId": 1, - "officeName": "Head Office", - "hierarchy": ".8." - }, - { - "id": 9, - "status": { - "id": 300, - "code": "groupingStatusType.active", - "value": "Active" - }, - "active": true, - "activationDate": [ - 2011, - 3, - 1 - ], - "name": "centerwithgroup", - "officeId": 1, - "officeName": "Head Office", - "hierarchy": ".9." - } -] + { + "id": 3, + "status": { + "id": 100, + "code": "groupingStatusType.pending", + "value": "Pending" + }, + "active": false, + "name": "Center 2", + "officeId": 1, + "officeName": "Head Office", + "hierarchy": ".3." + } + ] +}
@@ -3574,31 +3532,94 @@ DELETE groups/2

List Groups

+

The list capability of groups can support pagination and sorting.

+
Optional Arguments
+
+
offset
+
+ Integer optional, defaults to 0 +
+
Indicates from what result to start from.
+ +
limit
+
+ Integer optional, defaults to 200 +
+
Restricts the size of results returned.
+ +
orderBy
+
+ String optional, one of displayName, accountNo, officeId, officeName +
+
Orders the results by the field indicated.
+ +
sortBy
+
+ String optional, one of ASC, DESC +
+
Indicates what way to order results if orderBy is used.
+ +
officeId
+
+ Integer optional +
+
Provides ability to restrict list of groups returned based on the office there associated with.
+
underHierarchy
+
+ String optional +
+
Use the office hierarchy string to return all groups under a given hierarchy.
+ +
name
+
+ String optional +
+
Use name of groups to restrict results.
+ +
externalId
+
+ String optional +
+
Use externalId of groups to restrict results.
+ +
sqlSearch
+
+ String optional +
+
Use an sql fragment valid for the underlying group schema to filter results. e.g. display_name like %K%
+

Example Requests:

groups
+
+
groups?fields=name,officeName,joinedDate
+
+
groups?offset=10&limit=50
+
+
groups?orderBy=name,sortOrder=DESC
GET https://DomainName/mifosng-provider/api/v1/groups -[ - { - "id": 1, - "name": "First Group (changed)", - "externalId": "000-1A", - "officeId": 1, - "officeName": "Head Office", - "hierarchy": ".1." - }, - { - "id": 2, - "name": "Pending Group", - "officeId": 1, - "officeName": "Head Office", - "hierarchy": ".2." - } -] +{ + "totalFilteredRecords": 2, + "pageItems": [ + { + "id": 4, + "name": "AnotherGroup", + "status": { + "id": 100, + "code": "clientStatusType.pending", + "value": "Pending" + }, + "active": false, + "officeId": 1, + "officeName": "Head Office", + "hierarchy": ".4." + } + ] +}
@@ -12867,13 +12888,40 @@ No Request Body:

List Journal Entries

-
Arguments
-
-
officeId
-
- Integer optional -
-
glAccountId
+

The list capability of journal entries can support pagination and sorting.

+
Optional Arguments
+
+
offset
+
+ Integer optional, defaults to 0 +
+
Indicates from what result to start from.
+ +
limit
+
+ Integer optional, defaults to 200 +
+
Restricts the size of results returned.
+ +
orderBy
+
+ String optional, one of displayName, accountNo, officeId, officeName +
+
Orders the results by the field indicated.
+ +
sortBy
+
+ String optional, one of ASC, DESC +
+
Indicates what way to order results if orderBy is used.
+ +
officeId
+
+ Integer optional +
+
Provides ability to restrict list of centers returned based on the office there associated with.
+ +
glAccountId
Integer optional
@@ -12905,89 +12953,111 @@ No Request Body:
transactionId
String optional -
-
-

Example Requests:

-
journalentries?transactionId=PB37X8Y21EQUY4S
-
+ +
+

Example Requests:

+
journalentries
+
+
journalentries?transactionId=PB37X8Y21EQUY4S

journalentries?officeId=1&glAccountId=17&manualEntriesOnly=true&fromDate=2012-01-01&toDate=2013-01-01
+
+
journalentries?fields=officeName,glAccountName,transactionDate
+
+
journalentries?offset=10&limit=50
+
+
journalentries?orderBy=transactionId,sortOrder=DESC
GET https://DomainName/api/v1/journalentries?transactionId=PB37X8Y21EQUY4S -[ +{ + "totalFilteredRecords": 24, + "pageItems": [ { - "id": 81, - "officeId": 1, - "officeName": "Head Office", - "glAccountName": "Something totally else", - "glAccountId": 17, - "glAccountCode": "340098", - "glAccountType": { - "id": 3, - "code": "accountType.equity", - "value": "EQUITY" - }, - "transactionDate": [ - 2012, - 12, - 12 - ], - "entryType": { - "id": 2, - "code": "journalEntrytType.debit", - "value": "DEBIT" - }, - "amount": 120, - "transactionId": "PB37X8Y21EQUY4S", - "manualEntry": true, - "createdByUserId": 1, - "createdDate": [ - 2012, - 12, - 13 - ], - "createdByUserName": "mifos", - "reversed": true + "id": 1, + "officeId": 1, + "officeName": "Head Office", + "glAccountName": "ACCOUNT_NAME_WTYRB", + "glAccountId": 98, + "glAccountCode": "ASSET_C01367768735188", + "glAccountType": { + "id": 1, + "code": "accountType.asset", + "value": "ASSET" + }, + "transactionDate": [ + 2011, + 3, + 4 + ], + "entryType": { + "id": 2, + "code": "journalEntrytType.debit", + "value": "DEBIT" + }, + "amount": 10000, + "transactionId": "33", + "manualEntry": false, + "entityType": { + "id": 1, + "code": "productType.loan", + "value": "LOAN" + }, + "entityId": 7, + "createdByUserId": 1, + "createdDate": [ + 2013, + 5, + 5 + ], + "createdByUserName": "mifos", + "reversed": false }, { - "id": 82, - "officeId": 1, - "officeName": "Head Office", - "glAccountName": "Something else", - "glAccountId": 19, - "glAccountCode": "560050", - "glAccountType": { - "id": 3, - "code": "accountType.equity", - "value": "EQUITY" - }, - "transactionDate": [ - 2012, - 12, - 12 - ], - "entryType": { - "id": 1, - "code": "journalEntryType.credit", - "value": "CREDIT" - }, - "amount": 120, - "transactionId": "PB37X8Y21EQUY4S", - "manualEntry": true, - "createdByUserId": 1, - "createdDate": [ - 2012, - 12, - 13 - ], - "createdByUserName": "mifos", - "reversed": true + "id": 2, + "officeId": 1, + "officeName": "Head Office", + "glAccountName": "ACCOUNT_NAME_WTYRB", + "glAccountId": 98, + "glAccountCode": "ASSET_C01367768735188", + "glAccountType": { + "id": 1, + "code": "accountType.asset", + "value": "ASSET" + }, + "transactionDate": [ + 2011, + 3, + 4 + ], + "entryType": { + "id": 1, + "code": "journalEntryType.credit", + "value": "CREDIT" + }, + "amount": 10000, + "transactionId": "33", + "manualEntry": false, + "entityType": { + "id": 1, + "code": "productType.loan", + "value": "LOAN" + }, + "entityId": 7, + "createdByUserId": 1, + "createdDate": [ + 2013, + 5, + 5 + ], + "createdByUserName": "mifos", + "reversed": false } -] + ] +}