diff --git a/api-docs/apiLive.htm b/api-docs/apiLive.htm index 5157b92f0..77e3c1b67 100644 --- a/api-docs/apiLive.htm +++ b/api-docs/apiLive.htm @@ -2,8 +2,7 @@ - + Mifos X API Documentation @@ -91,7 +90,7 @@
- +

Overview

@@ -101,15 +100,13 @@
  • Mifos X API Documentation
  • Try The API From Your Browser
  • Generic Options
    • -
  • Creating and - Updating
    • -
  • Updating Dates and - Numbers
    • +
  • Creating and Updating
    • +
  • Updating Dates and Numbers
  • Field Descriptions
    • -
  • Authentication - Overview
    • +
  • Authentication Overview
  • Errors
  • Full API Matrix
    • +
  • Beta API Matrix
    • @@ -235,6 +232,8 @@
    + +

    Loan

    @@ -551,6 +550,9 @@
    + + + +

    Accounting

    @@ -1342,6 +1346,8 @@ + + clients/template Retrieve Client Template @@ -1366,6 +1373,8 @@ loans/{loanId}/transactions/template Retrieve Loan Transaction Template + + offices/template Retrieve Office Template @@ -13307,6 +13317,14 @@ GET https://DomainName/api/v1/search?query=000000111 + + + clients/template + + Retrieve Client Template + + + clients/{clientId} @@ -13368,57 +13386,6 @@ GET https://DomainName/api/v1/search?query=000000111 - - - Center - centers - Create a Center - List Centers - - - - - - centers/{centerId} - - Retrieve a Center - Update a Center - Delete a Center - - - - centers/{centerId}?command=activate - Activate a Center - - - - - - Group - groups - Create a Group - List Groups - - - - - - groups/{group} - - Retrieve a Group - Update a Group - Delete a Group - - - - groups/{groupId}?command=activate - Activate a Group - - - - - - Loan Product loanproducts @@ -13427,12 +13394,19 @@ GET https://DomainName/api/v1/search?query=000000111 + + + loanproducts/template + + Retrieve Loan Product Template + + + loanproducts/{productId} - Retrieve a Loan - Product + Retrieve a Loan Product Update a Loan Product @@ -13452,6 +13426,14 @@ GET https://DomainName/api/v1/search?query=000000111 + + + loans/template?clientId={clientId} + + Retrieve Loan Template + + + loans/{loanId} @@ -13508,6 +13490,14 @@ GET https://DomainName/api/v1/search?query=000000111 + + + loans/{loanId}/transactions/template + + Retrieve Loan Transaction Template + + + Loan Transactions loans/{loanId}/transactions?command=repayment @@ -13599,78 +13589,6 @@ GET https://DomainName/api/v1/search?query=000000111 Update a Collateral Delete a Collateral - - Savings Product - savingsproducts - Create a Savings product - List Savings products - - - - - - savingsproducts/{productId} - - Retrieve a Savings product - Update a Savings product - Delete a Savings product - - - Savings Accounts - savingsaccounts - Create new Savings Account - List Savings Accounts - - - - - - savingsaccounts/{accountId} - - Retrieve a Savings Account - Update a Savings Account - Delete a Savings Account - - - - savingsaccounts/{accountId}?command=activate - Activate a Savings Account - - - - - - - savingsaccounts/{accountId}?command=calculateInterest - Calculate Interest on a Savings Account - - - - - - - savingsaccounts/{accountId}?command=postInterest - Post Interest on a Savings Account - - - - - - Savings Transactions - savingsaccounts/{accountId}/transactions?command=deposit - Make a Deposit - - - - - - - savingsaccounts/{accountId}/transactions?command=withdrawal - Make a Withdrawal - - - - Office offices @@ -13679,6 +13597,14 @@ GET https://DomainName/api/v1/search?query=000000111 + + + offices/template + + Retrieve Office Template + + + offices/{officeId} @@ -13739,46 +13665,62 @@ GET https://DomainName/api/v1/search?query=000000111 Update a Code Value Delete a Code Value - - Audits - audits - - List Audits - - - - - - audits/{auditId} - - Retrieve an Audit Entry - - - - - Makercheckers - makercheckers - - List Maker Checker Entries - - - - - - makercheckers/{auditId} - - - - Delete Maker Checker Entry - - - - makercheckers/{auditId}?command=approve - Approve Maker Checker Entry - - - - + + Audits + audits + + List Audits + + + + + + audits/searchtemplate + + Retrieve Audit Search Template + + + + + + audits/{auditId} + + Retrieve an Audit Entry + + + + + Makercheckers + makercheckers + + List Maker Checker Entries + + + + + + makercheckers/searchtemplate + + Retrieve Maker Checker Search Template + + + + + + makercheckers/{auditId} + + + + Delete Maker Checker Entry + + + + makercheckers/{auditId}?command=approve + Approve Maker Checker Entry + + + + Funds funds @@ -13981,30 +13923,38 @@ GET https://DomainName/api/v1/search?query=000000111 - - Report - reports - Create a Report - List Reports - - - - - - reports/{id} - - Retrieve a Report - Update a Report - Delete a Report - - - Run Report - runreports/{reportName} - - Run a Report - - - + + Report + reports + Create a Report + List Reports + + + + + + reports/template + + Retrieve Report Template + + + + + + reports/{id} + + Retrieve a Report + Update a Report + Delete a Report + + + Run Report + runreports/{reportName} + + Run a Report + + + Authentication authentication @@ -14021,6 +13971,14 @@ GET https://DomainName/api/v1/search?query=000000111 + + + users/template + + Retrieve User Template + + + users/{userId} @@ -14064,16 +14022,32 @@ GET https://DomainName/api/v1/search?query=000000111 -
    +
    + +   +
    + + + + +

    Beta API Matrix

    - + + + - - - - - - - - - - + + + + + + - - - + + + + + + + - - + + + + + + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - + + - - + + + + + + - - - - - - - - - - - + + + + + + +
    +
    - +
    TEMPLATE RESOURCESRESOURCES
    		+ + + + + + +
    POST
    create/complex update
    		 @@ -14082,66 +14056,188 @@ GET https://DomainName/api/v1/search?query=000000111
    GET
    read
    		+ + + + + + +
    PUT
    update
    		 + + + + + + +
    DELETE
    delete
    +
    centers/templateRetrieve Center Template
    groups/templateRetrieve Group Template
    clients/templateRetrieve Client TemplateCentercentersCreate a CenterList Centers
    loanproducts/templateRetrieve Loan Product Template
    centers/templateRetrieve Center Template
    loans/template?clientId={clientId}Retrieve Loan Templatecenters/{centerId}Retrieve a CenterUpdate a CenterDelete a Center
    loans/{loanId}/transactions/templateRetrieve Loan Transaction Templatecenters/{centerId}?command=activateActivate a Center
    GroupgroupsCreate a GroupList Groups
    groups/templateRetrieve Group Template
    groups/{groupId}Retrieve a GroupUpdate a GroupDelete a Group
    groups/{groupId}?command=activateActivate a Group
    Savings ProductsavingsproductsCreate a Savings productList Savings products
    savingproducts/template Retrieve Savings Product Template
    savingsproducts/{productId}Retrieve a Savings productUpdate a Savings productDelete a Savings product
    Savings AccountssavingsaccountsCreate new Savings AccountList Savings Accounts
    savingsaccounts/template?clientId={clientId} Retrieve Savings Account Template
    savingsaccounts/{accountId}Retrieve a Savings AccountUpdate a Savings AccountDelete a Savings Account
    savingsaccounts/{accountId}?command=activateActivate a Savings Account
    savingsaccounts/{accountId}?command=calculateInterestCalculate Interest on a Savings Account
    savingsaccounts/{accountId}?command=postInterestPost Interest on a Savings Account
    savingsaccounts/{accountId}/transactions/template Retrieve Savings Account Transaction Template
    offices/templateRetrieve Office Template
    users/templateRetrieve User TemplateSavings Transactionssavingsaccounts/{accountId}/transactions?command=depositMake a Deposit
    audits/searchtemplateRetrieve Audit Search Template
    makercheckers/searchtemplateRetrieve Maker Checker Search Template
    reports/templateRetrieve Report Template
    savingsaccounts/{accountId}/transactions?command=withdrawalMake a Withdrawal
    +