sevDesk icon

sevDesk

Consume the sevDesk API

Overview

This node integrates with the sevDesk API to export credit note data as CSV files. It is designed to facilitate automated extraction of credit note information from sevDesk accounting software, enabling users to generate CSV exports for further processing, reporting, or archival purposes.

Common scenarios where this node is beneficial include:

  • Automating financial workflows by exporting credit notes in CSV format for import into other systems.
  • Generating periodic reports of credit notes within specified date ranges.
  • Archiving credit note data externally while optionally including related documents or metadata.

Practical example:

  • A user wants to export all credit notes issued between two dates as a CSV file and download it automatically for review or integration with another accounting system.

Properties

Name Meaning
Options Collection of optional parameters controlling the export behavior:
- Archive Documents: Whether to archive associated documents.
- Download: Whether to download the exported CSV immediately.
- End Date: The end date for filtering credit notes.
- Enshrine Documents: Whether to enshrine (preserve) documents.
- Export By Payday: Export data grouped by payday.
- Hash: A hash string used for validation or identification.
- Include Document XML: Include document XML data in the export.
- Include Enshrined: Include enshrined documents.
- Include Exported Documents: Include documents that have already been exported.
- Job ID: Identifier for an export job.
- Sev Query: Custom query string for filtering.
- Start Date: The start date for filtering credit notes.
- Stateless: Whether the export should be stateless.
- Types: Types of credit notes to include in the export.

Output

The node outputs JSON data representing the result of the export operation. This typically includes metadata about the export job, status, and potentially URLs or references to the generated CSV file.

If the "Download" option is enabled, the node may also handle binary data corresponding to the CSV file content, allowing direct file download or further binary processing downstream.

Dependencies

  • Requires an active connection to the sevDesk API via an API key credential.
  • The node expects environment configuration validated at runtime.
  • No additional external dependencies beyond the sevDesk API are indicated.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will prevent successful communication with sevDesk.
    • Incorrect date formats in "Start Date" or "End Date" options may cause errors or empty exports.
    • Requesting unsupported export types or invalid job IDs can lead to failures.
  • Error messages:

    • Errors returned from the API are captured and included in the output JSON under an error field when "Continue On Fail" is enabled.
    • Typical error messages relate to authentication failures, invalid parameters, or network issues.
  • Resolutions:

    • Verify API credentials and permissions.
    • Ensure date strings conform to expected formats (usually ISO 8601).
    • Check that job IDs and queries are valid and correspond to existing data.

Links and References

Discussion