Marvee icon

Marvee

Get data from Marvee API

Actions2

Extrato → Consultar

AI-generated

Overview

The node integrates with the Marvee API to retrieve financial statement data filtered by various criteria. Specifically, the "Extrato" (Statement) resource with the "Consultar" (Get Statement) operation allows users to query transaction statements within a specified date range and apply filters such as account, category, and status. This is useful for financial analysis, reconciliation, or reporting tasks where users need detailed transaction data from their accounts.

Practical examples include:

  • Fetching all transactions between two dates for specific bank accounts.
  • Filtering statements by categories like "Utilities" or "Sales".
  • Retrieving only reconciled or pending transactions for audit purposes.
  • Paginating through large sets of statement records.

Properties

Name Meaning
Data Início * Start date to filter the statement data (required). Specifies the beginning of the date range for the query.
Data Fim * End date to filter the statement data (required). Specifies the end of the date range for the query.
Filtrar Por Conta Filter the statement by one or more accounts. Users can select from a list of available accounts or specify account IDs using expressions.
Filtrar Por Categoria Filter the statement by one or more categories. Multiple categories can be selected from a list or specified via expressions.
Filtrar Por Status Filter transactions by their status. Multiple statuses can be selected from: Atrasado (Overdue), Conciliado (Reconciled), Pendente (Pending), Quitado (Paid), Vence Hoje (Due Today).
Página Page number for pagination, starting at 1. Controls which page of results to retrieve.
Tamanho Da Página Number of records per page, with a minimum of 1 and maximum of 1000. Defaults to 20. Controls the size of each page in paginated results.

Output

The node outputs an array of JSON objects representing the filtered statement transactions retrieved from the Marvee API. Each object corresponds to a single transaction record containing details such as date, amount, account, category, status, and other relevant financial information.

If the API supports binary data related to statements (e.g., PDF reports), it would be included in the binary output field; however, based on the provided code and properties, the primary output is structured JSON data representing statement entries.

Dependencies

  • Requires connection to the Marvee API via an API key credential configured in n8n.
  • The node depends on several helper modules internally to load options dynamically for accounts, categories, and customers.
  • Pagination parameters are supported to handle large datasets efficiently.
  • No additional external services beyond the Marvee API are required.

Troubleshooting

  • Common Issues:

    • Missing or invalid API credentials will cause authentication failures.
    • Providing invalid date ranges (e.g., start date after end date) may result in errors or empty results.
    • Selecting unsupported or non-existent account/category IDs may yield no data.
    • Exceeding the maximum page size (over 1000) will likely cause validation errors.

  • Error Messages:

    • "Operação não suportada para Statement: <operation>" indicates an unsupported operation was requested for the Statement resource.
    • "Recurso não suportado: <resource>" means the specified resource is not implemented in the node.
    • General execution errors are wrapped with "Erro na execução do nó Marvee: <message>", providing context about failures during API calls or processing.

  • Resolutions:

    • Verify API credentials and permissions.
    • Ensure date inputs are valid and logical.
    • Use the dynamic dropdowns or correct expressions to specify accounts and categories.
    • Respect pagination limits and defaults.

Links and References

Discussion