-
Notifications
You must be signed in to change notification settings - Fork 1.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add customer documentation for effective date #2607
Closed
tapaswenipathak
wants to merge
1
commit into
apache:develop
from
tapaswenipathak:effective-date-customer-docs
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
117 changes: 117 additions & 0 deletions
117
fineract-doc/src/docs/en/chapters/documentation/effective-date.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,117 @@ | ||
= Introducing Effective Date into Fineract | ||
|
||
For banks, Apache Fineract is introducing transaction idempotency, business and | ||
effective date configuration as an addition to currenty supported | ||
|
||
* System date | ||
* Tenant date | ||
* User-provided date | ||
|
||
An effective date represents the date that the receipient of a payment sees the | ||
funds transferred and the financial institutions at either end of the transaction | ||
settle funds with one another. | ||
|
||
As an example, usually the effective date for credit entries will be one or two | ||
days after the processing date; for debit entries the effective date is the | ||
following banking date or business date. | ||
|
||
= Features | ||
|
||
Customers and developers can now: | ||
|
||
* Specify effective date from which the compounding of interest or fee amounts | ||
will be considered in recalculation on late payment. | ||
* Specify effective date from which the late or advanced payment amounts will | ||
be considered in recalculation. | ||
* Update the recommended deposit amount for a RD account as on the effective date. | ||
* Specify or update deposit account transaction effective date. | ||
* Specify or update effective date in loan schedule generation. | ||
* Testing purpose. | ||
|
||
For Terms bearing the same effective date, loan term variations is sorted based | ||
on modified date (when available) and new inserted installment. | ||
|
||
= How to enable effective date as a functionality | ||
|
||
Effective date functionality can be added using Fineract job or using API. Both | ||
of which performs proper checks and outputs outcome parameter for the customers | ||
and developers. These also support timezones, daylight savings. | ||
|
||
== Job | ||
|
||
This depends on defining closing of business day (CoB) operations. Customers and | ||
developers can now: | ||
|
||
* Scheduled job | ||
|
||
As an example: | ||
|
||
```POST /fineract-provider/api/v1/jobs/<job_id>?command=executeJob`` | ||
|
||
== API | ||
|
||
Customers and developers can now manage effective date using API calls. | ||
|
||
|
||
= Effective date use case scenarios | ||
|
||
== Apply for loan | ||
|
||
* Tenant date | ||
* Effective date | ||
* Submitted on date | ||
* Outcome: SUCESS/FAILURE | ||
* Message | ||
* Reason | ||
* Loan application details | ||
|
||
|
||
== Repayment for a loan | ||
|
||
* Tenant date | ||
* Effective date | ||
* Transaction date | ||
* Outcome: SUCCESS/FAILURE | ||
* Loan transaction details | ||
* Submitted on date | ||
* Transaction date | ||
* Created on date | ||
|
||
= Effective date code examples | ||
|
||
== Increase Effective date by 1 day | ||
|
||
``` | ||
``` | ||
|
||
== API: | ||
|
||
Fetch effective date using: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. is there any api endpoint for effective date? @mdallos. |
||
|
||
`GET /fineract-provider/api/v1/businessdates/BUSINESS` | ||
|
||
|
||
```json | ||
|
||
Response | ||
{ | ||
"type": "BUSINESS", | ||
"date": [2022, 5, 13] | ||
} | ||
``` | ||
|
||
= Effective date specifics | ||
|
||
== Effective date type name | ||
|
||
* Type | ||
* Locale | ||
* DateFormat | ||
* DateValue | ||
|
||
== Effective date configuration domain service | ||
|
||
* isBusinessDateEnabled() | ||
|
||
== Effective date errors and exceptions | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
https://fineract.apache.org/docs/current/#_introducing_business_date_into_fineract_community_version
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
cc @edcable.