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 search for revenue records filtered by various criteria. It allows users to query revenues based on textual search terms, pagination settings, and a required due date range. This is useful for financial management workflows where you need to retrieve specific revenue entries within a certain period or matching particular keywords.

Practical examples include:

  • Retrieving all revenues due between two dates to generate reports.
  • Searching revenues by name or number to find specific transactions.
  • Paginating through large sets of revenue data for batch processing or synchronization.

Properties

Name Meaning
Search (Revenue) Textual search filter to find revenues by name, number, or other identifying information.
Page (Revenue) The page number of results to retrieve (for pagination).
Page Size (Revenue) Number of revenue items to return per page.
Due Date (From) Start date of the due date range filter (format YYYY-MM-DD, required).
Due Date (Until) End date of the due date range filter (format YYYY-MM-DD, required).

Output

The node outputs JSON data containing the list of revenues that match the specified filters. Each item in the output typically includes details about individual revenue entries such as their name, number, due date, amount, and other relevant financial information as provided by the Conta Azul API.

No binary data output is involved in this operation.

Dependencies

  • Requires an active Conta Azul API OAuth2 credential configured in n8n to authenticate requests.
  • Depends on the Conta Azul API service being available and accessible.
  • The node uses internal helper modules to perform the API calls but these are bundled and abstracted away from the user.

Troubleshooting

  • Common issues:

    • Missing or invalid API credentials will cause authentication failures.
    • Providing invalid date formats for the due date fields may result in errors or no data returned.
    • Requesting pages beyond the available data set might return empty results.
  • Error messages:

    • "Operation not supported": This indicates an unsupported operation was selected; ensure "Search Revenues By Filter" is chosen.
    • API errors related to authentication or rate limits should be resolved by checking credentials and API usage policies.
  • Resolution tips:

    • Verify that the due date fields are correctly formatted as YYYY-MM-DD.
    • Confirm that the Conta Azul API credentials are valid and have necessary permissions.
    • Adjust pagination parameters if no results are returned unexpectedly.

Links and References

Discussion