Actions39
- Client Actions
- Loan Actions
Overview
The node interacts with the Fineract API to list loan records based on various filtering and sorting criteria. It is useful for retrieving loan data from a Fineract system, such as fetching all loans under a specific office or hierarchy, filtering by loan status, or searching by account number or external ID.
Common scenarios include:
- Generating reports of active loans in a particular office.
- Fetching loans that match specific SQL-like search criteria.
- Retrieving paginated lists of loans for further processing or integration.
- Sorting loans by account number or display name for display purposes.
Example: A user wants to get all active loans under a certain office hierarchy, sorted by account number ascending, limited to 100 results.
Properties
| Name | Meaning |
|---|---|
| Return All | Whether to return all matching loan results or only up to a specified limit. Returning all may increase requests and cause timeouts. |
| Limit | Maximum number of loan results to return (1 to 200). Only used if "Return All" is false. |
| Offset | Starting index from which to return loan results. Used for pagination when "Return All" is false. |
| Order By | Field to order the loan results by. Options: Display Name, Account No, Office ID, Office Name. |
| Sort Order | Direction to sort results if "Order By" is used. Options: Ascending, Descending. |
| Office ID | Restrict loans returned to those associated with a specific office ID. |
| Under Hierarchy | Use an office hierarchy string to return all loans under that hierarchy. |
| Account No | Filter loans by their account number. |
| External ID | Filter loans by their external ID. |
| SQL Search | SQL fragment valid for the underlying loan schema to filter results, e.g., display_name like %K%. |
| Loan Status | Filter loans by status. Options: Active, All, Approved, Closed (Obligations Met), Closed (Rescheduled), Closed (Written Off), Submitted and Pending Approval. |
| Fields | Comma-separated list of fields to include in the response, e.g., ID,accountNo,status. |
Output
The node outputs JSON data representing the list of loans retrieved from the Fineract API. Each item in the output corresponds to a loan record containing fields as requested or default fields provided by the API.
If binary data were involved (not indicated here), it would typically represent files or attachments related to loans, but this node focuses on JSON loan data.
Dependencies
- Requires connection to a Fineract API instance.
- Needs credentials including base URL and tenant ID for authentication.
- The node uses standard HTTP headers for content type and tenant identification.
- Pagination support is built-in for handling large result sets.
Troubleshooting
- Timeouts when returning all results: Selecting "Return All" can cause many requests and potential timeouts. Use limits and offsets to paginate results instead.
- Invalid SQL Search syntax: The
sqlSearchproperty expects valid SQL fragments for the loan schema; invalid syntax will cause API errors. - Incorrect office hierarchy string: Providing an invalid hierarchy string may result in no results or errors.
- Filtering by non-existent fields: Using unknown field names in
fieldsor filters may cause empty responses or errors. - Authentication errors: Ensure the API credentials are correct and have sufficient permissions.