Actions39
- Client Actions
- Loan Actions
Overview
This node integrates with the Fineract API to list client records based on various filtering and pagination options. It is useful for retrieving client data from a Fineract-based financial system, enabling workflows that require client information such as CRM updates, reporting, or further loan processing.
Typical use cases include:
- Fetching all clients or a subset filtered by attributes like name, office, or hierarchy.
- Paginating through large client datasets efficiently.
- Filtering clients by custom SQL queries for advanced search scenarios.
- Sorting and selecting specific fields to optimize data retrieval.
Properties
| Name | Meaning |
|---|---|
| Return All | Whether to return all matching clients or limit results to a specified number (may increase requests). |
| Limit | Maximum number of client records to return when not returning all (1 to 200). |
| Offset | Number of client records to skip before starting to collect the result set. |
| Display Name | Filter clients by partial match on their display name. |
| Office ID | Filter clients belonging to a specific office by its ID. |
| Under Hierarchy | Filter clients under a specific office hierarchy path. |
| External ID | Filter clients by an external identifier. |
| First Name | Filter clients by first name. |
| Last Name | Filter clients by last name. |
| Orphans Only | Show only clients without any group associations (orphans). |
| SQL Search | Custom SQL query string for advanced filtering of clients. |
| Order By | Field to order the results by: Display Name, Account No, Office ID, or Office Name. |
| Sort Order | Sort direction for results: Ascending or Descending. |
| Fields | Comma-separated list of client fields to include in the response (e.g., ID, displayName, status). |
Output
The node outputs JSON data representing the list of clients retrieved from the Fineract API. Each item in the output array corresponds to a client record containing fields as requested or defaulted by the Fields property.
If binary data were involved, it would be summarized here, but this operation deals solely with JSON client data.
Dependencies
- Requires connection to a Fineract API instance.
- Needs an API authentication credential configured in n8n with base URL and tenant ID.
- The node sends HTTP requests to the
/fineract-provider/api/v1endpoint with appropriate headers.
Troubleshooting
- Timeouts or slow responses: Enabling "Return All" can cause many requests if the dataset is large; consider using limits and offsets to paginate.
- Empty results: Check filter values for correctness; partial matches are case-sensitive depending on backend.
- Authentication errors: Ensure API credentials (base URL, tenant ID, and API key) are correctly configured.
- Invalid field names in
Fields: Use valid field names supported by the Fineract API to avoid errors or empty fields. - SQL Search syntax errors: When using custom SQL queries, ensure the syntax matches what the Fineract API expects.
Links and References
- Fineract API Documentation
- n8n Documentation on HTTP Request Nodes (for understanding request handling)
- Fineract Client Management Guide