Dokumente - API-Referenz - PlanDocket Dokumentation

Endpunkte

GET


                    /api/v1/documents

Alle Dokumente auflisten

GET


                    /api/v1/documents/{id}

Einzelnes Dokument abrufen

POST


                    /api/v1/documents

Neues Dokument generieren

PUT/PATCH


                    /api/v1/documents/{id}

Dokument ändern: Inhalt (HTML, wird wie im Editor bereinigt), metadata und bei Verträgen der Vertragsstatus. Gesperrte Dokumente (unterschrieben, zur Unterschrift versendet, aktiver Vertrag) erlauben nur noch zulässige Statuswechsel (z. B. aktiv -> beendet), sonst 409

DELETE


                    /api/v1/documents/{id}

Dokument löschen wie in der Verwaltung (offene Abrechnungspositionen der Dokumentpositionen werden storniert, eine ersetzte Standgebühr wird wiederhergestellt). Gesperrte Dokumente: 409

GET


                    /api/v1/documents/{id}/pdf

Dokument als PDF herunterladen. variant=auto (Standard) liefert bei elektronisch unterschriebenen Verträgen das unterschriebene PDF, sonst das erzeugte PDF; variant=signed oder variant=generated erzwingt eine Variante. Der Header X-Document-Variant sagt, welche geliefert wurde

Abfrageparameter

Parameter	Beschreibung
`entity_type`	Nach Entitätstyp filtern
`entity_id`	Nach Entitäts-ID filtern
`category_id`	Nach Dokumentenkategorie-ID filtern
`is_contract`	Nach Vertragsstatus filtern (0 oder 1)
`contract_status`	Nach Vertragsstatuswert filtern
`esign_status`	Nach E-Signatur-Status filtern
`sort`	Sortierfeld (document_number, created_at, updated_at, contract_status, esign_status)
`order`	Sortierrichtung (ASC oder DESC, Standard: DESC)
`include`	Verknüpfte Daten einschließen (line_items)

Request-Schema

Anlegen (POST)

Parameter	Typ	Erforderlich	Beschreibung
`entity_type`	string	Ja	Entitätstyp für das Dokument (erforderlich; derzeit nur event_participant)
`entity_id`	integer	Ja	Entitäts-ID für das Dokument (erforderlich; ein nicht vorhandener Datensatz ergibt 404)
`template_id`	integer	Nein	Dokumentvorlagen-ID (erforderlich wenn keine category_id). Genau diese aktive Vorlage wird verwendet; wird zusätzlich category_id angegeben, muss die Vorlage zu dieser Kategorie gehören
`category_id`	integer	Nein	Dokumentkategorie-ID (erforderlich wenn keine template_id). Ohne template_id wird die erste Vorlage gewählt, deren Bedingungen zutreffen, sonst die Standardvorlage
`metadata`	object	Nein	Zusätzliche Metadaten als Schlüssel-Wert-Paare

Ändern (PATCH)

Parameter	Typ	Erforderlich	Beschreibung
`content`	string	Nein	Neuer Inhalt als HTML (nicht erlaubte Elemente wie Skripte werden entfernt; leerer Inhalt: 422). Nur bei nicht gesperrten Dokumenten
`metadata`	object\|null	Nein	Zusatzdaten als JSON-Objekt (höchstens 64 KB); null entfernt sie. Nur bei nicht gesperrten Dokumenten
`contract_status`	string	Nein	Vertragsstatus (draft, pending_signature, active, terminated); nur bei Verträgen. Bei gesperrten Verträgen nur die erlaubten Schritte, die Antwort 409 nennt sie in "allowed"

Response-Schema

Feld	Typ
`id`	integer
`category_id`	integer\|null
`category_name`	string\|null
`document_number`	string\|null
`entity_type`	string\|null
`entity_id`	integer\|null
`template_id`	integer\|null
`content`	string
`metadata`	object\|null
`esign_status`	string
`is_contract`	boolean
`contract_status`	string\|null
`created_at`	string
`updated_at`	string

Codebeispiele

curl -X GET "https://ihr-mandant.plandocket.com/api/v1/documents" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

<?php
$apiKey = 'YOUR_API_KEY';
$baseUrl = 'https://ihr-mandant.plandocket.com';

$ch = curl_init();
curl_setopt_array($ch, [
    CURLOPT_URL => $baseUrl . '/api/v1/documents',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . $apiKey,
    ],
]);

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);
print_r($data);

const apiKey = 'YOUR_API_KEY';
const baseUrl = 'https://ihr-mandant.plandocket.com';

const response = await fetch(`${baseUrl}/api/v1/documents`, {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${apiKey}`,
  },
});

const data = await response.json();
console.log(data);

import requests

api_key = 'YOUR_API_KEY'
base_url = 'https://ihr-mandant.plandocket.com'

headers = {
    'Authorization': f'Bearer {api_key}',
}

response = requests.get(f'{base_url}/api/v1/documents', headers=headers)
data = response.json()
print(data)

Beispiel-Antwort

200 OK

{
    "data": [
        {
            "id": 1,
            "category_id": 1,
            "category_name": "string",
            "document_number": "string",
            "entity_type": "string",
            "entity_id": 1,
            "template_id": 1,
            "content": "string",
            "metadata": {},
            "esign_status": "string",
            "is_contract": true,
            "contract_status": "string",
            "created_at": "2026-01-15T10:00:00+01:00",
            "updated_at": "2026-01-15T10:00:00+01:00"
        }
    ],
    "meta": {
        "current_page": 1,
        "per_page": 25,
        "total": 1,
        "total_pages": 1
    }
}