sevDesk icon

sevDesk

Consume the sevDesk API

Overview

The node integrates with the sevDesk API, allowing users to perform various operations on sevDesk resources. Specifically, for the Contact resource with the Get operation, it retrieves detailed information about a specific contact by its unique identifier. This is useful in scenarios where you need to fetch contact details for further processing, reporting, or synchronization with other systems.

Practical examples include:

  • Fetching customer details before creating an invoice.
  • Retrieving contact information to update records in a CRM.
  • Accessing contact data for validation or enrichment workflows.

Properties

Name Meaning
Contact ID The unique identifier of the contact to retrieve. This is a required string input.

Output

The node outputs JSON data representing the retrieved contact's details as returned by the sevDesk API. The structure typically includes fields such as contact name, address, communication details, and any custom fields associated with the contact.

If the node encounters an error (e.g., invalid Contact ID), it outputs a JSON object containing an error field with the error message.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the sevDesk API.
  • The base URL for API requests is https://my.sevdesk.de/api/ appended with the API version specified in credentials.
  • The node depends on internal resource management and validation modules bundled within the node implementation.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent Contact ID will result in an error response from the API.
    • Missing or incorrect API authentication credentials will cause authorization failures.
    • Network connectivity problems can prevent successful API calls.
  • Error messages:

    • Errors returned from the API are captured and output as JSON with an error property.
    • If the node is configured to continue on failure, errors for individual items do not stop execution but are included in the output for review.
  • Resolutions:

    • Verify that the Contact ID is correct and exists in sevDesk.
    • Ensure the API key credential is valid and has appropriate permissions.
    • Check network settings and firewall rules to allow outbound HTTPS requests to sevDesk.

Links and References

Discussion