Conta Azul API icon

Conta Azul API

Allows making requests to the Conta Azul API

Actions18

Search Revenues By Filter

AI-generated

Overview

This node operation allows users to search for revenues within the Conta Azul API by applying filters such as due date range and optional additional fields like search terms, pagination, and page size. It is useful for retrieving specific revenue records based on criteria like name, number, or due date, facilitating financial data management and reporting.

Use Case Examples

  1. Retrieve all revenues due between two dates with pagination.
  2. Search revenues by name or number within a specified due date range.

Properties

Name Meaning
busca_receita Search revenues by name, number, or other text criteria.
pagina_receita Page number for paginated results.
tamanho_pagina_receita Number of items per page in the paginated results.
data_vencimento_de Initial due date to filter revenues from (required).
data_vencimento_ate Final due date to filter revenues until (required).

Output

JSON

  • id - Unique identifier of the revenue record.
  • name - Name or description of the revenue.
  • dueDate - Due date of the revenue.
  • amount - Monetary amount of the revenue.
  • status - Current status of the revenue (e.g., paid, pending).

Dependencies

  • Conta Azul API OAuth2 credentials

Troubleshooting

  • Ensure that the required due date fields (data_vencimento_de and data_vencimento_ate) are provided in the correct format (YYYY-MM-DD).
  • Check API credentials and permissions if the node fails to retrieve data.
  • If pagination parameters are used, verify that page numbers and sizes are within valid ranges.

Links

Discussion