Endpoints / accountingInvoices

accountingInvoices

Rechnungen abfragen

Rechnungen (Debitoren) eines Zeitraums, mandantenweit über alle Patienten.

HTTP Request

POST https://dev.vitabyte.ch/v1/accounting/invoices
Auth basicAuth apiKey

Request Parameters

Beide Parameter sind optional. Ohne Angabe werden sämtliche Rechnungen retourniert.

Parameter Pflicht Typ Beispiel / Default
from

YYYY-MM-DD. Filtert auf Rechnungsdatum ab diesem Tag.

optional string
2026-01-01
until

YYYY-MM-DD. Filtert auf Rechnungsdatum bis zu diesem Tag.

optional string
2026-05-31

Response Parameters

Envelope-Abweichung: { "status": true, "result": [ … ] } - kein msg.

Field Typ Beschreibung
invoice_no string Rechnungsnummer im Format PPPPP-FFF (Patient + Fall)
patid integer Patienten-ID
case_no integer Fall-Nummer
invoice_date string Rechnungsdatum
amount number Rechnungsbetrag
amount_due number Offener Saldo
status string paid (Saldo = 0), open (Saldo > 0), overpaid (Saldo < 0)
due_date string Fälligkeitsdatum, null wenn keines gesetzt ist
payment_terms_days integer Zahlungsfrist in Tagen (Fälligkeits- minus Rechnungsdatum), null ohne Fälligkeitsdatum
dunning_level integer Mahnstufe: 0 = nicht gemahnt, 1-3 = 1. bis 3. Mahnung
last_dunning_date string Datum der letzten Mahnung, null wenn nie gemahnt
dunning_due_date string Zahlungsfrist der laufenden Mahnung, nur ab Mahnstufe 1, sonst null
recipient_type string Rechnungsempfänger: patient, recaddr (abweichende Rechnungsadresse des Patienten), garant oder insurance
recipient_zip string Postleitzahl des Rechnungsempfängers. null bei insurance oder wenn keine erfasst ist
recipient_country string Land des Rechnungsempfängers als ISO-Code (z.B. CH). null bei garant und insurance (dort wird kein Land geführt) oder wenn keines erfasst ist
qr_reference string QR-Referenz (27 Ziffern, ohne Leerzeichen) wie auf dem Zahlteil der Rechnung - zum Abgleich mit Bankgutschriften (camt). Aufgebaut aus Kunden-Identifikation der Bank, Patienten- und Fallnummer und Prüfziffer; null, wenn für den Rechnungsfall kein Konto mit Identifikation hinterlegt ist

Demo

Referenz und Beispiele stammen aus der internen API-Collection - die OpenAPI-Spec deckt diesen Endpoint noch nicht ab.

POST https://dev.vitabyte.ch/v1/accounting/invoices
Payload
{
    "from": "2026-01-01",
    "until": "2026-05-31"
}
Response
{
    "status": true,
    "result": [
        {
            "invoice_no": "00789-001",
            "patid": 789,
            "case_no": 1,
            "invoice_date": "2026-02-15",
            "amount": 342.8,
            "amount_due": 0,
            "status": "paid",
            "due_date": "2026-03-17",
            "payment_terms_days": 30,
            "dunning_level": 0,
            "last_dunning_date": null,
            "dunning_due_date": null,
            "recipient_type": "patient",
            "recipient_zip": "8001",
            "recipient_country": "CH",
            "qr_reference": "210000000000000000007890015"
        },
        {
            "invoice_no": "00789-002",
            "patid": 789,
            "case_no": 2,
            "invoice_date": "2026-03-10",
            "amount": 185.5,
            "amount_due": 185.5,
            "status": "open",
            "due_date": "2026-04-09",
            "payment_terms_days": 30,
            "dunning_level": 1,
            "last_dunning_date": "2026-04-20",
            "dunning_due_date": "2026-05-20",
            "recipient_type": "garant",
            "recipient_zip": "8400",
            "recipient_country": null,
            "qr_reference": "210000000000000000007890020"
        }
    ]
}