Mahnung anzeigen

Gibt die Details einer einzelnen Mahnung zurück.

Benötigte Lizenz

Dieser Endpoint erfordert das Add-on Mahnwesen.

Request

GET /api/oauth/v2/resource/invoices/dunnings/{uuid}

Header

Header	Wert
Authorization	Bearer {access_token}

URL-Parameter

Parameter	Typ	Pflicht	Beschreibung
uuid	string	Ja	Eindeutige ID der Mahnung

Erforderlicher Scope: dunnings

Response

Erfolg (200 OK)

{
  "data": {
    "id": "c3d4e5f6-a7b8-9012-cdef-234567890123",
    "invoice": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "customer": "f0e1d2c3-b4a5-6789-fedc-ba9876543210",
    "status": "active",
    "text": "Sehr geehrte Damen und Herren, wir erlauben uns, Sie an die folgende offene Rechnung zu erinnern.",
    "printedStatus": "unprinted",
    "paidStatus": "open",
    "dunningType": "7f8e9d0c-1b2a-3456-789a-bcdef0123456",
    "fee": "12.00",
    "latePaymentInterestRate": "4.00",
    "paymentDeadline": 14,
    "totalAmount": "122.35",
    "outstandingTotal": "122.35",
    "totalFee": "12.00",
    "outstandingFee": "12.00",
    "totalInterest": "0.35",
    "outstandingInterest": "0.35",
    "invoiceOutstandingBalance": "110.00",
    "interestCalculateStartDate": "2026-06-16",
    "interestCalculateEndDate": "2026-07-15",
    "createdAt": "2026-07-15T09:00:00+02:00",
    "updatedAt": "2026-07-15T09:00:00+02:00",
    "createdBy": "1a2b3c4d-5e6f-7890-abcd-ef1234567890",
    "updatedBy": "1a2b3c4d-5e6f-7890-abcd-ef1234567890",
    "deleted": false,
    "deletedAt": null,
    "deletedBy": null,
    "tenancy": "9a8b7c6d-5e4f-3210-9876-543210fedcba"
  }
}

Hinweis: Eine ersetzte oder stornierte Mahnung liefert weiterhin 200 – status steht dann auf replaced bzw. canceled, eine stornierte Mahnung hat zusätzlich deleted = true.

Response-Felder

Feld	Typ	Beschreibung
data.id	string (UUID) | null	Eindeutige ID der Mahnung
data.invoice	string (UUID) | null	ID der gemahnten Rechnung, nachladbar über Rechnung anzeigen
data.customer	string (UUID) | null	ID des Kunden, nachladbar über Kunde anzeigen
data.status	string	Technischer Status: active, replaced, canceled. Siehe Konventionen
data.text	string | null	Mahntext, wie er auf dem Schreiben an den Kunden steht
data.printedStatus	string	Druckstatus: printed (gedruckt), unprinted (nicht gedruckt)
data.paidStatus	string	Zahlungsstatus: open (offen), paid (bezahlt)
data.dunningType	string (UUID) | null	ID der Mahnstufe, nachladbar über Mahnstufe anzeigen
data.fee	string	Mahngebühr dieser Mahnstufe
data.latePaymentInterestRate	string	Verzugszinssatz in Prozent
data.paymentDeadline	integer	Zahlungsziel in Tagen
data.totalAmount	string	Gesamtbetrag der Mahnung
data.outstandingTotal	string	Offener Gesamtbetrag
data.totalFee	string	Mahngebühren gesamt
data.outstandingFee	string	Offene Mahngebühren
data.totalInterest	string	Verzugszinsen gesamt
data.outstandingInterest	string	Offene Verzugszinsen
data.invoiceOutstandingBalance	string	Offener Betrag der gemahnten Rechnung
data.interestCalculateStartDate	string | null	Beginn der Zinsberechnung (YYYY-MM-DD)
data.interestCalculateEndDate	string | null	Ende der Zinsberechnung (YYYY-MM-DD)
data.createdAt	string (ISO 8601)	Erstellungszeitpunkt
data.updatedAt	string (ISO 8601)	Letzter Änderungszeitpunkt
data.createdBy	string (UUID) | null	ID des Benutzers, der die Mahnung erstellt hat, nachladbar über Benutzer anzeigen
data.updatedBy	string (UUID) | null	ID des Benutzers, der die letzte Änderung vorgenommen hat
data.deleted	boolean	Ob die Mahnung gelöscht ist
data.deletedAt	string (ISO 8601) | null	Löschzeitpunkt
data.deletedBy	string (UUID) | null	ID des Benutzers, der die Mahnung gelöscht hat
data.tenancy	string (UUID) | null	ID des zugeordneten Mandanten

Hinweis zu Geldbeträgen: Alle Geldbeträge und der Zinssatz kommen als JSON-String, nicht als Zahl ("fee": "12.00"). Das betrifft fee, latePaymentInterestRate, totalAmount, outstandingTotal, totalFee, outstandingFee, totalInterest, outstandingInterest und invoiceOutstandingBalance. Verarbeite die Werte mit einem Dezimaltyp. Parst du sie in eine Fließkommazahl, baust du Rundungsfehler ein. Gleiches Verhalten wie bei Rechnungen und Bareinnahmen.

Hinweis: paymentDeadline ist eine Anzahl von Tagen, kein Datum.

Beispiele

bash

curl -X GET "https://my.offisy.at/api/oauth/v2/resource/invoices/dunnings/b2c3d4e5-f6a7-8901-bcde-f01234567890" \
  -H "Authorization: Bearer {access_token}"

Server

Client-ID

Client-Secret

Parameter

uuid *string

Zuerst Token anfordern

Mögliche Fehler

Status	Code	Beschreibung
401	invalid_client	Access Token ungültig oder abgelaufen
403	insufficient_scope	Scope dunnings nicht vorhanden
404	not_found	Mahnung nicht gefunden, oder mit dem Add-on Mandanten einem Mandanten zugeordnet, auf den der Besitzer-Benutzer deines API-Zugangs keinen Zugriff hat oder in dem ihm das Recht Mahnwesen: Anzeigen fehlt. Die Antwort ist dieselbe wie bei einer unbekannten UUID (The requested resource was not found.)
429	rate_limit_exceeded	Zu viele Anfragen – siehe Fehlerbehandlung

Hinweis: Fehlt der Authorization-Header oder ist der Token ungültig, antwortet die API mit 401 und dem JSON-Envelope invalid_client. Das gilt für die OAuth-API allgemein, nicht nur für diesen Endpoint.