Mindz icon

Mindz

Interact with Mindz API
Join our community

Actions116

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 skipping a number of results and limiting the output size.
  • Sort invoices by amount or status in ascending or descending order.

Properties

Name Meaning
Account Key The key of the MindzPay account used to authenticate and identify which account's invoices to list.
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 A search term to filter invoices based on matching criteria (e.g., invoice details).

Output

The node outputs a JSON array of invoice objects under the json field. Each object represents an individual invoice with its associated data fields such as invoice ID, creation date, amount, status, and other relevant invoice details.

If binary data is present (not indicated explicitly here), it would typically represent attachments or PDF copies of invoices, but this node primarily focuses on JSON invoice data.

Dependencies

  • Requires an API authentication token credential to connect securely to the MindzPay API.
  • The node depends on the MindzPay service being accessible and the provided account key being valid.
  • No additional external dependencies are indicated beyond the MindzPay API and n8n's OAuth2 credential setup.

Troubleshooting

  • Invalid Account Key: If the account key is incorrect or missing, the API will likely return an authentication error. Verify that the account key is correct and properly configured.
  • API Rate Limits: Excessive requests may trigger rate limiting. Use the limit and offset properties wisely to paginate through results.
  • Empty Results: If no invoices match the search term or filters, the output will be empty. Adjust search parameters or verify invoice existence.
  • Sorting Issues: Ensure the sortBy and sortDirection values are valid; otherwise, the API may ignore sorting or return errors.
  • Network Errors: Connectivity issues with the MindzPay API can cause failures. Check network access and API endpoint availability.

Links and References

Discussion