> ## Documentation Index > Fetch the complete documentation index at: https://docs.paywise.de/llms.txt > Use this file to discover all available pages before exploring further. # Get statement > Published payout statements and their customer-visible breakdown. ## OpenAPI ````yaml /api-docs/case-management-api/openapi.json get /v2/statements/{id}/ openapi: 3.0.3 info: description: >- Submit orders and manage their complete lifecycle through the current API at the `/v2/` HTTP path. title: paywise Case Management API version: current servers: - description: Production environment url: https://api.paywise.de - description: Sandbox environment url: https://api-sandbox.paywise.de security: [] tags: - description: Submit orders and manage them until acceptance. name: Orders - description: Stable claim resources and their current relationships. name: Claims - description: 'Accepted cases: state, published history and documents.' name: Mandates - description: Debtor master data reused across orders. name: Debtors - description: Payments reported by you and booked by paywise. name: Payments - description: Files attached to claims and other resources. name: Documents - description: Collective statements (Sammelabrechnungen). name: Statements - description: Per-case statements (Aktenabrechnungen). name: Single mandate statements - description: Webhook endpoints and their signing secrets. name: Webhooks - description: Delivery log and redelivery of webhook events. name: Webhook deliveries - description: Ordered feed of the events webhooks deliver. name: Events - description: Reference catalog of legal forms. name: Legal forms - description: The authenticated credential and its context. name: Info - description: Rate-limit headroom of the credential. name: Usage - description: Availability of the API. name: Health externalDocs: url: https://docs.paywise.de/api-docs/case-management-api/introduction paths: /v2/statements/{id}/: get: tags: - Statements summary: Get statement description: Published payout statements and their customer-visible breakdown. operationId: get-statement parameters: - description: >- Required when a Partner key calls the Case Management API; rejected for direct Case keys. Contains the entitled paywise company UUID. in: header name: X-On-Behalf-Of-Company schema: format: uuid type: string - description: UUID of the statement in this request. in: path name: id required: true schema: format: uuid type: string - description: >- Return 304 with an empty body when the current `ETag` matches one of the supplied validators (or `*`). in: header name: If-None-Match required: false schema: type: string responses: '200': content: application/json: examples: statement: value: booking_date: '2026-07-01' cancelled_at: null clearing_no: CLEARING-000042 comment: June clearing run created_at: '2026-07-01T06:00:00Z' files: - download_url: >- https://api.paywise.de/v2/statements/a0000000-0000-4000-8000-000000000001/download/?type=full-pdf filename: statement_CLEARING-000042.pdf media_type: application/pdf type: full-pdf financials: balance_before_outstanding_items_offsetting: currency: EUR value: '0.00' outstanding_items_offset: currency: EUR value: '0.00' total_balance: currency: EUR value: '0.00' vat_entries: [] id: a0000000-0000-4000-8000-000000000001 invoice_no: STATEMENT-000042 mandate_count: 2 mandates: - amount: currency: EUR value: '100.00' closing: null cost_burden: [] created_at: '2026-06-15T11:00:00Z' debtor: acting_as: consumer events: - description: null location: null occurence: '2026-05-01T09:00:00Z' title: Customer registered type: registration your_reference: null legal_form: null metadata: - type: user:reference value: CUSTOMER-1001 organization: null person: birth_date: null first_name: Alex last_name: Example salutation: mx your_reference: CUSTOMER-1001 id: 50000000-0000-4000-8000-000000000003 reference_number: PW-2026-000121 related_statements: [] state: legal_stage: code: extrajudicial label: Extrajudicial label_key: mandate.state.legal_stage.extrajudicial payment: code: open label: Open label_key: mandate.state.payment.open processing: code: active label: Active label_key: mandate.state.processing.active third_party_money: [] - amount: currency: EUR value: '100.00' closing: null cost_burden: [] created_at: '2026-06-15T11:00:00Z' debtor: acting_as: consumer events: - description: null location: null occurence: '2026-05-01T09:00:00Z' title: Customer registered type: registration your_reference: null legal_form: null metadata: - type: user:reference value: CUSTOMER-1001 organization: null person: birth_date: null first_name: Alex last_name: Example salutation: mx your_reference: CUSTOMER-1001 id: 50000000-0000-4000-8000-000000000004 reference_number: PW-2026-000122 related_statements: [] state: legal_stage: code: extrajudicial label: Extrajudicial label_key: mandate.state.legal_stage.extrajudicial payment: code: open label: Open label_key: mandate.state.payment.open processing: code: active label: Active label_key: mandate.state.processing.active third_party_money: [] period_end: '2026-06-30' period_start: '2026-06-01' published_at: '2026-07-01T06:00:00Z' status: published updated_at: '2026-07-01T06:00:00Z' schema: $ref: '#/components/schemas/StatementRead' description: '' headers: Cache-Control: description: >- Cacheability directive. Authenticated responses use `private, no-store`; the legal-form catalog may use `private, max-age=86400`. schema: type: string ETag: description: >- Strong validator of this representation. Send it back as `If-None-Match` to skip an unchanged re-read (304) or as `If-Match` on PATCH/PUT/DELETE to fail with 412 when the resource changed. schema: type: string X-Paywise-Environment: description: Environment that produced the response. schema: enum: - production - sandbox type: string X-Paywise-Request-Id: description: >- Fresh server-assigned correlation id for this response. Caller-provided request ids are ignored. schema: format: uuid type: string '304': description: 'Not modified: the `If-None-Match` validator still matches.' headers: Cache-Control: description: >- Cacheability directive. Authenticated responses use `private, no-store`; the legal-form catalog may use `private, max-age=86400`. schema: type: string X-Paywise-Environment: description: Environment that produced the response. schema: enum: - production - sandbox type: string X-Paywise-Request-Id: description: >- Fresh server-assigned correlation id for this response. Caller-provided request ids are ignored. schema: format: uuid type: string '401': content: application/json: examples: authentication-error: value: code: not_authenticated detail: Authentication credentials were not provided. schema: $ref: '#/components/schemas/Error' description: Standard error response. headers: Cache-Control: description: >- Cacheability directive. Authenticated responses use `private, no-store`; the legal-form catalog may use `private, max-age=86400`. schema: type: string X-Paywise-Environment: description: Environment that produced the response. schema: enum: - production - sandbox type: string X-Paywise-Request-Id: description: >- Fresh server-assigned correlation id for this response. Caller-provided request ids are ignored. schema: format: uuid type: string '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Standard error response. headers: Cache-Control: description: >- Cacheability directive. Authenticated responses use `private, no-store`; the legal-form catalog may use `private, max-age=86400`. schema: type: string X-Paywise-Environment: description: Environment that produced the response. schema: enum: - production - sandbox type: string X-Paywise-Request-Id: description: >- Fresh server-assigned correlation id for this response. Caller-provided request ids are ignored. schema: format: uuid type: string '404': content: application/json: examples: not-found-error: value: code: not_found detail: The requested resource was not found. schema: $ref: '#/components/schemas/Error' description: Standard error response. headers: Cache-Control: description: >- Cacheability directive. Authenticated responses use `private, no-store`; the legal-form catalog may use `private, max-age=86400`. schema: type: string X-Paywise-Environment: description: Environment that produced the response. schema: enum: - production - sandbox type: string X-Paywise-Request-Id: description: >- Fresh server-assigned correlation id for this response. Caller-provided request ids are ignored. schema: format: uuid type: string '429': content: application/json: schema: $ref: '#/components/schemas/Error' description: Standard error response. headers: Cache-Control: description: >- Cacheability directive. Authenticated responses use `private, no-store`; the legal-form catalog may use `private, max-age=86400`. schema: type: string Retry-After: description: Integer seconds to wait before retrying a throttled request. schema: minimum: 1 type: integer X-Paywise-Environment: description: Environment that produced the response. schema: enum: - production - sandbox type: string X-Paywise-Request-Id: description: >- Fresh server-assigned correlation id for this response. Caller-provided request ids are ignored. schema: format: uuid type: string '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Standard error response. headers: Cache-Control: description: >- Cacheability directive. Authenticated responses use `private, no-store`; the legal-form catalog may use `private, max-age=86400`. schema: type: string X-Paywise-Environment: description: Environment that produced the response. schema: enum: - production - sandbox type: string X-Paywise-Request-Id: description: >- Fresh server-assigned correlation id for this response. Caller-provided request ids are ignored. schema: format: uuid type: string security: - caseBearerAuth: [] - partnerBearerAuth: [] components: schemas: StatementRead: properties: booking_date: description: Date on which the statement was booked. format: date nullable: true readOnly: true type: string cancelled_at: description: Time at which the statement was cancelled, when applicable. format: date-time nullable: true readOnly: true type: string clearing_no: description: Clearing number of the statement. nullable: true readOnly: true type: string comment: description: Free-text note paywise attached to the statement, when any. nullable: true readOnly: true type: string created_at: description: Time at which the statement record was created. format: date-time readOnly: true type: string files: description: >- Every available download of this statement: the PDF and the Excel exports for third-party money, cost burden and closings. A file appears once it has been transferred. items: $ref: '#/components/schemas/StatementTypedFile' readOnly: true type: array financials: allOf: - $ref: '#/components/schemas/StatementFinancials' description: Statement-wide balances and VAT breakdown. readOnly: true id: description: Stable identifier of this statement. format: uuid readOnly: true type: string invoice_no: description: Invoice number of the statement. nullable: true readOnly: true type: string mandate_count: description: Number of accepted cases included in this statement. minimum: 0 readOnly: true type: integer mandates: description: Accepted cases included in this statement. items: $ref: '#/components/schemas/StatementMandateRow' readOnly: true type: array period_end: description: End of the period covered by the statement. format: date nullable: true readOnly: true type: string period_start: description: Start of the period covered by the statement. format: date nullable: true readOnly: true type: string published_at: description: Time at which the statement became available to you. format: date-time nullable: true readOnly: true type: string status: allOf: - $ref: '#/components/schemas/CaseStatementStatusEnum' description: Whether the statement is published or cancelled. readOnly: true updated_at: description: Time at which the statement record was last updated. format: date-time nullable: true readOnly: true type: string required: - booking_date - cancelled_at - clearing_no - comment - created_at - files - financials - id - invoice_no - mandate_count - mandates - period_end - period_start - published_at - status - updated_at type: object Error: properties: code: description: Machine-readable error category. type: string detail: description: Short human-readable summary of the error. type: string errors: description: Field-level validation errors, when applicable. items: $ref: '#/components/schemas/ErrorItem' type: array required: - detail - code type: object StatementTypedFile: properties: download_url: description: Authenticated URL for downloading this file. format: uri readOnly: true type: string filename: description: Descriptive filename for this download. readOnly: true type: string media_type: description: Media type of this download. readOnly: true type: string type: description: >- Kind of download: full-pdf (the statement document), third-party-money-xlsx (Fremdgeldabrechnung), cost-burden-xlsx (Kostenbelastung) or closing-xlsx (Abschlussmeldungen). Pass it as the type query parameter of the download operation. readOnly: true type: string required: - download_url - filename - media_type - type type: object StatementFinancials: properties: balance_before_outstanding_items_offsetting: allOf: - $ref: '#/components/schemas/StatementAmount' description: Payout balance before older outstanding items are offset. nullable: true readOnly: true outstanding_items_offset: allOf: - $ref: '#/components/schemas/StatementAmount' description: Older outstanding items deducted from this statement. nullable: true readOnly: true total_balance: allOf: - $ref: '#/components/schemas/StatementAmount' description: Final balance after outstanding items are offset. nullable: true readOnly: true vat_entries: description: Invoice and collection amounts grouped by VAT rate. items: $ref: '#/components/schemas/StatementVATEntry' readOnly: true type: array required: - balance_before_outstanding_items_offsetting - outstanding_items_offset - total_balance - vat_entries type: object StatementMandateRow: properties: amount: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- Current claim total of the linked main case, shared with its sub-cases; null when the case or its total is unavailable. This is a live case value, rather than a snapshot at the statement booking date. nullable: true readOnly: true closing: allOf: - $ref: '#/components/schemas/StatementClosing' description: Closing details when the accepted case ended in this statement. nullable: true readOnly: true cost_burden: description: Fees and expenses charged to you, grouped by VAT rate. items: $ref: '#/components/schemas/StatementCostBurden' readOnly: true type: array created_at: description: Time at which the accepted case was created. format: date-time readOnly: true type: string debtor: allOf: - $ref: '#/components/schemas/MandateDebtor' description: Debtor associated with the accepted case. nullable: true readOnly: true id: description: Identifier of the accepted case included in the statement. format: uuid readOnly: true type: string reference_number: description: paywise case-file reference number. nullable: true readOnly: true type: string related_statements: description: >- Other published statements that also include this accepted case, newest first. Empty when the case appears in no other statement. items: $ref: '#/components/schemas/RelatedStatement' readOnly: true type: array state: allOf: - $ref: '#/components/schemas/MandateState' description: Current legal, processing, and payment states of the case. nullable: true readOnly: true third_party_money: description: Debtor-payment allocations grouped by VAT rate. items: $ref: '#/components/schemas/StatementThirdPartyMoney' readOnly: true type: array required: - amount - closing - cost_burden - created_at - debtor - id - reference_number - related_statements - state - third_party_money type: object CaseStatementStatusEnum: enum: - published - cancelled type: string ErrorItem: properties: code: description: Machine-readable field error code. type: string field: description: >- Path to the field that caused the error, using dots for objects and brackets for list indexes, for example `claims[0].amount`; null for an error without a field path. nullable: true type: string message: description: Human-readable explanation of the field error. type: string required: - field - code - message type: object StatementAmount: properties: currency: description: Currency of the amount. readOnly: true type: string value: description: Monetary value expressed with two decimal places. format: decimal pattern: ^-?\d{0,14}(?:\.\d{0,2})?$ readOnly: true type: string required: - currency - value type: object StatementVATEntry: properties: claims_from_advanced_costs: allOf: - $ref: '#/components/schemas/ClaimsFromAdvancedCosts' description: Collection claims arising from costs advanced by paywise. nullable: true readOnly: true claims_from_payments_to_client: allOf: - $ref: '#/components/schemas/ClaimsFromPaymentsToClient' description: Collection claims arising from debtor payments made directly to you. nullable: true readOnly: true claims_from_payments_to_dca: allOf: - $ref: '#/components/schemas/ClaimsFromPaymentsToDCA' description: Collection claims arising from debtor payments to paywise. nullable: true readOnly: true instalment_payments_to_client: allOf: - $ref: '#/components/schemas/StatementAmount' description: Instalment payments already passed on to you for this VAT rate. nullable: true readOnly: true invoice_amount: allOf: - $ref: '#/components/schemas/StatementAmount' description: Net invoice amount for this VAT rate. nullable: true readOnly: true invoice_amount_vat: allOf: - $ref: '#/components/schemas/StatementAmount' description: VAT charged on the invoice amount for this rate. nullable: true readOnly: true payout: allOf: - $ref: '#/components/schemas/StatementAmount' description: Payout balance for this VAT rate. nullable: true readOnly: true total_payments_to_dca: allOf: - $ref: '#/components/schemas/StatementAmount' description: Total debtor payments received by paywise for this VAT rate. nullable: true readOnly: true vat: allOf: - $ref: '#/components/schemas/StatementAmount' description: Total VAT amount for this VAT rate. nullable: true readOnly: true vat_rate: description: VAT percentage applied to this entry, e.g. 19.00 for 19%. format: decimal pattern: ^-?\d{0,3}(?:\.\d{0,2})?$ readOnly: true type: string required: - claims_from_advanced_costs - claims_from_payments_to_client - claims_from_payments_to_dca - instalment_payments_to_client - invoice_amount - invoice_amount_vat - payout - total_payments_to_dca - vat - vat_rate type: object StatementClosing: properties: accepted_main_claim_amount: allOf: - $ref: '#/components/schemas/StatementAmount' description: Principal amount accepted when the case was closed. nullable: true readOnly: true closing_code: allOf: - $ref: '#/components/schemas/ClosingCodeEnum' description: |- Machine-readable closing reason code. * `IP01` - Vollzahlung * `IP02` - Teilzahlung * `IP03` - vor Bearbeitung bezahlt * `IP04` - Vergleichszahlung * `IPU1` - Vollzahlung (Unterakte) * `IPU2` - Teilzahlung (Unterakte) * `IPU3` - vor Bearbeitung bezahlt (Unterakte) * `IPU4` - Vergleichszahlung (Unterakte) * `IN01` - Akte storniert * `IN010` - Akte storniert - keine Kostenbelastung Honorar * `IN011` - Akte geschlossen: Negative SCHUFA-Auskunft * `IN012` - Akte storniert: Nicht eingezahlter GMV-Vorschuss * `IN013` - Akte storniert: Nicht eingezahlter ZV-Vorschuss * `IN014` - Akte storniert: Nicht beantwortete Rückfrage * `IN015` - Akte geschlossen: Mangels zustellfähiger Anschrift * `IN016` - Akte geschlossen: Schuldner verstorben * `IN017` - Akte geschlossen: Bestritten * `IN018` - Akte storniert: Zahlung vor Übernahme * `IN02` - Kunde wünscht Abschluss * `IN020` - Kunde wünscht Abschluss - keine Kostenbelastung * `IN03` - Abschluss wegen EV * `IN04` - Abschluss wegen Insolvenz * `IN05` - Schuldner verstorben * `IN06` - Erfolglos * `INO7` - Aktensperre * `IN08` - Aufhebung Aktensperre * `INU1` - Unterakte storniert * `INU2` - Kunde wünscht Abschluss (Unterakte) * `INU3` - Abschluss wegen EV (Unterakte) * `INU4` - Abschluss wegen Insolvenz (Unterakte) * `INU5` - Schuldner verstorben (Unterakte) * `INU6` - Erfolglos (Unterakte) * `IÜ01` - Überwachung Sonstiges * `IÜ02` - Überwachung Abgabe EV * `IÜ03` - Überwachung Insolvenz * `IÜU1` - Überwachung Sonstiges (Unterakte) * `IÜU2` - Überwachung Abgabe EV (Unterakte) * `IÜU3` - Überwachung Insolvenz (Unterakte) nullable: true readOnly: true closing_date: description: Date on which the case was closed. format: date nullable: true readOnly: true type: string closing_description: description: Human-readable explanation of the closing reason. nullable: true readOnly: true type: string closing_type: allOf: - $ref: '#/components/schemas/ClosingTypeEnum' description: >- Business category of the case closing. * `positive` - Positiv * `negative` - Negativ * `transition_to_longtime_monitoring` - Übergang ins Überwachungsverfahren nullable: true readOnly: true remaining_main_claim_amount: allOf: - $ref: '#/components/schemas/StatementAmount' description: Principal amount still open when the case was closed. nullable: true readOnly: true required: - accepted_main_claim_amount - closing_code - closing_date - closing_description - closing_type - remaining_main_claim_amount type: object StatementCostBurden: properties: fee: allOf: - $ref: '#/components/schemas/StatementAmount' description: Collection fee charged to you. nullable: true readOnly: true fee_vat: allOf: - $ref: '#/components/schemas/StatementAmount' description: VAT on the collection fee charged to you. nullable: true readOnly: true litigation_taxable_expenses: allOf: - $ref: '#/components/schemas/StatementAmount' description: Taxable litigation expenses charged to you. nullable: true readOnly: true litigation_taxable_expenses_vat: allOf: - $ref: '#/components/schemas/StatementAmount' description: VAT on taxable litigation expenses charged to you. nullable: true readOnly: true litigation_taxfree_expenses: allOf: - $ref: '#/components/schemas/StatementAmount' description: Tax-free litigation expenses charged to you. nullable: true readOnly: true tax_free_expenses: allOf: - $ref: '#/components/schemas/StatementAmount' description: Tax-free expenses charged to you. nullable: true readOnly: true taxable_expenses: allOf: - $ref: '#/components/schemas/StatementAmount' description: Taxable expenses charged to you. nullable: true readOnly: true taxable_expenses_vat: allOf: - $ref: '#/components/schemas/StatementAmount' description: VAT on taxable expenses charged to you. nullable: true readOnly: true total_amount: allOf: - $ref: '#/components/schemas/StatementAmount' description: Total amount charged to you for this VAT rate. nullable: true readOnly: true vat_rate: description: VAT percentage applied to this cost burden, e.g. 19.00 for 19%. format: decimal pattern: ^-?\d{0,3}(?:\.\d{0,2})?$ readOnly: true type: string required: - fee - fee_vat - litigation_taxable_expenses - litigation_taxable_expenses_vat - litigation_taxfree_expenses - tax_free_expenses - taxable_expenses - taxable_expenses_vat - total_amount - vat_rate type: object MandateDebtor: description: Immutable debtor snapshot embedded in accepted-case resources. properties: acting_as: allOf: - $ref: '#/components/schemas/ActingAsEnum' description: >- Whether the debtor incurred the obligation as a consumer or in a business capacity. * `consumer` - consumer * `business` - business readOnly: true events: description: Stored contextual events associated with this resource. items: $ref: '#/components/schemas/LegacyEventRead' readOnly: true type: array legal_form: description: >- Permanent public legal-form code; look up its label and representation rules with GET /v2/legal-forms/. Null for consumers. nullable: true readOnly: true type: string metadata: description: Stored metadata entries; duplicate types remain separate entries. items: $ref: '#/components/schemas/LegacyMetadataRead' readOnly: true type: array organization: allOf: - $ref: '#/components/schemas/OrganizationRead' description: Organization identity for a business debtor. nullable: true readOnly: true person: allOf: - $ref: '#/components/schemas/PersonRead' description: Natural-person identity for a consumer or sole proprietor. nullable: true readOnly: true your_reference: description: Your reference for this debtor. nullable: true readOnly: true type: string required: - acting_as - events - legal_form - metadata - organization - person - your_reference type: object RelatedStatement: description: Reference to another statement that contains the same accepted case. properties: booking_date: description: Date on which the related statement was booked. format: date nullable: true readOnly: true type: string clearing_no: description: Clearing number of the related statement. nullable: true readOnly: true type: string id: description: Identifier of the related statement. format: uuid readOnly: true type: string period_end: description: End of the period covered by the related statement. format: date nullable: true readOnly: true type: string period_start: description: Start of the period covered by the related statement. format: date nullable: true readOnly: true type: string required: - booking_date - clearing_no - id - period_end - period_start type: object MandateState: properties: legal_stage: allOf: - $ref: '#/components/schemas/MandateStateValue' description: Current legal collection stage. readOnly: true payment: allOf: - $ref: '#/components/schemas/MandateStateValue' description: Current payment or settlement state. readOnly: true processing: allOf: - $ref: '#/components/schemas/MandateStateValue' description: Current operational processing state. readOnly: true required: - legal_stage - payment - processing type: object StatementThirdPartyMoney: properties: extraordinary_payouts_to_client: allOf: - $ref: '#/components/schemas/ExtraordinaryPayoutsToClient' description: Allocation of extraordinary payouts made to you. nullable: true readOnly: true payments_to_client: allOf: - $ref: '#/components/schemas/PaymentsToClient' description: Allocation of debtor payments made directly to you. nullable: true readOnly: true payments_to_dca: allOf: - $ref: '#/components/schemas/PaymentsToDCA' description: Allocation of debtor payments received by paywise. nullable: true readOnly: true total_payments: allOf: - $ref: '#/components/schemas/StatementAmount' description: Total debtor payments received by paywise or directly by you. nullable: true readOnly: true vat_rate: description: >- VAT percentage applied to this payment allocation, e.g. 19.00 for 19%. format: decimal pattern: ^-?\d{0,3}(?:\.\d{0,2})?$ readOnly: true type: string required: - extraordinary_payouts_to_client - payments_to_client - payments_to_dca - total_payments - vat_rate type: object ClaimsFromAdvancedCosts: properties: fee_claims: allOf: - $ref: '#/components/schemas/StatementAmount' description: Collection-fee claims arising from costs advanced by paywise. nullable: true readOnly: true fee_vat_claims: allOf: - $ref: '#/components/schemas/StatementAmount' description: VAT on collection-fee claims arising from costs advanced by paywise. nullable: true readOnly: true taxable_expenses_claims: allOf: - $ref: '#/components/schemas/StatementAmount' description: Taxable expense claims arising from costs advanced by paywise. nullable: true readOnly: true taxable_expenses_vat_claims: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- VAT on taxable expense claims arising from costs advanced by paywise. nullable: true readOnly: true taxable_litigation_expenses_claims: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- Taxable litigation-cost claims arising from costs advanced by paywise. nullable: true readOnly: true taxable_litigation_expenses_vat_claims: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- VAT on taxable litigation-cost claims arising from costs advanced by paywise. nullable: true readOnly: true taxfree_expenses_claims: allOf: - $ref: '#/components/schemas/StatementAmount' description: Tax-free expense claims arising from costs advanced by paywise. nullable: true readOnly: true taxfree_litigation_expenses_claims: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- Tax-free litigation-cost claims arising from costs advanced by paywise. nullable: true readOnly: true required: - fee_claims - fee_vat_claims - taxable_expenses_claims - taxable_expenses_vat_claims - taxable_litigation_expenses_claims - taxable_litigation_expenses_vat_claims - taxfree_expenses_claims - taxfree_litigation_expenses_claims type: object ClaimsFromPaymentsToClient: properties: fee_claims: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- Collection-fee claims arising from debtor payments received directly by you. nullable: true readOnly: true fee_vat_claims: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- VAT on collection-fee claims arising from debtor payments received directly by you. nullable: true readOnly: true success_commission_claims: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- Success-commission claims arising from debtor payments received directly by you. nullable: true readOnly: true success_commission_vat_claims: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- VAT on success-commission claims arising from debtor payments received directly by you. nullable: true readOnly: true taxable_expenses_claims: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- Taxable expense claims arising from debtor payments received directly by you. nullable: true readOnly: true taxable_expenses_vat_claims: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- VAT on taxable expense claims arising from debtor payments received directly by you. nullable: true readOnly: true taxfree_expenses_claims: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- Tax-free expense claims arising from debtor payments received directly by you. nullable: true readOnly: true required: - fee_claims - fee_vat_claims - success_commission_claims - success_commission_vat_claims - taxable_expenses_claims - taxable_expenses_vat_claims - taxfree_expenses_claims type: object ClaimsFromPaymentsToDCA: properties: fee_claims: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- Collection-fee claims arising from debtor payments received by paywise. nullable: true readOnly: true fee_vat_claims: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- VAT on collection-fee claims arising from debtor payments received by paywise. nullable: true readOnly: true success_commission_claims: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- Success-commission claims arising from debtor payments received by paywise. nullable: true readOnly: true success_commission_vat_claims: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- VAT on success-commission claims arising from debtor payments received by paywise. nullable: true readOnly: true taxable_expenses_claims: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- Taxable expense claims arising from debtor payments received by paywise. nullable: true readOnly: true taxable_expenses_vat_claims: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- VAT on taxable expense claims arising from debtor payments received by paywise. nullable: true readOnly: true taxfree_expenses_claims: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- Tax-free expense claims arising from debtor payments received by paywise. nullable: true readOnly: true required: - fee_claims - fee_vat_claims - success_commission_claims - success_commission_vat_claims - taxable_expenses_claims - taxable_expenses_vat_claims - taxfree_expenses_claims type: object ClosingCodeEnum: description: |- * `IP01` - Vollzahlung * `IP02` - Teilzahlung * `IP03` - vor Bearbeitung bezahlt * `IP04` - Vergleichszahlung * `IPU1` - Vollzahlung (Unterakte) * `IPU2` - Teilzahlung (Unterakte) * `IPU3` - vor Bearbeitung bezahlt (Unterakte) * `IPU4` - Vergleichszahlung (Unterakte) * `IN01` - Akte storniert * `IN010` - Akte storniert - keine Kostenbelastung Honorar * `IN011` - Akte geschlossen: Negative SCHUFA-Auskunft * `IN012` - Akte storniert: Nicht eingezahlter GMV-Vorschuss * `IN013` - Akte storniert: Nicht eingezahlter ZV-Vorschuss * `IN014` - Akte storniert: Nicht beantwortete Rückfrage * `IN015` - Akte geschlossen: Mangels zustellfähiger Anschrift * `IN016` - Akte geschlossen: Schuldner verstorben * `IN017` - Akte geschlossen: Bestritten * `IN018` - Akte storniert: Zahlung vor Übernahme * `IN02` - Kunde wünscht Abschluss * `IN020` - Kunde wünscht Abschluss - keine Kostenbelastung * `IN03` - Abschluss wegen EV * `IN04` - Abschluss wegen Insolvenz * `IN05` - Schuldner verstorben * `IN06` - Erfolglos * `INO7` - Aktensperre * `IN08` - Aufhebung Aktensperre * `INU1` - Unterakte storniert * `INU2` - Kunde wünscht Abschluss (Unterakte) * `INU3` - Abschluss wegen EV (Unterakte) * `INU4` - Abschluss wegen Insolvenz (Unterakte) * `INU5` - Schuldner verstorben (Unterakte) * `INU6` - Erfolglos (Unterakte) * `IÜ01` - Überwachung Sonstiges * `IÜ02` - Überwachung Abgabe EV * `IÜ03` - Überwachung Insolvenz * `IÜU1` - Überwachung Sonstiges (Unterakte) * `IÜU2` - Überwachung Abgabe EV (Unterakte) * `IÜU3` - Überwachung Insolvenz (Unterakte) enum: - IP01 - IP02 - IP03 - IP04 - IPU1 - IPU2 - IPU3 - IPU4 - IN01 - IN010 - IN011 - IN012 - IN013 - IN014 - IN015 - IN016 - IN017 - IN018 - IN02 - IN020 - IN03 - IN04 - IN05 - IN06 - INO7 - IN08 - INU1 - INU2 - INU3 - INU4 - INU5 - INU6 - IÜ01 - IÜ02 - IÜ03 - IÜU1 - IÜU2 - IÜU3 type: string ClosingTypeEnum: description: >- * `positive` - Positiv * `negative` - Negativ * `transition_to_longtime_monitoring` - Übergang ins Überwachungsverfahren enum: - positive - negative - transition_to_longtime_monitoring type: string ActingAsEnum: description: |- * `consumer` - consumer * `business` - business enum: - consumer - business type: string LegacyEventRead: description: Stored events may likewise use retired or internal type values. properties: description: description: Optional description of the event. nullable: true readOnly: true type: string location: description: Optional location associated with the event. nullable: true readOnly: true type: string occurence: description: >- Time at which the event occurred; the historical field spelling is intentional. format: date-time readOnly: true type: string title: description: Human-readable title of the event. readOnly: true type: string type: description: >- Stored event type; historical values may be outside today's input enum. readOnly: true type: string your_reference: description: Your optional reference for the event. nullable: true readOnly: true type: string required: - description - location - occurence - title - type - your_reference type: object LegacyMetadataRead: description: Stored types may predate today's resource-specific input choices. properties: type: description: >- Stored metadata type; historical values may be outside today's input enum. readOnly: true type: string value: description: Stored metadata value. readOnly: true type: string required: - type - value type: object OrganizationRead: properties: commercial_register: description: Register court or authority holding the registration. nullable: true readOnly: true type: string commercial_registration_number: description: Commercial, association, or partnership register number. nullable: true readOnly: true type: string name: description: Registered or trading name of the organization. readOnly: true type: string required: - commercial_register - commercial_registration_number - name type: object PersonRead: properties: birth_date: description: Date of birth used to identify the natural person. format: date nullable: true readOnly: true type: string first_name: description: Given name of the natural person. readOnly: true type: string last_name: description: Family name of the natural person. readOnly: true type: string salutation: allOf: - $ref: '#/components/schemas/SalutationEnum' description: >- Salutation of the natural person; null if no supported salutation is stored. nullable: true readOnly: true required: - birth_date - first_name - last_name - salutation type: object MandateStateValue: description: Stable machine code plus an i18n-ready label key and current label. properties: code: description: >- Stable machine-readable state code; an empty string when that state has not been set. readOnly: true type: string label: description: >- Current human-readable state label; an empty string when its code is unset. readOnly: true type: string label_key: description: >- Stable translation key for the state; an empty string when its code is unset. readOnly: true type: string required: - code - label - label_key type: object ExtraordinaryPayoutsToClient: properties: allocation_to_client_costs: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- Amount allocated to your costs from extraordinary payouts made to you. nullable: true readOnly: true allocation_to_client_expenses: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- Amount allocated to your expenses from extraordinary payouts made to you. nullable: true readOnly: true allocation_to_default_interest: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- Amount allocated to default interest from extraordinary payouts made to you. nullable: true readOnly: true allocation_to_fee: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- Amount allocated to the collection fee from extraordinary payouts made to you. nullable: true readOnly: true allocation_to_fee_vat: allOf: - $ref: '#/components/schemas/StatementAmount' description: Amount allocated to fee VAT from extraordinary payouts made to you. nullable: true readOnly: true allocation_to_main_claim: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- Amount allocated to the principal claim from extraordinary payouts made to you. nullable: true readOnly: true allocation_to_overpayment: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- Amount allocated to overpayment from extraordinary payouts made to you. nullable: true readOnly: true allocation_to_success_commission: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- Amount allocated to the success commission from extraordinary payouts made to you. nullable: true readOnly: true allocation_to_success_commission_vat: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- Amount allocated to success-commission VAT from extraordinary payouts made to you. nullable: true readOnly: true allocation_to_tax_free_expenses: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- Amount allocated to paywise's tax-free expenses from extraordinary payouts made to you. nullable: true readOnly: true allocation_to_taxable_expenses: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- Amount allocated to paywise's taxable expenses from extraordinary payouts made to you. nullable: true readOnly: true allocation_to_taxable_expenses_vat: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- Amount allocated to VAT on taxable expenses from extraordinary payouts made to you. nullable: true readOnly: true payout: allOf: - $ref: '#/components/schemas/StatementAmount' description: Resulting payout balance from extraordinary payouts made to you. nullable: true readOnly: true total_payments: allOf: - $ref: '#/components/schemas/StatementAmount' description: Total extraordinary payouts made to you. nullable: true readOnly: true required: - allocation_to_client_costs - allocation_to_client_expenses - allocation_to_default_interest - allocation_to_fee - allocation_to_fee_vat - allocation_to_main_claim - allocation_to_overpayment - allocation_to_success_commission - allocation_to_success_commission_vat - allocation_to_tax_free_expenses - allocation_to_taxable_expenses - allocation_to_taxable_expenses_vat - payout - total_payments type: object PaymentsToClient: properties: allocation_to_client_costs: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- Amount allocated to your costs from debtor payments made directly to you. nullable: true readOnly: true allocation_to_client_expenses: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- Amount allocated to your expenses from debtor payments made directly to you. nullable: true readOnly: true allocation_to_default_interest: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- Amount allocated to default interest from debtor payments made directly to you. nullable: true readOnly: true allocation_to_fee: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- Amount allocated to the collection fee from debtor payments made directly to you. nullable: true readOnly: true allocation_to_fee_vat: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- Amount allocated to fee VAT from debtor payments made directly to you. nullable: true readOnly: true allocation_to_main_claim: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- Amount allocated to the principal claim from debtor payments made directly to you. nullable: true readOnly: true allocation_to_overpayment: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- Amount allocated to overpayment from debtor payments made directly to you. nullable: true readOnly: true allocation_to_success_commission: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- Amount allocated to the success commission from debtor payments made directly to you. nullable: true readOnly: true allocation_to_success_commission_vat: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- Amount allocated to success-commission VAT from debtor payments made directly to you. nullable: true readOnly: true allocation_to_tax_free_expenses: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- Amount allocated to paywise's tax-free expenses from debtor payments made directly to you. nullable: true readOnly: true allocation_to_taxable_expenses: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- Amount allocated to paywise's taxable expenses from debtor payments made directly to you. nullable: true readOnly: true allocation_to_taxable_expenses_vat: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- Amount allocated to VAT on taxable expenses from debtor payments made directly to you. nullable: true readOnly: true payout: allOf: - $ref: '#/components/schemas/StatementAmount' description: Resulting payout balance from debtor payments made directly to you. nullable: true readOnly: true total_payments: allOf: - $ref: '#/components/schemas/StatementAmount' description: Total debtor payments made directly to you. nullable: true readOnly: true required: - allocation_to_client_costs - allocation_to_client_expenses - allocation_to_default_interest - allocation_to_fee - allocation_to_fee_vat - allocation_to_main_claim - allocation_to_overpayment - allocation_to_success_commission - allocation_to_success_commission_vat - allocation_to_tax_free_expenses - allocation_to_taxable_expenses - allocation_to_taxable_expenses_vat - payout - total_payments type: object PaymentsToDCA: properties: allocation_to_client_costs: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- Amount allocated to your costs from debtor payments received by paywise. nullable: true readOnly: true allocation_to_client_expenses: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- Amount allocated to your expenses from debtor payments received by paywise. nullable: true readOnly: true allocation_to_default_interest: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- Amount allocated to default interest from debtor payments received by paywise. nullable: true readOnly: true allocation_to_fee: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- Amount allocated to the collection fee from debtor payments received by paywise. nullable: true readOnly: true allocation_to_fee_vat: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- Amount allocated to fee VAT from debtor payments received by paywise. nullable: true readOnly: true allocation_to_main_claim: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- Amount allocated to the principal claim from debtor payments received by paywise. nullable: true readOnly: true allocation_to_overpayment: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- Amount allocated to overpayment from debtor payments received by paywise. nullable: true readOnly: true allocation_to_success_commission: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- Amount allocated to the success commission from debtor payments received by paywise. nullable: true readOnly: true allocation_to_success_commission_vat: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- Amount allocated to success-commission VAT from debtor payments received by paywise. nullable: true readOnly: true allocation_to_tax_free_expenses: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- Amount allocated to paywise's tax-free expenses from debtor payments received by paywise. nullable: true readOnly: true allocation_to_taxable_expenses: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- Amount allocated to paywise's taxable expenses from debtor payments received by paywise. nullable: true readOnly: true allocation_to_taxable_expenses_vat: allOf: - $ref: '#/components/schemas/StatementAmount' description: >- Amount allocated to VAT on taxable expenses from debtor payments received by paywise. nullable: true readOnly: true payout: allOf: - $ref: '#/components/schemas/StatementAmount' description: Resulting payout balance from debtor payments received by paywise. nullable: true readOnly: true total_payments: allOf: - $ref: '#/components/schemas/StatementAmount' description: Total debtor payments received by paywise. nullable: true readOnly: true required: - allocation_to_client_costs - allocation_to_client_expenses - allocation_to_default_interest - allocation_to_fee - allocation_to_fee_vat - allocation_to_main_claim - allocation_to_overpayment - allocation_to_success_commission - allocation_to_success_commission_vat - allocation_to_tax_free_expenses - allocation_to_taxable_expenses - allocation_to_taxable_expenses_vat - payout - total_payments type: object SalutationEnum: enum: - mr - ms - mx type: string securitySchemes: caseBearerAuth: description: >- Company-bound Case Management API key — the standard credential for this API. scheme: bearer type: http partnerBearerAuth: description: >- Partner API key acting for one entitled company; every Case request must then also carry the X-On-Behalf-Of-Company header. scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.