diff --git a/api-docs/apiLive.htm b/api-docs/apiLive.htm index 409c42392..1007b744e 100644 --- a/api-docs/apiLive.htm +++ b/api-docs/apiLive.htm @@ -2263,7 +2263,7 @@ Request Body:
Allows the Destination Branch to accept the proposed Client Transfer.
The destination branch may also choose to link this client to a group (in which case, any existing active JLG loan of the client is rescheduled to match the meeting frequency of the group) and loan Officer at the time of accepting the transfer
@@ -8933,190 +8933,190 @@ DELETE loanproducts/5/productmix - -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. - | -
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 during 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. + | +
Example Requests:
-
+
+
+
+ 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
- ]
- }
+{
+ "id": 1,
+ "name": "Good Friday",
+ "fromDate": [
+ 2013,
+ 10,
+ 25
+ ],
+ "toDate": [
+ 2013,
+ 10,
+ 25
+ ],
+ "repaymentsScheduleTo": [
+ 2013,
+ 10,
+ 26
+ ]
+}
]
-
-
+
+ Mandatory Fields |
-
| name, fromDate, toDate, repaymentsRescheduledTo, offices | -
+
+
+
+ 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"
- ]
+"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
+"resourceId": 1
}
-
-
+
-
+ 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. - | -
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. + | +