sevDesk icon

sevDesk

Consume the sevDesk API

Overview

This node integrates with the sevDesk API to retrieve multiple orders based on specified filters. It is useful for scenarios where users need to fetch a list of orders matching certain criteria such as date ranges, status, or customer contact ID. For example, an e-commerce business could use this node to pull all delivered orders within a specific timeframe for reporting or further processing.

Properties

Name Meaning
Filters A collection of optional filters to narrow down the orders retrieved. Includes:
- Contact ID: Filter orders by a specific customer contact identifier (string).
- End Date: Filter orders up to this timestamp (number, likely Unix epoch).
- Order Number: Filter by a specific order number (string).
- Start Date: Filter orders from this timestamp onwards (number, likely Unix epoch).
- Status: Filter orders by their status. Possible values are: Draft, Delivered, Billed, Accepted, Declined, Finished.

Output

The node outputs an array of JSON objects representing the orders that match the provided filters. Each object contains the order data as returned by the sevDesk API. The exact structure depends on the API response but typically includes fields like order ID, contact details, order number, status, dates, and line items.

No binary data output is indicated in the source code.

Dependencies

  • Requires an API key credential for authenticating with the sevDesk API.
  • The base URL for API requests is https://my.sevdesk.de/api/ combined with the API version specified in credentials.
  • Environment configuration validation is performed before execution.
  • Uses internal resource management classes to handle API operations.

Troubleshooting

  • Common issues:
    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect filter formats (e.g., non-numeric timestamps) may result in API errors or empty results.
    • Network connectivity problems can prevent successful API calls.
  • Error handling:
    • If an error occurs during execution, the node either throws the error or, if configured to continue on failure, returns an error object with the message for the affected item.
  • Resolution tips:
    • Verify API credentials and permissions.
    • Ensure filter values conform to expected types and formats.
    • Check network access to the sevDesk API endpoint.

Links and References

Discussion