Imobzi icon

Imobzi

Interagir com a API da Imobzi
Join our community

Actions62

Overview

This node integrates with the Imobzi API to retrieve multiple rental records ("Locacao" resource) based on specified filters, ordering, limits, and offsets. It is useful for scenarios where you need to fetch a list of rental data from Imobzi, such as generating reports, syncing rental information with other systems, or filtering rentals by specific criteria.

For example, you can use this node to:

  • Retrieve all rentals where the tenant's name starts with "John".
  • Get a paginated list of rentals ordered by start date.
  • Filter rentals that have a value greater than a certain amount.

Properties

Name Meaning
Filtros A collection of filter conditions to narrow down the rental records. Each condition includes:
- Campo Name or ID: The field to filter by (loaded dynamically from rental fields).
- Operador: Comparison operator, options are: "Começa Com" (starts_with), "Contém" (contains), "Diferente" (neq), "Igual" (eq), "Maior Ou Igual" (gte), "Maior Que" (gt), "Menor Ou Igual" (lte), "Menor Que" (lt), "Não Contém" (not_contains), "Termina Com" (ends_with).
- Valor: The value to compare against.
Order By Field name to order the results by.
Limit Maximum number of rental records to return. Must be at least 1. Default is 50.
Offset Number of rental records to skip before starting to collect the result set. Useful for pagination. Must be 0 or more. Default is 0.

Output

The node outputs an array of JSON objects under the json property, each representing a rental record retrieved from the Imobzi API. The structure of each rental object corresponds to the fields available in the Imobzi rentals endpoint, including tenant information and other rental details.

No binary data output is produced by this operation.

Example output snippet:

[
  {
    "json": {
      "id": 123,
      "tenant": "John Doe",
      "startDate": "2023-01-01",
      "endDate": "2023-12-31",
      ...
    }
  },
  {
    "json": {
      "id": 124,
      "tenant": "Jane Smith",
      "startDate": "2023-02-01",
      "endDate": "2023-11-30",
      ...
    }
  }
]

Dependencies

  • Requires an active connection to the Imobzi API via an API key credential configured in n8n.
  • The node uses authenticated HTTP requests to the Imobzi API endpoints.
  • No additional external dependencies beyond the Imobzi API and n8n's HTTP request capabilities.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Using unsupported or misspelled filter fields may result in API errors or empty results.
    • Requesting too large a limit may lead to timeouts or rate limiting by the API.
    • Incorrect operators or values in filters might not return expected results.

  • Error messages:

    • "Recurso "locacao" não suportado!": Indicates the resource name is incorrect or not implemented; ensure "Locacao" is selected.
    • "Operação "getAll" não suportada!": Means the operation is not supported; verify the operation selection.
    • API errors returned from Imobzi will be shown in the error message; check the API documentation for details.

  • Resolutions:

    • Verify API credentials and permissions.
    • Double-check filter field names and operators.
    • Use smaller limits or add offsets for pagination.
    • Enable "Continue On Fail" if partial data retrieval is acceptable.

Links and References

Discussion