API Conta Azul

Permite fazer requisições à API da Conta Azul

Overview

This node integrates with the Conta Azul API to create a new person record in the system. It supports creating different types of persons such as individuals (Física), companies (Jurídica), and foreigners (Estrangeira). The node is useful for automating customer, supplier, or carrier registrations within Conta Azul directly from workflows.

Typical use cases include:

  • Automatically adding new clients or suppliers when receiving form submissions.
  • Synchronizing contact data from other systems into Conta Azul.
  • Managing transporters or other business partners by creating their profiles programmatically.

Properties

Name Meaning
Tipo de Pessoa Type of person: Física (Individual), Jurídica (Company), Estrangeira (Foreigner)
Nome Full name of the person
Email Email address (optional)
Telefone Phone number (optional)
Perfis Profiles associated with the person; can select multiple: Cliente (Client), Fornecedor (Supplier), Transportadora (Carrier)
CEP Postal code of the address
Logradouro Street name
Número Address number
Complemento Address complement (optional)
Bairro Neighborhood
Cidade City
Estado State
CPF Individual taxpayer registry identification (required only if Tipo de Pessoa = Física)
CNPJ Company registration number (required only if Tipo de Pessoa = Jurídica)
País Country of the address (fixed default: Brasil)

Output

The node outputs JSON data representing the newly created person record as returned by the Conta Azul API. This typically includes identifiers, status, and all submitted fields confirming the creation.

No binary data output is produced by this operation.

Dependencies

  • Requires an OAuth2 API credential configured for Conta Azul to authenticate requests.
  • Internet access to call the Conta Azul REST API endpoints.
  • Proper permissions on the Conta Azul account to create person records.

Troubleshooting

  • Common issues:

    • Missing required fields such as name, address components, or document numbers will cause errors.
    • Providing CPF when the person type is not "Física" or CNPJ when not "Jurídica" may lead to validation failures.
    • Incorrect or expired API credentials will result in authentication errors.
    • Network connectivity problems can cause request timeouts or failures.
  • Error messages:

    • "Operação não suportada" indicates an unsupported operation was selected; ensure "Criar pessoa" is chosen.
    • Validation errors from the API usually specify which field is invalid or missing; verify input data accordingly.
    • Authentication errors suggest checking the API key or OAuth token validity.

Links and References

Discussion