diff --git a/api-docs/apiLive.htm b/api-docs/apiLive.htm index 48fc60ebc..db216eae6 100644 --- a/api-docs/apiLive.htm +++ b/api-docs/apiLive.htm @@ -183,6 +183,14 @@ + + + clients/{clientId}?command=close + Close a Client + + + + clients/{clientId}/loans @@ -1839,6 +1847,12 @@ function executeAjaxRequest(url, verbType, jsonData, basicAuthKey, successFuncti
Defaults to false if not provided. If staffInSelectedOfficeOnly=true only staff who are associated with the selected branch are returned.
+
commandParam
+
+ String optional +
+
If commandParam=close retrieves all closureReasons which are associated with + "ClientClosureReason" value.

Example Request:

clients/template
@@ -1975,7 +1989,34 @@ Request Body: - + +   +
+
+

Close a Client

+

Clients can be closed if they dont have any non-closed loans/savingsAccount. This API exists to close a client .

+

If the client have any corresponding active loans/savingsAccount this API will result in an error.

+
+
+ POST https://Domain Name/api/v1/clients/{clientId}?command=close + POST clients/1?command=close +Content-Type: application/json +Request Body: +{ + "dateFormat":"dd MMMM yyyy", + "locale":"en", + "closureDate":"25 June 2013", + "closureReasonId":"11" +} + + +{ + "clientId":15, + "resourceId":15 +} + +
+
 
@@ -15783,6 +15824,14 @@ GET https://DomainName/api/v1/search?query=000000111 + + + clients/{clientId}?command=close + Close a Client + + + + clients/{clientId}/loans