sevDesk icon

sevDesk

Consume the sevDesk API

Overview

The node integrates with the sevDesk API, allowing users to perform various operations on sevDesk resources. Specifically, for the Credit Note resource with the Get operation, it retrieves detailed information about a specific credit note by its ID. This is useful in scenarios where you need to fetch and process credit note data from sevDesk within an automated workflow, such as generating reports, syncing financial data, or validating credit notes before further processing.

Example use cases:

  • Automatically retrieving credit note details after creation for record-keeping.
  • Fetching credit note information to update another system or database.
  • Validating credit note status or amounts before triggering downstream actions.

Properties

Name Meaning
Credit Note ID The unique identifier of the credit note to retrieve. This is a required string input.

Output

The node outputs JSON data representing the retrieved credit note object from the sevDesk API. The structure typically includes all fields related to the credit note, such as its ID, date, amount, customer details, status, and line items.

If the node encounters an error (e.g., invalid ID or API issues), it outputs a JSON object containing an error field with the error message.

No binary data output is indicated for this operation.

Dependencies

  • Requires an active connection to the sevDesk API via an API key credential configured in n8n.
  • 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 Credit Note ID will cause the API call to fail.
    • Network or authentication errors if the API key is incorrect or expired.
    • API rate limits or sevDesk service outages may cause temporary failures.
  • Error Messages:

    • Errors returned from the API are captured and output as { "error": "message" }.
    • If the node is set to continue on failure, these errors appear in the output JSON; otherwise, execution stops.
  • Resolutions:

    • Verify that the Credit Note ID is correct and exists in sevDesk.
    • Check API credentials and permissions.
    • Ensure network connectivity and sevDesk service availability.
    • Enable "Continue On Fail" in the node settings to handle errors gracefully in workflows.

Links and References

Discussion