Actions13
- Category Actions
- Payment Bank Actions
- Bill Actions
- Payment Status Actions
- Webhook Actions
Overview
This node integrates with the Bizappay API to manage bills and related resources. Specifically, the Bill - Search operation allows users to search for bills using various filters such as status, category, amount range, date range, payer email, and free-text search within bill name, description, or reference.
Common scenarios where this node is beneficial include:
- Retrieving a filtered list of bills for reporting or reconciliation.
- Searching for specific bills based on customer email or keywords.
- Filtering bills by payment status or creation date to monitor outstanding payments.
For example, a business could use this node to find all overdue bills in a certain category created within the last month, or to search for bills associated with a particular customer's email address.
Properties
| Name | Meaning |
|---|---|
| Search Filters | Collection of filters to apply when searching bills. Includes: |
| - Status: Filter by bill status. Options: Pending, Paid, Overdue, Cancelled | |
| - Category: Filter by category code (string) | |
| - Amount Range: Minimum and maximum amount to filter by (numbers with 2 decimal precision) | |
| - Date Range: Start and end creation dates to filter by (date-time) | |
| - Payer Email: Filter by payer's email address (string, case-insensitive substring match) | |
| - Search Text: Search text to look for in bill name, description, or external reference |
Output
The output JSON contains a summary of the search results and the filtered list of bills:
status: Indicates success, typically"ok".data: An array of bill objects matching the filters. Each bill object includes fields like name, description, amount, status, payer email, etc.total: The total number of bills found.filters_applied: List of filter keys that were applied in the search.search_summary: Contains metadata about the search:total_found: Number of bills found.filters_count: Number of filters applied.search_timestamp: ISO timestamp when the search was performed.
No binary data output is produced by this operation.
Dependencies
- Requires an active connection to the Bizappay API via an API key credential configured in n8n.
- Uses the internal helper function to make authenticated POST requests to Bizappay endpoints.
- No additional external dependencies beyond standard Node.js crypto module (used elsewhere in the node).
Troubleshooting
- Empty Results: If no bills are returned, verify that the filters are correctly set and that bills exist matching those criteria.
- Invalid Filter Values: Ensure that filter values conform to expected types and formats (e.g., valid dates, numeric ranges).
- API Errors: Network issues or invalid credentials can cause request failures. Check API key validity and network connectivity.
- Case Sensitivity: Payer email and search text filters perform case-insensitive substring matches; ensure input matches expected content.
- Unexpected Response Structure: If the API response structure changes, the node may fail to parse results properly.
Links and References
- Bizappay API Documentation (hypothetical link)
- n8n Expressions Documentation
- Node.js Crypto Module (used internally for webhook signature verification)
This summary focuses exclusively on the "Bill" resource with the "Search" operation as requested.