Superlogica icon

Superlogica

Consumir API do Superlogica Condomínios
Join our community

Actions42

Overview

This node integrates with the Superlogica API to manage "Boleto" resources, specifically allowing users to cancel a boleto (a payment slip commonly used in Brazil). The "Cancelar Boleto" operation enables users to provide the boleto ID and a cancellation reason to request the cancellation of that boleto via the API.

Common scenarios include:

  • Canceling a boleto that was issued incorrectly or is no longer needed.
  • Automating boleto management workflows where cancellations must be processed programmatically.
  • Integrating boleto cancellation into broader financial or condominium management systems.

Example use case:
A property manager uses this node to automatically cancel boletos when tenants request it or when errors are detected in billing.

Properties

Name Meaning
ID do Boleto The unique identifier of the boleto to cancel. This is required to specify which boleto should be canceled.
Motivo do Cancelamento The reason for canceling the boleto. This text explains why the cancellation is being requested and is mandatory.

Output

The node outputs JSON data representing the response from the Superlogica API after attempting to cancel the boleto. This typically includes confirmation details about the cancellation or error information if the cancellation failed.

The output structure is:

  • json: Contains the API response data related to the cancellation request.
  • If an error occurs and "Continue On Fail" is enabled, the output will contain an error field with the error message.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to the Superlogica API.
  • Needs valid API credentials including an application token and access token.
  • The API base URL defaults to https://api.superlogica.net/v2/condor but can be overridden by credentials configuration.

Troubleshooting

  • Missing Credentials: The node will throw an error if the required API credentials are not provided. Ensure that the API key and tokens are correctly configured in n8n.
  • Invalid Boleto ID: Providing an incorrect or non-existent boleto ID may result in API errors. Verify the boleto ID before running the node.
  • Cancellation Reason Required: The cancellation reason must be supplied; otherwise, the API may reject the request.
  • API Connectivity Issues: Network problems or incorrect API URLs can cause failures. Confirm network access and correct endpoint configuration.
  • Error Handling: If "Continue On Fail" is enabled, errors will be returned as part of the output JSON instead of stopping execution, allowing for graceful handling in workflows.

Links and References

Discussion