API Conta Azul

Overview

This node integrates with the Conta Azul API, enabling users to perform various operations related to services, sales, people, cost centers, categories, financial accounts, products, revenues, expenses, installments, and creation of products, people, and sales. Specifically, the "Buscar serviço por filtro" (Search service by filter) operation allows users to search for services using textual filters such as name, code, or description, with pagination support.

Common scenarios where this node is beneficial include:

• Retrieving a filtered list of services from Conta Azul based on partial text matches.
• Paginating through large sets of services to process or analyze them in batches.
• Automating workflows that require fetching service data dynamically from Conta Azul.

Practical example:

• A user wants to find all services containing the word "consulting" in their name or description and process them in pages of 10 items each. They can configure this node with the textual search term "consulting", set the page number, and page size accordingly.

Properties

Output

The node outputs JSON data representing the list of services matching the provided textual filter and pagination parameters. The structure typically includes an array of service objects with details such as service ID, name, code, description, and other relevant metadata as returned by the Conta Azul API.

No binary data output is indicated for this operation.

Dependencies

• Requires an API key credential for Conta Azul OAuth2 authentication configured in n8n.
• Depends on the external Conta Azul API service being accessible and the credentials having appropriate permissions.
• No additional environment variables are explicitly required beyond the API credential.

Troubleshooting

• Common issues:

  • Invalid or expired API credentials may cause authentication failures.
  • Providing invalid page numbers or sizes might result in empty responses or errors.
  • Network connectivity issues can prevent successful API calls.

• Error messages:

  • "Operação não suportada": This error indicates that the selected operation is not implemented or recognized by the node. Ensure the operation parameter is correctly set to "getAllServices" for this use case.
  • Authentication errors usually indicate problems with the API key or OAuth token; re-authenticate or verify credentials.
  • Pagination parameters out of range may cause the API to return no results; adjust page and size values accordingly.

Links and References

• Conta Azul API Documentation
• n8n OAuth2 Credential Setup Guide