From cad6a46ea6e82ec62dcbca75fac1cb9e541c300e Mon Sep 17 00:00:00 2001 From: ashok-conflux Date: Fri, 13 Sep 2013 12:41:45 +0530 Subject: [PATCH] Added Holidays and working days details to api doc --- api-docs/apiLive.htm | 208 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 208 insertions(+) diff --git a/api-docs/apiLive.htm b/api-docs/apiLive.htm index 9db64215b..409c42392 100644 --- a/api-docs/apiLive.htm +++ b/api-docs/apiLive.htm @@ -900,6 +900,22 @@ Update Loan Product Mix Delete Loan Products Mix + + Holidays + holidays + Create a Holiday + List Holidays + + + + + Working days + + + + + + @@ -8916,6 +8932,194 @@ DELETE loanproducts/5/productmix + +   +
+
+

Holidays

+

Some MFI's span large regions where different branch offices might observe different holidays. They need the ability to define holidays for specific branch offices and be able to set the repayment rule to follow during those holidays. +

+

+ The reschedule of repayments to repaymentsRescheduledTo date durign defined holidays is turned on/off by enabling/disabling reschedule-repayments-on-holidays in Global configurations. +

+

Allow Repayment transactions on a defined holidays is turned on/off by enabling/disabling allow-transactions-on-holiday in Global configurations. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field Descriptions
name
Name of the holiday. +
fromDate
The date on holiday begins. +
toDate
The date on holiday ends. +
repaymentsRescheduledTo
Date to which repayments will be rescheduled when repayments date falls on a defined holiday. e.g. A holiday is defined on 25th of October 2013 with repaymentsRescheduledTo date to 26th of October 2013 and any loans with repayments date on 25th of October 2013 will be rescheduled to 26th of October 2013. +
officeId
The officeId represents the office to which holiday is applied. +
+
+
+ +   +
+
+

List Holidays

+

Example Requests:

+
holidays?officeId=1
+
+
+
+
+ +GET https://DomainName/api/v1/holidays?officeId=1 + + +[ + { + "id": 1, + "name": "Good Friday", + "fromDate": [ + 2013, + 10, + 25 + ], + "toDate": [ + 2013, + 10, + 25 + ], + "repaymentsScheduleTo": [ + 2013, + 10, + 26 + ] + } +] + +
+
+ +   +
+
+

Create a Holiday

+ + + + + + + +
Mandatory Fields
name, fromDate, toDate, repaymentsRescheduledTo, offices
+
+
+ +POST https://DomainName/api/v1/holidays + + +POST holidays +Content-Type: application/json +Request Body: +{ + "name": "Good Friday", + "dateFormat": "dd MMMM yyyy", + "locale": "en", + "fromDate": "25 October 2013", + "toDate": "25 October 2013", + "repaymentsRescheduledTo": "26 October 2013", + "offices": [ + "officeId":"1", + "officeId":"2" + ] +} + + +{ + "resourceId": 1 +} + +
+
+ + + +   +
+
+

Working days

+

The days of the week that are workdays. +

+

+ Rescheduling of repayments when it falls on a non-working is turned on /off by enable/disable reschedule-future-repayments parameter in Global configurations. +

+

+ Allow transactions on non-working days is configurable by enabling/disbaling the allow-transactions-on-non_workingday parameter in Global configurations. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Schedule for repayments on non-working day
Same day
The repayments schedule for same day regardless of it's a non-working day. +
Next workday
The repayments reschedule to next working day. e.g. if a repayment falls on a non-working day will be rescheduled to next available working day. +
Previous workday
The repayments reschedule to previous working day. e.g. if a repayment falls on a non-working day will be rescheduled to previous available working day. +
Next scheduled meeting
The repayments reschduled to next scheduled meeting. +
+
+
+ + +  
@@ -9035,6 +9239,10 @@ Request Body:

Global configuration related to set of supported enable/disable configurations:

  1. maker-checker - defaults to false - if true turns on maker-checker functionality
    2. +
  2. reschedule-future-repayments - defaults to false - if true reschedules repayemnts which falls on a non-working day to configured repayment rescheduling rule
    3. +
  3. allow-transactions-on-non_workingday - defaults to false - if true allows transactions on non-working days
    4. +
  4. reschedule-repayments-on-holidays - defaults to false - if true reschedules repayemnts which falls on a non-working day to defined reschedule date
    5. +
  5. allow-transactions-on-holiday - defaults to false - if true allows transactions on holidays