sevDesk icon

sevDesk

Consume the sevDesk API

Overview

The node integrates with the sevDesk API to export voucher data as CSV files. It is designed to facilitate automated extraction of accounting vouchers, which can be useful for bookkeeping, auditing, or financial reporting purposes. Typical use cases include exporting vouchers within a specific date range, filtering by types, and optionally including related documents or metadata.

For example, an accountant might use this node to export all vouchers from the last month as CSV files to import into another accounting system or to archive them.

Properties

Name Meaning
Options A collection of optional parameters to customize the export behavior:
- Archive Documents Whether to archive the exported documents (true/false).
- Download Whether to download the exported file immediately (true/false).
- End Date The end date for the export period (string, e.g., "2024-06-30").
- Enshrine Documents Whether to enshrine (securely store) the documents (true/false).
- Export By Payday Whether to export vouchers 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 XML representation of documents 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 for the export period (string, e.g., "2024-06-01").
- Stateless Whether the export should be stateless (true/false).
- Types Comma-separated list of voucher types 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(s), allowing further processing or saving within n8n workflows.

Dependencies

  • Requires an API key credential for authenticating with the sevDesk API.
  • The node communicates with the sevDesk API endpoint at https://my.sevdesk.de/api/.
  • Environment configuration validation is performed before execution to ensure necessary environment variables or settings are correctly set.

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 invalid or unsupported voucher types in the "Types" field could result in no data being returned.
    • 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 message field.
    • If "Continue On Fail" is enabled, the node will not stop on errors but instead output error details per item.
    • To resolve errors, verify API credentials, check parameter formats, and ensure the sevDesk service is reachable.

Links and References

Discussion