Alegra (Unofficial - BETA) icon

Alegra (Unofficial - BETA)

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

Actions37

Overview

This node integrates with the Alegra API to manage "items," which represent products or services in an accounting or inventory context. The "Get Many" operation under the "Item" resource allows users to retrieve multiple items from their Alegra account, optionally filtered and sorted according to various criteria.

Typical use cases include:

  • Synchronizing product or service lists from Alegra into other systems.
  • Generating reports or dashboards based on item data.
  • Automating workflows that require bulk access to item information, such as inventory checks or price updates.

For example, a user might configure this node to fetch all active products within a specific category, ordered by price ascending, to update an e-commerce platform's catalog.

Properties

Name Meaning
Return All Whether to return all matching items or limit the number of results.
Limit Maximum number of items to return if not returning all (minimum 1, maximum 100).
Filters Collection of filters to narrow down the items returned:
- Name Filter items by their name (string match).
- Type Filter by item type; options are: All (no filter), Product, Service.
- Reference Filter by reference or SKU string.
- Status Filter by status; options are: All (no filter), Active, Inactive.
- Category Name or ID Filter by category, selectable from a dynamically loaded list or by specifying an ID via expression.
- Order By Field to order the results by; options: Name, ID, Price, Reference.
- Order Direction Direction of ordering; options: Ascending, Descending.

Output

The output is an array of JSON objects, each representing an item retrieved from Alegra. Each item object contains fields corresponding to the item's properties as returned by the Alegra API, such as:

  • id: Unique identifier of the item.
  • name: Name of the item.
  • type: Type of the item (e.g., product or service).
  • price: Price of the item.
  • reference: Reference code or SKU.
  • Other metadata fields like category, tax info, status, etc.

No binary data is output by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Alegra API.
  • The node uses the Alegra API base URL configured in the credential environment.
  • Dynamic loading of categories for filtering requires the node to call the /categories endpoint.

Troubleshooting

  • Common issues:

    • Authentication errors if the API key credential is missing or invalid.
    • Rate limiting or network errors from the Alegra API.
    • Invalid filter values causing the API to reject requests.

  • Error messages:

    • Errors from the API are wrapped and surfaced as node operation errors with the message from Alegra.
    • If the node is set to continue on failure, errors will be included in the output JSON under an error field.

  • Resolutions:

    • Verify the API key credential is correctly configured and has necessary permissions.
    • Check network connectivity and API availability.
    • Ensure filter values conform to expected formats and valid options.

Links and References

Discussion