sevDesk icon

sevDesk

Consume the sevDesk API
Join our community

Actions98

Overview

This node interacts with the sevDesk API to generate a download hash for export operations. The "Generate Download Hash" operation under the "Export" resource is designed to create a secure hash that can be used to authenticate or verify the download of exported data from sevDesk.

Typical use cases include:

  • Automating the retrieval of export files by generating a valid download hash.
  • Integrating sevDesk export functionality into workflows where secure access to exported documents is required.
  • Managing export jobs programmatically, ensuring that downloads are authorized and traceable.

For example, a user might trigger this node after initiating an export job to obtain a download hash, which can then be used in subsequent steps to securely download the exported data.

Properties

Name Meaning
Options A collection of optional parameters to customize the export hash generation:
- Archive Documents Boolean flag to indicate if documents should be archived.
- Download Boolean flag to specify if the export should be downloaded immediately.
- End Date String representing the end date for the export range.
- Enshrine Documents Boolean flag to enshrine (securely store) documents.
- Export By Payday Boolean flag to export data grouped by payday.
- Hash String input for an existing hash value, if applicable.
- 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 for the export job.
- Sev Query String query parameter for filtering or specifying export details.
- Start Date String representing the start date for the export range.
- Stateless Boolean flag indicating if the export should be stateless (not retaining session state).
- Types String specifying types of documents or data to include in the export.

Output

The node outputs JSON data containing the result of the "Generate Download Hash" operation. This typically includes the generated hash string and any related metadata returned by the sevDesk API.

If the operation involves binary data (e.g., actual export files), the node would handle it accordingly, but based on the provided code and properties, the primary output is JSON with the download hash information.

Dependencies

  • Requires an active connection to the sevDesk API via an API key credential.
  • The node depends on the SevDeskResourceManager class to manage API requests and execute resource operations.
  • 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 or missing job IDs or hash values may result in errors from the sevDesk API.
    • Date format errors in "Start Date" or "End Date" fields could lead to failed requests.

  • Error Messages:

    • Errors thrown during execution are caught; if "Continue On Fail" is enabled, error messages are included in the output JSON under an error field.
    • Typical error messages relate to invalid parameters or API request failures. Users should verify all input properties and ensure API connectivity.

Links and References

Note: This summary is based solely on static analysis of the provided source code and property definitions without runtime execution.

Discussion