DATEVconnect Integration with Klardaten

2024-10-01

Practical DATEV Integration with Klardaten's API

Integrating DATEV with your systems shouldn’t be a hassle. At Klardaten, we understand the challenges of working with traditional DATEVconnect setups—rate limits, setup complexities, and the lack of internet accessibility can slow you down. That’s why we designed our API to make data exchange between DATEV and your applications faster, simpler, and more secure.

What’s DATEVconnect?

DATEVconnect is an interface that allows automatic, two-way data exchange between DATEV programs and external applications. This integration is crucial in accounting, payroll, and document management. However, setting up and maintaining DATEVconnect can be tricky. It’s not accessible over the internet by default, and existing solutions impose strict rate limits that can cause delays. At Klardaten, we solve these issues with a powerful API that makes DATEV more flexible, scalable, and efficient.

Simple Setup with Klardaten API Connector

To integrate DATEV with Klardaten’s API, all you need is to follow these simple steps:

Register Your User: Sign up on the Klardaten platform by creating your user account.
Register a DATEV Client Instance: Once your account is registered, you’ll create a DATEV client instance by providing your Beraternummer (advisor number). This step connects the DATEV system to our platform.
Install the API Connector: Install the Klardaten API connector on the same Windows machine where you installed DATEVconnect. The installation is straightforward, guided by an easy-to-follow setup wizard.

Should you run into any issues during setup, our support team is always available to assist you.

Example Use Cases with API Requests

Let’s look at how you can use our API in practice.

Access Token and Instance ID Requirements

Before executing the examples below, you must obtain an access token by registering or logging in. You will use this token to authenticate the API requests. Additionally, upon creating a client instance, you will receive an instance_id in the response, which must be included in the request header x-client-instance-id for further API communication.

Register User

curl -X POST "https://api.klardaten.com/api/auth/register" \
     -H "Content-Type: application/json" \
     -d '{
           "email": "test@user.com",
           "password": "!Not-Too-Secure-Password-123"
         }'

The response will include an access token.

Create Instance

curl -X POST "https://api.klardaten.com/api/client-instances" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer {{accessToken}}" \
     -d '{
           "name": "My Datev instance",
           "beraternummer": "1234567"
         }'

Example JSON response:

{
  "id": "c11197b0-b7e3-47da-a8ea-c14ff4407b30",
  "name": "My Datev instance",
  "beraternummer": "1234567",
  "status": "UP"
}

Now that you have both the access token and the client instance ID, you can proceed with the examples below to interact with the Klardaten API. Ensure that your Authorization header contains the access token and the x-client-instance-id header includes the instance ID for all requests.

Below are two common API requests for interacting with DATEV data.

Example 1: Retrieve Client Data

Here’s a simple curl request to retrieve a list of clients from DATEVconnect:

curl -X GET "https://api.klardaten.com/datevconnect/master-data/v1/clients" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer {{accessToken}}" \
     -H "x-client-instance-id: c11197b0-b7e3-47da-a8ea-c14ff4407b30"

This request pulls client data, which you can use to automate accounting or client management workflows. Here, you find the content of a single entry in the JSON response:

[
  {
    "id": "d13f9c3c-380c-494e-97c8-d12fff738189",
    "client_since": "1999-04-15T00:00:00.000",
    "client_to": "2019-03-31T00:00:00.000",
    "differing_name": "Abweichender Mustermeier",
    "legal_person_id": "fd3b2877-7505-4811-a53f-cd1c28ef627c",
    "name": "Mustermeier GmbH",
    "note": "Notiz zu Mandant 10000",
    "number": 10000,
    "status": "active",
    "timestamp": "2017-03-31T10:03:11.107",
    "type": "legal_person",
    "organization_id": "f43f9c3g-380c-494e-97c8-d12fff738180",
    "organization_name": "Musterkanzlei",
    "organization_number": "1",
    "establishment_id": "h63f9c3g-380c-494e-97c8-d12fff738180",
    "establishment_name": "Musterkanzlei - Hauptsitz",
    "establishment_number": "1",
    "establishment_short_name": "Hauptsitz",
    "functional_area_id": "g93e8c3g-380c-494e-97c8-d12fff738371",
    "functional_area_name": "Gesamtunternehmen",
    "functional_area_short_name": "999"
  }
]

