sevDesk icon

sevDesk

Consume the sevDesk API
Join our community

Actions98

Overview

This node integrates with the sevDesk API to export transaction data as CSV files. It is designed to facilitate automated extraction of financial transaction records from sevDesk, a popular accounting software. Typical use cases include exporting transaction data for accounting audits, financial reporting, or integration with other systems that require CSV-formatted transaction data.

For example, a user might configure this node to export all transactions within a specific date range, optionally including archived documents or additional XML data, and then download the resulting CSV file for further processing or storage.

Properties

Name Meaning
Options A collection of optional parameters to customize the export behavior:
- Archive Documents Whether to archive the exported documents (true/false).
- Download Whether to download the exported CSV file immediately (true/false).
- End Date The end date for the export period, formatted as a string (e.g., "YYYY-MM-DD").
- Enshrine Documents Whether to enshrine (securely store) the documents (true/false).
- Export By Payday Whether to export transactions grouped by payday (true/false).
- Hash A hash string used for validation or identification purposes during export.
- Include Document XML Whether to include the document XML data 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 a specific export job, useful for tracking or resuming exports.
- Sev Query A query string to filter or specify particular data for export.
- Start Date The start date for the export period, formatted as a string (e.g., "YYYY-MM-DD").
- Stateless Whether to perform the export operation statelessly (true/false), possibly affecting how state or session data is handled.
- Types A string specifying types of transactions or documents to export.

Output

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

If the Download option is enabled, the node may also handle binary data corresponding to the downloaded CSV file, allowing subsequent nodes to process or save the file directly.

Dependencies

  • Requires an active connection to the sevDesk API, authenticated via an API key credential.
  • The node expects the environment to be configured properly for API access, including any necessary environment variables 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 for Start Date or End Date may cause the export to fail or return no data.
    • Using incompatible combinations of options (e.g., enabling both Archive Documents and Stateless) might lead to unexpected behavior.
    • Network connectivity issues can interrupt the export process.

  • Error Messages:

    • Errors returned from the API are captured and included in the output JSON under an error field if the node is set to continue on failure.
    • Common error messages relate to authentication failures, invalid parameters, or server-side errors from sevDesk.

  • Resolution Tips:

    • Verify API credentials and permissions.
    • Ensure date strings conform to expected formats.
    • Review option combinations for logical consistency.
    • Check network connectivity and retry failed operations.

Links and References

Discussion