API documentation
User
Tenant
Feature
Entitlement
User & permissions
Settings
- Settings
- Media
- Webhook
- Notification
Payment
- Payment Method
- Transaction
- SEPA XML
- Open Banking
- Bank Account Transaction
Customer
- Customer
- Customer Address
- Customer Email
- Customer Settings
- Customer Otp
Billing
- Invoice
- Invoice Position Item
- Billing Run
Dunning
- Dunning Document
- Dunning Rule
Subscription
- Subscription
- Subscription Item
- Subscription Measurement
- Billing Group
Offers
- Offer
- Offer Recipient
- Offer Template
Catalogue
- Unit
- Measurement
- Product
- Product Family
- Price Plan
- Coupon
Checkout
- Checkout Link
- Cart
Accounting
Get dunning documents
Get dunning documents
Required permissions:dunning-document:readAuthorizations
Value for the Authorization header parameter.
Query Parameters
The collection page number
The number of items per page
0 < x < 100asc, desc asc, desc asc, desc asc, desc Response
The customer of the dunning document
2 - 255Can be empty. In this case the default currency of the tenant is used.
2 - 255The ID of the customer in DATEV
2 - 255Can be empty if the customer is a company.
2 - 255Can be empty if the customer is a company.
2 - 255STATUS_ACTIVE, STATUS_ARCHIVED, STATUS_SUSPENDED The document date of the dunning document
The due date until when the invoice should be paid
The dunning fee in cents for this dunning document. This is only relevant for dunning documents of type "dunning".
The id of the dunning document
The invoice for which this dunning document was created
The currency code of the invoice. If multiple currency codes will be used in the positions, they will be converted to that base currency.
The customer of the invoice.
2 - 255Can be empty. In this case the default currency of the tenant is used.
2 - 255The ID of the customer in DATEV
2 - 255Can be empty if the customer is a company.
2 - 255Can be empty if the customer is a company.
2 - 255STATUS_ACTIVE, STATUS_ARCHIVED, STATUS_SUSPENDED Custom fields for the entity. The keys are the field names and the values are the field values. They need to be configured under "/custom-fields" in the API documentation. The input is validated against the configuration. For more details see Custom Fields Guide
reminder, dunning, none The unique identifier of the invoice.
The notice of the invoice.
The invoice address of the invoice.
The net amount of the invoice.
The document id of the invoice. This will be generated, when the invoice will be finalized.
The payment method which should be used to fullfill the payment of the invoice.
wallet, sepa_debit, stripe, fake_provider, paypal, bank_transfer, go_cardless, testing active, action_required, expired, revoked, gateway_unconfigured sepa_debit, card, paypal, bank_transfer, wallet, fake_provider STATUS_DRAFT, STATUS_PAID, STATUS_CANCELLED, STATUS_CLOSED, STATUS_REFUNDED, STATUS_REMINDED, STATUS_UNPAID, STATUS_NEW, STATUS_FINALIZING The type of the invoice.
TYPE_INVOICE, TYPE_CREDIT, TYPE_REFUND, TYPE_REMINDER, TYPE_CANCEL, TYPE_DUNNING The level of the current dunning document
The reason for the cancellation. This is used for internal purposes only.
The status of the current dunning document
Possible values:
open: The dunning document is open and can be paid.cancelled: The dunning document was cancelled and can not be paid anymore.paid: The dunning document was paid and can not be paid anymore. The dunning process for this invoice is stopped.
The type of the current dunning document
reminder, dunning Was this page helpful?