sevDesk icon

sevDesk

Consume the sevDesk API
Join our community

Actions98

Overview

The node integrates with the sevDesk API to export contact data as CSV files. Specifically, the "Export Contact as CSV" operation under the "Export" resource allows users to generate CSV exports of their contacts from sevDesk. This is useful for scenarios such as backing up contact information, migrating data to other systems, or performing offline analysis.

Practical examples include:

  • Exporting all customer contacts within a specific date range.
  • Generating CSV files that include additional document metadata or XML attachments.
  • Automating periodic exports of contact data for accounting or CRM synchronization.

Properties

Name Meaning
Archive Documents Whether to archive documents related to the export (true/false).
Download Whether to download the exported CSV file immediately (true/false).
End Date The end date filter for the export, specifying the latest date for included contacts/documents.
Enshrine Documents Whether to enshrine (preserve) documents during export (true/false).
Export By Payday Whether to export data grouped by payday (true/false).
Hash A hash string used for validation or identification of the export job.
Include Document XML Whether to include XML versions of documents in the export (true/false).
Include Enshrined Whether to include documents that have been enshrined (true/false).
Include Exported Documents Whether to include documents that have already been exported (true/false).
Job ID Identifier for a specific export job to retrieve or manage.
Sev Query A custom query string to filter or modify the export request.
Start Date The start date filter for the export, specifying the earliest date for included contacts/documents.
Stateless Whether the export should be stateless, possibly affecting how state or progress is tracked (true/false).
Types A string specifying types of contacts or documents to include in the export.

Output

The node outputs JSON data representing the result of the export operation. This typically includes metadata about the export job, status, and potentially URLs 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 content.

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.
  • The node depends on internal resource management and validation schema modules bundled with it.

Troubleshooting

  • Common issues:
    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect date formats in "Start Date" or "End Date" can lead to errors or empty exports.
    • 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 JSON error 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 ISO strings, and API credentials are current.

Links and References

Discussion