sevDesk icon

sevDesk

Consume the sevDesk API
Join our community

Actions98

Overview

The node interacts with the sevDesk API to retrieve the progress status of an export job. This is useful for monitoring long-running export operations, such as exporting invoices, vouchers, or other financial documents from sevDesk. Users can check how far along an export process is, enabling automation workflows that depend on the completion of these exports.

Practical examples include:

  • Automatically polling the export progress until it completes before triggering a download.
  • Integrating export progress checks into larger accounting or ERP workflows.
  • Conditional logic based on whether an export job has finished or is still in progress.

Properties

Name Meaning
Options A collection of optional parameters to customize the export progress request:
- Archive Documents Boolean flag to indicate if documents should be archived.
- Download Boolean flag to indicate if the export should be downloaded.
- End Date String representing the end date filter for the export.
- Enshrine Documents Boolean flag to enshrine documents (preserve them in a special state).
- Export By Payday Boolean flag to export data grouped by payday.
- Hash String hash value related to the export job, possibly for validation or identification.
- Include Document XML Boolean flag to include document XML data in the export.
- Include Enshrined Boolean flag to include enshrined documents in the export.
- Include Exported Documents Boolean flag to include already exported documents.
- Job ID String identifier of the export job whose progress is being queried.
- Sev Query String query parameter specific to sevDesk filtering or searching.
- Start Date String representing the start date filter for the export.
- Stateless Boolean flag indicating if the operation should be stateless.
- Types String specifying types of documents or data to include in the export.

Output

The node outputs JSON data representing the current progress status of the specified export job. The structure typically includes details such as percentage completed, current step, and any relevant metadata about the export process.

If the export involves binary data (e.g., downloadable files), this node focuses on progress status only and does not output binary content directly.

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 API version configured in credentials.
  • No additional external dependencies beyond the sevDesk API and its authentication.

Troubleshooting

  • Common Issues:

    • Invalid or missing Job ID: The node requires a valid export job identifier; otherwise, the API call will fail.
    • Network or authentication errors: Ensure the API key credential is correctly configured and has sufficient permissions.
    • Incorrect date formats in Start Date or End Date fields may cause API rejections.

  • Error Messages:

    • Errors returned from the API are passed through; typical messages might include "Job not found" or "Unauthorized".
    • If the node throws an error about environment configuration, verify that all required environment variables and API versions are set properly.

  • Resolution Tips:

    • Double-check the Job ID and other option parameters.
    • Confirm API credentials and network connectivity.
    • Use the continue-on-fail option to handle intermittent failures gracefully.

Links and References

Discussion