Retrieve an Aktenabrechnung
An Aktenabrechnung settles exactly one case. It is created by a case event in our collection system and becomes available here once we have released it.
Not the same resource as /v1/statements/. A statement (Sammelabrechnung) settles
every case of one clearing run at once and carries a mandate_details sub-resource; an
Aktenabrechnung settles a single case and carries that case directly in mandate. Both
number ranges are shared, so the same clearing_no never appears in both resources.
Types (statement_type):
| Value | Meaning |
|---|---|
interim | Zwischenabrechnung — interim settlement while the case continues |
final | Endabrechnung — final settlement of the case |
expenses_invoice | Auslagenrechnung — invoice for expenses we advanced |
transition_to_longtime_monitoring | Übergabe Überwachungsverfahren — handover to long-term monitoring |
negative_closing | Negativabschluss — the case is closed without success |
Sign convention. total_balance is the authority on the direction of the money:
a positive value is a payout to you, a negative value is an amount you owe us.
A negative balance is itemised in cost_burden; a payout is itemised in vat_entries.
Do not infer the direction from statement_type — an interim settlement can end up
negative.
reference_number is our case reference, your_reference is your own customer number
for the debtor as it was stored on the case. vat_rate is a decimal fraction
(0.19 = 19%), the same convention as overview_vat_specific on /v1/statements/.
Subscribe to the single_mandate_statement.created and single_mandate_statement.updated
webhook events instead of polling. created fires when we release an Aktenabrechnung
to you, not when it is first booked internally, so every statement a webhook announces is
retrievable here.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response
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.
URL of this Aktenabrechnung.
Unique ID of this Aktenabrechnung.
The clearing number of the statement (Abrechnungsnummer). Drawn from the same number range as the clearing numbers of /v1/statements/.
The invoice number of the statement (Rechnungsnummer). Null when the settlement did not produce an invoice.
What kind of settlement this is: "interim" (Zwischenabrechnung), "final" (Endabrechnung), "expenses_invoice" (Auslagenrechnung), "transition_to_longtime_monitoring" (Übergabe Überwachungsverfahren) or "negative_closing" (Negativabschluss).
interim- Zwischenabrechnungfinal- Endabrechnungexpenses_invoice- Auslagenrechnungtransition_to_longtime_monitoring- Übergabe Überwachungsverfahrennegative_closing- Negativabschluss
interim, final, expenses_invoice, transition_to_longtime_monitoring, negative_closing The date the statement was booked (Buchungsdatum).
Start of the settled period. Null for settlements that cover the whole case history.
End of the settled period.
Whether this statement has been reversed (Storno). The reversed statement itself stays retrievable; the reversal is booked as its own statement.
Additional comment or notes on the statement.
Our case file reference number ("Aktenzeichen") of the case this statement settles.
Your customer number of the debtor as stored on the case
The case this statement settles. Null when the case is no longer linked; use reference_number, which is a snapshot and always present.
Whether you are entitled to deduct input tax (vorsteuerabzugsberechtigt). Determines whether VAT amounts are passed on to you.
How the balance is settled: "transfer" (Überweisung) or "direct_debit" (Lastschrift).
transfer- Überweisungdirect_debit- Lastschrift
transfer, direct_debit Total of all principal claims settled here (Summe der Hauptforderungen).
Principal claim still open after this settlement (offene Hauptforderung).
positive = payout to you, negative = amount you owe
The invoices settled by this statement (Hauptforderungen).
Payments and their allocation, one entry per VAT rate.
What you owe us on this case (Kostenbelastung). Null when the settlement pays out to you.
Available files for this statement with metadata and download URLs. Empty until the PDF has been transferred.
