sevDesk icon

sevDesk

Consume the sevDesk API

Overview

The node integrates with the sevDesk API to retrieve reports, specifically supporting the "Get Many" operation for the "Report" resource. This operation allows users to fetch multiple report entries based on specified filters such as contact and date ranges. It is useful in scenarios where bulk report data extraction is needed for analysis, auditing, or exporting financial information.

For example, a user might want to download all invoices related to a specific contact within a certain date range or simply retrieve a list of reports without downloading them as files.

Properties

Name Meaning
Download Whether the report will be downloaded as a file (boolean: true or false).
Additional Fields Collection of optional filters to refine the report retrieval:
- Contact Retrieve all invoices associated with this contact (string).
- Start Date Retrieve all invoices with a date equal to or after this date (string, typically ISO date).
- End Date Retrieve all invoices with a date equal to or before this date (string, typically ISO date).

Output

The output is an array containing JSON objects representing the retrieved reports. Each object corresponds to a report entry fetched from the sevDesk API according to the specified filters.

If the "Download" property is set to true, the node will provide the report content as a downloadable file (binary data), allowing users to save the report locally or pass it to subsequent nodes for further processing.

Dependencies

  • Requires an API key credential for authenticating with the sevDesk API.
  • The node uses the base URL https://my.sevdesk.de/api/ combined with the API version specified in credentials.
  • Environment configuration validation is performed at runtime to ensure proper setup.

Troubleshooting

  • Common issues:

    • Invalid or missing API authentication token can cause authorization errors.
    • Incorrect date formats in "Start Date" or "End Date" fields may lead to no results or API errors.
    • Requesting downloads without proper permissions or unsupported report types might fail.
  • Error messages:

    • Errors returned by the API are captured and included in the output if "Continue On Fail" is enabled.
    • Typical error messages include authentication failures, invalid parameters, or network issues.
  • Resolutions:

    • Verify that the API key credential is correctly configured and has necessary permissions.
    • Ensure date inputs follow the expected format (e.g., ISO 8601).
    • Check network connectivity and sevDesk service status.

Links and References

Discussion