sevDesk icon

sevDesk

Consume the sevDesk API

Overview

This node integrates with the sevDesk API to perform various operations on sevDesk resources. Specifically, for the Credit Note resource and the Enshrine operation, it allows users to "enshrine" (finalize or lock) a credit note within sevDesk. This is useful in accounting workflows where a credit note needs to be marked as finalized or officially recorded.

Typical use cases include:

  • Finalizing a credit note after review so it cannot be modified.
  • Locking credit notes before financial reporting or auditing.
  • Automating bookkeeping processes by programmatically changing credit note statuses.

Properties

Name Meaning
Credit Note ID The unique identifier of the credit note to be enshrined. This is required to specify which credit note the operation applies to.

Output

The node outputs an array of JSON objects corresponding to the results of the executed operations. Each output item contains the response from the sevDesk API related to the enshrinement of the specified credit note.

If an error occurs during execution and the node is configured to continue on failure, the output will include an object with an error field describing the issue for that particular item.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the sevDesk API.
  • The base URL for API requests is https://my.sevdesk.de/api/ appended with the API version specified in credentials.
  • The node depends on internal resource management and validation modules bundled within the node's codebase.
  • Environment configuration validation is performed at runtime to ensure necessary environment variables or settings are present.

Troubleshooting

  • Common issues:

    • Invalid or missing Credit Note ID will cause the operation to fail.
    • Authentication errors if the API key credential is incorrect or expired.
    • Network connectivity problems preventing access to the sevDesk API.
    • API version mismatches if the credential's API version does not match the expected endpoint.
  • Error messages:

    • Errors returned from the API are captured and included in the output when "Continue On Fail" is enabled.
    • Typical error messages might include "Credit Note not found," "Unauthorized," or "Invalid request."
  • Resolutions:

    • Verify the Credit Note ID is correct and exists in sevDesk.
    • Check and update the API key credential.
    • Ensure network connectivity and firewall rules allow outbound HTTPS requests.
    • Confirm the API version setting matches the sevDesk API version in use.

Links and References

Discussion