sevDesk icon

sevDesk

Consume the sevDesk API

Overview

This node integrates with the sevDesk API to manage contact addresses. Specifically, the "Create" operation under the "Contact Address" resource allows users to add a new address for a contact in their sevDesk account. This is useful for automating the management of contact information, such as adding billing or shipping addresses when new contacts are created or updated.

Practical examples include:

  • Automatically creating a new contact address when onboarding a customer.
  • Syncing address data from another CRM or database into sevDesk.
  • Adding multiple categorized addresses (e.g., billing, shipping) to a single contact programmatically.

Properties

Name Meaning
Contact The contact to which this address belongs. It includes:
Contact ID: Identifier of the contact.
Object Name: Fixed as "Contact".
Street Street name of the contact address.
Zip Code Postal code of the contact address.
City City of the contact address.
Country The country of the contact address. It includes:
Country ID: Identifier of the country (can be retrieved via GET /StaticCountry).
Object Name: Fixed as "StaticCountry".
Category The category of the contact address. It includes:
Category ID: Identifier of the category (retrievable via GET /Category?objectType=ContactAddress).
Object Name: Fixed as "Category".
Name First name or primary name field in the address.
Name 2 Second name field in the address.
Name 3 Third name field in the address.
Name 4 Fourth name field in the address.

Output

The node outputs JSON data representing the response from the sevDesk API after creating the contact address. This typically includes details of the newly created address record, such as its unique ID and all submitted fields.

If an error occurs during execution and "Continue On Fail" is enabled, the output will contain an error object with the message describing the failure.

The node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the sevDesk API.
  • The base URL for API requests is https://my.sevdesk.de/api/{apiVersion}, where {apiVersion} is specified in the credentials.
  • The node depends on internal resource managers and validation schemas initialized at runtime.
  • Environment configuration validation is performed before execution.

Troubleshooting

  • Common issues:

    • Missing or invalid API authentication token can cause authorization errors.
    • Providing incorrect or missing required fields like Contact ID, Country ID, or Category ID may result in API validation errors.
    • Network connectivity problems can lead to request timeouts or failures.
  • Error messages:

    • Errors returned by the API will be included in the output if "Continue On Fail" is enabled.
    • Validation schema initialization errors are logged to the console but do not stop node execution.
  • Resolutions:

    • Ensure the API key credential is correctly configured and has necessary permissions.
    • Verify that all required fields are provided and valid according to sevDesk API documentation.
    • Check network connectivity and retry failed requests.

Links and References

  • sevDesk API Documentation
  • Endpoint references mentioned in properties:
    • /StaticCountry for retrieving countries
    • /Category?objectType=ContactAddress for retrieving categories

Discussion