sevDesk icon

sevDesk

Consume the sevDesk API

Overview

This node integrates with the sevDesk API to manage Credit Notes, specifically allowing you to "book" a credit note. Booking a credit note typically means recording or finalizing it in the accounting system, which is essential for accurate financial tracking and reporting.

Common scenarios where this node is beneficial include:

  • Automating the booking of credit notes after they are created or updated.
  • Integrating sevDesk credit note management into broader workflows such as invoicing, payment reconciliation, or financial audits.
  • Ensuring that credit notes are properly recorded on specific dates with correct amounts and account details.

For example, you might use this node to book a credit note with a specified amount and date, linking it to a particular check account, thereby automating part of your bookkeeping process.

Properties

Name Meaning
Credit Note ID The unique identifier of the credit note to be booked. This is required to specify which credit note to book.
Booking Data A collection of data related to the booking operation:
- Amount The monetary amount to be booked for the credit note.
- Date The date when the booking should be recorded (typically in string format, e.g., "YYYY-MM-DD").
- Type The type/category of the booking (string).
- Check Account A nested collection specifying the check account details associated with the booking:
-- ID The identifier of the check account to link the booking to.
-- Object Name The object name, defaulting to "CheckAccount", indicating the type of linked account object.

Output

The node outputs an array of JSON objects corresponding to each input item processed. Each output JSON contains the response from the sevDesk API for the booking operation on the credit note. If an error occurs and the node is configured to continue on failure, the output will contain an error field with the error message for the respective item.

No binary data output is indicated for this operation.

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 specified in credentials.
  • Environment configuration validation is performed before execution.
  • No additional external dependencies beyond the sevDesk API and its authentication.

Troubleshooting

  • Common Issues:

    • Missing or invalid Credit Note ID will cause the operation to fail.
    • Incorrect or incomplete booking data (e.g., missing amount or date) may result in API errors.
    • Network or authentication issues with the sevDesk API can prevent successful booking.
  • Error Messages:

    • Errors returned by the API are captured and included in the output if "continue on fail" is enabled.
    • Typical error messages might relate to authorization failures, invalid parameters, or resource not found.
  • Resolution Tips:

    • Ensure the Credit Note ID is correct and exists in sevDesk.
    • Verify all required booking data fields are provided and correctly formatted.
    • Confirm that the API key credential is valid and has sufficient permissions.
    • Check network connectivity and sevDesk service status.

Links and References

Discussion