sevDesk icon

sevDesk

Consume the sevDesk API

Overview

This node integrates with the sevDesk API to manage accounting-related resources. Specifically, for the Credit Note resource with the Create From Invoice operation, it allows users to create a credit note based on an existing invoice. This is useful in scenarios where a business needs to issue a credit note referencing a previously issued invoice, such as when correcting billing errors or processing returns.

Practical examples include:

  • Automatically generating a credit note after an invoice cancellation.
  • Creating credit notes for partial refunds linked to specific invoices.

Properties

Name Meaning
Invoice A collection containing details of the invoice from which the credit note will be created. It includes:
- ID: The unique identifier of the invoice.
- Object Name: The type of object, defaulting to "Invoice".

Output

The node outputs JSON data representing the result of the credit note creation request. This typically includes details of the newly created credit note as returned by the sevDesk API.

If an error occurs during execution and the node is configured to continue on failure, the output will contain an error message associated with the specific input item.

No binary data output is indicated.

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.
  • Validation schemas for sevDesk data are initialized at module load time.

Troubleshooting

  • Common issues:

    • Invalid or missing invoice ID can cause the API call to fail.
    • Incorrect API credentials or expired tokens will prevent successful authentication.
    • Network connectivity problems may lead to request failures.
  • Error messages:

    • Errors thrown during the API call are captured and can be output per item if "continue on fail" is enabled.
    • Initialization failures of validation schemas are logged to the console but do not stop node loading.
  • Resolutions:

    • Verify that the invoice ID provided exists and is correct.
    • Ensure the API key credential is valid and has necessary permissions.
    • Check network access to the sevDesk API endpoint.

Links and References

Discussion