Get Loan Due Details API
Get Loan Due Details API in Frappe Lending provides the outstanding dues and repayment details for a specific loan as of a selected date. It helps external systems retrieve overdue amounts, outstanding balances, applicable future amounts, and other loan-related financial details.
This API can be used for borrower communication, collection workflows, loan servicing applications, and repayment tracking systems.
Did You Know?
The API provides a complete view of loan dues, including overdue principal, interest, penalties, charges, and outstanding balances for a selected date.
API Endpoint
GET /api/method/lending.api.get_due_detailsRequest Parameters
The API requires the loan account and the date for which dues need to be calculated.
{
"loan": "ACC-LOAN-2026-00116",
"as_on_date": "2026-03-01"
}Request Parameters Description
| Parameter | Description |
|---|---|
| Loan | Specifies the loan account for which due details need to be retrieved. |
| As On Date | Defines the date on which outstanding dues are calculated. |
Response
The API returns detailed loan due information including overdue amounts, outstanding principal, future applicable amounts, and payment adjustments.
{
"message": {
"overdue_penalty_amount": 0.0,
"overdue_interest_amount": 6684.69,
"overdue_principal_amount": 100000.0,
"principal_outstanding": 100000.0,
"overdue_total_amount": 111684.69,
"applicable_future_interest": 161.33,
"unbooked_interest": 0.0,
"applicable_future_penalty": 0,
"oldest_due_date": "2024-12-15 00:00:00",
"overdue_charges": 5000.0,
"available_security_deposit": 0,
"written_off_amount": 0.0,
"excess_amount_paid": 0.0
}
}Response Fields
| Field | Description |
|---|---|
| Overdue Penalty Amount | Shows the total penalty amount overdue against the loan. |
| Overdue Interest Amount | Displays the interest amount pending for payment. |
| Overdue Principal Amount | Shows the principal amount overdue as of the selected date. |
| Principal Outstanding | Displays the remaining unpaid principal balance of the loan. |
| Overdue Total Amount | Shows the combined overdue amount including principal, interest, penalties, and applicable charges. |
| Applicable Future Interest | Displays future interest applicable on the loan as of the selected date. |
| Unbooked Interest | Shows interest calculated but not yet booked in the system. |
| Applicable Future Penalty | Displays any future penalty amount applicable to the loan. |
| Oldest Due Date | Shows the earliest pending due date for the loan. |
| Overdue Charges | Displays additional charges pending against the loan. |
| Available Security Deposit | Shows any available security deposit amount linked to the loan. |
| Written Off Amount | Displays the amount already written off for the loan. |
| Excess Amount Paid | Shows any excess payment received against the loan. |
How It Works
The API calculates loan dues based on the selected loan and date.
| Step | Description |
|---|---|
| 1. Select Loan | The system identifies the loan account provided in the request. |
| 2. Apply Date Filter | Dues are calculated based on the provided as-on date. |
| 3. Calculate Outstanding | The system evaluates principal, interest, penalties, charges, and adjustments. |
| 4. Return Due Details | The API returns a complete summary of payable and outstanding amounts. |
Use Cases
The Get Due Details API can be used for:
- Displaying outstanding dues in borrower portals.
- Supporting collection and recovery workflows.
- Generating repayment reminders.
- Calculating settlement or foreclosure amounts.
- Integrating loan information with external applications.
Note
The returned values represent loan dues calculated as of the requested date and may change as new repayments or loan events are processed.
Best Practices
- Provide the correct loan account identifier when requesting dues.
- Use an appropriate as-on date for accurate calculations.
- Refresh due details after repayment transactions.
- Use returned values carefully for borrower communication and settlement calculations.
