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:read
curl -X GET \
/dunning/overdue-rules \
--header "Authorization: Bearer <token>"
{
"data": [
{
"id": "ad8f3b1c-4f0e-4b9e-8b0a-0e0e0e0e0e0e",
"level": 1,
"daysOverdue": 1,
"dueInDays": 7,
"type": "<any>",
"emailTemplate": {
"id": "8d6b0c3e-0b7a-4b0a-8b1a-3b0b8b2d0b0b",
"name": "Order confirmation",
"senderName": "Acme Inc.",
"senderAddress": "noreply@acme.com",
"description": "Order confirmation for a new order",
"subject": "Order confirmation #{{ order.number }}",
"contentHtml": "<h1>Order confirmation</h1><p>Thank you for your order.</p>",
"contentPlain": "Order confirmation\\n\\nThank you for your order.",
"isSystem": true,
"isEnabled": "true",
"createdAt": "2021-01-01T00:00:00+00:00",
"updatedAt": "2021-01-01T00:00:00+00:00",
"preHeader": "Your order confirmation",
"versions": [
{
"id": "mltplv_1b2nE1a2b3nF4c5d6e7f8g9h0j",
"version": 1,
"subject": "Hello {{ name }}",
"contentHtml": "<h1>Hello {{ name }}</h1>",
"contentPlain": "Hello {{ name }}",
"preHeader": "Hello {{ name }}",
"createdAt": "2021-01-01T00:00:00+00:00",
"createdBy": "system"
}
],
"currentVersion": {
"id": "mltplv_1b2nE1a2b3nF4c5d6e7f8g9h0j",
"version": 1,
"subject": "Hello {{ name }}",
"contentHtml": "<h1>Hello {{ name }}</h1>",
"contentPlain": "Hello {{ name }}",
"preHeader": "Hello {{ name }}",
"createdAt": "2021-01-01T00:00:00+00:00",
"createdBy": "system"
}
},
"documentTemplate": {
"id": "00000000-0000-0000-0000-000000000000",
"brandColor": "#000000",
"headerBackgroundColor": "#ffffff",
"logoPosition": "right",
"type": "invoice",
"name": "invoice",
"language": "de",
"title": "Your invoice $invoice.documentId",
"logoUrl": "base64",
"introduction": "Thank you for your order.",
"closing": "Pay this invoice in the next 7 days.",
"information": [
{
"key": "Invoice number",
"value": "$invoice.documentId"
}
],
"footer": [
{
"line1": "Company name",
"line2": "Street",
"line3": "City",
"line4": "Country",
"line5": "VAT number"
}
]
},
"amountInCents": 100,
"attachOriginalInvoice": true,
"sendLetter": true,
"isEnabled": true,
"createdAt": "2021-01-01T00:00:00+00:00",
"updatedAt": "2021-01-01T00:00:00+00:00"
}
],
"meta": {
"pagination": {
"totalItems": 123,
"itemsPerPage": 123,
"currentPage": 123,
"lastPage": 123,
"pageTotalItems": 123
}
}
}
Authorizations
Value for the Authorization header parameter.
Query Parameters
The collection page number
The number of items per page
0 < x < 100
Response
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 < 6
Days after the invoice or last reminder / dunning is overdue.
x > 0
Number of days until this reminder / dunning should be paid.
x > 0
Type of the overdue rule.
Possible values:
reminder
: Send a reminder to the customer.dunning
: Send a dunning to the customer.
The email template that is used to send the reminder / dunning.
255
255
255
255
255
Indicates if the template is a system template. System templates cannot be deleted.
Indicates if the template is enabled. Disabled templates cannot be used.
The pre-header is the short summary text that follows the subject line when an email is viewed in the inbox.
system
, user
system
, user
The document template that is used to generate the reminder / dunning. This is required for a dunning and optional for a reminder.
The document type. Currently supported: invoice, subscription_cancellation, dunning
invoice
, subscription_cancellation
, dunning
255
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
255
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.
Amount in cents that is charged in the currency of the base invoice, for the dunning. This is required for type "dunning".
x > 0
Attach the original invoice additionally to the reminder / dunning.
Send a letter by mail to the customer.
Enable or disable the overdue rule.
Date and time when the overdue rule was created.
Date and time when the overdue rule was last updated.
Was this page helpful?
curl -X GET \
/dunning/overdue-rules \
--header "Authorization: Bearer <token>"
{
"data": [
{
"id": "ad8f3b1c-4f0e-4b9e-8b0a-0e0e0e0e0e0e",
"level": 1,
"daysOverdue": 1,
"dueInDays": 7,
"type": "<any>",
"emailTemplate": {
"id": "8d6b0c3e-0b7a-4b0a-8b1a-3b0b8b2d0b0b",
"name": "Order confirmation",
"senderName": "Acme Inc.",
"senderAddress": "noreply@acme.com",
"description": "Order confirmation for a new order",
"subject": "Order confirmation #{{ order.number }}",
"contentHtml": "<h1>Order confirmation</h1><p>Thank you for your order.</p>",
"contentPlain": "Order confirmation\\n\\nThank you for your order.",
"isSystem": true,
"isEnabled": "true",
"createdAt": "2021-01-01T00:00:00+00:00",
"updatedAt": "2021-01-01T00:00:00+00:00",
"preHeader": "Your order confirmation",
"versions": [
{
"id": "mltplv_1b2nE1a2b3nF4c5d6e7f8g9h0j",
"version": 1,
"subject": "Hello {{ name }}",
"contentHtml": "<h1>Hello {{ name }}</h1>",
"contentPlain": "Hello {{ name }}",
"preHeader": "Hello {{ name }}",
"createdAt": "2021-01-01T00:00:00+00:00",
"createdBy": "system"
}
],
"currentVersion": {
"id": "mltplv_1b2nE1a2b3nF4c5d6e7f8g9h0j",
"version": 1,
"subject": "Hello {{ name }}",
"contentHtml": "<h1>Hello {{ name }}</h1>",
"contentPlain": "Hello {{ name }}",
"preHeader": "Hello {{ name }}",
"createdAt": "2021-01-01T00:00:00+00:00",
"createdBy": "system"
}
},
"documentTemplate": {
"id": "00000000-0000-0000-0000-000000000000",
"brandColor": "#000000",
"headerBackgroundColor": "#ffffff",
"logoPosition": "right",
"type": "invoice",
"name": "invoice",
"language": "de",
"title": "Your invoice $invoice.documentId",
"logoUrl": "base64",
"introduction": "Thank you for your order.",
"closing": "Pay this invoice in the next 7 days.",
"information": [
{
"key": "Invoice number",
"value": "$invoice.documentId"
}
],
"footer": [
{
"line1": "Company name",
"line2": "Street",
"line3": "City",
"line4": "Country",
"line5": "VAT number"
}
]
},
"amountInCents": 100,
"attachOriginalInvoice": true,
"sendLetter": true,
"isEnabled": true,
"createdAt": "2021-01-01T00:00:00+00:00",
"updatedAt": "2021-01-01T00:00:00+00:00"
}
],
"meta": {
"pagination": {
"totalItems": 123,
"itemsPerPage": 123,
"currentPage": 123,
"lastPage": 123,
"pageTotalItems": 123
}
}
}