sevDesk icon

sevDesk

Consume the sevDesk API
Join our community

Actions98

Overview

The node integrates with the sevDesk API to export invoice data as CSV files. Specifically, the "Export Invoice as CSV" operation under the "Export" resource allows users to generate CSV exports of invoices from their sevDesk account. This is useful for accounting, reporting, or data migration purposes where invoice data needs to be processed or analyzed outside of sevDesk.

Practical examples include:

  • Automatically exporting invoices within a date range for monthly financial reports.
  • Archiving exported invoices in bulk.
  • Downloading the generated CSV file directly after export for immediate use.

Properties

Name Meaning
Archive Documents Whether to archive the documents after export (true/false).
Download Whether to download the exported CSV file immediately (true/false).
End Date The end date to filter invoices for export (string, typically in date format).
Enshrine Documents Whether to enshrine (preserve) the documents during export (true/false).
Export By Payday Whether to export invoices grouped by payday (true/false).
Hash A hash string used for validation or identification of the export job.
Include Document XML Whether to include the document's XML data in the export (true/false).
Include Enshrined Whether to include already enshrined documents in the export (true/false).
Include Exported Documents Whether to include documents that have been previously exported (true/false).
Job ID Identifier for a specific export job (string).
Sev Query A query string to filter the export results (string).
Start Date The start date to filter invoices for export (string, typically in date format).
Stateless Whether the export should be stateless (true/false).
Types Types of invoices or documents to export (string).

Output

The node outputs JSON data representing the result of the export operation. This typically includes metadata about the export job, status information, and potentially links or references to the generated CSV files.

If the "Download" option is enabled, the node may also output binary data corresponding to the downloaded CSV file, allowing subsequent nodes to process or save the file.

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 before execution.
  • No other external dependencies are indicated.

Troubleshooting

  • Common issues:
    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect date formats in "Start Date" or "End Date" may lead to empty exports or errors.
    • Using incompatible combinations of options (e.g., enabling both "Archive Documents" and "Stateless") might cause unexpected behavior.
  • Error messages:
    • Errors returned from the API are caught and can be output as error JSON objects if "Continue On Fail" is enabled.
    • Network or permission errors should be checked by verifying API keys and network connectivity.
  • To resolve errors, ensure all required properties are correctly set, dates are valid, and API credentials are active.

Links and References

Discussion