sevDesk icon

sevDesk

Consume the sevDesk API
Join our community

Actions98

Overview

The node integrates with the sevDesk API to perform various export-related operations. Specifically, the "Get Job Download Info" operation under the "Export" resource retrieves information about a job's downloadable export data. This is useful for workflows that automate the retrieval of export job statuses or download links after initiating exports in sevDesk.

Practical scenarios include:

  • Automatically checking the status and download availability of an export job.
  • Retrieving metadata or URLs needed to download exported accounting documents or reports.
  • Integrating sevDesk export jobs into larger automation pipelines where export results are processed further.

Properties

Name Meaning
Archive Documents Whether to archive the documents related to the export job (boolean).
Download Whether to trigger a download action for the export job (boolean).
End Date The end date filter for the export job (string, typically a date).
Enshrine Documents Whether to enshrine (securely store) the documents (boolean).
Export By Payday Whether to export data grouped by payday (boolean).
Hash A hash string used for validation or identification of the export job (string).
Include Document XML Whether to include document XML files in the export (boolean).
Include Enshrined Whether to include enshrined documents in the export (boolean).
Include Exported Documents Whether to include already exported documents (boolean).
Job ID The identifier of the export job to retrieve information for (string).
Sev Query A query string parameter for filtering or specifying details in the export job (string).
Start Date The start date filter for the export job (string, typically a date).
Stateless Whether the export job should be treated statelessly (boolean).
Types A string specifying types of documents or data to include in the export.

Output

The node outputs JSON data containing the information retrieved about the export job's downloadable content. This typically includes metadata such as job status, available download URLs, file hashes, timestamps, and other relevant details provided by the sevDesk API.

If the "Download" option is enabled, the node may also handle binary data representing the actual exported files, but this is not explicitly detailed in the static code.

Dependencies

  • Requires an API key credential for authenticating with the sevDesk API.
  • The base URL for API requests is https://my.sevdesk.de/api/ combined with the API version specified in credentials.
  • The node depends on internal modules managing resource operations and validation schemas, which handle communication with sevDesk endpoints.

Troubleshooting

  • Common issues:

    • Invalid or missing API authentication token can cause authorization errors.
    • Incorrect or missing Job ID will result in failure to retrieve export job info.
    • Date format errors in Start Date or End Date parameters may cause request failures.
    • Using incompatible combinations of options (e.g., enabling both Archive and Stateless) might lead to unexpected behavior depending on API constraints.

  • Error messages:

    • Errors returned from the API are caught and can be output as JSON error objects if "Continue On Fail" is enabled.
    • Typical error messages include authorization failures, invalid parameters, or job not found.

  • Resolution tips:

    • Verify API credentials and permissions.
    • Double-check Job ID and date formats.
    • Use the node’s "Continue On Fail" option during testing to capture error details without stopping workflow execution.

Links and References

Discussion