API Conta Azul

Permite fazer requisições à API da Conta Azul

Overview

This node integrates with the Conta Azul API to retrieve expense records filtered by specific criteria. It is designed to help users query expenses within a given due date range, optionally filtering by text search, and supports pagination for managing large result sets.

Common scenarios where this node is beneficial include:

  • Financial teams wanting to extract expense data for a specific period.
  • Automating reports on company expenses filtered by keywords or identifiers.
  • Integrating expense data into other workflows or dashboards for analysis.

For example, a user can fetch all expenses due between January 1st and January 31st, 2024, that contain a certain keyword in their description or number, retrieving results page by page.

Properties

Name Meaning
Busca (despesa) Textual search to filter expenses by name, number, or other identifying information.
Página (despesa) Page number of the results to retrieve (for pagination).
Tamanho da página (despesa) Number of expense items to return per page.
Data de vencimento (de) Start date of the due date range to filter expenses (format YYYY-MM-DD, required).
Data de vencimento (até) End date of the due date range to filter expenses (format YYYY-MM-DD, required).

Output

The node outputs JSON data containing the list of expenses matching the specified filters. The structure typically includes details such as expense identifiers, names, due dates, amounts, and other relevant metadata returned by the Conta Azul API.

No binary data output is indicated for this operation.

Dependencies

  • Requires an active Conta Azul API OAuth2 credential configured in n8n to authenticate requests.
  • Depends on the Conta Azul API service being available and accessible.
  • Pagination parameters must be managed properly to navigate through large datasets.

Troubleshooting

  • Missing or invalid API credentials: Ensure the OAuth2 credential for Conta Azul is correctly set up and authorized.
  • Invalid date formats: The due date fields require the format YYYY-MM-DD; incorrect formats may cause errors.
  • Empty results: If no expenses are returned, verify the date range and search terms are correct and that there are matching records.
  • Pagination issues: Requesting pages beyond the available range will likely return empty results; adjust the page number accordingly.
  • Unsupported operation error: This node only supports predefined operations; ensure "Buscar despesas por filtro" is selected.

Links and References

Discussion