Get Sanctioned Loan Amount API
Get Sanctioned Loan Amount API in Frappe Lending allows users to retrieve the sanctioned loan limit assigned to a specific applicant or customer. This API can be used by external systems to check the approved borrowing limit before creating or processing loan applications.
The API returns the sanctioned amount limit associated with the selected customer or applicant.
Did You Know?
Sanctioned Loan Amount helps lenders control borrower exposure by defining the maximum approved lending limit for an applicant.
API Endpoint
GET /api/resource/Sanctioned Loan AmountRequest
The API uses filters to retrieve the sanctioned amount limit for a specific applicant.
?filters=[["applicant", "=", "Sanctioned Amount Customer - 11"]]&fields=["sanctioned_amount_limit"]Request Parameters
| Parameter | Description |
|---|---|
| Applicant | Specifies the customer or borrower whose sanctioned loan limit needs to be retrieved. |
| Fields | Defines the fields to return in the response. In this case, only the sanctioned amount limit is retrieved. |
Response
The API returns the sanctioned loan limit available for the selected applicant.
{
"data": [
{
"sanctioned_amount_limit": 3000000.0
}
]
}Response Field
| Field | Description |
|---|---|
| Sanctioned Amount Limit | Displays the maximum loan amount approved for the applicant. |
How It Works
The API retrieves sanctioned loan information using the applicant filter.
| Step | Description |
|---|---|
| 1. Provide Applicant Filter | The request identifies the customer whose sanctioned limit is required. |
| 2. Fetch Sanctioned Record | The system searches for the matching Sanctioned Loan Amount record. |
| 3. Return Limit | The API returns the sanctioned amount limit value. |
Use Cases
The Get Sanctioned Loan Amount API can be used for:
- Checking borrower eligibility before loan creation.
- Validating loan applications against approved limits.
- Displaying sanctioned limits in external loan portals.
- Integrating lending workflows with third-party applications.
Note
The API returns the sanctioned limit configured for the applicant. Additional loan validation rules may apply during actual loan processing.
Best Practices
- Ensure the applicant name matches the configured borrower record.
- Retrieve the sanctioned limit before creating new loan applications.
- Maintain updated sanctioned amount records for accurate exposure checks.
- Use field filters to return only required information.
