sevDesk icon

sevDesk

Consume the sevDesk API

Overview

This node integrates with the sevDesk API to perform various operations on different resources. Specifically, for the Contact resource and the Check Customer Number Availability operation, it checks whether a given customer number is available or already in use within the sevDesk system. This is useful when you want to validate customer numbers before creating or updating contact records to avoid duplicates.

Practical examples include:

  • Validating a new customer's number during onboarding to ensure uniqueness.
  • Automating data entry workflows where customer numbers must be verified before proceeding.
  • Integrating with external systems that require confirmation of customer number availability in sevDesk.

Properties

Name Meaning
Customer Number The customer number to be checked for availability (string).

Output

The node outputs JSON data representing the result of the availability check. Typically, this will indicate whether the customer number exists or is free to use. If an error occurs, the output JSON will contain an error field with the error message.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating with the sevDesk API.
  • The node depends on the sevDesk API endpoint at https://my.sevdesk.de/api/.
  • Environment configuration validation is performed before execution.
  • Validation schemas are initialized at runtime to ensure request correctness.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Providing an empty or malformed customer number may lead to errors from the API.
    • Network connectivity problems can prevent successful API calls.
  • Error messages:

    • Errors returned by the API are captured and included in the output JSON under the error key.
    • If the node is set to continue on failure, errors do not stop execution but are reported per item.
    • To resolve errors, verify API credentials, ensure valid input values, and check network access.

Links and References

Discussion