sevDesk icon

sevDesk

Consume the sevDesk API
Join our community

Actions98

Overview

The node integrates with the sevDesk API to perform various operations related to exporting data. Specifically, the "Start DATEV XML Zip Export" operation under the "Export" resource initiates an export process that generates a ZIP archive containing DATEV-compliant XML files. This is useful for accounting and financial workflows where data needs to be exported in a standardized format for tax or bookkeeping purposes.

Typical use cases include:

  • Automating the export of accounting documents for submission to tax authorities.
  • Scheduling regular exports of financial data in DATEV XML format.
  • Archiving or downloading accounting data in a structured ZIP file for offline processing or backup.

Properties

Name Meaning
Archive Documents Whether to archive the documents as part of the export (true/false).
Download Whether to download the export immediately after creation (true/false).
End Date The end date for the export period (string, typically in date format).
Enshrine Documents Whether to enshrine (securely store) the documents during export (true/false).
Export By Payday Whether to export data grouped by payday instead of other criteria (true/false).
Hash A hash string used for validation or identification of the export job.
Include Document XML Whether to include the original document XML files in the export (true/false).
Include Enshrined Whether to include previously enshrined documents in the export (true/false).
Include Exported Documents Whether to include documents that have already been exported before (true/false).
Job ID Identifier for an existing export job to continue or reference (string).
Sev Query A query string parameter for filtering or specifying export details (string).
Start Date The start date for the export period (string, typically in date format).
Stateless Whether the export should be stateless, i.e., not retain state between requests (true/false).
Types A string specifying types of documents or data 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 such as job identifiers, status, URLs for downloading the generated ZIP file, or error messages if the export failed.

If the "Download" option is enabled, the node may also output binary data corresponding to the downloaded ZIP archive containing the DATEV XML files.

Dependencies

  • Requires an API key credential for authenticating with the sevDesk API.
  • The node uses the sevDesk API base URL configured with the appropriate API version.
  • Environment configuration validation is performed at runtime to ensure necessary environment variables or settings are present.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect date formats for "Start Date" or "End Date" may lead to errors or empty exports.
    • Providing an invalid "Job ID" when continuing an export job can cause failures.
    • Network connectivity issues can prevent communication with the sevDesk API.

  • Error messages:

    • Errors returned from the API are captured and included in the output JSON under an error field.
    • If the node is set to continue on failure, it will output error details per item without stopping execution.
    • Validation warnings may appear if environment configuration is incomplete or incorrect.

Links and References

Discussion