PUT
/
dunning
/
overdue-rules
/
{id}

Authorizations

Authorization
string
headerrequired

Value for the Authorization header parameter.

Path Parameters

id
string
required

OverdueRule identifier

Body

daysOverdue
integer
required

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

Required range: x > 0
dueInDays
integer
default: 7required

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

Required range: x > 0
type
enum<string>
default: reminderrequired

Type of the overdue rule.

Possible values:

  • reminder: Send a reminder to the customer.
  • dunning: Send a dunning to the customer.
Available options:
reminder,
dunning
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
attachOriginalInvoice
boolean
default: true

Attach the original invoice additionally to the reminder / dunning.

sendLetter
boolean

Send a letter by mail to the customer.

isEnabled
boolean
default: true

Enable or disable the overdue rule.

Response

200 - application/json
level
integer
default: 1required

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
daysOverdue
integer
required

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

Required range: x > 0
dueInDays
integer
default: 7required

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

Required range: x > 0
type
enum<string>
default: reminderrequired

Type of the overdue rule.

Possible values:

  • reminder: Send a reminder to the customer.
  • dunning: Send a dunning to the customer.
Available options:
reminder,
dunning
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.

id
string
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
attachOriginalInvoice
boolean
default: true

Attach the original invoice additionally to the reminder / dunning.

sendLetter
boolean

Send a letter by mail to the customer.

isEnabled
boolean
default: true

Enable or disable the overdue rule.

createdAt
string

Date and time when the overdue rule was created.

updatedAt
string

Date and time when the overdue rule was last updated.

Was this page helpful?

Get overdue rulesGet all subscriptions