Skip to main content
GET
Retrieve an Aktenabrechnung

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Response

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>
required
read-only

URL of this Aktenabrechnung.

id
string<uuid>
required
read-only

Unique ID of this Aktenabrechnung.

clearing_no
string
required
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
required
read-only

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

statement_type
enum<string>
required

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
Available options:
interim,
final,
expenses_invoice,
transition_to_longtime_monitoring,
negative_closing
booking_date
string<date>
required
read-only

The date the statement was booked (Buchungsdatum).

period_start
string<date> | null
required
read-only

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

period_end
string<date>
required
read-only

End of the settled period.

canceled
boolean
required
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
required
read-only

Additional comment or notes on the statement.

reference_number
string
required
read-only

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

your_reference
string | null
required
read-only

Your customer number of the debtor as stored on the case

mandate
object | null
required

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
required
read-only

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

payout_method
required

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

  • transfer - Überweisung
  • direct_debit - Lastschrift
Available options:
transfer,
direct_debit
principal_claims_total
object | null
required

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

open_principal_claim
object | null
required

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

total_balance
object | null
required

positive = payout to you, negative = amount you owe

principal_claims
object[]
required
read-only

The invoices settled by this statement (Hauptforderungen).

vat_entries
object[]
required
read-only

Payments and their allocation, one entry per VAT rate.

cost_burden
object | null
required

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

downloads
object[]
required
read-only

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

created
string<date-time>
required
read-only