Skip to main content
GET
Retrieve an Aktenabrechnung
This page documents a frozen v1 API. It receives only critical correctness or security corrections. For new integrations, use the current API and follow the linked migration guide.

Autorisierungen

Authorization
string
header
erforderlich

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Pfadparameter

id
string
erforderlich

Antwort

200 - application/json

A settlement for exactly one case (Aktenabrechnung).

Never exposes the platform-internal fields ikaros_event_id, ikaros_event_code, published and send_by_email: the first two are Ikaros bookkeeping, and the latter two are staff release decisions. A client only ever sees published Aktenabrechnungen, so published would be the constant true — a field that can only hold one value is not information, it is a promise we would have to keep.

href
string<uri>
erforderlich
read-only

URL of this Aktenabrechnung.

id
string<uuid>
erforderlich
read-only

Unique ID of this Aktenabrechnung.

clearing_no
string
erforderlich
read-only

The clearing number of the statement (Abrechnungsnummer). Drawn from the same number range as the clearing numbers of /v1/statements/.

invoice_no
string | null
erforderlich
read-only

The invoice number of the statement (Rechnungsnummer). Null when the settlement did not produce an invoice.

statement_type
enum<string>
erforderlich

What kind of settlement this is: "interim" (Zwischenabrechnung), "final" (Endabrechnung), "expenses_invoice" (Auslagenrechnung), "transition_to_longtime_monitoring" (Übergabe Überwachungsverfahren) or "negative_closing" (Negativabschluss).

  • interim - Zwischenabrechnung
  • final - Endabrechnung
  • expenses_invoice - Auslagenrechnung
  • transition_to_longtime_monitoring - Übergabe Überwachungsverfahren
  • negative_closing - Negativabschluss
Verfügbare Optionen:
interim,
final,
expenses_invoice,
transition_to_longtime_monitoring,
negative_closing
booking_date
string<date>
erforderlich
read-only

The date the statement was booked (Buchungsdatum).

period_start
string<date> | null
erforderlich
read-only

Start of the settled period. Null for settlements that cover the whole case history.

period_end
string<date>
erforderlich
read-only

End of the settled period.

canceled
boolean
erforderlich
read-only

Whether this statement has been reversed (Storno). The reversed statement itself stays retrievable; the reversal is booked as its own statement.

comment
string | null
erforderlich
read-only

Additional comment or notes on the statement.

reference_number
string
erforderlich
read-only

Our case file reference number ("Aktenzeichen") of the case this statement settles.

your_reference
string | null
erforderlich
read-only

Your customer number of the debtor as stored on the case

mandate
object | null
erforderlich

The case this statement settles. Null when the case is no longer linked; use reference_number, which is a snapshot and always present.

pre_tax_deductible
boolean
erforderlich
read-only

Whether you are entitled to deduct input tax (vorsteuerabzugsberechtigt). Determines whether VAT amounts are passed on to you.

payout_method
erforderlich

How the balance is settled: "transfer" (Überweisung) or "direct_debit" (Lastschrift).

  • transfer - Überweisung
  • direct_debit - Lastschrift
Verfügbare Optionen:
transfer,
direct_debit
principal_claims_total
object | null
erforderlich

Total of all principal claims settled here (Summe der Hauptforderungen).

open_principal_claim
object | null
erforderlich

Principal claim still open after this settlement (offene Hauptforderung).

total_balance
object | null
erforderlich

positive = payout to you, negative = amount you owe

principal_claims
object[]
erforderlich
read-only

The invoices settled by this statement (Hauptforderungen).

vat_entries
object[]
erforderlich
read-only

Payments and their allocation, one entry per VAT rate.

cost_burden
object | null
erforderlich

What you owe us on this case (Kostenbelastung). Null when the settlement pays out to you.

downloads
object[]
erforderlich
read-only

Available files for this statement with metadata and download URLs. Empty until the PDF has been transferred.

created
string<date-time>
erforderlich
read-only