Conta Azul API icon

Conta Azul API

Allows making requests to the Conta Azul API

Overview

The node integrates with the Conta Azul API to create a new sale record. It allows users to specify detailed information about the sale, including client identification, sale date, payment conditions, installments, payment method, status, observations, and the items involved in the sale. This node is beneficial for automating sales data entry into Conta Azul from other systems or workflows, ensuring accurate and consistent financial records.

Practical examples include:

  • Automatically recording sales made through an e-commerce platform.
  • Syncing offline sales data into Conta Azul for unified accounting.
  • Creating sales entries triggered by CRM events or invoicing systems.

Properties

Name Meaning
Client ID UUID of the client associated with the sale
Sale Number Numeric identifier for the sale
Sale Date Date and time when the sale occurred (format: YYYY-MM-DDTHH:mm:ssZ)
Payment Condition Option Description of payment terms (e.g., "À vista", "3x", "30,60,90")
Installments Multiple installment entries, each with due date, value, and optional description
Payment Method Method used for payment; options include Boleto Bancário, Cartão Crédito, Dinheiro, PIX, etc.
Status Current status of the sale; options are Em Andamento (In Progress), Aprovado (Approved), Faturado (Invoiced)
Observations General notes or comments about the sale
Payment Observations Notes specifically related to payment
Items List of sale items, each with product/service ID, description, quantity, and value

Output

The node outputs JSON data representing the created sale as returned by the Conta Azul API. This typically includes identifiers, status, dates, payment details, and itemized sale information. The output does not include binary data.

Dependencies

  • Requires an active Conta Azul API OAuth2 credential configured in n8n.
  • Depends on the Conta Azul API being accessible and the provided credentials having permissions to create sales.
  • No additional external dependencies beyond the Conta Azul API.

Troubleshooting

  • Common Issues:

    • Invalid or missing client UUID may cause the API to reject the sale creation.
    • Incorrect date format for sale date or installment due dates can lead to errors.
    • Missing required fields such as sale number, payment method, or items will prevent successful creation.
    • Network or authentication issues with the Conta Azul API can cause request failures.
  • Error Messages:

    • "Operation not supported": Indicates an unsupported operation was requested; ensure "Create Sale" is selected.
    • API validation errors usually specify which field is invalid or missing; verify all required properties.
    • Authentication errors suggest problems with the API key or OAuth token; reconfigure credentials if needed.

Links and References

Discussion