sevDesk icon

sevDesk

Consume the sevDesk API
Join our community

Actions98

Overview

This node integrates with the sevDesk API to export invoice data as a ZIP archive. It is designed to facilitate the extraction and packaging of invoice documents, optionally including related XML files and archived or enshrined documents. This operation is useful for automating financial workflows such as backing up invoices, transferring invoice data to other systems, or preparing data for audits.

Practical examples include:

  • Exporting all invoices within a specific date range as a ZIP file.
  • Including additional document formats (e.g., XML) alongside invoices.
  • Archiving or enshrining documents during export for compliance or record-keeping purposes.
  • Downloading the generated ZIP archive directly through the workflow.

Properties

Name Meaning
Archive Documents Whether to archive the exported documents (boolean).
Download Whether to download the exported ZIP file immediately (boolean).
End Date The end date to filter invoices for export (string, typically in date format).
Enshrine Documents Whether to enshrine the exported documents (boolean).
Export By Payday Whether to export invoices grouped by payday (boolean).
Hash A hash string used for validation or identification purposes during export (string).
Include Document XML Whether to include the XML versions of the documents in the export (boolean).
Include Enshrined Whether to include already enshrined documents in the export (boolean).
Include Exported Documents Whether to include documents that have been previously exported (boolean).
Job ID Identifier for a specific export job (string).
Sev Query A query string parameter for filtering or customizing the export (string).
Start Date The start date to filter invoices for export (string, typically in date format).
Stateless Whether the export should be stateless (boolean).
Types A string specifying types of documents or invoices 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 information, and potentially URLs or references to the generated ZIP archive containing the exported invoices.

If the "Download" option is enabled, the node may also output binary data corresponding to the ZIP file itself, allowing subsequent nodes to handle or store the actual archive.

Dependencies

  • Requires an active connection to the sevDesk API via an API key credential.
  • The node uses the base URL https://my.sevdesk.de/api/ combined with the configured API version.
  • Environment configuration validation is performed before execution.
  • No additional external dependencies are indicated beyond the sevDesk API access.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect date formats for "Start Date" or "End Date" may lead to empty exports or errors.
    • Providing invalid job IDs or hashes might result in failed export operations.
    • Network connectivity problems can interrupt 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 "Continue On Fail" is enabled.
    • Typical error messages relate to authorization failures, invalid parameters, or server-side issues.

  • Resolution tips:

    • Verify API credentials and permissions.
    • Ensure date strings conform to expected formats (e.g., ISO 8601).
    • Check network connectivity and retry if transient errors occur.
    • Use the "Continue On Fail" option to handle partial failures gracefully.

Links and References

Discussion