Mindz icon

Mindz

Interact with Mindz API
Join our community

Actions116

Overview

The MindzPay Invoice node's Refresh operation is designed to update or refresh the status and details of a specific invoice within the MindzPay system. This operation is useful when you want to ensure that your workflow has the most current information about an invoice, such as its payment status or any changes made externally after the invoice was initially created or retrieved.

Typical use cases include:

  • Automatically updating invoice records in your database or CRM after external changes.
  • Triggering follow-up actions based on the latest invoice status.
  • Synchronizing invoice data between MindzPay and other systems.

For example, after sending an invoice to a customer, you might periodically refresh the invoice to check if it has been paid or canceled, enabling automated notifications or accounting updates.

Properties

Name Meaning
Account Key The key identifying the MindzPay account associated with the invoice.
Invoice ID The unique identifier of the invoice to refresh (retrieve updated details for).

Output

The node outputs JSON data representing the refreshed invoice details. This typically includes updated fields such as invoice status, amounts, dates, and any other relevant metadata returned by the MindzPay API for the specified invoice.

If the node supports binary data output (not indicated here), it would generally represent attachments or documents related to the invoice, but this operation primarily deals with JSON invoice data.

Dependencies

  • Requires an active connection to the Mindz API via an OAuth2-based authentication credential configured in n8n.
  • The node depends on the MindzPay API being accessible and the provided Account Key and Invoice ID being valid.
  • No additional environment variables are explicitly required beyond the API credentials.

Troubleshooting

  • Invalid Account Key or Invoice ID: If these inputs are incorrect or missing, the API will likely return an error indicating the invoice cannot be found or accessed. Double-check the values.
  • Authentication Errors: Ensure the OAuth2 credential is correctly set up and has not expired.
  • API Connectivity Issues: Network problems or Mindz API downtime can cause failures; verify connectivity and service status.
  • Permission Denied: The account key used must have sufficient permissions to access and refresh the invoice.

Common error messages may include "Invoice not found," "Unauthorized," or "Invalid credentials." Resolving these usually involves verifying input parameters and credential configurations.

Links and References

Discussion