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 "Export Voucher as Zip" operation under the "Export" resource allows users to export vouchers in a compressed ZIP archive format. This is useful for accounting and bookkeeping workflows where vouchers need to be archived, shared, or processed in bulk.

Common scenarios include:

  • Exporting accounting vouchers for a specific date range.
  • Archiving vouchers with options to include additional document formats (e.g., XML).
  • Downloading exported voucher archives directly within an automation workflow.
  • Filtering exports by types or other criteria such as payday or enshrined status.

Practical example:
A user wants to automate monthly export of all vouchers between two dates, including their XML documents, and download the resulting ZIP file for local storage or further processing.

Properties

Name Meaning
Archive Documents Boolean option to archive the documents along with vouchers in the export.
Download Boolean option to trigger immediate download of the exported ZIP file.
End Date String representing the end date filter for the export (e.g., "2024-06-30").
Enshrine Documents Boolean option to mark documents as enshrined during export.
Export By Payday Boolean option to group or filter exports by payday.
Hash String value used as a hash parameter, possibly for validation or identification of export jobs.
Include Document XML Boolean option to include XML versions of the documents in the export.
Include Enshrined Boolean option to include already enshrined documents in the export.
Include Exported Documents Boolean option to include documents that have been previously exported.
Job ID String identifier for a specific export job, useful for tracking or resuming exports.
Sev Query String query parameter for filtering or searching within the export operation.
Start Date String representing the start date filter for the export (e.g., "2024-06-01").
Stateless Boolean option indicating whether the export should be stateless (likely meaning no persistent session).
Types String specifying types of vouchers or documents to include in the export (e.g., invoice, credit note).

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 binary references to the generated ZIP archive containing the vouchers.

If the "Download" option is enabled, the node may output binary data corresponding to the ZIP file, allowing downstream nodes to handle the file (e.g., save locally, upload elsewhere).

Dependencies

  • Requires an active connection to the sevDesk API via an API key credential.
  • The base URL for API requests is https://my.sevdesk.de/api/ with versioning handled dynamically.
  • No additional external dependencies beyond the sevDesk API and its authentication.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect date formats for start/end dates may lead to errors or empty exports.
    • Using unsupported or misspelled voucher types in the "Types" property can cause the export to fail or return no data.
    • Network connectivity issues can interrupt the export process.

  • 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 might include authentication errors, invalid parameters, or job not found when using a Job ID.

  • Resolutions:

    • Verify API credentials and permissions.
    • Ensure date strings follow expected formats (ISO 8601 recommended).
    • Double-check voucher type names against sevDesk documentation.
    • Use the Job ID only after confirming the job exists and is accessible.

Links and References

Discussion