ImobziInstall

Summary

Retrieve multiple invoice records from Imobzi, applying optional filters and auto-pagination up to a specified maximum number of records.

Inputs

• Quantidade De Registros — Select the maximum number of invoice records to retrieve with automatic pagination, options range from 50 up to 5000.
• Filtros — Collection of optional filters to refine the invoices retrieved, including date range (start and end), payment method (Boleto, Credit Card, PIX, or all), status (e.g., Paid, Pending, Overdue), sorting order (ascending or descending), and sorting field (defaults to date).

Output shape

A list of invoice records, each represented as a JSON object.

The operation supports auto-pagination and will return up to the selected maximum number of invoices. Filters are optional and support precise date filtering and payment/status-based filtering. Returned data corresponds to the Imobzi API's invoice listing format.

Examples

Example 1: Retrieve up to 100 paid invoices paid by PIX between two dates, sorted ascending by date.

Set 'Quantidade De Registros' to 100, and in 'Filtros' set 'Data Início' and 'Data Fim' with the desired date range, 'Método De Pagamento' to 'PIX', and 'Status' to 'Pago'.