Example 2: Retrieve Documents

Do you need to retrieve documents from DATEV? Here’s how you can do that with our API and DATEVconnect:

curl -X GET "https://api.klardaten.com/datevconnect/dms/v2/documents" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer {{accessToken}}" \
     -H "x-client-instance-id: c11197b0-b7e3-47da-a8ea-c14ff4407b30"

Here’s an example of the content of the JSON response for a single document:

[
  {
    "id": "e602ddcb-e479-4cee-b268-e53bbecf6dc9",
    "amount": "150,95",
    "cost_quantity": 1.25,
    "extension": "docx",
    "number": 3001,
    "year": 2021,
    "application": "KARE",
    "case_number": -2147483648,
    "change_date_time": "2021-04-28T14:03:58.310",
    "checked_out": false,
    "class": {
      "name": "Dokument",
      "id": 1
    },
    "correspondence_partner_guid": "e602ddcb-e479-4cee-b268-e53bbecf6dc9",
    "cost_date": "2020-12-10T00:00:00",
    "cost_number1": 1000,
    "cost_number2": 2000,
    "create_date_time": "2021-04-28T14:03:58.310",
    "description": "Eingangsrechnung 19.01.2021",
    "employee": {
      "name": "Mustermann, Max",
      "is_active": true,
      "id": 11
    },
    "folder": {
      "name": "Stammakte",
      "id": "3"
    },
    "keywords": "These, are, keywords",
    "state": {
      "name": "offen",
      "id": "5"
    },
    "acknowledge_by": [
      {
        "name": "Mustermann, Bob",
        "removed_acknowledgement": "2021-03-04T14:03:58.310",
        "acknowledged": "2021-03-04T14:03:58.310",
        "is_deleted": false,
        "id": "35e98168-01dd-4104-a273-79e38b3c3b22"
      }
    ]
  }
]

These examples show how easy it is to retrieve DATEV data and documents using our API. Our API gives you the power to automate various tax-related tasks and manage data efficiently.

Support and Documentation

One of the most frequent concerns when implementing new systems is the ease of setup and support. At Klardaten, we prioritize making our integration as straightforward as possible. Our setup wizard ensures the installation process is quick and simple, but our support team is always ready to assist if you encounter any issues.

We also provide detailed, step-by-step documentation to guide you through the installation, API usage, and troubleshooting processes. Whether you’re a technical expert or just getting started with APIs, our guides cover everything you need to know to make your integration work smoothly.

Why Use Klardaten’s API?

Our API addresses common issues that many businesses face with DATEVconnect. Let’s dive into the key improvements we offer:

Optimized Rate Limits: We’ve designed our API to handle larger volumes of requests without running into rate limits that slow down your operations. Whether importing financial records or handling payroll data, you can rely on consistent performance.
Fast Response Times: Slow data retrieval can severely impact productivity. With Klardaten, your data flows faster, minimizing the time spent waiting for server responses.
Secure Internet-Based Access: DATEVconnect isn’t accessible over the internet by default, which can complicate remote access or cloud-based operations. With Klardaten, we provide secure internet-based access to your DATEV data, unlocking greater flexibility.
Focus on What Matters: Instead of spending time navigating technical challenges, our API simplifies DATEV integration so you can focus on delivering value to your clients.

Ready to Get Started?

Integrating DATEV with your systems is now easier than ever. With just a few steps, you can have Klardaten’s API up and running, allowing you to streamline your workflows and make your processes more efficient. Stay ahead in the ever-evolving tax tech landscape with a solution built for scalability and long-term success.