API Conta Azul

Permite fazer requisições à API da Conta Azul

Overview

This node integrates with the Conta Azul API to perform various operations related to business management, such as retrieving services, sales, people, cost centers, categories, financial accounts, products, revenues, expenses, installments, and creating new products, people, or sales.

Specifically, the "Buscar produtos por filtro" (Search products by filter) operation allows users to search for products using filters like product name or code, status, sorting options, and pagination. This is useful for scenarios where you want to retrieve a list of products matching certain criteria from your Conta Azul account, for example:

  • Fetching active products containing a specific keyword in their name.
  • Retrieving all products sorted by stock quantity in descending order.
  • Paginating through large product catalogs efficiently.

Properties

Name Meaning
Busca (produto) Search term to find products by name or code.
Status Filter products by status: "Ativo" (Active), "Inativo" (Inactive), or "Todos" (All).
Campo de ordenação Field to sort results by: "Nome" (Name), "Código" (Code), "Valor de Venda" (Sale Price), or "Estoque" (Stock).
Direção da ordenação Sort direction: "Ascendente" (Ascending) or "Descendente" (Descending).
Página (produto) Page number of the results to retrieve (for pagination).
Tamanho da página (produto) Number of items per page (page size).

Output

The node outputs JSON data containing the list of products that match the specified filters. The structure typically includes product details such as name, code, status, sale price, stock quantity, and other relevant attributes provided 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 Conta Azul API service being accessible and the user having appropriate permissions to query product data.

Troubleshooting

  • Common issues:

    • Invalid or expired API credentials will cause authentication failures.
    • Incorrect filter values or unsupported combinations may result in empty responses or errors.
    • Pagination parameters out of range might return no results.
  • Error messages:

    • "Operação não suportada" (Operation not supported): This error occurs if an unsupported operation value is set; ensure the operation is exactly "getProductsByFilter".
    • API errors related to authentication or rate limits should be resolved by checking API keys and usage quotas.

Links and References

Discussion