API Conta Azul

Permite fazer requisições à API da Conta Azul

Overview

This node integrates with the Conta Azul API, a financial and sales management platform. Specifically, the "Buscar venda por filtro" (Search sale by filter) operation allows users to query sales records based on textual search criteria such as customer name, sale number, or customer email. It supports pagination to manage large result sets.

Typical use cases include:

  • Retrieving filtered sales data for reporting or analytics.
  • Automating workflows that require fetching specific sales information based on customer details or sale identifiers.
  • Integrating sales data into other systems or dashboards.

For example, a user might want to find all sales related to a particular customer email or sales number and process them further in an automation workflow.

Properties

Name Meaning
Busca textual (venda) Textual search by customer name, sale number, or customer email to filter sales records.
Página (venda) Page number of the results to retrieve (for pagination).
Tamanho da página (venda) Number of items per page to return (controls page size).

Output

The node outputs JSON data containing the list of sales matching the filter criteria. The structure typically includes sales details such as sale ID, customer information, sale date, status, payment details, and itemized products or services sold.

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 credentials having appropriate permissions to read sales data.

Troubleshooting

  • Common issues:

    • Invalid or expired API credentials will cause authentication failures.
    • Incorrect or empty filter parameters may return no results.
    • Pagination parameters out of range could lead to empty responses or errors.
  • Error messages:

    • "Operação não suportada" ("Operation not supported"): This error occurs if an unsupported operation value is provided; ensure the operation is set to "Buscar venda por filtro".
    • API errors related to authentication or rate limits should be resolved by verifying credentials and API usage policies.

Links and References

Discussion