API Conta Azul

Permite fazer requisições à API da Conta Azul

Overview

The node "API Conta Azul" enables making requests to the Conta Azul API, a financial and business management platform. Specifically, the operation Buscar categorias (Get Categories) allows users to search for financial categories within their Conta Azul account. This is useful for organizing and filtering financial data such as revenues and expenses by category type.

Common scenarios include:

  • Retrieving a list of income or expense categories to categorize transactions.
  • Filtering categories by name or code to find specific ones quickly.
  • Paginating through large sets of categories when managing extensive financial records.

Practical example:

  • A user wants to fetch all "Receita" (Income) categories containing the word "Consulting" to assign them to new revenue entries in an automated workflow.

Properties

Name Meaning
Busca (categoria) Search term to filter categories by name or code.
Tipo Type of category to retrieve; options are "Receita" (Income) or "Despesa" (Expense).
Página (categoria) Page number of the results to retrieve (for pagination).
Tamanho da página (categoria) Number of items per page to return (for pagination).

Output

The output JSON contains the list of categories matching the search criteria. Each item typically includes details such as category ID, name, code, and type (income or expense).

If the API supports it, the output may also include pagination metadata like total pages or total items.

No binary data output is expected from this operation.

Dependencies

  • Requires an OAuth2 API credential configured for Conta Azul to authenticate API requests.
  • Depends on the external Conta Azul API service being available and accessible.
  • The node uses internal helper modules to perform the actual API calls.

Troubleshooting

  • Common issues:

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

    • "Operação não suportada" (Operation not supported): Occurs if an unsupported operation is requested; ensure the operation parameter is set correctly.
    • Authentication errors: Check that the OAuth2 credentials are valid and have necessary permissions.
    • API rate limits or quota exceeded: May require waiting or adjusting usage patterns.

Links and References

Discussion