API Conta Azul

Permite fazer requisições à API da Conta Azul

Actions16

Overview

This node integrates with the Conta Azul API, a financial and business management platform. It allows users to perform various operations such as searching for services, sales, people, cost centers, categories, financial accounts, products, revenues, expenses, installments, and also creating products, people, and sales.

Specifically, the "Buscar venda por ID" (Search sale by ID) operation retrieves detailed information about a specific sale using its unique identifier (UUID). This is useful in scenarios where you need to fetch exact sale details for reporting, auditing, or further processing within an automated workflow.

Practical example:
You have an order processing workflow that triggers when a new sale is created in Conta Azul. Using this node with the "Buscar venda por ID" operation, you can retrieve all details of that sale by its ID to update your CRM system or generate invoices automatically.

Properties

Name Meaning
ID da Venda The unique identifier (UUID) of the sale to retrieve. This property is required for the "Buscar venda por ID" operation.

Output

The node outputs JSON data representing the sale details fetched from the Conta Azul API. The structure typically includes all relevant information about the sale such as customer info, items sold, payment conditions, status, dates, and any observations related to the sale.

If the node supports binary data output (not indicated here), it would be used for files or attachments related to the sale, but this operation primarily returns structured JSON data.

Dependencies

  • Requires an active Conta Azul API OAuth2 credential configured in n8n to authenticate requests.
  • Internet access to reach the Conta Azul API endpoints.

Troubleshooting

  • Common issues:

    • Invalid or missing sale ID: Ensure the provided UUID is correct and corresponds to an existing sale.
    • Authentication errors: Verify that the OAuth2 credentials are correctly set up and have not expired.
    • Network or API downtime: Check connectivity and Conta Azul service status.

  • Error messages:

    • "Operação não suportada" ("Operation not supported"): This error occurs if an unsupported operation value is passed. Confirm that the operation parameter is exactly "getSaleById" for this use case.
    • API errors returned from Conta Azul will usually include HTTP status codes and messages; these should be reviewed to adjust input parameters or credentials accordingly.

Links and References

Discussion