sevDesk icon

sevDesk

Consume the sevDesk API

Overview

The node integrates with the sevDesk API to start a DATEV CSV Zip export process. This operation is useful for users who want to export accounting data in the DATEV format, which is commonly used in German accounting systems for tax and bookkeeping purposes. The node initiates the export job on the sevDesk platform, allowing users to specify various options such as date ranges, document inclusion, and export types.

Practical examples include:

  • Automating monthly export of accounting vouchers and invoices for tax filing.
  • Exporting specific document types within a custom date range.
  • Including or excluding archived or enshrined documents based on business needs.

Properties

Name Meaning
Options A collection of optional parameters to customize the export:
- Archive Documents Whether to archive the documents after export (true/false).
- Download Whether to download the export immediately (true/false).
- End Date The end date for the export period (string, e.g., "YYYY-MM-DD").
- Enshrine Documents Whether to enshrine documents during export (true/false).
- Export By Payday Whether to export data grouped by payday (true/false).
- Hash A hash string related to the export job (string).
- Include Document XML Whether to include document XML files in the export (true/false).
- Include Enshrined Whether to include enshrined documents in the export (true/false).
- Include Exported Documents Whether to include documents that have already been exported (true/false).
- Job ID Identifier for an existing export job (string).
- Sev Query A query string parameter for filtering or searching (string).
- Start Date The start date for the export period (string, e.g., "YYYY-MM-DD").
- Stateless Whether the export should be stateless (true/false).
- Types Types of documents to export, specified as a string (e.g., invoice, voucher).

Output

The node outputs JSON data representing the result of the export operation. This typically includes information about the export job status, identifiers, and possibly URLs or hashes for downloading the exported ZIP file containing the DATEV CSV data.

If the "Download" option is enabled, the output may also include binary data representing the actual ZIP file content.

Dependencies

  • Requires an active connection to the sevDesk API via an API key credential.
  • The node expects the environment configuration to be validated before execution.
  • No additional external dependencies beyond the sevDesk API are required.

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.
    • Specifying incompatible options together (e.g., "Archive Documents" with "Stateless") might cause unexpected behavior.
    • Network issues or sevDesk API downtime can interrupt the export process.
  • Error Messages:

    • Errors returned from the API will be captured and can appear in the output JSON under an "error" field if "Continue On Fail" is enabled.
    • Validation errors related to input parameters may occur if dates or types are malformed; ensure correct formatting.
  • Resolution Tips:

    • Verify API credentials and permissions.
    • Use ISO date format strings ("YYYY-MM-DD") for date fields.
    • Review sevDesk API documentation for valid values of "Types" and other options.
    • Enable "Continue On Fail" cautiously to handle partial failures gracefully.

Links and References

Discussion