Mindz icon

Mindz

Interact with Mindz API
Join our community

Actions115

Overview

The MindzPay Invoice node's Update operation allows users to modify existing invoices within the MindzPay system. This includes updating invoice details such as status, amount, associated client or payment IDs, and attaching updated invoice files in binary format.

This node is beneficial in scenarios where invoice information changes after creation, for example:

  • Correcting invoice amounts or client details.
  • Updating the invoice status to reflect its current state (e.g., from pending to issued).
  • Associating payments or reissuing invoices with new data.
  • Uploading a revised invoice file.

Practical examples:

  • A business automates invoice management by updating invoice statuses based on payment confirmations.
  • An accounting workflow updates invoice amounts or client info when corrections are needed.
  • Automatically attaching updated invoice PDFs received from an external system.

Properties

Name Meaning
Account Key The key of the MindzPay account used to authenticate and identify the account for the update.
Input Binary Field The name of the input property containing the invoice file in binary form. Only one file allowed.
Invoice ID The unique identifier of the invoice to be updated.
NFe ID The NFe (electronic invoice) ID associated with the invoice.
Status The status of the invoice. Options include: Não Alterar (Do not change), Pendente (Pending), Em processo de emissão (In issuance process), Emitida (Issued), Falha ao emitir (Failed to issue), Em processo de cancelamento (In cancellation process), Cancelada (Cancelled), Falha ao cancelar (Failed to cancel), Não emitir (Do not issue), Enviado por email (Sent by email), Não emitida (Not issued).
Payment ID The ID of the payment linked to this invoice.
Client ID The ID of the client associated with the invoice.
Amount The monetary amount of the invoice, supporting two decimal places.

Output

The node outputs JSON data representing the updated invoice object as returned by the MindzPay API. This typically includes fields reflecting the invoice's current state after the update, such as updated status, amounts, IDs, timestamps, and any other relevant metadata.

If a binary invoice file is provided via the "Input Binary Field" property, the node processes this file accordingly, but the output primarily focuses on JSON data describing the invoice.

Dependencies

  • Requires an active connection to the MindzPay API using an API authentication token or OAuth2 credential configured in n8n.
  • The "Account Key" must be valid and authorized to perform invoice updates.
  • If uploading invoice files, the input data must contain the binary file under the specified property name.

Troubleshooting

  • Invalid Account Key or Authentication Failure: Ensure the provided account key is correct and that the API credentials are properly configured in n8n.
  • Invoice ID Not Found: Verify that the invoice ID exists in the MindzPay system before attempting an update.
  • Invalid Status Value: Use only the predefined status options; invalid values may cause errors.
  • Binary File Issues: If specifying a binary field, ensure the input contains exactly one valid file under the given property name.
  • API Rate Limits or Network Errors: Check network connectivity and MindzPay API limits if requests fail intermittently.

Links and References

  • MindzPay official API documentation (for detailed invoice update endpoints and parameters)
  • n8n documentation on handling binary data in nodes
  • General best practices for managing electronic invoices (NFe) in Brazil

Discussion