Update overdue rule

PUT

dunning

overdue-rules

{id}

curl -X PUT \
 /dunning/overdue-rules/{id} \
 --header "Content-Type: application/json" \
 --header "Authorization: Bearer <token>" \
 --data '{
    "daysOverdue": "1",
    "dueInDays": "7",
    "emailTemplate": {
        "subject": "Order confirmation #{{ order.number }}",
        "contentHtml": "<h1>Order confirmation<\/h1><p>Thank you for your order.<\/p>"
    },
    "documentTemplate": {
        "title": "Your invoice $invoice.documentId",
        "introduction": "Thank you for your order.",
        "closing": "Pay this invoice in the next 7 days.",
        "information": [
            {
                "key": "Invoice number",
                "value": "$invoice.documentId"
            }
        ]
    },
    "amountInCents": "100",
    "attachOriginalInvoice": "1",
    "sendLetter": "",
    "isEnabled": "1"
}'

{
  "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"
}

Authorizations

Authorization

string

header

required

Value for the Authorization header parameter.

Path Parameters

string

required

OverdueRule identifier

Body

The updated OverdueRule resource

daysOverdue

integer

required

Days after the invoice or last reminder / dunning is overdue.

Required range: x > 0

Example:

1

dueInDays

integer

default:7

required

Number of days until this reminder / dunning should be paid.

Required range: x > 0

Example:

7

type

any

required

Type of the overdue rule.

Possible values:

reminder: Send a reminder to the customer.
dunning: Send a dunning to the customer.

emailTemplate

object

required

The email template that is used to send the reminder / dunning.

documentTemplate

object

required

The document template that is used to generate the reminder / dunning. This is required for a dunning and optional for a reminder.

amountInCents

integer | null

Amount in cents that is charged in the currency of the base invoice, for the dunning. This is required for type "dunning".

Required range: x >= 0

Example:

100

attachOriginalInvoice

boolean

default:true

Attach the original invoice additionally to the reminder / dunning.

Example:

true

sendLetter

boolean

Send a letter by mail to the customer.

isEnabled

boolean

default:true

Enable or disable the overdue rule.

Example:

true

Response

200

application/json

OverdueRule resource updated

level

integer

default:1

required

Level of the overdue rule. The level is used to sort the overdue rules. The overdue rule with the lowest level is used first.

Required range: 0 < x <= 6

Example:

1

daysOverdue

integer

required

Days after the invoice or last reminder / dunning is overdue.

Required range: x > 0

Example:

1

dueInDays

integer

default:7

required

Number of days until this reminder / dunning should be paid.

Required range: x > 0

Example:

7

type

any

required

Type of the overdue rule.

Possible values:

reminder: Send a reminder to the customer.
dunning: Send a dunning to the customer.

emailTemplate

object

required

The email template that is used to send the reminder / dunning.

documentTemplate

object

required

The document template that is used to generate the reminder / dunning. This is required for a dunning and optional for a reminder.

documentTemplate.type

enum<string>

default:invoice

required

The document type. Currently supported: invoice, subscription_cancellation, dunning

Available options:

invoice,

subscription_cancellation,

dunning

Example:

"invoice"

documentTemplate.name

string

required

Maximum length: 255

Example:

"invoice"

documentTemplate.language

enum<string>

default:de

required

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).

Available options:

de,

en

Example:

"de"

documentTemplate.title

string

required

Maximum length: 255

Example:

"Your invoice $invoice.documentId"

documentTemplate.introduction

string

required

Example:

"Thank you for your order."

documentTemplate.closing

string

required

Example:

"Pay this invoice in the next 7 days."

documentTemplate.id

string

Example:

"00000000-0000-0000-0000-000000000000"

documentTemplate.brandColor

string

default:#000000

Your brand color in hex format. Used for some text elements.

Example:

"#000000"

documentTemplate.headerBackgroundColor

string

default:#ffffff

Your header background color in hex format.

Example:

"#ffffff"

documentTemplate.logoPosition

string

default:right

Your logo position in the header. Currently supported: left, center, right

Example:

"right"

documentTemplate.logoUrl

string

deprecated

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.

Example:

"base64"

documentTemplate.information

object[]

documentTemplate.footer

object[]

string

Example:

"ad8f3b1c-4f0e-4b9e-8b0a-0e0e0e0e0e0e"

amountInCents

integer | null

Amount in cents that is charged in the currency of the base invoice, for the dunning. This is required for type "dunning".

Required range: x >= 0

Example:

100

attachOriginalInvoice

boolean

default:true

Attach the original invoice additionally to the reminder / dunning.

Example:

true

sendLetter

boolean

Send a letter by mail to the customer.

isEnabled

boolean

default:true

Enable or disable the overdue rule.

Example:

true

createdAt

string

Date and time when the overdue rule was created.

Example:

"2021-01-01T00:00:00+00:00"

updatedAt

string

Date and time when the overdue rule was last updated.

Example:

"2021-01-01T00:00:00+00:00"

Get overdue rules Get all subscriptions

curl -X PUT \
 /dunning/overdue-rules/{id} \
 --header "Content-Type: application/json" \
 --header "Authorization: Bearer <token>" \
 --data '{
    "daysOverdue": "1",
    "dueInDays": "7",
    "emailTemplate": {
        "subject": "Order confirmation #{{ order.number }}",
        "contentHtml": "<h1>Order confirmation<\/h1><p>Thank you for your order.<\/p>"
    },
    "documentTemplate": {
        "title": "Your invoice $invoice.documentId",
        "introduction": "Thank you for your order.",
        "closing": "Pay this invoice in the next 7 days.",
        "information": [
            {
                "key": "Invoice number",
                "value": "$invoice.documentId"
            }
        ]
    },
    "amountInCents": "100",
    "attachOriginalInvoice": "1",
    "sendLetter": "",
    "isEnabled": "1"
}'

{
  "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"
}

API documentation

User

Tenant

Feature

Entitlement

User & permissions

Settings

Payment

Analytics

Customer

Billing

Dunning

Subscription

Offers

Catalogue

Checkout

Accounting

Taxes

Update overdue rule

Authorizations

Path Parameters

Body

Response