Conta Azul API icon

Conta Azul API

Allows making requests to the Conta Azul API

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 physical individuals, legal entities, or foreigners, and allows specifying detailed contact and address information. This operation is useful for automating customer, supplier, or transporter registrations within financial or business management workflows.

Practical examples include:

  • Automatically adding new customers from a CRM system into Conta Azul.
  • Registering suppliers or transporters when onboarding new partners.
  • Synchronizing user data collected from web forms directly into the accounting system.

Properties

Name Meaning
Person Type Type of person: "Física" (Physical individual), "Jurídica" (Legal entity), or "Estrangeira" (Foreigner)
Name Full name of the person
Email Email address of the person
Phone Contact phone number
Profiles Roles associated with the person: "Cliente" (Client), "Fornecedor" (Supplier), "Transportadora" (Transporter)
CEP Postal code (required)
Street Street address (logradouro) (required)
Number Address number (required)
Complement Additional address details
Neighborhood Neighborhood (bairro) (required)
City City (required)
State State (required)
CPF CPF number (Brazilian individual taxpayer registry) — shown only if Person Type is "Física"
CNPJ CNPJ number (Brazilian company registration) — shown only if Person Type is "Jurídica"
Country Country of the address (fixed to "Brasil") (required)

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 in n8n to authenticate requests to the Conta Azul API.
  • The node depends on the Conta Azul service being accessible and the provided credentials having permissions to create person records.

Troubleshooting

  • Common issues:

    • Missing required fields such as address components or person type may cause validation errors.
    • Providing CPF when the person type is not "Física" or CNPJ when not "Jurídica" might lead to API rejection.
    • Network or authentication failures can prevent successful API calls.
  • Error messages:

    • "Operation not supported": Indicates an unsupported operation was requested; ensure "Create Person" is selected.
    • Validation errors from the API will usually specify which field is missing or invalid.
  • Resolutions:

    • Double-check that all required properties are filled correctly according to the person type.
    • Verify that the OAuth2 credentials are valid and have necessary scopes.
    • Ensure network connectivity to the Conta Azul API endpoint.

Links and References

Discussion