Mindz icon

Mindz

Interact with Mindz API
Join our community

Actions116

Overview

The MindzPay Invoice node's Create operation allows users to create a new invoice record within the MindzPay system. This node is useful for automating invoice generation tied to payments and clients in the MindzPay platform, streamlining financial workflows such as billing, accounting, and payment tracking.

Typical use cases include:

  • Automatically generating invoices when a payment is registered.
  • Creating invoices linked to specific clients and payments.
  • Managing invoice statuses programmatically during order processing or subscription management.

For example, after receiving a payment confirmation, this node can be used to create an official invoice with the correct amount, client details, and payment reference, optionally attaching the invoice file in binary form.

Properties

Name Meaning
Account Key The key of the MindzPay account used to authenticate and identify the account context.
Input Binary Field The name of the input property containing the invoice file in binary format (only one file allowed).
NFe ID The unique identifier for the electronic invoice (NFe) within MindzPay.
Status The status of the invoice. Possible values:
- 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 associated with this invoice.
Client ID The ID of the client to whom the invoice belongs.
Amount The monetary amount of the invoice, with two decimal places precision.

Output

The node outputs JSON data representing the created invoice object as returned by the MindzPay API. This typically includes fields such as invoice identifiers, status, amounts, client and payment references, timestamps, and possibly URLs or metadata related to the invoice.

If the invoice file was provided as binary input, the node may also handle or pass through binary data representing the invoice document (e.g., PDF or XML), but the main output focus is on the JSON representation of the created invoice.

Dependencies

  • Requires an API authentication token credential configured in n8n to connect securely to the MindzPay API.
  • The node depends on the MindzPay service being accessible and the account key being valid.
  • If using the binary invoice file input, the incoming data must contain the specified binary property with a valid invoice file.

Troubleshooting

  • Missing required properties: Ensure that Account Key, Payment ID, Client ID, and Amount are provided; these are mandatory for creating an invoice.
  • Invalid status value: Use only the predefined status options; invalid values may cause API errors.
  • Binary field issues: If specifying a binary field, confirm that the input contains exactly one file under the given property name.
  • Authentication errors: Verify that the API credentials are correctly set up and have sufficient permissions.
  • API connectivity problems: Check network access to MindzPay endpoints and validate the account key.
  • Error messages from API: Typically indicate missing or malformed data; review the error details and adjust input accordingly.

Links and References

  • MindzPay official API documentation (for detailed invoice creation parameters and status codes)
  • n8n documentation on handling binary data in nodes
  • General best practices for managing invoices and payments in automated workflows

Discussion