PlanDocket

Zahlungserinnerungen

Business+

Versendete Zahlungserinnerungen und Mahnungen lesen, z. B. um die Mahnstufe neben einem offenen Posten in der Buchhaltung anzuzeigen. Versendet werden sie im Mahnlauf oder an der Rechnung in der Verwaltung.

Nur Lesen Dieser Endpunkt unterstützt nur GET-Anfragen.
Erforderliche Bereiche: invoices
Zugriffsstufe: GET invoices:read Mehr zu Zugriffsstufen
Feature-Flag: invoices

Endpunkte

GET /api/v1/payment-reminders

Alle Zahlungserinnerungen auflisten (neueste zuerst)

GET /api/v1/payment-reminders/{id}

Einzelne Zahlungserinnerung mit Textvorschau abrufen

Abfrageparameter

Parameter Beschreibung
invoice_id Nur Erinnerungen dieser Rechnung (ID)
invoice_number Nur Erinnerungen dieser Rechnung (Rechnungsnummer)
reminder_type Stufe: first, second, final oder legal
level Mahnstufe als Zahl (1, 2, 3 ...)
date_from Versendet ab (YYYY-MM-DD oder ISO 8601)
date_to Versendet bis (YYYY-MM-DD oder ISO 8601)
sort Sortierfeld (sent_at, level, created_at, reminder_id; Standard sent_at absteigend)
order Sortierrichtung (ASC oder DESC, Standard: DESC)

Response-Schema

Feld Typ
id integer
invoice_id integer
invoice_number string|null
invoice_status string|null
event_participant_id integer|null
contact_id integer|null
reminder_type string
reminder_type_label string|null
level integer|null
fee_amount float
currency string
due_date string|null
dunning_stopped boolean
sent_at string|null
sent_to string|null
sent_via string|null
subject string|null
created_at string
template_key string|null (show only)
message_preview string|null (show only)

Codebeispiele

curl -X GET "https://ihr-mandant.plandocket.com/api/v1/payment-reminders" \
  -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/payment-reminders',
    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/payment-reminders`, {
  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/payment-reminders', headers=headers)
data = response.json()
print(data)

Beispiel-Antwort

200 OK
{
    "data": [
        {
            "id": 1,
            "invoice_id": 1,
            "invoice_number": "string",
            "invoice_status": "string",
            "event_participant_id": 1,
            "contact_id": 1,
            "reminder_type": "string",
            "reminder_type_label": "string",
            "level": 1,
            "fee_amount": 100,
            "currency": "string",
            "due_date": "2026-01-15T10:00:00+01:00",
            "dunning_stopped": true,
            "sent_at": "2026-01-15T10:00:00+01:00",
            "sent_to": "string",
            "sent_via": "string",
            "subject": "string",
            "created_at": "2026-01-15T10:00:00+01:00",
            "template_key": "string",
            "message_preview": "string"
        }
    ],
    "meta": {
        "current_page": 1,
        "per_page": 25,
        "total": 1,
        "total_pages": 1
    }
}
API Version v1.0