Skip to main content
GET
Retrieve a statement
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

Mixin to provide download URLs for statement files. Reusable across different statement serializers.

href
string<uri>
erforderlich
read-only
clearing_no
string
erforderlich
read-only

The clearing number of the statement.

invoice_no
string
erforderlich
read-only

The invoice number of the statement.

booking_date
string<date>
erforderlich
read-only

The date when the statement was booked.

period_start
string<date>
erforderlich
read-only

The start date of the period covered by the statement.

period_end
string<date>
erforderlich
read-only

The end date of the period covered by the statement.

canceled
boolean
erforderlich
read-only

Whether the statement has been canceled.

comment
string
erforderlich
read-only

Additional comment or notes on the statement.

total_balance
object
erforderlich

Total balance after considering outstanding items.

balance_pre_outstanding_items_offsetting
object
erforderlich

Saldo Inkassoverfahren: Payout before considering outstanding items.

offset_outstanding_items
object
erforderlich

Amount of outstanding items that was offset.

mandate_count
integer
erforderlich
read-only

Number of mandates included in this statement.

mandate_details_href
string
erforderlich
read-only

URL to access paginated mandate details for this statement.

overview_vat_specific
object[]
erforderlich
read-only

VAT-specific financial details for this statement.

downloads
object[]
erforderlich
read-only

List of available statement files with metadata and download URLs.

created
string<date-time>
erforderlich
read-only
id
string