sevDesk icon

sevDesk

Consume the sevDesk API

Overview

The node integrates with the sevDesk API to perform various operations on sevDesk resources. Specifically, for the Credit Note resource and the Get PDF operation, it retrieves the PDF document of a specified credit note by its ID. This is useful when you want to programmatically download or access the PDF version of a credit note for record-keeping, sharing, or further processing.

Practical examples include:

  • Automatically fetching credit note PDFs after creation to store them in a document management system.
  • Downloading credit note PDFs to attach to emails sent to customers.
  • Archiving credit note PDFs in cloud storage for compliance purposes.

Properties

Name Meaning
Credit Note ID The unique identifier of the credit note whose PDF you want to retrieve.
Options Additional options for the operation:
  Download Boolean flag indicating whether to download the PDF file directly (true) or just get metadata/URL (false).

Output

The output contains JSON data representing the result of the PDF retrieval operation. Typically, this will include either:

  • Metadata about the PDF or a URL to access it if the download option is false.
  • The binary content of the PDF file if the download option is true.

If binary data is returned, it represents the actual PDF file of the credit note, which can be saved or forwarded as needed.

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 from credentials.
  • No additional external dependencies beyond the sevDesk API.

Troubleshooting

  • Common issues:

    • Invalid or missing Credit Note ID: Ensure the provided ID corresponds to an existing credit note in sevDesk.
    • Authentication errors: Verify that the API key credential is correctly set up and has sufficient permissions.
    • Network or API downtime: Check sevDesk service status if requests fail unexpectedly.
  • Error messages:

    • Errors returned from the API are captured and included in the output JSON under an error field if "Continue On Fail" is enabled.
    • Common error messages may relate to invalid IDs, permission denied, or rate limiting.
  • Resolution tips:

    • Double-check input parameters for correctness.
    • Confirm API credentials and permissions.
    • Use "Continue On Fail" to handle errors gracefully in workflows.

Links and References

Discussion