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 overdue rules
Get overdue rules.
Required permissions:dunning-rule:readAuthorizations
Value for the Authorization header parameter.
Query Parameters
The collection page number
The number of items per page
0 < x < 100Response
Days after the invoice or last reminder / dunning is overdue.
x > 0The document template that is used to generate the reminder / dunning. This is required for a dunning and optional for a reminder.
ISO 639-1 language code. The template is selected based on the customer language. If no template for language found, we will fallback to german (de).
de, en 255255The document type. Currently supported: invoice, subscription_cancellation, dunning
invoice, subscription_cancellation, dunning Your brand color in hex format. Used for some text elements.
Your header background color in hex format.
Your logo position in the header. Currently supported: left, center, right
The logo url can be a base64 encoded image or a url to a image file. If you use a base64 encoded image, the image must be a jpeg, jpg, png or gif file.
Number of days until this reminder / dunning should be paid.
x > 0The email template that is used to send the reminder / dunning.
255255255system, user Indicates if the template is enabled. Disabled templates cannot be used.
Indicates if the template is a system template. System templates cannot be deleted.
The pre-header is the short summary text that follows the subject line when an email is viewed in the inbox.
255255system, user Level of the overdue rule. The level is used to sort the overdue rules. The overdue rule with the lowest level is used first.
0 < x < 6Type of the overdue rule.
Possible values:
reminder: Send a reminder to the customer.dunning: Send a dunning to the customer.
Amount in cents that is charged in the currency of the base invoice, for the dunning. This is required for type "dunning".
x > 0Attach the original invoice additionally to the reminder / dunning.
Date and time when the overdue rule was created.
Enable or disable the overdue rule.
Send a letter by mail to the customer.
Date and time when the overdue rule was last updated.
Was this page helpful?