Alegra (Unofficial - BETA) icon

Alegra (Unofficial - BETA)

Consume Alegra API - UNOFFICIAL BETA community node. NOT officially supported by Alegra.

Overview

The node integrates with the Alegra API to manage tax records. Specifically, the "Tax" resource with the "Get Many" operation allows users to retrieve multiple tax entries from their Alegra account. This is useful for scenarios where you want to list all taxes or filter them by type or status, such as generating reports, syncing tax data with other systems, or validating tax configurations.

For example, a user might want to fetch all active general taxes to apply them in an invoicing workflow or retrieve all compound taxes for auditing purposes.

Properties

Name Meaning
Return All Whether to return all tax results or limit the number of results returned.
Limit Maximum number of tax results to return (only used if "Return All" is false).
Filters Collection of filters to narrow down the tax results:
- Type Filter by tax type. Options: All, General Tax, Retention, Compound Tax
- Status Filter by tax status. Options: All, Active, Inactive

Output

The output is an array of JSON objects representing tax records retrieved from Alegra. Each object contains details about a tax entry, such as its name, percentage, type, and status. The exact fields depend on the Alegra API response but typically include identifiers and descriptive attributes of each tax.

This node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the Alegra API.
  • The node uses HTTP requests to the Alegra API endpoints under /api/v1/taxes.
  • No additional environment variables are required beyond the API authentication setup.

Troubleshooting

  • Common issues:

    • Authentication errors due to invalid or missing API credentials.
    • Network connectivity problems preventing access to Alegra API.
    • Exceeding API rate limits imposed by Alegra.
    • Providing invalid filter values that do not match expected options.
  • Error messages:

    • Errors thrown by the node will typically contain the message from the Alegra API or a generic "Unknown error occurred".
    • To resolve authentication errors, verify the API key credential configuration.
    • For network or rate limit issues, check your internet connection and Alegra account limits.
    • Ensure filter values conform to the allowed options ("general", "retention", "compound" for type; "active", "inactive" for status).

Links and References

Discussion