Actions115
- Course Actions
- Bundle Actions
- Course Grade Actions
- Course Grade Detail Actions
- Course Teacher Actions
- Email Actions
- Email Campaign Actions
- Email Campaign Course Actions
- Email Campaign Excluded Course Actions
- Email Campaign Excluded List Actions
- Enroll Actions
- Email Campaign Excluded Plan Actions
- Email Campaign List Actions
- Email Campaign Plan Actions
- Email List Actions
- MindzPay Account Actions
- MindzPay Invoice Actions
- MindzPay Payment Actions
- MindzPay Subscription Actions
- Subscription Actions
- Team Actions
- User Actions
Overview
The MindzPay Invoice node's List operation allows users to retrieve a paginated list of invoices from the MindzPay system. This is useful for scenarios where you want to display, analyze, or process multiple invoices programmatically, such as generating reports, syncing invoice data with other systems, or monitoring payment statuses.
For example, you might use this node to:
- Fetch the latest 50 invoices sorted by creation date.
- Search invoices by specific terms (e.g., customer name or invoice ID).
- Implement pagination by specifying how many invoices to skip and limit per request.
Properties
| Name | Meaning |
|---|---|
| Account Key | The key identifying the MindzPay account to query invoices from. |
| Limit | Maximum number of invoice results to return (minimum 1). |
| Offset | Number of invoice results to skip (useful for pagination). |
| Sort By | Field to sort the invoice results by. Options: ID, Created At, Amount, Status. |
| Sort Direction | Direction to sort the results. Options: Ascending, Descending. |
| Search | Search term to filter invoices by matching relevant fields. |
Output
The node outputs a JSON array of invoice objects under the json field. Each object represents an invoice with its associated details such as ID, creation date, amount, status, and other relevant metadata provided by the MindzPay API.
If the node supports binary data output (not explicitly shown in the source), it would typically represent attachments or invoice PDFs, but based on the provided code and properties, the output focuses on JSON invoice data.
Dependencies
- Requires an active connection to the Mindz API using an OAuth2-based API key credential.
- The node depends on the MindzPay API service being accessible and properly authenticated.
- No additional environment variables are indicated beyond the required API authentication.
Troubleshooting
Common Issues:
- Invalid or missing Account Key will cause authentication or authorization failures.
- Exceeding API rate limits may result in errors or delayed responses.
- Providing invalid values for
limit,offset, or sorting options may cause the API to reject the request.
Error Messages:
- Authentication errors usually indicate issues with the API key or OAuth token; verify credentials.
- Validation errors may occur if
limitis less than 1 or if unsupported sort fields/directions are used. - Network or timeout errors suggest connectivity problems with the Mindz API endpoint.
To resolve these, ensure correct credentials, validate input parameters, and check network connectivity.
Links and References
- Mindz API Documentation (hypothetical link as no direct URL provided)
- OAuth2 Authentication setup in n8n documentation: https://docs.n8n.io/credentials/oauth2/
- Pagination and filtering best practices in REST APIs: https://restfulapi.net/pagination-in-rest-api/
Note: The summary is based solely on static analysis of the provided bundled source and property definitions without runtime execution.