diff --git a/api-docs/apiLive.htm b/api-docs/apiLive.htm index c3c739cc3..dc9566041 100644 --- a/api-docs/apiLive.htm +++ b/api-docs/apiLive.htm @@ -37,19 +37,19 @@
|
|
|
|
| ||||||||||
| CONFIGURATION | /v1/configurations/currency | Retrieve Currency Configuration | Update Currency Configuration | |||||||||||
| CONFIGURATION | configurations/currency | Retrieve Currency Configuration | Update Currency Configuration | |||||||||||
|
|
|
|
| ||||||||||
| ADDITIONAL FIELDS | /v1/additionalfields | List Additional Fields Sets | ||||||||||||
| /v1/additionalfields/{Type}/{Set}/{id} | Update Additional Fields | Retrieve Additional Fields | ||||||||||||
| ADDITIONAL FIELDS | additionalfields | List Additional Fields Sets | ||||||||||||
| additionalfields/{Type}/{Set}/{id} | Update Additional Fields | Retrieve Additional Fields | ||||||||||||
|
|
|
|
| ||||||||||
| REPORT | /v1/reports | List Reports | ||||||||||||
| /v1/reports/{reportName} | Run a Report | |||||||||||||
| REPORT | reports | List Reports | ||||||||||||
| reports/{reportName} | Run a Report | |||||||||||||
|
|
|
|
| ||||||||||
| AUTHENTICATION | /v1/authentication | Verify Authentication | ||||||||||||
| USER | /v1/users | Create a User | List Users | |||||||||||
| /v1/users/{userId} | Retrieve a User | Update a User | Delete a User | |||||||||||
| ROLE | /v1/roles | Create a New Role | List Roles | |||||||||||
| /v1/roles/{roleId} | Retrieve a Role | Update a Role | ||||||||||||
| PERMISSION | /v1/permissions | List Application Permissions | ||||||||||||
| AUTHENTICATION | authentication | Verify Authentication | ||||||||||||
| USER | users | Create a User | List Users | |||||||||||
| users/{userId} | Retrieve a User | Update a User | Delete a User | |||||||||||
| ROLE | roles | Create a New Role | List Roles | |||||||||||
| roles/{roleId} | Retrieve a Role | Update a Role | ||||||||||||
| PERMISSION | permissions | List Application Permissions | ||||||||||||
|
| |||
| /v1/clients/template | Retrieve Client Details Template | |||
| /v1/loans/template | Retrieve Loan Details Template | |||
| /v1/loans/{loanId}/transactions/template | Retrieve Loan Repayment/Loan Waiver Template | |||
| /v1/offices/template | Retrieve Office Details Template | |||
| /v1/loanproducts/template | Retrieve Loan Product Details Template | |||
| /v1/users/template | Retrieve User Details Template | |||
| /v1/roles/template | Retrieve Role Details Template | |||
| clients/template | Retrieve Client Details Template | |||
| loans/template | Retrieve Loan Details Template | |||
| loans/{loanId}/transactions/template | Retrieve Loan Repayment/Loan Waiver Template | |||
| offices/template | Retrieve Office Details Template | |||
| loanproducts/template | Retrieve Loan Product Details Template | |||
| users/template | Retrieve User Details Template | |||
| roles/template | Retrieve Role Details Template |
Full API Matrix | API Endpoint: | https://thedomainname/api |
|
|
|
|
| ||||||||||
| CLIENT | /v1/clients | Create a Client | List Clients | |||||||||||
| /v1/clients/{clientId} | Retrieve a Client | Update a Client | ||||||||||||
| /v1/clients/{clientId}/loans | Retrieve a Client's Loan Account Summary | |||||||||||||
| /v1/clients/{clientId}/notes | Add a Client Note | Retrieve a Client's Notes | ||||||||||||
| /v1/clients/{clientId}/notes/{noteId} | Retrieve a Client Note | Update a Client Note | ||||||||||||
| LOAN | /v1/loans | Create a New Loan/Submit a Loan Application | ||||||||||||
| /v1/loans/{loanId} | Approve, Undo Approval, Disburse, Undo Disbursal, Reject a Loan or Withdraw a Loan Application | Retrieve a Loan | Delete a Loan | |||||||||||
| /v1/loans/{loanId}/transactions | Make a Repayment / Loan Waiver | |||||||||||||
| /v1/loans/{loanId}/transactions/{transactionId} | Adjust a Repayment or Waiver | Retrieve a Repayment or Waiver Details | ||||||||||||
| OFFICE | /v1/offices | Create an Office | List Offices | |||||||||||
| /v1/offices/{officeId} | Retrieve an Office | Update an Office | ||||||||||||
| LOAN PRODUCT | /v1/loanproducts | Create a Loan Product | List Loan Products | |||||||||||
| /v1/loanproducts/{productId} | Retrieve a Loan Product | Update a Loan Product | ||||||||||||
| CONFIGURATION | /v1/configurations/currency | Retrieve Currency Configuration | Update Currency Configuration | |||||||||||
| ADDITIONAL FIELDS | /v1/additionalfields | List Additional Fields Sets | ||||||||||||
| /v1/additionalfields/{Type}/{Set}/{id} | Update Additional Fields | Retrieve Additional Fields | ||||||||||||
| REPORT | /v1/reports | List Reports | ||||||||||||
| /v1/reports/{reportName} | Run a Report | |||||||||||||
| AUTHENTICATION | /v1/authentication | Verify Authentication | ||||||||||||
| USER | /v1/users | Create a User | List Users | |||||||||||
| /v1/users/{userId} | Retrieve a User | Update a User | Delete a User | |||||||||||
| ROLE | /v1/roles | Create a New Role | List Roles | |||||||||||
| /v1/roles/{roleId} | Retrieve a Role | Update a Role | ||||||||||||
| PERMISSION | /v1/permissions | List Application Permissions | ||||||||||||
| CLIENT | clients | Create a Client | List Clients | |||||||||||
| clients/{clientId} | Retrieve a Client | Update a Client | ||||||||||||
| clients/{clientId}/loans | Retrieve a Client's Loan Account Summary | |||||||||||||
| clients/{clientId}/notes | Add a Client Note | Retrieve a Client's Notes | ||||||||||||
| clients/{clientId}/notes/{noteId} | Retrieve a Client Note | Update a Client Note | ||||||||||||
| LOAN | loans | Create a New Loan / Submit a Loan Application | ||||||||||||
| loans/{loanId} | Approve, Undo Approval, Disburse, Undo Disbursal, Reject a Loan or Withdraw a Loan Application | Retrieve a Loan | Delete a Loan | |||||||||||
| loans/{loanId}/transactions | Make a Repayment / Loan Waiver | |||||||||||||
| loans/{loanId}/transactions/{transactionId} | Adjust a Repayment or Waiver | Retrieve a Repayment or Waiver Details | ||||||||||||
| OFFICE | offices | Create an Office | List Offices | |||||||||||
| offices/{officeId} | Retrieve an Office | Update an Office | ||||||||||||
| LOAN PRODUCT | loanproducts | Create a Loan Product | List Loan Products | |||||||||||
| loanproducts/{productId} | Retrieve a Loan Product | Update a Loan Product | ||||||||||||
| CONFIGURATION | configurations/currency | Retrieve Currency Configuration | Update Currency Configuration | |||||||||||
| ADDITIONAL FIELDS | additionalfields | List Additional Fields Sets | ||||||||||||
| additionalfields/{Type}/{Set}/{id} | Update Additional Fields | Retrieve Additional Fields | ||||||||||||
| REPORT | reports | List Reports | ||||||||||||
| reports/{reportName} | Run a Report | |||||||||||||
| AUTHENTICATION | authentication | Verify Authentication | ||||||||||||
| USER | users | Create a User | List Users | |||||||||||
| users/{userId} | Retrieve a User | Update a User | Delete a User | |||||||||||
| ROLE | roles | Create a New Role | List Roles | |||||||||||
| roles/{roleId} | Retrieve a Role | Update a Role | ||||||||||||
| PERMISSION | permissions | List Application Permissions | ||||||||||||
|
| |||
| /v1/clients/template | Retrieve Client Details Template | |||
| /v1/loans/template | Retrieve Loan Details Template | |||
| /v1/loans/{loanId}/transactions/template | Retrieve Loan Repayment/Loan Waiver Template | |||
| /v1/offices/template | Retrieve Office Details Template | |||
| /v1/loanproducts/template | Retrieve Loan Product Details Template | |||
| /v1/users/template | Retrieve User Details Template | |||
| /v1/roles/template | Retrieve Role Details Template | |||
| clients/template | Retrieve Client Details Template | |||
| loans/template | Retrieve Loan Details Template | |||
| loans/{loanId}/transactions/template | Retrieve Loan Repayment/Loan Waiver Template | |||
| offices/template | Retrieve Office Details Template | |||
| loanproducts/template | Retrieve Loan Product Details Template | |||
| users/template | Retrieve User Details Template | |||
| roles/template | Retrieve Role Details Template |
exception
org.mifosng.platform.loan.domain.InvalidLoanTimelineDate: The date of when loan is approved cannot be before its submittal date.
@@ -30,20 +30,18 @@ Loan Transitions ... approve etc
Column 'loan_status_id' cannot be null; SQL [n/a]; constraint [null]; nested exception is org.hibernate.exception.ConstraintViolationException: Column 'loan_status_id' cannot be null
- sometimes clientId returned... always loanId OK?
+ sometimes clientId returned... always loanId OK? DOING
Loan Transactions (repay and waive - and maybe reversal - but not disbursement) general talk needed as retrieve could work for any txn?
transaction type... UNKNOWN(0), DISBURSEMENT(1), REPAYMENT(2), REVERSAL(3), WAIVED(4);
Create - (command has string and proper value fields... so assume its like eventDate above)
- Template - does waiver amount default to 'rest of loan' cos it looked like it missed out on other waivers. didn't test
- repayment amount matches current installment outstanding amount w/o taking waivers into account.
- check descriptions - couldn't test because of invalid locale
- retrieve: display transaction type value?
- "principal" : null, "interest" : null, total, "totalWaived" : null, "overpaid" : null, and the offset - are nulls ever put in?
+ retrieve: display transaction type value? DOING
+ "principal" : null, "interest" : null, total, "totalWaived" : null, "overpaid" : null, and the offset - are nulls ever put in? DOING
adjust:
- when adjusting a disbursal - The server encountered an internal error () that prevented it from fulfilling this request.exception
java.lang.IllegalArgumentException: Only repayment and waiver transactions can be adjusted.
+
+ when adjusting a disbursal - The server encountered an internal error () that prevented it from fulfilling this request.exception
java.lang.IllegalArgumentException: Only repayment and waiver transactions can be adjusted. DONE
on create and adjust, app returns clientId can it be transaction id or loanId?
@@ -67,3 +65,23 @@ bit of loan product/loan
repayment/waiver - describe waiver
why fields "totalWaived", "overpaid"
+
+take aout /v1 from resource name.
+
+maxJoinedOnOffsetFromToday
+
+ - create a client example could show second example with the
+field clientOrBusinessName being used instead of firstname, lastname,
+no mention of it.
+ - mention if optional externalId is provided, it must be unqiue?
+ - TODO - check update of client with 'clientOrBusinessName' with
+a first name/last name results in error
+
+ - Loans
+ - digitsAfterDecimal and currencyCode should NOT be sent during
+creation - they should be inherited from the product. Likewise for
+update.
+ - Would be better if it was possible to not pass any of these
+details if defaults from loan product are acceptable, they can be
+inherited from loan product.
+