API Conta Azul

Permite fazer requisições à API da Conta Azul

Actions16

Overview

This node integrates with the Conta Azul API to create a new sales record ("venda") in the system. It is designed for automating the process of registering sales transactions, including customer details, payment conditions, installments, payment methods, sale status, and items sold.

Typical use cases include:

  • Automating sales entry from e-commerce platforms or POS systems.
  • Synchronizing sales data between Conta Azul and other business tools.
  • Managing complex payment terms with multiple installments.
  • Tracking sales status and payment observations programmatically.

For example, a business can use this node to create a sale with multiple payment installments, specify the payment method as "PIX Pagamento Instantâneo", and add detailed items with quantities and prices, all within an automated workflow.

Properties

Name Meaning
ID do Cliente UUID of the client associated with the sale.
Número da Venda Sale number (numeric identifier).
Data da Venda Date and time of the sale in ISO 8601 format (e.g., YYYY-MM-DDTHH:mm:ssZ).
Opção da Condição de Pagamento Payment condition option, e.g., "À vista", "3x", "30,60,90", etc.
Parcelas Collection of payment installments. Each installment includes: due date (Data de Vencimento), amount (Valor), and optional description (Descrição). Multiple installments can be added.
Forma de Pagamento Payment method. Options include: Boleto Bancário, Cartão de Crédito, Cartão de Débito, Carteira Digital, Cashback, Cheque, Crédito Loja, Crédito Virtual, Depósito Bancário, Dinheiro, Outro, Débito Automático, Cartão Crédito via Link, PIX Pagamento Instantâneo, PIX Cobrança, Programa Fidelidade, Sem Pagamento, Transferência Bancária, Vale Alimentação, Vale Combustível, Vale Presente, Vale Refeição. Default is "Dinheiro".
Situação Sale status. Options are: Em andamento (In progress), Aprovado (Approved), Faturado (Invoiced). Default is "Em andamento".
Observações Optional notes about the sale.
Observações do Pagamento Optional notes about the payment.
Itens Collection of sale items. Each item includes: product/service ID (ID do Produto/Serviço), description, quantity, and value. Multiple items can be added.

Output

The node outputs JSON data representing the result of the sale creation request to the Conta Azul API. This typically includes:

  • Confirmation of the created sale with its unique identifiers.
  • Details of the sale such as customer info, sale number, date, payment conditions, installments, payment method, status, observations, and items.
  • Any error messages or validation feedback if the creation failed.

No binary data output is produced by this operation.

Dependencies

  • Requires an active Conta Azul API OAuth2 credential configured in n8n for authentication.
  • The node depends on the Conta Azul API being accessible and the provided credentials having permissions to create sales.
  • Network connectivity to the Conta Azul API endpoint is necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing required fields such as client ID, sale number, or items may cause the API to reject the request.
    • Incorrect date formats for sale date or installment due dates can lead to errors.
    • Using unsupported payment methods or statuses not recognized by the API.
    • Network or authentication failures due to expired or misconfigured API credentials.

  • Error messages:

    • "Operação não suportada": Indicates that the selected operation is not implemented; ensure "Criar venda" is chosen.
    • API validation errors will typically return descriptive messages indicating which field is invalid or missing.

  • Resolution tips:

    • Double-check all required properties are filled correctly.
    • Ensure date/time values follow the ISO 8601 format.
    • Verify the API credentials are valid and have appropriate scopes.
    • Review the API response message for specific validation errors.

Links and References

Discussion