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 perform various operations related to business management, such as managing persons, products, sales, financial accounts, categories, cost centers, revenues, and expenses. Specifically, the "Search Persons By Filter" operation allows users to search for persons (customers or companies) by a search term that can match document numbers, customer names, or company names. This is useful for retrieving filtered lists of persons from the Conta Azul system, supporting pagination to handle large result sets.

Practical examples:

  • Searching for customers by partial name or document number to quickly find their records.
  • Retrieving a paginated list of persons matching a certain filter for reporting or synchronization purposes.

Properties

Name Meaning
Search Term Search by document, customer name, or company name to filter persons.
Page (Person) The page number of results to retrieve (for pagination).
Page Size (Person) Number of items per page to return in the results (pagination size).

Output

The node outputs JSON data containing the list of persons matching the search criteria. The structure typically includes person details such as IDs, names, documents, contact information, and other relevant metadata as returned by the Conta Azul API. The output is paginated according to the input properties.

No binary data output is indicated for this operation.

Dependencies

  • Requires an OAuth2 API credential configured in n8n to authenticate requests to the Conta Azul API.
  • Depends on the Conta Azul API service being available and accessible.
  • No additional environment variables are explicitly required beyond the API authentication setup.

Troubleshooting

  • Common issues:

    • Invalid or expired API credentials may cause authentication failures.
    • Providing invalid page numbers or sizes might result in empty responses or errors.
    • Network connectivity issues could prevent successful API calls.
  • Error messages:

    • "Operation not supported": This error occurs if an unsupported operation is selected; ensure "Search Persons By Filter" is chosen.
    • API errors related to authentication or rate limits will be passed through; verify API key validity and usage limits.
  • Resolutions:

    • Re-authenticate or update the API credentials if authentication fails.
    • Validate input parameters for correctness and adherence to expected formats.
    • Check network connectivity and API service status.

Links and References

Discussion