Für: Administratoren
Rechnungen mit einem Verwaltungsschlüssel lesen
Erstellen Sie eine Liste der veröffentlichten Rechnungen Ihres Hubs und lesen Sie eine davon mit Angabe der Beträge, der Zahlung und der Rückerstattung für Ihre eigene Buchhaltung oder Berichterstattung.
In diesem Artikel4 Abschnitte
Bevor Sie beginnen
Diese Seite behandelt das Lesen von Rechnungen. Die Wege zur Erfassung der Rechnungen liegen unter https://prd-api-manage.caseactive.com/v1/<hub id>. Die Funktion „Key“ ermöglicht es, jede veröffentlichte Rechnung zu erfassen – auch solche, die bereits abgeschlossen sind. Die Funktion kann jedoch keine Rechnungen erstellen, ändern, zurückzahlen oder bezahlen.
Anrufe
| Anruf | Was es tut |
|---|---|
GET /invoices | Die Liste enthält die veröffentlichten Rechnungen – die neuesten Rechnungen stehen dabei ganz oben. |
GET /invoices/<case_id>/<invoice_id> | Liest eine Rechnung. |
| Parameter | Was es tut | Erforderlich | Standard |
|---|---|---|---|
status | Nur Rechnungen mit diesen Status: open, paid, void, uncollectible oder processing | Nein. | Alles |
case_id | Nur die Rechnungen für einen einzigen Fall. | Nein. | Jeder Fall |
limit | Wie viele Rechnungen eine Seite enthalten kann – bis zu 1000 Rechnungen. | Nein. | 20 |
start_key | Der startKey aus der vorherigen Seite | Nein. | Erste Seite |
Während es noch weitere Rechnungen gibt, rufen Sie bitte nextLink an – oder senden Sie startKey als start_key. Diese Liste enthält keine Filter nach Datum oder dem letzten Zeitpunkt des Änderungsvorgangs einer Rechnung. Um herauszufinden, was seit Ihrer letzten Synchronisierung geändert wurde – einschließlich Zahlungen und Rückerstattungen –, suchen Sie in der Tabelle case_invoices nach den Einträgen, bei denen filter_by=updated_on:> sowie die Zeit Ihrer letzten Synchronisierung in Unix-Sekunden angegeben sind. Eine Änderung wird erst einige Sekunden nach ihrer Erstellung als „gesucht“ markiert. Beginnen Sie daher jedes Fenster etwas vor dem Ende des vorherigen Fensters. Fügen Sie filter_by=refund_status:=succeeded hinzu, um Rückerstattungen zu finden. Weitere Informationen finden Sie in Suchfunktionen für Fälle und Benutzer mit der Funktion „Verwalten“.
Eine Rechnung
Jede Summe entspricht einer ganzen Zahl an Centen – in US-Dollar ausgedrückt: 96300 beträgt 963,00 US-Dollar.
{
"data": {
"case_id": "cc-1a2b3c4d5e6f70",
"invoice_id": "invoice::20260915143000_ab12cd34ef5678",
"host_id": "ca-7e6d5c4b3a2f10",
"name": "September legal services",
"description": "Consultation and filing for Jane Sample's claim",
"invoice_number": "INV-1042",
"po_number": "PO-778",
"terms": "Net 15",
"host_ref_id": "acct-1042",
"notes": "Thank you for your business.",
"participants_ids": ["cu-4f1c2a9e8b7d60"],
"user_id": "cu-9d8c7b6a5f4e30",
"status": "paid",
"due_date": "2026-09-30T17:00:00+00:00",
"transactions": {
"transactions": [
{"transaction_type": "charge", "description": "Consultation (hours)", "value": 35000, "quantity": 2, "currency": "usd"},
{"transaction_type": "charge", "description": "Court filing fee", "value": 30000, "quantity": 1, "currency": "usd"}
],
"discount": 0.1,
"tax": 0.07
},
"subtotal": 100000,
"discount": 0.1,
"discount_amount": 10000,
"discounted_amount": 90000,
"tax": 0.07,
"tax_amount": 6300,
"total": 96300,
"payment_gateway": "stripe",
"stripe_payment": {"user_id": "cu-4f1c2a9e8b7d60", "fees": 2863, "stripe_fee": 2823, "application_fee": 40, "net": 93437},
"payment_attempts": [{"datetime": "2026-09-20T14:05:12+00:00", "success": true, "user_id": "cu-4f1c2a9e8b7d60"}],
"completed_on": "2026-09-20T14:05:20+00:00",
"published": 1,
"created_on": "2026-09-15T14:30:00+00:00",
"updated_on": "2026-09-20T14:05:20+00:00"
}
}
| Feld | Was es enthält |
|---|---|
invoice_id, case_id | Die Rechnung – sowie der Behälter, in dem sie aufbewahrt wird. Lesen Sie eine Rechnung mit beiden. |
name, description | Titel und Beschreibung |
invoice_number, po_number, terms, notes, host_ref_id | Geschrieben auf der Rechnung. host_ref_id ist die Referenznummer der Rechnung. |
participants_ids | Die Leute, denen das angeboten wird… |
user_id | Wer hat es geschaffen? |
status | open: Wartet darauf, bezahlt zu werden. paid: Online bezahlt oder als bezahlt markiert. void: Storniert. uncollectible und processing: Von Ihren Mitarbeitern festgelegt. paid und void: Endgültige Werte. |
due_date | Wenn es soweit ist… |
transactions | Die Linien sind jeweils eine charge oder eine credit. Dazu kommen noch eine description, eine value in Centen sowie eine quantity. Zudem gibt es bestimmte Wechselkurse, die angewandt werden. |
subtotal | Abzüglich der Zuschüsse – niemals weniger als 0. |
discount, discount_amount, discounted_amount | Die Diskontsrate als Bruch0.1 Es beträgt 10%. Die Rabattmenge in Cent sowie der Gesamtbetrag nach dem Rabatt. |
tax, tax_amount | Die Steuerrate als Bruchzahl0.07 Es beträgt 7%). Die Steuer in Cent beträgt wiederum die Menge, die nach der Rabattung übrig bleibt. |
total | Was aufbewahrt werden muss, in Centen |
payment_gateway | Wenn die Zahlung online erfolgt, dann stripe. Wenn Ihr Personal das Dokument als bezahlt markiert hat, dann manual. |
stripe_payment | Für eine Online-Zahlung: Wer hat bezahlt, welche Gebühren wurden erhoben und wie hoch ist der Nettobetrag in Cent? |
payment_attempts | Jeder versucht, online zu bezahlen. Aber ob das funktioniert hat – und warum es nicht funktioniert hat… |
refunded | Eine Rückerstattung, falls vorhanden: status (pending, succeeded, failed oder canceled), amount in Centen sowie reason. Der Status der Rechnung bleibt weiterhin paid. |
completed_on | Wenn die Zahlung erfolgt ist oder die Zahlung annulliert wurde. |
Wenn ein Anruf abgelehnt wird
| Status | message | Warum |
|---|---|---|
| 404 | InvoiceDoesNotExistException | In der Kiste gibt es keine Rechnung mit dieser Identifikationsnummer. |
| 400 | InvoiceNotPublishedException | Die Rechnung ist ein Scheck. |
| 400 | SchemaFieldsException | status gehört nicht zu den fünf. |
| 400 | InvalidStartKeyException | start_key kam nicht aus dieser Liste. |
Für den Fehlermeldungsinhalt sowie die übrigen Codewerte siehe Verarbeitung von API-Fehlern und Statuscodes.